Index (Google Cloud Datastore Parent 2.16.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.datastore.admin.v1.Index

All Implemented Interfaces:

IndexOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
```
public final class Index
extends com.google.protobuf.GeneratedMessageV3
implements IndexOrBuilder
```
```
 Datastore composite index definition.
 
```
Protobuf type google.datastore.admin.v1.Index
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Index.AncestorMode` For an ordered index, specifies whether each of the entity's ancestors will be included.
`static class`	`Index.Builder` Datastore composite index definition.
`static class`	`Index.Direction` The direction determines how a property is indexed.
`static class`	`Index.IndexedProperty` A property of an index.
`static interface`	`Index.IndexedPropertyOrBuilder`
`static class`	`Index.State` The possible set of states of an index.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ANCESTOR_FIELD_NUMBER`
`static int`	`INDEX_ID_FIELD_NUMBER`
`static int`	`KIND_FIELD_NUMBER`
`static int`	`PROJECT_ID_FIELD_NUMBER`
`static int`	`PROPERTIES_FIELD_NUMBER`
`static int`	`STATE_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Index.AncestorMode`	`getAncestor()` Required.
`int`	`getAncestorValue()` Required.
`static Index`	`getDefaultInstance()`
`Index`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`String`	`getIndexId()` Output only.
`com.google.protobuf.ByteString`	`getIndexIdBytes()` Output only.
`String`	`getKind()` Required.
`com.google.protobuf.ByteString`	`getKindBytes()` Required.
`com.google.protobuf.Parser<Index>`	`getParserForType()`
`String`	`getProjectId()` Output only.
`com.google.protobuf.ByteString`	`getProjectIdBytes()` Output only.
`Index.IndexedProperty`	`getProperties(int index)` Required.
`int`	`getPropertiesCount()` Required.
`List<Index.IndexedProperty>`	`getPropertiesList()` Required.
`Index.IndexedPropertyOrBuilder`	`getPropertiesOrBuilder(int index)` Required.
`List<? extends Index.IndexedPropertyOrBuilder>`	`getPropertiesOrBuilderList()` Required.
`int`	`getSerializedSize()`
`Index.State`	`getState()` Output only.
`int`	`getStateValue()` Output only.
`int`	`hashCode()`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static Index.Builder`	`newBuilder()`
`static Index.Builder`	`newBuilder(Index prototype)`
`Index.Builder`	`newBuilderForType()`
`protected Index.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static Index`	`parseDelimitedFrom(InputStream input)`
`static Index`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Index`	`parseFrom(byte[] data)`
`static Index`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Index`	`parseFrom(ByteBuffer data)`
`static Index`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Index`	`parseFrom(com.google.protobuf.ByteString data)`
`static Index`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Index`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static Index`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Index`	`parseFrom(InputStream input)`
`static Index`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<Index>`	`parser()`
`Index.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

- Field Detail
  - PROJECT_ID_FIELD_NUMBER
```
public static final int PROJECT_ID_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - INDEX_ID_FIELD_NUMBER
```
public static final int INDEX_ID_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - KIND_FIELD_NUMBER
```
public static final int KIND_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - ANCESTOR_FIELD_NUMBER
```
public static final int ANCESTOR_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - PROPERTIES_FIELD_NUMBER
```
public static final int PROPERTIES_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - STATE_FIELD_NUMBER
```
public static final int STATE_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
- Method Detail
  - newInstance
```
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
```
    Overrides:
    
    newInstance in class com.google.protobuf.GeneratedMessageV3
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
  - getProjectId
```
public String getProjectId()
```
```
 Output only. Project ID.
 
```
    string project_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getProjectId in interface IndexOrBuilder
    
    Returns:
    
    The projectId.
  - getProjectIdBytes
```
public com.google.protobuf.ByteString getProjectIdBytes()
```
```
 Output only. Project ID.
 
```
    string project_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getProjectIdBytes in interface IndexOrBuilder
    
    Returns:
    
    The bytes for projectId.
  - getIndexId
```
public String getIndexId()
```
```
 Output only. The resource ID of the index.
 
```
    string index_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getIndexId in interface IndexOrBuilder
    
    Returns:
    
    The indexId.
  - getIndexIdBytes
```
public com.google.protobuf.ByteString getIndexIdBytes()
```
```
 Output only. The resource ID of the index.
 
```
    string index_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getIndexIdBytes in interface IndexOrBuilder
    
    Returns:
    
    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];
    Specified by:
    
    getKind in interface IndexOrBuilder
    
    Returns:
    
    The kind.
  - getKindBytes
```
public com.google.protobuf.ByteString getKindBytes()
```
```
 Required. The entity kind to which this index applies.
 
```
    string kind = 4 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getKindBytes in interface IndexOrBuilder
    
    Returns:
    
    The bytes for kind.
  - 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];
    Specified by:
    
    getAncestorValue in interface IndexOrBuilder
    
    Returns:
    
    The enum numeric value on the wire for ancestor.
  - 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];
    Specified by:
    
    getAncestor in interface IndexOrBuilder
    
    Returns:
    
    The ancestor.
  - getPropertiesList
```
public List<Index.IndexedProperty> getPropertiesList()
```
```
 Required. An ordered sequence of property names and their index attributes.
 
```
    repeated .google.datastore.admin.v1.Index.IndexedProperty properties = 6 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getPropertiesList in interface IndexOrBuilder
  - getPropertiesOrBuilderList
```
public List<? extends Index.IndexedPropertyOrBuilder> getPropertiesOrBuilderList()
```
```
 Required. An ordered sequence of property names and their index attributes.
 
```
    repeated .google.datastore.admin.v1.Index.IndexedProperty properties = 6 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getPropertiesOrBuilderList in interface IndexOrBuilder
  - getPropertiesCount
```
public int getPropertiesCount()
```
```
 Required. An ordered sequence of property names and their index attributes.
 
```
    repeated .google.datastore.admin.v1.Index.IndexedProperty properties = 6 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getPropertiesCount in interface IndexOrBuilder
  - getProperties
```
public Index.IndexedProperty getProperties(int index)
```
```
 Required. An ordered sequence of property names and their index attributes.
 
```
    repeated .google.datastore.admin.v1.Index.IndexedProperty properties = 6 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getProperties in interface IndexOrBuilder
  - getPropertiesOrBuilder
```
public Index.IndexedPropertyOrBuilder getPropertiesOrBuilder(int index)
```
```
 Required. An ordered sequence of property names and their index attributes.
 
```
    repeated .google.datastore.admin.v1.Index.IndexedProperty properties = 6 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getPropertiesOrBuilder in interface IndexOrBuilder
  - 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];
    Specified by:
    
    getStateValue in interface IndexOrBuilder
    
    Returns:
    
    The enum numeric value on the wire for state.
  - 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];
    Specified by:
    
    getState in interface IndexOrBuilder
    
    Returns:
    
    The state.
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3
  - writeTo
```
public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException
```
    Specified by:
    
    writeTo in interface com.google.protobuf.MessageLite
    
    Overrides:
    
    writeTo in class com.google.protobuf.GeneratedMessageV3
    
    Throws:
    
    IOException
  - getSerializedSize
```
public int getSerializedSize()
```
    Specified by:
    
    getSerializedSize in interface com.google.protobuf.MessageLite
    
    Overrides:
    
    getSerializedSize in class com.google.protobuf.GeneratedMessageV3
  - equals
```
public boolean equals(Object obj)
```
    Specified by:
    
    equals in interface com.google.protobuf.Message
    
    Overrides:
    
    equals in class com.google.protobuf.AbstractMessage
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface com.google.protobuf.Message
    
    Overrides:
    
    hashCode in class com.google.protobuf.AbstractMessage
  - parseFrom
```
public static Index parseFrom(ByteBuffer data)
                       throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static Index parseFrom(ByteBuffer data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static Index parseFrom(com.google.protobuf.ByteString data)
                       throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static Index parseFrom(com.google.protobuf.ByteString data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static Index parseFrom(byte[] data)
                       throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static Index parseFrom(byte[] data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static Index parseFrom(InputStream input)
                       throws IOException
```
    Throws:
    
    IOException
  - parseFrom
```
public static Index parseFrom(InputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws IOException
```
    Throws:
    
    IOException
  - parseDelimitedFrom
```
public static Index parseDelimitedFrom(InputStream input)
                                throws IOException
```
    Throws:
    
    IOException
  - parseDelimitedFrom
```
public static Index parseDelimitedFrom(InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException
```
    Throws:
    
    IOException
  - parseFrom
```
public static Index parseFrom(com.google.protobuf.CodedInputStream input)
                       throws IOException
```
    Throws:
    
    IOException
  - parseFrom
```
public static Index parseFrom(com.google.protobuf.CodedInputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws IOException
```
    Throws:
    
    IOException
  - newBuilderForType
```
public Index.Builder newBuilderForType()
```
    Specified by:
    
    newBuilderForType in interface com.google.protobuf.Message
    
    Specified by:
    
    newBuilderForType in interface com.google.protobuf.MessageLite
  - newBuilder
```
public static Index.Builder newBuilder()
```
  - newBuilder
```
public static Index.Builder newBuilder(Index prototype)
```
  - toBuilder
```
public Index.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface com.google.protobuf.Message
    
    Specified by:
    
    toBuilder in interface com.google.protobuf.MessageLite
  - newBuilderForType
```
protected Index.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
```
    Specified by:
    
    newBuilderForType in class com.google.protobuf.GeneratedMessageV3
  - getDefaultInstance
```
public static Index getDefaultInstance()
```
  - parser
```
public static com.google.protobuf.Parser<Index> parser()
```
  - getParserForType
```
public com.google.protobuf.Parser<Index> getParserForType()
```
    Specified by:
    
    getParserForType in interface com.google.protobuf.Message
    
    Specified by:
    
    getParserForType in interface com.google.protobuf.MessageLite
    
    Overrides:
    
    getParserForType in class com.google.protobuf.GeneratedMessageV3
  - getDefaultInstanceForType
```
public Index getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

Class Index

Nested Class Summary

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

Field Summary

Fields inherited from class com.google.protobuf.GeneratedMessageV3

Fields inherited from class com.google.protobuf.AbstractMessage

Fields inherited from class com.google.protobuf.AbstractMessageLite

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3

Methods inherited from class com.google.protobuf.AbstractMessage

Methods inherited from class com.google.protobuf.AbstractMessageLite

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite

Field Detail

PROJECT_ID_FIELD_NUMBER

INDEX_ID_FIELD_NUMBER

KIND_FIELD_NUMBER

ANCESTOR_FIELD_NUMBER

PROPERTIES_FIELD_NUMBER

STATE_FIELD_NUMBER

Method Detail

newInstance

getDescriptor

internalGetFieldAccessorTable

getProjectId

getProjectIdBytes

getIndexId

getIndexIdBytes

getKind

getKindBytes

getAncestorValue

getAncestor

getPropertiesList

getPropertiesOrBuilderList

getPropertiesCount

getProperties

getPropertiesOrBuilder

getStateValue

getState

isInitialized

writeTo

getSerializedSize

equals

hashCode

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseDelimitedFrom

parseDelimitedFrom

parseFrom

parseFrom

newBuilderForType

newBuilder

newBuilder

toBuilder

newBuilderForType

getDefaultInstance

parser

getParserForType

getDefaultInstanceForType