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
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
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: |
↳ 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. |
↳ model_deployment_monitoring_job |
string
Output only. Resource name of the Model Monitoring job associated with this Endpoint if monitoring is enabled by CreateModelDeploymentMonitoringJob. Format: |
↳ 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.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. The resource name of the Endpoint.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| 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.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
The description of the Endpoint.
Generated from protobuf field string description = 3;
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
The description of the Endpoint.
Generated from protobuf field string description = 3;
| 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.
Generated from protobuf field repeated .google.cloud.aiplatform.v1.DeployedModel deployed_models = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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.
Generated from protobuf field repeated .google.cloud.aiplatform.v1.DeployedModel deployed_models = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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.
Generated from protobuf field map<string, int32> traffic_split = 5;
| 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.
Generated from protobuf field map<string, int32> traffic_split = 5;
| 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.
Generated from protobuf field string etag = 6;
| Returns | |
|---|---|
| Type | Description |
string | |
setEtag
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
Generated from protobuf field string etag = 6;
| 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.
Generated from protobuf field map<string, string> labels = 7;
| 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.
Generated from protobuf field map<string, string> labels = 7;
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Timestamp when this Endpoint was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when this Endpoint was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. Timestamp when this Endpoint was last updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp when this Endpoint was last updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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.
Generated from protobuf field .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 10;
| 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.
Generated from protobuf field .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 10;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\EncryptionSpec
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNetwork
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.
Generated from protobuf field string network = 13 [(.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
string | |
setNetwork
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.
Generated from protobuf field string network = 13 [(.google.api.resource_reference) = {
| 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.
Generated from protobuf field bool enable_private_service_connect = 17 [deprecated = true];
| 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.
Generated from protobuf field bool enable_private_service_connect = 17 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getModelDeploymentMonitoringJob
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}
Generated from protobuf field string model_deployment_monitoring_job = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
string | |
setModelDeploymentMonitoringJob
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}
Generated from protobuf field string model_deployment_monitoring_job = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPredictRequestResponseLoggingConfig
Configures the request-response logging for online prediction.
Generated from protobuf field .google.cloud.aiplatform.v1.PredictRequestResponseLoggingConfig predict_request_response_logging_config = 18;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\PredictRequestResponseLoggingConfig|null | |
hasPredictRequestResponseLoggingConfig
clearPredictRequestResponseLoggingConfig
setPredictRequestResponseLoggingConfig
Configures the request-response logging for online prediction.
Generated from protobuf field .google.cloud.aiplatform.v1.PredictRequestResponseLoggingConfig predict_request_response_logging_config = 18;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\PredictRequestResponseLoggingConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |