Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::Endpoint (v0.15.0)

Version 0.15.0

• 0.38.0 (latest)
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.1
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::Endpoint.

Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. Timestamp when this Endpoint was created.

#deployed_models

def deployed_models() -> ::Array<::Google::Cloud::AIPlatform::V1::DeployedModel>

Returns

• (::Array<::Google::Cloud::AIPlatform::V1::DeployedModel>) — Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.

#description

def description() -> ::String

Returns

• (::String) — The description of the Endpoint.

#description=

def description=(value) -> ::String

Parameter

• value (::String) — The description of the Endpoint.

Returns

• (::String) — The description of the Endpoint.

#display_name

def display_name() -> ::String

Returns

• (::String) — Required. The display name of the Endpoint. The name can be up to 128 characters long and can be consist of any UTF-8 characters.

#display_name=

def display_name=(value) -> ::String

Parameter

• value (::String) — Required. The display name of the Endpoint. The name can be up to 128 characters long and can be consist of any UTF-8 characters.

Returns

• (::String) — Required. The display name of the Endpoint. The name can be up to 128 characters long and can be consist of any UTF-8 characters.

#enable_private_service_connect

def enable_private_service_connect() -> ::Boolean

Returns

• (::Boolean) — Deprecated: If true, expose the Endpoint via private service connect.

  Only one of the fields, network or enable_private_service_connect, can be set.

#enable_private_service_connect=

def enable_private_service_connect=(value) -> ::Boolean

Parameter

• value (::Boolean) — Deprecated: If true, expose the Endpoint via private service connect.

  Only one of the fields, network or enable_private_service_connect, can be set.

Returns

• (::Boolean) — Deprecated: If true, expose the Endpoint via private service connect.

  Only one of the fields, network or enable_private_service_connect, can be set.

#encryption_spec

def encryption_spec() -> ::Google::Cloud::AIPlatform::V1::EncryptionSpec

Returns

• (::Google::Cloud::AIPlatform::V1::EncryptionSpec) — 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.

#encryption_spec=

def encryption_spec=(value) -> ::Google::Cloud::AIPlatform::V1::EncryptionSpec

Parameter

• value (::Google::Cloud::AIPlatform::V1::EncryptionSpec) — 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.

Returns

• (::Google::Cloud::AIPlatform::V1::EncryptionSpec) — 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.

#etag

def etag() -> ::String

Returns

• (::String) — Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

#etag=

def etag=(value) -> ::String

Parameter

• value (::String) — Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Returns

• (::String) — Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

• (::Google::Protobuf::Map{::String => ::String}) — 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.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

• value (::Google::Protobuf::Map{::String => ::String}) — 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.

Returns

• (::Google::Protobuf::Map{::String => ::String}) — 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.

#model_deployment_monitoring_job

def model_deployment_monitoring_job() -> ::String

Returns

• (::String) — Output only. Resource name of the Model Monitoring job associated with this Endpoint if monitoring is enabled by [CreateModelDeploymentMonitoringJob][]. Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

#name

def name() -> ::String

Returns

• (::String) — Output only. The resource name of the Endpoint.

#network

def network() -> ::String

Returns

• (::String) — The full name of the Google Compute Engine network 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 or enable_private_service_connect, can be set.

  Format: projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is network name.

#network=

def network=(value) -> ::String

Parameter

• value (::String) — The full name of the Google Compute Engine network 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 or enable_private_service_connect, can be set.

  Format: projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is network name.

Returns

• (::String) — The full name of the Google Compute Engine network 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 or enable_private_service_connect, can be set.

  Format: projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is network name.

#predict_request_response_logging_config

def predict_request_response_logging_config() -> ::Google::Cloud::AIPlatform::V1::PredictRequestResponseLoggingConfig

Returns

• (::Google::Cloud::AIPlatform::V1::PredictRequestResponseLoggingConfig) — Configures the request-response logging for online prediction.

#predict_request_response_logging_config=

def predict_request_response_logging_config=(value) -> ::Google::Cloud::AIPlatform::V1::PredictRequestResponseLoggingConfig

Parameter

• value (::Google::Cloud::AIPlatform::V1::PredictRequestResponseLoggingConfig) — Configures the request-response logging for online prediction.

Returns

• (::Google::Cloud::AIPlatform::V1::PredictRequestResponseLoggingConfig) — Configures the request-response logging for online prediction.

#traffic_split

def traffic_split() -> ::Google::Protobuf::Map{::String => ::Integer}

Returns

• (::Google::Protobuf::Map{::String => ::Integer}) — 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.

#traffic_split=

def traffic_split=(value) -> ::Google::Protobuf::Map{::String => ::Integer}

Parameter

• value (::Google::Protobuf::Map{::String => ::Integer}) — 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.

Returns

• (::Google::Protobuf::Map{::String => ::Integer}) — 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.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. Timestamp when this Endpoint was last updated.