Interface DeployRequest.EndpointConfigOrBuilder (3.74.0)

public static interface DeployRequest.EndpointConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDedicatedEndpointDisabled()

public abstract boolean 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.

bool dedicated_endpoint_disabled = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The dedicatedEndpointDisabled.

getDedicatedEndpointEnabled() (deprecated)

public abstract boolean getDedicatedEndpointEnabled()

Deprecated. google.cloud.aiplatform.v1.DeployRequest.EndpointConfig.dedicated_endpoint_enabled is deprecated. See google/cloud/aiplatform/v1/model_garden_service.proto;l=159

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.

bool dedicated_endpoint_enabled = 2 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The dedicatedEndpointEnabled.

getEndpointDisplayName()

public abstract String getEndpointDisplayName()

Optional. The user-specified display name of the endpoint. If not set, a default name will be used.

string endpoint_display_name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The endpointDisplayName.

getEndpointDisplayNameBytes()

public abstract ByteString getEndpointDisplayNameBytes()

Optional. The user-specified display name of the endpoint. If not set, a default name will be used.

string endpoint_display_name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for endpointDisplayName.

getEndpointUserId()

public abstract String 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.

string endpoint_user_id = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The endpointUserId.

getEndpointUserIdBytes()

public abstract ByteString getEndpointUserIdBytes()

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.

string endpoint_user_id = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for endpointUserId.