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 \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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: |
↳ 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 |
↳ 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 |
getParent
Required. The resource name of the Location into which to upload the Model.
Format: projects/{project}/locations/{location}
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The resource name of the Location into which to upload the Model.
Format: projects/{project}/locations/{location}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getModel
Required. The Model to create.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\Model|null |
|
hasModel
clearModel
setModel
Required. The Model to create.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\Model
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The resource name of the Location into which to upload the Model.
Format: |
model |
Google\Cloud\AIPlatform\V1\Model
Required. The Model to create. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\UploadModelRequest |
|