Class Pipeline.Destination.AuthenticationConfig.OidcToken.Builder (1.58.0)

public static final class Pipeline.Destination.AuthenticationConfig.OidcToken.Builder extends GeneratedMessageV3.Builder<Pipeline.Destination.AuthenticationConfig.OidcToken.Builder> implements Pipeline.Destination.AuthenticationConfig.OidcTokenOrBuilder

Represents a config used to authenticate with a Google OIDC token using a GCP service account. Use this authentication method to invoke your Cloud Run and Cloud Functions destinations or HTTP endpoints that support Google OIDC.

Protobuf type google.cloud.eventarc.v1.Pipeline.Destination.AuthenticationConfig.OidcToken

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Pipeline.Destination.AuthenticationConfig.OidcToken.Builder
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Pipeline.Destination.AuthenticationConfig.OidcToken.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Overrides

build()

public Pipeline.Destination.AuthenticationConfig.OidcToken build()

buildPartial()

public Pipeline.Destination.AuthenticationConfig.OidcToken buildPartial()

clear()

public Pipeline.Destination.AuthenticationConfig.OidcToken.Builder clear()
Overrides

clearAudience()

public Pipeline.Destination.AuthenticationConfig.OidcToken.Builder clearAudience()

Optional. Audience to be used to generate the OIDC Token. The audience claim identifies the recipient that the JWT is intended for. If unspecified, the destination URI will be used.

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

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Pipeline.Destination.AuthenticationConfig.OidcToken.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public Pipeline.Destination.AuthenticationConfig.OidcToken.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Overrides

clearServiceAccount()

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

Required. Service account email used to generate the OIDC 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 the Pipeline to create OpenID tokens for authenticated requests.

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

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

This builder for chaining.

clone()

public Pipeline.Destination.AuthenticationConfig.OidcToken.Builder clone()
Overrides

getAudience()

public String getAudience()

Optional. Audience to be used to generate the OIDC Token. The audience claim identifies the recipient that the JWT is intended for. If unspecified, the destination URI will be used.

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

Returns
Type Description
String

The audience.

getAudienceBytes()

public ByteString getAudienceBytes()

Optional. Audience to be used to generate the OIDC Token. The audience claim identifies the recipient that the JWT is intended for. If unspecified, the destination URI will be used.

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

Returns
Type Description
ByteString

The bytes for audience.

getDefaultInstanceForType()

public Pipeline.Destination.AuthenticationConfig.OidcToken getDefaultInstanceForType()

getDescriptorForType()

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

getServiceAccount()

public String getServiceAccount()

Required. Service account email used to generate the OIDC 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 the Pipeline to create OpenID 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 OIDC 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 the Pipeline to create OpenID 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 GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Pipeline.Destination.AuthenticationConfig.OidcToken other)

public Pipeline.Destination.AuthenticationConfig.OidcToken.Builder mergeFrom(Pipeline.Destination.AuthenticationConfig.OidcToken other)
Parameter
Name Description
other Pipeline.Destination.AuthenticationConfig.OidcToken

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public Pipeline.Destination.AuthenticationConfig.OidcToken.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Pipeline.Destination.AuthenticationConfig.OidcToken.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Overrides

setAudience(String value)

public Pipeline.Destination.AuthenticationConfig.OidcToken.Builder setAudience(String value)

Optional. Audience to be used to generate the OIDC Token. The audience claim identifies the recipient that the JWT is intended for. If unspecified, the destination URI will be used.

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

Parameter
Name Description
value String

The audience to set.

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

This builder for chaining.

setAudienceBytes(ByteString value)

public Pipeline.Destination.AuthenticationConfig.OidcToken.Builder setAudienceBytes(ByteString value)

Optional. Audience to be used to generate the OIDC Token. The audience claim identifies the recipient that the JWT is intended for. If unspecified, the destination URI will be used.

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

Parameter
Name Description
value ByteString

The bytes for audience to set.

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

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Pipeline.Destination.AuthenticationConfig.OidcToken.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Overrides

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

public Pipeline.Destination.AuthenticationConfig.OidcToken.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Overrides

setServiceAccount(String value)

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

Required. Service account email used to generate the OIDC 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 the Pipeline to create OpenID 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.OidcToken.Builder

This builder for chaining.

setServiceAccountBytes(ByteString value)

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

Required. Service account email used to generate the OIDC 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 the Pipeline to create OpenID 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.OidcToken.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Pipeline.Destination.AuthenticationConfig.OidcToken.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Overrides