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

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

Model metadata that is needed for UploadModel or DeployModel/CreateEndpoint requests.

Generated from protobuf message google.cloud.aiplatform.v1.PublisherModel.CallToAction.Deploy

Namespace

Google \ Cloud \ AIPlatform \ V1 \ PublisherModel \ CallToAction

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ dedicated_resources Google\Cloud\AIPlatform\V1\DedicatedResources

A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration.

↳ automatic_resources Google\Cloud\AIPlatform\V1\AutomaticResources

A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.

↳ shared_resources string

The resource name of the shared DeploymentResourcePool to deploy on. Format: projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}

↳ model_display_name string

Optional. Default model display name.

↳ large_model_reference Google\Cloud\AIPlatform\V1\LargeModelReference

Optional. Large model reference. When this is set, model_artifact_spec is not needed.

↳ container_spec Google\Cloud\AIPlatform\V1\ModelContainerSpec

Optional. The specification of the container that is to be used when deploying this Model in Vertex AI. Not present for Large Models.

↳ artifact_uri string

Optional. The path to the directory containing the Model artifact and any of its supporting files.

↳ title string

Required. The title of the regional resource reference.

getDedicatedResources

A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration.

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

hasDedicatedResources

setDedicatedResources

A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration.

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

getAutomaticResources

A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.

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

hasAutomaticResources

setAutomaticResources

A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.

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

getSharedResources

The resource name of the shared DeploymentResourcePool to deploy on.

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

Returns
TypeDescription
string

hasSharedResources

setSharedResources

The resource name of the shared DeploymentResourcePool to deploy on.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getModelDisplayName

Optional. Default model display name.

Returns
TypeDescription
string

setModelDisplayName

Optional. Default model display name.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getLargeModelReference

Optional. Large model reference. When this is set, model_artifact_spec is not needed.

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

hasLargeModelReference

clearLargeModelReference

setLargeModelReference

Optional. Large model reference. When this is set, model_artifact_spec is not needed.

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

getContainerSpec

Optional. The specification of the container that is to be used when deploying this Model in Vertex AI. Not present for Large Models.

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

hasContainerSpec

clearContainerSpec

setContainerSpec

Optional. The specification of the container that is to be used when deploying this Model in Vertex AI. Not present for Large Models.

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

getArtifactUri

Optional. The path to the directory containing the Model artifact and any of its supporting files.

Returns
TypeDescription
string

setArtifactUri

Optional. The path to the directory containing the Model artifact and any of its supporting files.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTitle

Required. The title of the regional resource reference.

Returns
TypeDescription
string

setTitle

Required. The title of the regional resource reference.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPredictionResources

Returns
TypeDescription
string