Package com.google.cloud.visionai.v1

Interface IndexOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Index, Index.Builder
@Generated public interface IndexOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasEntireCorpus

      boolean hasEntireCorpus()
       Include all assets under the corpus.
      bool entire_corpus = 9;
      Returns:
      Whether the entireCorpus field is set.

    • getEntireCorpus

      boolean getEntireCorpus()
       Include all assets under the corpus.
      bool entire_corpus = 9;
      Returns:
      The entireCorpus.

    • getName

      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];
      Returns:
      The name.

    • getNameBytes

      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];
      Returns:
      The bytes for name.

    • getDisplayName

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

    • getDisplayNameBytes

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

    • getDescription

      String getDescription()
       Optional. Optional description of the index.
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The description.

    • getDescriptionBytes

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

    • getStateValue

      int getStateValue()
       Output only. State of the index.
      .google.cloud.visionai.v1.Index.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for state.

    • getState

      Index.State getState()
       Output only. State of the index.
      .google.cloud.visionai.v1.Index.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The state.

    • hasCreateTime

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

    • getCreateTime

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

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The create timestamp.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasUpdateTime

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

    • getUpdateTime

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

    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The update timestamp.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getDeployedIndexesList

      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];

    • getDeployedIndexes

      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];

    • getDeployedIndexesCount

      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];

    • getDeployedIndexesOrBuilderList

      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];

    • getDeployedIndexesOrBuilder

      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];

    • hasSatisfiesPzs

      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];
      Returns:
      Whether the satisfiesPzs field is set.

    • getSatisfiesPzs

      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];
      Returns:
      The satisfiesPzs.

    • hasSatisfiesPzi

      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];
      Returns:
      Whether the satisfiesPzi field is set.

    • getSatisfiesPzi

      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];
      Returns:
      The satisfiesPzi.

    • getAssetFilterCase

      Index.AssetFilterCase getAssetFilterCase()