com.google.cloud.aiplatform.v1

Class DeployRequest.ModelConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.aiplatform.v1.DeployRequest.ModelConfig

All Implemented Interfaces:

DeployRequest.ModelConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

DeployRequest

public static final class DeployRequest.ModelConfig
extends com.google.protobuf.GeneratedMessage
implements DeployRequest.ModelConfigOrBuilder

 The model config to use for the deployment.
 

Protobuf type google.cloud.aiplatform.v1.DeployRequest.ModelConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeployRequest.ModelConfig.Builder The model config to use for the deployment.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACCEPT_EULA_FIELD_NUMBER
static int	CONTAINER_SPEC_FIELD_NUMBER
static int	HUGGING_FACE_ACCESS_TOKEN_FIELD_NUMBER
static int	HUGGING_FACE_CACHE_ENABLED_FIELD_NUMBER
static int	MODEL_DISPLAY_NAME_FIELD_NUMBER
static int	MODEL_USER_ID_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
boolean	getAcceptEula() Optional.
ModelContainerSpec	getContainerSpec() Optional.
ModelContainerSpecOrBuilder	getContainerSpecOrBuilder() Optional.
static DeployRequest.ModelConfig	getDefaultInstance()
DeployRequest.ModelConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<DeployRequest.ModelConfig>	getParserForType()
int	getSerializedSize()
boolean	hasContainerSpec() Optional.
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static DeployRequest.ModelConfig.Builder	newBuilder()
static DeployRequest.ModelConfig.Builder	newBuilder(DeployRequest.ModelConfig prototype)
DeployRequest.ModelConfig.Builder	newBuilderForType()
protected DeployRequest.ModelConfig.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static DeployRequest.ModelConfig	parseDelimitedFrom(InputStream input)
static DeployRequest.ModelConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DeployRequest.ModelConfig	parseFrom(byte[] data)
static DeployRequest.ModelConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DeployRequest.ModelConfig	parseFrom(ByteBuffer data)
static DeployRequest.ModelConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DeployRequest.ModelConfig	parseFrom(com.google.protobuf.ByteString data)
static DeployRequest.ModelConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DeployRequest.ModelConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static DeployRequest.ModelConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DeployRequest.ModelConfig	parseFrom(InputStream input)
static DeployRequest.ModelConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<DeployRequest.ModelConfig>	parser()
DeployRequest.ModelConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

ACCEPT_EULA_FIELD_NUMBER

public static final int ACCEPT_EULA_FIELD_NUMBER

See Also:

Constant Field Values

HUGGING_FACE_ACCESS_TOKEN_FIELD_NUMBER

public static final int HUGGING_FACE_ACCESS_TOKEN_FIELD_NUMBER

See Also:

Constant Field Values

HUGGING_FACE_CACHE_ENABLED_FIELD_NUMBER

public static final int HUGGING_FACE_CACHE_ENABLED_FIELD_NUMBER

See Also:

Constant Field Values

MODEL_DISPLAY_NAME_FIELD_NUMBER

public static final int MODEL_DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

CONTAINER_SPEC_FIELD_NUMBER

public static final int CONTAINER_SPEC_FIELD_NUMBER

See Also:

Constant Field Values

MODEL_USER_ID_FIELD_NUMBER

public static final int MODEL_USER_ID_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getAcceptEula

public 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];

Specified by:

getAcceptEula in interface DeployRequest.ModelConfigOrBuilder

Returns:

The acceptEula.

getHuggingFaceAccessToken

public 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];

Specified by:

getHuggingFaceAccessToken in interface DeployRequest.ModelConfigOrBuilder

Returns:

The huggingFaceAccessToken.

getHuggingFaceAccessTokenBytes

public 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];

Specified by:

getHuggingFaceAccessTokenBytes in interface DeployRequest.ModelConfigOrBuilder

Returns:

The bytes for huggingFaceAccessToken.

getHuggingFaceCacheEnabled

public 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];

Specified by:

getHuggingFaceCacheEnabled in interface DeployRequest.ModelConfigOrBuilder

Returns:

The huggingFaceCacheEnabled.

getModelDisplayName

public 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];

Specified by:

getModelDisplayName in interface DeployRequest.ModelConfigOrBuilder

Returns:

The modelDisplayName.

getModelDisplayNameBytes

public 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];

Specified by:

getModelDisplayNameBytes in interface DeployRequest.ModelConfigOrBuilder

Returns:

The bytes for modelDisplayName.

hasContainerSpec

public 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];

Specified by:

hasContainerSpec in interface DeployRequest.ModelConfigOrBuilder

Returns:

Whether the containerSpec field is set.

getContainerSpec

public 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];

Specified by:

getContainerSpec in interface DeployRequest.ModelConfigOrBuilder

Returns:

The containerSpec.

getContainerSpecOrBuilder

public 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];

Specified by:

getContainerSpecOrBuilder in interface DeployRequest.ModelConfigOrBuilder

getModelUserId

public 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];

Specified by:

getModelUserId in interface DeployRequest.ModelConfigOrBuilder

Returns:

The modelUserId.

getModelUserIdBytes

public 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];

Specified by:

getModelUserIdBytes in interface DeployRequest.ModelConfigOrBuilder

Returns:

The bytes for modelUserId.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static DeployRequest.ModelConfig parseFrom(ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DeployRequest.ModelConfig parseFrom(ByteBuffer data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DeployRequest.ModelConfig parseFrom(com.google.protobuf.ByteString data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DeployRequest.ModelConfig parseFrom(com.google.protobuf.ByteString data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DeployRequest.ModelConfig parseFrom(byte[] data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DeployRequest.ModelConfig parseFrom(byte[] data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DeployRequest.ModelConfig parseFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseFrom

public static DeployRequest.ModelConfig parseFrom(InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static DeployRequest.ModelConfig parseDelimitedFrom(InputStream input)
                                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static DeployRequest.ModelConfig parseDelimitedFrom(InputStream input,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws IOException

Throws:

IOException

parseFrom

public static DeployRequest.ModelConfig parseFrom(com.google.protobuf.CodedInputStream input)
                                           throws IOException

Throws:

IOException

parseFrom

public static DeployRequest.ModelConfig parseFrom(com.google.protobuf.CodedInputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

newBuilderForType

public DeployRequest.ModelConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static DeployRequest.ModelConfig.Builder newBuilder()

newBuilder

public static DeployRequest.ModelConfig.Builder newBuilder(DeployRequest.ModelConfig prototype)

toBuilder

public DeployRequest.ModelConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected DeployRequest.ModelConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static DeployRequest.ModelConfig getDefaultInstance()

parser

public static com.google.protobuf.Parser<DeployRequest.ModelConfig> parser()

getParserForType

public com.google.protobuf.Parser<DeployRequest.ModelConfig> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public DeployRequest.ModelConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder