Class ServiceAccountAuthConfig.Builder (0.1.0)

public static final class ServiceAccountAuthConfig.Builder extends GeneratedMessage.Builder<ServiceAccountAuthConfig.Builder> implements ServiceAccountAuthConfigOrBuilder

Configurations for authentication using a custom service account.

Protobuf type google.cloud.ces.v1.ServiceAccountAuthConfig

Static Methods

getDescriptor()

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

Methods

addAllScopes(Iterable<String> values)

public ServiceAccountAuthConfig.Builder addAllScopes(Iterable<String> values)

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
values Iterable<String>

The scopes to add.

Returns
Type Description
ServiceAccountAuthConfig.Builder

This builder for chaining.

addScopes(String value)

public ServiceAccountAuthConfig.Builder addScopes(String value)

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
value String

The scopes to add.

Returns
Type Description
ServiceAccountAuthConfig.Builder

This builder for chaining.

addScopesBytes(ByteString value)

public ServiceAccountAuthConfig.Builder addScopesBytes(ByteString value)

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
value ByteString

The bytes of the scopes to add.

Returns
Type Description
ServiceAccountAuthConfig.Builder

This builder for chaining.

build()

public ServiceAccountAuthConfig build()
Returns
Type Description
ServiceAccountAuthConfig

buildPartial()

public ServiceAccountAuthConfig buildPartial()
Returns
Type Description
ServiceAccountAuthConfig

clear()

public ServiceAccountAuthConfig.Builder clear()
Returns
Type Description
ServiceAccountAuthConfig.Builder
Overrides

clearScopes()

public ServiceAccountAuthConfig.Builder clearScopes()

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
ServiceAccountAuthConfig.Builder

This builder for chaining.

clearServiceAccount()

public ServiceAccountAuthConfig.Builder clearServiceAccount()

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
ServiceAccountAuthConfig.Builder

This builder for chaining.

getDefaultInstanceForType()

public ServiceAccountAuthConfig getDefaultInstanceForType()
Returns
Type Description
ServiceAccountAuthConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ServiceAccountAuthConfig other)

public ServiceAccountAuthConfig.Builder mergeFrom(ServiceAccountAuthConfig other)
Parameter
Name Description
other ServiceAccountAuthConfig
Returns
Type Description
ServiceAccountAuthConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ServiceAccountAuthConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ServiceAccountAuthConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ServiceAccountAuthConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ServiceAccountAuthConfig.Builder
Overrides

setScopes(int index, String value)

public ServiceAccountAuthConfig.Builder setScopes(int index, String value)

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];

Parameters
Name Description
index int

The index to set the value at.

value String

The scopes to set.

Returns
Type Description
ServiceAccountAuthConfig.Builder

This builder for chaining.

setServiceAccount(String value)

public ServiceAccountAuthConfig.Builder setServiceAccount(String value)

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];

Parameter
Name Description
value String

The serviceAccount to set.

Returns
Type Description
ServiceAccountAuthConfig.Builder

This builder for chaining.

setServiceAccountBytes(ByteString value)

public ServiceAccountAuthConfig.Builder setServiceAccountBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for serviceAccount to set.

Returns
Type Description
ServiceAccountAuthConfig.Builder

This builder for chaining.