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/resources.proto 18 19 package com.google.cloud.kms.v1; 20 21 public interface ImportJobOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.kms.v1.ImportJob) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Output only. The resource name for this 31 * [ImportJob][google.cloud.kms.v1.ImportJob] in the format 32 * `projects/*/locations/*/keyRings/*/importJobs/*`. 33 * </pre> 34 * 35 * <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 36 * 37 * @return The name. 38 */ getName()39 java.lang.String getName(); 40 /** 41 * 42 * 43 * <pre> 44 * Output only. The resource name for this 45 * [ImportJob][google.cloud.kms.v1.ImportJob] in the format 46 * `projects/*/locations/*/keyRings/*/importJobs/*`. 47 * </pre> 48 * 49 * <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 50 * 51 * @return The bytes for name. 52 */ getNameBytes()53 com.google.protobuf.ByteString getNameBytes(); 54 55 /** 56 * 57 * 58 * <pre> 59 * Required. Immutable. The wrapping method to be used for incoming key 60 * material. 61 * </pre> 62 * 63 * <code> 64 * .google.cloud.kms.v1.ImportJob.ImportMethod import_method = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE]; 65 * </code> 66 * 67 * @return The enum numeric value on the wire for importMethod. 68 */ getImportMethodValue()69 int getImportMethodValue(); 70 /** 71 * 72 * 73 * <pre> 74 * Required. Immutable. The wrapping method to be used for incoming key 75 * material. 76 * </pre> 77 * 78 * <code> 79 * .google.cloud.kms.v1.ImportJob.ImportMethod import_method = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE]; 80 * </code> 81 * 82 * @return The importMethod. 83 */ getImportMethod()84 com.google.cloud.kms.v1.ImportJob.ImportMethod getImportMethod(); 85 86 /** 87 * 88 * 89 * <pre> 90 * Required. Immutable. The protection level of the 91 * [ImportJob][google.cloud.kms.v1.ImportJob]. This must match the 92 * [protection_level][google.cloud.kms.v1.CryptoKeyVersionTemplate.protection_level] 93 * of the [version_template][google.cloud.kms.v1.CryptoKey.version_template] 94 * on the [CryptoKey][google.cloud.kms.v1.CryptoKey] you attempt to import 95 * into. 96 * </pre> 97 * 98 * <code> 99 * .google.cloud.kms.v1.ProtectionLevel protection_level = 9 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE]; 100 * </code> 101 * 102 * @return The enum numeric value on the wire for protectionLevel. 103 */ getProtectionLevelValue()104 int getProtectionLevelValue(); 105 /** 106 * 107 * 108 * <pre> 109 * Required. Immutable. The protection level of the 110 * [ImportJob][google.cloud.kms.v1.ImportJob]. This must match the 111 * [protection_level][google.cloud.kms.v1.CryptoKeyVersionTemplate.protection_level] 112 * of the [version_template][google.cloud.kms.v1.CryptoKey.version_template] 113 * on the [CryptoKey][google.cloud.kms.v1.CryptoKey] you attempt to import 114 * into. 115 * </pre> 116 * 117 * <code> 118 * .google.cloud.kms.v1.ProtectionLevel protection_level = 9 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE]; 119 * </code> 120 * 121 * @return The protectionLevel. 122 */ getProtectionLevel()123 com.google.cloud.kms.v1.ProtectionLevel getProtectionLevel(); 124 125 /** 126 * 127 * 128 * <pre> 129 * Output only. The time at which this 130 * [ImportJob][google.cloud.kms.v1.ImportJob] was created. 131 * </pre> 132 * 133 * <code>.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; 134 * </code> 135 * 136 * @return Whether the createTime field is set. 137 */ hasCreateTime()138 boolean hasCreateTime(); 139 /** 140 * 141 * 142 * <pre> 143 * Output only. The time at which this 144 * [ImportJob][google.cloud.kms.v1.ImportJob] was created. 145 * </pre> 146 * 147 * <code>.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; 148 * </code> 149 * 150 * @return The createTime. 151 */ getCreateTime()152 com.google.protobuf.Timestamp getCreateTime(); 153 /** 154 * 155 * 156 * <pre> 157 * Output only. The time at which this 158 * [ImportJob][google.cloud.kms.v1.ImportJob] was created. 159 * </pre> 160 * 161 * <code>.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; 162 * </code> 163 */ getCreateTimeOrBuilder()164 com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder(); 165 166 /** 167 * 168 * 169 * <pre> 170 * Output only. The time this [ImportJob][google.cloud.kms.v1.ImportJob]'s key 171 * material was generated. 172 * </pre> 173 * 174 * <code> 175 * .google.protobuf.Timestamp generate_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; 176 * </code> 177 * 178 * @return Whether the generateTime field is set. 179 */ hasGenerateTime()180 boolean hasGenerateTime(); 181 /** 182 * 183 * 184 * <pre> 185 * Output only. The time this [ImportJob][google.cloud.kms.v1.ImportJob]'s key 186 * material was generated. 187 * </pre> 188 * 189 * <code> 190 * .google.protobuf.Timestamp generate_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; 191 * </code> 192 * 193 * @return The generateTime. 194 */ getGenerateTime()195 com.google.protobuf.Timestamp getGenerateTime(); 196 /** 197 * 198 * 199 * <pre> 200 * Output only. The time this [ImportJob][google.cloud.kms.v1.ImportJob]'s key 201 * material was generated. 202 * </pre> 203 * 204 * <code> 205 * .google.protobuf.Timestamp generate_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; 206 * </code> 207 */ getGenerateTimeOrBuilder()208 com.google.protobuf.TimestampOrBuilder getGenerateTimeOrBuilder(); 209 210 /** 211 * 212 * 213 * <pre> 214 * Output only. The time at which this 215 * [ImportJob][google.cloud.kms.v1.ImportJob] is scheduled for expiration and 216 * can no longer be used to import key material. 217 * </pre> 218 * 219 * <code>.google.protobuf.Timestamp expire_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; 220 * </code> 221 * 222 * @return Whether the expireTime field is set. 223 */ hasExpireTime()224 boolean hasExpireTime(); 225 /** 226 * 227 * 228 * <pre> 229 * Output only. The time at which this 230 * [ImportJob][google.cloud.kms.v1.ImportJob] is scheduled for expiration and 231 * can no longer be used to import key material. 232 * </pre> 233 * 234 * <code>.google.protobuf.Timestamp expire_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; 235 * </code> 236 * 237 * @return The expireTime. 238 */ getExpireTime()239 com.google.protobuf.Timestamp getExpireTime(); 240 /** 241 * 242 * 243 * <pre> 244 * Output only. The time at which this 245 * [ImportJob][google.cloud.kms.v1.ImportJob] is scheduled for expiration and 246 * can no longer be used to import key material. 247 * </pre> 248 * 249 * <code>.google.protobuf.Timestamp expire_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; 250 * </code> 251 */ getExpireTimeOrBuilder()252 com.google.protobuf.TimestampOrBuilder getExpireTimeOrBuilder(); 253 254 /** 255 * 256 * 257 * <pre> 258 * Output only. The time this [ImportJob][google.cloud.kms.v1.ImportJob] 259 * expired. Only present if [state][google.cloud.kms.v1.ImportJob.state] is 260 * [EXPIRED][google.cloud.kms.v1.ImportJob.ImportJobState.EXPIRED]. 261 * </pre> 262 * 263 * <code> 264 * .google.protobuf.Timestamp expire_event_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; 265 * </code> 266 * 267 * @return Whether the expireEventTime field is set. 268 */ hasExpireEventTime()269 boolean hasExpireEventTime(); 270 /** 271 * 272 * 273 * <pre> 274 * Output only. The time this [ImportJob][google.cloud.kms.v1.ImportJob] 275 * expired. Only present if [state][google.cloud.kms.v1.ImportJob.state] is 276 * [EXPIRED][google.cloud.kms.v1.ImportJob.ImportJobState.EXPIRED]. 277 * </pre> 278 * 279 * <code> 280 * .google.protobuf.Timestamp expire_event_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; 281 * </code> 282 * 283 * @return The expireEventTime. 284 */ getExpireEventTime()285 com.google.protobuf.Timestamp getExpireEventTime(); 286 /** 287 * 288 * 289 * <pre> 290 * Output only. The time this [ImportJob][google.cloud.kms.v1.ImportJob] 291 * expired. Only present if [state][google.cloud.kms.v1.ImportJob.state] is 292 * [EXPIRED][google.cloud.kms.v1.ImportJob.ImportJobState.EXPIRED]. 293 * </pre> 294 * 295 * <code> 296 * .google.protobuf.Timestamp expire_event_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; 297 * </code> 298 */ getExpireEventTimeOrBuilder()299 com.google.protobuf.TimestampOrBuilder getExpireEventTimeOrBuilder(); 300 301 /** 302 * 303 * 304 * <pre> 305 * Output only. The current state of the 306 * [ImportJob][google.cloud.kms.v1.ImportJob], indicating if it can be used. 307 * </pre> 308 * 309 * <code> 310 * .google.cloud.kms.v1.ImportJob.ImportJobState state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; 311 * </code> 312 * 313 * @return The enum numeric value on the wire for state. 314 */ getStateValue()315 int getStateValue(); 316 /** 317 * 318 * 319 * <pre> 320 * Output only. The current state of the 321 * [ImportJob][google.cloud.kms.v1.ImportJob], indicating if it can be used. 322 * </pre> 323 * 324 * <code> 325 * .google.cloud.kms.v1.ImportJob.ImportJobState state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; 326 * </code> 327 * 328 * @return The state. 329 */ getState()330 com.google.cloud.kms.v1.ImportJob.ImportJobState getState(); 331 332 /** 333 * 334 * 335 * <pre> 336 * Output only. The public key with which to wrap key material prior to 337 * import. Only returned if [state][google.cloud.kms.v1.ImportJob.state] is 338 * [ACTIVE][google.cloud.kms.v1.ImportJob.ImportJobState.ACTIVE]. 339 * </pre> 340 * 341 * <code> 342 * .google.cloud.kms.v1.ImportJob.WrappingPublicKey public_key = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; 343 * </code> 344 * 345 * @return Whether the publicKey field is set. 346 */ hasPublicKey()347 boolean hasPublicKey(); 348 /** 349 * 350 * 351 * <pre> 352 * Output only. The public key with which to wrap key material prior to 353 * import. Only returned if [state][google.cloud.kms.v1.ImportJob.state] is 354 * [ACTIVE][google.cloud.kms.v1.ImportJob.ImportJobState.ACTIVE]. 355 * </pre> 356 * 357 * <code> 358 * .google.cloud.kms.v1.ImportJob.WrappingPublicKey public_key = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; 359 * </code> 360 * 361 * @return The publicKey. 362 */ getPublicKey()363 com.google.cloud.kms.v1.ImportJob.WrappingPublicKey getPublicKey(); 364 /** 365 * 366 * 367 * <pre> 368 * Output only. The public key with which to wrap key material prior to 369 * import. Only returned if [state][google.cloud.kms.v1.ImportJob.state] is 370 * [ACTIVE][google.cloud.kms.v1.ImportJob.ImportJobState.ACTIVE]. 371 * </pre> 372 * 373 * <code> 374 * .google.cloud.kms.v1.ImportJob.WrappingPublicKey public_key = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; 375 * </code> 376 */ getPublicKeyOrBuilder()377 com.google.cloud.kms.v1.ImportJob.WrappingPublicKeyOrBuilder getPublicKeyOrBuilder(); 378 379 /** 380 * 381 * 382 * <pre> 383 * Output only. Statement that was generated and signed by the key creator 384 * (for example, an HSM) at key creation time. Use this statement to verify 385 * attributes of the key as stored on the HSM, independently of Google. 386 * Only present if the chosen 387 * [ImportMethod][google.cloud.kms.v1.ImportJob.ImportMethod] is one with a 388 * protection level of [HSM][google.cloud.kms.v1.ProtectionLevel.HSM]. 389 * </pre> 390 * 391 * <code> 392 * .google.cloud.kms.v1.KeyOperationAttestation attestation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; 393 * </code> 394 * 395 * @return Whether the attestation field is set. 396 */ hasAttestation()397 boolean hasAttestation(); 398 /** 399 * 400 * 401 * <pre> 402 * Output only. Statement that was generated and signed by the key creator 403 * (for example, an HSM) at key creation time. Use this statement to verify 404 * attributes of the key as stored on the HSM, independently of Google. 405 * Only present if the chosen 406 * [ImportMethod][google.cloud.kms.v1.ImportJob.ImportMethod] is one with a 407 * protection level of [HSM][google.cloud.kms.v1.ProtectionLevel.HSM]. 408 * </pre> 409 * 410 * <code> 411 * .google.cloud.kms.v1.KeyOperationAttestation attestation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; 412 * </code> 413 * 414 * @return The attestation. 415 */ getAttestation()416 com.google.cloud.kms.v1.KeyOperationAttestation getAttestation(); 417 /** 418 * 419 * 420 * <pre> 421 * Output only. Statement that was generated and signed by the key creator 422 * (for example, an HSM) at key creation time. Use this statement to verify 423 * attributes of the key as stored on the HSM, independently of Google. 424 * Only present if the chosen 425 * [ImportMethod][google.cloud.kms.v1.ImportJob.ImportMethod] is one with a 426 * protection level of [HSM][google.cloud.kms.v1.ProtectionLevel.HSM]. 427 * </pre> 428 * 429 * <code> 430 * .google.cloud.kms.v1.KeyOperationAttestation attestation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; 431 * </code> 432 */ getAttestationOrBuilder()433 com.google.cloud.kms.v1.KeyOperationAttestationOrBuilder getAttestationOrBuilder(); 434 } 435