Package com.google.cloud.visionai.v1

Class IndexEndpoint

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.visionai.v1.IndexEndpoint
All Implemented Interfaces:
IndexEndpointOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class IndexEndpoint extends com.google.protobuf.GeneratedMessage implements IndexEndpointOrBuilder
 Message representing IndexEndpoint resource. Indexes are deployed into it.
Protobuf type google.cloud.visionai.v1.IndexEndpoint
See Also:

  • Field Details

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

    • DEPLOYED_INDEX_FIELD_NUMBER

      public static final int DEPLOYED_INDEX_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • LABELS_FIELD_NUMBER

      public static final int LABELS_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:

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

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

    • getName

      public 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];
      Specified by:
      getName in interface IndexEndpointOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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];
      Specified by:
      getNameBytes in interface IndexEndpointOrBuilder
      Returns:
      The bytes for name.

    • getDisplayName

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

    • getDisplayNameBytes

      public 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];
      Specified by:
      getDisplayNameBytes in interface IndexEndpointOrBuilder
      Returns:
      The bytes for displayName.

    • getDescription

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

    • getDescriptionBytes

      public 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];
      Specified by:
      getDescriptionBytes in interface IndexEndpointOrBuilder
      Returns:
      The bytes for description.

    • hasDeployedIndex

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

    • getDeployedIndex

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

    • getDeployedIndexOrBuilder

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

    • getStateValue

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

    • getState

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

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: IndexEndpointOrBuilder
       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];
      Specified by:
      getLabelsCount in interface IndexEndpointOrBuilder

    • containsLabels

      public 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];
      Specified by:
      containsLabels in interface IndexEndpointOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface IndexEndpointOrBuilder

    • getLabelsMap

      public 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];
      Specified by:
      getLabelsMap in interface IndexEndpointOrBuilder

    • getLabelsOrDefault

      public 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];
      Specified by:
      getLabelsOrDefault in interface IndexEndpointOrBuilder

    • getLabelsOrThrow

      public 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];
      Specified by:
      getLabelsOrThrow in interface IndexEndpointOrBuilder

    • hasCreateTime

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

    • getCreateTime

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

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Create timestamp.
      .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface IndexEndpointOrBuilder

    • hasUpdateTime

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

    • getUpdateTime

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

    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. Update timestamp.
      .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface IndexEndpointOrBuilder

    • 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 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];
      Specified by:
      hasSatisfiesPzs in interface IndexEndpointOrBuilder
      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 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];
      Specified by:
      getSatisfiesPzs in interface IndexEndpointOrBuilder
      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 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];
      Specified by:
      hasSatisfiesPzi in interface IndexEndpointOrBuilder
      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 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];
      Specified by:
      getSatisfiesPzi in interface IndexEndpointOrBuilder
      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 IndexEndpoint parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static IndexEndpoint parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static IndexEndpoint parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static IndexEndpoint parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static IndexEndpoint parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static IndexEndpoint parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static IndexEndpoint parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static IndexEndpoint parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static IndexEndpoint parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static IndexEndpoint parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static IndexEndpoint parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static IndexEndpoint parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public IndexEndpoint.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static IndexEndpoint.Builder newBuilder()

    • newBuilder

      public static IndexEndpoint.Builder newBuilder(IndexEndpoint prototype)

    • toBuilder

      public IndexEndpoint.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected IndexEndpoint.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static IndexEndpoint getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<IndexEndpoint> parser()

    • getParserForType

      public com.google.protobuf.Parser<IndexEndpoint> 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 IndexEndpoint getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder