google-cloud-capacity_planner-v1beta 0.a → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +122 -0
  4. data/README.md +153 -8
  5. data/lib/google/cloud/capacity_planner/v1beta/capacity_planning_service/client.rb +686 -0
  6. data/lib/google/cloud/capacity_planner/v1beta/capacity_planning_service/credentials.rb +48 -0
  7. data/lib/google/cloud/capacity_planner/v1beta/capacity_planning_service/paths.rb +64 -0
  8. data/lib/google/cloud/capacity_planner/v1beta/capacity_planning_service/rest/client.rb +639 -0
  9. data/lib/google/cloud/capacity_planner/v1beta/capacity_planning_service/rest/service_stub.rb +279 -0
  10. data/lib/google/cloud/capacity_planner/v1beta/capacity_planning_service/rest.rb +54 -0
  11. data/lib/google/cloud/capacity_planner/v1beta/capacity_planning_service.rb +57 -0
  12. data/lib/google/cloud/capacity_planner/v1beta/rest.rb +38 -0
  13. data/lib/google/cloud/capacity_planner/v1beta/usage_service/client.rb +1214 -0
  14. data/lib/google/cloud/capacity_planner/v1beta/usage_service/credentials.rb +48 -0
  15. data/lib/google/cloud/capacity_planner/v1beta/usage_service/operations.rb +813 -0
  16. data/lib/google/cloud/capacity_planner/v1beta/usage_service/paths.rb +50 -0
  17. data/lib/google/cloud/capacity_planner/v1beta/usage_service/rest/client.rb +1146 -0
  18. data/lib/google/cloud/capacity_planner/v1beta/usage_service/rest/operations.rb +914 -0
  19. data/lib/google/cloud/capacity_planner/v1beta/usage_service/rest/service_stub.rb +546 -0
  20. data/lib/google/cloud/capacity_planner/v1beta/usage_service/rest.rb +53 -0
  21. data/lib/google/cloud/capacity_planner/v1beta/usage_service.rb +56 -0
  22. data/lib/google/cloud/capacity_planner/v1beta/version.rb +7 -2
  23. data/lib/google/cloud/capacity_planner/v1beta.rb +46 -0
  24. data/lib/google/cloud/capacityplanner/v1beta/allocation_pb.rb +53 -0
  25. data/lib/google/cloud/capacityplanner/v1beta/capacity_planning_service_pb.rb +73 -0
  26. data/lib/google/cloud/capacityplanner/v1beta/capacity_planning_service_services_pb.rb +54 -0
  27. data/lib/google/cloud/capacityplanner/v1beta/future_reservation_pb.rb +51 -0
  28. data/lib/google/cloud/capacityplanner/v1beta/location_pb.rb +46 -0
  29. data/lib/google/cloud/capacityplanner/v1beta/resource_pb.rb +51 -0
  30. data/lib/google/cloud/capacityplanner/v1beta/usage_service_pb.rb +90 -0
  31. data/lib/google/cloud/capacityplanner/v1beta/usage_service_services_pb.rb +61 -0
  32. data/lib/google-cloud-capacity_planner-v1beta.rb +21 -0
  33. data/proto_docs/README.md +4 -0
  34. data/proto_docs/google/api/client.rb +473 -0
  35. data/proto_docs/google/api/field_behavior.rb +85 -0
  36. data/proto_docs/google/api/launch_stage.rb +71 -0
  37. data/proto_docs/google/api/resource.rb +227 -0
  38. data/proto_docs/google/cloud/capacityplanner/v1beta/allocation.rb +206 -0
  39. data/proto_docs/google/cloud/capacityplanner/v1beta/capacity_planning_service.rb +374 -0
  40. data/proto_docs/google/cloud/capacityplanner/v1beta/future_reservation.rb +185 -0
  41. data/proto_docs/google/cloud/capacityplanner/v1beta/location.rb +79 -0
  42. data/proto_docs/google/cloud/capacityplanner/v1beta/resource.rb +159 -0
  43. data/proto_docs/google/cloud/capacityplanner/v1beta/usage_service.rb +912 -0
  44. data/proto_docs/google/longrunning/operations.rb +173 -0
  45. data/proto_docs/google/protobuf/any.rb +145 -0
  46. data/proto_docs/google/protobuf/duration.rb +98 -0
  47. data/proto_docs/google/protobuf/empty.rb +34 -0
  48. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  49. data/proto_docs/google/rpc/status.rb +48 -0
  50. data/proto_docs/google/type/date.rb +53 -0
  51. metadata +83 -9
