Class SignJwtRequest (3.37.0)

public final class SignJwtRequest extends GeneratedMessageV3 implements SignJwtRequestOrBuilder

Deprecated. Migrate to Service Account Credentials API.

The service account sign JWT request.

Protobuf type google.iam.admin.v1.SignJwtRequest

Static Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PAYLOAD_FIELD_NUMBER

public static final int PAYLOAD_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SignJwtRequest getDefaultInstance()
Returns
Type Description
SignJwtRequest

getDescriptor()

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

newBuilder()

public static SignJwtRequest.Builder newBuilder()
Returns
Type Description
SignJwtRequest.Builder

newBuilder(SignJwtRequest prototype)

public static SignJwtRequest.Builder newBuilder(SignJwtRequest prototype)
Parameter
Name Description
prototype SignJwtRequest
Returns
Type Description
SignJwtRequest.Builder

parseDelimitedFrom(InputStream input)

public static SignJwtRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SignJwtRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SignJwtRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SignJwtRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SignJwtRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SignJwtRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SignJwtRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SignJwtRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SignJwtRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SignJwtRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SignJwtRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SignJwtRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SignJwtRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SignJwtRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SignJwtRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SignJwtRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SignJwtRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SignJwtRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SignJwtRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SignJwtRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SignJwtRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SignJwtRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SignJwtRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SignJwtRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SignJwtRequest> parser()
Returns
Type Description
Parser<SignJwtRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SignJwtRequest getDefaultInstanceForType()
Returns
Type Description
SignJwtRequest

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.

getParserForType()

public Parser<SignJwtRequest> getParserForType()
Returns
Type Description
Parser<SignJwtRequest>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SignJwtRequest.Builder newBuilderForType()
Returns
Type Description
SignJwtRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SignJwtRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SignJwtRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SignJwtRequest.Builder toBuilder()
Returns
Type Description
SignJwtRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException