Class GenerateIdTokenRequest.Builder (2.58.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 2.78.0 (latest)
- 2.76.0
- 2.75.0
- 2.74.0
- 2.73.0
- 2.72.0
- 2.70.0
- 2.68.0
- 2.67.0
- 2.64.0
- 2.63.0
- 2.62.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 2.52.0
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.6
- 2.2.0
- 2.1.0
- 2.0.15
publicstaticfinalclass GenerateIdTokenRequest.BuilderextendsGeneratedMessageV3.Builder<GenerateIdTokenRequest.Builder>implementsGenerateIdTokenRequestOrBuilderProtobuf type google.iam.credentials.v1.GenerateIdTokenRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > GenerateIdTokenRequest.BuilderImplements
GenerateIdTokenRequestOrBuilderInherited Members
Static Methods
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllDelegates(Iterable<String> values)
publicGenerateIdTokenRequest.BuilderaddAllDelegates(Iterable<String>values) 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 |
values |
Iterable<String>The delegates to add. |
| Returns | |
|---|---|
| Type | Description |
GenerateIdTokenRequest.Builder |
This builder for chaining. |
addDelegates(String value)
publicGenerateIdTokenRequest.BuilderaddDelegates(Stringvalue) 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 |
value |
String The delegates to add. |
| Returns | |
|---|---|
| Type | Description |
GenerateIdTokenRequest.Builder |
This builder for chaining. |
addDelegatesBytes(ByteString value)
publicGenerateIdTokenRequest.BuilderaddDelegatesBytes(ByteStringvalue) 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 |
value |
ByteString The bytes of the delegates to add. |
| Returns | |
|---|---|
| Type | Description |
GenerateIdTokenRequest.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
publicGenerateIdTokenRequest.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
GenerateIdTokenRequest.Builder |
|
build()
publicGenerateIdTokenRequestbuild()| Returns | |
|---|---|
| Type | Description |
GenerateIdTokenRequest |
|
buildPartial()
publicGenerateIdTokenRequestbuildPartial()| Returns | |
|---|---|
| Type | Description |
GenerateIdTokenRequest |
|
clear()
publicGenerateIdTokenRequest.Builderclear()| Returns | |
|---|---|
| Type | Description |
GenerateIdTokenRequest.Builder |
|
clearAudience()
publicGenerateIdTokenRequest.BuilderclearAudience()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 | |
|---|---|
| Type | Description |
GenerateIdTokenRequest.Builder |
This builder for chaining. |
clearDelegates()
publicGenerateIdTokenRequest.BuilderclearDelegates() 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 |
GenerateIdTokenRequest.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
publicGenerateIdTokenRequest.BuilderclearField(Descriptors.FieldDescriptorfield)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
GenerateIdTokenRequest.Builder |
|
clearIncludeEmail()
publicGenerateIdTokenRequest.BuilderclearIncludeEmail() 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 | |
|---|---|
| Type | Description |
GenerateIdTokenRequest.Builder |
This builder for chaining. |
clearName()
publicGenerateIdTokenRequest.BuilderclearName() 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 |
GenerateIdTokenRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
publicGenerateIdTokenRequest.BuilderclearOneof(Descriptors.OneofDescriptoroneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
GenerateIdTokenRequest.Builder |
|
clone()
publicGenerateIdTokenRequest.Builderclone()| Returns | |
|---|---|
| Type | Description |
GenerateIdTokenRequest.Builder |
|
getAudience()
publicStringgetAudience()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 | |
|---|---|
| Type | Description |
String |
The audience. |
getAudienceBytes()
publicByteStringgetAudienceBytes()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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for audience. |
getDefaultInstanceForType()
publicGenerateIdTokenRequestgetDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
GenerateIdTokenRequest |
|
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. |
getDescriptorForType()
publicDescriptors.DescriptorgetDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getIncludeEmail()
publicbooleangetIncludeEmail() 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 | |
|---|---|
| Type | Description |
boolean |
The includeEmail. |
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. |
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
publicfinalbooleanisInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(GenerateIdTokenRequest other)
publicGenerateIdTokenRequest.BuildermergeFrom(GenerateIdTokenRequestother)| Parameter | |
|---|---|
| Name | Description |
other |
GenerateIdTokenRequest |
| Returns | |
|---|---|
| Type | Description |
GenerateIdTokenRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicGenerateIdTokenRequest.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
GenerateIdTokenRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
publicGenerateIdTokenRequest.BuildermergeFrom(Messageother)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
GenerateIdTokenRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
publicfinalGenerateIdTokenRequest.BuildermergeUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
GenerateIdTokenRequest.Builder |
|
setAudience(String value)
publicGenerateIdTokenRequest.BuildersetAudience(Stringvalue)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];
| Parameter | |
|---|---|
| Name | Description |
value |
String The audience to set. |
| Returns | |
|---|---|
| Type | Description |
GenerateIdTokenRequest.Builder |
This builder for chaining. |
setAudienceBytes(ByteString value)
publicGenerateIdTokenRequest.BuildersetAudienceBytes(ByteStringvalue)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteString The bytes for audience to set. |
| Returns | |
|---|---|
| Type | Description |
GenerateIdTokenRequest.Builder |
This builder for chaining. |
setDelegates(int index, String value)
publicGenerateIdTokenRequest.BuildersetDelegates(intindex,Stringvalue) 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;
| Parameters | |
|---|---|
| Name | Description |
index |
int The index to set the value at. |
value |
String The delegates to set. |
| Returns | |
|---|---|
| Type | Description |
GenerateIdTokenRequest.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
publicGenerateIdTokenRequest.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
GenerateIdTokenRequest.Builder |
|
setIncludeEmail(boolean value)
publicGenerateIdTokenRequest.BuildersetIncludeEmail(booleanvalue) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
boolean The includeEmail to set. |
| Returns | |
|---|---|
| Type | Description |
GenerateIdTokenRequest.Builder |
This builder for chaining. |
setName(String value)
publicGenerateIdTokenRequest.BuildersetName(Stringvalue) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
String The name to set. |
| Returns | |
|---|---|
| Type | Description |
GenerateIdTokenRequest.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
publicGenerateIdTokenRequest.BuildersetNameBytes(ByteStringvalue) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteString The bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
GenerateIdTokenRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
publicGenerateIdTokenRequest.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
GenerateIdTokenRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
publicfinalGenerateIdTokenRequest.BuildersetUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
GenerateIdTokenRequest.Builder |
|