Class ServiceAccountAuthConfig (0.1.0)

public final class ServiceAccountAuthConfig extends GeneratedMessage implements ServiceAccountAuthConfigOrBuilder

Configurations for authentication using a custom service account.

Protobuf type google.cloud.ces.v1.ServiceAccountAuthConfig

Static Fields

SCOPES_FIELD_NUMBER

public static final int SCOPES_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 ServiceAccountAuthConfig getDefaultInstance()
Returns
Type Description
ServiceAccountAuthConfig

getDescriptor()

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

newBuilder()

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

newBuilder(ServiceAccountAuthConfig prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ServiceAccountAuthConfig getDefaultInstanceForType()
Returns
Type Description
ServiceAccountAuthConfig

getParserForType()

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

getScopes(int index)

public String getScopes(int index)

Optional. The OAuth scopes to grant. If not specified, the default scope https://www.googleapis.com/auth/cloud-platform is used.

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

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The scopes at the given index.

getScopesBytes(int index)

public ByteString getScopesBytes(int index)

Optional. The OAuth scopes to grant. If not specified, the default scope https://www.googleapis.com/auth/cloud-platform is used.

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

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the scopes at the given index.

getScopesCount()

public int getScopesCount()

Optional. The OAuth scopes to grant. If not specified, the default scope https://www.googleapis.com/auth/cloud-platform is used.

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

Returns
Type Description
int

The count of scopes.

getScopesList()

public ProtocolStringList getScopesList()

Optional. The OAuth scopes to grant. If not specified, the default scope https://www.googleapis.com/auth/cloud-platform is used.

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

Returns
Type Description
ProtocolStringList

A list containing the scopes.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceAccount()

public String getServiceAccount()

Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the Authorization header of the request.

The service account must have the roles/iam.serviceAccountTokenCreator role granted to the CES service agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

string service_account = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The serviceAccount.

getServiceAccountBytes()

public ByteString getServiceAccountBytes()

Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the Authorization header of the request.

The service account must have the roles/iam.serviceAccountTokenCreator role granted to the CES service agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

string service_account = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for serviceAccount.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ServiceAccountAuthConfig.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ServiceAccountAuthConfig.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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