Class OidcToken (2.3.3)

Stay organized with collections Save and categorize content based on your preferences.
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.v1beta1.OidcToken

Implements

OidcTokenOrBuilder

Static Fields

AUDIENCE_FIELD_NUMBER

public static final int AUDIENCE_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static OidcToken getDefaultInstance()
Returns
TypeDescription
OidcToken

getDescriptor()

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

newBuilder()

public static OidcToken.Builder newBuilder()
Returns
TypeDescription
OidcToken.Builder

newBuilder(OidcToken prototype)

public static OidcToken.Builder newBuilder(OidcToken prototype)
Parameter
NameDescription
prototypeOidcToken
Returns
TypeDescription
OidcToken.Builder

parseDelimitedFrom(InputStream input)

public static OidcToken parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
OidcToken
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static OidcToken parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
OidcToken
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static OidcToken parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
OidcToken
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static OidcToken parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
OidcToken
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static OidcToken parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
OidcToken
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<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()

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

string audience = 2;

Returns
TypeDescription
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
TypeDescription
ByteString

The bytes for audience.

getDefaultInstanceForType()

public OidcToken getDefaultInstanceForType()
Returns
TypeDescription
OidcToken

getParserForType()

public Parser<OidcToken> getParserForType()
Returns
TypeDescription
Parser<OidcToken>
Overrides

getSerializedSize()

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

The bytes for serviceAccountEmail.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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 OidcToken.Builder newBuilderForType()
Returns
TypeDescription
OidcToken.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public OidcToken.Builder toBuilder()
Returns
TypeDescription
OidcToken.Builder

writeTo(CodedOutputStream output)

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