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 MacSignRequestOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.kms.v1.MacSignRequest) 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 * Required. The data to sign. The MAC tag is computed over this data field 64 * based on the specific algorithm. 65 * </pre> 66 * 67 * <code>bytes data = 2 [(.google.api.field_behavior) = REQUIRED];</code> 68 * 69 * @return The data. 70 */ getData()71 com.google.protobuf.ByteString getData(); 72 73 /** 74 * 75 * 76 * <pre> 77 * Optional. An optional CRC32C checksum of the 78 * [MacSignRequest.data][google.cloud.kms.v1.MacSignRequest.data]. If 79 * specified, [KeyManagementService][google.cloud.kms.v1.KeyManagementService] 80 * will verify the integrity of the received 81 * [MacSignRequest.data][google.cloud.kms.v1.MacSignRequest.data] using this 82 * checksum. [KeyManagementService][google.cloud.kms.v1.KeyManagementService] 83 * will report an error if the checksum verification fails. If you receive a 84 * checksum error, your client should verify that 85 * CRC32C([MacSignRequest.data][google.cloud.kms.v1.MacSignRequest.data]) is 86 * equal to 87 * [MacSignRequest.data_crc32c][google.cloud.kms.v1.MacSignRequest.data_crc32c], 88 * and if so, perform a limited number of retries. A persistent mismatch may 89 * indicate an issue in your computation of the CRC32C checksum. Note: This 90 * field is defined as int64 for reasons of compatibility across different 91 * languages. However, it is a non-negative integer, which will never exceed 92 * 2^32-1, and can be safely downconverted to uint32 in languages that support 93 * this type. 94 * </pre> 95 * 96 * <code>.google.protobuf.Int64Value data_crc32c = 3 [(.google.api.field_behavior) = OPTIONAL]; 97 * </code> 98 * 99 * @return Whether the dataCrc32c field is set. 100 */ hasDataCrc32C()101 boolean hasDataCrc32C(); 102 /** 103 * 104 * 105 * <pre> 106 * Optional. An optional CRC32C checksum of the 107 * [MacSignRequest.data][google.cloud.kms.v1.MacSignRequest.data]. If 108 * specified, [KeyManagementService][google.cloud.kms.v1.KeyManagementService] 109 * will verify the integrity of the received 110 * [MacSignRequest.data][google.cloud.kms.v1.MacSignRequest.data] using this 111 * checksum. [KeyManagementService][google.cloud.kms.v1.KeyManagementService] 112 * will report an error if the checksum verification fails. If you receive a 113 * checksum error, your client should verify that 114 * CRC32C([MacSignRequest.data][google.cloud.kms.v1.MacSignRequest.data]) is 115 * equal to 116 * [MacSignRequest.data_crc32c][google.cloud.kms.v1.MacSignRequest.data_crc32c], 117 * and if so, perform a limited number of retries. A persistent mismatch may 118 * indicate an issue in your computation of the CRC32C checksum. Note: This 119 * field is defined as int64 for reasons of compatibility across different 120 * languages. However, it is a non-negative integer, which will never exceed 121 * 2^32-1, and can be safely downconverted to uint32 in languages that support 122 * this type. 123 * </pre> 124 * 125 * <code>.google.protobuf.Int64Value data_crc32c = 3 [(.google.api.field_behavior) = OPTIONAL]; 126 * </code> 127 * 128 * @return The dataCrc32c. 129 */ getDataCrc32C()130 com.google.protobuf.Int64Value getDataCrc32C(); 131 /** 132 * 133 * 134 * <pre> 135 * Optional. An optional CRC32C checksum of the 136 * [MacSignRequest.data][google.cloud.kms.v1.MacSignRequest.data]. If 137 * specified, [KeyManagementService][google.cloud.kms.v1.KeyManagementService] 138 * will verify the integrity of the received 139 * [MacSignRequest.data][google.cloud.kms.v1.MacSignRequest.data] using this 140 * checksum. [KeyManagementService][google.cloud.kms.v1.KeyManagementService] 141 * will report an error if the checksum verification fails. If you receive a 142 * checksum error, your client should verify that 143 * CRC32C([MacSignRequest.data][google.cloud.kms.v1.MacSignRequest.data]) is 144 * equal to 145 * [MacSignRequest.data_crc32c][google.cloud.kms.v1.MacSignRequest.data_crc32c], 146 * and if so, perform a limited number of retries. A persistent mismatch may 147 * indicate an issue in your computation of the CRC32C checksum. Note: This 148 * field is defined as int64 for reasons of compatibility across different 149 * languages. However, it is a non-negative integer, which will never exceed 150 * 2^32-1, and can be safely downconverted to uint32 in languages that support 151 * this type. 152 * </pre> 153 * 154 * <code>.google.protobuf.Int64Value data_crc32c = 3 [(.google.api.field_behavior) = OPTIONAL]; 155 * </code> 156 */ getDataCrc32COrBuilder()157 com.google.protobuf.Int64ValueOrBuilder getDataCrc32COrBuilder(); 158 } 159