Google Cloud Ai Platform V1 Client - Class UploadModelRequest (0.31.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class UploadModelRequest.

Request message for ModelService.UploadModel.

Generated from protobuf message google.cloud.aiplatform.v1.UploadModelRequest

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

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

↳ parent_model string

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

↳ model_id string

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.

↳ model Google\Cloud\AIPlatform\V1\Model

Required. The Model to create.

↳ service_account string

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

getParent

Required. The resource name of the Location into which to upload the Model.

Format: projects/{project}/locations/{location}

Returns
TypeDescription
string

setParent

Required. The resource name of the Location into which to upload the Model.

Format: projects/{project}/locations/{location}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getParentModel

Optional. The resource name of the model into which to upload the version.

Only specify this field when uploading a new version.

Returns
TypeDescription
string

setParentModel

Optional. The resource name of the model into which to upload the version.

Only specify this field when uploading a new version.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

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.

Returns
TypeDescription
string

setModelId

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getModel

Required. The Model to create.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\Model|null

hasModel

clearModel

setModel

Required. The Model to create.

Parameter
NameDescription
var Google\Cloud\AIPlatform\V1\Model
Returns
TypeDescription
$this

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

Returns
TypeDescription
string

setServiceAccount

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
parent string

Required. The resource name of the Location into which to upload the Model. Format: projects/{project}/locations/{location} Please see Google\Cloud\AIPlatform\V1\ModelServiceClient::locationName() for help formatting this field.

model Google\Cloud\AIPlatform\V1\Model

Required. The Model to create.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\UploadModelRequest