Class SignJwtRequest.Builder (2.44.0)

public static final class SignJwtRequest.Builder extends GeneratedMessageV3.Builder<SignJwtRequest.Builder> implements SignJwtRequestOrBuilder

Protobuf type google.iam.credentials.v1.SignJwtRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllDelegates(Iterable<String> values)

public SignJwtRequest.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 = 3;

Parameter
Name Description
values Iterable<String>

The delegates to add.

Returns
Type Description
SignJwtRequest.Builder

This builder for chaining.

addDelegates(String value)

public SignJwtRequest.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 = 3;

Parameter
Name Description
value String

The delegates to add.

Returns
Type Description
SignJwtRequest.Builder

This builder for chaining.

addDelegatesBytes(ByteString value)

public SignJwtRequest.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 = 3;

Parameter
Name Description
value ByteString

The bytes of the delegates to add.

Returns
Type Description
SignJwtRequest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SignJwtRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SignJwtRequest.Builder
Overrides

build()

public SignJwtRequest build()
Returns
Type Description
SignJwtRequest

buildPartial()

public SignJwtRequest buildPartial()
Returns
Type Description
SignJwtRequest

clear()

public SignJwtRequest.Builder clear()
Returns
Type Description
SignJwtRequest.Builder
Overrides

clearDelegates()

public SignJwtRequest.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 = 3;

Returns
Type Description
SignJwtRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SignJwtRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SignJwtRequest.Builder
Overrides

clearName()

public SignJwtRequest.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
SignJwtRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SignJwtRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SignJwtRequest.Builder
Overrides

clearPayload()

public SignJwtRequest.Builder clearPayload()

Required. The JWT payload to sign: a JSON object that contains a JWT Claims Set.

string payload = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SignJwtRequest.Builder

This builder for chaining.

clone()

public SignJwtRequest.Builder clone()
Returns
Type Description
SignJwtRequest.Builder
Overrides

getDefaultInstanceForType()

public SignJwtRequest getDefaultInstanceForType()
Returns
Type Description
SignJwtRequest

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 = 3;

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 = 3;

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 = 3;

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 = 3;

Returns
Type Description
ProtocolStringList

A list containing the delegates.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getPayload()

public String getPayload()

Required. The JWT payload to sign: a JSON object that contains a JWT Claims Set.

string payload = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The payload.

getPayloadBytes()

public ByteString getPayloadBytes()

Required. The JWT payload to sign: a JSON object that contains a JWT Claims Set.

string payload = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for payload.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SignJwtRequest other)

public SignJwtRequest.Builder mergeFrom(SignJwtRequest other)
Parameter
Name Description
other SignJwtRequest
Returns
Type Description
SignJwtRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SignJwtRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SignJwtRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SignJwtRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SignJwtRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SignJwtRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SignJwtRequest.Builder
Overrides

setDelegates(int index, String value)

public SignJwtRequest.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 = 3;

Parameters
Name Description
index int

The index to set the value at.

value String

The delegates to set.

Returns
Type Description
SignJwtRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public SignJwtRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SignJwtRequest.Builder
Overrides

setName(String value)

public SignJwtRequest.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
SignJwtRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public SignJwtRequest.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
SignJwtRequest.Builder

This builder for chaining.

setPayload(String value)

public SignJwtRequest.Builder setPayload(String value)

Required. The JWT payload to sign: a JSON object that contains a JWT Claims Set.

string payload = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The payload to set.

Returns
Type Description
SignJwtRequest.Builder

This builder for chaining.

setPayloadBytes(ByteString value)

public SignJwtRequest.Builder setPayloadBytes(ByteString value)

Required. The JWT payload to sign: a JSON object that contains a JWT Claims Set.

string payload = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for payload to set.

Returns
Type Description
SignJwtRequest.Builder

This builder for chaining.

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

public SignJwtRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
SignJwtRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final SignJwtRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SignJwtRequest.Builder
Overrides