- 1.35.0 (latest)
- 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
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__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< 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
↳ update_time
↳ encryption_spec
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
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
↳ dedicated_endpoint_enabled
bool
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_dns
string
Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Depending on the features enabled, uid might be a random number or a string. For example, if fast_tryout is enabled, uid will be fasttryout. Format: https://{endpoint_id}.{region}-{uid}.prediction.vertexai.goog
.
↳ client_connection_config
↳ satisfies_pzs
bool
Output only. Reserved for future use.
↳ satisfies_pzi
bool
Output only. Reserved for future use.
↳ gen_ai_advanced_features_config
GenAiAdvancedFeaturesConfig
Optional. Configuration for GenAiAdvancedFeatures. If the endpoint is serving GenAI models, advanced features like native RAG integration can be configured. Currently, only Model Garden models are supported.
getName
Output only. The resource name of the Endpoint.
string
setName
Output only. The resource name of the Endpoint.
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.
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.
var
string
$this
getDescription
The description of the Endpoint.
string
setDescription
The description of the Endpoint.
var
string
$this
getDeployedModels
Output only. The models deployed in this Endpoint.
To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.
setDeployedModels
Output only. The models deployed in this Endpoint.
To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.
$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.
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.
$this
getEtag
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
string
setEtag
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
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.
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.
$this
getCreateTime
Output only. Timestamp when this Endpoint was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when this Endpoint was created.
$this
getUpdateTime
Output only. Timestamp when this Endpoint was last updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp when this Endpoint was last updated.
$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.
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.
$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.
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.
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.
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.
var
bool
$this
getPrivateServiceConnectConfig
Optional. Configuration for private service connect.
network and private_service_connect_config are mutually exclusive.
hasPrivateServiceConnectConfig
clearPrivateServiceConnectConfig
setPrivateServiceConnectConfig
Optional. Configuration for private service connect.
network and private_service_connect_config are mutually exclusive.
$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}
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}
var
string
$this
getPredictRequestResponseLoggingConfig
Configures the request-response logging for online prediction.
hasPredictRequestResponseLoggingConfig
clearPredictRequestResponseLoggingConfig
setPredictRequestResponseLoggingConfig
Configures the request-response logging for online prediction.
$this
getDedicatedEndpointEnabled
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.
bool
setDedicatedEndpointEnabled
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.
var
bool
$this
getDedicatedEndpointDns
Output only. DNS of the dedicated endpoint. Will only be populated if
dedicated_endpoint_enabled is true. Depending on the features enabled, uid
might be a random number or a string. For example, if fast_tryout is
enabled, uid will be fasttryout. Format: https://{endpoint_id}.{region}-{uid}.prediction.vertexai.goog
.
string
setDedicatedEndpointDns
Output only. DNS of the dedicated endpoint. Will only be populated if
dedicated_endpoint_enabled is true. Depending on the features enabled, uid
might be a random number or a string. For example, if fast_tryout is
enabled, uid will be fasttryout. Format: https://{endpoint_id}.{region}-{uid}.prediction.vertexai.goog
.
var
string
$this
getClientConnectionConfig
Configurations that are applied to the endpoint for online prediction.
hasClientConnectionConfig
clearClientConnectionConfig
setClientConnectionConfig
Configurations that are applied to the endpoint for online prediction.
$this
getSatisfiesPzs
Output only. Reserved for future use.
bool
setSatisfiesPzs
Output only. Reserved for future use.
var
bool
$this
getSatisfiesPzi
Output only. Reserved for future use.
bool
setSatisfiesPzi
Output only. Reserved for future use.
var
bool
$this
getGenAiAdvancedFeaturesConfig
Optional. Configuration for GenAiAdvancedFeatures. If the endpoint is serving GenAI models, advanced features like native RAG integration can be configured. Currently, only Model Garden models are supported.
hasGenAiAdvancedFeaturesConfig
clearGenAiAdvancedFeaturesConfig
setGenAiAdvancedFeaturesConfig
Optional. Configuration for GenAiAdvancedFeatures. If the endpoint is serving GenAI models, advanced features like native RAG integration can be configured. Currently, only Model Garden models are supported.
$this
