Class OidcToken (2.54.0) 

public final class OidcToken extends GeneratedMessageV3 implements OidcTokenOrBuilder

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.scheduler.v1.OidcToken

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > OidcToken

Implements

OidcTokenOrBuilder

Static Fields

AUDIENCE_FIELD_NUMBER

public static final int AUDIENCE_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static OidcToken getDefaultInstance()
Returns
Type Description
OidcToken

getDescriptor()

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

newBuilder()

public static OidcToken.Builder newBuilder()
Returns
Type Description
OidcToken.Builder

newBuilder(OidcToken prototype)

public static OidcToken.Builder newBuilder(OidcToken prototype)
Parameter
Name Description
prototype OidcToken
Returns
Type Description
OidcToken.Builder

parseDelimitedFrom(InputStream input)

public static OidcToken parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
OidcToken
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OidcToken parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OidcToken
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static OidcToken parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
OidcToken
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static OidcToken parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OidcToken
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static OidcToken parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
OidcToken
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static OidcToken parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OidcToken
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static OidcToken parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
OidcToken
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static OidcToken parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OidcToken
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static OidcToken parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
OidcToken
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OidcToken parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OidcToken
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static OidcToken parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
OidcToken
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static OidcToken parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OidcToken
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<OidcToken> parser()
Returns
Type Description
Parser<OidcToken>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAudience()

public String getAudience()

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()

public ByteString getAudienceBytes()

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()

public OidcToken getDefaultInstanceForType()
Returns
Type Description
OidcToken

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceAccountEmail()

public String getServiceAccountEmail()

Service account email to be used for generating OIDC token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.

string service_account_email = 1;

Returns
Type Description
String

The serviceAccountEmail.

getServiceAccountEmailBytes()

public ByteString getServiceAccountEmailBytes()

Service account email to be used for generating OIDC token. The service account must be within the same project as the job. 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public OidcToken.Builder newBuilderForType()
Returns
Type Description
OidcToken.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected OidcToken.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
OidcToken.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public OidcToken.Builder toBuilder()
Returns
Type Description
OidcToken.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException