com.google.cloud.aiplatform.v1

Interface DeployRequest.ModelConfigOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

DeployRequest.ModelConfig, DeployRequest.ModelConfig.Builder

Enclosing class:

DeployRequest

public static interface DeployRequest.ModelConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getAcceptEula() Optional.
ModelContainerSpec	getContainerSpec() Optional.
ModelContainerSpecOrBuilder	getContainerSpecOrBuilder() Optional.
String	getHuggingFaceAccessToken() Optional.
com.google.protobuf.ByteString	getHuggingFaceAccessTokenBytes() Optional.
boolean	getHuggingFaceCacheEnabled() Optional.
String	getModelDisplayName() Optional.
com.google.protobuf.ByteString	getModelDisplayNameBytes() Optional.
String	getModelUserId() Optional.
com.google.protobuf.ByteString	getModelUserIdBytes() Optional.
boolean	hasContainerSpec() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getAcceptEula

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:

The acceptEula.

getHuggingFaceAccessToken

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:

The huggingFaceAccessToken.

getHuggingFaceAccessTokenBytes

com.google.protobuf.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:

The bytes for huggingFaceAccessToken.

getHuggingFaceCacheEnabled

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:

The huggingFaceCacheEnabled.

getModelDisplayName

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:

The modelDisplayName.

getModelDisplayNameBytes

com.google.protobuf.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:

The bytes for modelDisplayName.

hasContainerSpec

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.v1.ModelContainerSpec container_spec = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the containerSpec field is set.

getContainerSpec

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.v1.ModelContainerSpec container_spec = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The containerSpec.

getContainerSpecOrBuilder

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.v1.ModelContainerSpec container_spec = 5 [(.google.api.field_behavior) = OPTIONAL];

getModelUserId

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:

The modelUserId.

getModelUserIdBytes

com.google.protobuf.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:

The bytes for modelUserId.