Class ServiceAccountSpec (3.24.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.v1beta1.ServiceAccountSpec

Static Fields

ENABLE_CUSTOM_SERVICE_ACCOUNT_FIELD_NUMBER

public static final int ENABLE_CUSTOM_SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ServiceAccountSpec getDefaultInstance()
Returns
TypeDescription
ServiceAccountSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ServiceAccountSpec.Builder newBuilder()
Returns
TypeDescription
ServiceAccountSpec.Builder

newBuilder(ServiceAccountSpec prototype)

public static ServiceAccountSpec.Builder newBuilder(ServiceAccountSpec prototype)
Parameter
NameDescription
prototypeServiceAccountSpec
Returns
TypeDescription
ServiceAccountSpec.Builder

parseDelimitedFrom(InputStream input)

public static ServiceAccountSpec parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ServiceAccountSpec
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ServiceAccountSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ServiceAccountSpec
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ServiceAccountSpec parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ServiceAccountSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ServiceAccountSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ServiceAccountSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ServiceAccountSpec parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ServiceAccountSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ServiceAccountSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ServiceAccountSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ServiceAccountSpec parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ServiceAccountSpec
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ServiceAccountSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ServiceAccountSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ServiceAccountSpec parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ServiceAccountSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ServiceAccountSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ServiceAccountSpec
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ServiceAccountSpec parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ServiceAccountSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ServiceAccountSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ServiceAccountSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ServiceAccountSpec> parser()
Returns
TypeDescription
Parser<ServiceAccountSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public ServiceAccountSpec getDefaultInstanceForType()
Returns
TypeDescription
ServiceAccountSpec

getEnableCustomServiceAccount()

public boolean getEnableCustomServiceAccount()

Required. If true, custom user-managed service account is enforced to run any workloads (e.g. Vertex Jobs) on the resource; Otherwise, will always use Vertex AI Custom Code Service Agent

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

Returns
TypeDescription
boolean

The enableCustomServiceAccount.

getParserForType()

public Parser<ServiceAccountSpec> getParserForType()
Returns
TypeDescription
Parser<ServiceAccountSpec>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getServiceAccount()

public String getServiceAccount()

Optional. Default service account that this PersistentResource's workloads run as. The workloads include:

  • Any runtime specified via ResourceRuntimeSpec on creation time, e.g. Ray;
  • Jobs submitted to PersistentResource, if no other service account specified in the job specs.

Only works when custom service account is enabled and users have the iam.serviceAccounts.actAs permission on this service account.

Required if any containers specified in ResourceRuntimeSpec.

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

Returns
TypeDescription
String

The serviceAccount.

getServiceAccountBytes()

public ByteString getServiceAccountBytes()

Optional. Default service account that this PersistentResource's workloads run as. The workloads include:

  • Any runtime specified via ResourceRuntimeSpec on creation time, e.g. Ray;
  • Jobs submitted to PersistentResource, if no other service account specified in the job specs.

Only works when custom service account is enabled and users have the iam.serviceAccounts.actAs permission on this service account.

Required if any containers specified in ResourceRuntimeSpec.

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

Returns
TypeDescription
ByteString

The bytes for serviceAccount.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ServiceAccountSpec.Builder newBuilderForType()
Returns
TypeDescription
ServiceAccountSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ServiceAccountSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ServiceAccountSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ServiceAccountSpec.Builder toBuilder()
Returns
TypeDescription
ServiceAccountSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException