google-cloud-security-private_ca-v1 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +169 -0
- data/LICENSE.md +201 -0
- data/README.md +139 -0
- data/lib/google-cloud-security-private_ca-v1.rb +21 -0
- data/lib/google/cloud/security/private_ca/v1.rb +40 -0
- data/lib/google/cloud/security/private_ca/v1/certificate_authority_service.rb +53 -0
- data/lib/google/cloud/security/private_ca/v1/certificate_authority_service/client.rb +2891 -0
- data/lib/google/cloud/security/private_ca/v1/certificate_authority_service/credentials.rb +53 -0
- data/lib/google/cloud/security/private_ca/v1/certificate_authority_service/operations.rb +657 -0
- data/lib/google/cloud/security/private_ca/v1/certificate_authority_service/paths.rb +155 -0
- data/lib/google/cloud/security/private_ca/v1/version.rb +30 -0
- data/lib/google/cloud/security/privateca/v1/resources_pb.rb +368 -0
- data/lib/google/cloud/security/privateca/v1/service_pb.rb +254 -0
- data/lib/google/cloud/security/privateca/v1/service_services_pb.rb +119 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/field_behavior.rb +65 -0
- data/proto_docs/google/api/resource.rb +283 -0
- data/proto_docs/google/cloud/security/privateca/v1/resources.rb +1188 -0
- data/proto_docs/google/cloud/security/privateca/v1/service.rb +934 -0
- data/proto_docs/google/longrunning/operations.rb +164 -0
- data/proto_docs/google/protobuf/any.rb +141 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +36 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/protobuf/timestamp.rb +129 -0
- data/proto_docs/google/rpc/status.rb +46 -0
- data/proto_docs/google/type/expr.rb +75 -0
- metadata +221 -0
|
@@ -0,0 +1,254 @@
|
|
|
1
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
|
2
|
+
# source: google/cloud/security/privateca/v1/service.proto
|
|
3
|
+
|
|
4
|
+
require 'google/protobuf'
|
|
5
|
+
|
|
6
|
+
require 'google/api/annotations_pb'
|
|
7
|
+
require 'google/api/client_pb'
|
|
8
|
+
require 'google/api/field_behavior_pb'
|
|
9
|
+
require 'google/api/resource_pb'
|
|
10
|
+
require 'google/cloud/security/privateca/v1/resources_pb'
|
|
11
|
+
require 'google/longrunning/operations_pb'
|
|
12
|
+
require 'google/protobuf/duration_pb'
|
|
13
|
+
require 'google/protobuf/field_mask_pb'
|
|
14
|
+
require 'google/protobuf/timestamp_pb'
|
|
15
|
+
Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
16
|
+
add_file("google/cloud/security/privateca/v1/service.proto", :syntax => :proto3) do
|
|
17
|
+
add_message "google.cloud.security.privateca.v1.CreateCertificateRequest" do
|
|
18
|
+
optional :parent, :string, 1
|
|
19
|
+
optional :certificate_id, :string, 2
|
|
20
|
+
optional :certificate, :message, 3, "google.cloud.security.privateca.v1.Certificate"
|
|
21
|
+
optional :request_id, :string, 4
|
|
22
|
+
optional :validate_only, :bool, 5
|
|
23
|
+
optional :issuing_certificate_authority_id, :string, 6
|
|
24
|
+
end
|
|
25
|
+
add_message "google.cloud.security.privateca.v1.GetCertificateRequest" do
|
|
26
|
+
optional :name, :string, 1
|
|
27
|
+
end
|
|
28
|
+
add_message "google.cloud.security.privateca.v1.ListCertificatesRequest" do
|
|
29
|
+
optional :parent, :string, 1
|
|
30
|
+
optional :page_size, :int32, 2
|
|
31
|
+
optional :page_token, :string, 3
|
|
32
|
+
optional :filter, :string, 4
|
|
33
|
+
optional :order_by, :string, 5
|
|
34
|
+
end
|
|
35
|
+
add_message "google.cloud.security.privateca.v1.ListCertificatesResponse" do
|
|
36
|
+
repeated :certificates, :message, 1, "google.cloud.security.privateca.v1.Certificate"
|
|
37
|
+
optional :next_page_token, :string, 2
|
|
38
|
+
repeated :unreachable, :string, 3
|
|
39
|
+
end
|
|
40
|
+
add_message "google.cloud.security.privateca.v1.RevokeCertificateRequest" do
|
|
41
|
+
optional :name, :string, 1
|
|
42
|
+
optional :reason, :enum, 2, "google.cloud.security.privateca.v1.RevocationReason"
|
|
43
|
+
optional :request_id, :string, 3
|
|
44
|
+
end
|
|
45
|
+
add_message "google.cloud.security.privateca.v1.UpdateCertificateRequest" do
|
|
46
|
+
optional :certificate, :message, 1, "google.cloud.security.privateca.v1.Certificate"
|
|
47
|
+
optional :update_mask, :message, 2, "google.protobuf.FieldMask"
|
|
48
|
+
optional :request_id, :string, 3
|
|
49
|
+
end
|
|
50
|
+
add_message "google.cloud.security.privateca.v1.ActivateCertificateAuthorityRequest" do
|
|
51
|
+
optional :name, :string, 1
|
|
52
|
+
optional :pem_ca_certificate, :string, 2
|
|
53
|
+
optional :subordinate_config, :message, 3, "google.cloud.security.privateca.v1.SubordinateConfig"
|
|
54
|
+
optional :request_id, :string, 4
|
|
55
|
+
end
|
|
56
|
+
add_message "google.cloud.security.privateca.v1.CreateCertificateAuthorityRequest" do
|
|
57
|
+
optional :parent, :string, 1
|
|
58
|
+
optional :certificate_authority_id, :string, 2
|
|
59
|
+
optional :certificate_authority, :message, 3, "google.cloud.security.privateca.v1.CertificateAuthority"
|
|
60
|
+
optional :request_id, :string, 4
|
|
61
|
+
end
|
|
62
|
+
add_message "google.cloud.security.privateca.v1.DisableCertificateAuthorityRequest" do
|
|
63
|
+
optional :name, :string, 1
|
|
64
|
+
optional :request_id, :string, 2
|
|
65
|
+
end
|
|
66
|
+
add_message "google.cloud.security.privateca.v1.EnableCertificateAuthorityRequest" do
|
|
67
|
+
optional :name, :string, 1
|
|
68
|
+
optional :request_id, :string, 2
|
|
69
|
+
end
|
|
70
|
+
add_message "google.cloud.security.privateca.v1.FetchCertificateAuthorityCsrRequest" do
|
|
71
|
+
optional :name, :string, 1
|
|
72
|
+
end
|
|
73
|
+
add_message "google.cloud.security.privateca.v1.FetchCertificateAuthorityCsrResponse" do
|
|
74
|
+
optional :pem_csr, :string, 1
|
|
75
|
+
end
|
|
76
|
+
add_message "google.cloud.security.privateca.v1.GetCertificateAuthorityRequest" do
|
|
77
|
+
optional :name, :string, 1
|
|
78
|
+
end
|
|
79
|
+
add_message "google.cloud.security.privateca.v1.ListCertificateAuthoritiesRequest" do
|
|
80
|
+
optional :parent, :string, 1
|
|
81
|
+
optional :page_size, :int32, 2
|
|
82
|
+
optional :page_token, :string, 3
|
|
83
|
+
optional :filter, :string, 4
|
|
84
|
+
optional :order_by, :string, 5
|
|
85
|
+
end
|
|
86
|
+
add_message "google.cloud.security.privateca.v1.ListCertificateAuthoritiesResponse" do
|
|
87
|
+
repeated :certificate_authorities, :message, 1, "google.cloud.security.privateca.v1.CertificateAuthority"
|
|
88
|
+
optional :next_page_token, :string, 2
|
|
89
|
+
repeated :unreachable, :string, 3
|
|
90
|
+
end
|
|
91
|
+
add_message "google.cloud.security.privateca.v1.UndeleteCertificateAuthorityRequest" do
|
|
92
|
+
optional :name, :string, 1
|
|
93
|
+
optional :request_id, :string, 2
|
|
94
|
+
end
|
|
95
|
+
add_message "google.cloud.security.privateca.v1.DeleteCertificateAuthorityRequest" do
|
|
96
|
+
optional :name, :string, 1
|
|
97
|
+
optional :request_id, :string, 2
|
|
98
|
+
optional :ignore_active_certificates, :bool, 4
|
|
99
|
+
end
|
|
100
|
+
add_message "google.cloud.security.privateca.v1.UpdateCertificateAuthorityRequest" do
|
|
101
|
+
optional :certificate_authority, :message, 1, "google.cloud.security.privateca.v1.CertificateAuthority"
|
|
102
|
+
optional :update_mask, :message, 2, "google.protobuf.FieldMask"
|
|
103
|
+
optional :request_id, :string, 3
|
|
104
|
+
end
|
|
105
|
+
add_message "google.cloud.security.privateca.v1.CreateCaPoolRequest" do
|
|
106
|
+
optional :parent, :string, 1
|
|
107
|
+
optional :ca_pool_id, :string, 2
|
|
108
|
+
optional :ca_pool, :message, 3, "google.cloud.security.privateca.v1.CaPool"
|
|
109
|
+
optional :request_id, :string, 4
|
|
110
|
+
end
|
|
111
|
+
add_message "google.cloud.security.privateca.v1.UpdateCaPoolRequest" do
|
|
112
|
+
optional :ca_pool, :message, 1, "google.cloud.security.privateca.v1.CaPool"
|
|
113
|
+
optional :update_mask, :message, 2, "google.protobuf.FieldMask"
|
|
114
|
+
optional :request_id, :string, 3
|
|
115
|
+
end
|
|
116
|
+
add_message "google.cloud.security.privateca.v1.DeleteCaPoolRequest" do
|
|
117
|
+
optional :name, :string, 1
|
|
118
|
+
optional :request_id, :string, 2
|
|
119
|
+
end
|
|
120
|
+
add_message "google.cloud.security.privateca.v1.FetchCaCertsRequest" do
|
|
121
|
+
optional :ca_pool, :string, 1
|
|
122
|
+
optional :request_id, :string, 2
|
|
123
|
+
end
|
|
124
|
+
add_message "google.cloud.security.privateca.v1.FetchCaCertsResponse" do
|
|
125
|
+
repeated :ca_certs, :message, 1, "google.cloud.security.privateca.v1.FetchCaCertsResponse.CertChain"
|
|
126
|
+
end
|
|
127
|
+
add_message "google.cloud.security.privateca.v1.FetchCaCertsResponse.CertChain" do
|
|
128
|
+
repeated :certificates, :string, 1
|
|
129
|
+
end
|
|
130
|
+
add_message "google.cloud.security.privateca.v1.GetCaPoolRequest" do
|
|
131
|
+
optional :name, :string, 1
|
|
132
|
+
end
|
|
133
|
+
add_message "google.cloud.security.privateca.v1.ListCaPoolsRequest" do
|
|
134
|
+
optional :parent, :string, 1
|
|
135
|
+
optional :page_size, :int32, 2
|
|
136
|
+
optional :page_token, :string, 3
|
|
137
|
+
optional :filter, :string, 4
|
|
138
|
+
optional :order_by, :string, 5
|
|
139
|
+
end
|
|
140
|
+
add_message "google.cloud.security.privateca.v1.ListCaPoolsResponse" do
|
|
141
|
+
repeated :ca_pools, :message, 1, "google.cloud.security.privateca.v1.CaPool"
|
|
142
|
+
optional :next_page_token, :string, 2
|
|
143
|
+
repeated :unreachable, :string, 3
|
|
144
|
+
end
|
|
145
|
+
add_message "google.cloud.security.privateca.v1.GetCertificateRevocationListRequest" do
|
|
146
|
+
optional :name, :string, 1
|
|
147
|
+
end
|
|
148
|
+
add_message "google.cloud.security.privateca.v1.ListCertificateRevocationListsRequest" do
|
|
149
|
+
optional :parent, :string, 1
|
|
150
|
+
optional :page_size, :int32, 2
|
|
151
|
+
optional :page_token, :string, 3
|
|
152
|
+
optional :filter, :string, 4
|
|
153
|
+
optional :order_by, :string, 5
|
|
154
|
+
end
|
|
155
|
+
add_message "google.cloud.security.privateca.v1.ListCertificateRevocationListsResponse" do
|
|
156
|
+
repeated :certificate_revocation_lists, :message, 1, "google.cloud.security.privateca.v1.CertificateRevocationList"
|
|
157
|
+
optional :next_page_token, :string, 2
|
|
158
|
+
repeated :unreachable, :string, 3
|
|
159
|
+
end
|
|
160
|
+
add_message "google.cloud.security.privateca.v1.UpdateCertificateRevocationListRequest" do
|
|
161
|
+
optional :certificate_revocation_list, :message, 1, "google.cloud.security.privateca.v1.CertificateRevocationList"
|
|
162
|
+
optional :update_mask, :message, 2, "google.protobuf.FieldMask"
|
|
163
|
+
optional :request_id, :string, 3
|
|
164
|
+
end
|
|
165
|
+
add_message "google.cloud.security.privateca.v1.CreateCertificateTemplateRequest" do
|
|
166
|
+
optional :parent, :string, 1
|
|
167
|
+
optional :certificate_template_id, :string, 2
|
|
168
|
+
optional :certificate_template, :message, 3, "google.cloud.security.privateca.v1.CertificateTemplate"
|
|
169
|
+
optional :request_id, :string, 4
|
|
170
|
+
end
|
|
171
|
+
add_message "google.cloud.security.privateca.v1.DeleteCertificateTemplateRequest" do
|
|
172
|
+
optional :name, :string, 1
|
|
173
|
+
optional :request_id, :string, 2
|
|
174
|
+
end
|
|
175
|
+
add_message "google.cloud.security.privateca.v1.GetCertificateTemplateRequest" do
|
|
176
|
+
optional :name, :string, 1
|
|
177
|
+
end
|
|
178
|
+
add_message "google.cloud.security.privateca.v1.ListCertificateTemplatesRequest" do
|
|
179
|
+
optional :parent, :string, 1
|
|
180
|
+
optional :page_size, :int32, 2
|
|
181
|
+
optional :page_token, :string, 3
|
|
182
|
+
optional :filter, :string, 4
|
|
183
|
+
optional :order_by, :string, 5
|
|
184
|
+
end
|
|
185
|
+
add_message "google.cloud.security.privateca.v1.ListCertificateTemplatesResponse" do
|
|
186
|
+
repeated :certificate_templates, :message, 1, "google.cloud.security.privateca.v1.CertificateTemplate"
|
|
187
|
+
optional :next_page_token, :string, 2
|
|
188
|
+
repeated :unreachable, :string, 3
|
|
189
|
+
end
|
|
190
|
+
add_message "google.cloud.security.privateca.v1.UpdateCertificateTemplateRequest" do
|
|
191
|
+
optional :certificate_template, :message, 1, "google.cloud.security.privateca.v1.CertificateTemplate"
|
|
192
|
+
optional :update_mask, :message, 2, "google.protobuf.FieldMask"
|
|
193
|
+
optional :request_id, :string, 3
|
|
194
|
+
end
|
|
195
|
+
add_message "google.cloud.security.privateca.v1.OperationMetadata" do
|
|
196
|
+
optional :create_time, :message, 1, "google.protobuf.Timestamp"
|
|
197
|
+
optional :end_time, :message, 2, "google.protobuf.Timestamp"
|
|
198
|
+
optional :target, :string, 3
|
|
199
|
+
optional :verb, :string, 4
|
|
200
|
+
optional :status_message, :string, 5
|
|
201
|
+
optional :requested_cancellation, :bool, 6
|
|
202
|
+
optional :api_version, :string, 7
|
|
203
|
+
end
|
|
204
|
+
end
|
|
205
|
+
end
|
|
206
|
+
|
|
207
|
+
module Google
|
|
208
|
+
module Cloud
|
|
209
|
+
module Security
|
|
210
|
+
module PrivateCA
|
|
211
|
+
module V1
|
|
212
|
+
CreateCertificateRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.CreateCertificateRequest").msgclass
|
|
213
|
+
GetCertificateRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.GetCertificateRequest").msgclass
|
|
214
|
+
ListCertificatesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.ListCertificatesRequest").msgclass
|
|
215
|
+
ListCertificatesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.ListCertificatesResponse").msgclass
|
|
216
|
+
RevokeCertificateRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.RevokeCertificateRequest").msgclass
|
|
217
|
+
UpdateCertificateRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.UpdateCertificateRequest").msgclass
|
|
218
|
+
ActivateCertificateAuthorityRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.ActivateCertificateAuthorityRequest").msgclass
|
|
219
|
+
CreateCertificateAuthorityRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.CreateCertificateAuthorityRequest").msgclass
|
|
220
|
+
DisableCertificateAuthorityRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.DisableCertificateAuthorityRequest").msgclass
|
|
221
|
+
EnableCertificateAuthorityRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.EnableCertificateAuthorityRequest").msgclass
|
|
222
|
+
FetchCertificateAuthorityCsrRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.FetchCertificateAuthorityCsrRequest").msgclass
|
|
223
|
+
FetchCertificateAuthorityCsrResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.FetchCertificateAuthorityCsrResponse").msgclass
|
|
224
|
+
GetCertificateAuthorityRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.GetCertificateAuthorityRequest").msgclass
|
|
225
|
+
ListCertificateAuthoritiesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.ListCertificateAuthoritiesRequest").msgclass
|
|
226
|
+
ListCertificateAuthoritiesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.ListCertificateAuthoritiesResponse").msgclass
|
|
227
|
+
UndeleteCertificateAuthorityRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.UndeleteCertificateAuthorityRequest").msgclass
|
|
228
|
+
DeleteCertificateAuthorityRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.DeleteCertificateAuthorityRequest").msgclass
|
|
229
|
+
UpdateCertificateAuthorityRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.UpdateCertificateAuthorityRequest").msgclass
|
|
230
|
+
CreateCaPoolRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.CreateCaPoolRequest").msgclass
|
|
231
|
+
UpdateCaPoolRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.UpdateCaPoolRequest").msgclass
|
|
232
|
+
DeleteCaPoolRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.DeleteCaPoolRequest").msgclass
|
|
233
|
+
FetchCaCertsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.FetchCaCertsRequest").msgclass
|
|
234
|
+
FetchCaCertsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.FetchCaCertsResponse").msgclass
|
|
235
|
+
FetchCaCertsResponse::CertChain = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.FetchCaCertsResponse.CertChain").msgclass
|
|
236
|
+
GetCaPoolRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.GetCaPoolRequest").msgclass
|
|
237
|
+
ListCaPoolsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.ListCaPoolsRequest").msgclass
|
|
238
|
+
ListCaPoolsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.ListCaPoolsResponse").msgclass
|
|
239
|
+
GetCertificateRevocationListRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.GetCertificateRevocationListRequest").msgclass
|
|
240
|
+
ListCertificateRevocationListsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.ListCertificateRevocationListsRequest").msgclass
|
|
241
|
+
ListCertificateRevocationListsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.ListCertificateRevocationListsResponse").msgclass
|
|
242
|
+
UpdateCertificateRevocationListRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.UpdateCertificateRevocationListRequest").msgclass
|
|
243
|
+
CreateCertificateTemplateRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.CreateCertificateTemplateRequest").msgclass
|
|
244
|
+
DeleteCertificateTemplateRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.DeleteCertificateTemplateRequest").msgclass
|
|
245
|
+
GetCertificateTemplateRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.GetCertificateTemplateRequest").msgclass
|
|
246
|
+
ListCertificateTemplatesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.ListCertificateTemplatesRequest").msgclass
|
|
247
|
+
ListCertificateTemplatesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.ListCertificateTemplatesResponse").msgclass
|
|
248
|
+
UpdateCertificateTemplateRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.UpdateCertificateTemplateRequest").msgclass
|
|
249
|
+
OperationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.security.privateca.v1.OperationMetadata").msgclass
|
|
250
|
+
end
|
|
251
|
+
end
|
|
252
|
+
end
|
|
253
|
+
end
|
|
254
|
+
end
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
|
2
|
+
# Source: google/cloud/security/privateca/v1/service.proto for package 'Google.Cloud.Security.PrivateCA.V1'
|
|
3
|
+
# Original file comments:
|
|
4
|
+
# Copyright 2021 Google LLC
|
|
5
|
+
#
|
|
6
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
7
|
+
# you may not use this file except in compliance with the License.
|
|
8
|
+
# You may obtain a copy of the License at
|
|
9
|
+
#
|
|
10
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
11
|
+
#
|
|
12
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
13
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
14
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
15
|
+
# See the License for the specific language governing permissions and
|
|
16
|
+
# limitations under the License.
|
|
17
|
+
#
|
|
18
|
+
|
|
19
|
+
require 'grpc'
|
|
20
|
+
require 'google/cloud/security/privateca/v1/service_pb'
|
|
21
|
+
|
|
22
|
+
module Google
|
|
23
|
+
module Cloud
|
|
24
|
+
module Security
|
|
25
|
+
module PrivateCA
|
|
26
|
+
module V1
|
|
27
|
+
module CertificateAuthorityService
|
|
28
|
+
# [Certificate Authority Service][google.cloud.security.privateca.v1.CertificateAuthorityService] manages private
|
|
29
|
+
# certificate authorities and issued certificates.
|
|
30
|
+
class Service
|
|
31
|
+
|
|
32
|
+
include GRPC::GenericService
|
|
33
|
+
|
|
34
|
+
self.marshal_class_method = :encode
|
|
35
|
+
self.unmarshal_class_method = :decode
|
|
36
|
+
self.service_name = 'google.cloud.security.privateca.v1.CertificateAuthorityService'
|
|
37
|
+
|
|
38
|
+
# Create a new [Certificate][google.cloud.security.privateca.v1.Certificate] in a given Project, Location from a particular
|
|
39
|
+
# [CaPool][google.cloud.security.privateca.v1.CaPool].
|
|
40
|
+
rpc :CreateCertificate, ::Google::Cloud::Security::PrivateCA::V1::CreateCertificateRequest, ::Google::Cloud::Security::PrivateCA::V1::Certificate
|
|
41
|
+
# Returns a [Certificate][google.cloud.security.privateca.v1.Certificate].
|
|
42
|
+
rpc :GetCertificate, ::Google::Cloud::Security::PrivateCA::V1::GetCertificateRequest, ::Google::Cloud::Security::PrivateCA::V1::Certificate
|
|
43
|
+
# Lists [Certificates][google.cloud.security.privateca.v1.Certificate].
|
|
44
|
+
rpc :ListCertificates, ::Google::Cloud::Security::PrivateCA::V1::ListCertificatesRequest, ::Google::Cloud::Security::PrivateCA::V1::ListCertificatesResponse
|
|
45
|
+
# Revoke a [Certificate][google.cloud.security.privateca.v1.Certificate].
|
|
46
|
+
rpc :RevokeCertificate, ::Google::Cloud::Security::PrivateCA::V1::RevokeCertificateRequest, ::Google::Cloud::Security::PrivateCA::V1::Certificate
|
|
47
|
+
# Update a [Certificate][google.cloud.security.privateca.v1.Certificate]. Currently, the only field you can update is the
|
|
48
|
+
# [labels][google.cloud.security.privateca.v1.Certificate.labels] field.
|
|
49
|
+
rpc :UpdateCertificate, ::Google::Cloud::Security::PrivateCA::V1::UpdateCertificateRequest, ::Google::Cloud::Security::PrivateCA::V1::Certificate
|
|
50
|
+
# Activate a [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] that is in state
|
|
51
|
+
# [AWAITING_USER_ACTIVATION][google.cloud.security.privateca.v1.CertificateAuthority.State.AWAITING_USER_ACTIVATION]
|
|
52
|
+
# and is of type [SUBORDINATE][google.cloud.security.privateca.v1.CertificateAuthority.Type.SUBORDINATE]. After
|
|
53
|
+
# the parent Certificate Authority signs a certificate signing request from
|
|
54
|
+
# [FetchCertificateAuthorityCsr][google.cloud.security.privateca.v1.CertificateAuthorityService.FetchCertificateAuthorityCsr], this method can complete the activation
|
|
55
|
+
# process.
|
|
56
|
+
rpc :ActivateCertificateAuthority, ::Google::Cloud::Security::PrivateCA::V1::ActivateCertificateAuthorityRequest, ::Google::Longrunning::Operation
|
|
57
|
+
# Create a new [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] in a given Project and Location.
|
|
58
|
+
rpc :CreateCertificateAuthority, ::Google::Cloud::Security::PrivateCA::V1::CreateCertificateAuthorityRequest, ::Google::Longrunning::Operation
|
|
59
|
+
# Disable a [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority].
|
|
60
|
+
rpc :DisableCertificateAuthority, ::Google::Cloud::Security::PrivateCA::V1::DisableCertificateAuthorityRequest, ::Google::Longrunning::Operation
|
|
61
|
+
# Enable a [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority].
|
|
62
|
+
rpc :EnableCertificateAuthority, ::Google::Cloud::Security::PrivateCA::V1::EnableCertificateAuthorityRequest, ::Google::Longrunning::Operation
|
|
63
|
+
# Fetch a certificate signing request (CSR) from a [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
|
|
64
|
+
# that is in state
|
|
65
|
+
# [AWAITING_USER_ACTIVATION][google.cloud.security.privateca.v1.CertificateAuthority.State.AWAITING_USER_ACTIVATION]
|
|
66
|
+
# and is of type [SUBORDINATE][google.cloud.security.privateca.v1.CertificateAuthority.Type.SUBORDINATE]. The
|
|
67
|
+
# CSR must then be signed by the desired parent Certificate Authority, which
|
|
68
|
+
# could be another [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] resource, or could be an on-prem
|
|
69
|
+
# certificate authority. See also [ActivateCertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthorityService.ActivateCertificateAuthority].
|
|
70
|
+
rpc :FetchCertificateAuthorityCsr, ::Google::Cloud::Security::PrivateCA::V1::FetchCertificateAuthorityCsrRequest, ::Google::Cloud::Security::PrivateCA::V1::FetchCertificateAuthorityCsrResponse
|
|
71
|
+
# Returns a [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority].
|
|
72
|
+
rpc :GetCertificateAuthority, ::Google::Cloud::Security::PrivateCA::V1::GetCertificateAuthorityRequest, ::Google::Cloud::Security::PrivateCA::V1::CertificateAuthority
|
|
73
|
+
# Lists [CertificateAuthorities][google.cloud.security.privateca.v1.CertificateAuthority].
|
|
74
|
+
rpc :ListCertificateAuthorities, ::Google::Cloud::Security::PrivateCA::V1::ListCertificateAuthoritiesRequest, ::Google::Cloud::Security::PrivateCA::V1::ListCertificateAuthoritiesResponse
|
|
75
|
+
# Undelete a [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] that has been deleted.
|
|
76
|
+
rpc :UndeleteCertificateAuthority, ::Google::Cloud::Security::PrivateCA::V1::UndeleteCertificateAuthorityRequest, ::Google::Longrunning::Operation
|
|
77
|
+
# Delete a [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority].
|
|
78
|
+
rpc :DeleteCertificateAuthority, ::Google::Cloud::Security::PrivateCA::V1::DeleteCertificateAuthorityRequest, ::Google::Longrunning::Operation
|
|
79
|
+
# Update a [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority].
|
|
80
|
+
rpc :UpdateCertificateAuthority, ::Google::Cloud::Security::PrivateCA::V1::UpdateCertificateAuthorityRequest, ::Google::Longrunning::Operation
|
|
81
|
+
# Create a [CaPool][google.cloud.security.privateca.v1.CaPool].
|
|
82
|
+
rpc :CreateCaPool, ::Google::Cloud::Security::PrivateCA::V1::CreateCaPoolRequest, ::Google::Longrunning::Operation
|
|
83
|
+
# Update a [CaPool][google.cloud.security.privateca.v1.CaPool].
|
|
84
|
+
rpc :UpdateCaPool, ::Google::Cloud::Security::PrivateCA::V1::UpdateCaPoolRequest, ::Google::Longrunning::Operation
|
|
85
|
+
# Returns a [CaPool][google.cloud.security.privateca.v1.CaPool].
|
|
86
|
+
rpc :GetCaPool, ::Google::Cloud::Security::PrivateCA::V1::GetCaPoolRequest, ::Google::Cloud::Security::PrivateCA::V1::CaPool
|
|
87
|
+
# Lists [CaPools][google.cloud.security.privateca.v1.CaPool].
|
|
88
|
+
rpc :ListCaPools, ::Google::Cloud::Security::PrivateCA::V1::ListCaPoolsRequest, ::Google::Cloud::Security::PrivateCA::V1::ListCaPoolsResponse
|
|
89
|
+
# Delete a [CaPool][google.cloud.security.privateca.v1.CaPool].
|
|
90
|
+
rpc :DeleteCaPool, ::Google::Cloud::Security::PrivateCA::V1::DeleteCaPoolRequest, ::Google::Longrunning::Operation
|
|
91
|
+
# FetchCaCerts returns the current trust anchor for the [CaPool][google.cloud.security.privateca.v1.CaPool]. This will
|
|
92
|
+
# include CA certificate chains for all ACTIVE [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
|
|
93
|
+
# resources in the [CaPool][google.cloud.security.privateca.v1.CaPool].
|
|
94
|
+
rpc :FetchCaCerts, ::Google::Cloud::Security::PrivateCA::V1::FetchCaCertsRequest, ::Google::Cloud::Security::PrivateCA::V1::FetchCaCertsResponse
|
|
95
|
+
# Returns a [CertificateRevocationList][google.cloud.security.privateca.v1.CertificateRevocationList].
|
|
96
|
+
rpc :GetCertificateRevocationList, ::Google::Cloud::Security::PrivateCA::V1::GetCertificateRevocationListRequest, ::Google::Cloud::Security::PrivateCA::V1::CertificateRevocationList
|
|
97
|
+
# Lists [CertificateRevocationLists][google.cloud.security.privateca.v1.CertificateRevocationList].
|
|
98
|
+
rpc :ListCertificateRevocationLists, ::Google::Cloud::Security::PrivateCA::V1::ListCertificateRevocationListsRequest, ::Google::Cloud::Security::PrivateCA::V1::ListCertificateRevocationListsResponse
|
|
99
|
+
# Update a [CertificateRevocationList][google.cloud.security.privateca.v1.CertificateRevocationList].
|
|
100
|
+
rpc :UpdateCertificateRevocationList, ::Google::Cloud::Security::PrivateCA::V1::UpdateCertificateRevocationListRequest, ::Google::Longrunning::Operation
|
|
101
|
+
# Create a new [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate] in a given Project and Location.
|
|
102
|
+
rpc :CreateCertificateTemplate, ::Google::Cloud::Security::PrivateCA::V1::CreateCertificateTemplateRequest, ::Google::Longrunning::Operation
|
|
103
|
+
# DeleteCertificateTemplate deletes a [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate].
|
|
104
|
+
rpc :DeleteCertificateTemplate, ::Google::Cloud::Security::PrivateCA::V1::DeleteCertificateTemplateRequest, ::Google::Longrunning::Operation
|
|
105
|
+
# Returns a [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate].
|
|
106
|
+
rpc :GetCertificateTemplate, ::Google::Cloud::Security::PrivateCA::V1::GetCertificateTemplateRequest, ::Google::Cloud::Security::PrivateCA::V1::CertificateTemplate
|
|
107
|
+
# Lists [CertificateTemplates][google.cloud.security.privateca.v1.CertificateTemplate].
|
|
108
|
+
rpc :ListCertificateTemplates, ::Google::Cloud::Security::PrivateCA::V1::ListCertificateTemplatesRequest, ::Google::Cloud::Security::PrivateCA::V1::ListCertificateTemplatesResponse
|
|
109
|
+
# Update a [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate].
|
|
110
|
+
rpc :UpdateCertificateTemplate, ::Google::Cloud::Security::PrivateCA::V1::UpdateCertificateTemplateRequest, ::Google::Longrunning::Operation
|
|
111
|
+
end
|
|
112
|
+
|
|
113
|
+
Stub = Service.rpc_stub_class
|
|
114
|
+
end
|
|
115
|
+
end
|
|
116
|
+
end
|
|
117
|
+
end
|
|
118
|
+
end
|
|
119
|
+
end
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2021 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 Api
|
|
22
|
+
# An indicator of the behavior of a given field (for example, that a field
|
|
23
|
+
# is required in requests, or given as output but ignored as input).
|
|
24
|
+
# This **does not** change the behavior in protocol buffers itself; it only
|
|
25
|
+
# denotes the behavior and may affect how API tooling handles the field.
|
|
26
|
+
#
|
|
27
|
+
# Note: This enum **may** receive new values in the future.
|
|
28
|
+
module FieldBehavior
|
|
29
|
+
# Conventional default for enums. Do not use this.
|
|
30
|
+
FIELD_BEHAVIOR_UNSPECIFIED = 0
|
|
31
|
+
|
|
32
|
+
# Specifically denotes a field as optional.
|
|
33
|
+
# While all fields in protocol buffers are optional, this may be specified
|
|
34
|
+
# for emphasis if appropriate.
|
|
35
|
+
OPTIONAL = 1
|
|
36
|
+
|
|
37
|
+
# Denotes a field as required.
|
|
38
|
+
# This indicates that the field **must** be provided as part of the request,
|
|
39
|
+
# and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
|
|
40
|
+
REQUIRED = 2
|
|
41
|
+
|
|
42
|
+
# Denotes a field as output only.
|
|
43
|
+
# This indicates that the field is provided in responses, but including the
|
|
44
|
+
# field in a request does nothing (the server *must* ignore it and
|
|
45
|
+
# *must not* throw an error as a result of the field's presence).
|
|
46
|
+
OUTPUT_ONLY = 3
|
|
47
|
+
|
|
48
|
+
# Denotes a field as input only.
|
|
49
|
+
# This indicates that the field is provided in requests, and the
|
|
50
|
+
# corresponding field is not included in output.
|
|
51
|
+
INPUT_ONLY = 4
|
|
52
|
+
|
|
53
|
+
# Denotes a field as immutable.
|
|
54
|
+
# This indicates that the field may be set once in a request to create a
|
|
55
|
+
# resource, but may not be changed thereafter.
|
|
56
|
+
IMMUTABLE = 5
|
|
57
|
+
|
|
58
|
+
# Denotes that a (repeated) field is an unordered list.
|
|
59
|
+
# This indicates that the service may provide the elements of the list
|
|
60
|
+
# in any arbitrary order, rather than the order the user originally
|
|
61
|
+
# provided. Additionally, the list's order may or may not be stable.
|
|
62
|
+
UNORDERED_LIST = 6
|
|
63
|
+
end
|
|
64
|
+
end
|
|
65
|
+
end
|
|
@@ -0,0 +1,283 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2021 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 Api
|
|
22
|
+
# A simple descriptor of a resource type.
|
|
23
|
+
#
|
|
24
|
+
# ResourceDescriptor annotates a resource message (either by means of a
|
|
25
|
+
# protobuf annotation or use in the service config), and associates the
|
|
26
|
+
# resource's schema, the resource type, and the pattern of the resource name.
|
|
27
|
+
#
|
|
28
|
+
# Example:
|
|
29
|
+
#
|
|
30
|
+
# message Topic {
|
|
31
|
+
# // Indicates this message defines a resource schema.
|
|
32
|
+
# // Declares the resource type in the format of {service}/{kind}.
|
|
33
|
+
# // For Kubernetes resources, the format is {api group}/{kind}.
|
|
34
|
+
# option (google.api.resource) = {
|
|
35
|
+
# type: "pubsub.googleapis.com/Topic"
|
|
36
|
+
# name_descriptor: {
|
|
37
|
+
# pattern: "projects/{project}/topics/{topic}"
|
|
38
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
|
39
|
+
# parent_name_extractor: "projects/{project}"
|
|
40
|
+
# }
|
|
41
|
+
# };
|
|
42
|
+
# }
|
|
43
|
+
#
|
|
44
|
+
# The ResourceDescriptor Yaml config will look like:
|
|
45
|
+
#
|
|
46
|
+
# resources:
|
|
47
|
+
# - type: "pubsub.googleapis.com/Topic"
|
|
48
|
+
# name_descriptor:
|
|
49
|
+
# - pattern: "projects/{project}/topics/{topic}"
|
|
50
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
|
51
|
+
# parent_name_extractor: "projects/{project}"
|
|
52
|
+
#
|
|
53
|
+
# Sometimes, resources have multiple patterns, typically because they can
|
|
54
|
+
# live under multiple parents.
|
|
55
|
+
#
|
|
56
|
+
# Example:
|
|
57
|
+
#
|
|
58
|
+
# message LogEntry {
|
|
59
|
+
# option (google.api.resource) = {
|
|
60
|
+
# type: "logging.googleapis.com/LogEntry"
|
|
61
|
+
# name_descriptor: {
|
|
62
|
+
# pattern: "projects/{project}/logs/{log}"
|
|
63
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
|
64
|
+
# parent_name_extractor: "projects/{project}"
|
|
65
|
+
# }
|
|
66
|
+
# name_descriptor: {
|
|
67
|
+
# pattern: "folders/{folder}/logs/{log}"
|
|
68
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
|
69
|
+
# parent_name_extractor: "folders/{folder}"
|
|
70
|
+
# }
|
|
71
|
+
# name_descriptor: {
|
|
72
|
+
# pattern: "organizations/{organization}/logs/{log}"
|
|
73
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Organization"
|
|
74
|
+
# parent_name_extractor: "organizations/{organization}"
|
|
75
|
+
# }
|
|
76
|
+
# name_descriptor: {
|
|
77
|
+
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
|
78
|
+
# parent_type: "billing.googleapis.com/BillingAccount"
|
|
79
|
+
# parent_name_extractor: "billingAccounts/{billing_account}"
|
|
80
|
+
# }
|
|
81
|
+
# };
|
|
82
|
+
# }
|
|
83
|
+
#
|
|
84
|
+
# The ResourceDescriptor Yaml config will look like:
|
|
85
|
+
#
|
|
86
|
+
# resources:
|
|
87
|
+
# - type: 'logging.googleapis.com/LogEntry'
|
|
88
|
+
# name_descriptor:
|
|
89
|
+
# - pattern: "projects/{project}/logs/{log}"
|
|
90
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
|
91
|
+
# parent_name_extractor: "projects/{project}"
|
|
92
|
+
# - pattern: "folders/{folder}/logs/{log}"
|
|
93
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
|
94
|
+
# parent_name_extractor: "folders/{folder}"
|
|
95
|
+
# - pattern: "organizations/{organization}/logs/{log}"
|
|
96
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Organization"
|
|
97
|
+
# parent_name_extractor: "organizations/{organization}"
|
|
98
|
+
# - pattern: "billingAccounts/{billing_account}/logs/{log}"
|
|
99
|
+
# parent_type: "billing.googleapis.com/BillingAccount"
|
|
100
|
+
# parent_name_extractor: "billingAccounts/{billing_account}"
|
|
101
|
+
#
|
|
102
|
+
# For flexible resources, the resource name doesn't contain parent names, but
|
|
103
|
+
# the resource itself has parents for policy evaluation.
|
|
104
|
+
#
|
|
105
|
+
# Example:
|
|
106
|
+
#
|
|
107
|
+
# message Shelf {
|
|
108
|
+
# option (google.api.resource) = {
|
|
109
|
+
# type: "library.googleapis.com/Shelf"
|
|
110
|
+
# name_descriptor: {
|
|
111
|
+
# pattern: "shelves/{shelf}"
|
|
112
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
|
113
|
+
# }
|
|
114
|
+
# name_descriptor: {
|
|
115
|
+
# pattern: "shelves/{shelf}"
|
|
116
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
|
117
|
+
# }
|
|
118
|
+
# };
|
|
119
|
+
# }
|
|
120
|
+
#
|
|
121
|
+
# The ResourceDescriptor Yaml config will look like:
|
|
122
|
+
#
|
|
123
|
+
# resources:
|
|
124
|
+
# - type: 'library.googleapis.com/Shelf'
|
|
125
|
+
# name_descriptor:
|
|
126
|
+
# - pattern: "shelves/{shelf}"
|
|
127
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
|
128
|
+
# - pattern: "shelves/{shelf}"
|
|
129
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
|
130
|
+
# @!attribute [rw] type
|
|
131
|
+
# @return [::String]
|
|
132
|
+
# The resource type. It must be in the format of
|
|
133
|
+
# \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
|
|
134
|
+
# singular and must not include version numbers.
|
|
135
|
+
#
|
|
136
|
+
# Example: `storage.googleapis.com/Bucket`
|
|
137
|
+
#
|
|
138
|
+
# The value of the resource_type_kind must follow the regular expression
|
|
139
|
+
# /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
|
|
140
|
+
# should use PascalCase (UpperCamelCase). The maximum number of
|
|
141
|
+
# characters allowed for the `resource_type_kind` is 100.
|
|
142
|
+
# @!attribute [rw] pattern
|
|
143
|
+
# @return [::Array<::String>]
|
|
144
|
+
# Optional. The relative resource name pattern associated with this resource
|
|
145
|
+
# type. The DNS prefix of the full resource name shouldn't be specified here.
|
|
146
|
+
#
|
|
147
|
+
# The path pattern must follow the syntax, which aligns with HTTP binding
|
|
148
|
+
# syntax:
|
|
149
|
+
#
|
|
150
|
+
# Template = Segment { "/" Segment } ;
|
|
151
|
+
# Segment = LITERAL | Variable ;
|
|
152
|
+
# Variable = "{" LITERAL "}" ;
|
|
153
|
+
#
|
|
154
|
+
# Examples:
|
|
155
|
+
#
|
|
156
|
+
# - "projects/\\{project}/topics/\\{topic}"
|
|
157
|
+
# - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
|
|
158
|
+
#
|
|
159
|
+
# The components in braces correspond to the IDs for each resource in the
|
|
160
|
+
# hierarchy. It is expected that, if multiple patterns are provided,
|
|
161
|
+
# the same component name (e.g. "project") refers to IDs of the same
|
|
162
|
+
# type of resource.
|
|
163
|
+
# @!attribute [rw] name_field
|
|
164
|
+
# @return [::String]
|
|
165
|
+
# Optional. The field on the resource that designates the resource name
|
|
166
|
+
# field. If omitted, this is assumed to be "name".
|
|
167
|
+
# @!attribute [rw] history
|
|
168
|
+
# @return [::Google::Api::ResourceDescriptor::History]
|
|
169
|
+
# Optional. The historical or future-looking state of the resource pattern.
|
|
170
|
+
#
|
|
171
|
+
# Example:
|
|
172
|
+
#
|
|
173
|
+
# // The InspectTemplate message originally only supported resource
|
|
174
|
+
# // names with organization, and project was added later.
|
|
175
|
+
# message InspectTemplate {
|
|
176
|
+
# option (google.api.resource) = {
|
|
177
|
+
# type: "dlp.googleapis.com/InspectTemplate"
|
|
178
|
+
# pattern:
|
|
179
|
+
# "organizations/{organization}/inspectTemplates/{inspect_template}"
|
|
180
|
+
# pattern: "projects/{project}/inspectTemplates/{inspect_template}"
|
|
181
|
+
# history: ORIGINALLY_SINGLE_PATTERN
|
|
182
|
+
# };
|
|
183
|
+
# }
|
|
184
|
+
# @!attribute [rw] plural
|
|
185
|
+
# @return [::String]
|
|
186
|
+
# The plural name used in the resource name and permission names, such as
|
|
187
|
+
# 'projects' for the resource name of 'projects/\\{project}' and the permission
|
|
188
|
+
# name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
|
|
189
|
+
# concept of the `plural` field in k8s CRD spec
|
|
190
|
+
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
|
191
|
+
#
|
|
192
|
+
# Note: The plural form is required even for singleton resources. See
|
|
193
|
+
# https://aip.dev/156
|
|
194
|
+
# @!attribute [rw] singular
|
|
195
|
+
# @return [::String]
|
|
196
|
+
# The same concept of the `singular` field in k8s CRD spec
|
|
197
|
+
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
|
198
|
+
# Such as "project" for the `resourcemanager.googleapis.com/Project` type.
|
|
199
|
+
# @!attribute [rw] style
|
|
200
|
+
# @return [::Array<::Google::Api::ResourceDescriptor::Style>]
|
|
201
|
+
# Style flag(s) for this resource.
|
|
202
|
+
# These indicate that a resource is expected to conform to a given
|
|
203
|
+
# style. See the specific style flags for additional information.
|
|
204
|
+
class ResourceDescriptor
|
|
205
|
+
include ::Google::Protobuf::MessageExts
|
|
206
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
207
|
+
|
|
208
|
+
# A description of the historical or future-looking state of the
|
|
209
|
+
# resource pattern.
|
|
210
|
+
module History
|
|
211
|
+
# The "unset" value.
|
|
212
|
+
HISTORY_UNSPECIFIED = 0
|
|
213
|
+
|
|
214
|
+
# The resource originally had one pattern and launched as such, and
|
|
215
|
+
# additional patterns were added later.
|
|
216
|
+
ORIGINALLY_SINGLE_PATTERN = 1
|
|
217
|
+
|
|
218
|
+
# The resource has one pattern, but the API owner expects to add more
|
|
219
|
+
# later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
|
|
220
|
+
# that from being necessary once there are multiple patterns.)
|
|
221
|
+
FUTURE_MULTI_PATTERN = 2
|
|
222
|
+
end
|
|
223
|
+
|
|
224
|
+
# A flag representing a specific style that a resource claims to conform to.
|
|
225
|
+
module Style
|
|
226
|
+
# The unspecified value. Do not use.
|
|
227
|
+
STYLE_UNSPECIFIED = 0
|
|
228
|
+
|
|
229
|
+
# This resource is intended to be "declarative-friendly".
|
|
230
|
+
#
|
|
231
|
+
# Declarative-friendly resources must be more strictly consistent, and
|
|
232
|
+
# setting this to true communicates to tools that this resource should
|
|
233
|
+
# adhere to declarative-friendly expectations.
|
|
234
|
+
#
|
|
235
|
+
# Note: This is used by the API linter (linter.aip.dev) to enable
|
|
236
|
+
# additional checks.
|
|
237
|
+
DECLARATIVE_FRIENDLY = 1
|
|
238
|
+
end
|
|
239
|
+
end
|
|
240
|
+
|
|
241
|
+
# Defines a proto annotation that describes a string field that refers to
|
|
242
|
+
# an API resource.
|
|
243
|
+
# @!attribute [rw] type
|
|
244
|
+
# @return [::String]
|
|
245
|
+
# The resource type that the annotated field references.
|
|
246
|
+
#
|
|
247
|
+
# Example:
|
|
248
|
+
#
|
|
249
|
+
# message Subscription {
|
|
250
|
+
# string topic = 2 [(google.api.resource_reference) = {
|
|
251
|
+
# type: "pubsub.googleapis.com/Topic"
|
|
252
|
+
# }];
|
|
253
|
+
# }
|
|
254
|
+
#
|
|
255
|
+
# Occasionally, a field may reference an arbitrary resource. In this case,
|
|
256
|
+
# APIs use the special value * in their resource reference.
|
|
257
|
+
#
|
|
258
|
+
# Example:
|
|
259
|
+
#
|
|
260
|
+
# message GetIamPolicyRequest {
|
|
261
|
+
# string resource = 2 [(google.api.resource_reference) = {
|
|
262
|
+
# type: "*"
|
|
263
|
+
# }];
|
|
264
|
+
# }
|
|
265
|
+
# @!attribute [rw] child_type
|
|
266
|
+
# @return [::String]
|
|
267
|
+
# The resource type of a child collection that the annotated field
|
|
268
|
+
# references. This is useful for annotating the `parent` field that
|
|
269
|
+
# doesn't have a fixed resource type.
|
|
270
|
+
#
|
|
271
|
+
# Example:
|
|
272
|
+
#
|
|
273
|
+
# message ListLogEntriesRequest {
|
|
274
|
+
# string parent = 1 [(google.api.resource_reference) = {
|
|
275
|
+
# child_type: "logging.googleapis.com/LogEntry"
|
|
276
|
+
# };
|
|
277
|
+
# }
|
|
278
|
+
class ResourceReference
|
|
279
|
+
include ::Google::Protobuf::MessageExts
|
|
280
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
281
|
+
end
|
|
282
|
+
end
|
|
283
|
+
end
|