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 EncryptResponseOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.kms.v1.EncryptResponse) 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 in 32 * encryption. Check this field to verify that the intended resource was used 33 * for encryption. 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 in 47 * encryption. Check this field to verify that the intended resource was used 48 * for encryption. 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 * The encrypted data. 62 * </pre> 63 * 64 * <code>bytes ciphertext = 2;</code> 65 * 66 * @return The ciphertext. 67 */ getCiphertext()68 com.google.protobuf.ByteString getCiphertext(); 69 70 /** 71 * 72 * 73 * <pre> 74 * Integrity verification field. A CRC32C checksum of the returned 75 * [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.ciphertext]. 76 * An integrity check of 77 * [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.ciphertext] 78 * can be performed by computing the CRC32C checksum of 79 * [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.ciphertext] 80 * and comparing your results to this field. Discard the response in case of 81 * non-matching checksum values, and perform a limited number of retries. A 82 * persistent mismatch may indicate an issue in your computation of the CRC32C 83 * checksum. Note: This field is defined as int64 for reasons of compatibility 84 * across different languages. However, it is a non-negative integer, which 85 * will never exceed 2^32-1, and can be safely downconverted to uint32 in 86 * languages that support this type. 87 * </pre> 88 * 89 * <code>.google.protobuf.Int64Value ciphertext_crc32c = 4;</code> 90 * 91 * @return Whether the ciphertextCrc32c field is set. 92 */ hasCiphertextCrc32C()93 boolean hasCiphertextCrc32C(); 94 /** 95 * 96 * 97 * <pre> 98 * Integrity verification field. A CRC32C checksum of the returned 99 * [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.ciphertext]. 100 * An integrity check of 101 * [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.ciphertext] 102 * can be performed by computing the CRC32C checksum of 103 * [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.ciphertext] 104 * and comparing your results to this field. Discard the response in case of 105 * non-matching checksum values, and perform a limited number of retries. A 106 * persistent mismatch may indicate an issue in your computation of the CRC32C 107 * checksum. Note: This field is defined as int64 for reasons of compatibility 108 * across different languages. However, it is a non-negative integer, which 109 * will never exceed 2^32-1, and can be safely downconverted to uint32 in 110 * languages that support this type. 111 * </pre> 112 * 113 * <code>.google.protobuf.Int64Value ciphertext_crc32c = 4;</code> 114 * 115 * @return The ciphertextCrc32c. 116 */ getCiphertextCrc32C()117 com.google.protobuf.Int64Value getCiphertextCrc32C(); 118 /** 119 * 120 * 121 * <pre> 122 * Integrity verification field. A CRC32C checksum of the returned 123 * [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.ciphertext]. 124 * An integrity check of 125 * [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.ciphertext] 126 * can be performed by computing the CRC32C checksum of 127 * [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.ciphertext] 128 * and comparing your results to this field. Discard the response in case of 129 * non-matching checksum values, and perform a limited number of retries. A 130 * persistent mismatch may indicate an issue in your computation of the CRC32C 131 * checksum. Note: This field is defined as int64 for reasons of compatibility 132 * across different languages. However, it is a non-negative integer, which 133 * will never exceed 2^32-1, and can be safely downconverted to uint32 in 134 * languages that support this type. 135 * </pre> 136 * 137 * <code>.google.protobuf.Int64Value ciphertext_crc32c = 4;</code> 138 */ getCiphertextCrc32COrBuilder()139 com.google.protobuf.Int64ValueOrBuilder getCiphertextCrc32COrBuilder(); 140 141 /** 142 * 143 * 144 * <pre> 145 * Integrity verification field. A flag indicating whether 146 * [EncryptRequest.plaintext_crc32c][google.cloud.kms.v1.EncryptRequest.plaintext_crc32c] 147 * was received by 148 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] and used 149 * for the integrity verification of the 150 * [plaintext][google.cloud.kms.v1.EncryptRequest.plaintext]. A false value of 151 * this field indicates either that 152 * [EncryptRequest.plaintext_crc32c][google.cloud.kms.v1.EncryptRequest.plaintext_crc32c] 153 * was left unset or that it was not delivered to 154 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've 155 * set 156 * [EncryptRequest.plaintext_crc32c][google.cloud.kms.v1.EncryptRequest.plaintext_crc32c] 157 * but this field is still false, discard the response and perform a limited 158 * number of retries. 159 * </pre> 160 * 161 * <code>bool verified_plaintext_crc32c = 5;</code> 162 * 163 * @return The verifiedPlaintextCrc32c. 164 */ getVerifiedPlaintextCrc32C()165 boolean getVerifiedPlaintextCrc32C(); 166 167 /** 168 * 169 * 170 * <pre> 171 * Integrity verification field. A flag indicating whether 172 * [EncryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.EncryptRequest.additional_authenticated_data_crc32c] 173 * was received by 174 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] and used 175 * for the integrity verification of the 176 * [AAD][google.cloud.kms.v1.EncryptRequest.additional_authenticated_data]. A 177 * false value of this field indicates either that 178 * [EncryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.EncryptRequest.additional_authenticated_data_crc32c] 179 * was left unset or that it was not delivered to 180 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've 181 * set 182 * [EncryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.EncryptRequest.additional_authenticated_data_crc32c] 183 * but this field is still false, discard the response and perform a limited 184 * number of retries. 185 * </pre> 186 * 187 * <code>bool verified_additional_authenticated_data_crc32c = 6;</code> 188 * 189 * @return The verifiedAdditionalAuthenticatedDataCrc32c. 190 */ getVerifiedAdditionalAuthenticatedDataCrc32C()191 boolean getVerifiedAdditionalAuthenticatedDataCrc32C(); 192 193 /** 194 * 195 * 196 * <pre> 197 * The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the 198 * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in 199 * encryption. 200 * </pre> 201 * 202 * <code>.google.cloud.kms.v1.ProtectionLevel protection_level = 7;</code> 203 * 204 * @return The enum numeric value on the wire for protectionLevel. 205 */ getProtectionLevelValue()206 int getProtectionLevelValue(); 207 /** 208 * 209 * 210 * <pre> 211 * The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the 212 * [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in 213 * encryption. 214 * </pre> 215 * 216 * <code>.google.cloud.kms.v1.ProtectionLevel protection_level = 7;</code> 217 * 218 * @return The protectionLevel. 219 */ getProtectionLevel()220 com.google.cloud.kms.v1.ProtectionLevel getProtectionLevel(); 221 } 222