google-cloud-api_hub-v1 0.a → 0.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +122 -0
- data/README.md +144 -8
- data/lib/google/cloud/api_hub/v1/api_hub/client.rb +4514 -0
- data/lib/google/cloud/api_hub/v1/api_hub/credentials.rb +47 -0
- data/lib/google/cloud/api_hub/v1/api_hub/paths.rb +216 -0
- data/lib/google/cloud/api_hub/v1/api_hub/rest/client.rb +4251 -0
- data/lib/google/cloud/api_hub/v1/api_hub/rest/service_stub.rb +2147 -0
- data/lib/google/cloud/api_hub/v1/api_hub/rest.rb +53 -0
- data/lib/google/cloud/api_hub/v1/api_hub.rb +55 -0
- data/lib/google/cloud/api_hub/v1/api_hub_dependencies/client.rb +906 -0
- data/lib/google/cloud/api_hub/v1/api_hub_dependencies/credentials.rb +47 -0
- data/lib/google/cloud/api_hub/v1/api_hub_dependencies/paths.rb +88 -0
- data/lib/google/cloud/api_hub/v1/api_hub_dependencies/rest/client.rb +853 -0
- data/lib/google/cloud/api_hub/v1/api_hub_dependencies/rest/service_stub.rb +366 -0
- data/lib/google/cloud/api_hub/v1/api_hub_dependencies/rest.rb +54 -0
- data/lib/google/cloud/api_hub/v1/api_hub_dependencies.rb +56 -0
- data/lib/google/cloud/api_hub/v1/api_hub_plugin/client.rb +640 -0
- data/lib/google/cloud/api_hub/v1/api_hub_plugin/credentials.rb +47 -0
- data/lib/google/cloud/api_hub/v1/api_hub_plugin/paths.rb +52 -0
- data/lib/google/cloud/api_hub/v1/api_hub_plugin/rest/client.rb +601 -0
- data/lib/google/cloud/api_hub/v1/api_hub_plugin/rest/service_stub.rb +248 -0
- data/lib/google/cloud/api_hub/v1/api_hub_plugin/rest.rb +53 -0
- data/lib/google/cloud/api_hub/v1/api_hub_plugin.rb +55 -0
- data/lib/google/cloud/api_hub/v1/bindings_override.rb +102 -0
- data/lib/google/cloud/api_hub/v1/host_project_registration_service/client.rb +689 -0
- data/lib/google/cloud/api_hub/v1/host_project_registration_service/credentials.rb +47 -0
- data/lib/google/cloud/api_hub/v1/host_project_registration_service/paths.rb +83 -0
- data/lib/google/cloud/api_hub/v1/host_project_registration_service/rest/client.rb +650 -0
- data/lib/google/cloud/api_hub/v1/host_project_registration_service/rest/service_stub.rb +247 -0
- data/lib/google/cloud/api_hub/v1/host_project_registration_service/rest.rb +53 -0
- data/lib/google/cloud/api_hub/v1/host_project_registration_service.rb +55 -0
- data/lib/google/cloud/api_hub/v1/linting_service/client.rb +744 -0
- data/lib/google/cloud/api_hub/v1/linting_service/credentials.rb +47 -0
- data/lib/google/cloud/api_hub/v1/linting_service/paths.rb +75 -0
- data/lib/google/cloud/api_hub/v1/linting_service/rest/client.rb +698 -0
- data/lib/google/cloud/api_hub/v1/linting_service/rest/service_stub.rb +307 -0
- data/lib/google/cloud/api_hub/v1/linting_service/rest.rb +53 -0
- data/lib/google/cloud/api_hub/v1/linting_service.rb +55 -0
- data/lib/google/cloud/api_hub/v1/provisioning/client.rb +676 -0
- data/lib/google/cloud/api_hub/v1/provisioning/credentials.rb +47 -0
- data/lib/google/cloud/api_hub/v1/provisioning/operations.rb +809 -0
- data/lib/google/cloud/api_hub/v1/provisioning/paths.rb +69 -0
- data/lib/google/cloud/api_hub/v1/provisioning/rest/client.rb +637 -0
- data/lib/google/cloud/api_hub/v1/provisioning/rest/operations.rb +902 -0
- data/lib/google/cloud/api_hub/v1/provisioning/rest/service_stub.rb +247 -0
- data/lib/google/cloud/api_hub/v1/provisioning/rest.rb +54 -0
- data/lib/google/cloud/api_hub/v1/provisioning.rb +56 -0
- data/lib/google/cloud/api_hub/v1/rest.rb +44 -0
- data/lib/google/cloud/api_hub/v1/runtime_project_attachment_service/client.rb +885 -0
- data/lib/google/cloud/api_hub/v1/runtime_project_attachment_service/credentials.rb +47 -0
- data/lib/google/cloud/api_hub/v1/runtime_project_attachment_service/paths.rb +83 -0
- data/lib/google/cloud/api_hub/v1/runtime_project_attachment_service/rest/client.rb +832 -0
- data/lib/google/cloud/api_hub/v1/runtime_project_attachment_service/rest/service_stub.rb +365 -0
- data/lib/google/cloud/api_hub/v1/runtime_project_attachment_service/rest.rb +53 -0
- data/lib/google/cloud/api_hub/v1/runtime_project_attachment_service.rb +55 -0
- data/lib/google/cloud/api_hub/v1/version.rb +7 -2
- data/lib/google/cloud/api_hub/v1.rb +51 -0
- data/lib/google/cloud/apihub/v1/apihub_service_pb.rb +102 -0
- data/lib/google/cloud/apihub/v1/apihub_service_services_pb.rb +288 -0
- data/lib/google/cloud/apihub/v1/common_fields_pb.rb +92 -0
- data/lib/google/cloud/apihub/v1/host_project_registration_service_pb.rb +53 -0
- data/lib/google/cloud/apihub/v1/host_project_registration_service_services_pb.rb +53 -0
- data/lib/google/cloud/apihub/v1/linting_service_pb.rb +56 -0
- data/lib/google/cloud/apihub/v1/linting_service_services_pb.rb +53 -0
- data/lib/google/cloud/apihub/v1/plugin_service_pb.rb +53 -0
- data/lib/google/cloud/apihub/v1/plugin_service_services_pb.rb +51 -0
- data/lib/google/cloud/apihub/v1/provisioning_service_pb.rb +53 -0
- data/lib/google/cloud/apihub/v1/provisioning_service_services_pb.rb +50 -0
- data/lib/google/cloud/apihub/v1/runtime_project_attachment_service_pb.rb +57 -0
- data/lib/google/cloud/apihub/v1/runtime_project_attachment_service_services_pb.rb +55 -0
- data/lib/google-cloud-api_hub-v1.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/client.rb +420 -0
- data/proto_docs/google/api/field_behavior.rb +85 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/api/resource.rb +227 -0
- data/proto_docs/google/cloud/apihub/v1/apihub_service.rb +1317 -0
- data/proto_docs/google/cloud/apihub/v1/common_fields.rb +1296 -0
- data/proto_docs/google/cloud/apihub/v1/host_project_registration_service.rb +146 -0
- data/proto_docs/google/cloud/apihub/v1/linting_service.rb +103 -0
- data/proto_docs/google/cloud/apihub/v1/plugin_service.rb +104 -0
- data/proto_docs/google/cloud/apihub/v1/provisioning_service.rb +87 -0
- data/proto_docs/google/cloud/apihub/v1/runtime_project_attachment_service.rb +182 -0
- data/proto_docs/google/longrunning/operations.rb +164 -0
- data/proto_docs/google/protobuf/any.rb +145 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +34 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/protobuf/timestamp.rb +127 -0
- data/proto_docs/google/rpc/status.rb +48 -0
- metadata +155 -10
@@ -0,0 +1,1317 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2024 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 ApiHub
|
23
|
+
module V1
|
24
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#create_api CreateApi} method's request.
|
25
|
+
# @!attribute [rw] parent
|
26
|
+
# @return [::String]
|
27
|
+
# Required. The parent resource for the API resource.
|
28
|
+
# Format: `projects/{project}/locations/{location}`
|
29
|
+
# @!attribute [rw] api_id
|
30
|
+
# @return [::String]
|
31
|
+
# Optional. The ID to use for the API resource, which will become the final
|
32
|
+
# component of the API's resource name. This field is optional.
|
33
|
+
#
|
34
|
+
# * If provided, the same will be used. The service will throw an error if
|
35
|
+
# the specified id is already used by another API resource in the API hub.
|
36
|
+
# * If not provided, a system generated id will be used.
|
37
|
+
#
|
38
|
+
# This value should be 4-500 characters, and valid characters
|
39
|
+
# are /[a-z][A-Z][0-9]-_/.
|
40
|
+
# @!attribute [rw] api
|
41
|
+
# @return [::Google::Cloud::ApiHub::V1::Api]
|
42
|
+
# Required. The API resource to create.
|
43
|
+
class CreateApiRequest
|
44
|
+
include ::Google::Protobuf::MessageExts
|
45
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
46
|
+
end
|
47
|
+
|
48
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#get_api GetApi} method's request.
|
49
|
+
# @!attribute [rw] name
|
50
|
+
# @return [::String]
|
51
|
+
# Required. The name of the API resource to retrieve.
|
52
|
+
# Format: `projects/{project}/locations/{location}/apis/{api}`
|
53
|
+
class GetApiRequest
|
54
|
+
include ::Google::Protobuf::MessageExts
|
55
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
56
|
+
end
|
57
|
+
|
58
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#update_api UpdateApi} method's request.
|
59
|
+
# @!attribute [rw] api
|
60
|
+
# @return [::Google::Cloud::ApiHub::V1::Api]
|
61
|
+
# Required. The API resource to update.
|
62
|
+
#
|
63
|
+
# The API resource's `name` field is used to identify the API resource to
|
64
|
+
# update.
|
65
|
+
# Format: `projects/{project}/locations/{location}/apis/{api}`
|
66
|
+
# @!attribute [rw] update_mask
|
67
|
+
# @return [::Google::Protobuf::FieldMask]
|
68
|
+
# Required. The list of fields to update.
|
69
|
+
class UpdateApiRequest
|
70
|
+
include ::Google::Protobuf::MessageExts
|
71
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
72
|
+
end
|
73
|
+
|
74
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#delete_api DeleteApi} method's request.
|
75
|
+
# @!attribute [rw] name
|
76
|
+
# @return [::String]
|
77
|
+
# Required. The name of the API resource to delete.
|
78
|
+
# Format: `projects/{project}/locations/{location}/apis/{api}`
|
79
|
+
# @!attribute [rw] force
|
80
|
+
# @return [::Boolean]
|
81
|
+
# Optional. If set to true, any versions from this API will also be deleted.
|
82
|
+
# Otherwise, the request will only work if the API has no versions.
|
83
|
+
class DeleteApiRequest
|
84
|
+
include ::Google::Protobuf::MessageExts
|
85
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
86
|
+
end
|
87
|
+
|
88
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#list_apis ListApis} method's request.
|
89
|
+
# @!attribute [rw] parent
|
90
|
+
# @return [::String]
|
91
|
+
# Required. The parent, which owns this collection of API resources.
|
92
|
+
# Format: `projects/{project}/locations/{location}`
|
93
|
+
# @!attribute [rw] filter
|
94
|
+
# @return [::String]
|
95
|
+
# Optional. An expression that filters the list of ApiResources.
|
96
|
+
#
|
97
|
+
# A filter expression consists of a field name, a comparison
|
98
|
+
# operator, and a value for filtering. The value must be a string. The
|
99
|
+
# comparison operator must be one of: `<`, `>`, `:` or `=`. Filters are not
|
100
|
+
# case sensitive.
|
101
|
+
#
|
102
|
+
# The following fields in the `ApiResource` are eligible for filtering:
|
103
|
+
#
|
104
|
+
# * `owner.email` - The email of the team which owns the ApiResource.
|
105
|
+
# Allowed comparison operators: `=`.
|
106
|
+
# * `create_time` - The time at which the ApiResource was created. The
|
107
|
+
# value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
|
108
|
+
# format. Allowed comparison operators: `>` and `<`.
|
109
|
+
# * `display_name` - The display name of the ApiResource. Allowed
|
110
|
+
# comparison operators: `=`.
|
111
|
+
# * `target_user.enum_values.values.id` - The allowed value id of the
|
112
|
+
# target users attribute associated with the ApiResource. Allowed
|
113
|
+
# comparison operator is `:`.
|
114
|
+
# * `target_user.enum_values.values.display_name` - The allowed value
|
115
|
+
# display name of the target users attribute associated with the
|
116
|
+
# ApiResource. Allowed comparison operator is `:`.
|
117
|
+
# * `team.enum_values.values.id` - The allowed value id of the team
|
118
|
+
# attribute associated with the ApiResource. Allowed comparison operator is
|
119
|
+
# `:`.
|
120
|
+
# * `team.enum_values.values.display_name` - The allowed value display name
|
121
|
+
# of the team attribute associated with the ApiResource. Allowed comparison
|
122
|
+
# operator is `:`.
|
123
|
+
# * `business_unit.enum_values.values.id` - The allowed value id of the
|
124
|
+
# business unit attribute associated with the ApiResource. Allowed
|
125
|
+
# comparison operator is `:`.
|
126
|
+
# * `business_unit.enum_values.values.display_name` - The allowed value
|
127
|
+
# display name of the business unit attribute associated with the
|
128
|
+
# ApiResource. Allowed comparison operator is `:`.
|
129
|
+
# * `maturity_level.enum_values.values.id` - The allowed value id of the
|
130
|
+
# maturity level attribute associated with the ApiResource. Allowed
|
131
|
+
# comparison operator is `:`.
|
132
|
+
# * `maturity_level.enum_values.values.display_name` - The allowed value
|
133
|
+
# display name of the maturity level attribute associated with the
|
134
|
+
# ApiResource. Allowed comparison operator is `:`.
|
135
|
+
# * `api_style.enum_values.values.id` - The allowed value id of the
|
136
|
+
# api style attribute associated with the ApiResource. Allowed
|
137
|
+
# comparison operator is `:`.
|
138
|
+
# * `api_style.enum_values.values.display_name` - The allowed value display
|
139
|
+
# name of the api style attribute associated with the ApiResource. Allowed
|
140
|
+
# comparison operator is `:`.
|
141
|
+
#
|
142
|
+
# Expressions are combined with either `AND` logic operator or `OR` logical
|
143
|
+
# operator but not both of them together i.e. only one of the `AND` or `OR`
|
144
|
+
# operator can be used throughout the filter string and both the operators
|
145
|
+
# cannot be used together. No other logical operators are supported. At most
|
146
|
+
# three filter fields are allowed in the filter string and if provided
|
147
|
+
# more than that then `INVALID_ARGUMENT` error is returned by the API.
|
148
|
+
#
|
149
|
+
# Here are a few examples:
|
150
|
+
#
|
151
|
+
# * `owner.email = \"apihub@google.com\"` - - The owner team email is
|
152
|
+
# _apihub@google.com_.
|
153
|
+
# * `owner.email = \"apihub@google.com\" AND create_time <
|
154
|
+
# \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"` -
|
155
|
+
# The owner team email is _apihub@google.com_ and the api was created
|
156
|
+
# before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_.
|
157
|
+
# * `owner.email = \"apihub@google.com\" OR team.enum_values.values.id:
|
158
|
+
# apihub-team-id` - The filter string specifies the APIs where the owner
|
159
|
+
# team email is _apihub@google.com_ or the id of the allowed value
|
160
|
+
# associated with the team attribute is _apihub-team-id_.
|
161
|
+
# * `owner.email = \"apihub@google.com\" OR
|
162
|
+
# team.enum_values.values.display_name: ApiHub Team` - The filter string
|
163
|
+
# specifies the APIs where the owner team email is _apihub@google.com_ or
|
164
|
+
# the display name of the allowed value associated with the team attribute
|
165
|
+
# is `ApiHub Team`.
|
166
|
+
# @!attribute [rw] page_size
|
167
|
+
# @return [::Integer]
|
168
|
+
# Optional. The maximum number of API resources to return. The service may
|
169
|
+
# return fewer than this value. If unspecified, at most 50 Apis will be
|
170
|
+
# returned. The maximum value is 1000; values above 1000 will be coerced to
|
171
|
+
# 1000.
|
172
|
+
# @!attribute [rw] page_token
|
173
|
+
# @return [::String]
|
174
|
+
# Optional. A page token, received from a previous `ListApis` call.
|
175
|
+
# Provide this to retrieve the subsequent page.
|
176
|
+
#
|
177
|
+
# When paginating, all other parameters (except page_size) provided to
|
178
|
+
# `ListApis` must match the call that provided the page token.
|
179
|
+
class ListApisRequest
|
180
|
+
include ::Google::Protobuf::MessageExts
|
181
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
182
|
+
end
|
183
|
+
|
184
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#list_apis ListApis} method's response.
|
185
|
+
# @!attribute [rw] apis
|
186
|
+
# @return [::Array<::Google::Cloud::ApiHub::V1::Api>]
|
187
|
+
# The API resources present in the API hub.
|
188
|
+
# @!attribute [rw] next_page_token
|
189
|
+
# @return [::String]
|
190
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
191
|
+
# If this field is omitted, there are no subsequent pages.
|
192
|
+
class ListApisResponse
|
193
|
+
include ::Google::Protobuf::MessageExts
|
194
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
195
|
+
end
|
196
|
+
|
197
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#create_version CreateVersion} method's
|
198
|
+
# request.
|
199
|
+
# @!attribute [rw] parent
|
200
|
+
# @return [::String]
|
201
|
+
# Required. The parent resource for API version.
|
202
|
+
# Format: `projects/{project}/locations/{location}/apis/{api}`
|
203
|
+
# @!attribute [rw] version_id
|
204
|
+
# @return [::String]
|
205
|
+
# Optional. The ID to use for the API version, which will become the final
|
206
|
+
# component of the version's resource name. This field is optional.
|
207
|
+
#
|
208
|
+
# * If provided, the same will be used. The service will throw an error if
|
209
|
+
# the specified id is already used by another version in the API resource.
|
210
|
+
# * If not provided, a system generated id will be used.
|
211
|
+
#
|
212
|
+
# This value should be 4-500 characters, and valid characters
|
213
|
+
# are /[a-z][A-Z][0-9]-_/.
|
214
|
+
# @!attribute [rw] version
|
215
|
+
# @return [::Google::Cloud::ApiHub::V1::Version]
|
216
|
+
# Required. The version to create.
|
217
|
+
class CreateVersionRequest
|
218
|
+
include ::Google::Protobuf::MessageExts
|
219
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
220
|
+
end
|
221
|
+
|
222
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#get_version GetVersion} method's request.
|
223
|
+
# @!attribute [rw] name
|
224
|
+
# @return [::String]
|
225
|
+
# Required. The name of the API version to retrieve.
|
226
|
+
# Format:
|
227
|
+
# `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
|
228
|
+
class GetVersionRequest
|
229
|
+
include ::Google::Protobuf::MessageExts
|
230
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
231
|
+
end
|
232
|
+
|
233
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#update_version UpdateVersion} method's
|
234
|
+
# request.
|
235
|
+
# @!attribute [rw] version
|
236
|
+
# @return [::Google::Cloud::ApiHub::V1::Version]
|
237
|
+
# Required. The API version to update.
|
238
|
+
#
|
239
|
+
# The version's `name` field is used to identify the API version to update.
|
240
|
+
# Format:
|
241
|
+
# `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
|
242
|
+
# @!attribute [rw] update_mask
|
243
|
+
# @return [::Google::Protobuf::FieldMask]
|
244
|
+
# Required. The list of fields to update.
|
245
|
+
class UpdateVersionRequest
|
246
|
+
include ::Google::Protobuf::MessageExts
|
247
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
248
|
+
end
|
249
|
+
|
250
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#delete_version DeleteVersion} method's
|
251
|
+
# request.
|
252
|
+
# @!attribute [rw] name
|
253
|
+
# @return [::String]
|
254
|
+
# Required. The name of the version to delete.
|
255
|
+
# Format:
|
256
|
+
# `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
|
257
|
+
# @!attribute [rw] force
|
258
|
+
# @return [::Boolean]
|
259
|
+
# Optional. If set to true, any specs from this version will also be deleted.
|
260
|
+
# Otherwise, the request will only work if the version has no specs.
|
261
|
+
class DeleteVersionRequest
|
262
|
+
include ::Google::Protobuf::MessageExts
|
263
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
264
|
+
end
|
265
|
+
|
266
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#list_versions ListVersions} method's
|
267
|
+
# request.
|
268
|
+
# @!attribute [rw] parent
|
269
|
+
# @return [::String]
|
270
|
+
# Required. The parent which owns this collection of API versions i.e., the
|
271
|
+
# API resource Format: `projects/{project}/locations/{location}/apis/{api}`
|
272
|
+
# @!attribute [rw] filter
|
273
|
+
# @return [::String]
|
274
|
+
# Optional. An expression that filters the list of Versions.
|
275
|
+
#
|
276
|
+
# A filter expression consists of a field name, a comparison
|
277
|
+
# operator, and a value for filtering. The value must be a string, a
|
278
|
+
# number, or a boolean. The comparison operator must be one of: `<`, `>` or
|
279
|
+
# `=`. Filters are not case sensitive.
|
280
|
+
#
|
281
|
+
# The following fields in the `Version` are eligible for filtering:
|
282
|
+
#
|
283
|
+
# * `display_name` - The display name of the Version. Allowed
|
284
|
+
# comparison operators: `=`.
|
285
|
+
# * `create_time` - The time at which the Version was created. The
|
286
|
+
# value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
|
287
|
+
# format. Allowed comparison operators: `>` and `<`.
|
288
|
+
# * `lifecycle.enum_values.values.id` - The allowed value id of the
|
289
|
+
# lifecycle attribute associated with the Version. Allowed comparison
|
290
|
+
# operators: `:`.
|
291
|
+
# * `lifecycle.enum_values.values.display_name` - The allowed value display
|
292
|
+
# name of the lifecycle attribute associated with the Version. Allowed
|
293
|
+
# comparison operators: `:`.
|
294
|
+
# * `compliance.enum_values.values.id` - The allowed value id of the
|
295
|
+
# compliances attribute associated with the Version. Allowed comparison
|
296
|
+
# operators: `:`.
|
297
|
+
# * `compliance.enum_values.values.display_name` - The allowed value
|
298
|
+
# display name of the compliances attribute associated with the Version.
|
299
|
+
# Allowed comparison operators: `:`.
|
300
|
+
# * `accreditation.enum_values.values.id` - The allowed value id of the
|
301
|
+
# accreditations attribute associated with the Version. Allowed
|
302
|
+
# comparison operators: `:`.
|
303
|
+
# * `accreditation.enum_values.values.display_name` - The allowed value
|
304
|
+
# display name of the accreditations attribute associated with the Version.
|
305
|
+
# Allowed comparison operators: `:`.
|
306
|
+
#
|
307
|
+
# Expressions are combined with either `AND` logic operator or `OR` logical
|
308
|
+
# operator but not both of them together i.e. only one of the `AND` or `OR`
|
309
|
+
# operator can be used throughout the filter string and both the operators
|
310
|
+
# cannot be used together. No other logical operators are
|
311
|
+
# supported. At most three filter fields are allowed in the filter
|
312
|
+
# string and if provided more than that then `INVALID_ARGUMENT` error is
|
313
|
+
# returned by the API.
|
314
|
+
#
|
315
|
+
# Here are a few examples:
|
316
|
+
#
|
317
|
+
# * `lifecycle.enum_values.values.id: preview-id` - The filter string
|
318
|
+
# specifies that the id of the allowed value associated with the lifecycle
|
319
|
+
# attribute of the Version is _preview-id_.
|
320
|
+
# * `lifecycle.enum_values.values.display_name: \"Preview Display Name\"` -
|
321
|
+
# The filter string specifies that the display name of the allowed value
|
322
|
+
# associated with the lifecycle attribute of the Version is `Preview
|
323
|
+
# Display Name`.
|
324
|
+
# * `lifecycle.enum_values.values.id: preview-id AND create_time <
|
325
|
+
# \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"` -
|
326
|
+
# The id of the allowed value associated with the lifecycle attribute of
|
327
|
+
# the Version is _preview-id_ and it was created before _2021-08-15
|
328
|
+
# 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_.
|
329
|
+
# * `compliance.enum_values.values.id: gdpr-id OR
|
330
|
+
# compliance.enum_values.values.id: pci-dss-id`
|
331
|
+
# - The id of the allowed value associated with the compliance attribute is
|
332
|
+
# _gdpr-id_ or _pci-dss-id_.
|
333
|
+
# @!attribute [rw] page_size
|
334
|
+
# @return [::Integer]
|
335
|
+
# Optional. The maximum number of versions to return. The service may return
|
336
|
+
# fewer than this value. If unspecified, at most 50 versions will be
|
337
|
+
# returned. The maximum value is 1000; values above 1000 will be coerced to
|
338
|
+
# 1000.
|
339
|
+
# @!attribute [rw] page_token
|
340
|
+
# @return [::String]
|
341
|
+
# Optional. A page token, received from a previous `ListVersions` call.
|
342
|
+
# Provide this to retrieve the subsequent page.
|
343
|
+
#
|
344
|
+
# When paginating, all other parameters (except page_size) provided to
|
345
|
+
# `ListVersions` must match the call that provided the page token.
|
346
|
+
class ListVersionsRequest
|
347
|
+
include ::Google::Protobuf::MessageExts
|
348
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
349
|
+
end
|
350
|
+
|
351
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#list_versions ListVersions} method's
|
352
|
+
# response.
|
353
|
+
# @!attribute [rw] versions
|
354
|
+
# @return [::Array<::Google::Cloud::ApiHub::V1::Version>]
|
355
|
+
# The versions corresponding to an API.
|
356
|
+
# @!attribute [rw] next_page_token
|
357
|
+
# @return [::String]
|
358
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
359
|
+
# If this field is omitted, there are no subsequent pages.
|
360
|
+
class ListVersionsResponse
|
361
|
+
include ::Google::Protobuf::MessageExts
|
362
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
363
|
+
end
|
364
|
+
|
365
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#create_spec CreateSpec} method's request.
|
366
|
+
# @!attribute [rw] parent
|
367
|
+
# @return [::String]
|
368
|
+
# Required. The parent resource for Spec.
|
369
|
+
# Format:
|
370
|
+
# `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
|
371
|
+
# @!attribute [rw] spec_id
|
372
|
+
# @return [::String]
|
373
|
+
# Optional. The ID to use for the spec, which will become the final component
|
374
|
+
# of the spec's resource name. This field is optional.
|
375
|
+
#
|
376
|
+
# * If provided, the same will be used. The service will throw an error if
|
377
|
+
# the specified id is already used by another spec in the API
|
378
|
+
# resource.
|
379
|
+
# * If not provided, a system generated id will be used.
|
380
|
+
#
|
381
|
+
# This value should be 4-500 characters, and valid characters
|
382
|
+
# are /[a-z][A-Z][0-9]-_/.
|
383
|
+
# @!attribute [rw] spec
|
384
|
+
# @return [::Google::Cloud::ApiHub::V1::Spec]
|
385
|
+
# Required. The spec to create.
|
386
|
+
class CreateSpecRequest
|
387
|
+
include ::Google::Protobuf::MessageExts
|
388
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
389
|
+
end
|
390
|
+
|
391
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#get_spec GetSpec} method's request.
|
392
|
+
# @!attribute [rw] name
|
393
|
+
# @return [::String]
|
394
|
+
# Required. The name of the spec to retrieve.
|
395
|
+
# Format:
|
396
|
+
# `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
|
397
|
+
class GetSpecRequest
|
398
|
+
include ::Google::Protobuf::MessageExts
|
399
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
400
|
+
end
|
401
|
+
|
402
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#update_spec UpdateSpec} method's request.
|
403
|
+
# @!attribute [rw] spec
|
404
|
+
# @return [::Google::Cloud::ApiHub::V1::Spec]
|
405
|
+
# Required. The spec to update.
|
406
|
+
#
|
407
|
+
# The spec's `name` field is used to identify the spec to
|
408
|
+
# update. Format:
|
409
|
+
# `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
|
410
|
+
# @!attribute [rw] update_mask
|
411
|
+
# @return [::Google::Protobuf::FieldMask]
|
412
|
+
# Required. The list of fields to update.
|
413
|
+
class UpdateSpecRequest
|
414
|
+
include ::Google::Protobuf::MessageExts
|
415
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
416
|
+
end
|
417
|
+
|
418
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#delete_spec DeleteSpec} method's request.
|
419
|
+
# @!attribute [rw] name
|
420
|
+
# @return [::String]
|
421
|
+
# Required. The name of the spec to delete.
|
422
|
+
# Format:
|
423
|
+
# `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
|
424
|
+
class DeleteSpecRequest
|
425
|
+
include ::Google::Protobuf::MessageExts
|
426
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
427
|
+
end
|
428
|
+
|
429
|
+
# The [ListSpecs][ListSpecs] method's request.
|
430
|
+
# @!attribute [rw] parent
|
431
|
+
# @return [::String]
|
432
|
+
# Required. The parent, which owns this collection of specs.
|
433
|
+
# Format:
|
434
|
+
# `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
|
435
|
+
# @!attribute [rw] filter
|
436
|
+
# @return [::String]
|
437
|
+
# Optional. An expression that filters the list of Specs.
|
438
|
+
#
|
439
|
+
# A filter expression consists of a field name, a comparison
|
440
|
+
# operator, and a value for filtering. The value must be a string. The
|
441
|
+
# comparison operator must be one of: `<`, `>`, `:` or `=`. Filters are not
|
442
|
+
# case sensitive.
|
443
|
+
#
|
444
|
+
# The following fields in the `Spec` are eligible for filtering:
|
445
|
+
#
|
446
|
+
# * `display_name` - The display name of the Spec. Allowed comparison
|
447
|
+
# operators: `=`.
|
448
|
+
# * `create_time` - The time at which the Spec was created. The
|
449
|
+
# value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
|
450
|
+
# format. Allowed comparison operators: `>` and `<`.
|
451
|
+
# * `spec_type.enum_values.values.id` - The allowed value id of the
|
452
|
+
# spec_type attribute associated with the Spec. Allowed comparison
|
453
|
+
# operators: `:`.
|
454
|
+
# * `spec_type.enum_values.values.display_name` - The allowed value display
|
455
|
+
# name of the spec_type attribute associated with the Spec. Allowed
|
456
|
+
# comparison operators: `:`.
|
457
|
+
# * `lint_response.json_values.values` - The json value of the
|
458
|
+
# lint_response attribute associated with the Spec. Allowed comparison
|
459
|
+
# operators: `:`.
|
460
|
+
# * `mime_type` - The MIME type of the Spec. Allowed comparison
|
461
|
+
# operators: `=`.
|
462
|
+
#
|
463
|
+
# Expressions are combined with either `AND` logic operator or `OR` logical
|
464
|
+
# operator but not both of them together i.e. only one of the `AND` or `OR`
|
465
|
+
# operator can be used throughout the filter string and both the operators
|
466
|
+
# cannot be used together. No other logical operators are
|
467
|
+
# supported. At most three filter fields are allowed in the filter
|
468
|
+
# string and if provided more than that then `INVALID_ARGUMENT` error is
|
469
|
+
# returned by the API.
|
470
|
+
#
|
471
|
+
# Here are a few examples:
|
472
|
+
#
|
473
|
+
# * `spec_type.enum_values.values.id: rest-id` - The filter
|
474
|
+
# string specifies that the id of the allowed value associated with the
|
475
|
+
# spec_type attribute is _rest-id_.
|
476
|
+
# * `spec_type.enum_values.values.display_name: \"Rest Display Name\"` -
|
477
|
+
# The filter string specifies that the display name of the allowed value
|
478
|
+
# associated with the spec_type attribute is `Rest Display Name`.
|
479
|
+
# * `spec_type.enum_values.values.id: grpc-id AND create_time <
|
480
|
+
# \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"` -
|
481
|
+
# The id of the allowed value associated with the spec_type attribute is
|
482
|
+
# _grpc-id_ and the spec was created before _2021-08-15 14:50:00 UTC_ and
|
483
|
+
# after _2021-08-10 12:00:00 UTC_.
|
484
|
+
# * `spec_type.enum_values.values.id: rest-id OR
|
485
|
+
# spec_type.enum_values.values.id: grpc-id`
|
486
|
+
# - The id of the allowed value associated with the spec_type attribute is
|
487
|
+
# _rest-id_ or _grpc-id_.
|
488
|
+
# @!attribute [rw] page_size
|
489
|
+
# @return [::Integer]
|
490
|
+
# Optional. The maximum number of specs to return. The service may return
|
491
|
+
# fewer than this value. If unspecified, at most 50 specs will be
|
492
|
+
# returned. The maximum value is 1000; values above 1000 will be coerced to
|
493
|
+
# 1000.
|
494
|
+
# @!attribute [rw] page_token
|
495
|
+
# @return [::String]
|
496
|
+
# Optional. A page token, received from a previous `ListSpecs` call.
|
497
|
+
# Provide this to retrieve the subsequent page.
|
498
|
+
#
|
499
|
+
# When paginating, all other parameters provided to `ListSpecs` must
|
500
|
+
# match the call that provided the page token.
|
501
|
+
class ListSpecsRequest
|
502
|
+
include ::Google::Protobuf::MessageExts
|
503
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
504
|
+
end
|
505
|
+
|
506
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#list_specs ListSpecs} method's response.
|
507
|
+
# @!attribute [rw] specs
|
508
|
+
# @return [::Array<::Google::Cloud::ApiHub::V1::Spec>]
|
509
|
+
# The specs corresponding to an API.
|
510
|
+
# @!attribute [rw] next_page_token
|
511
|
+
# @return [::String]
|
512
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
513
|
+
# If this field is omitted, there are no subsequent pages.
|
514
|
+
class ListSpecsResponse
|
515
|
+
include ::Google::Protobuf::MessageExts
|
516
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
517
|
+
end
|
518
|
+
|
519
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#get_spec_contents GetSpecContents} method's
|
520
|
+
# request.
|
521
|
+
# @!attribute [rw] name
|
522
|
+
# @return [::String]
|
523
|
+
# Required. The name of the spec whose contents need to be retrieved.
|
524
|
+
# Format:
|
525
|
+
# `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
|
526
|
+
class GetSpecContentsRequest
|
527
|
+
include ::Google::Protobuf::MessageExts
|
528
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
529
|
+
end
|
530
|
+
|
531
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#get_api_operation GetApiOperation} method's
|
532
|
+
# request.
|
533
|
+
# @!attribute [rw] name
|
534
|
+
# @return [::String]
|
535
|
+
# Required. The name of the operation to retrieve.
|
536
|
+
# Format:
|
537
|
+
# `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
|
538
|
+
class GetApiOperationRequest
|
539
|
+
include ::Google::Protobuf::MessageExts
|
540
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
541
|
+
end
|
542
|
+
|
543
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#list_api_operations ListApiOperations}
|
544
|
+
# method's request.
|
545
|
+
# @!attribute [rw] parent
|
546
|
+
# @return [::String]
|
547
|
+
# Required. The parent which owns this collection of operations i.e., the API
|
548
|
+
# version. Format:
|
549
|
+
# `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
|
550
|
+
# @!attribute [rw] filter
|
551
|
+
# @return [::String]
|
552
|
+
# Optional. An expression that filters the list of ApiOperations.
|
553
|
+
#
|
554
|
+
# A filter expression consists of a field name, a comparison
|
555
|
+
# operator, and a value for filtering. The value must be a string or a
|
556
|
+
# boolean. The comparison operator must be one of: `<`, `>` or
|
557
|
+
# `=`. Filters are not case sensitive.
|
558
|
+
#
|
559
|
+
# The following fields in the `ApiOperation` are eligible for filtering:
|
560
|
+
# * `name` - The ApiOperation resource name. Allowed comparison
|
561
|
+
# operators:
|
562
|
+
# `=`.
|
563
|
+
# * `details.http_operation.path.path` - The http operation's complete path
|
564
|
+
# relative to server endpoint. Allowed comparison operators: `=`.
|
565
|
+
# * `details.http_operation.method` - The http operation method type.
|
566
|
+
# Allowed comparison operators: `=`.
|
567
|
+
# * `details.deprecated` - Indicates if the ApiOperation is deprecated.
|
568
|
+
# Allowed values are True / False indicating the deprycation status of the
|
569
|
+
# ApiOperation. Allowed comparison operators: `=`.
|
570
|
+
# * `create_time` - The time at which the ApiOperation was created. The
|
571
|
+
# value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
|
572
|
+
# format. Allowed comparison operators: `>` and `<`.
|
573
|
+
#
|
574
|
+
# Expressions are combined with either `AND` logic operator or `OR` logical
|
575
|
+
# operator but not both of them together i.e. only one of the `AND` or `OR`
|
576
|
+
# operator can be used throughout the filter string and both the operators
|
577
|
+
# cannot be used together. No other logical operators are supported. At most
|
578
|
+
# three filter fields are allowed in the filter string and if provided
|
579
|
+
# more than that then `INVALID_ARGUMENT` error is returned by the API.
|
580
|
+
#
|
581
|
+
# Here are a few examples:
|
582
|
+
#
|
583
|
+
# * `details.deprecated = True` - The ApiOperation is deprecated.
|
584
|
+
# * `details.http_operation.method = GET AND create_time <
|
585
|
+
# \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"` -
|
586
|
+
# The method of the http operation of the ApiOperation is _GET_ and the
|
587
|
+
# spec was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10
|
588
|
+
# 12:00:00 UTC_.
|
589
|
+
# * `details.http_operation.method = GET OR details.http_operation.method =
|
590
|
+
# POST`. - The http operation of the method of ApiOperation is _GET_ or
|
591
|
+
# _POST_.
|
592
|
+
# @!attribute [rw] page_size
|
593
|
+
# @return [::Integer]
|
594
|
+
# Optional. The maximum number of operations to return. The service may
|
595
|
+
# return fewer than this value. If unspecified, at most 50 operations will be
|
596
|
+
# returned. The maximum value is 1000; values above 1000 will be coerced to
|
597
|
+
# 1000.
|
598
|
+
# @!attribute [rw] page_token
|
599
|
+
# @return [::String]
|
600
|
+
# Optional. A page token, received from a previous `ListApiOperations` call.
|
601
|
+
# Provide this to retrieve the subsequent page.
|
602
|
+
#
|
603
|
+
# When paginating, all other parameters (except page_size) provided to
|
604
|
+
# `ListApiOperations` must match the call that provided the page token.
|
605
|
+
class ListApiOperationsRequest
|
606
|
+
include ::Google::Protobuf::MessageExts
|
607
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
608
|
+
end
|
609
|
+
|
610
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#list_api_operations ListApiOperations}
|
611
|
+
# method's response.
|
612
|
+
# @!attribute [rw] api_operations
|
613
|
+
# @return [::Array<::Google::Cloud::ApiHub::V1::ApiOperation>]
|
614
|
+
# The operations corresponding to an API version.
|
615
|
+
# Only following field will be populated in the response: name,
|
616
|
+
# spec, details.deprecated, details.http_operation.path.path,
|
617
|
+
# details.http_operation.method and details.documentation.external_uri.
|
618
|
+
# @!attribute [rw] next_page_token
|
619
|
+
# @return [::String]
|
620
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
621
|
+
# If this field is omitted, there are no subsequent pages.
|
622
|
+
class ListApiOperationsResponse
|
623
|
+
include ::Google::Protobuf::MessageExts
|
624
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
625
|
+
end
|
626
|
+
|
627
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#get_definition GetDefinition} method's
|
628
|
+
# request.
|
629
|
+
# @!attribute [rw] name
|
630
|
+
# @return [::String]
|
631
|
+
# Required. The name of the definition to retrieve.
|
632
|
+
# Format:
|
633
|
+
# `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`
|
634
|
+
class GetDefinitionRequest
|
635
|
+
include ::Google::Protobuf::MessageExts
|
636
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
637
|
+
end
|
638
|
+
|
639
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#create_deployment CreateDeployment}
|
640
|
+
# method's request.
|
641
|
+
# @!attribute [rw] parent
|
642
|
+
# @return [::String]
|
643
|
+
# Required. The parent resource for the deployment resource.
|
644
|
+
# Format: `projects/{project}/locations/{location}`
|
645
|
+
# @!attribute [rw] deployment_id
|
646
|
+
# @return [::String]
|
647
|
+
# Optional. The ID to use for the deployment resource, which will become the
|
648
|
+
# final component of the deployment's resource name. This field is optional.
|
649
|
+
#
|
650
|
+
# * If provided, the same will be used. The service will throw an error if
|
651
|
+
# the specified id is already used by another deployment resource in the API
|
652
|
+
# hub.
|
653
|
+
# * If not provided, a system generated id will be used.
|
654
|
+
#
|
655
|
+
# This value should be 4-500 characters, and valid characters
|
656
|
+
# are /[a-z][A-Z][0-9]-_/.
|
657
|
+
# @!attribute [rw] deployment
|
658
|
+
# @return [::Google::Cloud::ApiHub::V1::Deployment]
|
659
|
+
# Required. The deployment resource to create.
|
660
|
+
class CreateDeploymentRequest
|
661
|
+
include ::Google::Protobuf::MessageExts
|
662
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
663
|
+
end
|
664
|
+
|
665
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#get_deployment GetDeployment} method's
|
666
|
+
# request.
|
667
|
+
# @!attribute [rw] name
|
668
|
+
# @return [::String]
|
669
|
+
# Required. The name of the deployment resource to retrieve.
|
670
|
+
# Format: `projects/{project}/locations/{location}/deployments/{deployment}`
|
671
|
+
class GetDeploymentRequest
|
672
|
+
include ::Google::Protobuf::MessageExts
|
673
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
674
|
+
end
|
675
|
+
|
676
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#update_deployment UpdateDeployment}
|
677
|
+
# method's request.
|
678
|
+
# @!attribute [rw] deployment
|
679
|
+
# @return [::Google::Cloud::ApiHub::V1::Deployment]
|
680
|
+
# Required. The deployment resource to update.
|
681
|
+
#
|
682
|
+
# The deployment resource's `name` field is used to identify the deployment
|
683
|
+
# resource to update.
|
684
|
+
# Format: `projects/{project}/locations/{location}/deployments/{deployment}`
|
685
|
+
# @!attribute [rw] update_mask
|
686
|
+
# @return [::Google::Protobuf::FieldMask]
|
687
|
+
# Required. The list of fields to update.
|
688
|
+
class UpdateDeploymentRequest
|
689
|
+
include ::Google::Protobuf::MessageExts
|
690
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
691
|
+
end
|
692
|
+
|
693
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#delete_deployment DeleteDeployment}
|
694
|
+
# method's request.
|
695
|
+
# @!attribute [rw] name
|
696
|
+
# @return [::String]
|
697
|
+
# Required. The name of the deployment resource to delete.
|
698
|
+
# Format: `projects/{project}/locations/{location}/deployments/{deployment}`
|
699
|
+
class DeleteDeploymentRequest
|
700
|
+
include ::Google::Protobuf::MessageExts
|
701
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
702
|
+
end
|
703
|
+
|
704
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#list_deployments ListDeployments} method's
|
705
|
+
# request.
|
706
|
+
# @!attribute [rw] parent
|
707
|
+
# @return [::String]
|
708
|
+
# Required. The parent, which owns this collection of deployment resources.
|
709
|
+
# Format: `projects/{project}/locations/{location}`
|
710
|
+
# @!attribute [rw] filter
|
711
|
+
# @return [::String]
|
712
|
+
# Optional. An expression that filters the list of Deployments.
|
713
|
+
#
|
714
|
+
# A filter expression consists of a field name, a comparison
|
715
|
+
# operator, and a value for filtering. The value must be a string. The
|
716
|
+
# comparison operator must be one of: `<`, `>` or
|
717
|
+
# `=`. Filters are not case sensitive.
|
718
|
+
#
|
719
|
+
# The following fields in the `Deployments` are eligible for filtering:
|
720
|
+
#
|
721
|
+
# * `display_name` - The display name of the Deployment. Allowed
|
722
|
+
# comparison operators: `=`.
|
723
|
+
# * `create_time` - The time at which the Deployment was created. The
|
724
|
+
# value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
|
725
|
+
# format. Allowed comparison operators: `>` and `<`.
|
726
|
+
# * `resource_uri` - A URI to the deployment resource. Allowed
|
727
|
+
# comparison operators: `=`.
|
728
|
+
# * `api_versions` - The API versions linked to this deployment. Allowed
|
729
|
+
# comparison operators: `:`.
|
730
|
+
# * `deployment_type.enum_values.values.id` - The allowed value id of the
|
731
|
+
# deployment_type attribute associated with the Deployment. Allowed
|
732
|
+
# comparison operators: `:`.
|
733
|
+
# * `deployment_type.enum_values.values.display_name` - The allowed value
|
734
|
+
# display name of the deployment_type attribute associated with the
|
735
|
+
# Deployment. Allowed comparison operators: `:`.
|
736
|
+
# * `slo.string_values.values` -The allowed string value of the slo
|
737
|
+
# attribute associated with the deployment. Allowed comparison
|
738
|
+
# operators: `:`.
|
739
|
+
# * `environment.enum_values.values.id` - The allowed value id of the
|
740
|
+
# environment attribute associated with the deployment. Allowed
|
741
|
+
# comparison operators: `:`.
|
742
|
+
# * `environment.enum_values.values.display_name` - The allowed value
|
743
|
+
# display name of the environment attribute associated with the deployment.
|
744
|
+
# Allowed comparison operators: `:`.
|
745
|
+
#
|
746
|
+
# Expressions are combined with either `AND` logic operator or `OR` logical
|
747
|
+
# operator but not both of them together i.e. only one of the `AND` or `OR`
|
748
|
+
# operator can be used throughout the filter string and both the operators
|
749
|
+
# cannot be used together. No other logical operators are supported. At most
|
750
|
+
# three filter fields are allowed in the filter string and if provided
|
751
|
+
# more than that then `INVALID_ARGUMENT` error is returned by the API.
|
752
|
+
#
|
753
|
+
# Here are a few examples:
|
754
|
+
#
|
755
|
+
# * `environment.enum_values.values.id: staging-id` - The allowed value id
|
756
|
+
# of the environment attribute associated with the Deployment is
|
757
|
+
# _staging-id_.
|
758
|
+
# * `environment.enum_values.values.display_name: \"Staging Deployment\"` -
|
759
|
+
# The allowed value display name of the environment attribute associated
|
760
|
+
# with the Deployment is `Staging Deployment`.
|
761
|
+
# * `environment.enum_values.values.id: production-id AND create_time <
|
762
|
+
# \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"` -
|
763
|
+
# The allowed value id of the environment attribute associated with the
|
764
|
+
# Deployment is _production-id_ and Deployment was created before
|
765
|
+
# _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_.
|
766
|
+
# * `environment.enum_values.values.id: production-id OR
|
767
|
+
# slo.string_values.values: \"99.99%\"`
|
768
|
+
# - The allowed value id of the environment attribute Deployment is
|
769
|
+
# _production-id_ or string value of the slo attribute is _99.99%_.
|
770
|
+
# @!attribute [rw] page_size
|
771
|
+
# @return [::Integer]
|
772
|
+
# Optional. The maximum number of deployment resources to return. The service
|
773
|
+
# may return fewer than this value. If unspecified, at most 50 deployments
|
774
|
+
# will be returned. The maximum value is 1000; values above 1000 will be
|
775
|
+
# coerced to 1000.
|
776
|
+
# @!attribute [rw] page_token
|
777
|
+
# @return [::String]
|
778
|
+
# Optional. A page token, received from a previous `ListDeployments` call.
|
779
|
+
# Provide this to retrieve the subsequent page.
|
780
|
+
#
|
781
|
+
# When paginating, all other parameters (except page_size) provided to
|
782
|
+
# `ListDeployments` must match the call that provided the page token.
|
783
|
+
class ListDeploymentsRequest
|
784
|
+
include ::Google::Protobuf::MessageExts
|
785
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
786
|
+
end
|
787
|
+
|
788
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#list_deployments ListDeployments} method's
|
789
|
+
# response.
|
790
|
+
# @!attribute [rw] deployments
|
791
|
+
# @return [::Array<::Google::Cloud::ApiHub::V1::Deployment>]
|
792
|
+
# The deployment resources present in the API hub.
|
793
|
+
# @!attribute [rw] next_page_token
|
794
|
+
# @return [::String]
|
795
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
796
|
+
# If this field is omitted, there are no subsequent pages.
|
797
|
+
class ListDeploymentsResponse
|
798
|
+
include ::Google::Protobuf::MessageExts
|
799
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
800
|
+
end
|
801
|
+
|
802
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#create_attribute CreateAttribute} method's
|
803
|
+
# request.
|
804
|
+
# @!attribute [rw] parent
|
805
|
+
# @return [::String]
|
806
|
+
# Required. The parent resource for Attribute.
|
807
|
+
# Format: `projects/{project}/locations/{location}`
|
808
|
+
# @!attribute [rw] attribute_id
|
809
|
+
# @return [::String]
|
810
|
+
# Optional. The ID to use for the attribute, which will become the final
|
811
|
+
# component of the attribute's resource name. This field is optional.
|
812
|
+
#
|
813
|
+
# * If provided, the same will be used. The service will throw an error if
|
814
|
+
# the specified id is already used by another attribute resource in the API
|
815
|
+
# hub.
|
816
|
+
# * If not provided, a system generated id will be used.
|
817
|
+
#
|
818
|
+
# This value should be 4-500 characters, and valid characters
|
819
|
+
# are /[a-z][A-Z][0-9]-_/.
|
820
|
+
# @!attribute [rw] attribute
|
821
|
+
# @return [::Google::Cloud::ApiHub::V1::Attribute]
|
822
|
+
# Required. The attribute to create.
|
823
|
+
class CreateAttributeRequest
|
824
|
+
include ::Google::Protobuf::MessageExts
|
825
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
826
|
+
end
|
827
|
+
|
828
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#get_attribute GetAttribute} method's
|
829
|
+
# request.
|
830
|
+
# @!attribute [rw] name
|
831
|
+
# @return [::String]
|
832
|
+
# Required. The name of the attribute to retrieve.
|
833
|
+
# Format:
|
834
|
+
# `projects/{project}/locations/{location}/attributes/{attribute}`
|
835
|
+
class GetAttributeRequest
|
836
|
+
include ::Google::Protobuf::MessageExts
|
837
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
838
|
+
end
|
839
|
+
|
840
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#update_attribute UpdateAttribute} method's
|
841
|
+
# request.
|
842
|
+
# @!attribute [rw] attribute
|
843
|
+
# @return [::Google::Cloud::ApiHub::V1::Attribute]
|
844
|
+
# Required. The attribute to update.
|
845
|
+
#
|
846
|
+
# The attribute's `name` field is used to identify the attribute to update.
|
847
|
+
# Format:
|
848
|
+
# `projects/{project}/locations/{location}/attributes/{attribute}`
|
849
|
+
# @!attribute [rw] update_mask
|
850
|
+
# @return [::Google::Protobuf::FieldMask]
|
851
|
+
# Required. The list of fields to update.
|
852
|
+
class UpdateAttributeRequest
|
853
|
+
include ::Google::Protobuf::MessageExts
|
854
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
855
|
+
end
|
856
|
+
|
857
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#delete_attribute DeleteAttribute} method's
|
858
|
+
# request.
|
859
|
+
# @!attribute [rw] name
|
860
|
+
# @return [::String]
|
861
|
+
# Required. The name of the attribute to delete.
|
862
|
+
# Format:
|
863
|
+
# `projects/{project}/locations/{location}/attributes/{attribute}`
|
864
|
+
class DeleteAttributeRequest
|
865
|
+
include ::Google::Protobuf::MessageExts
|
866
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
867
|
+
end
|
868
|
+
|
869
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#list_attributes ListAttributes} method's
|
870
|
+
# request.
|
871
|
+
# @!attribute [rw] parent
|
872
|
+
# @return [::String]
|
873
|
+
# Required. The parent resource for Attribute.
|
874
|
+
# Format: `projects/{project}/locations/{location}`
|
875
|
+
# @!attribute [rw] filter
|
876
|
+
# @return [::String]
|
877
|
+
# Optional. An expression that filters the list of Attributes.
|
878
|
+
#
|
879
|
+
# A filter expression consists of a field name, a comparison
|
880
|
+
# operator, and a value for filtering. The value must be a string or a
|
881
|
+
# boolean. The comparison operator must be one of: `<`, `>` or
|
882
|
+
# `=`. Filters are not case sensitive.
|
883
|
+
#
|
884
|
+
# The following fields in the `Attribute` are eligible for filtering:
|
885
|
+
#
|
886
|
+
# * `display_name` - The display name of the Attribute. Allowed
|
887
|
+
# comparison operators: `=`.
|
888
|
+
# * `definition_type` - The definition type of the attribute. Allowed
|
889
|
+
# comparison operators: `=`.
|
890
|
+
# * `scope` - The scope of the attribute. Allowed comparison operators:
|
891
|
+
# `=`.
|
892
|
+
# * `data_type` - The type of the data of the attribute. Allowed
|
893
|
+
# comparison operators: `=`.
|
894
|
+
# * `mandatory` - Denotes whether the attribute is mandatory or not.
|
895
|
+
# Allowed comparison operators: `=`.
|
896
|
+
# * `create_time` - The time at which the Attribute was created. The
|
897
|
+
# value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
|
898
|
+
# format. Allowed comparison operators: `>` and `<`.
|
899
|
+
#
|
900
|
+
# Expressions are combined with either `AND` logic operator or `OR` logical
|
901
|
+
# operator but not both of them together i.e. only one of the `AND` or `OR`
|
902
|
+
# operator can be used throughout the filter string and both the operators
|
903
|
+
# cannot be used together. No other logical operators are
|
904
|
+
# supported. At most three filter fields are allowed in the filter
|
905
|
+
# string and if provided more than that then `INVALID_ARGUMENT` error is
|
906
|
+
# returned by the API.
|
907
|
+
#
|
908
|
+
# Here are a few examples:
|
909
|
+
#
|
910
|
+
# * `display_name = production` - - The display name of the attribute is
|
911
|
+
# _production_.
|
912
|
+
# * `(display_name = production) AND (create_time <
|
913
|
+
# \"2021-08-15T14:50:00Z\") AND (create_time > \"2021-08-10T12:00:00Z\")` -
|
914
|
+
# The display name of the attribute is _production_ and the attribute was
|
915
|
+
# created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00
|
916
|
+
# UTC_.
|
917
|
+
# * `display_name = production OR scope = api` -
|
918
|
+
# The attribute where the display name is _production_ or the scope is
|
919
|
+
# _api_.
|
920
|
+
# @!attribute [rw] page_size
|
921
|
+
# @return [::Integer]
|
922
|
+
# Optional. The maximum number of attribute resources to return. The service
|
923
|
+
# may return fewer than this value. If unspecified, at most 50 attributes
|
924
|
+
# will be returned. The maximum value is 1000; values above 1000 will be
|
925
|
+
# coerced to 1000.
|
926
|
+
# @!attribute [rw] page_token
|
927
|
+
# @return [::String]
|
928
|
+
# Optional. A page token, received from a previous `ListAttributes` call.
|
929
|
+
# Provide this to retrieve the subsequent page.
|
930
|
+
#
|
931
|
+
# When paginating, all other parameters provided to `ListAttributes` must
|
932
|
+
# match the call that provided the page token.
|
933
|
+
class ListAttributesRequest
|
934
|
+
include ::Google::Protobuf::MessageExts
|
935
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
936
|
+
end
|
937
|
+
|
938
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#list_attributes ListAttributes} method's
|
939
|
+
# response.
|
940
|
+
# @!attribute [rw] attributes
|
941
|
+
# @return [::Array<::Google::Cloud::ApiHub::V1::Attribute>]
|
942
|
+
# The list of all attributes.
|
943
|
+
# @!attribute [rw] next_page_token
|
944
|
+
# @return [::String]
|
945
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
946
|
+
# If this field is omitted, there are no subsequent pages.
|
947
|
+
class ListAttributesResponse
|
948
|
+
include ::Google::Protobuf::MessageExts
|
949
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
950
|
+
end
|
951
|
+
|
952
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#search_resources SearchResources} method's
|
953
|
+
# request.
|
954
|
+
# @!attribute [rw] location
|
955
|
+
# @return [::String]
|
956
|
+
# Required. The resource name of the location which will be of the type
|
957
|
+
# `projects/{project_id}/locations/{location_id}`. This field is used to
|
958
|
+
# identify the instance of API-Hub in which resources should be searched.
|
959
|
+
# @!attribute [rw] query
|
960
|
+
# @return [::String]
|
961
|
+
# Required. The free text search query. This query can contain keywords which
|
962
|
+
# could be related to any detail of the API-Hub resources such display names,
|
963
|
+
# descriptions, attributes etc.
|
964
|
+
# @!attribute [rw] filter
|
965
|
+
# @return [::String]
|
966
|
+
# Optional. An expression that filters the list of search results.
|
967
|
+
#
|
968
|
+
# A filter expression consists of a field name, a comparison operator,
|
969
|
+
# and a value for filtering. The value must be a string, a number, or a
|
970
|
+
# boolean. The comparison operator must be `=`. Filters are not case
|
971
|
+
# sensitive.
|
972
|
+
#
|
973
|
+
# The following field names are eligible for filtering:
|
974
|
+
# * `resource_type` - The type of resource in the search results.
|
975
|
+
# Must be one of the following: `Api`, `ApiOperation`, `Deployment`,
|
976
|
+
# `Definition`, `Spec` or `Version`. This field can only be specified once
|
977
|
+
# in the filter.
|
978
|
+
#
|
979
|
+
# Here are is an example:
|
980
|
+
#
|
981
|
+
# * `resource_type = Api` - The resource_type is _Api_.
|
982
|
+
# @!attribute [rw] page_size
|
983
|
+
# @return [::Integer]
|
984
|
+
# Optional. The maximum number of search results to return. The service may
|
985
|
+
# return fewer than this value. If unspecified at most 10 search results will
|
986
|
+
# be returned. If value is negative then `INVALID_ARGUMENT` error is
|
987
|
+
# returned. The maximum value is 25; values above 25 will be coerced to 25.
|
988
|
+
# While paginating, you can specify a new page size parameter for each page
|
989
|
+
# of search results to be listed.
|
990
|
+
# @!attribute [rw] page_token
|
991
|
+
# @return [::String]
|
992
|
+
# Optional. A page token, received from a previous
|
993
|
+
# [SearchResources][SearchResources]
|
994
|
+
# call. Specify this parameter to retrieve the next page of transactions.
|
995
|
+
#
|
996
|
+
# When paginating, you must specify the `page_token` parameter and all the
|
997
|
+
# other parameters except
|
998
|
+
# {::Google::Cloud::ApiHub::V1::SearchResourcesRequest#page_size page_size}
|
999
|
+
# should be specified with the same value which was used in the previous
|
1000
|
+
# call. If the other fields are set with a different value than the previous
|
1001
|
+
# call then `INVALID_ARGUMENT` error is returned.
|
1002
|
+
class SearchResourcesRequest
|
1003
|
+
include ::Google::Protobuf::MessageExts
|
1004
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1005
|
+
end
|
1006
|
+
|
1007
|
+
# ApiHubResource is one of the resources such as Api, Operation, Deployment,
|
1008
|
+
# Definition, Spec and Version resources stored in API-Hub.
|
1009
|
+
# @!attribute [rw] api
|
1010
|
+
# @return [::Google::Cloud::ApiHub::V1::Api]
|
1011
|
+
# This represents Api resource in search results. Only name, display_name,
|
1012
|
+
# description and owner fields are populated in search results.
|
1013
|
+
# @!attribute [rw] operation
|
1014
|
+
# @return [::Google::Cloud::ApiHub::V1::ApiOperation]
|
1015
|
+
# This represents ApiOperation resource in search results. Only name,
|
1016
|
+
# and description fields are populated in search results.
|
1017
|
+
# @!attribute [rw] deployment
|
1018
|
+
# @return [::Google::Cloud::ApiHub::V1::Deployment]
|
1019
|
+
# This represents Deployment resource in search results. Only name,
|
1020
|
+
# display_name and description fields are populated in search results.
|
1021
|
+
# @!attribute [rw] spec
|
1022
|
+
# @return [::Google::Cloud::ApiHub::V1::Spec]
|
1023
|
+
# This represents Spec resource in search results. Only name,
|
1024
|
+
# display_name and description fields are populated in search results.
|
1025
|
+
# @!attribute [rw] definition
|
1026
|
+
# @return [::Google::Cloud::ApiHub::V1::Definition]
|
1027
|
+
# This represents Definition resource in search results.
|
1028
|
+
# Only name field is populated in search results.
|
1029
|
+
# @!attribute [rw] version
|
1030
|
+
# @return [::Google::Cloud::ApiHub::V1::Version]
|
1031
|
+
# This represents Version resource in search results. Only name,
|
1032
|
+
# display_name and description fields are populated in search results.
|
1033
|
+
class ApiHubResource
|
1034
|
+
include ::Google::Protobuf::MessageExts
|
1035
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1036
|
+
end
|
1037
|
+
|
1038
|
+
# Represents the search results.
|
1039
|
+
# @!attribute [rw] resource
|
1040
|
+
# @return [::Google::Cloud::ApiHub::V1::ApiHubResource]
|
1041
|
+
# This represents the ApiHubResource.
|
1042
|
+
# Note: Only selected fields of the resources are populated in response.
|
1043
|
+
class SearchResult
|
1044
|
+
include ::Google::Protobuf::MessageExts
|
1045
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1046
|
+
end
|
1047
|
+
|
1048
|
+
# Response for the
|
1049
|
+
# {::Google::Cloud::ApiHub::V1::ApiHub::Client#search_resources SearchResources} method.
|
1050
|
+
# @!attribute [rw] search_results
|
1051
|
+
# @return [::Array<::Google::Cloud::ApiHub::V1::SearchResult>]
|
1052
|
+
# List of search results according to the filter and search query specified.
|
1053
|
+
# The order of search results represents the ranking.
|
1054
|
+
# @!attribute [rw] next_page_token
|
1055
|
+
# @return [::String]
|
1056
|
+
# Pass this token in the
|
1057
|
+
# {::Google::Cloud::ApiHub::V1::SearchResourcesRequest SearchResourcesRequest}
|
1058
|
+
# to continue to list results. If all results have been returned, this field
|
1059
|
+
# is an empty string or not present in the response.
|
1060
|
+
class SearchResourcesResponse
|
1061
|
+
include ::Google::Protobuf::MessageExts
|
1062
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1063
|
+
end
|
1064
|
+
|
1065
|
+
# The
|
1066
|
+
# {::Google::Cloud::ApiHub::V1::ApiHubDependencies::Client#create_dependency CreateDependency}
|
1067
|
+
# method's request.
|
1068
|
+
# @!attribute [rw] parent
|
1069
|
+
# @return [::String]
|
1070
|
+
# Required. The parent resource for the dependency resource.
|
1071
|
+
# Format: `projects/{project}/locations/{location}`
|
1072
|
+
# @!attribute [rw] dependency_id
|
1073
|
+
# @return [::String]
|
1074
|
+
# Optional. The ID to use for the dependency resource, which will become the
|
1075
|
+
# final component of the dependency's resource name. This field is optional.
|
1076
|
+
# * If provided, the same will be used. The service will throw an error if
|
1077
|
+
# duplicate id is provided by the client.
|
1078
|
+
# * If not provided, a system generated id will be used.
|
1079
|
+
#
|
1080
|
+
# This value should be 4-500 characters, and valid characters
|
1081
|
+
# are `[a-z][A-Z][0-9]-_`.
|
1082
|
+
# @!attribute [rw] dependency
|
1083
|
+
# @return [::Google::Cloud::ApiHub::V1::Dependency]
|
1084
|
+
# Required. The dependency resource to create.
|
1085
|
+
class CreateDependencyRequest
|
1086
|
+
include ::Google::Protobuf::MessageExts
|
1087
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1088
|
+
end
|
1089
|
+
|
1090
|
+
# The [GetDependency][.ApiHubDependencies.GetDependency]
|
1091
|
+
# method's request.
|
1092
|
+
# @!attribute [rw] name
|
1093
|
+
# @return [::String]
|
1094
|
+
# Required. The name of the dependency resource to retrieve.
|
1095
|
+
# Format: `projects/{project}/locations/{location}/dependencies/{dependency}`
|
1096
|
+
class GetDependencyRequest
|
1097
|
+
include ::Google::Protobuf::MessageExts
|
1098
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1099
|
+
end
|
1100
|
+
|
1101
|
+
# The
|
1102
|
+
# {::Google::Cloud::ApiHub::V1::ApiHubDependencies::Client#update_dependency UpdateDependency}
|
1103
|
+
# method's request.
|
1104
|
+
# @!attribute [rw] dependency
|
1105
|
+
# @return [::Google::Cloud::ApiHub::V1::Dependency]
|
1106
|
+
# Required. The dependency resource to update.
|
1107
|
+
#
|
1108
|
+
# The dependency's `name` field is used to identify the dependency to update.
|
1109
|
+
# Format: `projects/{project}/locations/{location}/dependencies/{dependency}`
|
1110
|
+
# @!attribute [rw] update_mask
|
1111
|
+
# @return [::Google::Protobuf::FieldMask]
|
1112
|
+
# Required. The list of fields to update.
|
1113
|
+
class UpdateDependencyRequest
|
1114
|
+
include ::Google::Protobuf::MessageExts
|
1115
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1116
|
+
end
|
1117
|
+
|
1118
|
+
# The
|
1119
|
+
# {::Google::Cloud::ApiHub::V1::ApiHubDependencies::Client#delete_dependency DeleteDependency}
|
1120
|
+
# method's request.
|
1121
|
+
# @!attribute [rw] name
|
1122
|
+
# @return [::String]
|
1123
|
+
# Required. The name of the dependency resource to delete.
|
1124
|
+
# Format: `projects/{project}/locations/{location}/dependencies/{dependency}`
|
1125
|
+
class DeleteDependencyRequest
|
1126
|
+
include ::Google::Protobuf::MessageExts
|
1127
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1128
|
+
end
|
1129
|
+
|
1130
|
+
# The
|
1131
|
+
# {::Google::Cloud::ApiHub::V1::ApiHubDependencies::Client#list_dependencies ListDependencies}
|
1132
|
+
# method's request.
|
1133
|
+
# @!attribute [rw] parent
|
1134
|
+
# @return [::String]
|
1135
|
+
# Required. The parent which owns this collection of dependency resources.
|
1136
|
+
# Format: `projects/{project}/locations/{location}`
|
1137
|
+
# @!attribute [rw] filter
|
1138
|
+
# @return [::String]
|
1139
|
+
# Optional. An expression that filters the list of Dependencies.
|
1140
|
+
#
|
1141
|
+
# A filter expression consists of a field name, a comparison operator, and
|
1142
|
+
# a value for filtering. The value must be a string. Allowed comparison
|
1143
|
+
# operator is `=`. Filters are not case sensitive.
|
1144
|
+
#
|
1145
|
+
# The following fields in the `Dependency` are eligible for filtering:
|
1146
|
+
#
|
1147
|
+
# * `consumer.operation_resource_name` - The operation resource name for
|
1148
|
+
# the consumer entity involved in a dependency. Allowed comparison
|
1149
|
+
# operators: `=`.
|
1150
|
+
# * `consumer.external_api_resource_name` - The external api resource name
|
1151
|
+
# for the consumer entity involved in a dependency. Allowed comparison
|
1152
|
+
# operators: `=`.
|
1153
|
+
# * `supplier.operation_resource_name` - The operation resource name for
|
1154
|
+
# the supplier entity involved in a dependency. Allowed comparison
|
1155
|
+
# operators: `=`.
|
1156
|
+
# * `supplier.external_api_resource_name` - The external api resource name
|
1157
|
+
# for the supplier entity involved in a dependency. Allowed comparison
|
1158
|
+
# operators: `=`.
|
1159
|
+
#
|
1160
|
+
# Expressions are combined with either `AND` logic operator or `OR` logical
|
1161
|
+
# operator but not both of them together i.e. only one of the `AND` or `OR`
|
1162
|
+
# operator can be used throughout the filter string and both the operators
|
1163
|
+
# cannot be used together. No other logical operators are supported. At most
|
1164
|
+
# three filter fields are allowed in the filter string and if provided
|
1165
|
+
# more than that then `INVALID_ARGUMENT` error is returned by the API.
|
1166
|
+
#
|
1167
|
+
# For example, `consumer.operation_resource_name =
|
1168
|
+
# \"projects/p1/locations/global/apis/a1/versions/v1/operations/o1\" OR
|
1169
|
+
# supplier.operation_resource_name =
|
1170
|
+
# \"projects/p1/locations/global/apis/a1/versions/v1/operations/o1\"` - The
|
1171
|
+
# dependencies with either consumer or supplier operation resource name as
|
1172
|
+
# _projects/p1/locations/global/apis/a1/versions/v1/operations/o1_.
|
1173
|
+
# @!attribute [rw] page_size
|
1174
|
+
# @return [::Integer]
|
1175
|
+
# Optional. The maximum number of dependency resources to return. The service
|
1176
|
+
# may return fewer than this value. If unspecified, at most 50 dependencies
|
1177
|
+
# will be returned. The maximum value is 1000; values above 1000 will be
|
1178
|
+
# coerced to 1000.
|
1179
|
+
# @!attribute [rw] page_token
|
1180
|
+
# @return [::String]
|
1181
|
+
# Optional. A page token, received from a previous `ListDependencies` call.
|
1182
|
+
# Provide this to retrieve the subsequent page.
|
1183
|
+
#
|
1184
|
+
# When paginating, all other parameters provided to `ListDependencies` must
|
1185
|
+
# match the call that provided the page token.
|
1186
|
+
class ListDependenciesRequest
|
1187
|
+
include ::Google::Protobuf::MessageExts
|
1188
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1189
|
+
end
|
1190
|
+
|
1191
|
+
# The
|
1192
|
+
# {::Google::Cloud::ApiHub::V1::ApiHubDependencies::Client#list_dependencies ListDependencies}
|
1193
|
+
# method's response.
|
1194
|
+
# @!attribute [rw] dependencies
|
1195
|
+
# @return [::Array<::Google::Cloud::ApiHub::V1::Dependency>]
|
1196
|
+
# The dependency resources present in the API hub.
|
1197
|
+
# Only following field will be populated in the response: name.
|
1198
|
+
# @!attribute [rw] next_page_token
|
1199
|
+
# @return [::String]
|
1200
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
1201
|
+
# If this field is omitted, there are no subsequent pages.
|
1202
|
+
class ListDependenciesResponse
|
1203
|
+
include ::Google::Protobuf::MessageExts
|
1204
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1205
|
+
end
|
1206
|
+
|
1207
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#create_external_api CreateExternalApi}
|
1208
|
+
# method's request.
|
1209
|
+
# @!attribute [rw] parent
|
1210
|
+
# @return [::String]
|
1211
|
+
# Required. The parent resource for the External API resource.
|
1212
|
+
# Format: `projects/{project}/locations/{location}`
|
1213
|
+
# @!attribute [rw] external_api_id
|
1214
|
+
# @return [::String]
|
1215
|
+
# Optional. The ID to use for the External API resource, which will become
|
1216
|
+
# the final component of the External API's resource name. This field is
|
1217
|
+
# optional.
|
1218
|
+
#
|
1219
|
+
# * If provided, the same will be used. The service will throw an error if
|
1220
|
+
# the specified id is already used by another External API resource in the
|
1221
|
+
# API hub.
|
1222
|
+
# * If not provided, a system generated id will be used.
|
1223
|
+
#
|
1224
|
+
# This value should be 4-500 characters, and valid characters
|
1225
|
+
# are /[a-z][A-Z][0-9]-_/.
|
1226
|
+
# @!attribute [rw] external_api
|
1227
|
+
# @return [::Google::Cloud::ApiHub::V1::ExternalApi]
|
1228
|
+
# Required. The External API resource to create.
|
1229
|
+
class CreateExternalApiRequest
|
1230
|
+
include ::Google::Protobuf::MessageExts
|
1231
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1232
|
+
end
|
1233
|
+
|
1234
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#get_external_api GetExternalApi} method's
|
1235
|
+
# request.
|
1236
|
+
# @!attribute [rw] name
|
1237
|
+
# @return [::String]
|
1238
|
+
# Required. The name of the External API resource to retrieve.
|
1239
|
+
# Format:
|
1240
|
+
# `projects/{project}/locations/{location}/externalApis/{externalApi}`
|
1241
|
+
class GetExternalApiRequest
|
1242
|
+
include ::Google::Protobuf::MessageExts
|
1243
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1244
|
+
end
|
1245
|
+
|
1246
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#update_external_api UpdateExternalApi}
|
1247
|
+
# method's request.
|
1248
|
+
# @!attribute [rw] external_api
|
1249
|
+
# @return [::Google::Cloud::ApiHub::V1::ExternalApi]
|
1250
|
+
# Required. The External API resource to update.
|
1251
|
+
#
|
1252
|
+
# The External API resource's `name` field is used to identify the External
|
1253
|
+
# API resource to update. Format:
|
1254
|
+
# `projects/{project}/locations/{location}/externalApis/{externalApi}`
|
1255
|
+
# @!attribute [rw] update_mask
|
1256
|
+
# @return [::Google::Protobuf::FieldMask]
|
1257
|
+
# Required. The list of fields to update.
|
1258
|
+
class UpdateExternalApiRequest
|
1259
|
+
include ::Google::Protobuf::MessageExts
|
1260
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1261
|
+
end
|
1262
|
+
|
1263
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#delete_external_api DeleteExternalApi}
|
1264
|
+
# method's request.
|
1265
|
+
# @!attribute [rw] name
|
1266
|
+
# @return [::String]
|
1267
|
+
# Required. The name of the External API resource to delete.
|
1268
|
+
# Format:
|
1269
|
+
# `projects/{project}/locations/{location}/externalApis/{externalApi}`
|
1270
|
+
class DeleteExternalApiRequest
|
1271
|
+
include ::Google::Protobuf::MessageExts
|
1272
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1273
|
+
end
|
1274
|
+
|
1275
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#list_external_apis ListExternalApis}
|
1276
|
+
# method's request.
|
1277
|
+
# @!attribute [rw] parent
|
1278
|
+
# @return [::String]
|
1279
|
+
# Required. The parent, which owns this collection of External API resources.
|
1280
|
+
# Format: `projects/{project}/locations/{location}`
|
1281
|
+
# @!attribute [rw] page_size
|
1282
|
+
# @return [::Integer]
|
1283
|
+
# Optional. The maximum number of External API resources to return. The
|
1284
|
+
# service may return fewer than this value. If unspecified, at most 50
|
1285
|
+
# ExternalApis will be returned. The maximum value is 1000; values above 1000
|
1286
|
+
# will be coerced to 1000.
|
1287
|
+
# @!attribute [rw] page_token
|
1288
|
+
# @return [::String]
|
1289
|
+
# Optional. A page token, received from a previous `ListExternalApis` call.
|
1290
|
+
# Provide this to retrieve the subsequent page.
|
1291
|
+
#
|
1292
|
+
# When paginating, all other parameters (except page_size) provided to
|
1293
|
+
# `ListExternalApis` must match the call that provided the page token.
|
1294
|
+
class ListExternalApisRequest
|
1295
|
+
include ::Google::Protobuf::MessageExts
|
1296
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1297
|
+
end
|
1298
|
+
|
1299
|
+
# The {::Google::Cloud::ApiHub::V1::ApiHub::Client#list_external_apis ListExternalApis}
|
1300
|
+
# method's response.
|
1301
|
+
# @!attribute [rw] external_apis
|
1302
|
+
# @return [::Array<::Google::Cloud::ApiHub::V1::ExternalApi>]
|
1303
|
+
# The External API resources present in the API hub.
|
1304
|
+
# Only following fields will be populated in the response: name,
|
1305
|
+
# display_name, documentation.external_uri.
|
1306
|
+
# @!attribute [rw] next_page_token
|
1307
|
+
# @return [::String]
|
1308
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
1309
|
+
# If this field is omitted, there are no subsequent pages.
|
1310
|
+
class ListExternalApisResponse
|
1311
|
+
include ::Google::Protobuf::MessageExts
|
1312
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1313
|
+
end
|
1314
|
+
end
|
1315
|
+
end
|
1316
|
+
end
|
1317
|
+
end
|