Package com.google.cloud.aiplatform.v1

Class IndexEndpoint

  • All Implemented Interfaces:
    IndexEndpointOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class IndexEndpoint
extends com.google.protobuf.GeneratedMessageV3
implements IndexEndpointOrBuilder
     Indexes are deployed into it. An IndexEndpoint can have multiple
 DeployedIndexes.
    Protobuf type google.cloud.aiplatform.v1.IndexEndpoint
    See Also:
    Serialized Form

    • Field Detail

      • DISPLAY_NAME_FIELD_NUMBER

        public static final int DISPLAY_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DESCRIPTION_FIELD_NUMBER

        public static final int DESCRIPTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DEPLOYED_INDEXES_FIELD_NUMBER

        public static final int DEPLOYED_INDEXES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CREATE_TIME_FIELD_NUMBER

        public static final int CREATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UPDATE_TIME_FIELD_NUMBER

        public static final int UPDATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENABLE_PRIVATE_SERVICE_CONNECT_FIELD_NUMBER

        public static final int ENABLE_PRIVATE_SERVICE_CONNECT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PRIVATE_SERVICE_CONNECT_CONFIG_FIELD_NUMBER

        public static final int PRIVATE_SERVICE_CONNECT_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PUBLIC_ENDPOINT_ENABLED_FIELD_NUMBER

        public static final int PUBLIC_ENDPOINT_ENABLED_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PUBLIC_ENDPOINT_DOMAIN_NAME_FIELD_NUMBER

        public static final int PUBLIC_ENDPOINT_DOMAIN_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENCRYPTION_SPEC_FIELD_NUMBER

        public static final int ENCRYPTION_SPEC_FIELD_NUMBER
        See Also:
        Constant Field Values

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

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

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

      • getName

        public String getName()
         Output only. The resource name of the IndexEndpoint.
        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. The resource name of the IndexEndpoint.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface IndexEndpointOrBuilder
        Returns:
        The bytes for name.

      • getDisplayName

        public String getDisplayName()
         Required. The display name of the IndexEndpoint.
 The name can be up to 128 characters long and can consist of any UTF-8
 characters.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDisplayName in interface IndexEndpointOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Required. The display name of the IndexEndpoint.
 The name can be up to 128 characters long and can consist of any UTF-8
 characters.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDisplayNameBytes in interface IndexEndpointOrBuilder
        Returns:
        The bytes for displayName.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         The description of the IndexEndpoint.
        string description = 3;
        Specified by:
        getDescriptionBytes in interface IndexEndpointOrBuilder
        Returns:
        The bytes for description.

      • getDeployedIndexesList

        public List<DeployedIndex> getDeployedIndexesList()
         Output only. The indexes deployed in this endpoint.
        repeated .google.cloud.aiplatform.v1.DeployedIndex deployed_indexes = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDeployedIndexesList in interface IndexEndpointOrBuilder

      • getDeployedIndexesCount

        public int getDeployedIndexesCount()
         Output only. The indexes deployed in this endpoint.
        repeated .google.cloud.aiplatform.v1.DeployedIndex deployed_indexes = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDeployedIndexesCount in interface IndexEndpointOrBuilder

      • getDeployedIndexes

        public DeployedIndex getDeployedIndexes​(int index)
         Output only. The indexes deployed in this endpoint.
        repeated .google.cloud.aiplatform.v1.DeployedIndex deployed_indexes = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDeployedIndexes in interface IndexEndpointOrBuilder

      • getEtag

        public String getEtag()
         Used to perform consistent read-modify-write updates. If not set, a blind
 "overwrite" update happens.
        string etag = 5;
        Specified by:
        getEtag in interface IndexEndpointOrBuilder
        Returns:
        The etag.

      • getEtagBytes

        public com.google.protobuf.ByteString getEtagBytes()
         Used to perform consistent read-modify-write updates. If not set, a blind
 "overwrite" update happens.
        string etag = 5;
        Specified by:
        getEtagBytes in interface IndexEndpointOrBuilder
        Returns:
        The bytes for etag.

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: IndexEndpointOrBuilder
         The labels with user-defined metadata to organize your IndexEndpoints.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.
        map<string, string> labels = 6;
        Specified by:
        getLabelsCount in interface IndexEndpointOrBuilder

      • containsLabels

        public boolean containsLabels​(String key)
         The labels with user-defined metadata to organize your IndexEndpoints.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.
        map<string, string> labels = 6;
        Specified by:
        containsLabels in interface IndexEndpointOrBuilder

      • getLabelsMap

        public Map<String,​String> getLabelsMap()
         The labels with user-defined metadata to organize your IndexEndpoints.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.
        map<string, string> labels = 6;
        Specified by:
        getLabelsMap in interface IndexEndpointOrBuilder

      • getLabelsOrDefault

        public String getLabelsOrDefault​(String key,
                                 String defaultValue)
         The labels with user-defined metadata to organize your IndexEndpoints.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.
        map<string, string> labels = 6;
        Specified by:
        getLabelsOrDefault in interface IndexEndpointOrBuilder

      • getLabelsOrThrow

        public String getLabelsOrThrow​(String key)
         The labels with user-defined metadata to organize your IndexEndpoints.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.
        map<string, string> labels = 6;
        Specified by:
        getLabelsOrThrow in interface IndexEndpointOrBuilder

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Timestamp when this IndexEndpoint was created.
        .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. Timestamp when this IndexEndpoint was created.
        .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. Timestamp when this IndexEndpoint was created.
        .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface IndexEndpointOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. Timestamp when this IndexEndpoint was last updated.
 This timestamp is not updated when the endpoint's DeployedIndexes are
 updated, e.g. due to updates of the original Indexes they are the
 deployments of.
        .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. Timestamp when this IndexEndpoint was last updated.
 This timestamp is not updated when the endpoint's DeployedIndexes are
 updated, e.g. due to updates of the original Indexes they are the
 deployments of.
        .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. Timestamp when this IndexEndpoint was last updated.
 This timestamp is not updated when the endpoint's DeployedIndexes are
 updated, e.g. due to updates of the original Indexes they are the
 deployments of.
        .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface IndexEndpointOrBuilder

      • getNetwork

        public String getNetwork()
         Optional. The full name of the Google Compute Engine
 [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)
 to which the IndexEndpoint should be peered.

 Private services access must already be configured for the network. If left
 unspecified, the Endpoint is not peered with any network.

 [network][google.cloud.aiplatform.v1.IndexEndpoint.network] and
 [private_service_connect_config][google.cloud.aiplatform.v1.IndexEndpoint.private_service_connect_config]
 are mutually exclusive.

 [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert):
 `projects/{project}/global/networks/{network}`.
 Where {project} is a project number, as in '12345', and {network} is
 network name.
        string network = 9 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getNetwork in interface IndexEndpointOrBuilder
        Returns:
        The network.

      • getNetworkBytes

        public com.google.protobuf.ByteString getNetworkBytes()
         Optional. The full name of the Google Compute Engine
 [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)
 to which the IndexEndpoint should be peered.

 Private services access must already be configured for the network. If left
 unspecified, the Endpoint is not peered with any network.

 [network][google.cloud.aiplatform.v1.IndexEndpoint.network] and
 [private_service_connect_config][google.cloud.aiplatform.v1.IndexEndpoint.private_service_connect_config]
 are mutually exclusive.

 [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert):
 `projects/{project}/global/networks/{network}`.
 Where {project} is a project number, as in '12345', and {network} is
 network name.
        string network = 9 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getNetworkBytes in interface IndexEndpointOrBuilder
        Returns:
        The bytes for network.

      • getEnablePrivateServiceConnect

        @Deprecated
