Class DeployPublisherModelRequest.Builder (3.57.0)

public static final class DeployPublisherModelRequest.Builder extends GeneratedMessageV3.Builder<DeployPublisherModelRequest.Builder> implements DeployPublisherModelRequestOrBuilder

Request message for ModelGardenService.DeployPublisherModel.

Protobuf type google.cloud.aiplatform.v1beta1.DeployPublisherModelRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public DeployPublisherModelRequest build()
Returns
Type Description
DeployPublisherModelRequest

buildPartial()

public DeployPublisherModelRequest buildPartial()
Returns
Type Description
DeployPublisherModelRequest

clear()

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

clearAcceptEula()

public DeployPublisherModelRequest.Builder clearAcceptEula()

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

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

Returns
Type Description
DeployPublisherModelRequest.Builder

This builder for chaining.

clearDedicatedResources()

public DeployPublisherModelRequest.Builder clearDedicatedResources()

Optional. The dedicated resources to use for the endpoint. If not set, the default resources will be used.

.google.cloud.aiplatform.v1beta1.DedicatedResources dedicated_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DeployPublisherModelRequest.Builder

clearDestination()

public DeployPublisherModelRequest.Builder clearDestination()

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

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

Returns
Type Description
DeployPublisherModelRequest.Builder

This builder for chaining.

clearEndpointDisplayName()

public DeployPublisherModelRequest.Builder clearEndpointDisplayName()

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

string endpoint_display_name = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DeployPublisherModelRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearHuggingFaceAccessToken()

public DeployPublisherModelRequest.Builder clearHuggingFaceAccessToken()

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

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

Returns
Type Description
DeployPublisherModelRequest.Builder

This builder for chaining.

clearModel()

public DeployPublisherModelRequest.Builder clearModel()

Required. The name of the PublisherModel resource. Format: publishers/{publisher}/models/{publisher_model}@{version_id}, or publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001 or Hugging Face model ID like google/gemma-2-2b-it.

string model = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DeployPublisherModelRequest.Builder

This builder for chaining.

clearModelDisplayName()

public DeployPublisherModelRequest.Builder clearModelDisplayName()

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

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

Returns
Type Description
DeployPublisherModelRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clone()

public DeployPublisherModelRequest.Builder clone()
Returns
Type Description
DeployPublisherModelRequest.Builder
Overrides

getAcceptEula()

public boolean getAcceptEula()

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

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

Returns
Type Description
boolean

The acceptEula.

getDedicatedResources()

public DedicatedResources getDedicatedResources()

Optional. The dedicated resources to use for the endpoint. If not set, the default resources will be used.

.google.cloud.aiplatform.v1beta1.DedicatedResources dedicated_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DedicatedResources

The dedicatedResources.

getDedicatedResourcesBuilder()

public DedicatedResources.Builder getDedicatedResourcesBuilder()

Optional. The dedicated resources to use for the endpoint. If not set, the default resources will be used.

.google.cloud.aiplatform.v1beta1.DedicatedResources dedicated_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DedicatedResources.Builder

getDedicatedResourcesOrBuilder()

public DedicatedResourcesOrBuilder getDedicatedResourcesOrBuilder()

Optional. The dedicated resources to use for the endpoint. If not set, the default resources will be used.

.google.cloud.aiplatform.v1beta1.DedicatedResources dedicated_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DedicatedResourcesOrBuilder

getDefaultInstanceForType()

