Google Cloud Ai Platform V1 Client - Class DeployModelRequest (0.18.0)

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

Request message for EndpointService.DeployModel.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ endpoint`	`string` Required. The name of the Endpoint resource into which to deploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
`↳ deployed_model`	`Google\Cloud\AIPlatform\V1\DeployedModel` Required. The DeployedModel to be created within the Endpoint. Note that Endpoint.traffic_split must be updated for the DeployedModel to start receiving traffic, either as part of this call, or via EndpointService.UpdateEndpoint.
`↳ traffic_split`	`array\|Google\Protobuf\Internal\MapField` A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If this field is non-empty, then the Endpoint's traffic_split will be overwritten with it. To refer to the ID of the just being deployed Model, a "0" should be used, and the actual ID of the new DeployedModel will be filled in its place by this method. The traffic percentage values must add up to 100. If this field is empty, then the Endpoint's traffic_split is not updated.

getEndpoint

Required. The name of the Endpoint resource into which to deploy a Model.

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

Returns
Type	Description
`string`

setEndpoint

Required. The name of the Endpoint resource into which to deploy a Model.

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDeployedModel

Required. The DeployedModel to be created within the Endpoint. Note that Endpoint.traffic_split must be updated for the DeployedModel to start receiving traffic, either as part of this call, or via EndpointService.UpdateEndpoint.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\DeployedModel\|null`

hasDeployedModel

clearDeployedModel

setDeployedModel

Parameter
Name	Description
`var`	`Google\Cloud\AIPlatform\V1\DeployedModel`

Returns
Type	Description
`$this`

getTrafficSplit

A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel.

If this field is non-empty, then the Endpoint's traffic_split will be overwritten with it. To refer to the ID of the just being deployed Model, a "0" should be used, and the actual ID of the new DeployedModel will be filled in its place by this method. The traffic percentage values must add up to 100. If this field is empty, then the Endpoint's traffic_split is not updated.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setTrafficSplit

A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

static::build

Parameters
Name	Description
`endpoint`	`string` Required. The name of the Endpoint resource into which to deploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` Please see Google\Cloud\AIPlatform\V1\EndpointServiceClient::endpointName() for help formatting this field.
`deployedModel`	`Google\Cloud\AIPlatform\V1\DeployedModel` Required. The DeployedModel to be created within the Endpoint. Note that Endpoint.traffic_split must be updated for the DeployedModel to start receiving traffic, either as part of this call, or via EndpointService.UpdateEndpoint.
`trafficSplit`	`array` A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If this field is non-empty, then the Endpoint's traffic_split will be overwritten with it. To refer to the ID of the just being deployed Model, a "0" should be used, and the actual ID of the new DeployedModel will be filled in its place by this method. The traffic percentage values must add up to 100. If this field is empty, then the Endpoint's traffic_split is not updated.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\DeployModelRequest`