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 message google.cloud.aiplatform.v1.DeployRequest.EndpointConfig
Namespace
Google \ Cloud \ AIPlatform \ V1 \ DeployRequestMethods
__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 |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|