Google Cloud Ai Platform V1 Client - Class ServiceAccountSpec (1.41.0)

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 message google.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 the Vertex AI Custom Code Service Agent.
↳ service_account string

Optional. Required when all below conditions are met * * enable_custom_service_account is true; * * 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. Do not set this field if you want to submit jobs using custom service account to this PersistentResource after creation, but only specify the service_account inside 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 the Vertex 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 the Vertex 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_account is true;
  • 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.

Do not set this field if you want to submit jobs using custom service account to this PersistentResource after creation, but only specify the service_account inside the job.

Returns
Type Description
string

setServiceAccount

Optional. Required when all below conditions are met

  • enable_custom_service_account is true;
  • 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.

Do not set this field if you want to submit jobs using custom service account to this PersistentResource after creation, but only specify the service_account inside the job.

Parameter
Name Description
var string
Returns
Type Description
$this