Class GraphSearchRequest

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

Constructors

GraphSearchRequest()

public GraphSearchRequest()

GraphSearchRequest(GraphSearchRequest)

public GraphSearchRequest(GraphSearchRequest other)

Parameters

other GraphSearchRequest

Fields

ApplyVcsProjectionFieldNumber

Field number for the "apply_vcs_projection" field.

public const int ApplyVcsProjectionFieldNumber = 13

Field Value

int

DatumTransformFieldNumber

Field number for the "datum_transform" field.

public const int DatumTransformFieldNumber = 12

Field Value

int

FeatureEncodingFieldNumber

Field number for the "feature_encoding" field.

public const int FeatureEncodingFieldNumber = 10

Field Value

int

IdentifierArrayFieldNumber

Field number for the "identifier_array" field.

public const int IdentifierArrayFieldNumber = 18

Field Value

int

InputSpatRefFieldNumber

Field number for the "input_spat_ref" field.

public const int InputSpatRefFieldNumber = 7

Field Value

int

InputTransformFieldNumber

Field number for the "input_transform" field.

public const int InputTransformFieldNumber = 6

Field Value

int

MaxNumResultsFieldNumber

Field number for the "max_num_results" field.

public const int MaxNumResultsFieldNumber = 16

Field Value

int

NamedTypeFilterFieldNumber

Field number for the "named_type_filter" field.

public const int NamedTypeFilterFieldNumber = 3

Field Value

int

OutDateOnlyFormatFieldNumber

Field number for the "out_date_only_format" field.

public const int OutDateOnlyFormatFieldNumber = 21

Field Value

int

OutDurationFormatFieldNumber

Field number for the "out_duration_format" field.

public const int OutDurationFormatFieldNumber = 23

Field Value

int

OutSpatRefFieldNumber

Field number for the "out_spat_ref" field.

public const int OutSpatRefFieldNumber = 11

Field Value

int

OutTimeOnlyFormatFieldNumber

Field number for the "out_time_only_format" field.

public const int OutTimeOnlyFormatFieldNumber = 22

Field Value

int

OutTimeZoneFieldNumber

Field number for the "out_time_zone" field.

public const int OutTimeZoneFieldNumber = 19

Field Value

int

OutTimestampOffsetFormatFieldNumber

Field number for the "out_timestamp_offset_format" field.

public const int OutTimestampOffsetFormatFieldNumber = 20

Field Value

int

QuantizationParamsFieldNumber

Field number for the "quantization_params" field.

public const int QuantizationParamsFieldNumber = 14

Field Value

int

ReturnGeometryFieldNumber

Field number for the "return_geometry" field.

public const int ReturnGeometryFieldNumber = 9

Field Value

int

ReturnSearchContextFieldNumber

Field number for the "return_search_context" field.

public const int ReturnSearchContextFieldNumber = 17

Field Value

int

SearchQueryFieldNumber

Field number for the "search_query" field.

public const int SearchQueryFieldNumber = 1

Field Value

int

SpatialFilterFieldNumber

Field number for the "spatial_filter" field.

public const int SpatialFilterFieldNumber = 5

Field Value

int

SpatialRelationFieldNumber

Field number for the "spatial_relation" field.

public const int SpatialRelationFieldNumber = 8

Field Value

int

StartIndexFieldNumber

Field number for the "start_index" field.

public const int StartIndexFieldNumber = 15

Field Value

int

TypeCategoryFilterFieldNumber

Field number for the "type_category_filter" field.

public const int TypeCategoryFilterFieldNumber = 4

Field Value

int

Properties

ApplyVcsProjection

A flag to indicate whether the vertical coordinate system requires projection.

public bool ApplyVcsProjection { get; set; }

Property Value

bool

DatumTransform

The transformation to apply to the return geometries.

public EsriTypes.Types.DatumTransformation DatumTransform { get; set; }

Property Value

EsriTypes.Types.DatumTransformation

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

FeatureEncoding

Enumeration indicating the method of encoding return geometries.

