Package com.google.cloud.visionai.v1

Class Index

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.visionai.v1.Index
All Implemented Interfaces:
IndexOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Index extends com.google.protobuf.GeneratedMessage implements IndexOrBuilder
 An Index is a resource in Corpus. It contains an indexed version of the
 assets and annotations. When deployed to an endpoint, it will allow users to
 search the Index.
Protobuf type google.cloud.visionai.v1.Index
See Also:

  • Field Details

    • ENTIRE_CORPUS_FIELD_NUMBER

      public static final int ENTIRE_CORPUS_FIELD_NUMBER
      See Also:

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • DEPLOYED_INDEXES_FIELD_NUMBER

      public static final int DEPLOYED_INDEXES_FIELD_NUMBER
      See Also:

    • SATISFIES_PZS_FIELD_NUMBER

      public static final int SATISFIES_PZS_FIELD_NUMBER
      See Also:

    • SATISFIES_PZI_FIELD_NUMBER

      public static final int SATISFIES_PZI_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getAssetFilterCase

      public Index.AssetFilterCase getAssetFilterCase()
      Specified by:
      getAssetFilterCase in interface IndexOrBuilder

    • hasEntireCorpus

      public boolean hasEntireCorpus()
       Include all assets under the corpus.
      bool entire_corpus = 9;
      Specified by:
      hasEntireCorpus in interface IndexOrBuilder
      Returns:
      Whether the entireCorpus field is set.

    • getEntireCorpus

      public boolean getEntireCorpus()
       Include all assets under the corpus.
      bool entire_corpus = 9;
      Specified by:
      getEntireCorpus in interface IndexOrBuilder
      Returns:
      The entireCorpus.

    • getName

      public String getName()
       Output only. Resource name of the Index resource.
 Format:
 `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/indexes/{index_id}`
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getName in interface IndexOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Output only. Resource name of the Index resource.
 Format:
 `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/indexes/{index_id}`
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getNameBytes in interface IndexOrBuilder
      Returns:
      The bytes for name.

    • getDisplayName

      public String getDisplayName()
       Optional. Optional user-specified display name of the index.
      string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDisplayName in interface IndexOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Optional. Optional user-specified display name of the index.
      string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDisplayNameBytes in interface IndexOrBuilder
      Returns:
      The bytes for displayName.

    • getDescription

      public String getDescription()
       Optional. Optional description of the index.
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescription in interface IndexOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Optional. Optional description of the index.
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescriptionBytes in interface IndexOrBuilder
      Returns:
      The bytes for description.

    • getStateValue

      public int getStateValue()
       Output only. State of the index.
      .google.cloud.visionai.v1.Index.State state = 4 [(.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. State of the index.
      .google.cloud.visionai.v1.Index.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getState in interface IndexOrBuilder
      Returns:
      The state.

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. The create timestamp.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface IndexOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. The create timestamp.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface IndexOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The create timestamp.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface IndexOrBuilder

    • hasUpdateTime

      public boolean hasUpdateTime()
       Output only. The update timestamp.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasUpdateTime in interface IndexOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       Output only. The update timestamp.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTime in interface IndexOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The update timestamp.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface IndexOrBuilder

    • getDeployedIndexesList

      public List<DeployedIndexReference> getDeployedIndexesList()
       Output only. References to the deployed index instance.
 Index of VIDEO_ON_DEMAND corpus can have at most one deployed index.
 Index of IMAGE corpus can have multiple deployed indexes.
      repeated .google.cloud.visionai.v1.DeployedIndexReference deployed_indexes = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDeployedIndexesList in interface IndexOrBuilder

    • getDeployedIndexesOrBuilderList

      public List<? extends DeployedIndexReferenceOrBuilder> getDeployedIndexesOrBuilderList()
       Output only. References to the deployed index instance.
 Index of VIDEO_ON_DEMAND corpus can have at most one deployed index.
 Index of IMAGE corpus can have multiple deployed indexes.
      repeated .google.cloud.visionai.v1.DeployedIndexReference deployed_indexes = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDeployedIndexesOrBuilderList in interface IndexOrBuilder

    • getDeployedIndexesCount

      public int getDeployedIndexesCount()
       Output only. References to the deployed index instance.
 Index of VIDEO_ON_DEMAND corpus can have at most one deployed index.
 Index of IMAGE corpus can have multiple deployed indexes.
      repeated .google.cloud.visionai.v1.DeployedIndexReference deployed_indexes = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDeployedIndexesCount in interface IndexOrBuilder

    • getDeployedIndexes

      public DeployedIndexReference getDeployedIndexes(int index)
       Output only. References to the deployed index instance.
 Index of VIDEO_ON_DEMAND corpus can have at most one deployed index.
 Index of IMAGE corpus can have multiple deployed indexes.
      repeated .google.cloud.visionai.v1.DeployedIndexReference deployed_indexes = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDeployedIndexes in interface IndexOrBuilder

    • getDeployedIndexesOrBuilder

      public DeployedIndexReferenceOrBuilder getDeployedIndexesOrBuilder(int index)
       Output only. References to the deployed index instance.
 Index of VIDEO_ON_DEMAND corpus can have at most one deployed index.
 Index of IMAGE corpus can have multiple deployed indexes.
      repeated .google.cloud.visionai.v1.DeployedIndexReference deployed_indexes = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDeployedIndexesOrBuilder in interface IndexOrBuilder

    • hasSatisfiesPzs

      public boolean hasSatisfiesPzs()
       Output only. This boolean field is only set for projects that have Physical
 Zone Separation enabled via an Org Policy constraint. It is set to true
 when the index is a valid zone separated index and false if it isn't.
      optional bool satisfies_pzs = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasSatisfiesPzs in interface IndexOrBuilder
      Returns:
      Whether the satisfiesPzs field is set.

    • getSatisfiesPzs

      public boolean getSatisfiesPzs()
       Output only. This boolean field is only set for projects that have Physical
 Zone Separation enabled via an Org Policy constraint. It is set to true
 when the index is a valid zone separated index and false if it isn't.
      optional bool satisfies_pzs = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSatisfiesPzs in interface IndexOrBuilder
      Returns:
      The satisfiesPzs.

    • hasSatisfiesPzi

      public boolean hasSatisfiesPzi()
       Output only. This boolean field is only set for projects that have Physical
 Zone Isolation enabled via an Org Policy constraint. It is set to true when
 the index is a valid zone isolated index and false if it isn't.
      optional bool satisfies_pzi = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasSatisfiesPzi in interface IndexOrBuilder
      Returns:
      Whether the satisfiesPzi field is set.

    • getSatisfiesPzi

      public boolean getSatisfiesPzi()
       Output only. This boolean field is only set for projects that have Physical
 Zone Isolation enabled via an Org Policy constraint. It is set to true when
 the index is a valid zone isolated index and false if it isn't.
      optional bool satisfies_pzi = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSatisfiesPzi in interface IndexOrBuilder
      Returns:
      The satisfiesPzi.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

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

    • getDefaultInstanceForType

      public Index getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder