Package com.google.cloud.visionai.v1

Interface IndexEndpointOrBuilder

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

  • Method Details

    • getName

      String getName()
       Output only. Resource name of the IndexEndpoint.
 Format:
 `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint_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 IndexEndpoint.
 Format:
 `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint_id}`
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for name.

    • getDisplayName

      String getDisplayName()
       Optional. Display name of the IndexEndpoint. Can be up to 32 characters
 long.
      string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       Optional. Display name of the IndexEndpoint. Can be up to 32 characters
 long.
      string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for displayName.

    • getDescription

      String getDescription()
       Optional. Description of the IndexEndpoint. Can be up to 25000 characters
 long.
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Optional. Description of the IndexEndpoint. Can be up to 25000 characters
 long.
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for description.

    • hasDeployedIndex

      boolean hasDeployedIndex()
       Output only. The Index deployed in this IndexEndpoint.
      .google.cloud.visionai.v1.DeployedIndex deployed_index = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the deployedIndex field is set.

    • getDeployedIndex

      DeployedIndex getDeployedIndex()
       Output only. The Index deployed in this IndexEndpoint.
      .google.cloud.visionai.v1.DeployedIndex deployed_index = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The deployedIndex.

    • getDeployedIndexOrBuilder

      DeployedIndexOrBuilder getDeployedIndexOrBuilder()
       Output only. The Index deployed in this IndexEndpoint.
      .google.cloud.visionai.v1.DeployedIndex deployed_index = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getStateValue

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

    • getState

      IndexEndpoint.State getState()
       Output only. IndexEndpoint state.
      .google.cloud.visionai.v1.IndexEndpoint.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The state.

    • getLabelsCount

      int getLabelsCount()
       Optional. The labels applied to a resource must meet the following
 requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

    • containsLabels

      boolean containsLabels(String key)
       Optional. The labels applied to a resource must meet the following
 requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      Map<String,String> getLabelsMap()
       Optional. The labels applied to a resource must meet the following
 requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getLabelsOrDefault

      String getLabelsOrDefault(String key, String defaultValue)
       Optional. The labels applied to a resource must meet the following
 requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getLabelsOrThrow

      String getLabelsOrThrow(String key)
       Optional. The labels applied to a resource must meet the following
 requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

    • hasCreateTime

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

    • getCreateTime

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

    • getCreateTimeOrBuilder

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

    • hasUpdateTime

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

    • getUpdateTime

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

    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. Update timestamp.
      .google.protobuf.Timestamp update_time = 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 endpoint is a valid zone separated index endpoint and false
 if it isn't.
      optional bool satisfies_pzs = 10 [(.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 endpoint is a valid zone separated index endpoint and false
 if it isn't.
      optional bool satisfies_pzs = 10 [(.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 endpoint is a valid zone isolated index endpoint and false if it
 isn't.
      optional bool satisfies_pzi = 11 [(.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 endpoint is a valid zone isolated index endpoint and false if it
 isn't.
      optional bool satisfies_pzi = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The satisfiesPzi.