Class UploadModelRequest (3.31.0)

public final class UploadModelRequest extends GeneratedMessageV3 implements UploadModelRequestOrBuilder

Request message for ModelService.UploadModel.

Protobuf type google.cloud.aiplatform.v1.UploadModelRequest

Static Fields

MODEL_FIELD_NUMBER

public static final int MODEL_FIELD_NUMBER
Field Value
TypeDescription
int

MODEL_ID_FIELD_NUMBER

public static final int MODEL_ID_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_MODEL_FIELD_NUMBER

public static final int PARENT_MODEL_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static UploadModelRequest getDefaultInstance()
Returns
TypeDescription
UploadModelRequest

getDescriptor()

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

newBuilder()

public static UploadModelRequest.Builder newBuilder()
Returns
TypeDescription
UploadModelRequest.Builder

newBuilder(UploadModelRequest prototype)

public static UploadModelRequest.Builder newBuilder(UploadModelRequest prototype)
Parameter
NameDescription
prototypeUploadModelRequest
Returns
TypeDescription
UploadModelRequest.Builder

parseDelimitedFrom(InputStream input)

public static UploadModelRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UploadModelRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UploadModelRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UploadModelRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static UploadModelRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
UploadModelRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UploadModelRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UploadModelRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UploadModelRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
UploadModelRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UploadModelRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UploadModelRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UploadModelRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
UploadModelRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UploadModelRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UploadModelRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static UploadModelRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UploadModelRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UploadModelRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UploadModelRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static UploadModelRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
UploadModelRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UploadModelRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UploadModelRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<UploadModelRequest> parser()
Returns
TypeDescription
Parser<UploadModelRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public UploadModelRequest getDefaultInstanceForType()
Returns
TypeDescription
UploadModelRequest

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.

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.

getParserForType()

public Parser<UploadModelRequest> getParserForType()
Returns
TypeDescription
Parser<UploadModelRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public UploadModelRequest.Builder newBuilderForType()
Returns
TypeDescription
UploadModelRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UploadModelRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
UploadModelRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public UploadModelRequest.Builder toBuilder()
Returns
TypeDescription
UploadModelRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException