Class DeployRequest (3.60.0)

public final class DeployRequest extends GeneratedMessageV3 implements DeployRequestOrBuilder

Request message for ModelGardenService.Deploy.

Protobuf type google.cloud.aiplatform.v1beta1.DeployRequest

Static Fields

DEPLOY_CONFIG_FIELD_NUMBER

public static final int DEPLOY_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

DESTINATION_FIELD_NUMBER

public static final int DESTINATION_FIELD_NUMBER
Field Value
Type Description
int

ENDPOINT_CONFIG_FIELD_NUMBER

public static final int ENDPOINT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

HUGGING_FACE_MODEL_ID_FIELD_NUMBER

public static final int HUGGING_FACE_MODEL_ID_FIELD_NUMBER
Field Value
Type Description
int

MODEL_CONFIG_FIELD_NUMBER

public static final int MODEL_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

PUBLISHER_MODEL_NAME_FIELD_NUMBER

public static final int PUBLISHER_MODEL_NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DeployRequest getDefaultInstance()
Returns
Type Description
DeployRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static DeployRequest.Builder newBuilder()
Returns
Type Description
DeployRequest.Builder

newBuilder(DeployRequest prototype)

public static DeployRequest.Builder newBuilder(DeployRequest prototype)
Parameter
Name Description
prototype DeployRequest
Returns
Type Description
DeployRequest.Builder

parseDelimitedFrom(InputStream input)

public static DeployRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DeployRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DeployRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeployRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DeployRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DeployRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DeployRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeployRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DeployRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DeployRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DeployRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeployRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DeployRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DeployRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DeployRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeployRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DeployRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DeployRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DeployRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeployRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DeployRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DeployRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DeployRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeployRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DeployRequest> parser()
Returns
Type Description
Parser<DeployRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getArtifactsCase()

public DeployRequest.ArtifactsCase getArtifactsCase()
Returns
Type Description
DeployRequest.ArtifactsCase

getDefaultInstanceForType()

public DeployRequest getDefaultInstanceForType()
Returns
Type Description
DeployRequest

getDeployConfig()

public DeployRequest.DeployConfig getDeployConfig()

Optional. The deploy config to use for the deployment. If not specified, the default deploy config will be used.

.google.cloud.aiplatform.v1beta1.DeployRequest.DeployConfig deploy_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DeployRequest.DeployConfig

The deployConfig.

getDeployConfigOrBuilder()

public DeployRequest.DeployConfigOrBuilder getDeployConfigOrBuilder()

Optional. The deploy config to use for the deployment. If not specified, the default deploy config will be used.

.google.cloud.aiplatform.v1beta1.DeployRequest.DeployConfig deploy_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DeployRequest.DeployConfigOrBuilder

getDestination()

public String getDestination()

Required. The resource name of the Location to deploy the model in. Format: projects/{project}/locations/{location}

string destination = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The destination.

getDestinationBytes()

public ByteString getDestinationBytes()

Required. The resource name of the Location to deploy the model in. Format: projects/{project}/locations/{location}

string destination = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for destination.

getEndpointConfig()

public DeployRequest.EndpointConfig getEndpointConfig()

Optional. The endpoint config to use for the deployment. If not specified, the default endpoint config will be used.

.google.cloud.aiplatform.v1beta1.DeployRequest.EndpointConfig endpoint_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DeployRequest.EndpointConfig

The endpointConfig.

getEndpointConfigOrBuilder()

public DeployRequest.EndpointConfigOrBuilder getEndpointConfigOrBuilder()

Optional. The endpoint config to use for the deployment. If not specified, the default endpoint config will be used.

.google.cloud.aiplatform.v1beta1.DeployRequest.EndpointConfig endpoint_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DeployRequest.EndpointConfigOrBuilder

getHuggingFaceModelId()

public String getHuggingFaceModelId()

The Hugging Face model to deploy. Format: Hugging Face model ID like google/gemma-2-2b-it.

string hugging_face_model_id = 2;

Returns
Type Description
String

The huggingFaceModelId.

getHuggingFaceModelIdBytes()

public ByteString getHuggingFaceModelIdBytes()

The Hugging Face model to deploy. Format: Hugging Face model ID like google/gemma-2-2b-it.

string hugging_face_model_id = 2;

Returns
Type Description
ByteString

The bytes for huggingFaceModelId.

getModelConfig()

public DeployRequest.ModelConfig getModelConfig()

Optional. The model config to use for the deployment. If not specified, the default model config will be used.

.google.cloud.aiplatform.v1beta1.DeployRequest.ModelConfig model_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DeployRequest.ModelConfig

The modelConfig.

getModelConfigOrBuilder()

public DeployRequest.ModelConfigOrBuilder getModelConfigOrBuilder()

Optional. The model config to use for the deployment. If not specified, the default model config will be used.

.google.cloud.aiplatform.v1beta1.DeployRequest.ModelConfig model_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DeployRequest.ModelConfigOrBuilder

getParserForType()

public Parser<DeployRequest> getParserForType()
Returns
Type Description
Parser<DeployRequest>
Overrides

getPublisherModelName()

public String getPublisherModelName()

The Model Garden model to deploy. Format: publishers/{publisher}/models/{publisher_model}@{version_id}, or publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001.

string publisher_model_name = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The publisherModelName.

getPublisherModelNameBytes()

public ByteString getPublisherModelNameBytes()

The Model Garden model to deploy. Format: publishers/{publisher}/models/{publisher_model}@{version_id}, or publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001.

string publisher_model_name = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for publisherModelName.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasDeployConfig()

public boolean hasDeployConfig()

Optional. The deploy config to use for the deployment. If not specified, the default deploy config will be used.

.google.cloud.aiplatform.v1beta1.DeployRequest.DeployConfig deploy_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the deployConfig field is set.

hasEndpointConfig()

public boolean hasEndpointConfig()

Optional. The endpoint config to use for the deployment. If not specified, the default endpoint config will be used.

.google.cloud.aiplatform.v1beta1.DeployRequest.EndpointConfig endpoint_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the endpointConfig field is set.

hasHuggingFaceModelId()

public boolean hasHuggingFaceModelId()

The Hugging Face model to deploy. Format: Hugging Face model ID like google/gemma-2-2b-it.

string hugging_face_model_id = 2;

Returns
Type Description
boolean

Whether the huggingFaceModelId field is set.

hasModelConfig()

public boolean hasModelConfig()

Optional. The model config to use for the deployment. If not specified, the default model config will be used.

.google.cloud.aiplatform.v1beta1.DeployRequest.ModelConfig model_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the modelConfig field is set.

hasPublisherModelName()

public boolean hasPublisherModelName()

The Model Garden model to deploy. Format: publishers/{publisher}/models/{publisher_model}@{version_id}, or publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001.

string publisher_model_name = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the publisherModelName field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DeployRequest.Builder newBuilderForType()
Returns
Type Description
DeployRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DeployRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DeployRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public DeployRequest.Builder toBuilder()
Returns
Type Description
DeployRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException