Google Cloud Ai Platform V1 Client - Class CopyModelRequest (1.58.0)

1.58.0 (latest) 1.57.0 1.56.0 1.55.0 1.54.0 1.53.0 1.52.0 1.51.0 1.50.0 1.49.0 1.48.0 1.47.0 1.46.0 1.45.0 1.44.0 1.43.0 1.42.0 1.41.0 1.40.0 1.39.0 1.38.0 1.37.0 1.36.0 1.35.0 1.34.0 1.33.0 1.32.1 1.31.0 1.30.0 1.26.0 1.23.0 1.22.0 1.21.0 1.20.0 1.19.0 1.18.0 1.17.0 1.16.0 1.15.0 1.14.0 1.13.1 1.12.0 1.11.0 1.10.0 1.9.0 1.8.0 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0 0.39.0 0.38.0 0.37.1 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.2 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.13.0 0.12.0 0.11.1 0.10.0

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

Request message for ModelService.CopyModel.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ model_id	string Optional. Copy source_model into a new Model with this ID. The ID 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.
↳ parent_model	string Optional. Specify this field to copy source_model into this existing Model as a new version. Format: projects/{project}/locations/{location}/models/{model}
↳ parent	string Required. The resource name of the Location into which to copy the Model. Format: projects/{project}/locations/{location}
↳ source_model	string Required. The resource name of the Model to copy. That Model must be in the same Project. Format: projects/{project}/locations/{location}/models/{model}
↳ encryption_spec	EncryptionSpec Customer-managed encryption key options. If this is set, then the Model copy will be encrypted with the provided encryption key.
↳ custom_service_account	string Optional. The user-provided custom service account to use to do the copy model. If empty, Vertex AI Service Agent will be used to access resources needed to upload the model. This account must belong to the destination project where the model is copied to, i.e., the project specified in the parent field of this request and have the Vertex AI Service Agent role in the source project. Requires the user copying the Model to have the iam.serviceAccounts.actAs permission on this service account.

getModelId

Optional. Copy source_model into a new Model with this ID. The ID 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

hasModelId

setModelId

Optional. Copy source_model into a new Model with this ID. The ID 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

getParentModel

Optional. Specify this field to copy source_model into this existing Model as a new version. Format: projects/{project}/locations/{location}/models/{model}

Returns
Type	Description
string

hasParentModel

setParentModel

Optional. Specify this field to copy source_model into this existing Model as a new version. Format: projects/{project}/locations/{location}/models/{model}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getParent

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

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

Returns
Type	Description
string

setParent

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

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getSourceModel

Required. The resource name of the Model to copy. That Model must be in the same Project. Format: projects/{project}/locations/{location}/models/{model}

Returns
Type	Description
string

setSourceModel

Required. The resource name of the Model to copy. That Model must be in the same Project. Format: projects/{project}/locations/{location}/models/{model}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getEncryptionSpec

Customer-managed encryption key options. If this is set, then the Model copy will be encrypted with the provided encryption key.

Returns
Type	Description
EncryptionSpec|null

hasEncryptionSpec

clearEncryptionSpec

setEncryptionSpec

Customer-managed encryption key options. If this is set, then the Model copy will be encrypted with the provided encryption key.

Parameter
Name	Description
var	EncryptionSpec

Returns
Type	Description
$this

getCustomServiceAccount

Optional. The user-provided custom service account to use to do the copy model. If empty, Vertex AI Service Agent will be used to access resources needed to upload the model. This account must belong to the destination project where the model is copied to, i.e., the project specified in the parent field of this request and have the Vertex AI Service Agent role in the source project.

Requires the user copying the Model to have the iam.serviceAccounts.actAs permission on this service account.

Returns
Type	Description
string

setCustomServiceAccount

Optional. The user-provided custom service account to use to do the copy model. If empty, Vertex AI Service Agent will be used to access resources needed to upload the model. This account must belong to the destination project where the model is copied to, i.e., the project specified in the parent field of this request and have the Vertex AI Service Agent role in the source project.

Requires the user copying the Model to have the iam.serviceAccounts.actAs permission on this service account.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDestinationModel

Returns
Type	Description
string

static::build

Parameters
Name	Description
parent	string Required. The resource name of the Location into which to copy the Model. Format: projects/{project}/locations/{location} Please see ModelServiceClient::locationName() for help formatting this field.
sourceModel	string Required. The resource name of the Model to copy. That Model must be in the same Project. Format: projects/{project}/locations/{location}/models/{model} Please see ModelServiceClient::modelName() for help formatting this field.

Returns
Type	Description
CopyModelRequest