Class UploadModelRequest.Builder (3.22.0)

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

Request message for ModelService.UploadModel.

Protobuf type google.cloud.aiplatform.v1.UploadModelRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UploadModelRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
UploadModelRequest.Builder
Overrides

build()

public UploadModelRequest build()
Returns
TypeDescription
UploadModelRequest

buildPartial()

public UploadModelRequest buildPartial()
Returns
TypeDescription
UploadModelRequest

clear()

public UploadModelRequest.Builder clear()
Returns
TypeDescription
UploadModelRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public UploadModelRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
UploadModelRequest.Builder
Overrides

clearModel()

public UploadModelRequest.Builder clearModel()

Required. The Model to create.

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

Returns
TypeDescription
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
TypeDescription
UploadModelRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public UploadModelRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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. Users uploading the Model must have the iam.serviceAccounts.actAs permission on this service account. Also, this account must belong to the project specified in the parent field and have all necessary read permissions.

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

Returns
TypeDescription
UploadModelRequest.Builder

This builder for chaining.

clone()

public UploadModelRequest.Builder clone()
Returns
TypeDescription
UploadModelRequest.Builder
Overrides

getDefaultInstanceForType()

public UploadModelRequest getDefaultInstanceForType()
Returns
TypeDescription
UploadModelRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getModel()

public Model getModel()

Required. The Model to create.

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

Returns
TypeDescription
Model

The model.

getModelBuilder()

public Model.Builder getModelBuilder()

Required. The Model to create.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for modelId.

getModelOrBuilder()

public ModelOrBuilder getModelOrBuilder()

Required. The Model to create.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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. Users uploading the Model must have the iam.serviceAccounts.actAs permission on this service account. Also, this account must belong to the project specified in the parent field and have all necessary read permissions.

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

Returns
TypeDescription
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. Users uploading the Model must have the iam.serviceAccounts.actAs permission on this service account. Also, this account must belong to the project specified in the parent field and have all necessary read permissions.

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

Returns
TypeDescription
ByteString

The bytes for serviceAccount.

hasModel()

public boolean hasModel()

Required. The Model to create.

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

Returns
TypeDescription
boolean

Whether the model field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(UploadModelRequest other)

public UploadModelRequest.Builder mergeFrom(UploadModelRequest other)
Parameter
NameDescription
otherUploadModelRequest
Returns
TypeDescription
UploadModelRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UploadModelRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UploadModelRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public UploadModelRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
UploadModelRequest.Builder
Overrides

mergeModel(Model value)

public UploadModelRequest.Builder mergeModel(Model value)

Required. The Model to create.

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

Parameter
NameDescription
valueModel
Returns
TypeDescription
UploadModelRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UploadModelRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
UploadModelRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public UploadModelRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
UploadModelRequest.Builder
Overrides

setModel(Model value)

public UploadModelRequest.Builder setModel(Model value)

Required. The Model to create.

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

Parameter
NameDescription
valueModel
Returns
TypeDescription
UploadModelRequest.Builder

setModel(Model.Builder builderForValue)

public UploadModelRequest.Builder setModel(Model.Builder builderForValue)

Required. The Model to create.

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

Parameter
NameDescription
builderForValueModel.Builder
Returns
TypeDescription
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
NameDescription
valueString

The modelId to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for modelId to set.

Returns
TypeDescription
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
NameDescription
valueString

The parent to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
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
NameDescription
valueString

The parentModel to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for parentModel to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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. Users uploading the Model must have the iam.serviceAccounts.actAs permission on this service account. Also, this account must belong to the project specified in the parent field and have all necessary read permissions.

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

Parameter
NameDescription
valueString

The serviceAccount to set.

Returns
TypeDescription
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. Users uploading the Model must have the iam.serviceAccounts.actAs permission on this service account. Also, this account must belong to the project specified in the parent field and have all necessary read permissions.

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

Parameter
NameDescription
valueByteString

The bytes for serviceAccount to set.

Returns
TypeDescription
UploadModelRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final UploadModelRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
UploadModelRequest.Builder
Overrides