Class GenerateIdTokenRequest (2.33.0)

public final class GenerateIdTokenRequest extends GeneratedMessageV3 implements GenerateIdTokenRequestOrBuilder

Protobuf type google.iam.credentials.v1.GenerateIdTokenRequest

Static Fields

AUDIENCE_FIELD_NUMBER

public static final int AUDIENCE_FIELD_NUMBER
Field Value
TypeDescription
int

DELEGATES_FIELD_NUMBER

public static final int DELEGATES_FIELD_NUMBER
Field Value
TypeDescription
int

INCLUDE_EMAIL_FIELD_NUMBER

public static final int INCLUDE_EMAIL_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static GenerateIdTokenRequest getDefaultInstance()
Returns
TypeDescription
GenerateIdTokenRequest

getDescriptor()

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

newBuilder()

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

newBuilder(GenerateIdTokenRequest prototype)

public static GenerateIdTokenRequest.Builder newBuilder(GenerateIdTokenRequest prototype)
Parameter
NameDescription
prototypeGenerateIdTokenRequest
Returns
TypeDescription
GenerateIdTokenRequest.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<GenerateIdTokenRequest> parser()
Returns
TypeDescription
Parser<GenerateIdTokenRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAudience()

public String getAudience()

Required. The audience for the token, such as the API or account that this token grants access to.

string audience = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The audience.

getAudienceBytes()

public ByteString getAudienceBytes()

Required. The audience for the token, such as the API or account that this token grants access to.

string audience = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for audience.

getDefaultInstanceForType()

public GenerateIdTokenRequest getDefaultInstanceForType()
Returns
TypeDescription
GenerateIdTokenRequest

getDelegates(int index)

public String getDelegates(int index)

The sequence of service accounts in a delegation chain. Each service account must be granted the roles/iam.serviceAccountTokenCreator role on its next service account in the chain. The last service account in the chain must be granted the roles/iam.serviceAccountTokenCreator role on the service account that is specified in the name field of the request.

The delegates must have the following format: projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}. The - wildcard character is required; replacing it with a project ID is invalid.

repeated string delegates = 2;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The delegates at the given index.

getDelegatesBytes(int index)

public ByteString getDelegatesBytes(int index)

The sequence of service accounts in a delegation chain. Each service account must be granted the roles/iam.serviceAccountTokenCreator role on its next service account in the chain. The last service account in the chain must be granted the roles/iam.serviceAccountTokenCreator role on the service account that is specified in the name field of the request.

The delegates must have the following format: projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}. The - wildcard character is required; replacing it with a project ID is invalid.

repeated string delegates = 2;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the delegates at the given index.

getDelegatesCount()

public int getDelegatesCount()

The sequence of service accounts in a delegation chain. Each service account must be granted the roles/iam.serviceAccountTokenCreator role on its next service account in the chain. The last service account in the chain must be granted the roles/iam.serviceAccountTokenCreator role on the service account that is specified in the name field of the request.

The delegates must have the following format: projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}. The - wildcard character is required; replacing it with a project ID is invalid.

repeated string delegates = 2;

Returns
TypeDescription
int

The count of delegates.

getDelegatesList()

public ProtocolStringList getDelegatesList()

The sequence of service accounts in a delegation chain. Each service account must be granted the roles/iam.serviceAccountTokenCreator role on its next service account in the chain. The last service account in the chain must be granted the roles/iam.serviceAccountTokenCreator role on the service account that is specified in the name field of the request.

The delegates must have the following format: projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}. The - wildcard character is required; replacing it with a project ID is invalid.

repeated string delegates = 2;

Returns
TypeDescription
ProtocolStringList

A list containing the delegates.

getIncludeEmail()

public boolean getIncludeEmail()

Include the service account email in the token. If set to true, the token will contain email and email_verified claims.

bool include_email = 4;

Returns
TypeDescription
boolean

The includeEmail.

getName()

public String getName()

Required. The resource name of the service account for which the credentials are requested, in the following format: projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}. The - wildcard character is required; replacing it with a project ID is invalid.

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

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The resource name of the service account for which the credentials are requested, in the following format: projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}. The - wildcard character is required; replacing it with a project ID is invalid.

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

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
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 GenerateIdTokenRequest.Builder newBuilderForType()
Returns
TypeDescription
GenerateIdTokenRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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