This repository has been archived by the owner on Oct 2, 2023. It is now read-only.
/
CryptoKey.java
3172 lines (3023 loc) · 114 KB
/
CryptoKey.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/kms/v1/resources.proto
package com.google.cloud.kms.v1;
/**
*
*
* <pre>
* A [CryptoKey][google.cloud.kms.v1.CryptoKey] represents a logical key that can be used for cryptographic
* operations.
* A [CryptoKey][google.cloud.kms.v1.CryptoKey] is made up of one or more [versions][google.cloud.kms.v1.CryptoKeyVersion], which
* represent the actual key material used in cryptographic operations.
* </pre>
*
* Protobuf type {@code google.cloud.kms.v1.CryptoKey}
*/
public final class CryptoKey extends com.google.protobuf.GeneratedMessageV3
implements
// @@protoc_insertion_point(message_implements:google.cloud.kms.v1.CryptoKey)
CryptoKeyOrBuilder {
private static final long serialVersionUID = 0L;
// Use CryptoKey.newBuilder() to construct.
private CryptoKey(com.google.protobuf.GeneratedMessageV3.Builder<?> builder) {
super(builder);
}
private CryptoKey() {
name_ = "";
purpose_ = 0;
}
@java.lang.Override
@SuppressWarnings({"unused"})
protected java.lang.Object newInstance(UnusedPrivateParameter unused) {
return new CryptoKey();
}
@java.lang.Override
public final com.google.protobuf.UnknownFieldSet getUnknownFields() {
return this.unknownFields;
}
private CryptoKey(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
this();
if (extensionRegistry == null) {
throw new java.lang.NullPointerException();
}
int mutable_bitField0_ = 0;
com.google.protobuf.UnknownFieldSet.Builder unknownFields =
com.google.protobuf.UnknownFieldSet.newBuilder();
try {
boolean done = false;
while (!done) {
int tag = input.readTag();
switch (tag) {
case 0:
done = true;
break;
case 10:
{
java.lang.String s = input.readStringRequireUtf8();
name_ = s;
break;
}
case 18:
{
com.google.cloud.kms.v1.CryptoKeyVersion.Builder subBuilder = null;
if (primary_ != null) {
subBuilder = primary_.toBuilder();
}
primary_ =
input.readMessage(
com.google.cloud.kms.v1.CryptoKeyVersion.parser(), extensionRegistry);
if (subBuilder != null) {
subBuilder.mergeFrom(primary_);
primary_ = subBuilder.buildPartial();
}
break;
}
case 24:
{
int rawValue = input.readEnum();
purpose_ = rawValue;
break;
}
case 42:
{
com.google.protobuf.Timestamp.Builder subBuilder = null;
if (createTime_ != null) {
subBuilder = createTime_.toBuilder();
}
createTime_ =
input.readMessage(com.google.protobuf.Timestamp.parser(), extensionRegistry);
if (subBuilder != null) {
subBuilder.mergeFrom(createTime_);
createTime_ = subBuilder.buildPartial();
}
break;
}
case 58:
{
com.google.protobuf.Timestamp.Builder subBuilder = null;
if (nextRotationTime_ != null) {
subBuilder = nextRotationTime_.toBuilder();
}
nextRotationTime_ =
input.readMessage(com.google.protobuf.Timestamp.parser(), extensionRegistry);
if (subBuilder != null) {
subBuilder.mergeFrom(nextRotationTime_);
nextRotationTime_ = subBuilder.buildPartial();
}
break;
}
case 66:
{
com.google.protobuf.Duration.Builder subBuilder = null;
if (rotationScheduleCase_ == 8) {
subBuilder = ((com.google.protobuf.Duration) rotationSchedule_).toBuilder();
}
rotationSchedule_ =
input.readMessage(com.google.protobuf.Duration.parser(), extensionRegistry);
if (subBuilder != null) {
subBuilder.mergeFrom((com.google.protobuf.Duration) rotationSchedule_);
rotationSchedule_ = subBuilder.buildPartial();
}
rotationScheduleCase_ = 8;
break;
}
case 82:
{
if (!((mutable_bitField0_ & 0x00000001) != 0)) {
labels_ =
com.google.protobuf.MapField.newMapField(LabelsDefaultEntryHolder.defaultEntry);
mutable_bitField0_ |= 0x00000001;
}
com.google.protobuf.MapEntry<java.lang.String, java.lang.String> labels__ =
input.readMessage(
LabelsDefaultEntryHolder.defaultEntry.getParserForType(), extensionRegistry);
labels_.getMutableMap().put(labels__.getKey(), labels__.getValue());
break;
}
case 90:
{
com.google.cloud.kms.v1.CryptoKeyVersionTemplate.Builder subBuilder = null;
if (versionTemplate_ != null) {
subBuilder = versionTemplate_.toBuilder();
}
versionTemplate_ =
input.readMessage(
com.google.cloud.kms.v1.CryptoKeyVersionTemplate.parser(), extensionRegistry);
if (subBuilder != null) {
subBuilder.mergeFrom(versionTemplate_);
versionTemplate_ = subBuilder.buildPartial();
}
break;
}
default:
{
if (!parseUnknownField(input, unknownFields, extensionRegistry, tag)) {
done = true;
}
break;
}
}
}
} catch (com.google.protobuf.InvalidProtocolBufferException e) {
throw e.setUnfinishedMessage(this);
} catch (java.io.IOException e) {
throw new com.google.protobuf.InvalidProtocolBufferException(e).setUnfinishedMessage(this);
} finally {
this.unknownFields = unknownFields.build();
makeExtensionsImmutable();
}
}
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
return com.google.cloud.kms.v1.KmsResourcesProto
.internal_static_google_cloud_kms_v1_CryptoKey_descriptor;
}
@SuppressWarnings({"rawtypes"})
@java.lang.Override
protected com.google.protobuf.MapField internalGetMapField(int number) {
switch (number) {
case 10:
return internalGetLabels();
default:
throw new RuntimeException("Invalid map field number: " + number);
}
}
@java.lang.Override
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable() {
return com.google.cloud.kms.v1.KmsResourcesProto
.internal_static_google_cloud_kms_v1_CryptoKey_fieldAccessorTable
.ensureFieldAccessorsInitialized(
com.google.cloud.kms.v1.CryptoKey.class,
com.google.cloud.kms.v1.CryptoKey.Builder.class);
}
/**
*
*
* <pre>
* [CryptoKeyPurpose][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose] describes the cryptographic capabilities of a
* [CryptoKey][google.cloud.kms.v1.CryptoKey]. A given key can only be used for the operations allowed by
* its purpose. For more information, see
* [Key purposes](https://cloud.google.com/kms/docs/algorithms#key_purposes).
* </pre>
*
* Protobuf enum {@code google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose}
*/
public enum CryptoKeyPurpose implements com.google.protobuf.ProtocolMessageEnum {
/**
*
*
* <pre>
* Not specified.
* </pre>
*
* <code>CRYPTO_KEY_PURPOSE_UNSPECIFIED = 0;</code>
*/
CRYPTO_KEY_PURPOSE_UNSPECIFIED(0),
/**
*
*
* <pre>
* [CryptoKeys][google.cloud.kms.v1.CryptoKey] with this purpose may be used with
* [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt] and
* [Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt].
* </pre>
*
* <code>ENCRYPT_DECRYPT = 1;</code>
*/
ENCRYPT_DECRYPT(1),
/**
*
*
* <pre>
* [CryptoKeys][google.cloud.kms.v1.CryptoKey] with this purpose may be used with
* [AsymmetricSign][google.cloud.kms.v1.KeyManagementService.AsymmetricSign] and
* [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].
* </pre>
*
* <code>ASYMMETRIC_SIGN = 5;</code>
*/
ASYMMETRIC_SIGN(5),
/**
*
*
* <pre>
* [CryptoKeys][google.cloud.kms.v1.CryptoKey] with this purpose may be used with
* [AsymmetricDecrypt][google.cloud.kms.v1.KeyManagementService.AsymmetricDecrypt] and
* [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].
* </pre>
*
* <code>ASYMMETRIC_DECRYPT = 6;</code>
*/
ASYMMETRIC_DECRYPT(6),
UNRECOGNIZED(-1),
;
/**
*
*
* <pre>
* Not specified.
* </pre>
*
* <code>CRYPTO_KEY_PURPOSE_UNSPECIFIED = 0;</code>
*/
public static final int CRYPTO_KEY_PURPOSE_UNSPECIFIED_VALUE = 0;
/**
*
*
* <pre>
* [CryptoKeys][google.cloud.kms.v1.CryptoKey] with this purpose may be used with
* [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt] and
* [Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt].
* </pre>
*
* <code>ENCRYPT_DECRYPT = 1;</code>
*/
public static final int ENCRYPT_DECRYPT_VALUE = 1;
/**
*
*
* <pre>
* [CryptoKeys][google.cloud.kms.v1.CryptoKey] with this purpose may be used with
* [AsymmetricSign][google.cloud.kms.v1.KeyManagementService.AsymmetricSign] and
* [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].
* </pre>
*
* <code>ASYMMETRIC_SIGN = 5;</code>
*/
public static final int ASYMMETRIC_SIGN_VALUE = 5;
/**
*
*
* <pre>
* [CryptoKeys][google.cloud.kms.v1.CryptoKey] with this purpose may be used with
* [AsymmetricDecrypt][google.cloud.kms.v1.KeyManagementService.AsymmetricDecrypt] and
* [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].
* </pre>
*
* <code>ASYMMETRIC_DECRYPT = 6;</code>
*/
public static final int ASYMMETRIC_DECRYPT_VALUE = 6;
public final int getNumber() {
if (this == UNRECOGNIZED) {
throw new java.lang.IllegalArgumentException(
"Can't get the number of an unknown enum value.");
}
return value;
}
/**
* @param value The numeric wire value of the corresponding enum entry.
* @return The enum associated with the given numeric wire value.
* @deprecated Use {@link #forNumber(int)} instead.
*/
@java.lang.Deprecated
public static CryptoKeyPurpose valueOf(int value) {
return forNumber(value);
}
/**
* @param value The numeric wire value of the corresponding enum entry.
* @return The enum associated with the given numeric wire value.
*/
public static CryptoKeyPurpose forNumber(int value) {
switch (value) {
case 0:
return CRYPTO_KEY_PURPOSE_UNSPECIFIED;
case 1:
return ENCRYPT_DECRYPT;
case 5:
return ASYMMETRIC_SIGN;
case 6:
return ASYMMETRIC_DECRYPT;
default:
return null;
}
}
public static com.google.protobuf.Internal.EnumLiteMap<CryptoKeyPurpose> internalGetValueMap() {
return internalValueMap;
}
private static final com.google.protobuf.Internal.EnumLiteMap<CryptoKeyPurpose>
internalValueMap =
new com.google.protobuf.Internal.EnumLiteMap<CryptoKeyPurpose>() {
public CryptoKeyPurpose findValueByNumber(int number) {
return CryptoKeyPurpose.forNumber(number);
}
};
public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor() {
if (this == UNRECOGNIZED) {
throw new java.lang.IllegalStateException(
"Can't get the descriptor of an unrecognized enum value.");
}
return getDescriptor().getValues().get(ordinal());
}
public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType() {
return getDescriptor();
}
public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor() {
return com.google.cloud.kms.v1.CryptoKey.getDescriptor().getEnumTypes().get(0);
}
private static final CryptoKeyPurpose[] VALUES = values();
public static CryptoKeyPurpose valueOf(
com.google.protobuf.Descriptors.EnumValueDescriptor desc) {
if (desc.getType() != getDescriptor()) {
throw new java.lang.IllegalArgumentException("EnumValueDescriptor is not for this type.");
}
if (desc.getIndex() == -1) {
return UNRECOGNIZED;
}
return VALUES[desc.getIndex()];
}
private final int value;
private CryptoKeyPurpose(int value) {
this.value = value;
}
// @@protoc_insertion_point(enum_scope:google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose)
}
private int rotationScheduleCase_ = 0;
private java.lang.Object rotationSchedule_;
public enum RotationScheduleCase
implements
com.google.protobuf.Internal.EnumLite,
com.google.protobuf.AbstractMessage.InternalOneOfEnum {
ROTATION_PERIOD(8),
ROTATIONSCHEDULE_NOT_SET(0);
private final int value;
private RotationScheduleCase(int value) {
this.value = value;
}
/**
* @param value The number of the enum to look for.
* @return The enum associated with the given number.
* @deprecated Use {@link #forNumber(int)} instead.
*/
@java.lang.Deprecated
public static RotationScheduleCase valueOf(int value) {
return forNumber(value);
}
public static RotationScheduleCase forNumber(int value) {
switch (value) {
case 8:
return ROTATION_PERIOD;
case 0:
return ROTATIONSCHEDULE_NOT_SET;
default:
return null;
}
}
public int getNumber() {
return this.value;
}
};
public RotationScheduleCase getRotationScheduleCase() {
return RotationScheduleCase.forNumber(rotationScheduleCase_);
}
public static final int NAME_FIELD_NUMBER = 1;
private volatile java.lang.Object name_;
/**
*
*
* <pre>
* Output only. The resource name for this [CryptoKey][google.cloud.kms.v1.CryptoKey] in the format
* `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
* </pre>
*
* <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
*
* @return The name.
*/
@java.lang.Override
public java.lang.String getName() {
java.lang.Object ref = name_;
if (ref instanceof java.lang.String) {
return (java.lang.String) ref;
} else {
com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
name_ = s;
return s;
}
}
/**
*
*
* <pre>
* Output only. The resource name for this [CryptoKey][google.cloud.kms.v1.CryptoKey] in the format
* `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
* </pre>
*
* <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
*
* @return The bytes for name.
*/
@java.lang.Override
public com.google.protobuf.ByteString getNameBytes() {
java.lang.Object ref = name_;
if (ref instanceof java.lang.String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
name_ = b;
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
public static final int PRIMARY_FIELD_NUMBER = 2;
private com.google.cloud.kms.v1.CryptoKeyVersion primary_;
/**
*
*
* <pre>
* Output only. A copy of the "primary" [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] that will be used
* by [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt] when this [CryptoKey][google.cloud.kms.v1.CryptoKey] is given
* in [EncryptRequest.name][google.cloud.kms.v1.EncryptRequest.name].
* The [CryptoKey][google.cloud.kms.v1.CryptoKey]'s primary version can be updated via
* [UpdateCryptoKeyPrimaryVersion][google.cloud.kms.v1.KeyManagementService.UpdateCryptoKeyPrimaryVersion].
* Keys with [purpose][google.cloud.kms.v1.CryptoKey.purpose]
* [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT] may have a
* primary. For other keys, this field will be omitted.
* </pre>
*
* <code>
* .google.cloud.kms.v1.CryptoKeyVersion primary = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
* </code>
*
* @return Whether the primary field is set.
*/
@java.lang.Override
public boolean hasPrimary() {
return primary_ != null;
}
/**
*
*
* <pre>
* Output only. A copy of the "primary" [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] that will be used
* by [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt] when this [CryptoKey][google.cloud.kms.v1.CryptoKey] is given
* in [EncryptRequest.name][google.cloud.kms.v1.EncryptRequest.name].
* The [CryptoKey][google.cloud.kms.v1.CryptoKey]'s primary version can be updated via
* [UpdateCryptoKeyPrimaryVersion][google.cloud.kms.v1.KeyManagementService.UpdateCryptoKeyPrimaryVersion].
* Keys with [purpose][google.cloud.kms.v1.CryptoKey.purpose]
* [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT] may have a
* primary. For other keys, this field will be omitted.
* </pre>
*
* <code>
* .google.cloud.kms.v1.CryptoKeyVersion primary = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
* </code>
*
* @return The primary.
*/
@java.lang.Override
public com.google.cloud.kms.v1.CryptoKeyVersion getPrimary() {
return primary_ == null
? com.google.cloud.kms.v1.CryptoKeyVersion.getDefaultInstance()
: primary_;
}
/**
*
*
* <pre>
* Output only. A copy of the "primary" [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] that will be used
* by [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt] when this [CryptoKey][google.cloud.kms.v1.CryptoKey] is given
* in [EncryptRequest.name][google.cloud.kms.v1.EncryptRequest.name].
* The [CryptoKey][google.cloud.kms.v1.CryptoKey]'s primary version can be updated via
* [UpdateCryptoKeyPrimaryVersion][google.cloud.kms.v1.KeyManagementService.UpdateCryptoKeyPrimaryVersion].
* Keys with [purpose][google.cloud.kms.v1.CryptoKey.purpose]
* [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT] may have a
* primary. For other keys, this field will be omitted.
* </pre>
*
* <code>
* .google.cloud.kms.v1.CryptoKeyVersion primary = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
* </code>
*/
@java.lang.Override
public com.google.cloud.kms.v1.CryptoKeyVersionOrBuilder getPrimaryOrBuilder() {
return getPrimary();
}
public static final int PURPOSE_FIELD_NUMBER = 3;
private int purpose_;
/**
*
*
* <pre>
* Immutable. The immutable purpose of this [CryptoKey][google.cloud.kms.v1.CryptoKey].
* </pre>
*
* <code>
* .google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose purpose = 3 [(.google.api.field_behavior) = IMMUTABLE];
* </code>
*
* @return The enum numeric value on the wire for purpose.
*/
@java.lang.Override
public int getPurposeValue() {
return purpose_;
}
/**
*
*
* <pre>
* Immutable. The immutable purpose of this [CryptoKey][google.cloud.kms.v1.CryptoKey].
* </pre>
*
* <code>
* .google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose purpose = 3 [(.google.api.field_behavior) = IMMUTABLE];
* </code>
*
* @return The purpose.
*/
@java.lang.Override
public com.google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose getPurpose() {
@SuppressWarnings("deprecation")
com.google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose result =
com.google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.valueOf(purpose_);
return result == null
? com.google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.UNRECOGNIZED
: result;
}
public static final int CREATE_TIME_FIELD_NUMBER = 5;
private com.google.protobuf.Timestamp createTime_;
/**
*
*
* <pre>
* Output only. The time at which this [CryptoKey][google.cloud.kms.v1.CryptoKey] was created.
* </pre>
*
* <code>.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
* </code>
*
* @return Whether the createTime field is set.
*/
@java.lang.Override
public boolean hasCreateTime() {
return createTime_ != null;
}
/**
*
*
* <pre>
* Output only. The time at which this [CryptoKey][google.cloud.kms.v1.CryptoKey] was created.
* </pre>
*
* <code>.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
* </code>
*
* @return The createTime.
*/
@java.lang.Override
public com.google.protobuf.Timestamp getCreateTime() {
return createTime_ == null ? com.google.protobuf.Timestamp.getDefaultInstance() : createTime_;
}
/**
*
*
* <pre>
* Output only. The time at which this [CryptoKey][google.cloud.kms.v1.CryptoKey] was created.
* </pre>
*
* <code>.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
* </code>
*/
@java.lang.Override
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder() {
return getCreateTime();
}
public static final int NEXT_ROTATION_TIME_FIELD_NUMBER = 7;
private com.google.protobuf.Timestamp nextRotationTime_;
/**
*
*
* <pre>
* At [next_rotation_time][google.cloud.kms.v1.CryptoKey.next_rotation_time], the Key Management Service will automatically:
* 1. Create a new version of this [CryptoKey][google.cloud.kms.v1.CryptoKey].
* 2. Mark the new version as primary.
* Key rotations performed manually via
* [CreateCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.CreateCryptoKeyVersion] and
* [UpdateCryptoKeyPrimaryVersion][google.cloud.kms.v1.KeyManagementService.UpdateCryptoKeyPrimaryVersion]
* do not affect [next_rotation_time][google.cloud.kms.v1.CryptoKey.next_rotation_time].
* Keys with [purpose][google.cloud.kms.v1.CryptoKey.purpose]
* [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT] support
* automatic rotation. For other keys, this field must be omitted.
* </pre>
*
* <code>.google.protobuf.Timestamp next_rotation_time = 7;</code>
*
* @return Whether the nextRotationTime field is set.
*/
@java.lang.Override
public boolean hasNextRotationTime() {
return nextRotationTime_ != null;
}
/**
*
*
* <pre>
* At [next_rotation_time][google.cloud.kms.v1.CryptoKey.next_rotation_time], the Key Management Service will automatically:
* 1. Create a new version of this [CryptoKey][google.cloud.kms.v1.CryptoKey].
* 2. Mark the new version as primary.
* Key rotations performed manually via
* [CreateCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.CreateCryptoKeyVersion] and
* [UpdateCryptoKeyPrimaryVersion][google.cloud.kms.v1.KeyManagementService.UpdateCryptoKeyPrimaryVersion]
* do not affect [next_rotation_time][google.cloud.kms.v1.CryptoKey.next_rotation_time].
* Keys with [purpose][google.cloud.kms.v1.CryptoKey.purpose]
* [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT] support
* automatic rotation. For other keys, this field must be omitted.
* </pre>
*
* <code>.google.protobuf.Timestamp next_rotation_time = 7;</code>
*
* @return The nextRotationTime.
*/
@java.lang.Override
public com.google.protobuf.Timestamp getNextRotationTime() {
return nextRotationTime_ == null
? com.google.protobuf.Timestamp.getDefaultInstance()
: nextRotationTime_;
}
/**
*
*
* <pre>
* At [next_rotation_time][google.cloud.kms.v1.CryptoKey.next_rotation_time], the Key Management Service will automatically:
* 1. Create a new version of this [CryptoKey][google.cloud.kms.v1.CryptoKey].
* 2. Mark the new version as primary.
* Key rotations performed manually via
* [CreateCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.CreateCryptoKeyVersion] and
* [UpdateCryptoKeyPrimaryVersion][google.cloud.kms.v1.KeyManagementService.UpdateCryptoKeyPrimaryVersion]
* do not affect [next_rotation_time][google.cloud.kms.v1.CryptoKey.next_rotation_time].
* Keys with [purpose][google.cloud.kms.v1.CryptoKey.purpose]
* [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT] support
* automatic rotation. For other keys, this field must be omitted.
* </pre>
*
* <code>.google.protobuf.Timestamp next_rotation_time = 7;</code>
*/
@java.lang.Override
public com.google.protobuf.TimestampOrBuilder getNextRotationTimeOrBuilder() {
return getNextRotationTime();
}
public static final int ROTATION_PERIOD_FIELD_NUMBER = 8;
/**
*
*
* <pre>
* [next_rotation_time][google.cloud.kms.v1.CryptoKey.next_rotation_time] will be advanced by this period when the service
* automatically rotates a key. Must be at least 24 hours and at most
* 876,000 hours.
* If [rotation_period][google.cloud.kms.v1.CryptoKey.rotation_period] is set, [next_rotation_time][google.cloud.kms.v1.CryptoKey.next_rotation_time] must also be set.
* Keys with [purpose][google.cloud.kms.v1.CryptoKey.purpose]
* [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT] support
* automatic rotation. For other keys, this field must be omitted.
* </pre>
*
* <code>.google.protobuf.Duration rotation_period = 8;</code>
*
* @return Whether the rotationPeriod field is set.
*/
@java.lang.Override
public boolean hasRotationPeriod() {
return rotationScheduleCase_ == 8;
}
/**
*
*
* <pre>
* [next_rotation_time][google.cloud.kms.v1.CryptoKey.next_rotation_time] will be advanced by this period when the service
* automatically rotates a key. Must be at least 24 hours and at most
* 876,000 hours.
* If [rotation_period][google.cloud.kms.v1.CryptoKey.rotation_period] is set, [next_rotation_time][google.cloud.kms.v1.CryptoKey.next_rotation_time] must also be set.
* Keys with [purpose][google.cloud.kms.v1.CryptoKey.purpose]
* [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT] support
* automatic rotation. For other keys, this field must be omitted.
* </pre>
*
* <code>.google.protobuf.Duration rotation_period = 8;</code>
*
* @return The rotationPeriod.
*/
@java.lang.Override
public com.google.protobuf.Duration getRotationPeriod() {
if (rotationScheduleCase_ == 8) {
return (com.google.protobuf.Duration) rotationSchedule_;
}
return com.google.protobuf.Duration.getDefaultInstance();
}
/**
*
*
* <pre>
* [next_rotation_time][google.cloud.kms.v1.CryptoKey.next_rotation_time] will be advanced by this period when the service
* automatically rotates a key. Must be at least 24 hours and at most
* 876,000 hours.
* If [rotation_period][google.cloud.kms.v1.CryptoKey.rotation_period] is set, [next_rotation_time][google.cloud.kms.v1.CryptoKey.next_rotation_time] must also be set.
* Keys with [purpose][google.cloud.kms.v1.CryptoKey.purpose]
* [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT] support
* automatic rotation. For other keys, this field must be omitted.
* </pre>
*
* <code>.google.protobuf.Duration rotation_period = 8;</code>
*/
@java.lang.Override
public com.google.protobuf.DurationOrBuilder getRotationPeriodOrBuilder() {
if (rotationScheduleCase_ == 8) {
return (com.google.protobuf.Duration) rotationSchedule_;
}
return com.google.protobuf.Duration.getDefaultInstance();
}
public static final int VERSION_TEMPLATE_FIELD_NUMBER = 11;
private com.google.cloud.kms.v1.CryptoKeyVersionTemplate versionTemplate_;
/**
*
*
* <pre>
* A template describing settings for new [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] instances.
* The properties of new [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] instances created by either
* [CreateCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.CreateCryptoKeyVersion] or
* auto-rotation are controlled by this template.
* </pre>
*
* <code>.google.cloud.kms.v1.CryptoKeyVersionTemplate version_template = 11;</code>
*
* @return Whether the versionTemplate field is set.
*/
@java.lang.Override
public boolean hasVersionTemplate() {
return versionTemplate_ != null;
}
/**
*
*
* <pre>
* A template describing settings for new [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] instances.
* The properties of new [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] instances created by either
* [CreateCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.CreateCryptoKeyVersion] or
* auto-rotation are controlled by this template.
* </pre>
*
* <code>.google.cloud.kms.v1.CryptoKeyVersionTemplate version_template = 11;</code>
*
* @return The versionTemplate.
*/
@java.lang.Override
public com.google.cloud.kms.v1.CryptoKeyVersionTemplate getVersionTemplate() {
return versionTemplate_ == null
? com.google.cloud.kms.v1.CryptoKeyVersionTemplate.getDefaultInstance()
: versionTemplate_;
}
/**
*
*
* <pre>
* A template describing settings for new [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] instances.
* The properties of new [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] instances created by either
* [CreateCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.CreateCryptoKeyVersion] or
* auto-rotation are controlled by this template.
* </pre>
*
* <code>.google.cloud.kms.v1.CryptoKeyVersionTemplate version_template = 11;</code>
*/
@java.lang.Override
public com.google.cloud.kms.v1.CryptoKeyVersionTemplateOrBuilder getVersionTemplateOrBuilder() {
return getVersionTemplate();
}
public static final int LABELS_FIELD_NUMBER = 10;
private static final class LabelsDefaultEntryHolder {
static final com.google.protobuf.MapEntry<java.lang.String, java.lang.String> defaultEntry =
com.google.protobuf.MapEntry.<java.lang.String, java.lang.String>newDefaultInstance(
com.google.cloud.kms.v1.KmsResourcesProto
.internal_static_google_cloud_kms_v1_CryptoKey_LabelsEntry_descriptor,
com.google.protobuf.WireFormat.FieldType.STRING,
"",
com.google.protobuf.WireFormat.FieldType.STRING,
"");
}
private com.google.protobuf.MapField<java.lang.String, java.lang.String> labels_;
private com.google.protobuf.MapField<java.lang.String, java.lang.String> internalGetLabels() {
if (labels_ == null) {
return com.google.protobuf.MapField.emptyMapField(LabelsDefaultEntryHolder.defaultEntry);
}
return labels_;
}
public int getLabelsCount() {
return internalGetLabels().getMap().size();
}
/**
*
*
* <pre>
* Labels with user-defined metadata. For more information, see
* [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys).
* </pre>
*
* <code>map<string, string> labels = 10;</code>
*/
@java.lang.Override
public boolean containsLabels(java.lang.String key) {
if (key == null) {
throw new java.lang.NullPointerException();
}
return internalGetLabels().getMap().containsKey(key);
}
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Override
@java.lang.Deprecated
public java.util.Map<java.lang.String, java.lang.String> getLabels() {
return getLabelsMap();
}
/**
*
*
* <pre>
* Labels with user-defined metadata. For more information, see
* [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys).
* </pre>
*
* <code>map<string, string> labels = 10;</code>
*/
@java.lang.Override
public java.util.Map<java.lang.String, java.lang.String> getLabelsMap() {
return internalGetLabels().getMap();
}
/**
*
*
* <pre>
* Labels with user-defined metadata. For more information, see
* [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys).
* </pre>
*
* <code>map<string, string> labels = 10;</code>
*/
@java.lang.Override
public java.lang.String getLabelsOrDefault(java.lang.String key, java.lang.String defaultValue) {
if (key == null) {
throw new java.lang.NullPointerException();
}
java.util.Map<java.lang.String, java.lang.String> map = internalGetLabels().getMap();
return map.containsKey(key) ? map.get(key) : defaultValue;
}
/**
*
*
* <pre>
* Labels with user-defined metadata. For more information, see
* [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys).
* </pre>
*
* <code>map<string, string> labels = 10;</code>
*/
@java.lang.Override
public java.lang.String getLabelsOrThrow(java.lang.String key) {
if (key == null) {
throw new java.lang.NullPointerException();
}
java.util.Map<java.lang.String, java.lang.String> map = internalGetLabels().getMap();
if (!map.containsKey(key)) {
throw new java.lang.IllegalArgumentException();
}
return map.get(key);
}
private byte memoizedIsInitialized = -1;
@java.lang.Override
public final boolean isInitialized() {
byte isInitialized = memoizedIsInitialized;
if (isInitialized == 1) return true;
if (isInitialized == 0) return false;
memoizedIsInitialized = 1;
return true;
}
@java.lang.Override
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException {