1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/cloud/kms/v1/service.proto 18 19 package com.google.cloud.kms.v1; 20 21 public interface MacVerifyResponseOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.kms.v1.MacVerifyResponse) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * The resource name of the 31 * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used for 32 * verification. Check this field to verify that the intended resource was 33 * used for verification. 34 * </pre> 35 * 36 * <code>string name = 1;</code> 37 * 38 * @return The name. 39 */ getName()40 java.lang.String getName(); 41 /** 42 * 43 * 44 * <pre> 45 * The resource name of the 46 * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used for 47 * verification. Check this field to verify that the intended resource was 48 * used for verification. 49 * </pre> 50 * 51 * <code>string name = 1;</code> 52 * 53 * @return The bytes for name. 54 */ getNameBytes()55 com.google.protobuf.ByteString getNameBytes(); 56 57 /** 58 * 59 * 60 * <pre> 61 * This field indicates whether or not the verification operation for 62 * [MacVerifyRequest.mac][google.cloud.kms.v1.MacVerifyRequest.mac] over 63 * [MacVerifyRequest.data][google.cloud.kms.v1.MacVerifyRequest.data] was 64 * successful. 65 * </pre> 66 * 67 * <code>bool success = 2;</code> 68 * 69 * @return The success. 70 */ getSuccess()71 boolean getSuccess(); 72 73 /** 74 * 75 * 76 * <pre> 77 * Integrity verification field. A flag indicating whether 78 * [MacVerifyRequest.data_crc32c][google.cloud.kms.v1.MacVerifyRequest.data_crc32c] 79 * was received by 80 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] and used 81 * for the integrity verification of the 82 * [data][google.cloud.kms.v1.MacVerifyRequest.data]. A false value of this 83 * field indicates either that 84 * [MacVerifyRequest.data_crc32c][google.cloud.kms.v1.MacVerifyRequest.data_crc32c] 85 * was left unset or that it was not delivered to 86 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've 87 * set 88 * [MacVerifyRequest.data_crc32c][google.cloud.kms.v1.MacVerifyRequest.data_crc32c] 89 * but this field is still false, discard the response and perform a limited 90 * number of retries. 91 * </pre> 92 * 93 * <code>bool verified_data_crc32c = 3;</code> 94 * 95 * @return The verifiedDataCrc32c. 96 */ getVerifiedDataCrc32C()97 boolean getVerifiedDataCrc32C(); 98 99 /** 100 * 101 * 102 * <pre> 103 * Integrity verification field. A flag indicating whether 104 * [MacVerifyRequest.mac_crc32c][google.cloud.kms.v1.MacVerifyRequest.mac_crc32c] 105 * was received by 106 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] and used 107 * for the integrity verification of the 108 * [data][google.cloud.kms.v1.MacVerifyRequest.mac]. A false value of this 109 * field indicates either that 110 * [MacVerifyRequest.mac_crc32c][google.cloud.kms.v1.MacVerifyRequest.mac_crc32c] 111 * was left unset or that it was not delivered to 112 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've 113 * set 114 * [MacVerifyRequest.mac_crc32c][google.cloud.kms.v1.MacVerifyRequest.mac_crc32c] 115 * but this field is still false, discard the response and perform a limited 116 * number of retries. 117 * </pre> 118 * 119 * <code>bool verified_mac_crc32c = 4;</code> 120 * 121 * @return The verifiedMacCrc32c. 122 */ getVerifiedMacCrc32C()123 boolean getVerifiedMacCrc32C(); 124 125 /** 126 * 127 * 128 * <pre> 129 * Integrity verification field. This value is used for the integrity 130 * verification of [MacVerifyResponse.success]. If the value of this field 131 * contradicts the value of [MacVerifyResponse.success], discard the response 132 * and perform a limited number of retries. 133 * </pre> 134 * 135 * <code>bool verified_success_integrity = 5;</code> 136 * 137 * @return The verifiedSuccessIntegrity. 138 */ getVerifiedSuccessIntegrity()139 boolean getVerifiedSuccessIntegrity(); 140 141 /** 142 * 143 * 144 * <pre> 145 * The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the 146 * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used for 147 * verification. 148 * </pre> 149 * 150 * <code>.google.cloud.kms.v1.ProtectionLevel protection_level = 6;</code> 151 * 152 * @return The enum numeric value on the wire for protectionLevel. 153 */ getProtectionLevelValue()154 int getProtectionLevelValue(); 155 /** 156 * 157 * 158 * <pre> 159 * The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the 160 * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used for 161 * verification. 162 * </pre> 163 * 164 * <code>.google.cloud.kms.v1.ProtectionLevel protection_level = 6;</code> 165 * 166 * @return The protectionLevel. 167 */ getProtectionLevel()168 com.google.cloud.kms.v1.ProtectionLevel getProtectionLevel(); 169 } 170