/
certificate_manager.proto
1271 lines (1084 loc) · 46.7 KB
/
certificate_manager.proto
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 2023 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
//
// http://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.
syntax = "proto3";
package google.cloud.certificatemanager.v1;
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/cloud/certificatemanager/v1/certificate_issuance_config.proto";
import "google/cloud/certificatemanager/v1/trust_config.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.CertificateManager.V1";
option go_package = "cloud.google.com/go/certificatemanager/apiv1/certificatemanagerpb;certificatemanagerpb";
option java_multiple_files = true;
option java_outer_classname = "CertificateManagerProto";
option java_package = "com.google.cloud.certificatemanager.v1";
option php_namespace = "Google\\Cloud\\CertificateManager\\V1";
option ruby_package = "Google::Cloud::CertificateManager::V1";
// API Overview
//
// Certificates Manager API allows customers to see and manage all their TLS
// certificates.
//
// Certificates Manager API service provides methods to manage certificates,
// group them into collections, and create serving configuration that can be
// easily applied to other Cloud resources e.g. Target Proxies.
//
// Data Model
//
// The Certificates Manager service exposes the following resources:
//
// * `Certificate` that describes a single TLS certificate.
// * `CertificateMap` that describes a collection of certificates that can be
// attached to a target resource.
// * `CertificateMapEntry` that describes a single configuration entry that
// consists of a SNI and a group of certificates. It's a subresource of
// CertificateMap.
//
// Certificate, CertificateMap and CertificateMapEntry IDs
// have to fully match the regexp `[a-z0-9-]{1,63}`. In other words,
// - only lower case letters, digits, and hyphen are allowed
// - length of the resource ID has to be in [1,63] range.
//
// Provides methods to manage Cloud Certificate Manager entities.
service CertificateManager {
option (google.api.default_host) = "certificatemanager.googleapis.com";
option (google.api.oauth_scopes) =
"https://www.googleapis.com/auth/cloud-platform";
// Lists Certificates in a given project and location.
rpc ListCertificates(ListCertificatesRequest)
returns (ListCertificatesResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/certificates"
};
option (google.api.method_signature) = "parent";
}
// Gets details of a single Certificate.
rpc GetCertificate(GetCertificateRequest) returns (Certificate) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/certificates/*}"
};
option (google.api.method_signature) = "name";
}
// Creates a new Certificate in a given project and location.
rpc CreateCertificate(CreateCertificateRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/certificates"
body: "certificate"
};
option (google.api.method_signature) = "parent,certificate,certificate_id";
option (google.longrunning.operation_info) = {
response_type: "Certificate"
metadata_type: "OperationMetadata"
};
}
// Updates a Certificate.
rpc UpdateCertificate(UpdateCertificateRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
patch: "/v1/{certificate.name=projects/*/locations/*/certificates/*}"
body: "certificate"
};
option (google.api.method_signature) = "certificate,update_mask";
option (google.longrunning.operation_info) = {
response_type: "Certificate"
metadata_type: "OperationMetadata"
};
}
// Deletes a single Certificate.
rpc DeleteCertificate(DeleteCertificateRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/certificates/*}"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "OperationMetadata"
};
}
// Lists CertificateMaps in a given project and location.
rpc ListCertificateMaps(ListCertificateMapsRequest)
returns (ListCertificateMapsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/certificateMaps"
};
option (google.api.method_signature) = "parent";
}
// Gets details of a single CertificateMap.
rpc GetCertificateMap(GetCertificateMapRequest) returns (CertificateMap) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/certificateMaps/*}"
};
option (google.api.method_signature) = "name";
}
// Creates a new CertificateMap in a given project and location.
rpc CreateCertificateMap(CreateCertificateMapRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/certificateMaps"
body: "certificate_map"
};
option (google.api.method_signature) =
"parent,certificate_map,certificate_map_id";
option (google.longrunning.operation_info) = {
response_type: "CertificateMap"
metadata_type: "OperationMetadata"
};
}
// Updates a CertificateMap.
rpc UpdateCertificateMap(UpdateCertificateMapRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
patch: "/v1/{certificate_map.name=projects/*/locations/*/certificateMaps/*}"
body: "certificate_map"
};
option (google.api.method_signature) = "certificate_map,update_mask";
option (google.longrunning.operation_info) = {
response_type: "CertificateMap"
metadata_type: "OperationMetadata"
};
}
// Deletes a single CertificateMap. A Certificate Map can't be deleted
// if it contains Certificate Map Entries. Remove all the entries from
// the map before calling this method.
rpc DeleteCertificateMap(DeleteCertificateMapRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/certificateMaps/*}"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "OperationMetadata"
};
}
// Lists CertificateMapEntries in a given project and location.
rpc ListCertificateMapEntries(ListCertificateMapEntriesRequest)
returns (ListCertificateMapEntriesResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/certificateMaps/*}/certificateMapEntries"
};
option (google.api.method_signature) = "parent";
}
// Gets details of a single CertificateMapEntry.
rpc GetCertificateMapEntry(GetCertificateMapEntryRequest)
returns (CertificateMapEntry) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/certificateMaps/*/certificateMapEntries/*}"
};
option (google.api.method_signature) = "name";
}
// Creates a new CertificateMapEntry in a given project and location.
rpc CreateCertificateMapEntry(CreateCertificateMapEntryRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/certificateMaps/*}/certificateMapEntries"
body: "certificate_map_entry"
};
option (google.api.method_signature) =
"parent,certificate_map_entry,certificate_map_entry_id";
option (google.longrunning.operation_info) = {
response_type: "CertificateMapEntry"
metadata_type: "OperationMetadata"
};
}
// Updates a CertificateMapEntry.
rpc UpdateCertificateMapEntry(UpdateCertificateMapEntryRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
patch: "/v1/{certificate_map_entry.name=projects/*/locations/*/certificateMaps/*/certificateMapEntries/*}"
body: "certificate_map_entry"
};
option (google.api.method_signature) = "certificate_map_entry,update_mask";
option (google.longrunning.operation_info) = {
response_type: "CertificateMapEntry"
metadata_type: "OperationMetadata"
};
}
// Deletes a single CertificateMapEntry.
rpc DeleteCertificateMapEntry(DeleteCertificateMapEntryRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/certificateMaps/*/certificateMapEntries/*}"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "OperationMetadata"
};
}
// Lists DnsAuthorizations in a given project and location.
rpc ListDnsAuthorizations(ListDnsAuthorizationsRequest)
returns (ListDnsAuthorizationsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/dnsAuthorizations"
};
option (google.api.method_signature) = "parent";
}
// Gets details of a single DnsAuthorization.
rpc GetDnsAuthorization(GetDnsAuthorizationRequest)
returns (DnsAuthorization) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/dnsAuthorizations/*}"
};
option (google.api.method_signature) = "name";
}
// Creates a new DnsAuthorization in a given project and location.
rpc CreateDnsAuthorization(CreateDnsAuthorizationRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/dnsAuthorizations"
body: "dns_authorization"
};
option (google.api.method_signature) =
"parent,dns_authorization,dns_authorization_id";
option (google.longrunning.operation_info) = {
response_type: "DnsAuthorization"
metadata_type: "OperationMetadata"
};
}
// Updates a DnsAuthorization.
rpc UpdateDnsAuthorization(UpdateDnsAuthorizationRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
patch: "/v1/{dns_authorization.name=projects/*/locations/*/dnsAuthorizations/*}"
body: "dns_authorization"
};
option (google.api.method_signature) = "dns_authorization,update_mask";
option (google.longrunning.operation_info) = {
response_type: "DnsAuthorization"
metadata_type: "OperationMetadata"
};
}
// Deletes a single DnsAuthorization.
rpc DeleteDnsAuthorization(DeleteDnsAuthorizationRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/dnsAuthorizations/*}"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "OperationMetadata"
};
}
// Lists CertificateIssuanceConfigs in a given project and location.
rpc ListCertificateIssuanceConfigs(ListCertificateIssuanceConfigsRequest)
returns (ListCertificateIssuanceConfigsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/certificateIssuanceConfigs"
};
option (google.api.method_signature) = "parent";
}
// Gets details of a single CertificateIssuanceConfig.
rpc GetCertificateIssuanceConfig(GetCertificateIssuanceConfigRequest)
returns (CertificateIssuanceConfig) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/certificateIssuanceConfigs/*}"
};
option (google.api.method_signature) = "name";
}
// Creates a new CertificateIssuanceConfig in a given project and location.
rpc CreateCertificateIssuanceConfig(CreateCertificateIssuanceConfigRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/certificateIssuanceConfigs"
body: "certificate_issuance_config"
};
option (google.api.method_signature) =
"parent,certificate_issuance_config,certificate_issuance_config_id";
option (google.longrunning.operation_info) = {
response_type: "CertificateIssuanceConfig"
metadata_type: "OperationMetadata"
};
}
// Deletes a single CertificateIssuanceConfig.
rpc DeleteCertificateIssuanceConfig(DeleteCertificateIssuanceConfigRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/certificateIssuanceConfigs/*}"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "OperationMetadata"
};
}
// Lists TrustConfigs in a given project and location.
rpc ListTrustConfigs(ListTrustConfigsRequest)
returns (ListTrustConfigsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/trustConfigs"
};
option (google.api.method_signature) = "parent";
}
// Gets details of a single TrustConfig.
rpc GetTrustConfig(GetTrustConfigRequest) returns (TrustConfig) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/trustConfigs/*}"
};
option (google.api.method_signature) = "name";
}
// Creates a new TrustConfig in a given project and location.
rpc CreateTrustConfig(CreateTrustConfigRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/trustConfigs"
body: "trust_config"
};
option (google.api.method_signature) =
"parent,trust_config,trust_config_id";
option (google.longrunning.operation_info) = {
response_type: "TrustConfig"
metadata_type: "OperationMetadata"
};
}
// Updates a TrustConfig.
rpc UpdateTrustConfig(UpdateTrustConfigRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
patch: "/v1/{trust_config.name=projects/*/locations/*/trustConfigs/*}"
body: "trust_config"
};
option (google.api.method_signature) = "trust_config,update_mask";
option (google.longrunning.operation_info) = {
response_type: "TrustConfig"
metadata_type: "OperationMetadata"
};
}
// Deletes a single TrustConfig.
rpc DeleteTrustConfig(DeleteTrustConfigRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/trustConfigs/*}"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "OperationMetadata"
};
}
}
// Request for the `ListCertificates` method.
message ListCertificatesRequest {
// Required. The project and location from which the certificate should be
// listed, specified in the format `projects/*/locations/*`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "locations.googleapis.com/Location"
}
];
// Maximum number of certificates to return per call.
int32 page_size = 2;
// The value returned by the last `ListCertificatesResponse`. Indicates that
// this is a continuation of a prior `ListCertificates` call, and that the
// system should return the next page of data.
string page_token = 3;
// Filter expression to restrict the Certificates returned.
string filter = 4;
// A list of Certificate field names used to specify the order of the returned
// results. The default sorting order is ascending. To specify descending
// order for a field, add a suffix `" desc"`.
string order_by = 5;
}
// Response for the `ListCertificates` method.
message ListCertificatesResponse {
// A list of certificates for the parent resource.
repeated Certificate certificates = 1;
// If there might be more results than those appearing in this response, then
// `next_page_token` is included. To get the next set of results, call this
// method again using the value of `next_page_token` as `page_token`.
string next_page_token = 2;
// A list of locations that could not be reached.
repeated string unreachable = 3;
}
// Request for the `GetCertificate` method.
message GetCertificateRequest {
// Required. A name of the certificate to describe. Must be in the format
// `projects/*/locations/*/certificates/*`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "certificatemanager.googleapis.com/Certificate"
}
];
}
// Request for the `CreateCertificate` method.
message CreateCertificateRequest {
// Required. The parent resource of the certificate. Must be in the format
// `projects/*/locations/*`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "locations.googleapis.com/Location"
}
];
// Required. A user-provided name of the certificate.
string certificate_id = 2 [(google.api.field_behavior) = REQUIRED];
// Required. A definition of the certificate to create.
Certificate certificate = 3 [(google.api.field_behavior) = REQUIRED];
}
// Request for the `UpdateCertificate` method.
message UpdateCertificateRequest {
// Required. A definition of the certificate to update.
Certificate certificate = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The update mask applies to the resource. For the `FieldMask`
// definition, see
// https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
google.protobuf.FieldMask update_mask = 2
[(google.api.field_behavior) = REQUIRED];
}
// Request for the `DeleteCertificate` method.
message DeleteCertificateRequest {
// Required. A name of the certificate to delete. Must be in the format
// `projects/*/locations/*/certificates/*`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "certificatemanager.googleapis.com/Certificate"
}
];
}
// Request for the `ListCertificateMaps` method.
message ListCertificateMapsRequest {
// Required. The project and location from which the certificate maps should
// be listed, specified in the format `projects/*/locations/*`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "locations.googleapis.com/Location"
}
];
// Maximum number of certificate maps to return per call.
int32 page_size = 2;
// The value returned by the last `ListCertificateMapsResponse`. Indicates
// that this is a continuation of a prior `ListCertificateMaps` call, and that
// the system should return the next page of data.
string page_token = 3;
// Filter expression to restrict the Certificates Maps returned.
string filter = 4;
// A list of Certificate Map field names used to specify the order of the
// returned results. The default sorting order is ascending. To specify
// descending order for a field, add a suffix `" desc"`.
string order_by = 5;
}
// Response for the `ListCertificateMaps` method.
message ListCertificateMapsResponse {
// A list of certificate maps for the parent resource.
repeated CertificateMap certificate_maps = 1;
// If there might be more results than those appearing in this response, then
// `next_page_token` is included. To get the next set of results, call this
// method again using the value of `next_page_token` as `page_token`.
string next_page_token = 2;
// Locations that could not be reached.
repeated string unreachable = 3;
}
// Request for the `GetCertificateMap` method.
message GetCertificateMapRequest {
// Required. A name of the certificate map to describe. Must be in the format
// `projects/*/locations/*/certificateMaps/*`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "certificatemanager.googleapis.com/CertificateMap"
}
];
}
// Request for the `CreateCertificateMap` method.
message CreateCertificateMapRequest {
// Required. The parent resource of the certificate map. Must be in the format
// `projects/*/locations/*`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "locations.googleapis.com/Location"
}
];
// Required. A user-provided name of the certificate map.
string certificate_map_id = 2 [(google.api.field_behavior) = REQUIRED];
// Required. A definition of the certificate map to create.
CertificateMap certificate_map = 3 [(google.api.field_behavior) = REQUIRED];
}
// Request for the `UpdateCertificateMap` method.
message UpdateCertificateMapRequest {
// Required. A definition of the certificate map to update.
CertificateMap certificate_map = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The update mask applies to the resource. For the `FieldMask`
// definition, see
// https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
google.protobuf.FieldMask update_mask = 2
[(google.api.field_behavior) = REQUIRED];
}
// Request for the `DeleteCertificateMap` method.
message DeleteCertificateMapRequest {
// Required. A name of the certificate map to delete. Must be in the format
// `projects/*/locations/*/certificateMaps/*`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "certificatemanager.googleapis.com/CertificateMap"
}
];
}
// Request for the `ListCertificateMapEntries` method.
message ListCertificateMapEntriesRequest {
// Required. The project, location and certificate map from which the
// certificate map entries should be listed, specified in the format
// `projects/*/locations/*/certificateMaps/*`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "certificatemanager.googleapis.com/CertificateMap"
}
];
// Maximum number of certificate map entries to return. The service may return
// fewer than this value.
// If unspecified, at most 50 certificate map entries will be returned.
// The maximum value is 1000; values above 1000 will be coerced to 1000.
int32 page_size = 2;
// The value returned by the last `ListCertificateMapEntriesResponse`.
// Indicates that this is a continuation of a prior
// `ListCertificateMapEntries` call, and that the system should return the
// next page of data.
string page_token = 3;
// Filter expression to restrict the returned Certificate Map Entries.
string filter = 4;
// A list of Certificate Map Entry field names used to specify
// the order of the returned results. The default sorting order is ascending.
// To specify descending order for a field, add a suffix `" desc"`.
string order_by = 5;
}
// Response for the `ListCertificateMapEntries` method.
message ListCertificateMapEntriesResponse {
// A list of certificate map entries for the parent resource.
repeated CertificateMapEntry certificate_map_entries = 1;
// If there might be more results than those appearing in this response, then
// `next_page_token` is included. To get the next set of results, call this
// method again using the value of `next_page_token` as `page_token`.
string next_page_token = 2;
// Locations that could not be reached.
repeated string unreachable = 3;
}
// Request for the `GetCertificateMapEntry` method.
message GetCertificateMapEntryRequest {
// Required. A name of the certificate map entry to describe. Must be in the
// format `projects/*/locations/*/certificateMaps/*/certificateMapEntries/*`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "certificatemanager.googleapis.com/CertificateMapEntry"
}
];
}
// Request for the `CreateCertificateMapEntry` method.
message CreateCertificateMapEntryRequest {
// Required. The parent resource of the certificate map entry. Must be in the
// format `projects/*/locations/*/certificateMaps/*`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "certificatemanager.googleapis.com/CertificateMap"
}
];
// Required. A user-provided name of the certificate map entry.
string certificate_map_entry_id = 2 [(google.api.field_behavior) = REQUIRED];
// Required. A definition of the certificate map entry to create.
CertificateMapEntry certificate_map_entry = 3
[(google.api.field_behavior) = REQUIRED];
}
// Request for the `UpdateCertificateMapEntry` method.
message UpdateCertificateMapEntryRequest {
// Required. A definition of the certificate map entry to create map entry.
CertificateMapEntry certificate_map_entry = 1
[(google.api.field_behavior) = REQUIRED];
// Required. The update mask applies to the resource. For the `FieldMask`
// definition, see
// https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
google.protobuf.FieldMask update_mask = 2
[(google.api.field_behavior) = REQUIRED];
}
// Request for the `DeleteCertificateMapEntry` method.
message DeleteCertificateMapEntryRequest {
// Required. A name of the certificate map entry to delete. Must be in the
// format `projects/*/locations/*/certificateMaps/*/certificateMapEntries/*`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "certificatemanager.googleapis.com/CertificateMapEntry"
}
];
}
// Request for the `ListDnsAuthorizations` method.
message ListDnsAuthorizationsRequest {
// Required. The project and location from which the dns authorizations should
// be listed, specified in the format `projects/*/locations/*`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "locations.googleapis.com/Location"
}
];
// Maximum number of dns authorizations to return per call.
int32 page_size = 2;
// The value returned by the last `ListDnsAuthorizationsResponse`. Indicates
// that this is a continuation of a prior `ListDnsAuthorizations` call, and
// that the system should return the next page of data.
string page_token = 3;
// Filter expression to restrict the Dns Authorizations returned.
string filter = 4;
// A list of Dns Authorization field names used to specify the order of the
// returned results. The default sorting order is ascending. To specify
// descending order for a field, add a suffix `" desc"`.
string order_by = 5;
}
// Response for the `ListDnsAuthorizations` method.
message ListDnsAuthorizationsResponse {
// A list of dns authorizations for the parent resource.
repeated DnsAuthorization dns_authorizations = 1;
// If there might be more results than those appearing in this response, then
// `next_page_token` is included. To get the next set of results, call this
// method again using the value of `next_page_token` as `page_token`.
string next_page_token = 2;
// Locations that could not be reached.
repeated string unreachable = 3;
}
// Request for the `GetDnsAuthorization` method.
message GetDnsAuthorizationRequest {
// Required. A name of the dns authorization to describe. Must be in the
// format `projects/*/locations/*/dnsAuthorizations/*`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "certificatemanager.googleapis.com/DnsAuthorization"
}
];
}
// Request for the `CreateDnsAuthorization` method.
message CreateDnsAuthorizationRequest {
// Required. The parent resource of the dns authorization. Must be in the
// format `projects/*/locations/*`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "locations.googleapis.com/Location"
}
];
// Required. A user-provided name of the dns authorization.
string dns_authorization_id = 2 [(google.api.field_behavior) = REQUIRED];
// Required. A definition of the dns authorization to create.
DnsAuthorization dns_authorization = 3
[(google.api.field_behavior) = REQUIRED];
}
// Request for the `UpdateDnsAuthorization` method.
message UpdateDnsAuthorizationRequest {
// Required. A definition of the dns authorization to update.
DnsAuthorization dns_authorization = 1
[(google.api.field_behavior) = REQUIRED];
// Required. The update mask applies to the resource. For the `FieldMask`
// definition, see
// https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
google.protobuf.FieldMask update_mask = 2
[(google.api.field_behavior) = REQUIRED];
}
// Request for the `DeleteDnsAuthorization` method.
message DeleteDnsAuthorizationRequest {
// Required. A name of the dns authorization to delete. Must be in the format
// `projects/*/locations/*/dnsAuthorizations/*`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "certificatemanager.googleapis.com/DnsAuthorization"
}
];
}
// Represents the metadata of the long-running operation. Output only.
message OperationMetadata {
// The time the operation was created.
google.protobuf.Timestamp create_time = 1;
// The time the operation finished running.
google.protobuf.Timestamp end_time = 2;
// Server-defined resource path for the target of the operation.
string target = 3;
// Name of the verb executed by the operation.
string verb = 4;
// Human-readable status of the operation, if any.
string status_message = 5;
// Identifies whether the user has requested cancellation
// of the operation. Operations that have successfully been cancelled
// have [Operation.error][] value with a
// [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
// `Code.CANCELLED`.
bool requested_cancellation = 6;
// API version used to start the operation.
string api_version = 7;
}
// Defines TLS certificate.
message Certificate {
option (google.api.resource) = {
type: "certificatemanager.googleapis.com/Certificate"
pattern: "projects/{project}/locations/{location}/certificates/{certificate}"
};
// Certificate data for a SelfManaged Certificate.
// SelfManaged Certificates are uploaded by the user. Updating such
// certificates before they expire remains the user's responsibility.
message SelfManagedCertificate {
// Input only. The PEM-encoded certificate chain.
// Leaf certificate comes first, followed by intermediate ones if any.
string pem_certificate = 1 [(google.api.field_behavior) = INPUT_ONLY];
// Input only. The PEM-encoded private key of the leaf certificate.
string pem_private_key = 2 [(google.api.field_behavior) = INPUT_ONLY];
}
// Configuration and state of a Managed Certificate.
// Certificate Manager provisions and renews Managed Certificates
// automatically, for as long as it's authorized to do so.
message ManagedCertificate {
// State of the managed certificate resource.
enum State {
// State is unspecified.
STATE_UNSPECIFIED = 0;
// Certificate Manager attempts to provision or renew the certificate.
// If the process takes longer than expected, consult the
// `provisioning_issue` field.
PROVISIONING = 1;
// Multiple certificate provisioning attempts failed and Certificate
// Manager gave up. To try again, delete and create a new managed
// Certificate resource.
// For details see the `provisioning_issue` field.
FAILED = 2;
// The certificate management is working, and a certificate has been
// provisioned.
ACTIVE = 3;
}
// Information about issues with provisioning a Managed Certificate.
message ProvisioningIssue {
// Reason for provisioning failures.
enum Reason {
// Reason is unspecified.
REASON_UNSPECIFIED = 0;
// Certificate provisioning failed due to an issue with one or more of
// the domains on the certificate.
// For details of which domains failed, consult the
// `authorization_attempt_info` field.
AUTHORIZATION_ISSUE = 1;
// Exceeded Certificate Authority quotas or internal rate limits of the
// system. Provisioning may take longer to complete.
RATE_LIMITED = 2;
}
// Output only. Reason for provisioning failures.
Reason reason = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Human readable explanation about the issue. Provided to
// help address the configuration issues. Not guaranteed to be stable. For
// programmatic access use Reason enum.
string details = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// State of the latest attempt to authorize a domain for certificate
// issuance.
message AuthorizationAttemptInfo {
// State of the domain for managed certificate issuance.
enum State {
// State is unspecified.
STATE_UNSPECIFIED = 0;
// Certificate provisioning for this domain is under way. Google Cloud
// will attempt to authorize the domain.
AUTHORIZING = 1;
// A managed certificate can be provisioned, no issues for this domain.
AUTHORIZED = 6;
// Attempt to authorize the domain failed. This prevents the Managed
// Certificate from being issued.
// See `failure_reason` and `details` fields for more information.
FAILED = 7;
}
// Reason for failure of the authorization attempt for the domain.
enum FailureReason {
// FailureReason is unspecified.
FAILURE_REASON_UNSPECIFIED = 0;
// There was a problem with the user's DNS or load balancer
// configuration for this domain.
CONFIG = 1;
// Certificate issuance forbidden by an explicit CAA record for the
// domain or a failure to check CAA records for the domain.
CAA = 2;
// Reached a CA or internal rate-limit for the domain,
// e.g. for certificates per top-level private domain.
RATE_LIMITED = 3;
}
// Domain name of the authorization attempt.
string domain = 1;
// Output only. State of the domain for managed certificate issuance.
State state = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Reason for failure of the authorization attempt for the
// domain.
FailureReason failure_reason = 3
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Human readable explanation for reaching the state.
// Provided to help address the configuration issues. Not guaranteed to be
// stable. For programmatic access use FailureReason enum.
string details = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Immutable. The domains for which a managed SSL certificate will be
// generated. Wildcard domains are only supported with DNS challenge
// resolution.
repeated string domains = 1 [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Authorizations that will be used for performing domain
// authorization.
repeated string dns_authorizations = 2 [
(google.api.field_behavior) = IMMUTABLE,
(google.api.resource_reference) = {
type: "certificatemanager.googleapis.com/DnsAuthorization"
}
];
// Immutable. The resource name for a
// [CertificateIssuanceConfig][google.cloud.certificatemanager.v1.CertificateIssuanceConfig]
// used to configure private PKI certificates in the format
// `projects/*/locations/*/certificateIssuanceConfigs/*`.
// If this field is not set, the certificates will instead be publicly
// signed as documented at
// https://cloud.google.com/load-balancing/docs/ssl-certificates/google-managed-certs#caa.
string issuance_config = 6 [
(google.api.field_behavior) = IMMUTABLE,
(google.api.resource_reference) = {
type: "certificatemanager.googleapis.com/CertificateIssuanceConfig"
}
];
// Output only. State of the managed certificate resource.
State state = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Information about issues with provisioning a Managed
// Certificate.
ProvisioningIssue provisioning_issue = 3
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Detailed state of the latest authorization attempt for each
// domain specified for managed certificate resource.
repeated AuthorizationAttemptInfo authorization_attempt_info = 5