Package com.google.cloud.aiplatform.v1

Interface IndexEndpointOrBuilder

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

    • Method Detail

      • getName

        String getName()
         Output only. The resource name of the IndexEndpoint.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Output only. The resource name of the IndexEndpoint.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for name.

      • getDisplayName

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

      • getDisplayNameBytes

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

      • getDescription

        String getDescription()
         The description of the IndexEndpoint.
        string description = 3;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         The description of the IndexEndpoint.
        string description = 3;
        Returns:
        The bytes for description.

      • getDeployedIndexesList

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

      • getDeployedIndexes

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

      • getDeployedIndexesCount

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

      • getDeployedIndexesOrBuilderList

        List<? extends DeployedIndexOrBuilder> getDeployedIndexesOrBuilderList()
         Output only. The indexes deployed in this endpoint.
        repeated .google.cloud.aiplatform.v1.DeployedIndex deployed_indexes = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getDeployedIndexesOrBuilder

        DeployedIndexOrBuilder getDeployedIndexesOrBuilder​(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];

      • getEtag

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

      • getEtagBytes

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

      • getLabelsCount

        int getLabelsCount()
         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;

      • containsLabels

        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;

      • getLabelsMap

        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;

      • getLabelsOrDefault

        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;

      • getLabelsOrThrow

        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;

      • hasCreateTime

        boolean hasCreateTime()
         Output only. Timestamp when this IndexEndpoint was created.
        .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. Timestamp when this IndexEndpoint was created.
        .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

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

      • hasUpdateTime

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

      • getUpdateTime

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

      • getUpdateTimeOrBuilder

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

      • getNetwork

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

      • getNetworkBytes

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

      • getEnablePrivateServiceConnect

        @Deprecated
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];
        Returns:
        The enablePrivateServiceConnect.

      • hasPrivateServiceConnectConfig

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

      • getPrivateServiceConnectConfig

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

      • getPrivateServiceConnectConfigOrBuilder

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

      • getPublicEndpointEnabled

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

      • getPublicEndpointDomainName

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

      • getPublicEndpointDomainNameBytes

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

      • hasEncryptionSpec

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

      • getEncryptionSpec

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

      • getEncryptionSpecOrBuilder

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