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 AsymmetricSignRequestOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.kms.v1.AsymmetricSignRequest) 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 * signing. 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 * signing. 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 * Optional. The digest of the data to sign. The digest must be produced with 64 * the same digest algorithm as specified by the key version's 65 * [algorithm][google.cloud.kms.v1.CryptoKeyVersion.algorithm]. 66 * This field may not be supplied if 67 * [AsymmetricSignRequest.data][google.cloud.kms.v1.AsymmetricSignRequest.data] 68 * is supplied. 69 * </pre> 70 * 71 * <code>.google.cloud.kms.v1.Digest digest = 3 [(.google.api.field_behavior) = OPTIONAL];</code> 72 * 73 * @return Whether the digest field is set. 74 */ hasDigest()75 boolean hasDigest(); 76 /** 77 * 78 * 79 * <pre> 80 * Optional. The digest of the data to sign. The digest must be produced with 81 * the same digest algorithm as specified by the key version's 82 * [algorithm][google.cloud.kms.v1.CryptoKeyVersion.algorithm]. 83 * This field may not be supplied if 84 * [AsymmetricSignRequest.data][google.cloud.kms.v1.AsymmetricSignRequest.data] 85 * is supplied. 86 * </pre> 87 * 88 * <code>.google.cloud.kms.v1.Digest digest = 3 [(.google.api.field_behavior) = OPTIONAL];</code> 89 * 90 * @return The digest. 91 */ getDigest()92 com.google.cloud.kms.v1.Digest getDigest(); 93 /** 94 * 95 * 96 * <pre> 97 * Optional. The digest of the data to sign. The digest must be produced with 98 * the same digest algorithm as specified by the key version's 99 * [algorithm][google.cloud.kms.v1.CryptoKeyVersion.algorithm]. 100 * This field may not be supplied if 101 * [AsymmetricSignRequest.data][google.cloud.kms.v1.AsymmetricSignRequest.data] 102 * is supplied. 103 * </pre> 104 * 105 * <code>.google.cloud.kms.v1.Digest digest = 3 [(.google.api.field_behavior) = OPTIONAL];</code> 106 */ getDigestOrBuilder()107 com.google.cloud.kms.v1.DigestOrBuilder getDigestOrBuilder(); 108 109 /** 110 * 111 * 112 * <pre> 113 * Optional. An optional CRC32C checksum of the 114 * [AsymmetricSignRequest.digest][google.cloud.kms.v1.AsymmetricSignRequest.digest]. 115 * If specified, 116 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will 117 * verify the integrity of the received 118 * [AsymmetricSignRequest.digest][google.cloud.kms.v1.AsymmetricSignRequest.digest] 119 * using this checksum. 120 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will 121 * report an error if the checksum verification fails. If you receive a 122 * checksum error, your client should verify that 123 * CRC32C([AsymmetricSignRequest.digest][google.cloud.kms.v1.AsymmetricSignRequest.digest]) 124 * is equal to 125 * [AsymmetricSignRequest.digest_crc32c][google.cloud.kms.v1.AsymmetricSignRequest.digest_crc32c], 126 * and if so, perform a limited number of retries. A persistent mismatch may 127 * indicate an issue in your computation of the CRC32C checksum. Note: This 128 * field is defined as int64 for reasons of compatibility across different 129 * languages. However, it is a non-negative integer, which will never exceed 130 * 2^32-1, and can be safely downconverted to uint32 in languages that support 131 * this type. 132 * </pre> 133 * 134 * <code>.google.protobuf.Int64Value digest_crc32c = 4 [(.google.api.field_behavior) = OPTIONAL]; 135 * </code> 136 * 137 * @return Whether the digestCrc32c field is set. 138 */ hasDigestCrc32C()139 boolean hasDigestCrc32C(); 140 /** 141 * 142 * 143 * <pre> 144 * Optional. An optional CRC32C checksum of the 145 * [AsymmetricSignRequest.digest][google.cloud.kms.v1.AsymmetricSignRequest.digest]. 146 * If specified, 147 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will 148 * verify the integrity of the received 149 * [AsymmetricSignRequest.digest][google.cloud.kms.v1.AsymmetricSignRequest.digest] 150 * using this checksum. 151 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will 152 * report an error if the checksum verification fails. If you receive a 153 * checksum error, your client should verify that 154 * CRC32C([AsymmetricSignRequest.digest][google.cloud.kms.v1.AsymmetricSignRequest.digest]) 155 * is equal to 156 * [AsymmetricSignRequest.digest_crc32c][google.cloud.kms.v1.AsymmetricSignRequest.digest_crc32c], 157 * and if so, perform a limited number of retries. A persistent mismatch may 158 * indicate an issue in your computation of the CRC32C checksum. Note: This 159 * field is defined as int64 for reasons of compatibility across different 160 * languages. However, it is a non-negative integer, which will never exceed 161 * 2^32-1, and can be safely downconverted to uint32 in languages that support 162 * this type. 163 * </pre> 164 * 165 * <code>.google.protobuf.Int64Value digest_crc32c = 4 [(.google.api.field_behavior) = OPTIONAL]; 166 * </code> 167 * 168 * @return The digestCrc32c. 169 */ getDigestCrc32C()170 com.google.protobuf.Int64Value getDigestCrc32C(); 171 /** 172 * 173 * 174 * <pre> 175 * Optional. An optional CRC32C checksum of the 176 * [AsymmetricSignRequest.digest][google.cloud.kms.v1.AsymmetricSignRequest.digest]. 177 * If specified, 178 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will 179 * verify the integrity of the received 180 * [AsymmetricSignRequest.digest][google.cloud.kms.v1.AsymmetricSignRequest.digest] 181 * using this checksum. 182 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will 183 * report an error if the checksum verification fails. If you receive a 184 * checksum error, your client should verify that 185 * CRC32C([AsymmetricSignRequest.digest][google.cloud.kms.v1.AsymmetricSignRequest.digest]) 186 * is equal to 187 * [AsymmetricSignRequest.digest_crc32c][google.cloud.kms.v1.AsymmetricSignRequest.digest_crc32c], 188 * and if so, perform a limited number of retries. A persistent mismatch may 189 * indicate an issue in your computation of the CRC32C checksum. Note: This 190 * field is defined as int64 for reasons of compatibility across different 191 * languages. However, it is a non-negative integer, which will never exceed 192 * 2^32-1, and can be safely downconverted to uint32 in languages that support 193 * this type. 194 * </pre> 195 * 196 * <code>.google.protobuf.Int64Value digest_crc32c = 4 [(.google.api.field_behavior) = OPTIONAL]; 197 * </code> 198 */ getDigestCrc32COrBuilder()199 com.google.protobuf.Int64ValueOrBuilder getDigestCrc32COrBuilder(); 200 201 /** 202 * 203 * 204 * <pre> 205 * Optional. The data to sign. 206 * It can't be supplied if 207 * [AsymmetricSignRequest.digest][google.cloud.kms.v1.AsymmetricSignRequest.digest] 208 * is supplied. 209 * </pre> 210 * 211 * <code>bytes data = 6 [(.google.api.field_behavior) = OPTIONAL];</code> 212 * 213 * @return The data. 214 */ getData()215 com.google.protobuf.ByteString getData(); 216 217 /** 218 * 219 * 220 * <pre> 221 * Optional. An optional CRC32C checksum of the 222 * [AsymmetricSignRequest.data][google.cloud.kms.v1.AsymmetricSignRequest.data]. 223 * If specified, 224 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will 225 * verify the integrity of the received 226 * [AsymmetricSignRequest.data][google.cloud.kms.v1.AsymmetricSignRequest.data] 227 * using this checksum. 228 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will 229 * report an error if the checksum verification fails. If you receive a 230 * checksum error, your client should verify that 231 * CRC32C([AsymmetricSignRequest.data][google.cloud.kms.v1.AsymmetricSignRequest.data]) 232 * is equal to 233 * [AsymmetricSignRequest.data_crc32c][google.cloud.kms.v1.AsymmetricSignRequest.data_crc32c], 234 * and if so, perform a limited number of retries. A persistent mismatch may 235 * indicate an issue in your computation of the CRC32C checksum. Note: This 236 * field is defined as int64 for reasons of compatibility across different 237 * languages. However, it is a non-negative integer, which will never exceed 238 * 2^32-1, and can be safely downconverted to uint32 in languages that support 239 * this type. 240 * </pre> 241 * 242 * <code>.google.protobuf.Int64Value data_crc32c = 7 [(.google.api.field_behavior) = OPTIONAL]; 243 * </code> 244 * 245 * @return Whether the dataCrc32c field is set. 246 */ hasDataCrc32C()247 boolean hasDataCrc32C(); 248 /** 249 * 250 * 251 * <pre> 252 * Optional. An optional CRC32C checksum of the 253 * [AsymmetricSignRequest.data][google.cloud.kms.v1.AsymmetricSignRequest.data]. 254 * If specified, 255 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will 256 * verify the integrity of the received 257 * [AsymmetricSignRequest.data][google.cloud.kms.v1.AsymmetricSignRequest.data] 258 * using this checksum. 259 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will 260 * report an error if the checksum verification fails. If you receive a 261 * checksum error, your client should verify that 262 * CRC32C([AsymmetricSignRequest.data][google.cloud.kms.v1.AsymmetricSignRequest.data]) 263 * is equal to 264 * [AsymmetricSignRequest.data_crc32c][google.cloud.kms.v1.AsymmetricSignRequest.data_crc32c], 265 * and if so, perform a limited number of retries. A persistent mismatch may 266 * indicate an issue in your computation of the CRC32C checksum. Note: This 267 * field is defined as int64 for reasons of compatibility across different 268 * languages. However, it is a non-negative integer, which will never exceed 269 * 2^32-1, and can be safely downconverted to uint32 in languages that support 270 * this type. 271 * </pre> 272 * 273 * <code>.google.protobuf.Int64Value data_crc32c = 7 [(.google.api.field_behavior) = OPTIONAL]; 274 * </code> 275 * 276 * @return The dataCrc32c. 277 */ getDataCrc32C()278 com.google.protobuf.Int64Value getDataCrc32C(); 279 /** 280 * 281 * 282 * <pre> 283 * Optional. An optional CRC32C checksum of the 284 * [AsymmetricSignRequest.data][google.cloud.kms.v1.AsymmetricSignRequest.data]. 285 * If specified, 286 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will 287 * verify the integrity of the received 288 * [AsymmetricSignRequest.data][google.cloud.kms.v1.AsymmetricSignRequest.data] 289 * using this checksum. 290 * [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will 291 * report an error if the checksum verification fails. If you receive a 292 * checksum error, your client should verify that 293 * CRC32C([AsymmetricSignRequest.data][google.cloud.kms.v1.AsymmetricSignRequest.data]) 294 * is equal to 295 * [AsymmetricSignRequest.data_crc32c][google.cloud.kms.v1.AsymmetricSignRequest.data_crc32c], 296 * and if so, perform a limited number of retries. A persistent mismatch may 297 * indicate an issue in your computation of the CRC32C checksum. Note: This 298 * field is defined as int64 for reasons of compatibility across different 299 * languages. However, it is a non-negative integer, which will never exceed 300 * 2^32-1, and can be safely downconverted to uint32 in languages that support 301 * this type. 302 * </pre> 303 * 304 * <code>.google.protobuf.Int64Value data_crc32c = 7 [(.google.api.field_behavior) = OPTIONAL]; 305 * </code> 306 */ getDataCrc32COrBuilder()307 com.google.protobuf.Int64ValueOrBuilder getDataCrc32COrBuilder(); 308 } 309