Class SecretPayload.Builder

  • All Implemented Interfaces:
    SecretPayloadOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    SecretPayload

    public static final class SecretPayload.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<SecretPayload.Builder>
    implements SecretPayloadOrBuilder
     A secret payload resource in the Secret Manager API. This contains the
     sensitive secret payload that is associated with a
     [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
     
    Protobuf type google.cloud.secretmanager.v1.SecretPayload
    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<SecretPayload.Builder>
      • clear

        public SecretPayload.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<SecretPayload.Builder>
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<SecretPayload.Builder>
      • getDefaultInstanceForType

        public SecretPayload getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
      • build

        public SecretPayload build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder
      • buildPartial

        public SecretPayload buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder
      • clone

        public SecretPayload.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<SecretPayload.Builder>
      • setField

        public SecretPayload.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<SecretPayload.Builder>
      • clearField

        public SecretPayload.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<SecretPayload.Builder>
      • clearOneof

        public SecretPayload.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<SecretPayload.Builder>
      • setRepeatedField

        public SecretPayload.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      int index,
                                                      Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SecretPayload.Builder>
      • addRepeatedField

        public SecretPayload.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SecretPayload.Builder>
      • mergeFrom

        public SecretPayload.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SecretPayload.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<SecretPayload.Builder>
      • mergeFrom

        public SecretPayload.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SecretPayload.Builder>
        Throws:
        IOException
      • getData

        public com.google.protobuf.ByteString getData()
         The secret data. Must be no larger than 64KiB.
         
        bytes data = 1;
        Specified by:
        getData in interface SecretPayloadOrBuilder
        Returns:
        The data.
      • setData

        public SecretPayload.Builder setData​(com.google.protobuf.ByteString value)
         The secret data. Must be no larger than 64KiB.
         
        bytes data = 1;
        Parameters:
        value - The data to set.
        Returns:
        This builder for chaining.
      • clearData

        public SecretPayload.Builder clearData()
         The secret data. Must be no larger than 64KiB.
         
        bytes data = 1;
        Returns:
        This builder for chaining.
      • hasDataCrc32C

        public 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];
        Specified by:
        hasDataCrc32C in interface SecretPayloadOrBuilder
        Returns:
        Whether the dataCrc32c field is set.
      • getDataCrc32C

        public 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];
        Specified by:
        getDataCrc32C in interface SecretPayloadOrBuilder
        Returns:
        The dataCrc32c.
      • setDataCrc32C

        public SecretPayload.Builder setDataCrc32C​(long value)
         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];
        Parameters:
        value - The dataCrc32c to set.
        Returns:
        This builder for chaining.
      • clearDataCrc32C

        public SecretPayload.Builder clearDataCrc32C()
         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:
        This builder for chaining.
      • setUnknownFields

        public final SecretPayload.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SecretPayload.Builder>
      • mergeUnknownFields

        public final SecretPayload.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SecretPayload.Builder>