Class UploadModelRequest.Builder (3.43.0)

public static final class UploadModelRequest.Builder extends GeneratedMessageV3.Builder<UploadModelRequest.Builder> implements UploadModelRequestOrBuilder

Request message for ModelService.UploadModel.

Protobuf type google.cloud.aiplatform.v1beta1.UploadModelRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public UploadModelRequest build()
Returns
Type Description
UploadModelRequest

buildPartial()

public UploadModelRequest buildPartial()
Returns
Type Description
UploadModelRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearModel()

public UploadModelRequest.Builder clearModel()

Required. The Model to create.

.google.cloud.aiplatform.v1beta1.Model model = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
UploadModelRequest.Builder

clearModelId()

public UploadModelRequest.Builder clearModelId()

Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name.

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

Returns
Type Description
UploadModelRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearParent()

public UploadModelRequest.Builder clearParent()

Required. The resource name of the Location into which to upload the Model. Format: projects/{project}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
UploadModelRequest.Builder

This builder for chaining.

clearParentModel()

public UploadModelRequest.Builder clearParentModel()

Optional. The resource name of the model into which to upload the version. Only specify this field when uploading a new version.

string parent_model = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
UploadModelRequest.Builder

This builder for chaining.

clearServiceAccount()

public UploadModelRequest.Builder clearServiceAccount()

Optional. The user-provided custom service account to use to do the model upload. If empty, Vertex AI Service Agent will be used to access resources needed to upload the model. This account must belong to the target project where the model is uploaded to, i.e., the project specified in the parent field of this request and have necessary read permissions (to Google Cloud Storage, Artifact Registry, etc.).

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

Returns
Type Description
UploadModelRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public UploadModelRequest getDefaultInstanceForType()
Returns
Type Description
UploadModelRequest

getDescriptorForType()

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

getModel()

public Model getModel()

Required. The Model to create.

.google.cloud.aiplatform.v1beta1.Model model = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Model

The model.

getModelBuilder()

public Model.Builder getModelBuilder()

Required. The Model to create.

.google.cloud.aiplatform.v1beta1.Model model = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Model.Builder

getModelId()

public String getModelId()

Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name.

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

Returns
Type Description
String

The modelId.

getModelIdBytes()

public ByteString getModelIdBytes()

Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name.

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

Returns
Type Description
ByteString

The bytes for modelId.

getModelOrBuilder()

public ModelOrBuilder getModelOrBuilder()

Required. The Model to create.

.google.cloud.aiplatform.v1beta1.Model model = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ModelOrBuilder

getParent()

public String getParent()

Required. The resource name of the Location into which to upload the Model. Format: projects/{project}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The resource name of the Location into which to upload the Model. Format: projects/{project}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getParentModel()

public String getParentModel()

Optional. The resource name of the model into which to upload the version. Only specify this field when uploading a new version.

string parent_model = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The parentModel.

getParentModelBytes()

public ByteString getParentModelBytes()

Optional. The resource name of the model into which to upload the version. Only specify this field when uploading a new version.

string parent_model = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for parentModel.

getServiceAccount()

public String getServiceAccount()

Optional. The user-provided custom service account to use to do the model upload. If empty, Vertex AI Service Agent will be used to access resources needed to upload the model. This account must belong to the target project where the model is uploaded to, i.e., the project specified in the parent field of this request and have necessary read permissions (to Google Cloud Storage, Artifact Registry, etc.).

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

Returns
Type Description
String

The serviceAccount.

getServiceAccountBytes()

public ByteString getServiceAccountBytes()

Optional. The user-provided custom service account to use to do the model upload. If empty, Vertex AI Service Agent will be used to access resources needed to upload the model. This account must belong to the target project where the model is uploaded to, i.e., the project specified in the parent field of this request and have necessary read permissions (to Google Cloud Storage, Artifact Registry, etc.).

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

Returns
Type Description
ByteString

The bytes for serviceAccount.

hasModel()

public boolean hasModel()

Required. The Model to create.

.google.cloud.aiplatform.v1beta1.Model model = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the model field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(UploadModelRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeModel(Model value)

public UploadModelRequest.Builder mergeModel(Model value)

Required. The Model to create.

.google.cloud.aiplatform.v1beta1.Model model = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Model
Returns
Type Description
UploadModelRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setModel(Model value)

public UploadModelRequest.Builder setModel(Model value)

Required. The Model to create.

.google.cloud.aiplatform.v1beta1.Model model = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Model
Returns
Type Description
UploadModelRequest.Builder

setModel(Model.Builder builderForValue)

public UploadModelRequest.Builder setModel(Model.Builder builderForValue)

Required. The Model to create.

.google.cloud.aiplatform.v1beta1.Model model = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Model.Builder
Returns
Type Description
UploadModelRequest.Builder

setModelId(String value)

public UploadModelRequest.Builder setModelId(String value)

Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name.

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

Parameter
Name Description
value String

The modelId to set.

Returns
Type Description
UploadModelRequest.Builder

This builder for chaining.

setModelIdBytes(ByteString value)

public UploadModelRequest.Builder setModelIdBytes(ByteString value)

Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name.

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

Parameter
Name Description
value ByteString

The bytes for modelId to set.

Returns
Type Description
UploadModelRequest.Builder

This builder for chaining.

setParent(String value)

public UploadModelRequest.Builder setParent(String value)

Required. The resource name of the Location into which to upload the Model. Format: projects/{project}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
UploadModelRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public UploadModelRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the Location into which to upload the Model. Format: projects/{project}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
UploadModelRequest.Builder

This builder for chaining.

setParentModel(String value)

public UploadModelRequest.Builder setParentModel(String value)

Optional. The resource name of the model into which to upload the version. Only specify this field when uploading a new version.

string parent_model = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The parentModel to set.

Returns
Type Description
UploadModelRequest.Builder

This builder for chaining.

setParentModelBytes(ByteString value)

public UploadModelRequest.Builder setParentModelBytes(ByteString value)

Optional. The resource name of the model into which to upload the version. Only specify this field when uploading a new version.

string parent_model = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for parentModel to set.

Returns
Type Description
UploadModelRequest.Builder

This builder for chaining.

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

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

setServiceAccount(String value)

public UploadModelRequest.Builder setServiceAccount(String value)

Optional. The user-provided custom service account to use to do the model upload. If empty, Vertex AI Service Agent will be used to access resources needed to upload the model. This account must belong to the target project where the model is uploaded to, i.e., the project specified in the parent field of this request and have necessary read permissions (to Google Cloud Storage, Artifact Registry, etc.).

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

Parameter
Name Description
value String

The serviceAccount to set.

Returns
Type Description
UploadModelRequest.Builder

This builder for chaining.

setServiceAccountBytes(ByteString value)

public UploadModelRequest.Builder setServiceAccountBytes(ByteString value)

Optional. The user-provided custom service account to use to do the model upload. If empty, Vertex AI Service Agent will be used to access resources needed to upload the model. This account must belong to the target project where the model is uploaded to, i.e., the project specified in the parent field of this request and have necessary read permissions (to Google Cloud Storage, Artifact Registry, etc.).

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

Parameter
Name Description
value ByteString

The bytes for serviceAccount to set.

Returns
Type Description
UploadModelRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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