Class GenerateAccessTokenRequest (2.13.0) 

publicfinalclass GenerateAccessTokenRequestextendsGeneratedMessageV3implementsGenerateAccessTokenRequestOrBuilder

Protobuf type google.iam.credentials.v1.GenerateAccessTokenRequest

Inherited Members

Static Fields

DELEGATES_FIELD_NUMBER

publicstaticfinalintDELEGATES_FIELD_NUMBER
Field Value
Type Description
int

LIFETIME_FIELD_NUMBER

publicstaticfinalintLIFETIME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

publicstaticfinalintNAME_FIELD_NUMBER
Field Value
Type Description
int

SCOPE_FIELD_NUMBER

publicstaticfinalintSCOPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticGenerateAccessTokenRequestgetDefaultInstance()
Returns
Type Description
GenerateAccessTokenRequest

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticGenerateAccessTokenRequest.BuildernewBuilder()
Returns
Type Description
GenerateAccessTokenRequest.Builder

newBuilder(GenerateAccessTokenRequest prototype)

publicstaticGenerateAccessTokenRequest.BuildernewBuilder(GenerateAccessTokenRequestprototype)
Parameter
Name Description
prototype GenerateAccessTokenRequest
Returns
Type Description
GenerateAccessTokenRequest.Builder

parseDelimitedFrom(InputStream input)

publicstaticGenerateAccessTokenRequestparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
GenerateAccessTokenRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

publicstaticGenerateAccessTokenRequestparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
GenerateAccessTokenRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

publicstaticGenerateAccessTokenRequestparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
GenerateAccessTokenRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

publicstaticGenerateAccessTokenRequestparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
GenerateAccessTokenRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

publicstaticGenerateAccessTokenRequestparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
GenerateAccessTokenRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

publicstaticGenerateAccessTokenRequestparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
GenerateAccessTokenRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

publicGenerateAccessTokenRequestgetDefaultInstanceForType()
Returns
Type Description
GenerateAccessTokenRequest

getDelegates(int index)

publicStringgetDelegates(intindex)

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
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The delegates at the given index.

getDelegatesBytes(int index)

publicByteStringgetDelegatesBytes(intindex)

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
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the delegates at the given index.

getDelegatesCount()

publicintgetDelegatesCount()

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
Type Description
int

The count of delegates.

getDelegatesList()

publicProtocolStringListgetDelegatesList()

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
Type Description
ProtocolStringList

A list containing the delegates.

getLifetime()

publicDurationgetLifetime()

The desired lifetime duration of the access token in seconds. Must be set to a value less than or equal to 3600 (1 hour). If a value is not specified, the token's lifetime will be set to a default value of one hour.

.google.protobuf.Duration lifetime = 7;

Returns
Type Description
Duration

The lifetime.

getLifetimeOrBuilder()

publicDurationOrBuildergetLifetimeOrBuilder()

The desired lifetime duration of the access token in seconds. Must be set to a value less than or equal to 3600 (1 hour). If a value is not specified, the token's lifetime will be set to a default value of one hour.

.google.protobuf.Duration lifetime = 7;

Returns
Type Description
DurationOrBuilder

getName()

publicStringgetName()

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
Type Description
String

The name.

getNameBytes()

publicByteStringgetNameBytes()

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
Type Description
ByteString

The bytes for name.

getParserForType()

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

getScope(int index)

publicStringgetScope(intindex)

Required. Code to identify the scopes to be included in the OAuth 2.0 access token. See https://developers.google.com/identity/protocols/googlescopes for more information. At least one value required.

repeated string scope = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The scope at the given index.

getScopeBytes(int index)

publicByteStringgetScopeBytes(intindex)

Required. Code to identify the scopes to be included in the OAuth 2.0 access token. See https://developers.google.com/identity/protocols/googlescopes for more information. At least one value required.

repeated string scope = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the scope at the given index.

getScopeCount()

publicintgetScopeCount()

Required. Code to identify the scopes to be included in the OAuth 2.0 access token. See https://developers.google.com/identity/protocols/googlescopes for more information. At least one value required.

repeated string scope = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The count of scope.

getScopeList()

publicProtocolStringListgetScopeList()

Required. Code to identify the scopes to be included in the OAuth 2.0 access token. See https://developers.google.com/identity/protocols/googlescopes for more information. At least one value required.

repeated string scope = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ProtocolStringList

A list containing the scope.

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

publicfinalUnknownFieldSetgetUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hasLifetime()

publicbooleanhasLifetime()

The desired lifetime duration of the access token in seconds. Must be set to a value less than or equal to 3600 (1 hour). If a value is not specified, the token's lifetime will be set to a default value of one hour.

.google.protobuf.Duration lifetime = 7;

Returns
Type Description
boolean

Whether the lifetime field is set.

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicGenerateAccessTokenRequest.BuildernewBuilderForType()
Returns
Type Description
GenerateAccessTokenRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedGenerateAccessTokenRequest.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
GenerateAccessTokenRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

publicGenerateAccessTokenRequest.BuildertoBuilder()
Returns
Type Description
GenerateAccessTokenRequest.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年10月30日 UTC.