google-cloud-certificate_manager-v1 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,832 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module CertificateManager
23
+ module V1
24
+ # Request for the `ListCertificates` method.
25
+ # @!attribute [rw] parent
26
+ # @return [::String]
27
+ # Required. The project and location from which the certificate should be listed,
28
+ # specified in the format `projects/*/locations/*`.
29
+ # @!attribute [rw] page_size
30
+ # @return [::Integer]
31
+ # Maximum number of certificates to return per call.
32
+ # @!attribute [rw] page_token
33
+ # @return [::String]
34
+ # The value returned by the last `ListCertificatesResponse`. Indicates that
35
+ # this is a continuation of a prior `ListCertificates` call, and that the
36
+ # system should return the next page of data.
37
+ # @!attribute [rw] filter
38
+ # @return [::String]
39
+ # Filter expression to restrict the Certificates returned.
40
+ # @!attribute [rw] order_by
41
+ # @return [::String]
42
+ # A list of Certificate field names used to specify the order of the returned
43
+ # results. The default sorting order is ascending. To specify descending
44
+ # order for a field, add a suffix " desc".
45
+ class ListCertificatesRequest
46
+ include ::Google::Protobuf::MessageExts
47
+ extend ::Google::Protobuf::MessageExts::ClassMethods
48
+ end
49
+
50
+ # Response for the `ListCertificates` method.
51
+ # @!attribute [rw] certificates
52
+ # @return [::Array<::Google::Cloud::CertificateManager::V1::Certificate>]
53
+ # A list of certificates for the parent resource.
54
+ # @!attribute [rw] next_page_token
55
+ # @return [::String]
56
+ # If there might be more results than those appearing in this response, then
57
+ # `next_page_token` is included. To get the next set of results, call this
58
+ # method again using the value of `next_page_token` as `page_token`.
59
+ # @!attribute [rw] unreachable
60
+ # @return [::Array<::String>]
61
+ # A list of locations that could not be reached.
62
+ class ListCertificatesResponse
63
+ include ::Google::Protobuf::MessageExts
64
+ extend ::Google::Protobuf::MessageExts::ClassMethods
65
+ end
66
+
67
+ # Request for the `GetCertificate` method.
68
+ # @!attribute [rw] name
69
+ # @return [::String]
70
+ # Required. A name of the certificate to describe. Must be in the format
71
+ # `projects/*/locations/*/certificates/*`.
72
+ class GetCertificateRequest
73
+ include ::Google::Protobuf::MessageExts
74
+ extend ::Google::Protobuf::MessageExts::ClassMethods
75
+ end
76
+
77
+ # Request for the `CreateCertificate` method.
78
+ # @!attribute [rw] parent
79
+ # @return [::String]
80
+ # Required. The parent resource of the certificate. Must be in the format
81
+ # `projects/*/locations/*`.
82
+ # @!attribute [rw] certificate_id
83
+ # @return [::String]
84
+ # Required. A user-provided name of the certificate.
85
+ # @!attribute [rw] certificate
86
+ # @return [::Google::Cloud::CertificateManager::V1::Certificate]
87
+ # Required. A definition of the certificate to create.
88
+ class CreateCertificateRequest
89
+ include ::Google::Protobuf::MessageExts
90
+ extend ::Google::Protobuf::MessageExts::ClassMethods
91
+ end
92
+
93
+ # Request for the `UpdateCertificate` method.
94
+ # @!attribute [rw] certificate
95
+ # @return [::Google::Cloud::CertificateManager::V1::Certificate]
96
+ # Required. A definition of the certificate to update.
97
+ # @!attribute [rw] update_mask
98
+ # @return [::Google::Protobuf::FieldMask]
99
+ # Required. The update mask applies to the resource. For the `FieldMask` definition,
100
+ # see
101
+ # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
102
+ class UpdateCertificateRequest
103
+ include ::Google::Protobuf::MessageExts
104
+ extend ::Google::Protobuf::MessageExts::ClassMethods
105
+ end
106
+
107
+ # Request for the `DeleteCertificate` method.
108
+ # @!attribute [rw] name
109
+ # @return [::String]
110
+ # Required. A name of the certificate to delete. Must be in the format
111
+ # `projects/*/locations/*/certificates/*`.
112
+ class DeleteCertificateRequest
113
+ include ::Google::Protobuf::MessageExts
114
+ extend ::Google::Protobuf::MessageExts::ClassMethods
115
+ end
116
+
117
+ # Request for the `ListCertificateMaps` method.
118
+ # @!attribute [rw] parent
119
+ # @return [::String]
120
+ # Required. The project and location from which the certificate maps should be listed,
121
+ # specified in the format `projects/*/locations/*`.
122
+ # @!attribute [rw] page_size
123
+ # @return [::Integer]
124
+ # Maximum number of certificate maps to return per call.
125
+ # @!attribute [rw] page_token
126
+ # @return [::String]
127
+ # The value returned by the last `ListCertificateMapsResponse`. Indicates
128
+ # that this is a continuation of a prior `ListCertificateMaps` call, and that
129
+ # the system should return the next page of data.
130
+ # @!attribute [rw] filter
131
+ # @return [::String]
132
+ # Filter expression to restrict the Certificates Maps returned.
133
+ # @!attribute [rw] order_by
134
+ # @return [::String]
135
+ # A list of Certificate Map field names used to specify the order of the
136
+ # returned results. The default sorting order is ascending. To specify
137
+ # descending order for a field, add a suffix " desc".
138
+ class ListCertificateMapsRequest
139
+ include ::Google::Protobuf::MessageExts
140
+ extend ::Google::Protobuf::MessageExts::ClassMethods
141
+ end
142
+
143
+ # Response for the `ListCertificateMaps` method.
144
+ # @!attribute [rw] certificate_maps
145
+ # @return [::Array<::Google::Cloud::CertificateManager::V1::CertificateMap>]
146
+ # A list of certificate maps for the parent resource.
147
+ # @!attribute [rw] next_page_token
148
+ # @return [::String]
149
+ # If there might be more results than those appearing in this response, then
150
+ # `next_page_token` is included. To get the next set of results, call this
151
+ # method again using the value of `next_page_token` as `page_token`.
152
+ # @!attribute [rw] unreachable
153
+ # @return [::Array<::String>]
154
+ # Locations that could not be reached.
155
+ class ListCertificateMapsResponse
156
+ include ::Google::Protobuf::MessageExts
157
+ extend ::Google::Protobuf::MessageExts::ClassMethods
158
+ end
159
+
160
+ # Request for the `GetCertificateMap` method.
161
+ # @!attribute [rw] name
162
+ # @return [::String]
163
+ # Required. A name of the certificate map to describe. Must be in the format
164
+ # `projects/*/locations/*/certificateMaps/*`.
165
+ class GetCertificateMapRequest
166
+ include ::Google::Protobuf::MessageExts
167
+ extend ::Google::Protobuf::MessageExts::ClassMethods
168
+ end
169
+
170
+ # Request for the `CreateCertificateMap` method.
171
+ # @!attribute [rw] parent
172
+ # @return [::String]
173
+ # Required. The parent resource of the certificate map. Must be in the format
174
+ # `projects/*/locations/*`.
175
+ # @!attribute [rw] certificate_map_id
176
+ # @return [::String]
177
+ # Required. A user-provided name of the certificate map.
178
+ # @!attribute [rw] certificate_map
179
+ # @return [::Google::Cloud::CertificateManager::V1::CertificateMap]
180
+ # Required. A definition of the certificate map to create.
181
+ class CreateCertificateMapRequest
182
+ include ::Google::Protobuf::MessageExts
183
+ extend ::Google::Protobuf::MessageExts::ClassMethods
184
+ end
185
+
186
+ # Request for the `UpdateCertificateMap` method.
187
+ # @!attribute [rw] certificate_map
188
+ # @return [::Google::Cloud::CertificateManager::V1::CertificateMap]
189
+ # Required. A definition of the certificate map to update.
190
+ # @!attribute [rw] update_mask
191
+ # @return [::Google::Protobuf::FieldMask]
192
+ # Required. The update mask applies to the resource. For the `FieldMask` definition,
193
+ # see
194
+ # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
195
+ class UpdateCertificateMapRequest
196
+ include ::Google::Protobuf::MessageExts
197
+ extend ::Google::Protobuf::MessageExts::ClassMethods
198
+ end
199
+
200
+ # Request for the `DeleteCertificateMap` method.
201
+ # @!attribute [rw] name
202
+ # @return [::String]
203
+ # Required. A name of the certificate map to delete. Must be in the format
204
+ # `projects/*/locations/*/certificateMaps/*`.
205
+ class DeleteCertificateMapRequest
206
+ include ::Google::Protobuf::MessageExts
207
+ extend ::Google::Protobuf::MessageExts::ClassMethods
208
+ end
209
+
210
+ # Request for the `ListCertificateMapEntries` method.
211
+ # @!attribute [rw] parent
212
+ # @return [::String]
213
+ # Required. The project, location and certificate map from which the certificate map
214
+ # entries should be listed, specified in the format
215
+ # `projects/*/locations/*/certificateMaps/*`.
216
+ # @!attribute [rw] page_size
217
+ # @return [::Integer]
218
+ # Maximum number of certificate map entries to return. The service may return
219
+ # fewer than this value.
220
+ # If unspecified, at most 50 certificate map entries will be returned.
221
+ # The maximum value is 1000; values above 1000 will be coerced to 1000.
222
+ # @!attribute [rw] page_token
223
+ # @return [::String]
224
+ # The value returned by the last `ListCertificateMapEntriesResponse`.
225
+ # Indicates that this is a continuation of a prior
226
+ # `ListCertificateMapEntries` call, and that the system should return the
227
+ # next page of data.
228
+ # @!attribute [rw] filter
229
+ # @return [::String]
230
+ # Filter expression to restrict the returned Certificate Map Entries.
231
+ # @!attribute [rw] order_by
232
+ # @return [::String]
233
+ # A list of Certificate Map Entry field names used to specify
234
+ # the order of the returned results. The default sorting order is ascending.
235
+ # To specify descending order for a field, add a suffix " desc".
236
+ class ListCertificateMapEntriesRequest
237
+ include ::Google::Protobuf::MessageExts
238
+ extend ::Google::Protobuf::MessageExts::ClassMethods
239
+ end
240
+
241
+ # Response for the `ListCertificateMapEntries` method.
242
+ # @!attribute [rw] certificate_map_entries
243
+ # @return [::Array<::Google::Cloud::CertificateManager::V1::CertificateMapEntry>]
244
+ # A list of certificate map entries for the parent resource.
245
+ # @!attribute [rw] next_page_token
246
+ # @return [::String]
247
+ # If there might be more results than those appearing in this response, then
248
+ # `next_page_token` is included. To get the next set of results, call this
249
+ # method again using the value of `next_page_token` as `page_token`.
250
+ # @!attribute [rw] unreachable
251
+ # @return [::Array<::String>]
252
+ # Locations that could not be reached.
253
+ class ListCertificateMapEntriesResponse
254
+ include ::Google::Protobuf::MessageExts
255
+ extend ::Google::Protobuf::MessageExts::ClassMethods
256
+ end
257
+
258
+ # Request for the `GetCertificateMapEntry` method.
259
+ # @!attribute [rw] name
260
+ # @return [::String]
261
+ # Required. A name of the certificate map entry to describe. Must be in the
262
+ # format `projects/*/locations/*/certificateMaps/*/certificateMapEntries/*`.
263
+ class GetCertificateMapEntryRequest
264
+ include ::Google::Protobuf::MessageExts
265
+ extend ::Google::Protobuf::MessageExts::ClassMethods
266
+ end
267
+
268
+ # Request for the `CreateCertificateMapEntry` method.
269
+ # @!attribute [rw] parent
270
+ # @return [::String]
271
+ # Required. The parent resource of the certificate map entry. Must be in the
272
+ # format `projects/*/locations/*/certificateMaps/*`.
273
+ # @!attribute [rw] certificate_map_entry_id
274
+ # @return [::String]
275
+ # Required. A user-provided name of the certificate map entry.
276
+ # @!attribute [rw] certificate_map_entry
277
+ # @return [::Google::Cloud::CertificateManager::V1::CertificateMapEntry]
278
+ # Required. A definition of the certificate map entry to create.
279
+ class CreateCertificateMapEntryRequest
280
+ include ::Google::Protobuf::MessageExts
281
+ extend ::Google::Protobuf::MessageExts::ClassMethods
282
+ end
283
+
284
+ # Request for the `UpdateCertificateMapEntry` method.
285
+ # @!attribute [rw] certificate_map_entry
286
+ # @return [::Google::Cloud::CertificateManager::V1::CertificateMapEntry]
287
+ # Required. A definition of the certificate map entry to create map entry.
288
+ # @!attribute [rw] update_mask
289
+ # @return [::Google::Protobuf::FieldMask]
290
+ # Required. The update mask applies to the resource. For the `FieldMask` definition,
291
+ # see
292
+ # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
293
+ class UpdateCertificateMapEntryRequest
294
+ include ::Google::Protobuf::MessageExts
295
+ extend ::Google::Protobuf::MessageExts::ClassMethods
296
+ end
297
+
298
+ # Request for the `DeleteCertificateMapEntry` method.
299
+ # @!attribute [rw] name
300
+ # @return [::String]
301
+ # Required. A name of the certificate map entry to delete. Must be in the format
302
+ # `projects/*/locations/*/certificateMaps/*/certificateMapEntries/*`.
303
+ class DeleteCertificateMapEntryRequest
304
+ include ::Google::Protobuf::MessageExts
305
+ extend ::Google::Protobuf::MessageExts::ClassMethods
306
+ end
307
+
308
+ # Request for the `ListDnsAuthorizations` method.
309
+ # @!attribute [rw] parent
310
+ # @return [::String]
311
+ # Required. The project and location from which the dns authorizations should be
312
+ # listed, specified in the format `projects/*/locations/*`.
313
+ # @!attribute [rw] page_size
314
+ # @return [::Integer]
315
+ # Maximum number of dns authorizations to return per call.
316
+ # @!attribute [rw] page_token
317
+ # @return [::String]
318
+ # The value returned by the last `ListDnsAuthorizationsResponse`. Indicates
319
+ # that this is a continuation of a prior `ListDnsAuthorizations` call, and
320
+ # that the system should return the next page of data.
321
+ # @!attribute [rw] filter
322
+ # @return [::String]
323
+ # Filter expression to restrict the Dns Authorizations returned.
324
+ # @!attribute [rw] order_by
325
+ # @return [::String]
326
+ # A list of Dns Authorization field names used to specify the order of the
327
+ # returned results. The default sorting order is ascending. To specify
328
+ # descending order for a field, add a suffix " desc".
329
+ class ListDnsAuthorizationsRequest
330
+ include ::Google::Protobuf::MessageExts
331
+ extend ::Google::Protobuf::MessageExts::ClassMethods
332
+ end
333
+
334
+ # Response for the `ListDnsAuthorizations` method.
335
+ # @!attribute [rw] dns_authorizations
336
+ # @return [::Array<::Google::Cloud::CertificateManager::V1::DnsAuthorization>]
337
+ # A list of dns authorizations for the parent resource.
338
+ # @!attribute [rw] next_page_token
339
+ # @return [::String]
340
+ # If there might be more results than those appearing in this response, then
341
+ # `next_page_token` is included. To get the next set of results, call this
342
+ # method again using the value of `next_page_token` as `page_token`.
343
+ # @!attribute [rw] unreachable
344
+ # @return [::Array<::String>]
345
+ # Locations that could not be reached.
346
+ class ListDnsAuthorizationsResponse
347
+ include ::Google::Protobuf::MessageExts
348
+ extend ::Google::Protobuf::MessageExts::ClassMethods
349
+ end
350
+
351
+ # Request for the `GetDnsAuthorization` method.
352
+ # @!attribute [rw] name
353
+ # @return [::String]
354
+ # Required. A name of the dns authorization to describe. Must be in the format
355
+ # `projects/*/locations/*/dnsAuthorizations/*`.
356
+ class GetDnsAuthorizationRequest
357
+ include ::Google::Protobuf::MessageExts
358
+ extend ::Google::Protobuf::MessageExts::ClassMethods
359
+ end
360
+
361
+ # Request for the `CreateDnsAuthorization` method.
362
+ # @!attribute [rw] parent
363
+ # @return [::String]
364
+ # Required. The parent resource of the dns authorization. Must be in the format
365
+ # `projects/*/locations/*`.
366
+ # @!attribute [rw] dns_authorization_id
367
+ # @return [::String]
368
+ # Required. A user-provided name of the dns authorization.
369
+ # @!attribute [rw] dns_authorization
370
+ # @return [::Google::Cloud::CertificateManager::V1::DnsAuthorization]
371
+ # Required. A definition of the dns authorization to create.
372
+ class CreateDnsAuthorizationRequest
373
+ include ::Google::Protobuf::MessageExts
374
+ extend ::Google::Protobuf::MessageExts::ClassMethods
375
+ end
376
+
377
+ # Request for the `UpdateDnsAuthorization` method.
378
+ # @!attribute [rw] dns_authorization
379
+ # @return [::Google::Cloud::CertificateManager::V1::DnsAuthorization]
380
+ # Required. A definition of the dns authorization to update.
381
+ # @!attribute [rw] update_mask
382
+ # @return [::Google::Protobuf::FieldMask]
383
+ # Required. The update mask applies to the resource. For the `FieldMask` definition,
384
+ # see
385
+ # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
386
+ class UpdateDnsAuthorizationRequest
387
+ include ::Google::Protobuf::MessageExts
388
+ extend ::Google::Protobuf::MessageExts::ClassMethods
389
+ end
390
+
391
+ # Request for the `DeleteDnsAuthorization` method.
392
+ # @!attribute [rw] name
393
+ # @return [::String]
394
+ # Required. A name of the dns authorization to delete. Must be in the format
395
+ # `projects/*/locations/*/dnsAuthorizations/*`.
396
+ class DeleteDnsAuthorizationRequest
397
+ include ::Google::Protobuf::MessageExts
398
+ extend ::Google::Protobuf::MessageExts::ClassMethods
399
+ end
400
+
401
+ # Represents the metadata of the long-running operation. Output only.
402
+ # @!attribute [rw] create_time
403
+ # @return [::Google::Protobuf::Timestamp]
404
+ # The time the operation was created.
405
+ # @!attribute [rw] end_time
406
+ # @return [::Google::Protobuf::Timestamp]
407
+ # The time the operation finished running.
408
+ # @!attribute [rw] target
409
+ # @return [::String]
410
+ # Server-defined resource path for the target of the operation.
411
+ # @!attribute [rw] verb
412
+ # @return [::String]
413
+ # Name of the verb executed by the operation.
414
+ # @!attribute [rw] status_message
415
+ # @return [::String]
416
+ # Human-readable status of the operation, if any.
417
+ # @!attribute [rw] requested_cancellation
418
+ # @return [::Boolean]
419
+ # Identifies whether the user has requested cancellation
420
+ # of the operation. Operations that have successfully been cancelled
421
+ # have [Operation.error][] value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
422
+ # corresponding to `Code.CANCELLED`.
423
+ # @!attribute [rw] api_version
424
+ # @return [::String]
425
+ # API version used to start the operation.
426
+ class OperationMetadata
427
+ include ::Google::Protobuf::MessageExts
428
+ extend ::Google::Protobuf::MessageExts::ClassMethods
429
+ end
430
+
431
+ # Defines TLS certificate.
432
+ # @!attribute [rw] name
433
+ # @return [::String]
434
+ # A user-defined name of the certificate. Certificate names must be unique
435
+ # globally and match pattern `projects/*/locations/*/certificates/*`.
436
+ # @!attribute [rw] description
437
+ # @return [::String]
438
+ # One or more paragraphs of text description of a certificate.
439
+ # @!attribute [r] create_time
440
+ # @return [::Google::Protobuf::Timestamp]
441
+ # Output only. The creation timestamp of a Certificate.
442
+ # @!attribute [r] update_time
443
+ # @return [::Google::Protobuf::Timestamp]
444
+ # Output only. The last update timestamp of a Certificate.
445
+ # @!attribute [rw] labels
446
+ # @return [::Google::Protobuf::Map{::String => ::String}]
447
+ # Set of labels associated with a Certificate.
448
+ # @!attribute [rw] self_managed
449
+ # @return [::Google::Cloud::CertificateManager::V1::Certificate::SelfManagedCertificate]
450
+ # If set, defines data of a self-managed certificate.
451
+ # @!attribute [rw] managed
452
+ # @return [::Google::Cloud::CertificateManager::V1::Certificate::ManagedCertificate]
453
+ # If set, contains configuration and state of a managed certificate.
454
+ # @!attribute [r] san_dnsnames
455
+ # @return [::Array<::String>]
456
+ # Output only. The list of Subject Alternative Names of dnsName type defined in the
457
+ # certificate (see RFC 5280 4.2.1.6).
458
+ # Managed certificates that haven't been provisioned yet have this field
459
+ # populated with a value of the managed.domains field.
460
+ # @!attribute [r] pem_certificate
461
+ # @return [::String]
462
+ # Output only. The PEM-encoded certificate chain.
463
+ # @!attribute [r] expire_time
464
+ # @return [::Google::Protobuf::Timestamp]
465
+ # Output only. The expiry timestamp of a Certificate.
466
+ # @!attribute [rw] scope
467
+ # @return [::Google::Cloud::CertificateManager::V1::Certificate::Scope]
468
+ # Immutable. The scope of the certificate.
469
+ class Certificate
470
+ include ::Google::Protobuf::MessageExts
471
+ extend ::Google::Protobuf::MessageExts::ClassMethods
472
+
473
+ # Certificate data for a SelfManaged Certificate.
474
+ # SelfManaged Certificates are uploaded by the user. Updating such
475
+ # certificates before they expire remains the user's responsibility.
476
+ # @!attribute [rw] pem_certificate
477
+ # @return [::String]
478
+ # Input only. The PEM-encoded certificate chain.
479
+ # Leaf certificate comes first, followed by intermediate ones if any.
480
+ # @!attribute [rw] pem_private_key
481
+ # @return [::String]
482
+ # Input only. The PEM-encoded private key of the leaf certificate.
483
+ class SelfManagedCertificate
484
+ include ::Google::Protobuf::MessageExts
485
+ extend ::Google::Protobuf::MessageExts::ClassMethods
486
+ end
487
+
488
+ # Configuration and state of a Managed Certificate.
489
+ # Certificate Manager provisions and renews Managed Certificates
490
+ # automatically, for as long as it's authorized to do so.
491
+ # @!attribute [rw] domains
492
+ # @return [::Array<::String>]
493
+ # Immutable. The domains for which a managed SSL certificate will be generated.
494
+ # Wildcard domains are only supported with DNS challenge resolution.
495
+ # @!attribute [rw] dns_authorizations
496
+ # @return [::Array<::String>]
497
+ # Immutable. Authorizations that will be used for performing domain authorization.
498
+ # @!attribute [r] state
499
+ # @return [::Google::Cloud::CertificateManager::V1::Certificate::ManagedCertificate::State]
500
+ # Output only. State of the managed certificate resource.
501
+ # @!attribute [rw] provisioning_issue
502
+ # @return [::Google::Cloud::CertificateManager::V1::Certificate::ManagedCertificate::ProvisioningIssue]
503
+ # Information about issues with provisioning a Managed Certificate.
504
+ # @!attribute [r] authorization_attempt_info
505
+ # @return [::Array<::Google::Cloud::CertificateManager::V1::Certificate::ManagedCertificate::AuthorizationAttemptInfo>]
506
+ # Output only. Detailed state of the latest authorization attempt for each domain
507
+ # specified for managed certificate resource.
508
+ class ManagedCertificate
509
+ include ::Google::Protobuf::MessageExts
510
+ extend ::Google::Protobuf::MessageExts::ClassMethods
511
+
512
+ # Information about issues with provisioning a Managed Certificate.
513
+ # @!attribute [rw] reason
514
+ # @return [::Google::Cloud::CertificateManager::V1::Certificate::ManagedCertificate::ProvisioningIssue::Reason]
515
+ # Reason for provisioning failures.
516
+ # @!attribute [rw] details
517
+ # @return [::String]
518
+ # Human readable explanation about the issue. Provided to help address
519
+ # the configuration issues.
520
+ # Not guaranteed to be stable. For programmatic access use Reason enum.
521
+ class ProvisioningIssue
522
+ include ::Google::Protobuf::MessageExts
523
+ extend ::Google::Protobuf::MessageExts::ClassMethods
524
+
525
+ module Reason
526
+ REASON_UNSPECIFIED = 0
527
+
528
+ # Certificate provisioning failed due to an issue with one or more of
529
+ # the domains on the certificate.
530
+ # For details of which domains failed, consult the
531
+ # `authorization_attempt_info` field.
532
+ AUTHORIZATION_ISSUE = 1
533
+
534
+ # Exceeded Certificate Authority quotas or internal rate limits of the
535
+ # system. Provisioning may take longer to complete.
536
+ RATE_LIMITED = 2
537
+ end
538
+ end
539
+
540
+ # State of the latest attempt to authorize a domain for certificate
541
+ # issuance.
542
+ # @!attribute [rw] domain
543
+ # @return [::String]
544
+ # Domain name of the authorization attempt.
545
+ # @!attribute [rw] state
546
+ # @return [::Google::Cloud::CertificateManager::V1::Certificate::ManagedCertificate::AuthorizationAttemptInfo::State]
547
+ # State of the domain for managed certificate issuance.
548
+ # @!attribute [r] failure_reason
549
+ # @return [::Google::Cloud::CertificateManager::V1::Certificate::ManagedCertificate::AuthorizationAttemptInfo::FailureReason]
550
+ # Output only. Reason for failure of the authorization attempt for the domain.
551
+ # @!attribute [rw] details
552
+ # @return [::String]
553
+ # Human readable explanation for reaching the state. Provided to help
554
+ # address the configuration issues.
555
+ # Not guaranteed to be stable. For programmatic access use Reason enum.
556
+ class AuthorizationAttemptInfo
557
+ include ::Google::Protobuf::MessageExts
558
+ extend ::Google::Protobuf::MessageExts::ClassMethods
559
+
560
+ module State
561
+ STATE_UNSPECIFIED = 0
562
+
563
+ # Certificate provisioning for this domain is under way. GCP will
564
+ # attempt to authorize the domain.
565
+ AUTHORIZING = 1
566
+
567
+ # A managed certificate can be provisioned, no issues for this domain.
568
+ AUTHORIZED = 6
569
+
570
+ # Attempt to authorize the domain failed. This prevents the Managed
571
+ # Certificate from being issued.
572
+ # See `failure_reason` and `details` fields for more information.
573
+ FAILED = 7
574
+ end
575
+
576
+ module FailureReason
577
+ FAILURE_REASON_UNSPECIFIED = 0
578
+
579
+ # There was a problem with the user's DNS or load balancer
580
+ # configuration for this domain.
581
+ CONFIG = 1
582
+
583
+ # Certificate issuance forbidden by an explicit CAA record for the
584
+ # domain or a failure to check CAA records for the domain.
585
+ CAA = 2
586
+
587
+ # Reached a CA or internal rate-limit for the domain,
588
+ # e.g. for certificates per top-level private domain.
589
+ RATE_LIMITED = 3
590
+ end
591
+ end
592
+
593
+ module State
594
+ STATE_UNSPECIFIED = 0
595
+
596
+ # Certificate Manager attempts to provision or renew the certificate.
597
+ # If the process takes longer than expected, consult the
598
+ # `provisioning_issue` field.
599
+ PROVISIONING = 1
600
+
601
+ # Multiple certificate provisioning attempts failed and Certificate
602
+ # Manager gave up. To try again, delete and create a new managed
603
+ # Certificate resource.
604
+ # For details see the `provisioning_issue` field.
605
+ FAILED = 2
606
+
607
+ # The certificate management is working, and a certificate has been
608
+ # provisioned.
609
+ ACTIVE = 3
610
+ end
611
+ end
612
+
613
+ # @!attribute [rw] key
614
+ # @return [::String]
615
+ # @!attribute [rw] value
616
+ # @return [::String]
617
+ class LabelsEntry
618
+ include ::Google::Protobuf::MessageExts
619
+ extend ::Google::Protobuf::MessageExts::ClassMethods
620
+ end
621
+
622
+ # Certificate scope.
623
+ module Scope
624
+ # Certificates with default scope are served from core Google data centers.
625
+ # If unsure, choose this option.
626
+ DEFAULT = 0
627
+
628
+ # Certificates with scope EDGE_CACHE are special-purposed certificates,
629
+ # served from non-core Google data centers.
630
+ EDGE_CACHE = 1
631
+ end
632
+ end
633
+
634
+ # Defines a collection of certificate configurations.
635
+ # @!attribute [rw] name
636
+ # @return [::String]
637
+ # A user-defined name of the Certificate Map. Certificate Map names must be
638
+ # unique globally and match pattern
639
+ # `projects/*/locations/*/certificateMaps/*`.
640
+ # @!attribute [rw] description
641
+ # @return [::String]
642
+ # One or more paragraphs of text description of a certificate map.
643
+ # @!attribute [r] create_time
644
+ # @return [::Google::Protobuf::Timestamp]
645
+ # Output only. The creation timestamp of a Certificate Map.
646
+ # @!attribute [r] update_time
647
+ # @return [::Google::Protobuf::Timestamp]
648
+ # Output only. The update timestamp of a Certificate Map.
649
+ # @!attribute [rw] labels
650
+ # @return [::Google::Protobuf::Map{::String => ::String}]
651
+ # Set of labels associated with a Certificate Map.
652
+ # @!attribute [r] gclb_targets
653
+ # @return [::Array<::Google::Cloud::CertificateManager::V1::CertificateMap::GclbTarget>]
654
+ # Output only. A list of GCLB targets which use this Certificate Map.
655
+ class CertificateMap
656
+ include ::Google::Protobuf::MessageExts
657
+ extend ::Google::Protobuf::MessageExts::ClassMethods
658
+
659
+ # Describes a Target Proxy which uses this Certificate Map.
660
+ # @!attribute [rw] target_https_proxy
661
+ # @return [::String]
662
+ # A name must be in the format
663
+ # `projects/*/locations/*/targetHttpsProxies/*`.
664
+ # @!attribute [rw] target_ssl_proxy
665
+ # @return [::String]
666
+ # A name must be in the format
667
+ # `projects/*/locations/*/targetSslProxies/*`.
668
+ # @!attribute [rw] ip_configs
669
+ # @return [::Array<::Google::Cloud::CertificateManager::V1::CertificateMap::GclbTarget::IpConfig>]
670
+ # IP configurations for this Target Proxy where the
671
+ # Certificate Map is serving.
672
+ class GclbTarget
673
+ include ::Google::Protobuf::MessageExts
674
+ extend ::Google::Protobuf::MessageExts::ClassMethods
675
+
676
+ # Defines IP configuration where this Certificate Map is serving.
677
+ # @!attribute [rw] ip_address
678
+ # @return [::String]
679
+ # An external IP address.
680
+ # @!attribute [rw] ports
681
+ # @return [::Array<::Integer>]
682
+ # Ports.
683
+ class IpConfig
684
+ include ::Google::Protobuf::MessageExts
685
+ extend ::Google::Protobuf::MessageExts::ClassMethods
686
+ end
687
+ end
688
+
689
+ # @!attribute [rw] key
690
+ # @return [::String]
691
+ # @!attribute [rw] value
692
+ # @return [::String]
693
+ class LabelsEntry
694
+ include ::Google::Protobuf::MessageExts
695
+ extend ::Google::Protobuf::MessageExts::ClassMethods
696
+ end
697
+ end
698
+
699
+ # Defines a certificate map entry.
700
+ # @!attribute [rw] name
701
+ # @return [::String]
702
+ # A user-defined name of the Certificate Map Entry. Certificate Map Entry
703
+ # names must be unique globally and match pattern
704
+ # `projects/*/locations/*/certificateMaps/*/certificateMapEntries/*`.
705
+ # @!attribute [rw] description
706
+ # @return [::String]
707
+ # One or more paragraphs of text description of a certificate map entry.
708
+ # @!attribute [r] create_time
709
+ # @return [::Google::Protobuf::Timestamp]
710
+ # Output only. The creation timestamp of a Certificate Map Entry.
711
+ # @!attribute [r] update_time
712
+ # @return [::Google::Protobuf::Timestamp]
713
+ # Output only. The update timestamp of a Certificate Map Entry.
714
+ # @!attribute [rw] labels
715
+ # @return [::Google::Protobuf::Map{::String => ::String}]
716
+ # Set of labels associated with a Certificate Map Entry.
717
+ # @!attribute [rw] hostname
718
+ # @return [::String]
719
+ # A Hostname (FQDN, e.g. `example.com`) or a wildcard hostname expression
720
+ # (`*.example.com`) for a set of hostnames with common suffix. Used as
721
+ # Server Name Indication (SNI) for selecting a proper certificate.
722
+ # @!attribute [rw] matcher
723
+ # @return [::Google::Cloud::CertificateManager::V1::CertificateMapEntry::Matcher]
724
+ # A predefined matcher for particular cases, other than SNI selection.
725
+ # @!attribute [rw] certificates
726
+ # @return [::Array<::String>]
727
+ # A set of Certificates defines for the given `hostname`. There can be
728
+ # defined up to fifteen certificates in each Certificate Map Entry. Each
729
+ # certificate must match pattern `projects/*/locations/*/certificates/*`.
730
+ # @!attribute [r] state
731
+ # @return [::Google::Cloud::CertificateManager::V1::ServingState]
732
+ # Output only. A serving state of this Certificate Map Entry.
733
+ class CertificateMapEntry
734
+ include ::Google::Protobuf::MessageExts
735
+ extend ::Google::Protobuf::MessageExts::ClassMethods
736
+
737
+ # @!attribute [rw] key
738
+ # @return [::String]
739
+ # @!attribute [rw] value
740
+ # @return [::String]
741
+ class LabelsEntry
742
+ include ::Google::Protobuf::MessageExts
743
+ extend ::Google::Protobuf::MessageExts::ClassMethods
744
+ end
745
+
746
+ # Defines predefined cases other than SNI-hostname match when this
747
+ # configuration should be applied.
748
+ module Matcher
749
+ # A matcher has't been recognized.
750
+ MATCHER_UNSPECIFIED = 0
751
+
752
+ # A primary certificate that is served when SNI wasn't specified in the
753
+ # request or SNI couldn't be found in the map.
754
+ PRIMARY = 1
755
+ end
756
+ end
757
+
758
+ # A DnsAuthorization resource describes a way to perform domain authorization
759
+ # for certificate issuance.
760
+ # @!attribute [rw] name
761
+ # @return [::String]
762
+ # A user-defined name of the dns authorization. DnsAuthorization names must
763
+ # be unique globally and match pattern
764
+ # `projects/*/locations/*/dnsAuthorizations/*`.
765
+ # @!attribute [r] create_time
766
+ # @return [::Google::Protobuf::Timestamp]
767
+ # Output only. The creation timestamp of a DnsAuthorization.
768
+ # @!attribute [r] update_time
769
+ # @return [::Google::Protobuf::Timestamp]
770
+ # Output only. The last update timestamp of a DnsAuthorization.
771
+ # @!attribute [rw] labels
772
+ # @return [::Google::Protobuf::Map{::String => ::String}]
773
+ # Set of labels associated with a DnsAuthorization.
774
+ # @!attribute [rw] description
775
+ # @return [::String]
776
+ # One or more paragraphs of text description of a DnsAuthorization.
777
+ # @!attribute [rw] domain
778
+ # @return [::String]
779
+ # Required. Immutable. A domain which is being authorized. A DnsAuthorization resource covers a
780
+ # single domain and its wildcard, e.g. authorization for `example.com` can
781
+ # be used to issue certificates for `example.com` and `*.example.com`.
782
+ # @!attribute [r] dns_resource_record
783
+ # @return [::Google::Cloud::CertificateManager::V1::DnsAuthorization::DnsResourceRecord]
784
+ # Output only. DNS Resource Record that needs to be added to DNS configuration.
785
+ class DnsAuthorization
786
+ include ::Google::Protobuf::MessageExts
787
+ extend ::Google::Protobuf::MessageExts::ClassMethods
788
+
789
+ # The structure describing the DNS Resource Record that needs to be added
790
+ # to DNS configuration for the authorization to be usable by
791
+ # certificate.
792
+ # @!attribute [r] name
793
+ # @return [::String]
794
+ # Output only. Fully qualified name of the DNS Resource Record.
795
+ # e.g. `_acme-challenge.example.com`
796
+ # @!attribute [r] type
797
+ # @return [::String]
798
+ # Output only. Type of the DNS Resource Record.
799
+ # Currently always set to "CNAME".
800
+ # @!attribute [r] data
801
+ # @return [::String]
802
+ # Output only. Data of the DNS Resource Record.
803
+ class DnsResourceRecord
804
+ include ::Google::Protobuf::MessageExts
805
+ extend ::Google::Protobuf::MessageExts::ClassMethods
806
+ end
807
+
808
+ # @!attribute [rw] key
809
+ # @return [::String]
810
+ # @!attribute [rw] value
811
+ # @return [::String]
812
+ class LabelsEntry
813
+ include ::Google::Protobuf::MessageExts
814
+ extend ::Google::Protobuf::MessageExts::ClassMethods
815
+ end
816
+ end
817
+
818
+ # Defines set of serving states associated with a resource.
819
+ module ServingState
820
+ # The status is undefined.
821
+ SERVING_STATE_UNSPECIFIED = 0
822
+
823
+ # The configuration is serving.
824
+ ACTIVE = 1
825
+
826
+ # Update is in progress. Some frontends may serve this configuration.
827
+ PENDING = 2
828
+ end
829
+ end
830
+ end
831
+ end
832
+ end