Class NamedTypeReplicaDefinition

Namespace
EsriPBuffer.Graph
Assembly
ESRI.Server.SOESupport.dll
public sealed class NamedTypeReplicaDefinition : IMessage<NamedTypeReplicaDefinition>, IEquatable<NamedTypeReplicaDefinition>, IDeepCloneable<NamedTypeReplicaDefinition>, IBufferMessage, IMessage
Inheritance
NamedTypeReplicaDefinition
Implements
IBufferMessage
IMessage
Inherited Members

Constructors

NamedTypeReplicaDefinition()

public NamedTypeReplicaDefinition()

NamedTypeReplicaDefinition(NamedTypeReplicaDefinition)

public NamedTypeReplicaDefinition(NamedTypeReplicaDefinition other)

Parameters

other NamedTypeReplicaDefinition

Fields

OpenCypherWhereClauseFieldNumber

Field number for the "open_cypher_where_clause" field.

public const int OpenCypherWhereClauseFieldNumber = 2

Field Value

int

ParametersFieldNumber

Field number for the "parameters" field.

public const int ParametersFieldNumber = 3

Field Value

int

ProvenanceOptionsFieldNumber

Field number for the "provenance_options" field.

public const int ProvenanceOptionsFieldNumber = 4

Field Value

int

TypeNameFieldNumber

Field number for the "type_name" field.

public const int TypeNameFieldNumber = 1

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

OpenCypherWhereClause

Defines an attribute query for the entity or relationship type. The query is an openCypher WHERE clause. Entities satisfying the query MATCH (n:<type_name>) WHERE <where_clause> RETURN n are included in the replica. Entities can be referenced by the symbolic name n.

Relationships satisfying the query MATCH ()-[n:<type_name>]->() WHERE <where_clause> RETURN n are included in the replica. Additionally the origin and destination entities of the relationship must be defined in the replica. Relationships can be referenced by the symbolic name n.

  • When no open_cypher_where_clause is provided, all entities or relationships of the type are included in the replica.
  • Spatial operators are supported in the open_cypher_where_clause.
  • The open_cypher_where_clause can reference parameters defined in the parameters map.
public string OpenCypherWhereClause { get; set; }

Property Value

string

Parameters

parameters can only contain combinations of:

  • primitive values
  • array values
  • homogeneous arrays
  • anonymous objects We'll throw a runtime error if the following are encountered:
  • entity values
  • relationship values Parameter names must be referenced in the open_cypher_where_clause.
public MapField<string, AnyValue> Parameters { get; }

Property Value

MapField<string, AnyValue>

Parser

public static MessageParser<NamedTypeReplicaDefinition> Parser { get; }

Property Value

MessageParser<NamedTypeReplicaDefinition>

ProvenanceOptions

Defines the result set for associated provenance of entities or relationships defined by the type_name & where_clause.

public ProvenanceOptions ProvenanceOptions { get; set; }

Property Value

ProvenanceOptions

TypeName

The name of the entity or relationship type to include in the replica.

public string TypeName { get; set; }

Property Value

string

Methods

CalculateSize()

public int CalculateSize()

Returns

int

Clone()

public NamedTypeReplicaDefinition Clone()

Returns

NamedTypeReplicaDefinition

Equals(NamedTypeReplicaDefinition)

public bool Equals(NamedTypeReplicaDefinition other)

Parameters

other NamedTypeReplicaDefinition

Returns

bool

Equals(object)

public override bool Equals(object other)

Parameters

other object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

MergeFrom(NamedTypeReplicaDefinition)

public void MergeFrom(NamedTypeReplicaDefinition other)

Parameters

other NamedTypeReplicaDefinition

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

ToString()

public override string ToString()

Returns

string

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream