Class SignJwtRequest.Builder (3.39.0)

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

Deprecated. Migrate to Service Account Credentials API.

The service account sign JWT request.

Protobuf type google.iam.admin.v1.SignJwtRequest

Static Methods

getDescriptor()

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

Methods

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

clearField(Descriptors.FieldDescriptor field)

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

clearName() (deprecated)

public SignJwtRequest.Builder clearName()

Deprecated. google.iam.admin.v1.SignJwtRequest.name is deprecated. See google/iam/admin/v1/iam.proto;l=1023

Required. Deprecated. Migrate to Service Account Credentials API.

The resource name of the service account in the following format: projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. Using - as a wildcard for the PROJECT_ID will infer the project from the account. The ACCOUNT value can be the email address or the unique_id of the service account.

string name = 1 [deprecated = true, (.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() (deprecated)

public SignJwtRequest.Builder clearPayload()

Deprecated. google.iam.admin.v1.SignJwtRequest.payload is deprecated. See google/iam/admin/v1/iam.proto;l=1044

Required. Deprecated. Migrate to Service Account Credentials API.

The JWT payload to sign. Must be a serialized JSON object that contains a JWT Claims Set. For example: {"sub": "user@example.com", "iat": 313435}

If the JWT Claims Set contains an expiration time (exp) claim, it must be an integer timestamp that is not in the past and no more than 12 hours in the future.

If the JWT Claims Set does not contain an expiration time (exp) claim, this claim is added automatically, with a timestamp that is 1 hour in the future.

string payload = 2 [deprecated = true, (.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

getDescriptorForType()

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

getName() (deprecated)

public String getName()

Deprecated. google.iam.admin.v1.SignJwtRequest.name is deprecated. See google/iam/admin/v1/iam.proto;l=1023

Required. Deprecated. Migrate to Service Account Credentials API.

The resource name of the service account in the following format: projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. Using - as a wildcard for the PROJECT_ID will infer the project from the account. The ACCOUNT value can be the email address or the unique_id of the service account.

string name = 1 [deprecated = true, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes() (deprecated)

public ByteString getNameBytes()

Deprecated. google.iam.admin.v1.SignJwtRequest.name is deprecated. See google/iam/admin/v1/iam.proto;l=1023

Required. Deprecated. Migrate to Service Account Credentials API.

The resource name of the service account in the following format: projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. Using - as a wildcard for the PROJECT_ID will infer the project from the account. The ACCOUNT value can be the email address or the unique_id of the service account.

string name = 1 [deprecated = true, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getPayload() (deprecated)

public String getPayload()

Deprecated. google.iam.admin.v1.SignJwtRequest.payload is deprecated. See google/iam/admin/v1/iam.proto;l=1044

Required. Deprecated. Migrate to Service Account Credentials API.

The JWT payload to sign. Must be a serialized JSON object that contains a JWT Claims Set. For example: {"sub": "user@example.com", "iat": 313435}

If the JWT Claims Set contains an expiration time (exp) claim, it must be an integer timestamp that is not in the past and no more than 12 hours in the future.

If the JWT Claims Set does not contain an expiration time (exp) claim, this claim is added automatically, with a timestamp that is 1 hour in the future.

string payload = 2 [deprecated = true, (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The payload.

getPayloadBytes() (deprecated)

public ByteString getPayloadBytes()

Deprecated. google.iam.admin.v1.SignJwtRequest.payload is deprecated. See google/iam/admin/v1/iam.proto;l=1044

Required. Deprecated. Migrate to Service Account Credentials API.

The JWT payload to sign. Must be a serialized JSON object that contains a JWT Claims Set. For example: {"sub": "user@example.com", "iat": 313435}

If the JWT Claims Set contains an expiration time (exp) claim, it must be an integer timestamp that is not in the past and no more than 12 hours in the future.

If the JWT Claims Set does not contain an expiration time (exp) claim, this claim is added automatically, with a timestamp that is 1 hour in the future.

string payload = 2 [deprecated = true, (.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

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) (deprecated)

public SignJwtRequest.Builder setName(String value)

Deprecated. google.iam.admin.v1.SignJwtRequest.name is deprecated. See google/iam/admin/v1/iam.proto;l=1023

Required. Deprecated. Migrate to Service Account Credentials API.

The resource name of the service account in the following format: projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. Using - as a wildcard for the PROJECT_ID will infer the project from the account. The ACCOUNT value can be the email address or the unique_id of the service account.

string name = 1 [deprecated = true, (.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) (deprecated)

public SignJwtRequest.Builder setNameBytes(ByteString value)

Deprecated. google.iam.admin.v1.SignJwtRequest.name is deprecated. See google/iam/admin/v1/iam.proto;l=1023

Required. Deprecated. Migrate to Service Account Credentials API.

The resource name of the service account in the following format: projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. Using - as a wildcard for the PROJECT_ID will infer the project from the account. The ACCOUNT value can be the email address or the unique_id of the service account.

string name = 1 [deprecated = true, (.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) (deprecated)

public SignJwtRequest.Builder setPayload(String value)

Deprecated. google.iam.admin.v1.SignJwtRequest.payload is deprecated. See google/iam/admin/v1/iam.proto;l=1044

Required. Deprecated. Migrate to Service Account Credentials API.

The JWT payload to sign. Must be a serialized JSON object that contains a JWT Claims Set. For example: {"sub": "user@example.com", "iat": 313435}

If the JWT Claims Set contains an expiration time (exp) claim, it must be an integer timestamp that is not in the past and no more than 12 hours in the future.

If the JWT Claims Set does not contain an expiration time (exp) claim, this claim is added automatically, with a timestamp that is 1 hour in the future.

string payload = 2 [deprecated = true, (.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) (deprecated)

public SignJwtRequest.Builder setPayloadBytes(ByteString value)

Deprecated. google.iam.admin.v1.SignJwtRequest.payload is deprecated. See google/iam/admin/v1/iam.proto;l=1044

Required. Deprecated. Migrate to Service Account Credentials API.

The JWT payload to sign. Must be a serialized JSON object that contains a JWT Claims Set. For example: {"sub": "user@example.com", "iat": 313435}

If the JWT Claims Set contains an expiration time (exp) claim, it must be an integer timestamp that is not in the past and no more than 12 hours in the future.

If the JWT Claims Set does not contain an expiration time (exp) claim, this claim is added automatically, with a timestamp that is 1 hour in the future.

string payload = 2 [deprecated = true, (.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