<?php
/*
 * Copyright 2014 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

namespace Google\Service\CloudKMS;

class MacSignResponse extends \Google\Model
{
  /**
   * Not specified.
   */
  public const PROTECTION_LEVEL_PROTECTION_LEVEL_UNSPECIFIED = 'PROTECTION_LEVEL_UNSPECIFIED';
  /**
   * Crypto operations are performed in software.
   */
  public const PROTECTION_LEVEL_SOFTWARE = 'SOFTWARE';
  /**
   * Crypto operations are performed in a Hardware Security Module.
   */
  public const PROTECTION_LEVEL_HSM = 'HSM';
  /**
   * Crypto operations are performed by an external key manager.
   */
  public const PROTECTION_LEVEL_EXTERNAL = 'EXTERNAL';
  /**
   * Crypto operations are performed in an EKM-over-VPC backend.
   */
  public const PROTECTION_LEVEL_EXTERNAL_VPC = 'EXTERNAL_VPC';
  /**
   * The created signature.
   *
   * @var string
   */
  public $mac;
  /**
   * Integrity verification field. A CRC32C checksum of the returned
   * MacSignResponse.mac. An integrity check of MacSignResponse.mac can be
   * performed by computing the CRC32C checksum of MacSignResponse.mac 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: 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.
   *
   * @var string
   */
  public $macCrc32c;
  /**
   * The resource name of the CryptoKeyVersion used for signing. Check this
   * field to verify that the intended resource was used for signing.
   *
   * @var string
   */
  public $name;
  /**
   * The ProtectionLevel of the CryptoKeyVersion used for signing.
   *
   * @var string
   */
  public $protectionLevel;
  /**
   * Integrity verification field. A flag indicating whether
   * MacSignRequest.data_crc32c was received by KeyManagementService and used
   * for the integrity verification of the data. A false value of this field
   * indicates either that MacSignRequest.data_crc32c was left unset or that it
   * was not delivered to KeyManagementService. If you've set
   * MacSignRequest.data_crc32c but this field is still false, discard the
   * response and perform a limited number of retries.
   *
   * @var bool
   */
  public $verifiedDataCrc32c;

  /**
   * The created signature.
   *
   * @param string $mac
   */
  public function setMac($mac)
  {
    $this->mac = $mac;
  }
  /**
   * @return string
   */
  public function getMac()
  {
    return $this->mac;
  }
  /**
   * Integrity verification field. A CRC32C checksum of the returned
   * MacSignResponse.mac. An integrity check of MacSignResponse.mac can be
   * performed by computing the CRC32C checksum of MacSignResponse.mac 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: 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.
   *
   * @param string $macCrc32c
   */
  public function setMacCrc32c($macCrc32c)
  {
    $this->macCrc32c = $macCrc32c;
  }
  /**
   * @return string
   */
  public function getMacCrc32c()
  {
    return $this->macCrc32c;
  }
  /**
   * The resource name of the CryptoKeyVersion used for signing. Check this
   * field to verify that the intended resource was used for signing.
   *
   * @param string $name
   */
  public function setName($name)
  {
    $this->name = $name;
  }
  /**
   * @return string
   */
  public function getName()
  {
    return $this->name;
  }
  /**
   * The ProtectionLevel of the CryptoKeyVersion used for signing.
   *
   * Accepted values: PROTECTION_LEVEL_UNSPECIFIED, SOFTWARE, HSM, EXTERNAL,
   * EXTERNAL_VPC
   *
   * @param self::PROTECTION_LEVEL_* $protectionLevel
   */
  public function setProtectionLevel($protectionLevel)
  {
    $this->protectionLevel = $protectionLevel;
  }
  /**
   * @return self::PROTECTION_LEVEL_*
   */
  public function getProtectionLevel()
  {
    return $this->protectionLevel;
  }
  /**
   * Integrity verification field. A flag indicating whether
   * MacSignRequest.data_crc32c was received by KeyManagementService and used
   * for the integrity verification of the data. A false value of this field
   * indicates either that MacSignRequest.data_crc32c was left unset or that it
   * was not delivered to KeyManagementService. If you've set
   * MacSignRequest.data_crc32c but this field is still false, discard the
   * response and perform a limited number of retries.
   *
   * @param bool $verifiedDataCrc32c
   */
  public function setVerifiedDataCrc32c($verifiedDataCrc32c)
  {
    $this->verifiedDataCrc32c = $verifiedDataCrc32c;
  }
  /**
   * @return bool
   */
  public function getVerifiedDataCrc32c()
  {
    return $this->verifiedDataCrc32c;
  }
}

// Adding a class alias for backwards compatibility with the previous class name.
class_alias(MacSignResponse::class, 'Google_Service_CloudKMS_MacSignResponse');
