Class Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder (1.83.0)

public static final class Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder extends GeneratedMessage.Builder<Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder> implements Pipeline.Destination.AuthenticationConfig.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.eventarc.v1.Pipeline.Destination.AuthenticationConfig.OAuthToken

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder

Static Methods

getDescriptor()

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

Methods

build()

public Pipeline.Destination.AuthenticationConfig.OAuthToken build()
Returns
Type Description
Pipeline.Destination.AuthenticationConfig.OAuthToken

buildPartial()

public Pipeline.Destination.AuthenticationConfig.OAuthToken buildPartial()
Returns
Type Description
Pipeline.Destination.AuthenticationConfig.OAuthToken

clear()

public Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder clear()
Returns
Type Description
Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder
Overrides

clearScope()

public Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder clearScope()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder

This builder for chaining.

clearServiceAccount()

public Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder clearServiceAccount()

Required. Service account email used to generate the OAuth token. The principal who calls this API must have iam.serviceAccounts.actAs permission in the service account. See https://cloud.google.com/iam/docs/understanding-service-accounts for more information. Eventarc service agents must have roles/roles/iam.serviceAccountTokenCreator role to allow Pipeline to create OAuth2 tokens for authenticated requests.

string service_account = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder

This builder for chaining.

getDefaultInstanceForType()

public Pipeline.Destination.AuthenticationConfig.OAuthToken getDefaultInstanceForType()
Returns
Type Description
Pipeline.Destination.AuthenticationConfig.OAuthToken

getDescriptorForType()

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

getScope()

public String getScope()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The scope.

getScopeBytes()

public ByteString getScopeBytes()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for scope.

getServiceAccount()

public String getServiceAccount()

Required. Service account email used to generate the OAuth token. The principal who calls this API must have iam.serviceAccounts.actAs permission in the service account. See https://cloud.google.com/iam/docs/understanding-service-accounts for more information. Eventarc service agents must have roles/roles/iam.serviceAccountTokenCreator role to allow Pipeline to create OAuth2 tokens for authenticated requests.

string service_account = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The serviceAccount.

getServiceAccountBytes()

public ByteString getServiceAccountBytes()

Required. Service account email used to generate the OAuth token. The principal who calls this API must have iam.serviceAccounts.actAs permission in the service account. See https://cloud.google.com/iam/docs/understanding-service-accounts for more information. Eventarc service agents must have roles/roles/iam.serviceAccountTokenCreator role to allow Pipeline to create OAuth2 tokens for authenticated requests.

string service_account = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

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(Pipeline.Destination.AuthenticationConfig.OAuthToken other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setScope(String value)

public Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder setScope(String value)

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The scope to set.

Returns
Type Description
Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder

This builder for chaining.

setScopeBytes(ByteString value)

public Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder setScopeBytes(ByteString value)

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for scope to set.

Returns
Type Description
Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder

This builder for chaining.

setServiceAccount(String value)

public Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder setServiceAccount(String value)

Required. Service account email used to generate the OAuth token. The principal who calls this API must have iam.serviceAccounts.actAs permission in the service account. See https://cloud.google.com/iam/docs/understanding-service-accounts for more information. Eventarc service agents must have roles/roles/iam.serviceAccountTokenCreator role to allow Pipeline to create OAuth2 tokens for authenticated requests.

string service_account = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The serviceAccount to set.

Returns
Type Description
Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder

This builder for chaining.

setServiceAccountBytes(ByteString value)

public Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder setServiceAccountBytes(ByteString value)

Required. Service account email used to generate the OAuth token. The principal who calls this API must have iam.serviceAccounts.actAs permission in the service account. See https://cloud.google.com/iam/docs/understanding-service-accounts for more information. Eventarc service agents must have roles/roles/iam.serviceAccountTokenCreator role to allow Pipeline to create OAuth2 tokens for authenticated requests.

string service_account = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for serviceAccount to set.

Returns
Type Description
Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder

This builder for chaining.