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 DecryptRequestOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.kms.v1.DecryptRequest) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Required. The resource name of the 31 * [CryptoKey][google.cloud.kms.v1.CryptoKey] to use for decryption. The 32 * server will choose the appropriate version. 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 * [CryptoKey][google.cloud.kms.v1.CryptoKey] to use for decryption. The 48 * server will choose the appropriate version. 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 encrypted data originally returned in 64 * [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.ciphertext]. 65 * </pre> 66 * 67 * <code>bytes ciphertext = 2 [(.google.api.field_behavior) = REQUIRED];</code> 68 * 69 * @return The ciphertext. 70 */ getCiphertext()71 com.google.protobuf.ByteString getCiphertext(); 72 73 /** 74 * 75 * 76 * <pre> 77 * Optional. Optional data that must match the data originally supplied in 78 * [EncryptRequest.additional_authenticated_data][google.cloud.kms.v1.EncryptRequest.additional_authenticated_data]. 79 * </pre> 80 * 81 * <code>bytes additional_authenticated_data = 3 [(.google.api.field_behavior) = OPTIONAL];</code> 82 * 83 * @return The additionalAuthenticatedData. 84 */ getAdditionalAuthenticatedData()85 com.google.protobuf.ByteString getAdditionalAuthenticatedData(); 86 87 /** 88 * 89 * 90 * <pre> 91 * Optional. An optional CRC32C checksum of the 92 * [DecryptRequest.ciphertext][google.cloud.kms.v1.DecryptRequest.ciphertext]. 93 * If specified, 94 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will 95 * verify the integrity of the received 96 * [DecryptRequest.ciphertext][google.cloud.kms.v1.DecryptRequest.ciphertext] 97 * using this checksum. 98 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will 99 * report an error if the checksum verification fails. If you receive a 100 * checksum error, your client should verify that 101 * CRC32C([DecryptRequest.ciphertext][google.cloud.kms.v1.DecryptRequest.ciphertext]) 102 * is equal to 103 * [DecryptRequest.ciphertext_crc32c][google.cloud.kms.v1.DecryptRequest.ciphertext_crc32c], 104 * and if so, perform a limited number of retries. A persistent mismatch may 105 * indicate an issue in your computation of the CRC32C checksum. Note: This 106 * field is defined as int64 for reasons of compatibility across different 107 * languages. However, it is a non-negative integer, which will never exceed 108 * 2^32-1, and can be safely downconverted to uint32 in languages that support 109 * this type. 110 * </pre> 111 * 112 * <code> 113 * .google.protobuf.Int64Value ciphertext_crc32c = 5 [(.google.api.field_behavior) = OPTIONAL]; 114 * </code> 115 * 116 * @return Whether the ciphertextCrc32c field is set. 117 */ hasCiphertextCrc32C()118 boolean hasCiphertextCrc32C(); 119 /** 120 * 121 * 122 * <pre> 123 * Optional. An optional CRC32C checksum of the 124 * [DecryptRequest.ciphertext][google.cloud.kms.v1.DecryptRequest.ciphertext]. 125 * If specified, 126 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will 127 * verify the integrity of the received 128 * [DecryptRequest.ciphertext][google.cloud.kms.v1.DecryptRequest.ciphertext] 129 * using this checksum. 130 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will 131 * report an error if the checksum verification fails. If you receive a 132 * checksum error, your client should verify that 133 * CRC32C([DecryptRequest.ciphertext][google.cloud.kms.v1.DecryptRequest.ciphertext]) 134 * is equal to 135 * [DecryptRequest.ciphertext_crc32c][google.cloud.kms.v1.DecryptRequest.ciphertext_crc32c], 136 * and if so, perform a limited number of retries. A persistent mismatch may 137 * indicate an issue in your computation of the CRC32C checksum. Note: This 138 * field is defined as int64 for reasons of compatibility across different 139 * languages. However, it is a non-negative integer, which will never exceed 140 * 2^32-1, and can be safely downconverted to uint32 in languages that support 141 * this type. 142 * </pre> 143 * 144 * <code> 145 * .google.protobuf.Int64Value ciphertext_crc32c = 5 [(.google.api.field_behavior) = OPTIONAL]; 146 * </code> 147 * 148 * @return The ciphertextCrc32c. 149 */ getCiphertextCrc32C()150 com.google.protobuf.Int64Value getCiphertextCrc32C(); 151 /** 152 * 153 * 154 * <pre> 155 * Optional. An optional CRC32C checksum of the 156 * [DecryptRequest.ciphertext][google.cloud.kms.v1.DecryptRequest.ciphertext]. 157 * If specified, 158 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will 159 * verify the integrity of the received 160 * [DecryptRequest.ciphertext][google.cloud.kms.v1.DecryptRequest.ciphertext] 161 * using this checksum. 162 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will 163 * report an error if the checksum verification fails. If you receive a 164 * checksum error, your client should verify that 165 * CRC32C([DecryptRequest.ciphertext][google.cloud.kms.v1.DecryptRequest.ciphertext]) 166 * is equal to 167 * [DecryptRequest.ciphertext_crc32c][google.cloud.kms.v1.DecryptRequest.ciphertext_crc32c], 168 * and if so, perform a limited number of retries. A persistent mismatch may 169 * indicate an issue in your computation of the CRC32C checksum. Note: This 170 * field is defined as int64 for reasons of compatibility across different 171 * languages. However, it is a non-negative integer, which will never exceed 172 * 2^32-1, and can be safely downconverted to uint32 in languages that support 173 * this type. 174 * </pre> 175 * 176 * <code> 177 * .google.protobuf.Int64Value ciphertext_crc32c = 5 [(.google.api.field_behavior) = OPTIONAL]; 178 * </code> 179 */ getCiphertextCrc32COrBuilder()180 com.google.protobuf.Int64ValueOrBuilder getCiphertextCrc32COrBuilder(); 181 182 /** 183 * 184 * 185 * <pre> 186 * Optional. An optional CRC32C checksum of the 187 * [DecryptRequest.additional_authenticated_data][google.cloud.kms.v1.DecryptRequest.additional_authenticated_data]. 188 * If specified, 189 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will 190 * verify the integrity of the received 191 * [DecryptRequest.additional_authenticated_data][google.cloud.kms.v1.DecryptRequest.additional_authenticated_data] 192 * using this checksum. 193 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will 194 * report an error if the checksum verification fails. If you receive a 195 * checksum error, your client should verify that 196 * CRC32C([DecryptRequest.additional_authenticated_data][google.cloud.kms.v1.DecryptRequest.additional_authenticated_data]) 197 * is equal to 198 * [DecryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.DecryptRequest.additional_authenticated_data_crc32c], 199 * and if so, perform a limited number of retries. A persistent mismatch may 200 * indicate an issue in your computation of the CRC32C checksum. Note: This 201 * field is defined as int64 for reasons of compatibility across different 202 * languages. However, it is a non-negative integer, which will never exceed 203 * 2^32-1, and can be safely downconverted to uint32 in languages that support 204 * this type. 205 * </pre> 206 * 207 * <code> 208 * .google.protobuf.Int64Value additional_authenticated_data_crc32c = 6 [(.google.api.field_behavior) = OPTIONAL]; 209 * </code> 210 * 211 * @return Whether the additionalAuthenticatedDataCrc32c field is set. 212 */ hasAdditionalAuthenticatedDataCrc32C()213 boolean hasAdditionalAuthenticatedDataCrc32C(); 214 /** 215 * 216 * 217 * <pre> 218 * Optional. An optional CRC32C checksum of the 219 * [DecryptRequest.additional_authenticated_data][google.cloud.kms.v1.DecryptRequest.additional_authenticated_data]. 220 * If specified, 221 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will 222 * verify the integrity of the received 223 * [DecryptRequest.additional_authenticated_data][google.cloud.kms.v1.DecryptRequest.additional_authenticated_data] 224 * using this checksum. 225 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will 226 * report an error if the checksum verification fails. If you receive a 227 * checksum error, your client should verify that 228 * CRC32C([DecryptRequest.additional_authenticated_data][google.cloud.kms.v1.DecryptRequest.additional_authenticated_data]) 229 * is equal to 230 * [DecryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.DecryptRequest.additional_authenticated_data_crc32c], 231 * and if so, perform a limited number of retries. A persistent mismatch may 232 * indicate an issue in your computation of the CRC32C checksum. Note: This 233 * field is defined as int64 for reasons of compatibility across different 234 * languages. However, it is a non-negative integer, which will never exceed 235 * 2^32-1, and can be safely downconverted to uint32 in languages that support 236 * this type. 237 * </pre> 238 * 239 * <code> 240 * .google.protobuf.Int64Value additional_authenticated_data_crc32c = 6 [(.google.api.field_behavior) = OPTIONAL]; 241 * </code> 242 * 243 * @return The additionalAuthenticatedDataCrc32c. 244 */ getAdditionalAuthenticatedDataCrc32C()245 com.google.protobuf.Int64Value getAdditionalAuthenticatedDataCrc32C(); 246 /** 247 * 248 * 249 * <pre> 250 * Optional. An optional CRC32C checksum of the 251 * [DecryptRequest.additional_authenticated_data][google.cloud.kms.v1.DecryptRequest.additional_authenticated_data]. 252 * If specified, 253 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will 254 * verify the integrity of the received 255 * [DecryptRequest.additional_authenticated_data][google.cloud.kms.v1.DecryptRequest.additional_authenticated_data] 256 * using this checksum. 257 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will 258 * report an error if the checksum verification fails. If you receive a 259 * checksum error, your client should verify that 260 * CRC32C([DecryptRequest.additional_authenticated_data][google.cloud.kms.v1.DecryptRequest.additional_authenticated_data]) 261 * is equal to 262 * [DecryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.DecryptRequest.additional_authenticated_data_crc32c], 263 * and if so, perform a limited number of retries. A persistent mismatch may 264 * indicate an issue in your computation of the CRC32C checksum. Note: This 265 * field is defined as int64 for reasons of compatibility across different 266 * languages. However, it is a non-negative integer, which will never exceed 267 * 2^32-1, and can be safely downconverted to uint32 in languages that support 268 * this type. 269 * </pre> 270 * 271 * <code> 272 * .google.protobuf.Int64Value additional_authenticated_data_crc32c = 6 [(.google.api.field_behavior) = OPTIONAL]; 273 * </code> 274 */ getAdditionalAuthenticatedDataCrc32COrBuilder()275 com.google.protobuf.Int64ValueOrBuilder getAdditionalAuthenticatedDataCrc32COrBuilder(); 276 } 277