public EsriTypes.Types.esriFeatureEncoding FeatureEncoding { get; set; }

Property Value

EsriTypes.Types.esriFeatureEncoding

IdentifierArray

Identifier filtering array

public ArrayValue IdentifierArray { get; set; }

Property Value

ArrayValue

InputSpatRef

The input geometry spatial reference.

public EsriTypes.Types.SpatialReference InputSpatRef { get; set; }

Property Value

EsriTypes.Types.SpatialReference

InputTransform

Transformation parameters for server to decode spatial filter geometry.

public Transform InputTransform { get; set; }

Property Value

Transform

MaxNumResults

The maximum number results to return.

public int MaxNumResults { get; set; }

Property Value

int

NamedTypeFilter

Search execution is limited to specified named types.

public RepeatedField<string> NamedTypeFilter { get; }

Property Value

RepeatedField<string>

OutDateOnlyFormat

Indicates the method of encoding output DateOnlyValues.

public DateOnlyFormat OutDateOnlyFormat { get; set; }

Property Value

DateOnlyFormat

OutDurationFormat

Indicates the method of encoding output DurationValues.

public DurationFormat OutDurationFormat { get; set; }

Property Value

DurationFormat

OutSpatRef

The output spatial reference of the return geometries.

public EsriTypes.Types.SpatialReference OutSpatRef { get; set; }

Property Value

EsriTypes.Types.SpatialReference

OutTimeOnlyFormat

Indicates the method of encoding output TimeOnlyValues.

public TimeOnlyFormat OutTimeOnlyFormat { get; set; }

Property Value

TimeOnlyFormat

OutTimeZone

Return timestamp_offset values in the specified time zone.

public TimeZone OutTimeZone { get; set; }

Property Value

TimeZone

OutTimestampOffsetFormat

Indicates the method of encoding output TimestampOffsetValues.

public TimestampOffsetFormat OutTimestampOffsetFormat { get; set; }

Property Value

TimestampOffsetFormat

Parser

public static MessageParser<GraphSearchRequest> Parser { get; }

Property Value

MessageParser<GraphSearchRequest>

QuantizationParams

Support for coordinate quantization.

public QuantizationParameters QuantizationParams { get; set; }

Property Value

QuantizationParameters

ReturnGeometry

Output Geometry Parameters

[Obsolete]
public bool ReturnGeometry { get; set; }

Property Value

bool

ReturnSearchContext

Include search context fields: propertyNames, scores, typeCategory & typeName in the result set. Returns exactly the tuple { id(doc), [propertyName1, ..., propertyNameN], [score1,..., scoreN], typeCategoryOf(doc), typeNameOf(doc)} for each document.

public bool ReturnSearchContext { get; set; }

Property Value

bool

SearchQuery

Search Query Parameters

public string SearchQuery { get; set; }

Property Value

string

SpatialFilter

Input Filter Geometry Parameters

public GeometryValue SpatialFilter { get; set; }

Property Value

GeometryValue

SpatialRelation

The spatial relationship to be applied to the input geometry. Defaults to esriSpatialRelIntersects.

public EsriTypes.Types.esriSpatialRel SpatialRelation { get; set; }

Property Value

EsriTypes.Types.esriSpatialRel

StartIndex

Search Result Set Options

public int StartIndex { get; set; }

Property Value

int

TypeCategoryFilter

Limit search results to entity types, relationship types or both. Check service definition for capabilities of underlying drivers.

public esriNamedTypeCategory TypeCategoryFilter { get; set; }

Property Value

esriNamedTypeCategory

Methods

CalculateSize()

public int CalculateSize()

Returns

int

Clone()

public GraphSearchRequest Clone()

Returns

GraphSearchRequest

Equals(GraphSearchRequest)

public bool Equals(GraphSearchRequest other)

Parameters

other GraphSearchRequest

Returns

bool

Equals(object)

public override bool Equals(object other)

Parameters

other object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

MergeFrom(GraphSearchRequest)

public void MergeFrom(GraphSearchRequest other)

Parameters

other GraphSearchRequest

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