Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::Endpoint (v0.59.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

#client_connection_config

def client_connection_config() -> ::Google::Cloud::AIPlatform::V1::ClientConnectionConfig
Returns

#client_connection_config=

def client_connection_config=(value) -> ::Google::Cloud::AIPlatform::V1::ClientConnectionConfig
Parameter
Returns

#create_time

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

#dedicated_endpoint_dns

def dedicated_endpoint_dns() -> ::String
Returns
  • (::String) — Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog.

#dedicated_endpoint_enabled

def dedicated_endpoint_enabled() -> ::Boolean
Returns
  • (::Boolean) — If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon.

#dedicated_endpoint_enabled=

def dedicated_endpoint_enabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon.
Returns
  • (::Boolean) — If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon.

#deployed_models

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

#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 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 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 consist of any UTF-8 characters.

#enable_private_service_connect

def enable_private_service_connect() -> ::Boolean
Returns

#enable_private_service_connect=

def enable_private_service_connect=(value) -> ::Boolean
Parameter
Returns

#encryption_spec

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

#encryption_spec=

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

#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 JobService.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) — Optional. 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) — Optional. 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) — Optional. 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

#predict_request_response_logging_config=

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

#private_service_connect_config

def private_service_connect_config() -> ::Google::Cloud::AIPlatform::V1::PrivateServiceConnectConfig
Returns

#private_service_connect_config=

def private_service_connect_config=(value) -> ::Google::Cloud::AIPlatform::V1::PrivateServiceConnectConfig
Parameter
Returns

#satisfies_pzi

def satisfies_pzi() -> ::Boolean
Returns
  • (::Boolean) — Output only. Reserved for future use.

#satisfies_pzs

def satisfies_pzs() -> ::Boolean
Returns
  • (::Boolean) — Output only. Reserved for future use.

#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