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

public static final class Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder extends GeneratedMessageV3.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

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder
Overrides

build()

public Pipeline.Destination.AuthenticationConfig.OAuthToken build()
Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OAuthToken

buildPartial()

public Pipeline.Destination.AuthenticationConfig.OAuthToken buildPartial()
Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OAuthToken

clear()

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

clearField(Descriptors.FieldDescriptor field)

public Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
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?hl=en#sa_common 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
TypeDescription
Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder

This builder for chaining.

clone()

public Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder clone()
Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder
Overrides

getDefaultInstanceForType()

public Pipeline.Destination.AuthenticationConfig.OAuthToken getDefaultInstanceForType()
Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OAuthToken

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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?hl=en#sa_common 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
TypeDescription
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?hl=en#sa_common 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
TypeDescription
ByteString

The bytes for serviceAccount.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Pipeline.Destination.AuthenticationConfig.OAuthToken other)

public Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder mergeFrom(Pipeline.Destination.AuthenticationConfig.OAuthToken other)
Parameter
NameDescription
otherPipeline.Destination.AuthenticationConfig.OAuthToken
Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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
NameDescription
valueString

The scope to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for scope to set.

Returns
TypeDescription
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?hl=en#sa_common 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
NameDescription
valueString

The serviceAccount to set.

Returns
TypeDescription
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?hl=en#sa_common 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
NameDescription
valueByteString

The bytes for serviceAccount to set.

Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OAuthToken.Builder
Overrides