Class Index (2.20.0)

public final class Index extends GeneratedMessageV3 implements IndexOrBuilder

Datastore composite index definition.

Protobuf type google.datastore.admin.v1.Index

Implements

IndexOrBuilder

Static Fields

ANCESTOR_FIELD_NUMBER

public static final int ANCESTOR_FIELD_NUMBER
Field Value
Type Description
int

INDEX_ID_FIELD_NUMBER

public static final int INDEX_ID_FIELD_NUMBER
Field Value
Type Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
Type Description
int

PROPERTIES_FIELD_NUMBER

public static final int PROPERTIES_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Index getDefaultInstance()
Returns
Type Description
Index

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Index.Builder newBuilder()
Returns
Type Description
Index.Builder

newBuilder(Index prototype)

public static Index.Builder newBuilder(Index prototype)
Parameter
Name Description
prototype Index
Returns
Type Description
Index.Builder

parseDelimitedFrom(InputStream input)

public static Index parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Index
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Index parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Index
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Index parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Index
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Index parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Index
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Index parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Index
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Index parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Index
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Index parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Index
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Index parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Index
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Index parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Index
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Index parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Index
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Index parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Index
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Index parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Index
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Index> parser()
Returns
Type Description
Parser<Index>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAncestor()

public 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 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.

getDefaultInstanceForType()

public Index getDefaultInstanceForType()
Returns
Type Description
Index

getIndexId()

public 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 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 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 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.

getParserForType()

public Parser<Index> getParserForType()
Returns
Type Description
Parser<Index>
Overrides

getProjectId()

public String getProjectId()

Output only. Project ID.

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

Returns
Type Description
String

The projectId.

getProjectIdBytes()

public 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 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 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 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 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 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>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public 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 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Index.Builder newBuilderForType()
Returns
Type Description
Index.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Index.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Index.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Index.Builder toBuilder()
Returns
Type Description
Index.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException