Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ServiceAccountSpec.
Configuration for the use of custom service account to run the workloads.
Generated from protobuf messagegoogle.cloud.aiplatform.v1.ServiceAccountSpec
Namespace
Google \ Cloud \ AIPlatform \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ enable_custom_service_account
bool
Required. If true, custom user-managed service account is enforced to run any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses theVertex AI Custom Code Service Agent.
↳ service_account
string
Optional. Required when all below conditions are met * *enable_custom_service_accountis true; * * any runtime is specified viaResourceRuntimeSpecon creation time, for example, Ray The users must haveiam.serviceAccounts.actAspermission on this service account and then the specified runtime containers will run as it. Do not set this field if you want to submit jobs using custom service account to this PersistentResource after creation, but only specify theservice_accountinside the job.
getEnableCustomServiceAccount
Required. If true, custom user-managed service account is enforced to run
any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses
theVertex AI Custom Code Service
Agent.
Returns
Type
Description
bool
setEnableCustomServiceAccount
Required. If true, custom user-managed service account is enforced to run
any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses
theVertex AI Custom Code Service
Agent.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getServiceAccount
Optional. Required when all below conditions are met
enable_custom_service_accountis true;
any runtime is specified viaResourceRuntimeSpecon creation time,
for example, Ray
The users must haveiam.serviceAccounts.actAspermission on this service
account and then the specified runtime containers will run as it.
Do not set this field if you want to submit jobs using custom service
account to this PersistentResource after creation, but only specify theservice_accountinside the job.
Returns
Type
Description
string
setServiceAccount
Optional. Required when all below conditions are met
enable_custom_service_accountis true;
any runtime is specified viaResourceRuntimeSpecon creation time,
for example, Ray
The users must haveiam.serviceAccounts.actAspermission on this service
account and then the specified runtime containers will run as it.
Do not set this field if you want to submit jobs using custom service
account to this PersistentResource after creation, but only specify theservice_accountinside the job.
[[["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 ServiceAccountSpec (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-ai-platform/latest/V1.ServiceAccountSpec)\n- [1.34.0](/php/docs/reference/cloud-ai-platform/1.34.0/V1.ServiceAccountSpec)\n- [1.33.0](/php/docs/reference/cloud-ai-platform/1.33.0/V1.ServiceAccountSpec)\n- [1.32.1](/php/docs/reference/cloud-ai-platform/1.32.1/V1.ServiceAccountSpec)\n- [1.31.0](/php/docs/reference/cloud-ai-platform/1.31.0/V1.ServiceAccountSpec)\n- [1.30.0](/php/docs/reference/cloud-ai-platform/1.30.0/V1.ServiceAccountSpec)\n- [1.26.0](/php/docs/reference/cloud-ai-platform/1.26.0/V1.ServiceAccountSpec)\n- [1.23.0](/php/docs/reference/cloud-ai-platform/1.23.0/V1.ServiceAccountSpec)\n- [1.22.0](/php/docs/reference/cloud-ai-platform/1.22.0/V1.ServiceAccountSpec)\n- [1.21.0](/php/docs/reference/cloud-ai-platform/1.21.0/V1.ServiceAccountSpec)\n- [1.20.0](/php/docs/reference/cloud-ai-platform/1.20.0/V1.ServiceAccountSpec)\n- [1.19.0](/php/docs/reference/cloud-ai-platform/1.19.0/V1.ServiceAccountSpec)\n- [1.18.0](/php/docs/reference/cloud-ai-platform/1.18.0/V1.ServiceAccountSpec)\n- [1.17.0](/php/docs/reference/cloud-ai-platform/1.17.0/V1.ServiceAccountSpec)\n- [1.16.0](/php/docs/reference/cloud-ai-platform/1.16.0/V1.ServiceAccountSpec)\n- [1.15.0](/php/docs/reference/cloud-ai-platform/1.15.0/V1.ServiceAccountSpec)\n- [1.14.0](/php/docs/reference/cloud-ai-platform/1.14.0/V1.ServiceAccountSpec)\n- [1.13.1](/php/docs/reference/cloud-ai-platform/1.13.1/V1.ServiceAccountSpec)\n- [1.12.0](/php/docs/reference/cloud-ai-platform/1.12.0/V1.ServiceAccountSpec)\n- [1.11.0](/php/docs/reference/cloud-ai-platform/1.11.0/V1.ServiceAccountSpec)\n- [1.10.0](/php/docs/reference/cloud-ai-platform/1.10.0/V1.ServiceAccountSpec)\n- [1.9.0](/php/docs/reference/cloud-ai-platform/1.9.0/V1.ServiceAccountSpec)\n- [1.8.0](/php/docs/reference/cloud-ai-platform/1.8.0/V1.ServiceAccountSpec)\n- [1.7.0](/php/docs/reference/cloud-ai-platform/1.7.0/V1.ServiceAccountSpec)\n- [1.6.0](/php/docs/reference/cloud-ai-platform/1.6.0/V1.ServiceAccountSpec)\n- [1.5.0](/php/docs/reference/cloud-ai-platform/1.5.0/V1.ServiceAccountSpec)\n- [1.4.0](/php/docs/reference/cloud-ai-platform/1.4.0/V1.ServiceAccountSpec)\n- [1.3.0](/php/docs/reference/cloud-ai-platform/1.3.0/V1.ServiceAccountSpec)\n- [1.2.0](/php/docs/reference/cloud-ai-platform/1.2.0/V1.ServiceAccountSpec)\n- [1.1.0](/php/docs/reference/cloud-ai-platform/1.1.0/V1.ServiceAccountSpec)\n- [1.0.0](/php/docs/reference/cloud-ai-platform/1.0.0/V1.ServiceAccountSpec)\n- [0.39.0](/php/docs/reference/cloud-ai-platform/0.39.0/V1.ServiceAccountSpec)\n- [0.38.0](/php/docs/reference/cloud-ai-platform/0.38.0/V1.ServiceAccountSpec)\n- [0.37.1](/php/docs/reference/cloud-ai-platform/0.37.1/V1.ServiceAccountSpec)\n- [0.32.0](/php/docs/reference/cloud-ai-platform/0.32.0/V1.ServiceAccountSpec)\n- [0.31.0](/php/docs/reference/cloud-ai-platform/0.31.0/V1.ServiceAccountSpec)\n- [0.30.0](/php/docs/reference/cloud-ai-platform/0.30.0/V1.ServiceAccountSpec)\n- [0.29.0](/php/docs/reference/cloud-ai-platform/0.29.0/V1.ServiceAccountSpec)\n- [0.28.0](/php/docs/reference/cloud-ai-platform/0.28.0/V1.ServiceAccountSpec)\n- [0.27.0](/php/docs/reference/cloud-ai-platform/0.27.0/V1.ServiceAccountSpec)\n- [0.26.2](/php/docs/reference/cloud-ai-platform/0.26.2/V1.ServiceAccountSpec)\n- [0.25.0](/php/docs/reference/cloud-ai-platform/0.25.0/V1.ServiceAccountSpec)\n- [0.24.0](/php/docs/reference/cloud-ai-platform/0.24.0/V1.ServiceAccountSpec)\n- [0.23.0](/php/docs/reference/cloud-ai-platform/0.23.0/V1.ServiceAccountSpec)\n- [0.22.0](/php/docs/reference/cloud-ai-platform/0.22.0/V1.ServiceAccountSpec)\n- [0.21.0](/php/docs/reference/cloud-ai-platform/0.21.0/V1.ServiceAccountSpec)\n- [0.20.0](/php/docs/reference/cloud-ai-platform/0.20.0/V1.ServiceAccountSpec)\n- [0.19.0](/php/docs/reference/cloud-ai-platform/0.19.0/V1.ServiceAccountSpec)\n- [0.18.0](/php/docs/reference/cloud-ai-platform/0.18.0/V1.ServiceAccountSpec)\n- [0.17.0](/php/docs/reference/cloud-ai-platform/0.17.0/V1.ServiceAccountSpec)\n- [0.16.0](/php/docs/reference/cloud-ai-platform/0.16.0/V1.ServiceAccountSpec)\n- [0.15.0](/php/docs/reference/cloud-ai-platform/0.15.0/V1.ServiceAccountSpec)\n- [0.13.0](/php/docs/reference/cloud-ai-platform/0.13.0/V1.ServiceAccountSpec)\n- [0.12.0](/php/docs/reference/cloud-ai-platform/0.12.0/V1.ServiceAccountSpec)\n- [0.11.1](/php/docs/reference/cloud-ai-platform/0.11.1/V1.ServiceAccountSpec)\n- [0.10.0](/php/docs/reference/cloud-ai-platform/0.10.0/V1.ServiceAccountSpec) \nReference documentation and code samples for the Google Cloud Ai Platform V1 Client class ServiceAccountSpec.\n\nConfiguration for the use of custom service account to run the workloads.\n\nGenerated from protobuf message `google.cloud.aiplatform.v1.ServiceAccountSpec`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AIPlatform \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getEnableCustomServiceAccount\n\nRequired. If true, custom user-managed service account is enforced to run\nany workloads (for example, Vertex Jobs) on the resource. Otherwise, uses\nthe [Vertex AI Custom Code Service\nAgent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).\n\n### setEnableCustomServiceAccount\n\nRequired. If true, custom user-managed service account is enforced to run\nany workloads (for example, Vertex Jobs) on the resource. Otherwise, uses\nthe [Vertex AI Custom Code Service\nAgent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).\n\n### getServiceAccount\n\nOptional. Required when all below conditions are met\n\n- `enable_custom_service_account` is true;\n- any runtime is specified via `ResourceRuntimeSpec` on creation time, for example, Ray The users must have `iam.serviceAccounts.actAs` permission on this service account and then the specified runtime containers will run as it.\n\nDo not set this field if you want to submit jobs using custom service\naccount to this PersistentResource after creation, but only specify the\n`service_account` inside the job.\n\n### setServiceAccount\n\nOptional. Required when all below conditions are met\n\n- `enable_custom_service_account` is true;\n- any runtime is specified via `ResourceRuntimeSpec` on creation time, for example, Ray The users must have `iam.serviceAccounts.actAs` permission on this service account and then the specified runtime containers will run as it.\n\nDo not set this field if you want to submit jobs using custom service\naccount to this PersistentResource after creation, but only specify the\n`service_account` inside the job."]]
