- 1.47.0 (latest)
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.1
- 1.31.0
- 1.30.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.1
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 0.39.0
- 0.38.0
- 0.37.1
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.2
- 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.13.0
- 0.12.0
- 0.11.1
- 0.10.0
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.
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
: 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.
↳ 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: 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.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
string
setName
Output only. The resource name of the Endpoint.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
string
$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];
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];
var
string
$this
getDescription
The description of the Endpoint.
Generated from protobuf field string description = 3;
string
setDescription
The description of the Endpoint.
Generated from protobuf field string description = 3;
var
string
$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];
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];
$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;
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;
var
array|Google\Protobuf\Internal\MapField
$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;
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;
var
string
$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;
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;
var
array|Google\Protobuf\Internal\MapField
$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];
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];
var
Google\Protobuf\Timestamp
$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];
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];
var
Google\Protobuf\Timestamp
$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;
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;
$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) = {
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) = {
var
string
$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];
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];
var
bool
$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) = {
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) = {
var
string
$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;
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;
$this
