Google Cloud Ai Platform V1 Client - Class CopyModelRequest (0.38.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 Google\Cloud\AIPlatform\V1\EncryptionSpec

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

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
Google\Cloud\AIPlatform\V1\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 Google\Cloud\AIPlatform\V1\EncryptionSpec
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 Google\Cloud\AIPlatform\V1\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 Google\Cloud\AIPlatform\V1\ModelServiceClient::modelName() for help formatting this field.

Returns
Type Description
Google\Cloud\AIPlatform\V1\CopyModelRequest