Class ServiceAccountSpec (3.45.0)

public final class ServiceAccountSpec extends GeneratedMessageV3 implements ServiceAccountSpecOrBuilder

Configuration for the use of custom service account to run the workloads.

Protobuf type google.cloud.aiplatform.v1.ServiceAccountSpec

Static Fields

ENABLE_CUSTOM_SERVICE_ACCOUNT_FIELD_NUMBER

public static final int ENABLE_CUSTOM_SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ServiceAccountSpec getDefaultInstance()
Returns
Type Description
ServiceAccountSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ServiceAccountSpec.Builder newBuilder()
Returns
Type Description
ServiceAccountSpec.Builder

newBuilder(ServiceAccountSpec prototype)

public static ServiceAccountSpec.Builder newBuilder(ServiceAccountSpec prototype)
Parameter
Name Description
prototype ServiceAccountSpec
Returns
Type Description
ServiceAccountSpec.Builder

parseDelimitedFrom(InputStream input)

public static ServiceAccountSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ServiceAccountSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ServiceAccountSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ServiceAccountSpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ServiceAccountSpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ServiceAccountSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ServiceAccountSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ServiceAccountSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ServiceAccountSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ServiceAccountSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ServiceAccountSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ServiceAccountSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ServiceAccountSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ServiceAccountSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ServiceAccountSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ServiceAccountSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ServiceAccountSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ServiceAccountSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ServiceAccountSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ServiceAccountSpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ServiceAccountSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ServiceAccountSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ServiceAccountSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ServiceAccountSpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ServiceAccountSpec> parser()
Returns
Type Description
Parser<ServiceAccountSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ServiceAccountSpec getDefaultInstanceForType()
Returns
Type Description
ServiceAccountSpec

getEnableCustomServiceAccount()

public boolean 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.

bool enable_custom_service_account = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

The enableCustomServiceAccount.

getParserForType()

public Parser<ServiceAccountSpec> getParserForType()
Returns
Type Description
Parser<ServiceAccountSpec>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceAccount()

public String 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.

string service_account = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The serviceAccount.

getServiceAccountBytes()

public ByteString getServiceAccountBytes()

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.

string service_account = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for serviceAccount.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ServiceAccountSpec.Builder newBuilderForType()
Returns
Type Description
ServiceAccountSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ServiceAccountSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ServiceAccountSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ServiceAccountSpec.Builder toBuilder()
Returns
Type Description
ServiceAccountSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException