Class OAuthToken.Builder (2.83.0)

public static final class OAuthToken.Builder extends GeneratedMessage.Builder<OAuthToken.Builder> implements OAuthTokenOrBuilder

Contains information needed for generating an OAuth token. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.

Protobuf type google.cloud.tasks.v2.OAuthToken

Implements

OAuthTokenOrBuilder

Static Methods

getDescriptor()

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

Methods

build()

public OAuthToken build()
Returns
Type Description
OAuthToken

buildPartial()

public OAuthToken buildPartial()
Returns
Type Description
OAuthToken

clear()

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

clearScope()

public OAuthToken.Builder clearScope()

OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.

string scope = 2;

Returns
Type Description
OAuthToken.Builder

This builder for chaining.

clearServiceAccountEmail()

public OAuthToken.Builder clearServiceAccountEmail()

Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.

string service_account_email = 1;

Returns
Type Description
OAuthToken.Builder

This builder for chaining.

getDefaultInstanceForType()

public OAuthToken getDefaultInstanceForType()
Returns
Type Description
OAuthToken

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getScope()

public String getScope()

OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.

string scope = 2;

Returns
Type Description
String

The scope.

getScopeBytes()

public ByteString getScopeBytes()

OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.

string scope = 2;

Returns
Type Description
ByteString

The bytes for scope.

getServiceAccountEmail()

public String getServiceAccountEmail()

Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.

string service_account_email = 1;

Returns
Type Description
String

The serviceAccountEmail.

getServiceAccountEmailBytes()

public ByteString getServiceAccountEmailBytes()

Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.

string service_account_email = 1;

Returns
Type Description
ByteString

The bytes for serviceAccountEmail.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(OAuthToken other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setScope(String value)

public OAuthToken.Builder setScope(String value)

OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.

string scope = 2;

Parameter
Name Description
value String

The scope to set.

Returns
Type Description
OAuthToken.Builder

This builder for chaining.

setScopeBytes(ByteString value)

public OAuthToken.Builder setScopeBytes(ByteString value)

OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.

string scope = 2;

Parameter
Name Description
value ByteString

The bytes for scope to set.

Returns
Type Description
OAuthToken.Builder

This builder for chaining.

setServiceAccountEmail(String value)

public OAuthToken.Builder setServiceAccountEmail(String value)

Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.

string service_account_email = 1;

Parameter
Name Description
value String

The serviceAccountEmail to set.

Returns
Type Description
OAuthToken.Builder

This builder for chaining.

setServiceAccountEmailBytes(ByteString value)

public OAuthToken.Builder setServiceAccountEmailBytes(ByteString value)

Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.

string service_account_email = 1;

Parameter
Name Description
value ByteString

The bytes for serviceAccountEmail to set.

Returns
Type Description
OAuthToken.Builder

This builder for chaining.