Interface IndexOrBuilder (2.22.0) 

public interface IndexOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAncestor()

public abstract Index.AncestorMode getAncestor()

Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.

.google.datastore.admin.v1.Index.AncestorMode ancestor = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Index.AncestorMode

The ancestor.

getAncestorValue()

public abstract int getAncestorValue()

Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.

.google.datastore.admin.v1.Index.AncestorMode ancestor = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for ancestor.

getIndexId()

public abstract String getIndexId()

Output only. The resource ID of the index.

string index_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The indexId.

getIndexIdBytes()

public abstract ByteString getIndexIdBytes()

Output only. The resource ID of the index.

string index_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for indexId.

getKind()

public abstract String getKind()

Required. The entity kind to which this index applies.

string kind = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The kind.

getKindBytes()

public abstract ByteString getKindBytes()

Required. The entity kind to which this index applies.

string kind = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for kind.

getProjectId()

public abstract String getProjectId()

Output only. Project ID.

string project_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The projectId.

getProjectIdBytes()

public abstract ByteString getProjectIdBytes()

Output only. Project ID.

string project_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for projectId.

getProperties(int index)

public abstract Index.IndexedProperty getProperties(int index)

Required. An ordered sequence of property names and their index attributes.

Requires:

  • A maximum of 100 properties.

repeated .google.datastore.admin.v1.Index.IndexedProperty properties = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Index.IndexedProperty

getPropertiesCount()

public abstract int getPropertiesCount()

Required. An ordered sequence of property names and their index attributes.

Requires:

  • A maximum of 100 properties.

repeated .google.datastore.admin.v1.Index.IndexedProperty properties = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getPropertiesList()

public abstract List<Index.IndexedProperty> getPropertiesList()

Required. An ordered sequence of property names and their index attributes.

Requires:

  • A maximum of 100 properties.

repeated .google.datastore.admin.v1.Index.IndexedProperty properties = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<IndexedProperty>

getPropertiesOrBuilder(int index)

public abstract Index.IndexedPropertyOrBuilder getPropertiesOrBuilder(int index)

Required. An ordered sequence of property names and their index attributes.

Requires:

  • A maximum of 100 properties.

repeated .google.datastore.admin.v1.Index.IndexedProperty properties = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Index.IndexedPropertyOrBuilder

getPropertiesOrBuilderList()

public abstract List<? extends Index.IndexedPropertyOrBuilder> getPropertiesOrBuilderList()

Required. An ordered sequence of property names and their index attributes.

Requires:

  • A maximum of 100 properties.

repeated .google.datastore.admin.v1.Index.IndexedProperty properties = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.datastore.admin.v1.Index.IndexedPropertyOrBuilder>

getState()

public abstract Index.State getState()

Output only. The state of the index.

.google.datastore.admin.v1.Index.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Index.State

The state.

getStateValue()

public abstract int getStateValue()

Output only. The state of the index.

.google.datastore.admin.v1.Index.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.