Interface DeployRequest.ModelConfigOrBuilder (3.74.0)

public static interface DeployRequest.ModelConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAcceptEula()

public abstract boolean getAcceptEula()

Optional. Whether the user accepts the End User License Agreement (EULA) for the model.

bool accept_eula = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The acceptEula.

getContainerSpec()

public abstract ModelContainerSpec getContainerSpec()

Optional. The specification of the container that is to be used when deploying. If not set, the default container spec will be used.

.google.cloud.aiplatform.v1beta1.ModelContainerSpec container_spec = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ModelContainerSpec

The containerSpec.

getContainerSpecOrBuilder()

public abstract ModelContainerSpecOrBuilder getContainerSpecOrBuilder()

Optional. The specification of the container that is to be used when deploying. If not set, the default container spec will be used.

.google.cloud.aiplatform.v1beta1.ModelContainerSpec container_spec = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ModelContainerSpecOrBuilder

getHuggingFaceAccessToken()

public abstract String getHuggingFaceAccessToken()

Optional. The Hugging Face read access token used to access the model artifacts of gated models.

string hugging_face_access_token = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The huggingFaceAccessToken.

getHuggingFaceAccessTokenBytes()

public abstract ByteString getHuggingFaceAccessTokenBytes()

Optional. The Hugging Face read access token used to access the model artifacts of gated models.

string hugging_face_access_token = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for huggingFaceAccessToken.

getHuggingFaceCacheEnabled()

public abstract boolean getHuggingFaceCacheEnabled()

Optional. If true, the model will deploy with a cached version instead of directly downloading the model artifacts from Hugging Face. This is suitable for VPC-SC users with limited internet access.

bool hugging_face_cache_enabled = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The huggingFaceCacheEnabled.

getModelDisplayName()

public abstract String getModelDisplayName()

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

string model_display_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The modelDisplayName.

getModelDisplayNameBytes()

public abstract ByteString getModelDisplayNameBytes()

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

string model_display_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for modelDisplayName.

getModelUserId()

public abstract String getModelUserId()

Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name. When not provided, Vertex AI will generate a value for this ID. When Model Registry model is provided, this field will be ignored.

This value may be up to 63 characters, and valid characters are [a-z0-9_-]. The first character cannot be a number or hyphen.

string model_user_id = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The modelUserId.

getModelUserIdBytes()

public abstract ByteString getModelUserIdBytes()

Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name. When not provided, Vertex AI will generate a value for this ID. When Model Registry model is provided, this field will be ignored.

This value may be up to 63 characters, and valid characters are [a-z0-9_-]. The first character cannot be a number or hyphen.

string model_user_id = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for modelUserId.

hasContainerSpec()

public abstract boolean hasContainerSpec()

Optional. The specification of the container that is to be used when deploying. If not set, the default container spec will be used.

.google.cloud.aiplatform.v1beta1.ModelContainerSpec container_spec = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the containerSpec field is set.