Google Cloud Ai Platform V1 Client - Class Endpoint (1.0.0-RC1)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class Endpoint.

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

Generated from protobuf message google.cloud.aiplatform.v1.Endpoint

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Output only. The resource name of the Endpoint.
↳ display_name 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.
↳ description string

The description of the Endpoint.
↳ deployed_models 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.
↳ traffic_split array|Google\Protobuf\Internal\MapField

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.
↳ etag string

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
↳ labels array|Google\Protobuf\Internal\MapField

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.
↳ create_time Google\Protobuf\Timestamp

Output only. Timestamp when this Endpoint was created.
↳ update_time Google\Protobuf\Timestamp

Output only. Timestamp when this Endpoint was last updated.
↳ encryption_spec 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.
↳ network 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.
↳ enable_private_service_connect bool

Deprecated: If true, expose the Endpoint via private service connect. Only one of the fields, network or enable_private_service_connect, can be set.
↳ private_service_connect_config Google\Cloud\AIPlatform\V1\PrivateServiceConnectConfig

Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive.
↳ model_deployment_monitoring_job 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}
↳ predict_request_response_logging_config Google\Cloud\AIPlatform\V1\PredictRequestResponseLoggingConfig

Configures the request-response logging for online prediction.

getName

Output only. The resource name of the Endpoint.

Returns
Type Description
string

setName

Output only. The resource name of the Endpoint.

Parameter
Name Description
var string
Returns
Type Description
$this

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.

Returns
Type Description
string

setDisplayName

Required. The display name of the Endpoint.

The name can be up to 128 characters long and can consist of any UTF-8 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

The description of the Endpoint.

Returns
Type Description
string

setDescription

The description of the Endpoint.

Parameter
Name Description
var string
Returns
Type Description
$this

getDeployedModels

Output only. The models deployed in this Endpoint.

To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setDeployedModels

Output only. The models deployed in this Endpoint.

To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.

Parameter
Name Description
var array<Google\Cloud\AIPlatform\V1\DeployedModel>
Returns
Type Description
$this

getTrafficSplit

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
Type Description
Google\Protobuf\Internal\MapField

setTrafficSplit

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.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getEtag

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Returns
Type Description
string

setEtag

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Parameter
Name Description
var string
Returns
Type Description
$this

getLabels

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
Type Description
Google\Protobuf\Internal\MapField

setLabels

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.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getCreateTime

Output only. Timestamp when this Endpoint was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when this Endpoint was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. Timestamp when this Endpoint was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Timestamp when this Endpoint was last updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

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.

Returns
Type Description
Google\Cloud\AIPlatform\V1\EncryptionSpec|null

hasEncryptionSpec

clearEncryptionSpec

setEncryptionSpec

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.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\EncryptionSpec
Returns
Type Description
$this

getNetwork

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
Type Description
string

setNetwork

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getEnablePrivateServiceConnect

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
Type Description
bool

setEnablePrivateServiceConnect

Deprecated: If true, expose the Endpoint via private service connect.

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

Parameter
Name Description
var bool
Returns
Type Description
$this

getPrivateServiceConnectConfig

Optional. Configuration for private service connect.

network and private_service_connect_config are mutually exclusive.

Returns
Type Description
Google\Cloud\AIPlatform\V1\PrivateServiceConnectConfig|null

hasPrivateServiceConnectConfig

clearPrivateServiceConnectConfig

setPrivateServiceConnectConfig

Optional. Configuration for private service connect.

network and private_service_connect_config are mutually exclusive.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\PrivateServiceConnectConfig
Returns
Type Description
$this

getModelDeploymentMonitoringJob

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}

Returns
Type Description
string

setModelDeploymentMonitoringJob

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}

Parameter
Name Description
var string
Returns
Type Description
$this

getPredictRequestResponseLoggingConfig

Configures the request-response logging for online prediction.

Returns
Type Description
Google\Cloud\AIPlatform\V1\PredictRequestResponseLoggingConfig|null

hasPredictRequestResponseLoggingConfig

clearPredictRequestResponseLoggingConfig

setPredictRequestResponseLoggingConfig

Configures the request-response logging for online prediction.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\PredictRequestResponseLoggingConfig
Returns
Type Description
$this