public boolean getEnablePrivateServiceConnect()
        Deprecated.
        google.cloud.aiplatform.v1.IndexEndpoint.enable_private_service_connect is deprecated. See google/cloud/aiplatform/v1/index_endpoint.proto;l=104
         Optional. Deprecated: If true, expose the IndexEndpoint via private service
 connect.

 Only one of the fields,
 [network][google.cloud.aiplatform.v1.IndexEndpoint.network] or
 [enable_private_service_connect][google.cloud.aiplatform.v1.IndexEndpoint.enable_private_service_connect],
 can be set.
        bool enable_private_service_connect = 10 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEnablePrivateServiceConnect in interface IndexEndpointOrBuilder
        Returns:
        The enablePrivateServiceConnect.

      • hasPrivateServiceConnectConfig

        public boolean hasPrivateServiceConnectConfig()
         Optional. Configuration for private service connect.

 [network][google.cloud.aiplatform.v1.IndexEndpoint.network] and
 [private_service_connect_config][google.cloud.aiplatform.v1.IndexEndpoint.private_service_connect_config]
 are mutually exclusive.
        .google.cloud.aiplatform.v1.PrivateServiceConnectConfig private_service_connect_config = 12 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasPrivateServiceConnectConfig in interface IndexEndpointOrBuilder
        Returns:
        Whether the privateServiceConnectConfig field is set.

      • getPrivateServiceConnectConfig

        public PrivateServiceConnectConfig getPrivateServiceConnectConfig()
         Optional. Configuration for private service connect.

 [network][google.cloud.aiplatform.v1.IndexEndpoint.network] and
 [private_service_connect_config][google.cloud.aiplatform.v1.IndexEndpoint.private_service_connect_config]
 are mutually exclusive.
        .google.cloud.aiplatform.v1.PrivateServiceConnectConfig private_service_connect_config = 12 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPrivateServiceConnectConfig in interface IndexEndpointOrBuilder
        Returns:
        The privateServiceConnectConfig.

      • getPrivateServiceConnectConfigOrBuilder

        public PrivateServiceConnectConfigOrBuilder getPrivateServiceConnectConfigOrBuilder()
         Optional. Configuration for private service connect.

 [network][google.cloud.aiplatform.v1.IndexEndpoint.network] and
 [private_service_connect_config][google.cloud.aiplatform.v1.IndexEndpoint.private_service_connect_config]
 are mutually exclusive.
        .google.cloud.aiplatform.v1.PrivateServiceConnectConfig private_service_connect_config = 12 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPrivateServiceConnectConfigOrBuilder in interface IndexEndpointOrBuilder

      • getPublicEndpointEnabled

        public boolean getPublicEndpointEnabled()
         Optional. If true, the deployed index will be accessible through public
 endpoint.
        bool public_endpoint_enabled = 13 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPublicEndpointEnabled in interface IndexEndpointOrBuilder
        Returns:
        The publicEndpointEnabled.

      • getPublicEndpointDomainName

        public String getPublicEndpointDomainName()
         Output only. If
 [public_endpoint_enabled][google.cloud.aiplatform.v1.IndexEndpoint.public_endpoint_enabled]
 is true, this field will be populated with the domain name to use for this
 index endpoint.
        string public_endpoint_domain_name = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getPublicEndpointDomainName in interface IndexEndpointOrBuilder
        Returns:
        The publicEndpointDomainName.

      • getPublicEndpointDomainNameBytes

        public com.google.protobuf.ByteString getPublicEndpointDomainNameBytes()
         Output only. If
 [public_endpoint_enabled][google.cloud.aiplatform.v1.IndexEndpoint.public_endpoint_enabled]
 is true, this field will be populated with the domain name to use for this
 index endpoint.
        string public_endpoint_domain_name = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getPublicEndpointDomainNameBytes in interface IndexEndpointOrBuilder
        Returns:
        The bytes for publicEndpointDomainName.

      • hasEncryptionSpec

        public boolean hasEncryptionSpec()
         Immutable. Customer-managed encryption key spec for an IndexEndpoint. If
 set, this IndexEndpoint and all sub-resources of this IndexEndpoint will be
 secured by this key.
        .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 15 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        hasEncryptionSpec in interface IndexEndpointOrBuilder
        Returns:
        Whether the encryptionSpec field is set.

      • getEncryptionSpec

        public EncryptionSpec getEncryptionSpec()
         Immutable. Customer-managed encryption key spec for an IndexEndpoint. If
 set, this IndexEndpoint and all sub-resources of this IndexEndpoint will be
 secured by this key.
        .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 15 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getEncryptionSpec in interface IndexEndpointOrBuilder
        Returns:
        The encryptionSpec.

      • getEncryptionSpecOrBuilder

        public EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()
         Immutable. Customer-managed encryption key spec for an IndexEndpoint. If
 set, this IndexEndpoint and all sub-resources of this IndexEndpoint will be
 secured by this key.
        .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 15 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getEncryptionSpecOrBuilder in interface IndexEndpointOrBuilder

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

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

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

      • getDefaultInstanceForType

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