Google Cloud Ai Platform V1 Client - Class DeployRequest (1.31.0)

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

Request message for ModelGardenService.Deploy.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ publisher_model_name`	`string` The Model Garden model to deploy. Format: `publishers/{publisher}/models/{publisher_model}@{version_id}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001`.
`↳ hugging_face_model_id`	`string` The Hugging Face model to deploy. Format: Hugging Face model ID like `google/gemma-2-2b-it`.
`↳ destination`	`string` Required. The resource name of the Location to deploy the model in. Format: `projects/{project}/locations/{location}`
`↳ model_config`	`DeployRequest\ModelConfig` Optional. The model config to use for the deployment. If not specified, the default model config will be used.
`↳ endpoint_config`	`DeployRequest\EndpointConfig` Optional. The endpoint config to use for the deployment. If not specified, the default endpoint config will be used.
`↳ deploy_config`	`DeployRequest\DeployConfig` Optional. The deploy config to use for the deployment. If not specified, the default deploy config will be used.

getPublisherModelName

The Model Garden model to deploy.

Format: publishers/{publisher}/models/{publisher_model}@{version_id}, or publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001.

Returns
Type	Description
`string`

hasPublisherModelName

setPublisherModelName

The Model Garden model to deploy.

Format: publishers/{publisher}/models/{publisher_model}@{version_id}, or publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getHuggingFaceModelId

The Hugging Face model to deploy.

Format: Hugging Face model ID like google/gemma-2-2b-it.

Returns
Type	Description
`string`

hasHuggingFaceModelId

setHuggingFaceModelId

The Hugging Face model to deploy.

Format: Hugging Face model ID like google/gemma-2-2b-it.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDestination

Required. The resource name of the Location to deploy the model in.

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

Returns
Type	Description
`string`

setDestination

Required. The resource name of the Location to deploy the model in.

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getModelConfig

Optional. The model config to use for the deployment.

If not specified, the default model config will be used.

Returns
Type	Description
`DeployRequest\ModelConfig\|null`

hasModelConfig

clearModelConfig

setModelConfig

Optional. The model config to use for the deployment.

If not specified, the default model config will be used.

Parameter
Name	Description
`var`	`DeployRequest\ModelConfig`

Returns
Type	Description
`$this`

getEndpointConfig

Optional. The endpoint config to use for the deployment.

If not specified, the default endpoint config will be used.

Returns
Type	Description
`DeployRequest\EndpointConfig\|null`

hasEndpointConfig

clearEndpointConfig

setEndpointConfig