<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: google/cloud/kms/v1/service.proto

namespace Google\Cloud\Kms\V1;

use Google\Protobuf\Internal\GPBType;
use Google\Protobuf\Internal\RepeatedField;
use Google\Protobuf\Internal\GPBUtil;

/**
 * Response message for
 * [KeyManagementService.Decapsulate][google.cloud.kms.v1.KeyManagementService.Decapsulate].
 *
 * Generated from protobuf message <code>google.cloud.kms.v1.DecapsulateResponse</code>
 */
class DecapsulateResponse extends \Google\Protobuf\Internal\Message
{
    /**
     * The resource name of the
     * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used for
     * decapsulation. Check this field to verify that the intended resource was
     * used for decapsulation.
     *
     * Generated from protobuf field <code>string name = 1;</code>
     */
    protected $name = '';
    /**
     * The decapsulated shared_secret originally encapsulated with the matching
     * public key.
     *
     * Generated from protobuf field <code>bytes shared_secret = 2;</code>
     */
    protected $shared_secret = '';
    /**
     * Integrity verification field. A CRC32C checksum of the returned
     * [DecapsulateResponse.shared_secret][google.cloud.kms.v1.DecapsulateResponse.shared_secret].
     * An integrity check of
     * [DecapsulateResponse.shared_secret][google.cloud.kms.v1.DecapsulateResponse.shared_secret]
     * can be performed by computing the CRC32C checksum of
     * [DecapsulateResponse.shared_secret][google.cloud.kms.v1.DecapsulateResponse.shared_secret]
     * and comparing your results to this field. Discard the response in case of
     * non-matching checksum values, and perform a limited number of retries. A
     * persistent mismatch may indicate an issue in your computation of the CRC32C
     * checksum. Note: receiving this response message indicates that
     * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] is able to
     * successfully decrypt the
     * [ciphertext][google.cloud.kms.v1.DecapsulateRequest.ciphertext]. Note: This
     * field is defined as int64 for reasons of compatibility across different
     * languages. However, it is a non-negative integer, which will never exceed
     * 2^32-1, and can be safely downconverted to uint32 in languages that support
     * this type.
     *
     * Generated from protobuf field <code>optional int64 shared_secret_crc32c = 3;</code>
     */
    protected $shared_secret_crc32c = null;
    /**
     * Integrity verification field. A flag indicating whether
     * [DecapsulateRequest.ciphertext_crc32c][google.cloud.kms.v1.DecapsulateRequest.ciphertext_crc32c]
     * was received by
     * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] and used
     * for the integrity verification of the
     * [ciphertext][google.cloud.kms.v1.DecapsulateRequest.ciphertext]. A false
     * value of this field indicates either that
     * [DecapsulateRequest.ciphertext_crc32c][google.cloud.kms.v1.DecapsulateRequest.ciphertext_crc32c]
     * was left unset or that it was not delivered to
     * [KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've
     * set
     * [DecapsulateRequest.ciphertext_crc32c][google.cloud.kms.v1.DecapsulateRequest.ciphertext_crc32c]
     * but this field is still false, discard the response and perform a limited
     * number of retries.
     *
     * Generated from protobuf field <code>bool verified_ciphertext_crc32c = 4;</code>
     */
    protected $verified_ciphertext_crc32c = false;
    /**
     * The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the
     * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in
     * decapsulation.
     *
     * Generated from protobuf field <code>.google.cloud.kms.v1.ProtectionLevel protection_level = 5;</code>
     */
    protected $protection_level = 0;

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $name
     *           The resource name of the
     *           [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used for
     *           decapsulation. Check this field to verify that the intended resource was
     *           used for decapsulation.
     *     @type string $shared_secret
     *           The decapsulated shared_secret originally encapsulated with the matching
     *           public key.
     *     @type int|string $shared_secret_crc32c
     *           Integrity verification field. A CRC32C checksum of the returned
     *           [DecapsulateResponse.shared_secret][google.cloud.kms.v1.DecapsulateResponse.shared_secret].
     *           An integrity check of
     *           [DecapsulateResponse.shared_secret][google.cloud.kms.v1.DecapsulateResponse.shared_secret]
     *           can be performed by computing the CRC32C checksum of
     *           [DecapsulateResponse.shared_secret][google.cloud.kms.v1.DecapsulateResponse.shared_secret]
     *           and comparing your results to this field. Discard the response in case of
     *           non-matching checksum values, and perform a limited number of retries. A
     *           persistent mismatch may indicate an issue in your computation of the CRC32C
     *           checksum. Note: receiving this response message indicates that
     *           [KeyManagementService][google.cloud.kms.v1.KeyManagementService] is able to
     *           successfully decrypt the
     *           [ciphertext][google.cloud.kms.v1.DecapsulateRequest.ciphertext]. Note: This
     *           field is defined as int64 for reasons of compatibility across different
     *           languages. However, it is a non-negative integer, which will never exceed
     *           2^32-1, and can be safely downconverted to uint32 in languages that support
     *           this type.
     *     @type bool $verified_ciphertext_crc32c
     *           Integrity verification field. A flag indicating whether
     *           [DecapsulateRequest.ciphertext_crc32c][google.cloud.kms.v1.DecapsulateRequest.ciphertext_crc32c]
     *           was received by
     *           [KeyManagementService][google.cloud.kms.v1.KeyManagementService] and used
     *           for the integrity verification of the
     *           [ciphertext][google.cloud.kms.v1.DecapsulateRequest.ciphertext]. A false
     *           value of this field indicates either that
     *           [DecapsulateRequest.ciphertext_crc32c][google.cloud.kms.v1.DecapsulateRequest.ciphertext_crc32c]
     *           was left unset or that it was not delivered to
     *           [KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've
     *           set
     *           [DecapsulateRequest.ciphertext_crc32c][google.cloud.kms.v1.DecapsulateRequest.ciphertext_crc32c]
     *           but this field is still false, discard the response and perform a limited
     *           number of retries.
     *     @type int $protection_level
     *           The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the
     *           [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in
     *           decapsulation.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Cloud\Kms\V1\Service::initOnce();
        parent::__construct($data);
    }

    /**
     * The resource name of the
     * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used for
     * decapsulation. Check this field to verify that the intended resource was
     * used for decapsulation.
     *
     * Generated from protobuf field <code>string name = 1;</code>
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * The resource name of the
     * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used for
     * decapsulation. Check this field to verify that the intended resource was
     * used for decapsulation.
     *
     * Generated from protobuf field <code>string name = 1;</code>
     * @param string $var
     * @return $this
     */
    public function setName($var)
    {
        GPBUtil::checkString($var, True);
        $this->name = $var;

        return $this;
    }

    /**
     * The decapsulated shared_secret originally encapsulated with the matching
     * public key.
     *
     * Generated from protobuf field <code>bytes shared_secret = 2;</code>
     * @return string
     */
    public function getSharedSecret()
    {
        return $this->shared_secret;
    }

    /**
     * The decapsulated shared_secret originally encapsulated with the matching
     * public key.
     *
     * Generated from protobuf field <code>bytes shared_secret = 2;</code>
     * @param string $var
     * @return $this
     */
    public function setSharedSecret($var)
    {
        GPBUtil::checkString($var, False);
        $this->shared_secret = $var;

        return $this;
    }

    /**
     * Integrity verification field. A CRC32C checksum of the returned
     * [DecapsulateResponse.shared_secret][google.cloud.kms.v1.DecapsulateResponse.shared_secret].
     * An integrity check of
     * [DecapsulateResponse.shared_secret][google.cloud.kms.v1.DecapsulateResponse.shared_secret]
     * can be performed by computing the CRC32C checksum of
     * [DecapsulateResponse.shared_secret][google.cloud.kms.v1.DecapsulateResponse.shared_secret]
     * and comparing your results to this field. Discard the response in case of
     * non-matching checksum values, and perform a limited number of retries. A
     * persistent mismatch may indicate an issue in your computation of the CRC32C
     * checksum. Note: receiving this response message indicates that
     * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] is able to
     * successfully decrypt the
     * [ciphertext][google.cloud.kms.v1.DecapsulateRequest.ciphertext]. Note: This
     * field is defined as int64 for reasons of compatibility across different
     * languages. However, it is a non-negative integer, which will never exceed
     * 2^32-1, and can be safely downconverted to uint32 in languages that support
     * this type.
     *
     * Generated from protobuf field <code>optional int64 shared_secret_crc32c = 3;</code>
     * @return int|string
     */
    public function getSharedSecretCrc32C()
    {
        return isset($this->shared_secret_crc32c) ? $this->shared_secret_crc32c : 0;
    }

    public function hasSharedSecretCrc32C()
    {
        return isset($this->shared_secret_crc32c);
    }

    public function clearSharedSecretCrc32C()
    {
        unset($this->shared_secret_crc32c);
    }

    /**
     * Integrity verification field. A CRC32C checksum of the returned
     * [DecapsulateResponse.shared_secret][google.cloud.kms.v1.DecapsulateResponse.shared_secret].
     * An integrity check of
     * [DecapsulateResponse.shared_secret][google.cloud.kms.v1.DecapsulateResponse.shared_secret]
     * can be performed by computing the CRC32C checksum of
     * [DecapsulateResponse.shared_secret][google.cloud.kms.v1.DecapsulateResponse.shared_secret]
     * and comparing your results to this field. Discard the response in case of
     * non-matching checksum values, and perform a limited number of retries. A
     * persistent mismatch may indicate an issue in your computation of the CRC32C
     * checksum. Note: receiving this response message indicates that
     * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] is able to
     * successfully decrypt the
     * [ciphertext][google.cloud.kms.v1.DecapsulateRequest.ciphertext]. Note: This
     * field is defined as int64 for reasons of compatibility across different
     * languages. However, it is a non-negative integer, which will never exceed
     * 2^32-1, and can be safely downconverted to uint32 in languages that support
     * this type.
     *
     * Generated from protobuf field <code>optional int64 shared_secret_crc32c = 3;</code>
     * @param int|string $var
     * @return $this
     */
    public function setSharedSecretCrc32C($var)
    {
        GPBUtil::checkInt64($var);
        $this->shared_secret_crc32c = $var;

        return $this;
    }

    /**
     * Integrity verification field. A flag indicating whether
     * [DecapsulateRequest.ciphertext_crc32c][google.cloud.kms.v1.DecapsulateRequest.ciphertext_crc32c]
     * was received by
     * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] and used
     * for the integrity verification of the
     * [ciphertext][google.cloud.kms.v1.DecapsulateRequest.ciphertext]. A false
     * value of this field indicates either that
     * [DecapsulateRequest.ciphertext_crc32c][google.cloud.kms.v1.DecapsulateRequest.ciphertext_crc32c]
     * was left unset or that it was not delivered to
     * [KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've
     * set
     * [DecapsulateRequest.ciphertext_crc32c][google.cloud.kms.v1.DecapsulateRequest.ciphertext_crc32c]
     * but this field is still false, discard the response and perform a limited
     * number of retries.
     *
     * Generated from protobuf field <code>bool verified_ciphertext_crc32c = 4;</code>
     * @return bool
     */
    public function getVerifiedCiphertextCrc32C()
    {
        return $this->verified_ciphertext_crc32c;
    }

    /**
     * Integrity verification field. A flag indicating whether
     * [DecapsulateRequest.ciphertext_crc32c][google.cloud.kms.v1.DecapsulateRequest.ciphertext_crc32c]
     * was received by
     * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] and used
     * for the integrity verification of the
     * [ciphertext][google.cloud.kms.v1.DecapsulateRequest.ciphertext]. A false
     * value of this field indicates either that
     * [DecapsulateRequest.ciphertext_crc32c][google.cloud.kms.v1.DecapsulateRequest.ciphertext_crc32c]
     * was left unset or that it was not delivered to
     * [KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've
     * set
     * [DecapsulateRequest.ciphertext_crc32c][google.cloud.kms.v1.DecapsulateRequest.ciphertext_crc32c]
     * but this field is still false, discard the response and perform a limited
     * number of retries.
     *
     * Generated from protobuf field <code>bool verified_ciphertext_crc32c = 4;</code>
     * @param bool $var
     * @return $this
     */
    public function setVerifiedCiphertextCrc32C($var)
    {
        GPBUtil::checkBool($var);
        $this->verified_ciphertext_crc32c = $var;

        return $this;
    }

    /**
     * The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the
     * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in
     * decapsulation.
     *
     * Generated from protobuf field <code>.google.cloud.kms.v1.ProtectionLevel protection_level = 5;</code>
     * @return int
     */
    public function getProtectionLevel()
    {
        return $this->protection_level;
    }

    /**
     * The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the
     * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in
     * decapsulation.
     *
     * Generated from protobuf field <code>.google.cloud.kms.v1.ProtectionLevel protection_level = 5;</code>
     * @param int $var
     * @return $this
     */
    public function setProtectionLevel($var)
    {
        GPBUtil::checkEnum($var, \Google\Cloud\Kms\V1\ProtectionLevel::class);
        $this->protection_level = $var;

        return $this;
    }

}

