Class Pipeline.Destination.AuthenticationConfig.OidcToken (1.57.0)

public static final class Pipeline.Destination.AuthenticationConfig.OidcToken extends GeneratedMessageV3 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<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Pipeline.Destination.AuthenticationConfig.OidcToken

Static Fields

AUDIENCE_FIELD_NUMBER

public static final int AUDIENCE_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Pipeline.Destination.AuthenticationConfig.OidcToken getDefaultInstance()
Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OidcToken

getDescriptor()

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

newBuilder()

public static Pipeline.Destination.AuthenticationConfig.OidcToken.Builder newBuilder()
Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OidcToken.Builder

newBuilder(Pipeline.Destination.AuthenticationConfig.OidcToken )

public static Pipeline.Destination.AuthenticationConfig.OidcToken.Builder newBuilder(Pipeline.Destination.AuthenticationConfig.OidcToken )
Parameter
NameDescription
Pipeline.Destination.AuthenticationConfig.OidcToken
Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OidcToken.Builder

parseDelimitedFrom(InputStream input)

public static Pipeline.Destination.AuthenticationConfig.OidcToken parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OidcToken
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Pipeline.Destination.AuthenticationConfig.OidcToken parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OidcToken
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Pipeline.Destination.AuthenticationConfig.OidcToken parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OidcToken
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Pipeline.Destination.AuthenticationConfig.OidcToken parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OidcToken
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Pipeline.Destination.AuthenticationConfig.OidcToken parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OidcToken
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Pipeline.Destination.AuthenticationConfig.OidcToken parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OidcToken
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Pipeline.Destination.AuthenticationConfig.OidcToken parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OidcToken
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Pipeline.Destination.AuthenticationConfig.OidcToken parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OidcToken
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Pipeline.Destination.AuthenticationConfig.OidcToken parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OidcToken
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Pipeline.Destination.AuthenticationConfig.OidcToken parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OidcToken
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Pipeline.Destination.AuthenticationConfig.OidcToken parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OidcToken
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Pipeline.Destination.AuthenticationConfig.OidcToken parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OidcToken
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Pipeline.Destination.AuthenticationConfig.OidcToken> parser()
Returns
TypeDescription
Parser<OidcToken>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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
TypeDescription
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
TypeDescription
ByteString

The bytes for audience.

getDefaultInstanceForType()

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

getParserForType()

public Parser<Pipeline.Destination.AuthenticationConfig.OidcToken> getParserForType()
Returns
TypeDescription
Parser<OidcToken>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
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
TypeDescription
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
TypeDescription
ByteString

The bytes for serviceAccount.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Pipeline.Destination.AuthenticationConfig.OidcToken.Builder newBuilderForType()
Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OidcToken.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Pipeline.Destination.AuthenticationConfig.OidcToken.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OidcToken.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Pipeline.Destination.AuthenticationConfig.OidcToken.Builder toBuilder()
Returns
TypeDescription
Pipeline.Destination.AuthenticationConfig.OidcToken.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException