Class SecretPayload (2.53.0) 

public final class SecretPayload extends GeneratedMessageV3 implements SecretPayloadOrBuilder

A secret payload resource in the Secret Manager API. This contains the sensitive secret payload that is associated with a SecretVersion.

Protobuf type google.cloud.secretmanager.v1beta2.SecretPayload

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SecretPayload

Static Fields

DATA_CRC32C_FIELD_NUMBER

public static final int DATA_CRC32C_FIELD_NUMBER
Field Value
Type Description
int

DATA_FIELD_NUMBER

public static final int DATA_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SecretPayload getDefaultInstance()
Returns
Type Description
SecretPayload

getDescriptor()

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

newBuilder()

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

newBuilder(SecretPayload prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getData()

public ByteString getData()

The secret data. Must be no larger than 64KiB.

bytes data = 1;

Returns
Type Description
ByteString

The data.

getDataCrc32C()

public long getDataCrc32C()

Optional. If specified, SecretManagerService will verify the integrity of the received data on SecretManagerService.AddSecretVersion calls using the crc32c checksum and store it to include in future SecretManagerService.AccessSecretVersion responses. If a checksum is not provided in the SecretManagerService.AddSecretVersion request, the SecretManagerService will generate and store one for you.

The CRC32C value is encoded as a Int64 for compatibility, and can be safely downconverted to uint32 in languages that support this type. https://cloud.google.com/apis/design/design_patterns#integer_types

optional int64 data_crc32c = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The dataCrc32c.

getDefaultInstanceForType()

public SecretPayload getDefaultInstanceForType()
Returns
Type Description
SecretPayload

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasDataCrc32C()

public boolean hasDataCrc32C()

Optional. If specified, SecretManagerService will verify the integrity of the received data on SecretManagerService.AddSecretVersion calls using the crc32c checksum and store it to include in future SecretManagerService.AccessSecretVersion responses. If a checksum is not provided in the SecretManagerService.AddSecretVersion request, the SecretManagerService will generate and store one for you.

The CRC32C value is encoded as a Int64 for compatibility, and can be safely downconverted to uint32 in languages that support this type. https://cloud.google.com/apis/design/design_patterns#integer_types

optional int64 data_crc32c = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the dataCrc32c field is set.

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 SecretPayload.Builder newBuilderForType()
Returns
Type Description
SecretPayload.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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