public static final class GenerateIdTokenRequest.Builder extends GeneratedMessageV3.Builder<GenerateIdTokenRequest.Builder> implements GenerateIdTokenRequestOrBuilder
Protobuf type google.iam.credentials.v1.GenerateIdTokenRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > GenerateIdTokenRequest.BuilderImplements
GenerateIdTokenRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
values | Iterable<String> The delegates to add. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | String The delegates to add. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
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)
public GenerateIdTokenRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
GenerateIdTokenRequest.Builder |
build()
public GenerateIdTokenRequest build()
Returns | |
---|---|
Type | Description |
GenerateIdTokenRequest |
buildPartial()
public GenerateIdTokenRequest buildPartial()
Returns | |
---|---|
Type | Description |
GenerateIdTokenRequest |
clear()
public GenerateIdTokenRequest.Builder clear()
Returns | |
---|---|
Type | Description |
GenerateIdTokenRequest.Builder |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
GenerateIdTokenRequest.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public GenerateIdTokenRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
GenerateIdTokenRequest.Builder |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
GenerateIdTokenRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public GenerateIdTokenRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
GenerateIdTokenRequest.Builder |
clone()
public GenerateIdTokenRequest.Builder clone()
Returns | |
---|---|
Type | Description |
GenerateIdTokenRequest.Builder |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
ByteString | The bytes for audience. |
getDefaultInstanceForType()
public GenerateIdTokenRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
index | int The index of the element to return. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
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()
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
ProtocolStringList | A list containing the delegates. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
ByteString | The bytes for name. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(GenerateIdTokenRequest other)
public GenerateIdTokenRequest.Builder mergeFrom(GenerateIdTokenRequest other)
Parameter | |
---|---|
Name | Description |
other | GenerateIdTokenRequest |
Returns | |
---|---|
Type | Description |
GenerateIdTokenRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public GenerateIdTokenRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
GenerateIdTokenRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public GenerateIdTokenRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
GenerateIdTokenRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final GenerateIdTokenRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
GenerateIdTokenRequest.Builder |
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 | |
---|---|
Name | Description |
value | String The audience to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | ByteString The bytes for audience to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
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)
public GenerateIdTokenRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
GenerateIdTokenRequest.Builder |
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 | |
---|---|
Name | Description |
value | boolean The includeEmail to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | String The name to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
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)
public GenerateIdTokenRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
GenerateIdTokenRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final GenerateIdTokenRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
GenerateIdTokenRequest.Builder |