This repository has been archived by the owner on Oct 2, 2023. It is now read-only.
/
CryptoKeyOrBuilder.java
401 lines (390 loc) · 15.1 KB
/
CryptoKeyOrBuilder.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
/*
* 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;
public interface CryptoKeyOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.kms.v1.CryptoKey)
com.google.protobuf.MessageOrBuilder {
/**
*
*
* <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.String getName();
/**
*
*
* <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.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
* <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.
*/
boolean hasPrimary();
/**
*
*
* <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.
*/
com.google.cloud.kms.v1.CryptoKeyVersion getPrimary();
/**
*
*
* <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>
*/
com.google.cloud.kms.v1.CryptoKeyVersionOrBuilder getPrimaryOrBuilder();
/**
*
*
* <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.
*/
int getPurposeValue();
/**
*
*
* <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.
*/
com.google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose getPurpose();
/**
*
*
* <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.
*/
boolean hasCreateTime();
/**
*
*
* <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.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
* <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>
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
* <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.
*/
boolean hasNextRotationTime();
/**
*
*
* <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.
*/
com.google.protobuf.Timestamp getNextRotationTime();
/**
*
*
* <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>
*/
com.google.protobuf.TimestampOrBuilder getNextRotationTimeOrBuilder();
/**
*
*
* <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.
*/
boolean hasRotationPeriod();
/**
*
*
* <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.
*/
com.google.protobuf.Duration getRotationPeriod();
/**
*
*
* <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>
*/
com.google.protobuf.DurationOrBuilder getRotationPeriodOrBuilder();
/**
*
*
* <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.
*/
boolean hasVersionTemplate();
/**
*
*
* <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.
*/
com.google.cloud.kms.v1.CryptoKeyVersionTemplate getVersionTemplate();
/**
*
*
* <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>
*/
com.google.cloud.kms.v1.CryptoKeyVersionTemplateOrBuilder getVersionTemplateOrBuilder();
/**
*
*
* <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>
*/
int getLabelsCount();
/**
*
*
* <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>
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map<java.lang.String, java.lang.String> getLabels();
/**
*
*
* <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.util.Map<java.lang.String, java.lang.String> 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.String getLabelsOrDefault(java.lang.String key, java.lang.String 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.String getLabelsOrThrow(java.lang.String key);
public com.google.cloud.kms.v1.CryptoKey.RotationScheduleCase getRotationScheduleCase();
}