Class Index (2.23.0)

publicfinalclass IndexextendsGeneratedMessageV3implementsIndexOrBuilder

Datastore composite index definition.

Protobuf type google.datastore.admin.v1.Index

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Index

Implements

IndexOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.notify()

Object.wait()

Object.wait(long,int)

Static Fields

ANCESTOR_FIELD_NUMBER

publicstaticfinalintANCESTOR_FIELD_NUMBER

Field Value
Type	Description
`int`

INDEX_ID_FIELD_NUMBER

publicstaticfinalintINDEX_ID_FIELD_NUMBER

Field Value
Type	Description
`int`

KIND_FIELD_NUMBER

publicstaticfinalintKIND_FIELD_NUMBER

Field Value
Type	Description
`int`

PROJECT_ID_FIELD_NUMBER

publicstaticfinalintPROJECT_ID_FIELD_NUMBER

Field Value
Type	Description
`int`

PROPERTIES_FIELD_NUMBER

publicstaticfinalintPROPERTIES_FIELD_NUMBER

Field Value
Type	Description
`int`

STATE_FIELD_NUMBER

publicstaticfinalintSTATE_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

publicstaticIndexgetDefaultInstance()

Returns
Type	Description
`Index`

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

publicstaticIndex.BuildernewBuilder()

Returns
Type	Description
`Index.Builder`

newBuilder(Index prototype)

publicstaticIndex.BuildernewBuilder(Indexprototype)

Parameter
Name	Description
`prototype`	`Index`

Returns
Type	Description
`Index.Builder`

parseDelimitedFrom(InputStream input)

publicstaticIndexparseDelimitedFrom(InputStreaminput)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Index`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticIndexparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Index`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

publicstaticIndexparseFrom(byte[]data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`Index`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticIndexparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Index`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

publicstaticIndexparseFrom(ByteStringdata)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`Index`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticIndexparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Index`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

publicstaticIndexparseFrom(CodedInputStreaminput)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`Index`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticIndexparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Index`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

publicstaticIndexparseFrom(InputStreaminput)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Index`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticIndexparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Index`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

publicstaticIndexparseFrom(ByteBufferdata)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`Index`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticIndexparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Index`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

publicstaticParser<Index>parser()

Returns
Type	Description
`Parser<Index>`

Methods

equals(Object obj)

publicbooleanequals(Objectobj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getAncestor()

publicIndex.AncestorModegetAncestor()

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()

publicintgetAncestorValue()

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()

publicIndexgetDefaultInstanceForType()

Returns
Type	Description
`Index`

getIndexId()

publicStringgetIndexId()

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()

publicByteStringgetIndexIdBytes()

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()

publicStringgetKind()

Required. The entity kind to which this index applies.

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

Returns
Type	Description
`String`	The kind.

getKindBytes()

publicByteStringgetKindBytes()

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()

publicParser<Index>getParserForType()

Returns
Type	Description
`Parser<Index>`

Overrides

GeneratedMessageV3.getParserForType()

getProjectId()

publicStringgetProjectId()

Output only. Project ID.

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

Returns
Type	Description
`String`	The projectId.

getProjectIdBytes()

publicByteStringgetProjectIdBytes()

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)

publicIndex.IndexedPropertygetProperties(intindex)

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()

publicintgetPropertiesCount()

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()

publicList<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)

publicIndex.IndexedPropertyOrBuildergetPropertiesOrBuilder(intindex)

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()

publicList<?extendsIndex.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()

publicintgetSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getState()

publicIndex.StategetState()

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()

publicintgetStateValue()

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()

publicinthashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

publicfinalbooleanisInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

publicIndex.BuildernewBuilderForType()

Returns
Type	Description
`Index.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedIndex.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`Index.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

publicIndex.BuildertoBuilder()

Returns
Type	Description
`Index.Builder`

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`

Class Index (2.23.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Implements

Inherited Members

Static Fields

ANCESTOR_FIELD_NUMBER

INDEX_ID_FIELD_NUMBER

KIND_FIELD_NUMBER

PROJECT_ID_FIELD_NUMBER

PROPERTIES_FIELD_NUMBER

STATE_FIELD_NUMBER

Static Methods

getDefaultInstance()

getDescriptor()

newBuilder()

newBuilder(Index prototype)

parseDelimitedFrom(InputStream input)

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

parseFrom(byte[] data)

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

parseFrom(ByteString data)

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

parseFrom(CodedInputStream input)

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

parseFrom(InputStream input)

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

parseFrom(ByteBuffer data)

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

parser()

Methods

equals(Object obj)

getAncestor()

getAncestorValue()

getDefaultInstanceForType()

getIndexId()

getIndexIdBytes()

getKind()

getKindBytes()

getParserForType()

getProjectId()

getProjectIdBytes()

getProperties(int index)

getPropertiesCount()

getPropertiesList()

getPropertiesOrBuilder(int index)

getPropertiesOrBuilderList()

getSerializedSize()

getState()

getStateValue()

hashCode()

internalGetFieldAccessorTable()

isInitialized()

newBuilderForType()

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

writeTo(CodedOutputStream output)

Class Index (2.23.0)