Class GenerateIdTokenRequest.Builder (2.22.0)

public static final class GenerateIdTokenRequest.Builder extends GeneratedMessageV3.Builder<GenerateIdTokenRequest.Builder> implements GenerateIdTokenRequestOrBuilder

Protobuf type google.iam.credentials.v1.GenerateIdTokenRequest

Static Methods

getDescriptor()

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

Methods

addAllDelegates(Iterable<String> values)

public GenerateIdTokenRequest.Builder addAllDelegates(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
NameDescription
valuesIterable<String>

The delegates to add.

Returns
TypeDescription
GenerateIdTokenRequest.Builder

This builder for chaining.

addDelegates(String value)

public GenerateIdTokenRequest.Builder addDelegates(String value)

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
valueString

The delegates to add.

Returns
TypeDescription
GenerateIdTokenRequest.Builder

This builder for chaining.

addDelegatesBytes(ByteString value)

public GenerateIdTokenRequest.Builder addDelegatesBytes(ByteString value)

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
valueByteString

The bytes of the delegates to add.

Returns
TypeDescription
GenerateIdTokenRequest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public GenerateIdTokenRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
GenerateIdTokenRequest.Builder
Overrides

build()

public GenerateIdTokenRequest build()
Returns
TypeDescription
GenerateIdTokenRequest

buildPartial()

public GenerateIdTokenRequest buildPartial()
Returns
TypeDescription
GenerateIdTokenRequest

clear()

public GenerateIdTokenRequest.Builder clear()
Returns
TypeDescription
GenerateIdTokenRequest.Builder
Overrides

clearAudience()

public GenerateIdTokenRequest.Builder clearAudience()

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
GenerateIdTokenRequest.Builder

This builder for chaining.

clearDelegates()

public GenerateIdTokenRequest.Builder clearDelegates()

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
GenerateIdTokenRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public GenerateIdTokenRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
GenerateIdTokenRequest.Builder
Overrides

clearIncludeEmail()

public GenerateIdTokenRequest.Builder clearIncludeEmail()

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
GenerateIdTokenRequest.Builder

This builder for chaining.

clearName()

public GenerateIdTokenRequest.Builder clearName()

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
GenerateIdTokenRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public GenerateIdTokenRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
GenerateIdTokenRequest.Builder
Overrides

clone()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(GenerateIdTokenRequest other)

public GenerateIdTokenRequest.Builder mergeFrom(GenerateIdTokenRequest other)
Parameter
NameDescription
otherGenerateIdTokenRequest
Returns
TypeDescription
GenerateIdTokenRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GenerateIdTokenRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GenerateIdTokenRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public GenerateIdTokenRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
GenerateIdTokenRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GenerateIdTokenRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
GenerateIdTokenRequest.Builder
Overrides

setAudience(String value)

public GenerateIdTokenRequest.Builder setAudience(String value)

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
NameDescription
valueString

The audience to set.

Returns
TypeDescription
GenerateIdTokenRequest.Builder

This builder for chaining.

setAudienceBytes(ByteString value)

public GenerateIdTokenRequest.Builder setAudienceBytes(ByteString value)

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
NameDescription
valueByteString

The bytes for audience to set.

Returns
TypeDescription
GenerateIdTokenRequest.Builder

This builder for chaining.

setDelegates(int index, String value)

public GenerateIdTokenRequest.Builder setDelegates(int index, String value)

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
NameDescription
indexint

The index to set the value at.

valueString

The delegates to set.

Returns
TypeDescription
GenerateIdTokenRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public GenerateIdTokenRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
GenerateIdTokenRequest.Builder
Overrides

setIncludeEmail(boolean value)

public GenerateIdTokenRequest.Builder setIncludeEmail(boolean value)

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
NameDescription
valueboolean

The includeEmail to set.

Returns
TypeDescription
GenerateIdTokenRequest.Builder

This builder for chaining.

setName(String value)

public GenerateIdTokenRequest.Builder setName(String value)

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
NameDescription
valueString

The name to set.

Returns
TypeDescription
GenerateIdTokenRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public GenerateIdTokenRequest.Builder setNameBytes(ByteString value)

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
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
GenerateIdTokenRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public GenerateIdTokenRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
GenerateIdTokenRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final GenerateIdTokenRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
GenerateIdTokenRequest.Builder
Overrides