Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class EndpointConfig.
The endpoint config to use for the deployment.
Generated from protobuf messagegoogle.cloud.aiplatform.v1.DeployRequest.EndpointConfig
Namespace
Google \ Cloud \ AIPlatform \ V1 \ DeployRequest
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ endpoint_display_name
string
Optional. The user-specified display name of the endpoint. If not set, a default name will be used.
↳ dedicated_endpoint_enabled
bool
Optional. Deprecated. Use dedicated_endpoint_disabled instead. 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 limitations will be removed soon.
↳ dedicated_endpoint_disabled
bool
Optional. By default, if dedicated endpoint is enabled, 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 limitations will be removed soon. If this field is set to true, the dedicated endpoint will be disabled and the deployed model will be exposed through the shared DNS {region}-aiplatform.googleapis.com.
↳ endpoint_user_id
string
Optional. Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are[a-z0-9-]. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are[0-9]with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as?endpoint_id=12345. This is the fallback for fields that are not included in either the URI or the body.
getEndpointDisplayName
Optional. The user-specified display name of the endpoint. If not set, a
default name will be used.
Returns
Type
Description
string
setEndpointDisplayName
Optional. The user-specified display name of the endpoint. If not set, a
default name will be used.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDedicatedEndpointEnabled
Optional. Deprecated. Use dedicated_endpoint_disabled instead.
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 limitations will be removed soon.
Returns
Type
Description
bool
setDedicatedEndpointEnabled
Optional. Deprecated. Use dedicated_endpoint_disabled instead.
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 limitations will be removed soon.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getDedicatedEndpointDisabled
Optional. By default, if dedicated endpoint is enabled, 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 limitations will be
removed soon.
If this field is set to true, the dedicated endpoint will be disabled
and the deployed model will be exposed through the shared DNS
{region}-aiplatform.googleapis.com.
Returns
Type
Description
bool
setDedicatedEndpointDisabled
Optional. By default, if dedicated endpoint is enabled, 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 limitations will be
removed soon.
If this field is set to true, the dedicated endpoint will be disabled
and the deployed model will be exposed through the shared DNS
{region}-aiplatform.googleapis.com.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getEndpointUserId
Optional. Immutable. The ID to use for endpoint, which will become the
final component of the endpoint resource name. If not provided, Vertex AI
will generate a value for this ID.
If the first character is a letter, this value may be up to 63
characters, and valid characters are[a-z0-9-]. The last character must
be a letter or number.
If the first character is a number, this value may be up to 9 characters,
and valid characters are[0-9]with no leading zeros.
When using HTTP/JSON, this field is populated
based on a query string argument, such as?endpoint_id=12345. This is
the fallback for fields that are not included in either the URI or the
body.
Returns
Type
Description
string
setEndpointUserId
Optional. Immutable. The ID to use for endpoint, which will become the
final component of the endpoint resource name. If not provided, Vertex AI
will generate a value for this ID.
If the first character is a letter, this value may be up to 63
characters, and valid characters are[a-z0-9-]. The last character must
be a letter or number.
If the first character is a number, this value may be up to 9 characters,
and valid characters are[0-9]with no leading zeros.
When using HTTP/JSON, this field is populated
based on a query string argument, such as?endpoint_id=12345. This is
the fallback for fields that are not included in either the URI or the
body.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Ai Platform V1 Client - Class EndpointConfig (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-ai-platform/latest/V1.DeployRequest.EndpointConfig)\n- [1.34.0](/php/docs/reference/cloud-ai-platform/1.34.0/V1.DeployRequest.EndpointConfig)\n- [1.33.0](/php/docs/reference/cloud-ai-platform/1.33.0/V1.DeployRequest.EndpointConfig)\n- [1.32.1](/php/docs/reference/cloud-ai-platform/1.32.1/V1.DeployRequest.EndpointConfig)\n- [1.31.0](/php/docs/reference/cloud-ai-platform/1.31.0/V1.DeployRequest.EndpointConfig)\n- [1.30.0](/php/docs/reference/cloud-ai-platform/1.30.0/V1.DeployRequest.EndpointConfig)\n- [1.26.0](/php/docs/reference/cloud-ai-platform/1.26.0/V1.DeployRequest.EndpointConfig)\n- [1.23.0](/php/docs/reference/cloud-ai-platform/1.23.0/V1.DeployRequest.EndpointConfig)\n- [1.22.0](/php/docs/reference/cloud-ai-platform/1.22.0/V1.DeployRequest.EndpointConfig)\n- [1.21.0](/php/docs/reference/cloud-ai-platform/1.21.0/V1.DeployRequest.EndpointConfig)\n- [1.20.0](/php/docs/reference/cloud-ai-platform/1.20.0/V1.DeployRequest.EndpointConfig)\n- [1.19.0](/php/docs/reference/cloud-ai-platform/1.19.0/V1.DeployRequest.EndpointConfig)\n- [1.18.0](/php/docs/reference/cloud-ai-platform/1.18.0/V1.DeployRequest.EndpointConfig)\n- [1.17.0](/php/docs/reference/cloud-ai-platform/1.17.0/V1.DeployRequest.EndpointConfig)\n- [1.16.0](/php/docs/reference/cloud-ai-platform/1.16.0/V1.DeployRequest.EndpointConfig)\n- [1.15.0](/php/docs/reference/cloud-ai-platform/1.15.0/V1.DeployRequest.EndpointConfig)\n- [1.14.0](/php/docs/reference/cloud-ai-platform/1.14.0/V1.DeployRequest.EndpointConfig)\n- [1.13.1](/php/docs/reference/cloud-ai-platform/1.13.1/V1.DeployRequest.EndpointConfig)\n- [1.12.0](/php/docs/reference/cloud-ai-platform/1.12.0/V1.DeployRequest.EndpointConfig)\n- [1.11.0](/php/docs/reference/cloud-ai-platform/1.11.0/V1.DeployRequest.EndpointConfig)\n- [1.10.0](/php/docs/reference/cloud-ai-platform/1.10.0/V1.DeployRequest.EndpointConfig)\n- [1.9.0](/php/docs/reference/cloud-ai-platform/1.9.0/V1.DeployRequest.EndpointConfig)\n- [1.8.0](/php/docs/reference/cloud-ai-platform/1.8.0/V1.DeployRequest.EndpointConfig)\n- [1.7.0](/php/docs/reference/cloud-ai-platform/1.7.0/V1.DeployRequest.EndpointConfig)\n- [1.6.0](/php/docs/reference/cloud-ai-platform/1.6.0/V1.DeployRequest.EndpointConfig)\n- [1.5.0](/php/docs/reference/cloud-ai-platform/1.5.0/V1.DeployRequest.EndpointConfig)\n- [1.4.0](/php/docs/reference/cloud-ai-platform/1.4.0/V1.DeployRequest.EndpointConfig)\n- [1.3.0](/php/docs/reference/cloud-ai-platform/1.3.0/V1.DeployRequest.EndpointConfig)\n- [1.2.0](/php/docs/reference/cloud-ai-platform/1.2.0/V1.DeployRequest.EndpointConfig)\n- [1.1.0](/php/docs/reference/cloud-ai-platform/1.1.0/V1.DeployRequest.EndpointConfig)\n- [1.0.0](/php/docs/reference/cloud-ai-platform/1.0.0/V1.DeployRequest.EndpointConfig)\n- [0.39.0](/php/docs/reference/cloud-ai-platform/0.39.0/V1.DeployRequest.EndpointConfig)\n- [0.38.0](/php/docs/reference/cloud-ai-platform/0.38.0/V1.DeployRequest.EndpointConfig)\n- [0.37.1](/php/docs/reference/cloud-ai-platform/0.37.1/V1.DeployRequest.EndpointConfig)\n- [0.32.0](/php/docs/reference/cloud-ai-platform/0.32.0/V1.DeployRequest.EndpointConfig)\n- [0.31.0](/php/docs/reference/cloud-ai-platform/0.31.0/V1.DeployRequest.EndpointConfig)\n- [0.30.0](/php/docs/reference/cloud-ai-platform/0.30.0/V1.DeployRequest.EndpointConfig)\n- [0.29.0](/php/docs/reference/cloud-ai-platform/0.29.0/V1.DeployRequest.EndpointConfig)\n- [0.28.0](/php/docs/reference/cloud-ai-platform/0.28.0/V1.DeployRequest.EndpointConfig)\n- [0.27.0](/php/docs/reference/cloud-ai-platform/0.27.0/V1.DeployRequest.EndpointConfig)\n- [0.26.2](/php/docs/reference/cloud-ai-platform/0.26.2/V1.DeployRequest.EndpointConfig)\n- [0.25.0](/php/docs/reference/cloud-ai-platform/0.25.0/V1.DeployRequest.EndpointConfig)\n- [0.24.0](/php/docs/reference/cloud-ai-platform/0.24.0/V1.DeployRequest.EndpointConfig)\n- [0.23.0](/php/docs/reference/cloud-ai-platform/0.23.0/V1.DeployRequest.EndpointConfig)\n- [0.22.0](/php/docs/reference/cloud-ai-platform/0.22.0/V1.DeployRequest.EndpointConfig)\n- [0.21.0](/php/docs/reference/cloud-ai-platform/0.21.0/V1.DeployRequest.EndpointConfig)\n- [0.20.0](/php/docs/reference/cloud-ai-platform/0.20.0/V1.DeployRequest.EndpointConfig)\n- [0.19.0](/php/docs/reference/cloud-ai-platform/0.19.0/V1.DeployRequest.EndpointConfig)\n- [0.18.0](/php/docs/reference/cloud-ai-platform/0.18.0/V1.DeployRequest.EndpointConfig)\n- [0.17.0](/php/docs/reference/cloud-ai-platform/0.17.0/V1.DeployRequest.EndpointConfig)\n- [0.16.0](/php/docs/reference/cloud-ai-platform/0.16.0/V1.DeployRequest.EndpointConfig)\n- [0.15.0](/php/docs/reference/cloud-ai-platform/0.15.0/V1.DeployRequest.EndpointConfig)\n- [0.13.0](/php/docs/reference/cloud-ai-platform/0.13.0/V1.DeployRequest.EndpointConfig)\n- [0.12.0](/php/docs/reference/cloud-ai-platform/0.12.0/V1.DeployRequest.EndpointConfig)\n- [0.11.1](/php/docs/reference/cloud-ai-platform/0.11.1/V1.DeployRequest.EndpointConfig)\n- [0.10.0](/php/docs/reference/cloud-ai-platform/0.10.0/V1.DeployRequest.EndpointConfig) \nReference documentation and code samples for the Google Cloud Ai Platform V1 Client class EndpointConfig.\n\nThe endpoint config to use for the deployment.\n\nGenerated from protobuf message `google.cloud.aiplatform.v1.DeployRequest.EndpointConfig`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AIPlatform \\\\ V1 \\\\ DeployRequest\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getEndpointDisplayName\n\nOptional. The user-specified display name of the endpoint. If not set, a\ndefault name will be used.\n\n### setEndpointDisplayName\n\nOptional. The user-specified display name of the endpoint. If not set, a\ndefault name will be used.\n\n### getDedicatedEndpointEnabled\n\nOptional. Deprecated. Use dedicated_endpoint_disabled instead.\n\nIf true, the endpoint will be exposed through a\ndedicated DNS \\[Endpoint.dedicated_endpoint_dns\\]. Your request to the\ndedicated DNS will be isolated from other users' traffic and will have\nbetter performance and reliability. Note: Once you enabled dedicated\nendpoint, you won't be able to send request to the shared DNS\n{region}-aiplatform.googleapis.com. The limitations will be removed soon.\n\n### setDedicatedEndpointEnabled\n\nOptional. Deprecated. Use dedicated_endpoint_disabled instead.\n\nIf true, the endpoint will be exposed through a\ndedicated DNS \\[Endpoint.dedicated_endpoint_dns\\]. Your request to the\ndedicated DNS will be isolated from other users' traffic and will have\nbetter performance and reliability. Note: Once you enabled dedicated\nendpoint, you won't be able to send request to the shared DNS\n{region}-aiplatform.googleapis.com. The limitations will be removed soon.\n\n### getDedicatedEndpointDisabled\n\nOptional. By default, if dedicated endpoint is enabled, the endpoint will\nbe exposed through a dedicated DNS \\[Endpoint.dedicated_endpoint_dns\\].\n\nYour request to the dedicated DNS will be isolated from other users'\ntraffic and will have better performance and reliability. Note: Once you\nenabled dedicated endpoint, you won't be able to send request to the\nshared DNS {region}-aiplatform.googleapis.com. The limitations will be\nremoved soon.\nIf this field is set to true, the dedicated endpoint will be disabled\nand the deployed model will be exposed through the shared DNS\n{region}-aiplatform.googleapis.com.\n\n### setDedicatedEndpointDisabled\n\nOptional. By default, if dedicated endpoint is enabled, the endpoint will\nbe exposed through a dedicated DNS \\[Endpoint.dedicated_endpoint_dns\\].\n\nYour request to the dedicated DNS will be isolated from other users'\ntraffic and will have better performance and reliability. Note: Once you\nenabled dedicated endpoint, you won't be able to send request to the\nshared DNS {region}-aiplatform.googleapis.com. The limitations will be\nremoved soon.\nIf this field is set to true, the dedicated endpoint will be disabled\nand the deployed model will be exposed through the shared DNS\n{region}-aiplatform.googleapis.com.\n\n### getEndpointUserId\n\nOptional. Immutable. The ID to use for endpoint, which will become the\nfinal component of the endpoint resource name. If not provided, Vertex AI\nwill generate a value for this ID.\n\nIf the first character is a letter, this value may be up to 63\ncharacters, and valid characters are `[a-z0-9-]`. The last character must\nbe a letter or number.\nIf the first character is a number, this value may be up to 9 characters,\nand valid characters are `[0-9]` with no leading zeros.\nWhen using HTTP/JSON, this field is populated\nbased on a query string argument, such as `?endpoint_id=12345`. This is\nthe fallback for fields that are not included in either the URI or the\nbody.\n\n### setEndpointUserId\n\nOptional. Immutable. The ID to use for endpoint, which will become the\nfinal component of the endpoint resource name. If not provided, Vertex AI\nwill generate a value for this ID.\n\nIf the first character is a letter, this value may be up to 63\ncharacters, and valid characters are `[a-z0-9-]`. The last character must\nbe a letter or number.\nIf the first character is a number, this value may be up to 9 characters,\nand valid characters are `[0-9]` with no leading zeros.\nWhen using HTTP/JSON, this field is populated\nbased on a query string argument, such as `?endpoint_id=12345`. This is\nthe fallback for fields that are not included in either the URI or the\nbody."]]
