Class OidcToken (2.3.12) 

publicfinalclass OidcTokenextendsGeneratedMessageV3implementsOidcTokenOrBuilder

Contains information needed for generating an OpenID Connect token. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.

Protobuf type google.cloud.tasks.v2.OidcToken

Implements

OidcTokenOrBuilder

Inherited Members

Static Fields

AUDIENCE_FIELD_NUMBER

publicstaticfinalintAUDIENCE_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER

publicstaticfinalintSERVICE_ACCOUNT_EMAIL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticOidcTokengetDefaultInstance()
Returns
Type Description
OidcToken

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticOidcToken.BuildernewBuilder()
Returns
Type Description
OidcToken.Builder

newBuilder(OidcToken prototype)

publicstaticOidcToken.BuildernewBuilder(OidcTokenprototype)
Parameter
Name Description
prototype OidcToken
Returns
Type Description
OidcToken.Builder

parseDelimitedFrom(InputStream input)

publicstaticOidcTokenparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
OidcToken
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticOidcTokenparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OidcToken
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticOidcTokenparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
OidcToken
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticOidcTokenparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OidcToken
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticOidcTokenparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
OidcToken
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticOidcTokenparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OidcToken
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticOidcTokenparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
OidcToken
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticOidcTokenparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OidcToken
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticOidcTokenparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
OidcToken
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticOidcTokenparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OidcToken
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticOidcTokenparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
OidcToken
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticOidcTokenparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OidcToken
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<OidcToken>parser()
Returns
Type Description
Parser<OidcToken>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAudience()

publicStringgetAudience()

Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.

string audience = 2;

Returns
Type Description
String

The audience.

getAudienceBytes()

publicByteStringgetAudienceBytes()

Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.

string audience = 2;

Returns
Type Description
ByteString

The bytes for audience.

getDefaultInstanceForType()

publicOidcTokengetDefaultInstanceForType()
Returns
Type Description
OidcToken

getParserForType()

publicParser<OidcToken>getParserForType()
Returns
Type Description
Parser<OidcToken>
Overrides

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

getServiceAccountEmail()

publicStringgetServiceAccountEmail()

Service account email to be used for generating OIDC 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()

publicByteStringgetServiceAccountEmailBytes()

Service account email to be used for generating OIDC 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.

getUnknownFields()

publicfinalUnknownFieldSetgetUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicOidcToken.BuildernewBuilderForType()
Returns
Type Description
OidcToken.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedOidcToken.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
OidcToken.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicOidcToken.BuildertoBuilder()
Returns
Type Description
OidcToken.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.