Class DeployRequest.Builder (3.60.0)

public static final class DeployRequest.Builder extends GeneratedMessageV3.Builder<DeployRequest.Builder> implements DeployRequestOrBuilder

Request message for ModelGardenService.Deploy.

Protobuf type google.cloud.aiplatform.v1beta1.DeployRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DeployRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DeployRequest.Builder
Overrides

build()

public DeployRequest build()
Returns
Type Description
DeployRequest

buildPartial()

public DeployRequest buildPartial()
Returns
Type Description
DeployRequest

clear()

public DeployRequest.Builder clear()
Returns
Type Description
DeployRequest.Builder
Overrides

clearArtifacts()

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

clearDeployConfig()

public DeployRequest.Builder clearDeployConfig()

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.Builder

clearDestination()

public DeployRequest.Builder clearDestination()

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
DeployRequest.Builder

This builder for chaining.

clearEndpointConfig()

public DeployRequest.Builder clearEndpointConfig()

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.Builder

clearField(Descriptors.FieldDescriptor field)

public DeployRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
DeployRequest.Builder
Overrides

clearHuggingFaceModelId()

public DeployRequest.Builder clearHuggingFaceModelId()

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
DeployRequest.Builder

This builder for chaining.

clearModelConfig()

public DeployRequest.Builder clearModelConfig()

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.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public DeployRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
DeployRequest.Builder
Overrides

clearPublisherModelName()

public DeployRequest.Builder clearPublisherModelName()

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
DeployRequest.Builder

This builder for chaining.

clone()

public DeployRequest.Builder clone()
Returns
Type Description
DeployRequest.Builder
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.

getDeployConfigBuilder()

public DeployRequest.DeployConfig.Builder getDeployConfigBuilder()

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.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getEndpointConfigBuilder()

public DeployRequest.EndpointConfig.Builder getEndpointConfigBuilder()

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.Builder

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.

getModelConfigBuilder()

public DeployRequest.ModelConfig.Builder getModelConfigBuilder()

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.Builder

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

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDeployConfig(DeployRequest.DeployConfig value)

public DeployRequest.Builder mergeDeployConfig(DeployRequest.DeployConfig value)

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

Parameter
Name Description
value DeployRequest.DeployConfig
Returns
Type Description
DeployRequest.Builder

mergeEndpointConfig(DeployRequest.EndpointConfig value)

public DeployRequest.Builder mergeEndpointConfig(DeployRequest.EndpointConfig value)

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

Parameter
Name Description
value DeployRequest.EndpointConfig
Returns
Type Description
DeployRequest.Builder

mergeFrom(DeployRequest other)

public DeployRequest.Builder mergeFrom(DeployRequest other)
Parameter
Name Description
other DeployRequest
Returns
Type Description
DeployRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DeployRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeployRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public DeployRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DeployRequest.Builder
Overrides

mergeModelConfig(DeployRequest.ModelConfig value)

public DeployRequest.Builder mergeModelConfig(DeployRequest.ModelConfig value)

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

Parameter
Name Description
value DeployRequest.ModelConfig
Returns
Type Description
DeployRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DeployRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DeployRequest.Builder
Overrides

setDeployConfig(DeployRequest.DeployConfig value)

public DeployRequest.Builder setDeployConfig(DeployRequest.DeployConfig value)

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

Parameter
Name Description
value DeployRequest.DeployConfig
Returns
Type Description
DeployRequest.Builder

setDeployConfig(DeployRequest.DeployConfig.Builder builderForValue)

public DeployRequest.Builder setDeployConfig(DeployRequest.DeployConfig.Builder builderForValue)

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

Parameter
Name Description
builderForValue DeployRequest.DeployConfig.Builder
Returns
Type Description
DeployRequest.Builder

setDestination(String value)

public DeployRequest.Builder setDestination(String value)

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) = { ... }

Parameter
Name Description
value String

The destination to set.

Returns
Type Description
DeployRequest.Builder

This builder for chaining.

setDestinationBytes(ByteString value)

public DeployRequest.Builder setDestinationBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for destination to set.

Returns
Type Description
DeployRequest.Builder

This builder for chaining.

setEndpointConfig(DeployRequest.EndpointConfig value)

public DeployRequest.Builder setEndpointConfig(DeployRequest.EndpointConfig value)

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

Parameter
Name Description
value DeployRequest.EndpointConfig
Returns
Type Description
DeployRequest.Builder

setEndpointConfig(DeployRequest.EndpointConfig.Builder builderForValue)

public DeployRequest.Builder setEndpointConfig(DeployRequest.EndpointConfig.Builder builderForValue)

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

Parameter
Name Description
builderForValue DeployRequest.EndpointConfig.Builder
Returns
Type Description
DeployRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public DeployRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DeployRequest.Builder
Overrides

setHuggingFaceModelId(String value)

public DeployRequest.Builder setHuggingFaceModelId(String value)

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

string hugging_face_model_id = 2;

Parameter
Name Description
value String

The huggingFaceModelId to set.

Returns
Type Description
DeployRequest.Builder

This builder for chaining.

setHuggingFaceModelIdBytes(ByteString value)

public DeployRequest.Builder setHuggingFaceModelIdBytes(ByteString value)

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

string hugging_face_model_id = 2;

Parameter
Name Description
value ByteString

The bytes for huggingFaceModelId to set.

Returns
Type Description
DeployRequest.Builder

This builder for chaining.

setModelConfig(DeployRequest.ModelConfig value)

public DeployRequest.Builder setModelConfig(DeployRequest.ModelConfig value)

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

Parameter
Name Description
value DeployRequest.ModelConfig
Returns
Type Description
DeployRequest.Builder

setModelConfig(DeployRequest.ModelConfig.Builder builderForValue)

public DeployRequest.Builder setModelConfig(DeployRequest.ModelConfig.Builder builderForValue)

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

Parameter
Name Description
builderForValue DeployRequest.ModelConfig.Builder
Returns
Type Description
DeployRequest.Builder

setPublisherModelName(String value)

public DeployRequest.Builder setPublisherModelName(String value)

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) = { ... }

Parameter
Name Description
value String

The publisherModelName to set.

Returns
Type Description
DeployRequest.Builder

This builder for chaining.

setPublisherModelNameBytes(ByteString value)

public DeployRequest.Builder setPublisherModelNameBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for publisherModelName to set.

Returns
Type Description
DeployRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DeployRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
DeployRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final DeployRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DeployRequest.Builder
Overrides