Package com.google.datastore.admin.v1

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

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

 Requires:

 * A maximum of 100 properties.
        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.

 Requires:

 * A maximum of 100 properties.
        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.

 Requires:

 * A maximum of 100 properties.
        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.

 Requires:

 * A maximum of 100 properties.
        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.

 Requires:

 * A maximum of 100 properties.
        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​(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

      • 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