public DeployPublisherModelRequest getDefaultInstanceForType()
Returns
Type Description
DeployPublisherModelRequest

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 = 2 [(.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 = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for destination.

getEndpointDisplayName()

public String getEndpointDisplayName()

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

string endpoint_display_name = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The endpointDisplayName.

getEndpointDisplayNameBytes()

public ByteString getEndpointDisplayNameBytes()

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

string endpoint_display_name = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for endpointDisplayName.

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 = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The huggingFaceAccessToken.

getHuggingFaceAccessTokenBytes()

public ByteString getHuggingFaceAccessTokenBytes()

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

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

Returns
Type Description
ByteString

The bytes for huggingFaceAccessToken.

getModel()

public String getModel()

Required. The name of the PublisherModel resource. Format: publishers/{publisher}/models/{publisher_model}@{version_id}, or publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001 or Hugging Face model ID like google/gemma-2-2b-it.

string model = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The model.

getModelBytes()

public ByteString getModelBytes()

Required. The name of the PublisherModel resource. Format: publishers/{publisher}/models/{publisher_model}@{version_id}, or publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001 or Hugging Face model ID like google/gemma-2-2b-it.

string model = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for model.

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

Returns
Type Description
String

The modelDisplayName.

getModelDisplayNameBytes()

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

Returns
Type Description
ByteString

The bytes for modelDisplayName.

hasDedicatedResources()

public boolean hasDedicatedResources()

Optional. The dedicated resources to use for the endpoint. If not set, the default resources will be used.

.google.cloud.aiplatform.v1beta1.DedicatedResources dedicated_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the dedicatedResources field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDedicatedResources(DedicatedResources value)

public DeployPublisherModelRequest.Builder mergeDedicatedResources(DedicatedResources value)

Optional. The dedicated resources to use for the endpoint. If not set, the default resources will be used.

.google.cloud.aiplatform.v1beta1.DedicatedResources dedicated_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DedicatedResources
Returns
Type Description
DeployPublisherModelRequest.Builder

mergeFrom(DeployPublisherModelRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setAcceptEula(boolean value)

public DeployPublisherModelRequest.Builder setAcceptEula(boolean value)

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

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

Parameter
Name Description
value boolean

The acceptEula to set.

Returns
Type Description
DeployPublisherModelRequest.Builder

This builder for chaining.

setDedicatedResources(DedicatedResources value)

public DeployPublisherModelRequest.Builder setDedicatedResources(DedicatedResources value)

Optional. The dedicated resources to use for the endpoint. If not set, the default resources will be used.

.google.cloud.aiplatform.v1beta1.DedicatedResources dedicated_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DedicatedResources
Returns
Type Description
DeployPublisherModelRequest.Builder

setDedicatedResources(DedicatedResources.Builder builderForValue)

public DeployPublisherModelRequest.Builder setDedicatedResources(DedicatedResources.Builder builderForValue)

Optional. The dedicated resources to use for the endpoint. If not set, the default resources will be used.

.google.cloud.aiplatform.v1beta1.DedicatedResources dedicated_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue DedicatedResources.Builder
Returns
Type Description
DeployPublisherModelRequest.Builder

setDestination(String value)

public DeployPublisherModelRequest.Builder setDestination(String value)

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

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

Parameter
Name Description
value String

The destination to set.

Returns
Type Description
DeployPublisherModelRequest.Builder

This builder for chaining.

setDestinationBytes(ByteString value)

public DeployPublisherModelRequest.Builder setDestinationBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for destination to set.

Returns
Type Description
DeployPublisherModelRequest.Builder

This builder for chaining.

setEndpointDisplayName(String value)

public DeployPublisherModelRequest.Builder setEndpointDisplayName(String value)

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

string endpoint_display_name = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The endpointDisplayName to set.

Returns
Type Description
DeployPublisherModelRequest.Builder

This builder for chaining.

setEndpointDisplayNameBytes(ByteString value)

public DeployPublisherModelRequest.Builder setEndpointDisplayNameBytes(ByteString value)

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

string endpoint_display_name = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for endpointDisplayName to set.

Returns
Type Description
DeployPublisherModelRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setHuggingFaceAccessToken(String value)

public DeployPublisherModelRequest.Builder setHuggingFaceAccessToken(String value)

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

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

Parameter
Name Description
value String

The huggingFaceAccessToken to set.

Returns
Type Description
DeployPublisherModelRequest.Builder

This builder for chaining.

setHuggingFaceAccessTokenBytes(ByteString value)

public DeployPublisherModelRequest.Builder setHuggingFaceAccessTokenBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for huggingFaceAccessToken to set.

Returns
Type Description
DeployPublisherModelRequest.Builder

This builder for chaining.

setModel(String value)

public DeployPublisherModelRequest.Builder setModel(String value)

Required. The name of the PublisherModel resource. Format: publishers/{publisher}/models/{publisher_model}@{version_id}, or publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001 or Hugging Face model ID like google/gemma-2-2b-it.

string model = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The model to set.

Returns
Type Description
DeployPublisherModelRequest.Builder

This builder for chaining.

setModelBytes(ByteString value)

public DeployPublisherModelRequest.Builder setModelBytes(ByteString value)

Required. The name of the PublisherModel resource. Format: publishers/{publisher}/models/{publisher_model}@{version_id}, or publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001 or Hugging Face model ID like google/gemma-2-2b-it.

string model = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for model to set.

Returns
Type Description
DeployPublisherModelRequest.Builder

This builder for chaining.

setModelDisplayName(String value)

public DeployPublisherModelRequest.Builder setModelDisplayName(String value)

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

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

Parameter
Name Description
value String

The modelDisplayName to set.

Returns
Type Description
DeployPublisherModelRequest.Builder

This builder for chaining.

setModelDisplayNameBytes(ByteString value)

public DeployPublisherModelRequest.Builder setModelDisplayNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for modelDisplayName to set.

Returns
Type Description
DeployPublisherModelRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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