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 MacVerifyRequestOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.kms.v1.MacVerifyRequest) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Required. The resource name of the 31 * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to use for 32 * verification. 33 * </pre> 34 * 35 * <code> 36 * string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... } 37 * </code> 38 * 39 * @return The name. 40 */ getName()41 java.lang.String getName(); 42 /** 43 * 44 * 45 * <pre> 46 * Required. The resource name of the 47 * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to use for 48 * verification. 49 * </pre> 50 * 51 * <code> 52 * string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... } 53 * </code> 54 * 55 * @return The bytes for name. 56 */ getNameBytes()57 com.google.protobuf.ByteString getNameBytes(); 58 59 /** 60 * 61 * 62 * <pre> 63 * Required. The data used previously as a 64 * [MacSignRequest.data][google.cloud.kms.v1.MacSignRequest.data] to generate 65 * the MAC tag. 66 * </pre> 67 * 68 * <code>bytes data = 2 [(.google.api.field_behavior) = REQUIRED];</code> 69 * 70 * @return The data. 71 */ getData()72 com.google.protobuf.ByteString getData(); 73 74 /** 75 * 76 * 77 * <pre> 78 * Optional. An optional CRC32C checksum of the 79 * [MacVerifyRequest.data][google.cloud.kms.v1.MacVerifyRequest.data]. If 80 * specified, [KeyManagementService][google.cloud.kms.v1.KeyManagementService] 81 * will verify the integrity of the received 82 * [MacVerifyRequest.data][google.cloud.kms.v1.MacVerifyRequest.data] using 83 * this checksum. 84 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will 85 * report an error if the checksum verification fails. If you receive a 86 * checksum error, your client should verify that 87 * CRC32C([MacVerifyRequest.data][google.cloud.kms.v1.MacVerifyRequest.data]) 88 * is equal to 89 * [MacVerifyRequest.data_crc32c][google.cloud.kms.v1.MacVerifyRequest.data_crc32c], 90 * and if so, perform a limited number of retries. A persistent mismatch may 91 * indicate an issue in your computation of the CRC32C checksum. Note: This 92 * field is defined as int64 for reasons of compatibility across different 93 * languages. However, it is a non-negative integer, which will never exceed 94 * 2^32-1, and can be safely downconverted to uint32 in languages that support 95 * this type. 96 * </pre> 97 * 98 * <code>.google.protobuf.Int64Value data_crc32c = 3 [(.google.api.field_behavior) = OPTIONAL]; 99 * </code> 100 * 101 * @return Whether the dataCrc32c field is set. 102 */ hasDataCrc32C()103 boolean hasDataCrc32C(); 104 /** 105 * 106 * 107 * <pre> 108 * Optional. An optional CRC32C checksum of the 109 * [MacVerifyRequest.data][google.cloud.kms.v1.MacVerifyRequest.data]. If 110 * specified, [KeyManagementService][google.cloud.kms.v1.KeyManagementService] 111 * will verify the integrity of the received 112 * [MacVerifyRequest.data][google.cloud.kms.v1.MacVerifyRequest.data] using 113 * this checksum. 114 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will 115 * report an error if the checksum verification fails. If you receive a 116 * checksum error, your client should verify that 117 * CRC32C([MacVerifyRequest.data][google.cloud.kms.v1.MacVerifyRequest.data]) 118 * is equal to 119 * [MacVerifyRequest.data_crc32c][google.cloud.kms.v1.MacVerifyRequest.data_crc32c], 120 * and if so, perform a limited number of retries. A persistent mismatch may 121 * indicate an issue in your computation of the CRC32C checksum. Note: This 122 * field is defined as int64 for reasons of compatibility across different 123 * languages. However, it is a non-negative integer, which will never exceed 124 * 2^32-1, and can be safely downconverted to uint32 in languages that support 125 * this type. 126 * </pre> 127 * 128 * <code>.google.protobuf.Int64Value data_crc32c = 3 [(.google.api.field_behavior) = OPTIONAL]; 129 * </code> 130 * 131 * @return The dataCrc32c. 132 */ getDataCrc32C()133 com.google.protobuf.Int64Value getDataCrc32C(); 134 /** 135 * 136 * 137 * <pre> 138 * Optional. An optional CRC32C checksum of the 139 * [MacVerifyRequest.data][google.cloud.kms.v1.MacVerifyRequest.data]. If 140 * specified, [KeyManagementService][google.cloud.kms.v1.KeyManagementService] 141 * will verify the integrity of the received 142 * [MacVerifyRequest.data][google.cloud.kms.v1.MacVerifyRequest.data] using 143 * this checksum. 144 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will 145 * report an error if the checksum verification fails. If you receive a 146 * checksum error, your client should verify that 147 * CRC32C([MacVerifyRequest.data][google.cloud.kms.v1.MacVerifyRequest.data]) 148 * is equal to 149 * [MacVerifyRequest.data_crc32c][google.cloud.kms.v1.MacVerifyRequest.data_crc32c], 150 * and if so, perform a limited number of retries. A persistent mismatch may 151 * indicate an issue in your computation of the CRC32C checksum. Note: This 152 * field is defined as int64 for reasons of compatibility across different 153 * languages. However, it is a non-negative integer, which will never exceed 154 * 2^32-1, and can be safely downconverted to uint32 in languages that support 155 * this type. 156 * </pre> 157 * 158 * <code>.google.protobuf.Int64Value data_crc32c = 3 [(.google.api.field_behavior) = OPTIONAL]; 159 * </code> 160 */ getDataCrc32COrBuilder()161 com.google.protobuf.Int64ValueOrBuilder getDataCrc32COrBuilder(); 162 163 /** 164 * 165 * 166 * <pre> 167 * Required. The signature to verify. 168 * </pre> 169 * 170 * <code>bytes mac = 4 [(.google.api.field_behavior) = REQUIRED];</code> 171 * 172 * @return The mac. 173 */ getMac()174 com.google.protobuf.ByteString getMac(); 175 176 /** 177 * 178 * 179 * <pre> 180 * Optional. An optional CRC32C checksum of the 181 * [MacVerifyRequest.mac][google.cloud.kms.v1.MacVerifyRequest.mac]. If 182 * specified, [KeyManagementService][google.cloud.kms.v1.KeyManagementService] 183 * will verify the integrity of the received 184 * [MacVerifyRequest.mac][google.cloud.kms.v1.MacVerifyRequest.mac] using this 185 * checksum. [KeyManagementService][google.cloud.kms.v1.KeyManagementService] 186 * will report an error if the checksum verification fails. If you receive a 187 * checksum error, your client should verify that 188 * CRC32C([MacVerifyRequest.tag][]) is equal to 189 * [MacVerifyRequest.mac_crc32c][google.cloud.kms.v1.MacVerifyRequest.mac_crc32c], 190 * and if so, perform a limited number of retries. A persistent mismatch may 191 * indicate an issue in your computation of the CRC32C checksum. Note: This 192 * field is defined as int64 for reasons of compatibility across different 193 * languages. However, it is a non-negative integer, which will never exceed 194 * 2^32-1, and can be safely downconverted to uint32 in languages that support 195 * this type. 196 * </pre> 197 * 198 * <code>.google.protobuf.Int64Value mac_crc32c = 5 [(.google.api.field_behavior) = OPTIONAL]; 199 * </code> 200 * 201 * @return Whether the macCrc32c field is set. 202 */ hasMacCrc32C()203 boolean hasMacCrc32C(); 204 /** 205 * 206 * 207 * <pre> 208 * Optional. An optional CRC32C checksum of the 209 * [MacVerifyRequest.mac][google.cloud.kms.v1.MacVerifyRequest.mac]. If 210 * specified, [KeyManagementService][google.cloud.kms.v1.KeyManagementService] 211 * will verify the integrity of the received 212 * [MacVerifyRequest.mac][google.cloud.kms.v1.MacVerifyRequest.mac] using this 213 * checksum. [KeyManagementService][google.cloud.kms.v1.KeyManagementService] 214 * will report an error if the checksum verification fails. If you receive a 215 * checksum error, your client should verify that 216 * CRC32C([MacVerifyRequest.tag][]) is equal to 217 * [MacVerifyRequest.mac_crc32c][google.cloud.kms.v1.MacVerifyRequest.mac_crc32c], 218 * and if so, perform a limited number of retries. A persistent mismatch may 219 * indicate an issue in your computation of the CRC32C checksum. Note: This 220 * field is defined as int64 for reasons of compatibility across different 221 * languages. However, it is a non-negative integer, which will never exceed 222 * 2^32-1, and can be safely downconverted to uint32 in languages that support 223 * this type. 224 * </pre> 225 * 226 * <code>.google.protobuf.Int64Value mac_crc32c = 5 [(.google.api.field_behavior) = OPTIONAL]; 227 * </code> 228 * 229 * @return The macCrc32c. 230 */ getMacCrc32C()231 com.google.protobuf.Int64Value getMacCrc32C(); 232 /** 233 * 234 * 235 * <pre> 236 * Optional. An optional CRC32C checksum of the 237 * [MacVerifyRequest.mac][google.cloud.kms.v1.MacVerifyRequest.mac]. If 238 * specified, [KeyManagementService][google.cloud.kms.v1.KeyManagementService] 239 * will verify the integrity of the received 240 * [MacVerifyRequest.mac][google.cloud.kms.v1.MacVerifyRequest.mac] using this 241 * checksum. [KeyManagementService][google.cloud.kms.v1.KeyManagementService] 242 * will report an error if the checksum verification fails. If you receive a 243 * checksum error, your client should verify that 244 * CRC32C([MacVerifyRequest.tag][]) is equal to 245 * [MacVerifyRequest.mac_crc32c][google.cloud.kms.v1.MacVerifyRequest.mac_crc32c], 246 * and if so, perform a limited number of retries. A persistent mismatch may 247 * indicate an issue in your computation of the CRC32C checksum. Note: This 248 * field is defined as int64 for reasons of compatibility across different 249 * languages. However, it is a non-negative integer, which will never exceed 250 * 2^32-1, and can be safely downconverted to uint32 in languages that support 251 * this type. 252 * </pre> 253 * 254 * <code>.google.protobuf.Int64Value mac_crc32c = 5 [(.google.api.field_behavior) = OPTIONAL]; 255 * </code> 256 */ getMacCrc32COrBuilder()257 com.google.protobuf.Int64ValueOrBuilder getMacCrc32COrBuilder(); 258 } 259