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 \ CallToActionMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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: |
↳ 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. |
↳ deploy_task_name |
string
Optional. The name of the deploy task (e.g., "text to image generation"). |
↳ deploy_metadata |
Deploy\DeployMetadata
Optional. Metadata information about this deployment config. |
↳ title |
string
Required. The title of the regional resource reference. |
↳ public_artifact_uri |
string
Optional. The signed URI for ephemeral Cloud Storage access to model artifact. |
getDedicatedResources
A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration.
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\DedicatedResources
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAutomaticResources
A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\AutomaticResources
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSharedResources
The resource name of the shared DeploymentResourcePool to deploy on.
Format:
projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}
| Returns | |
|---|---|
| Type | Description |
string |
|
hasSharedResources
setSharedResources
The resource name of the shared DeploymentResourcePool to deploy on.
Format:
projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getModelDisplayName
Optional. Default model display name.
| Returns | |
|---|---|
| Type | Description |
string |
|
setModelDisplayName
Optional. Default model display name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLargeModelReference
Optional. Large model reference. When this is set, model_artifact_spec is not needed.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\LargeModelReference|null |
|
hasLargeModelReference
clearLargeModelReference
setLargeModelReference
Optional. Large model reference. When this is set, model_artifact_spec is not needed.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\LargeModelReference
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\ModelContainerSpec
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getArtifactUri
Optional. The path to the directory containing the Model artifact and any of its supporting files.
| Returns | |
|---|---|
| Type | Description |
string |
|
setArtifactUri
Optional. The path to the directory containing the Model artifact and any of its supporting files.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeployTaskName
Optional. The name of the deploy task (e.g., "text to image generation").
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDeployTaskName
clearDeployTaskName
setDeployTaskName
Optional. The name of the deploy task (e.g., "text to image generation").
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeployMetadata
Optional. Metadata information about this deployment config.
| Returns | |
|---|---|
| Type | Description |
Deploy\DeployMetadata|null |
|
hasDeployMetadata
clearDeployMetadata
setDeployMetadata
Optional. Metadata information about this deployment config.
| Parameter | |
|---|---|
| Name | Description |
var |
Deploy\DeployMetadata
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTitle
Required. The title of the regional resource reference.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTitle
Required. The title of the regional resource reference.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPublicArtifactUri
Optional. The signed URI for ephemeral Cloud Storage access to model artifact.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPublicArtifactUri
Optional. The signed URI for ephemeral Cloud Storage access to model artifact.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPredictionResources
| Returns | |
|---|---|
| Type | Description |
string |
|