@@ -0,0 +1,279 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 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
+ require "google/cloud/capacityplanner/v1beta/capacity_planning_service_pb"
20
+
21
+ module Google
22
+ module Cloud
23
+ module CapacityPlanner
24
+ module V1beta
25
+ module CapacityPlanningService
26
+ module Rest
27
+ ##
28
+ # REST service stub for the CapacityPlanningService service.
29
+ # Service stub contains baseline method implementations
30
+ # including transcoding, making the REST call, and deserialing the response.
31
+ #
32
+ class ServiceStub
33
+ # @private
34
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
35
+ # These require statements are intentionally placed here to initialize
36
+ # the REST modules only when it's required.
37
+ require "gapic/rest"
38
+
39
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
40
+ endpoint_template: endpoint_template,
41
+ universe_domain: universe_domain,
42
+ credentials: credentials,
43
+ numeric_enums: true,
44
+ service_name: self.class,
45
+ raise_faraday_errors: false,
46
+ logger: logger
47
+ end
48
+
49
+ ##
50
+ # The effective universe domain
51
+ #
52
+ # @return [String]
53
+ #
54
+ def universe_domain
55
+ @client_stub.universe_domain
56
+ end
57
+
58
+ ##
59
+ # The effective endpoint
60
+ #
61
+ # @return [String]
62
+ #
63
+ def endpoint
64
+ @client_stub.endpoint
65
+ end
66
+
67
+ ##
68
+ # The logger used for request/response debug logging.
69
+ #
70
+ # @return [Logger]
71
+ #
72
+ def logger stub: false
73
+ stub ? @client_stub.stub_logger : @client_stub.logger
74
+ end
75
+
76
+ ##
77
+ # Baseline implementation for the get_capacity_plan REST call
78
+ #
79
+ # @param request_pb [::Google::Cloud::CapacityPlanner::V1beta::GetCapacityPlanRequest]
80
+ # A request object representing the call parameters. Required.
81
+ # @param options [::Gapic::CallOptions]
82
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
83
+ #
84
+ # @yield [result, operation] Access the result along with the TransportOperation object
85
+ # @yieldparam result [::Google::Cloud::CapacityPlanner::V1beta::CapacityPlan]
86
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
87
+ #
88
+ # @return [::Google::Cloud::CapacityPlanner::V1beta::CapacityPlan]
89
+ # A result object deserialized from the server's reply
90
+ def get_capacity_plan request_pb, options = nil
91
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
92
+
93
+ verb, uri, query_string_params, body = ServiceStub.transcode_get_capacity_plan_request request_pb
94
+ query_string_params = if query_string_params.any?
95
+ query_string_params.to_h { |p| p.split "=", 2 }
96
+ else
97
+ {}
98
+ end
99
+
100
+ response = @client_stub.make_http_request(
101
+ verb,
102
+ uri: uri,
103
+ body: body || "",
104
+ params: query_string_params,
105
+ method_name: "get_capacity_plan",
106
+ options: options
107
+ )
108
+ operation = ::Gapic::Rest::TransportOperation.new response
109
+ result = ::Google::Cloud::CapacityPlanner::V1beta::CapacityPlan.decode_json response.body, ignore_unknown_fields: true
110
+ catch :response do
111
+ yield result, operation if block_given?
112
+ result
113
+ end
114
+ end
115
+
116
+ ##
117
+ # Baseline implementation for the query_capacity_plans REST call
118
+ #
119
+ # @param request_pb [::Google::Cloud::CapacityPlanner::V1beta::QueryCapacityPlansRequest]
120
+ # A request object representing the call parameters. Required.
121
+ # @param options [::Gapic::CallOptions]
122
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
123
+ #
124
+ # @yield [result, operation] Access the result along with the TransportOperation object
125
+ # @yieldparam result [::Google::Cloud::CapacityPlanner::V1beta::QueryCapacityPlansResponse]
126
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
127
+ #
128
+ # @return [::Google::Cloud::CapacityPlanner::V1beta::QueryCapacityPlansResponse]
129
+ # A result object deserialized from the server's reply
130
+ def query_capacity_plans request_pb, options = nil
131
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
132
+
133
+ verb, uri, query_string_params, body = ServiceStub.transcode_query_capacity_plans_request request_pb
134
+ query_string_params = if query_string_params.any?
135
+ query_string_params.to_h { |p| p.split "=", 2 }
136
+ else
137
+ {}
138
+ end
139
+
140
+ response = @client_stub.make_http_request(
141
+ verb,
142
+ uri: uri,
143
+ body: body || "",
144
+ params: query_string_params,
145
+ method_name: "query_capacity_plans",
146
+ options: options
147
+ )
148
+ operation = ::Gapic::Rest::TransportOperation.new response
149
+ result = ::Google::Cloud::CapacityPlanner::V1beta::QueryCapacityPlansResponse.decode_json response.body, ignore_unknown_fields: true
150
+ catch :response do
151
+ yield result, operation if block_given?
152
+ result
153
+ end
154
+ end
155
+
156
+ ##
157
+ # Baseline implementation for the query_capacity_plan_insights REST call
158
+ #
159
+ # @param request_pb [::Google::Cloud::CapacityPlanner::V1beta::QueryCapacityPlanInsightsRequest]
160
+ # A request object representing the call parameters. Required.
161
+ # @param options [::Gapic::CallOptions]
162
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
163
+ #
164
+ # @yield [result, operation] Access the result along with the TransportOperation object
165
+ # @yieldparam result [::Google::Cloud::CapacityPlanner::V1beta::QueryCapacityPlanInsightsResponse]
166
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
167
+ #
168
+ # @return [::Google::Cloud::CapacityPlanner::V1beta::QueryCapacityPlanInsightsResponse]
169
+ # A result object deserialized from the server's reply
170
+ def query_capacity_plan_insights request_pb, options = nil
171
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
172
+
173
+ verb, uri, query_string_params, body = ServiceStub.transcode_query_capacity_plan_insights_request request_pb
174
+ query_string_params = if query_string_params.any?
175
+ query_string_params.to_h { |p| p.split "=", 2 }
176
+ else
177
+ {}
178
+ end
179
+
180
+ response = @client_stub.make_http_request(
181
+ verb,
182
+ uri: uri,
183
+ body: body || "",
184
+ params: query_string_params,
185
+ method_name: "query_capacity_plan_insights",
186
+ options: options
187
+ )
188
+ operation = ::Gapic::Rest::TransportOperation.new response
189
+ result = ::Google::Cloud::CapacityPlanner::V1beta::QueryCapacityPlanInsightsResponse.decode_json response.body, ignore_unknown_fields: true
190
+ catch :response do
191
+ yield result, operation if block_given?
192
+ result
193
+ end
194
+ end
195
+
196
+ ##
197
+ # @private
198
+ #
199
+ # GRPC transcoding helper method for the get_capacity_plan REST call
200
+ #
201
+ # @param request_pb [::Google::Cloud::CapacityPlanner::V1beta::GetCapacityPlanRequest]
202
+ # A request object representing the call parameters. Required.
203
+ # @return [Array(String, [String, nil], Hash{String => String})]
204
+ # Uri, Body, Query string parameters
205
+ def self.transcode_get_capacity_plan_request request_pb
206
+ transcoder = Gapic::Rest::GrpcTranscoder.new
207
+ .with_bindings(
208
+ uri_method: :get,
209
+ uri_template: "/v1beta/{name}",
210
+ matches: [
211
+ ["name", %r{^projects/[^/]+/capacityPlans/[^/]+/?$}, false]
212
+ ]
213
+ )
214
+ transcoder.transcode request_pb
215
+ end
216
+
217
+ ##
218
+ # @private
219
+ #
220
+ # GRPC transcoding helper method for the query_capacity_plans REST call
221
+ #
222
+ # @param request_pb [::Google::Cloud::CapacityPlanner::V1beta::QueryCapacityPlansRequest]
223
+ # A request object representing the call parameters. Required.
224
+ # @return [Array(String, [String, nil], Hash{String => String})]
225
+ # Uri, Body, Query string parameters
226
+ def self.transcode_query_capacity_plans_request request_pb
227
+ transcoder = Gapic::Rest::GrpcTranscoder.new
228
+ .with_bindings(
229
+ uri_method: :get,
230
+ uri_template: "/v1beta/{parent}/capacityPlans:query",
231
+ matches: [
232
+ ["parent", %r{^organizations/[^/]+/?$}, false]
233
+ ]
234
+ )
235
+ .with_bindings(
236
+ uri_method: :get,
237
+ uri_template: "/v1beta/{parent}/capacityPlans:query",
238
+ matches: [
239
+ ["parent", %r{^folders/[^/]+/?$}, false]
240
+ ]
241
+ )
242
+ .with_bindings(
243
+ uri_method: :get,
244
+ uri_template: "/v1beta/{parent}/capacityPlans:query",
245
+ matches: [
246
+ ["parent", %r{^projects/[^/]+/?$}, false]
247
+ ]
248
+ )
249
+ transcoder.transcode request_pb
250
+ end
251
+
252
+ ##
253
+ # @private
254
+ #
255
+ # GRPC transcoding helper method for the query_capacity_plan_insights REST call
256
+ #
257
+ # @param request_pb [::Google::Cloud::CapacityPlanner::V1beta::QueryCapacityPlanInsightsRequest]
258
+ # A request object representing the call parameters. Required.
259
+ # @return [Array(String, [String, nil], Hash{String => String})]
260
+ # Uri, Body, Query string parameters
261
+ def self.transcode_query_capacity_plan_insights_request request_pb
262
+ transcoder = Gapic::Rest::GrpcTranscoder.new
263
+ .with_bindings(
264
+ uri_method: :post,
265
+ uri_template: "/v1beta/{parent}/capacityPlanInsights:query",
266
+ body: "*",
267
+ matches: [
268
+ ["parent", %r{^projects/[^/]+/?$}, false]
269
+ ]
270
+ )
271
+ transcoder.transcode request_pb
272
+ end
273
+ end
274
+ end
275
+ end
276
+ end
277
+ end
278
+ end
279
+ end
@@ -0,0 +1,54 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 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
+ require "gapic/rest"
20
+ require "gapic/config"
21
+ require "gapic/config/method"
22
+
23
+ require "google/cloud/capacity_planner/v1beta/version"
24
+
25
+ require "google/cloud/capacity_planner/v1beta/capacity_planning_service/credentials"
26
+ require "google/cloud/capacity_planner/v1beta/capacity_planning_service/paths"
27
+ require "google/cloud/capacity_planner/v1beta/capacity_planning_service/rest/client"
28
+
29
+ module Google
30
+ module Cloud
31
+ module CapacityPlanner
32
+ module V1beta
33
+ ##
34
+ # This API allows users to plan for GCP capacity associated with their
35
+ # projects. Users can request additional capacity for GCP resources such as
36
+ # VMs, PDs, etc.
37
+ #
38
+ # To load this service and instantiate a REST client:
39
+ #
40
+ # require "google/cloud/capacity_planner/v1beta/capacity_planning_service/rest"
41
+ # client = ::Google::Cloud::CapacityPlanner::V1beta::CapacityPlanningService::Rest::Client.new
42
+ #
43
+ module CapacityPlanningService
44
+ # Client for the REST transport
45
+ module Rest
46
+ end
47
+ end
48
+ end
49
+ end
50
+ end
51
+ end
52
+
53
+ helper_path = ::File.join __dir__, "rest", "helpers.rb"
54
+ require "google/cloud/capacity_planner/v1beta/capacity_planning_service/rest/helpers" if ::File.file? helper_path
@@ -0,0 +1,57 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 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
+ require "gapic/common"
20
+ require "gapic/config"
21
+ require "gapic/config/method"
22
+
23
+ require "google/cloud/capacity_planner/v1beta/version"
24
+
25
+ require "google/cloud/capacity_planner/v1beta/capacity_planning_service/credentials"
26
+ require "google/cloud/capacity_planner/v1beta/capacity_planning_service/paths"
27
+ require "google/cloud/capacity_planner/v1beta/capacity_planning_service/client"
28
+ require "google/cloud/capacity_planner/v1beta/capacity_planning_service/rest"
29
+
30
+ module Google
31
+ module Cloud
32
+ module CapacityPlanner
33
+ module V1beta
34
+ ##
35
+ # This API allows users to plan for GCP capacity associated with their
36
+ # projects. Users can request additional capacity for GCP resources such as
37
+ # VMs, PDs, etc.
38
+ #
39
+ # @example Load this service and instantiate a gRPC client
40
+ #
41
+ # require "google/cloud/capacity_planner/v1beta/capacity_planning_service"
42
+ # client = ::Google::Cloud::CapacityPlanner::V1beta::CapacityPlanningService::Client.new
43
+ #
44
+ # @example Load this service and instantiate a REST client
45
+ #
46
+ # require "google/cloud/capacity_planner/v1beta/capacity_planning_service/rest"
47
+ # client = ::Google::Cloud::CapacityPlanner::V1beta::CapacityPlanningService::Rest::Client.new
48
+ #
49
+ module CapacityPlanningService
50
+ end
51
+ end
52
+ end
53
+ end
54
+ end
55
+
56
+ helper_path = ::File.join __dir__, "capacity_planning_service", "helpers.rb"
57
+ require "google/cloud/capacity_planner/v1beta/capacity_planning_service/helpers" if ::File.file? helper_path
@@ -0,0 +1,38 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 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
+ require "google/cloud/capacity_planner/v1beta/capacity_planning_service/rest"
20
+ require "google/cloud/capacity_planner/v1beta/usage_service/rest"
21
+ require "google/cloud/capacity_planner/v1beta/version"
22
+
23
+ module Google
24
+ module Cloud
25
+ module CapacityPlanner
26
+ ##
27
+ # To load just the REST part of this package, including all its services, and instantiate a REST client:
28
+ #
29
+ # @example
30
+ #
31
+ # require "google/cloud/capacity_planner/v1beta/rest"
32
+ # client = ::Google::Cloud::CapacityPlanner::V1beta::CapacityPlanningService::Rest::Client.new
33
+ #
34
+ module V1beta
35
+ end
36
+ end
37
+ end
38
+ end