Package com.google.cloud.aiplatform.v1

Interface EndpointOrBuilder

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

    • Method Detail

      • getName

        String getName()
         Output only. The resource name of the Endpoint.
        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 Endpoint.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for name.

      • getDisplayName

        String getDisplayName()
         Required. The display name of the Endpoint.
 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 Endpoint.
 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 Endpoint.
        string description = 3;
        Returns:
        The description.

      • getDescriptionBytes

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

      • getDeployedModelsList

        List<DeployedModel> getDeployedModelsList()
         Output only. The models deployed in this Endpoint.
 To add or remove DeployedModels use
 [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel]
 and
 [EndpointService.UndeployModel][google.cloud.aiplatform.v1.EndpointService.UndeployModel]
 respectively.
        repeated .google.cloud.aiplatform.v1.DeployedModel deployed_models = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getDeployedModels

        DeployedModel getDeployedModels​(int index)
         Output only. The models deployed in this Endpoint.
 To add or remove DeployedModels use
 [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel]
 and
 [EndpointService.UndeployModel][google.cloud.aiplatform.v1.EndpointService.UndeployModel]
 respectively.
        repeated .google.cloud.aiplatform.v1.DeployedModel deployed_models = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getDeployedModelsCount

        int getDeployedModelsCount()
         Output only. The models deployed in this Endpoint.
 To add or remove DeployedModels use
 [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel]
 and
 [EndpointService.UndeployModel][google.cloud.aiplatform.v1.EndpointService.UndeployModel]
 respectively.
        repeated .google.cloud.aiplatform.v1.DeployedModel deployed_models = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getDeployedModelsOrBuilderList

        List<? extends DeployedModelOrBuilder> getDeployedModelsOrBuilderList()
         Output only. The models deployed in this Endpoint.
 To add or remove DeployedModels use
 [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel]
 and
 [EndpointService.UndeployModel][google.cloud.aiplatform.v1.EndpointService.UndeployModel]
 respectively.
        repeated .google.cloud.aiplatform.v1.DeployedModel deployed_models = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getDeployedModelsOrBuilder

        DeployedModelOrBuilder getDeployedModelsOrBuilder​(int index)
         Output only. The models deployed in this Endpoint.
 To add or remove DeployedModels use
 [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel]
 and
 [EndpointService.UndeployModel][google.cloud.aiplatform.v1.EndpointService.UndeployModel]
 respectively.
        repeated .google.cloud.aiplatform.v1.DeployedModel deployed_models = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getTrafficSplitCount

        int getTrafficSplitCount()
         A map from a DeployedModel's ID to the percentage of this Endpoint's
 traffic that should be forwarded to that DeployedModel.

 If a DeployedModel's ID is not listed in this map, then it receives no
 traffic.

 The traffic percentage values must add up to 100, or map must be empty if
 the Endpoint is to not accept any traffic at a moment.
        map<string, int32> traffic_split = 5;

      • containsTrafficSplit

        boolean containsTrafficSplit​(String key)
         A map from a DeployedModel's ID to the percentage of this Endpoint's
 traffic that should be forwarded to that DeployedModel.

 If a DeployedModel's ID is not listed in this map, then it receives no
 traffic.

 The traffic percentage values must add up to 100, or map must be empty if
 the Endpoint is to not accept any traffic at a moment.
        map<string, int32> traffic_split = 5;

      • getTrafficSplitMap

        Map<String,​Integer> getTrafficSplitMap()
         A map from a DeployedModel's ID to the percentage of this Endpoint's
 traffic that should be forwarded to that DeployedModel.

 If a DeployedModel's ID is not listed in this map, then it receives no
 traffic.

 The traffic percentage values must add up to 100, or map must be empty if
 the Endpoint is to not accept any traffic at a moment.
        map<string, int32> traffic_split = 5;

      • getTrafficSplitOrDefault

        int getTrafficSplitOrDefault​(String key,
                             int defaultValue)
         A map from a DeployedModel's ID to the percentage of this Endpoint's
 traffic that should be forwarded to that DeployedModel.

 If a DeployedModel's ID is not listed in this map, then it receives no
 traffic.

 The traffic percentage values must add up to 100, or map must be empty if
 the Endpoint is to not accept any traffic at a moment.
        map<string, int32> traffic_split = 5;

      • getTrafficSplitOrThrow

        int getTrafficSplitOrThrow​(String key)
         A map from a DeployedModel's ID to the percentage of this Endpoint's
 traffic that should be forwarded to that DeployedModel.

 If a DeployedModel's ID is not listed in this map, then it receives no
 traffic.

 The traffic percentage values must add up to 100, or map must be empty if
 the Endpoint is to not accept any traffic at a moment.
        map<string, int32> traffic_split = 5;

      • getEtag

        String getEtag()
         Used to perform consistent read-modify-write updates. If not set, a blind
 "overwrite" update happens.
        string etag = 6;
        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 = 6;
        Returns:
        The bytes for etag.

      • getLabelsCount

        int getLabelsCount()
         The labels with user-defined metadata to organize your Endpoints.

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

      • containsLabels

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

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

      • getLabelsMap

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

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

      • getLabelsOrDefault

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

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

      • getLabelsOrThrow

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

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

      • hasCreateTime

        boolean hasCreateTime()
         Output only. Timestamp when this Endpoint was created.
        .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        com.google.protobuf.Timestamp getCreateTime()
         Output only. Timestamp when this Endpoint was created.
        .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Timestamp when this Endpoint was created.
        .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasUpdateTime

        boolean hasUpdateTime()
         Output only. Timestamp when this Endpoint was last updated.
        .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        com.google.protobuf.Timestamp getUpdateTime()
         Output only. Timestamp when this Endpoint was last updated.
        .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. Timestamp when this Endpoint was last updated.
        .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasEncryptionSpec

        boolean hasEncryptionSpec()
         Customer-managed encryption key spec for an Endpoint. If set, this
 Endpoint and all sub-resources of this Endpoint will be secured by
 this key.
        .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 10;
        Returns:
        Whether the encryptionSpec field is set.

      • getEncryptionSpec

        EncryptionSpec getEncryptionSpec()
         Customer-managed encryption key spec for an Endpoint. If set, this
 Endpoint and all sub-resources of this Endpoint will be secured by
 this key.
        .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 10;
        Returns:
        The encryptionSpec.

      • getEncryptionSpecOrBuilder

        EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()
         Customer-managed encryption key spec for an Endpoint. If set, this
 Endpoint and all sub-resources of this Endpoint will be secured by
 this key.
        .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 10;

      • 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 Endpoint should be peered.

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

 Only one of the fields,
 [network][google.cloud.aiplatform.v1.Endpoint.network] or
 [enable_private_service_connect][google.cloud.aiplatform.v1.Endpoint.enable_private_service_connect],
 can be set.

 [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 = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
        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 Endpoint should be peered.

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

 Only one of the fields,
 [network][google.cloud.aiplatform.v1.Endpoint.network] or
 [enable_private_service_connect][google.cloud.aiplatform.v1.Endpoint.enable_private_service_connect],
 can be set.

 [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 = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for network.

      • getEnablePrivateServiceConnect

        @Deprecated
boolean getEnablePrivateServiceConnect()
        Deprecated.
        google.cloud.aiplatform.v1.Endpoint.enable_private_service_connect is deprecated. See google/cloud/aiplatform/v1/endpoint.proto;l=126
         Deprecated: If true, expose the Endpoint via private service connect.

 Only one of the fields,
 [network][google.cloud.aiplatform.v1.Endpoint.network] or
 [enable_private_service_connect][google.cloud.aiplatform.v1.Endpoint.enable_private_service_connect],
 can be set.
        bool enable_private_service_connect = 17 [deprecated = true];
        Returns:
        The enablePrivateServiceConnect.

      • getModelDeploymentMonitoringJob

        String getModelDeploymentMonitoringJob()
         Output only. Resource name of the Model Monitoring job associated with this
 Endpoint if monitoring is enabled by
 [JobService.CreateModelDeploymentMonitoringJob][google.cloud.aiplatform.v1.JobService.CreateModelDeploymentMonitoringJob].
 Format:
 `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
        string model_deployment_monitoring_job = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Returns:
        The modelDeploymentMonitoringJob.

      • getModelDeploymentMonitoringJobBytes

        com.google.protobuf.ByteString getModelDeploymentMonitoringJobBytes()
         Output only. Resource name of the Model Monitoring job associated with this
 Endpoint if monitoring is enabled by
 [JobService.CreateModelDeploymentMonitoringJob][google.cloud.aiplatform.v1.JobService.CreateModelDeploymentMonitoringJob].
 Format:
 `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
        string model_deployment_monitoring_job = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for modelDeploymentMonitoringJob.

      • hasPredictRequestResponseLoggingConfig

        boolean hasPredictRequestResponseLoggingConfig()
         Configures the request-response logging for online prediction.
        .google.cloud.aiplatform.v1.PredictRequestResponseLoggingConfig predict_request_response_logging_config = 18;
        Returns:
        Whether the predictRequestResponseLoggingConfig field is set.

      • getPredictRequestResponseLoggingConfig

        PredictRequestResponseLoggingConfig getPredictRequestResponseLoggingConfig()
         Configures the request-response logging for online prediction.
        .google.cloud.aiplatform.v1.PredictRequestResponseLoggingConfig predict_request_response_logging_config = 18;
        Returns:
        The predictRequestResponseLoggingConfig.

      • getPredictRequestResponseLoggingConfigOrBuilder

        PredictRequestResponseLoggingConfigOrBuilder getPredictRequestResponseLoggingConfigOrBuilder()
         Configures the request-response logging for online prediction.
        .google.cloud.aiplatform.v1.PredictRequestResponseLoggingConfig predict_request_response_logging_config = 18;