Package com.google.cloud.secretmanager.v1

Interface SecretPayloadOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    SecretPayload, SecretPayload.Builder
    public interface SecretPayloadOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.google.protobuf.ByteString getData()
      The secret data.
      long getDataCrc32C()
      Optional.
      boolean hasDataCrc32C()
      Optional.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getData

        com.google.protobuf.ByteString getData()
         The secret data. Must be no larger than 64KiB.
        bytes data = 1;
        Returns:
        The data.

      • hasDataCrc32C

        boolean hasDataCrc32C()
         Optional. If specified,
 [SecretManagerService][google.cloud.secretmanager.v1.SecretManagerService]
 will verify the integrity of the received
 [data][google.cloud.secretmanager.v1.SecretPayload.data] on
 [SecretManagerService.AddSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AddSecretVersion]
 calls using the crc32c checksum and store it to include in future
 [SecretManagerService.AccessSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AccessSecretVersion]
 responses. If a checksum is not provided in the
 [SecretManagerService.AddSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AddSecretVersion]
 request, the
 [SecretManagerService][google.cloud.secretmanager.v1.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:
        Whether the dataCrc32c field is set.

      • getDataCrc32C

        long getDataCrc32C()
         Optional. If specified,
 [SecretManagerService][google.cloud.secretmanager.v1.SecretManagerService]
 will verify the integrity of the received
 [data][google.cloud.secretmanager.v1.SecretPayload.data] on
 [SecretManagerService.AddSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AddSecretVersion]
 calls using the crc32c checksum and store it to include in future
 [SecretManagerService.AccessSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AccessSecretVersion]
 responses. If a checksum is not provided in the
 [SecretManagerService.AddSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AddSecretVersion]
 request, the
 [SecretManagerService][google.cloud.secretmanager.v1.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:
        The dataCrc32c.