Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ModelConfig.
The model config to use for the deployment.
Generated from protobuf messagegoogle.cloud.aiplatform.v1.DeployRequest.ModelConfig
Namespace
Google \ Cloud \ AIPlatform \ V1 \ DeployRequest
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ accept_eula
bool
Optional. Whether the user accepts the End User License Agreement (EULA) for the model.
↳ hugging_face_access_token
string
Optional. The Hugging Face read access token used to access the model artifacts of gated models.
↳ hugging_face_cache_enabled
bool
Optional. If true, the model will deploy with a cached version instead of directly downloading the model artifacts from Hugging Face. This is suitable for VPC-SC users with limited internet access.
↳ model_display_name
string
Optional. The user-specified display name of the uploaded model. If not set, a default name will be used.
Optional. The specification of the container that is to be used when deploying. If not set, the default container spec will be used.
↳ model_user_id
string
Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name. When not provided, Vertex AI will generate a value for this ID. When Model Registry model is provided, this field will be ignored. This value may be up to 63 characters, and valid characters are[a-z0-9_-]. The first character cannot be a number or hyphen.
getAcceptEula
Optional. Whether the user accepts the End User License Agreement (EULA)
for the model.
Returns
Type
Description
bool
setAcceptEula
Optional. Whether the user accepts the End User License Agreement (EULA)
for the model.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getHuggingFaceAccessToken
Optional. The Hugging Face read access token used to access the model
artifacts of gated models.
Returns
Type
Description
string
setHuggingFaceAccessToken
Optional. The Hugging Face read access token used to access the model
artifacts of gated models.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getHuggingFaceCacheEnabled
Optional. If true, the model will deploy with a cached version instead of
directly downloading the model artifacts from Hugging Face. This is
suitable for VPC-SC users with limited internet access.
Returns
Type
Description
bool
setHuggingFaceCacheEnabled
Optional. If true, the model will deploy with a cached version instead of
directly downloading the model artifacts from Hugging Face. This is
suitable for VPC-SC users with limited internet access.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getModelDisplayName
Optional. The user-specified display name of the uploaded model. If not
set, a default name will be used.
Returns
Type
Description
string
setModelDisplayName
Optional. The user-specified display name of the uploaded model. If not
set, a default name will be used.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getContainerSpec
Optional. The specification of the container that is to be used when
deploying. If not set, the default container spec will be used.
Optional. The ID to use for the uploaded Model, which will become the
final component of the model resource name. When not provided, Vertex AI
will generate a value for this ID. When Model Registry model is provided,
this field will be ignored.
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
setModelUserId
Optional. The ID to use for the uploaded Model, which will become the
final component of the model resource name. When not provided, Vertex AI
will generate a value for this ID. When Model Registry model is provided,
this field will be ignored.
This value may be up to 63 characters, and valid characters are[a-z0-9_-]. The first character cannot be a number or hyphen.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Ai Platform V1 Client - Class ModelConfig (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-ai-platform/latest/V1.DeployRequest.ModelConfig)\n- [1.34.0](/php/docs/reference/cloud-ai-platform/1.34.0/V1.DeployRequest.ModelConfig)\n- [1.33.0](/php/docs/reference/cloud-ai-platform/1.33.0/V1.DeployRequest.ModelConfig)\n- [1.32.1](/php/docs/reference/cloud-ai-platform/1.32.1/V1.DeployRequest.ModelConfig)\n- [1.31.0](/php/docs/reference/cloud-ai-platform/1.31.0/V1.DeployRequest.ModelConfig)\n- [1.30.0](/php/docs/reference/cloud-ai-platform/1.30.0/V1.DeployRequest.ModelConfig)\n- [1.26.0](/php/docs/reference/cloud-ai-platform/1.26.0/V1.DeployRequest.ModelConfig)\n- [1.23.0](/php/docs/reference/cloud-ai-platform/1.23.0/V1.DeployRequest.ModelConfig)\n- [1.22.0](/php/docs/reference/cloud-ai-platform/1.22.0/V1.DeployRequest.ModelConfig)\n- [1.21.0](/php/docs/reference/cloud-ai-platform/1.21.0/V1.DeployRequest.ModelConfig)\n- [1.20.0](/php/docs/reference/cloud-ai-platform/1.20.0/V1.DeployRequest.ModelConfig)\n- [1.19.0](/php/docs/reference/cloud-ai-platform/1.19.0/V1.DeployRequest.ModelConfig)\n- [1.18.0](/php/docs/reference/cloud-ai-platform/1.18.0/V1.DeployRequest.ModelConfig)\n- [1.17.0](/php/docs/reference/cloud-ai-platform/1.17.0/V1.DeployRequest.ModelConfig)\n- [1.16.0](/php/docs/reference/cloud-ai-platform/1.16.0/V1.DeployRequest.ModelConfig)\n- [1.15.0](/php/docs/reference/cloud-ai-platform/1.15.0/V1.DeployRequest.ModelConfig)\n- [1.14.0](/php/docs/reference/cloud-ai-platform/1.14.0/V1.DeployRequest.ModelConfig)\n- [1.13.1](/php/docs/reference/cloud-ai-platform/1.13.1/V1.DeployRequest.ModelConfig)\n- [1.12.0](/php/docs/reference/cloud-ai-platform/1.12.0/V1.DeployRequest.ModelConfig)\n- [1.11.0](/php/docs/reference/cloud-ai-platform/1.11.0/V1.DeployRequest.ModelConfig)\n- [1.10.0](/php/docs/reference/cloud-ai-platform/1.10.0/V1.DeployRequest.ModelConfig)\n- [1.9.0](/php/docs/reference/cloud-ai-platform/1.9.0/V1.DeployRequest.ModelConfig)\n- [1.8.0](/php/docs/reference/cloud-ai-platform/1.8.0/V1.DeployRequest.ModelConfig)\n- [1.7.0](/php/docs/reference/cloud-ai-platform/1.7.0/V1.DeployRequest.ModelConfig)\n- [1.6.0](/php/docs/reference/cloud-ai-platform/1.6.0/V1.DeployRequest.ModelConfig)\n- [1.5.0](/php/docs/reference/cloud-ai-platform/1.5.0/V1.DeployRequest.ModelConfig)\n- [1.4.0](/php/docs/reference/cloud-ai-platform/1.4.0/V1.DeployRequest.ModelConfig)\n- [1.3.0](/php/docs/reference/cloud-ai-platform/1.3.0/V1.DeployRequest.ModelConfig)\n- [1.2.0](/php/docs/reference/cloud-ai-platform/1.2.0/V1.DeployRequest.ModelConfig)\n- [1.1.0](/php/docs/reference/cloud-ai-platform/1.1.0/V1.DeployRequest.ModelConfig)\n- [1.0.0](/php/docs/reference/cloud-ai-platform/1.0.0/V1.DeployRequest.ModelConfig)\n- [0.39.0](/php/docs/reference/cloud-ai-platform/0.39.0/V1.DeployRequest.ModelConfig)\n- [0.38.0](/php/docs/reference/cloud-ai-platform/0.38.0/V1.DeployRequest.ModelConfig)\n- [0.37.1](/php/docs/reference/cloud-ai-platform/0.37.1/V1.DeployRequest.ModelConfig)\n- [0.32.0](/php/docs/reference/cloud-ai-platform/0.32.0/V1.DeployRequest.ModelConfig)\n- [0.31.0](/php/docs/reference/cloud-ai-platform/0.31.0/V1.DeployRequest.ModelConfig)\n- [0.30.0](/php/docs/reference/cloud-ai-platform/0.30.0/V1.DeployRequest.ModelConfig)\n- [0.29.0](/php/docs/reference/cloud-ai-platform/0.29.0/V1.DeployRequest.ModelConfig)\n- [0.28.0](/php/docs/reference/cloud-ai-platform/0.28.0/V1.DeployRequest.ModelConfig)\n- [0.27.0](/php/docs/reference/cloud-ai-platform/0.27.0/V1.DeployRequest.ModelConfig)\n- [0.26.2](/php/docs/reference/cloud-ai-platform/0.26.2/V1.DeployRequest.ModelConfig)\n- [0.25.0](/php/docs/reference/cloud-ai-platform/0.25.0/V1.DeployRequest.ModelConfig)\n- [0.24.0](/php/docs/reference/cloud-ai-platform/0.24.0/V1.DeployRequest.ModelConfig)\n- [0.23.0](/php/docs/reference/cloud-ai-platform/0.23.0/V1.DeployRequest.ModelConfig)\n- [0.22.0](/php/docs/reference/cloud-ai-platform/0.22.0/V1.DeployRequest.ModelConfig)\n- [0.21.0](/php/docs/reference/cloud-ai-platform/0.21.0/V1.DeployRequest.ModelConfig)\n- [0.20.0](/php/docs/reference/cloud-ai-platform/0.20.0/V1.DeployRequest.ModelConfig)\n- [0.19.0](/php/docs/reference/cloud-ai-platform/0.19.0/V1.DeployRequest.ModelConfig)\n- [0.18.0](/php/docs/reference/cloud-ai-platform/0.18.0/V1.DeployRequest.ModelConfig)\n- [0.17.0](/php/docs/reference/cloud-ai-platform/0.17.0/V1.DeployRequest.ModelConfig)\n- [0.16.0](/php/docs/reference/cloud-ai-platform/0.16.0/V1.DeployRequest.ModelConfig)\n- [0.15.0](/php/docs/reference/cloud-ai-platform/0.15.0/V1.DeployRequest.ModelConfig)\n- [0.13.0](/php/docs/reference/cloud-ai-platform/0.13.0/V1.DeployRequest.ModelConfig)\n- [0.12.0](/php/docs/reference/cloud-ai-platform/0.12.0/V1.DeployRequest.ModelConfig)\n- [0.11.1](/php/docs/reference/cloud-ai-platform/0.11.1/V1.DeployRequest.ModelConfig)\n- [0.10.0](/php/docs/reference/cloud-ai-platform/0.10.0/V1.DeployRequest.ModelConfig) \nReference documentation and code samples for the Google Cloud Ai Platform V1 Client class ModelConfig.\n\nThe model config to use for the deployment.\n\nGenerated from protobuf message `google.cloud.aiplatform.v1.DeployRequest.ModelConfig`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AIPlatform \\\\ V1 \\\\ DeployRequest\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getAcceptEula\n\nOptional. Whether the user accepts the End User License Agreement (EULA)\nfor the model.\n\n### setAcceptEula\n\nOptional. Whether the user accepts the End User License Agreement (EULA)\nfor the model.\n\n### getHuggingFaceAccessToken\n\nOptional. The Hugging Face read access token used to access the model\nartifacts of gated models.\n\n### setHuggingFaceAccessToken\n\nOptional. The Hugging Face read access token used to access the model\nartifacts of gated models.\n\n### getHuggingFaceCacheEnabled\n\nOptional. If true, the model will deploy with a cached version instead of\ndirectly downloading the model artifacts from Hugging Face. This is\nsuitable for VPC-SC users with limited internet access.\n\n### setHuggingFaceCacheEnabled\n\nOptional. If true, the model will deploy with a cached version instead of\ndirectly downloading the model artifacts from Hugging Face. This is\nsuitable for VPC-SC users with limited internet access.\n\n### getModelDisplayName\n\nOptional. The user-specified display name of the uploaded model. If not\nset, a default name will be used.\n\n### setModelDisplayName\n\nOptional. The user-specified display name of the uploaded model. If not\nset, a default name will be used.\n\n### getContainerSpec\n\nOptional. The specification of the container that is to be used when\ndeploying. If not set, the default container spec will be used.\n\n### hasContainerSpec\n\n### clearContainerSpec\n\n### setContainerSpec\n\nOptional. The specification of the container that is to be used when\ndeploying. If not set, the default container spec will be used.\n\n### getModelUserId\n\nOptional. The ID to use for the uploaded Model, which will become the\nfinal component of the model resource name. When not provided, Vertex AI\nwill generate a value for this ID. When Model Registry model is provided,\nthis field will be ignored.\n\nThis value may be up to 63 characters, and valid characters are\n`[a-z0-9_-]`. The first character cannot be a number or hyphen.\n\n### setModelUserId\n\nOptional. The ID to use for the uploaded Model, which will become the\nfinal component of the model resource name. When not provided, Vertex AI\nwill generate a value for this ID. When Model Registry model is provided,\nthis field will be ignored.\n\nThis value may be up to 63 characters, and valid characters are\n`[a-z0-9_-]`. The first character cannot be a number or hyphen."]]
