google-cloud-cloud_quotas-v1 0.a → 0.2.0
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/api/cloudquotas/v1/cloudquotas_pb.rb +58 -0
- data/lib/google/api/cloudquotas/v1/cloudquotas_services_pb.rb +62 -0
- data/lib/google/api/cloudquotas/v1/resources_pb.rb +58 -0
- data/lib/google/cloud/cloud_quotas/v1/cloud_quotas/client.rb +1002 -0
- data/lib/google/cloud/cloud_quotas/v1/cloud_quotas/credentials.rb +47 -0
- data/lib/google/cloud/cloud_quotas/v1/cloud_quotas/paths.rb +265 -0
- data/lib/google/cloud/cloud_quotas/v1/cloud_quotas/rest/client.rb +933 -0
- data/lib/google/cloud/cloud_quotas/v1/cloud_quotas/rest/service_stub.rb +504 -0
- data/lib/google/cloud/cloud_quotas/v1/cloud_quotas/rest.rb +58 -0
- data/lib/google/cloud/cloud_quotas/v1/cloud_quotas.rb +61 -0
- data/lib/google/cloud/cloud_quotas/v1/rest.rb +37 -0
- data/lib/google/cloud/cloud_quotas/v1/version.rb +7 -2
- data/lib/google/cloud/cloud_quotas/v1.rb +45 -0
- data/lib/google-cloud-cloud_quotas-v1.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/client.rb +395 -0
- data/proto_docs/google/api/cloudquotas/v1/cloudquotas.rb +196 -0
- data/proto_docs/google/api/cloudquotas/v1/resources.rb +332 -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 +222 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/protobuf/timestamp.rb +127 -0
- data/proto_docs/google/protobuf/wrappers.rb +121 -0
- metadata +184 -10
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 5fd671e70f580c31e71b0b3ec730fab5146a4de10e6e202772b5b85afa4f187f
|
4
|
+
data.tar.gz: 3f198bd2afa8e31534df8c5dabda46794087c93ffd48acd5686ac18b9dd342b4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e3ad866e2660c9a34b0c7896f085497c97ae2ef42762c2bc14ca9cdcb2f1dc9a826f71ad2cee92c85b15a1f117d06ead6c6258072d98a7c1f1d29b75cb9034e7
|
7
|
+
data.tar.gz: 765a23bd08545466eafaae0cd42e049dbf1c0be6f23bc82b8ea1b1c99f49759a91f6df2a5550d0d4db8acb123a2b71c02b091d040134f63cf0ab420b61049f5d
|
data/.yardopts
ADDED
data/AUTHENTICATION.md
ADDED
@@ -0,0 +1,122 @@
|
|
1
|
+
# Authentication
|
2
|
+
|
3
|
+
The recommended way to authenticate to the google-cloud-cloud_quotas-v1 library is to use
|
4
|
+
[Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
|
5
|
+
To review all of your authentication options, see [Credentials lookup](#credential-lookup).
|
6
|
+
|
7
|
+
## Quickstart
|
8
|
+
|
9
|
+
The following example shows how to set up authentication for a local development
|
10
|
+
environment with your user credentials.
|
11
|
+
|
12
|
+
**NOTE:** This method is _not_ recommended for running in production. User credentials
|
13
|
+
should be used only during development.
|
14
|
+
|
15
|
+
1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
|
16
|
+
2. Set up a local ADC file with your user credentials:
|
17
|
+
|
18
|
+
```sh
|
19
|
+
gcloud auth application-default login
|
20
|
+
```
|
21
|
+
|
22
|
+
3. Write code as if already authenticated.
|
23
|
+
|
24
|
+
For more information about setting up authentication for a local development environment, see
|
25
|
+
[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
|
26
|
+
|
27
|
+
## Credential Lookup
|
28
|
+
|
29
|
+
The google-cloud-cloud_quotas-v1 library provides several mechanisms to configure your system.
|
30
|
+
Generally, using Application Default Credentials to facilitate automatic
|
31
|
+
credentials discovery is the easist method. But if you need to explicitly specify
|
32
|
+
credentials, there are several methods available to you.
|
33
|
+
|
34
|
+
Credentials are accepted in the following ways, in the following order or precedence:
|
35
|
+
|
36
|
+
1. Credentials specified in method arguments
|
37
|
+
2. Credentials specified in configuration
|
38
|
+
3. Credentials pointed to or included in environment variables
|
39
|
+
4. Credentials found in local ADC file
|
40
|
+
5. Credentials returned by the metadata server for the attached service account (GCP)
|
41
|
+
|
42
|
+
### Configuration
|
43
|
+
|
44
|
+
You can configure a path to a JSON credentials file, either for an individual client object or
|
45
|
+
globally, for all client objects. The JSON file can contain credentials created for
|
46
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
47
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
48
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
49
|
+
|
50
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
51
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
52
|
+
whenever possible.
|
53
|
+
|
54
|
+
To configure a credentials file for an individual client initialization:
|
55
|
+
|
56
|
+
```ruby
|
57
|
+
require "google/cloud/cloud_quotas/v1"
|
58
|
+
|
59
|
+
client = ::Google::Cloud::CloudQuotas::V1::CloudQuotas::Client.new do |config|
|
60
|
+
config.credentials = "path/to/credentialfile.json"
|
61
|
+
end
|
62
|
+
```
|
63
|
+
|
64
|
+
To configure a credentials file globally for all clients:
|
65
|
+
|
66
|
+
```ruby
|
67
|
+
require "google/cloud/cloud_quotas/v1"
|
68
|
+
|
69
|
+
::Google::Cloud::CloudQuotas::V1::CloudQuotas::Client.configure do |config|
|
70
|
+
config.credentials = "path/to/credentialfile.json"
|
71
|
+
end
|
72
|
+
|
73
|
+
client = ::Google::Cloud::CloudQuotas::V1::CloudQuotas::Client.new
|
74
|
+
```
|
75
|
+
|
76
|
+
### Environment Variables
|
77
|
+
|
78
|
+
You can also use an environment variable to provide a JSON credentials file.
|
79
|
+
The environment variable can contain a path to the credentials file or, for
|
80
|
+
environments such as Docker containers where writing files is not encouraged,
|
81
|
+
you can include the credentials file itself.
|
82
|
+
|
83
|
+
The JSON file can contain credentials created for
|
84
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
85
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
86
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
87
|
+
|
88
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
89
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
90
|
+
whenever possible.
|
91
|
+
|
92
|
+
The environment variables that google-cloud-cloud_quotas-v1
|
93
|
+
checks for credentials are:
|
94
|
+
|
95
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
96
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
97
|
+
|
98
|
+
```ruby
|
99
|
+
require "google/cloud/cloud_quotas/v1"
|
100
|
+
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
102
|
+
|
103
|
+
client = ::Google::Cloud::CloudQuotas::V1::CloudQuotas::Client.new
|
104
|
+
```
|
105
|
+
|
106
|
+
### Local ADC file
|
107
|
+
|
108
|
+
You can set up a local ADC file with your user credentials for authentication during
|
109
|
+
development. If credentials are not provided in code or in environment variables,
|
110
|
+
then the local ADC credentials are discovered.
|
111
|
+
|
112
|
+
Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
|
113
|
+
|
114
|
+
### Google Cloud Platform environments
|
115
|
+
|
116
|
+
When running on Google Cloud Platform (GCP), including Google Compute Engine
|
117
|
+
(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
|
118
|
+
Functions (GCF) and Cloud Run, credentials are retrieved from the attached
|
119
|
+
service account automatically. Code should be written as if already authenticated.
|
120
|
+
|
121
|
+
For more information, see
|
122
|
+
[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
|
data/README.md
CHANGED
@@ -1,8 +1,144 @@
|
|
1
|
-
#
|
2
|
-
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
1
|
+
# Ruby Client for the Cloud Quotas V1 API
|
2
|
+
|
3
|
+
Cloud Quotas API provides Google Cloud service consumers with management and observability for resource usage, quotas, and restrictions of the services they consume.
|
4
|
+
|
5
|
+
Cloud Quotas API provides Google Cloud service consumers with management and observability for resource usage, quotas, and restrictions of the services they consume.
|
6
|
+
|
7
|
+
https://github.com/googleapis/google-cloud-ruby
|
8
|
+
|
9
|
+
This gem is a _versioned_ client. It provides basic client classes for a
|
10
|
+
specific version of the Cloud Quotas V1 API. Most users should consider using
|
11
|
+
the main client gem,
|
12
|
+
[google-cloud-cloud_quotas](https://rubygems.org/gems/google-cloud-cloud_quotas).
|
13
|
+
See the section below titled *Which client should I use?* for more information.
|
14
|
+
|
15
|
+
## Installation
|
16
|
+
|
17
|
+
```
|
18
|
+
$ gem install google-cloud-cloud_quotas-v1
|
19
|
+
```
|
20
|
+
|
21
|
+
## Before You Begin
|
22
|
+
|
23
|
+
In order to use this library, you first need to go through the following steps:
|
24
|
+
|
25
|
+
1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
|
26
|
+
1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
|
27
|
+
1. [Enable the API.](https://console.cloud.google.com/apis/library/cloudquotas.googleapis.com)
|
28
|
+
1. {file:AUTHENTICATION.md Set up authentication.}
|
29
|
+
|
30
|
+
## Quick Start
|
31
|
+
|
32
|
+
```ruby
|
33
|
+
require "google/cloud/cloud_quotas/v1"
|
34
|
+
|
35
|
+
client = ::Google::Cloud::CloudQuotas::V1::CloudQuotas::Client.new
|
36
|
+
request = ::Google::Cloud::CloudQuotas::V1::ListQuotaInfosRequest.new # (request fields as keyword arguments...)
|
37
|
+
response = client.list_quota_infos request
|
38
|
+
```
|
39
|
+
|
40
|
+
View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-cloud_quotas-v1/latest)
|
41
|
+
for class and method documentation.
|
42
|
+
|
43
|
+
See also the [Product Documentation](https://cloud.google.com/docs/quota/api-overview)
|
44
|
+
for general usage information.
|
45
|
+
|
46
|
+
## Enabling Logging
|
47
|
+
|
48
|
+
To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
|
49
|
+
The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
|
50
|
+
or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
|
51
|
+
that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
|
52
|
+
and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
|
53
|
+
|
54
|
+
Configuring a Ruby stdlib logger:
|
55
|
+
|
56
|
+
```ruby
|
57
|
+
require "logger"
|
58
|
+
|
59
|
+
module MyLogger
|
60
|
+
LOGGER = Logger.new $stderr, level: Logger::WARN
|
61
|
+
def logger
|
62
|
+
LOGGER
|
63
|
+
end
|
64
|
+
end
|
65
|
+
|
66
|
+
# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
|
67
|
+
module GRPC
|
68
|
+
extend MyLogger
|
69
|
+
end
|
70
|
+
```
|
71
|
+
|
72
|
+
|
73
|
+
## Google Cloud Samples
|
74
|
+
|
75
|
+
To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
|
76
|
+
|
77
|
+
## Supported Ruby Versions
|
78
|
+
|
79
|
+
This library is supported on Ruby 2.6+.
|
80
|
+
|
81
|
+
Google provides official support for Ruby versions that are actively supported
|
82
|
+
by Ruby Core—that is, Ruby versions that are either in normal maintenance or
|
83
|
+
in security maintenance, and not end of life. Older versions of Ruby _may_
|
84
|
+
still work, but are unsupported and not recommended. See
|
85
|
+
https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
|
86
|
+
support schedule.
|
87
|
+
|
88
|
+
## Which client should I use?
|
89
|
+
|
90
|
+
Most modern Ruby client libraries for Google APIs come in two flavors: the main
|
91
|
+
client library with a name such as `google-cloud-cloud_quotas`,
|
92
|
+
and lower-level _versioned_ client libraries with names such as
|
93
|
+
`google-cloud-cloud_quotas-v1`.
|
94
|
+
_In most cases, you should install the main client._
|
95
|
+
|
96
|
+
### What's the difference between the main client and a versioned client?
|
97
|
+
|
98
|
+
A _versioned client_ provides a basic set of data types and client classes for
|
99
|
+
a _single version_ of a specific service. (That is, for a service with multiple
|
100
|
+
versions, there might be a separate versioned client for each service version.)
|
101
|
+
Most versioned clients are written and maintained by a code generator.
|
102
|
+
|
103
|
+
The _main client_ is designed to provide you with the _recommended_ client
|
104
|
+
interfaces for the service. There will be only one main client for any given
|
105
|
+
service, even a service with multiple versions. The main client includes
|
106
|
+
factory methods for constructing the client objects we recommend for most
|
107
|
+
users. In some cases, those will be classes provided by an underlying versioned
|
108
|
+
client; in other cases, they will be handwritten higher-level client objects
|
109
|
+
with additional capabilities, convenience methods, or best practices built in.
|
110
|
+
Generally, the main client will default to a recommended service version,
|
111
|
+
although in some cases you can override this if you need to talk to a specific
|
112
|
+
service version.
|
113
|
+
|
114
|
+
### Why would I want to use the main client?
|
115
|
+
|
116
|
+
We recommend that most users install the main client gem for a service. You can
|
117
|
+
identify this gem as the one _without_ a version in its name, e.g.
|
118
|
+
`google-cloud-cloud_quotas`.
|
119
|
+
The main client is recommended because it will embody the best practices for
|
120
|
+
accessing the service, and may also provide more convenient interfaces or
|
121
|
+
tighter integration into frameworks and third-party libraries. In addition, the
|
122
|
+
documentation and samples published by Google will generally demonstrate use of
|
123
|
+
the main client.
|
124
|
+
|
125
|
+
### Why would I want to use a versioned client?
|
126
|
+
|
127
|
+
You can use a versioned client if you are content with a possibly lower-level
|
128
|
+
class interface, you explicitly want to avoid features provided by the main
|
129
|
+
client, or you want to access a specific service version not be covered by the
|
130
|
+
main client. You can identify versioned client gems because the service version
|
131
|
+
is part of the name, e.g. `google-cloud-cloud_quotas-v1`.
|
132
|
+
|
133
|
+
### What about the google-apis-<name> clients?
|
134
|
+
|
135
|
+
Client library gems with names that begin with `google-apis-` are based on an
|
136
|
+
older code generation technology. They talk to a REST/JSON backend (whereas
|
137
|
+
most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
|
138
|
+
not offer the same performance, features, and ease of use provided by more
|
139
|
+
modern clients.
|
140
|
+
|
141
|
+
The `google-apis-` clients have wide coverage across Google services, so you
|
142
|
+
might need to use one if there is no modern client available for the service.
|
143
|
+
However, if a modern client is available, we generally recommend it over the
|
144
|
+
older `google-apis-` clients.
|
@@ -0,0 +1,58 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
3
|
+
# source: google/api/cloudquotas/v1/cloudquotas.proto
|
4
|
+
|
5
|
+
require 'google/protobuf'
|
6
|
+
|
7
|
+
require 'google/api/annotations_pb'
|
8
|
+
require 'google/api/client_pb'
|
9
|
+
require 'google/api/cloudquotas/v1/resources_pb'
|
10
|
+
require 'google/api/field_behavior_pb'
|
11
|
+
require 'google/api/resource_pb'
|
12
|
+
require 'google/protobuf/field_mask_pb'
|
13
|
+
|
14
|
+
|
15
|
+
descriptor_data = "\n+google/api/cloudquotas/v1/cloudquotas.proto\x12\x19google.api.cloudquotas.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a)google/api/cloudquotas/v1/resources.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a google/protobuf/field_mask.proto\"\x86\x01\n\x15ListQuotaInfosRequest\x12<\n\x06parent\x18\x01 \x01(\tB,\xe0\x41\x02\xfa\x41&\x12$cloudquotas.googleapis.com/QuotaInfo\x12\x16\n\tpage_size\x18\x02 \x01(\x05\x42\x03\xe0\x41\x01\x12\x17\n\npage_token\x18\x03 \x01(\tB\x03\xe0\x41\x01\"l\n\x16ListQuotaInfosResponse\x12\x39\n\x0bquota_infos\x18\x01 \x03(\x0b\x32$.google.api.cloudquotas.v1.QuotaInfo\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\"Q\n\x13GetQuotaInfoRequest\x12:\n\x04name\x18\x01 \x01(\tB,\xe0\x41\x02\xfa\x41&\n$cloudquotas.googleapis.com/QuotaInfo\"\xbe\x01\n\x1bListQuotaPreferencesRequest\x12\x42\n\x06parent\x18\x01 \x01(\tB2\xe0\x41\x02\xfa\x41,\x12*cloudquotas.googleapis.com/QuotaPreference\x12\x16\n\tpage_size\x18\x02 \x01(\x05\x42\x03\xe0\x41\x01\x12\x17\n\npage_token\x18\x03 \x01(\tB\x03\xe0\x41\x01\x12\x13\n\x06\x66ilter\x18\x04 \x01(\tB\x03\xe0\x41\x01\x12\x15\n\x08order_by\x18\x05 \x01(\tB\x03\xe0\x41\x01\"\x93\x01\n\x1cListQuotaPreferencesResponse\x12\x45\n\x11quota_preferences\x18\x01 \x03(\x0b\x32*.google.api.cloudquotas.v1.QuotaPreference\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\x12\x13\n\x0bunreachable\x18\x03 \x03(\t\"]\n\x19GetQuotaPreferenceRequest\x12@\n\x04name\x18\x01 \x01(\tB2\xe0\x41\x02\xfa\x41,\n*cloudquotas.googleapis.com/QuotaPreference\"\x9a\x02\n\x1c\x43reateQuotaPreferenceRequest\x12\x42\n\x06parent\x18\x01 \x01(\tB2\xe0\x41\x02\xfa\x41,\x12*cloudquotas.googleapis.com/QuotaPreference\x12 \n\x13quota_preference_id\x18\x02 \x01(\tB\x03\xe0\x41\x01\x12I\n\x10quota_preference\x18\x03 \x01(\x0b\x32*.google.api.cloudquotas.v1.QuotaPreferenceB\x03\xe0\x41\x02\x12I\n\x14ignore_safety_checks\x18\x04 \x03(\x0e\x32+.google.api.cloudquotas.v1.QuotaSafetyCheck\"\xa2\x02\n\x1cUpdateQuotaPreferenceRequest\x12\x34\n\x0bupdate_mask\x18\x01 \x01(\x0b\x32\x1a.google.protobuf.FieldMaskB\x03\xe0\x41\x01\x12I\n\x10quota_preference\x18\x02 \x01(\x0b\x32*.google.api.cloudquotas.v1.QuotaPreferenceB\x03\xe0\x41\x02\x12\x1a\n\rallow_missing\x18\x03 \x01(\x08\x42\x03\xe0\x41\x01\x12\x1a\n\rvalidate_only\x18\x04 \x01(\x08\x42\x03\xe0\x41\x01\x12I\n\x14ignore_safety_checks\x18\x05 \x03(\x0e\x32+.google.api.cloudquotas.v1.QuotaSafetyCheck2\xb9\x11\n\x0b\x43loudQuotas\x12\xc1\x02\n\x0eListQuotaInfos\x12\x30.google.api.cloudquotas.v1.ListQuotaInfosRequest\x1a\x31.google.api.cloudquotas.v1.ListQuotaInfosResponse\"\xc9\x01\x82\xd3\xe4\x93\x02\xb9\x01\x12\x39/v1/{parent=projects/*/locations/*/services/*}/quotaInfosZ@\x12>/v1/{parent=organizations/*/locations/*/services/*}/quotaInfosZ:\x12\x38/v1/{parent=folders/*/locations/*/services/*}/quotaInfos\xda\x41\x06parent\x12\xae\x02\n\x0cGetQuotaInfo\x12..google.api.cloudquotas.v1.GetQuotaInfoRequest\x1a$.google.api.cloudquotas.v1.QuotaInfo\"\xc7\x01\x82\xd3\xe4\x93\x02\xb9\x01\x12\x39/v1/{name=projects/*/locations/*/services/*/quotaInfos/*}Z@\x12>/v1/{name=organizations/*/locations/*/services/*/quotaInfos/*}Z:\x12\x38/v1/{name=folders/*/locations/*/services/*/quotaInfos/*}\xda\x41\x04name\x12\xc4\x02\n\x14ListQuotaPreferences\x12\x36.google.api.cloudquotas.v1.ListQuotaPreferencesRequest\x1a\x37.google.api.cloudquotas.v1.ListQuotaPreferencesResponse\"\xba\x01\x82\xd3\xe4\x93\x02\xaa\x01\x12\x34/v1/{parent=projects/*/locations/*}/quotaPreferencesZ5\x12\x33/v1/{parent=folders/*/locations/*}/quotaPreferencesZ;\x12\x39/v1/{parent=organizations/*/locations/*}/quotaPreferences\xda\x41\x06parent\x12\xb1\x02\n\x12GetQuotaPreference\x12\x34.google.api.cloudquotas.v1.GetQuotaPreferenceRequest\x1a*.google.api.cloudquotas.v1.QuotaPreference\"\xb8\x01\x82\xd3\xe4\x93\x02\xaa\x01\x12\x34/v1/{name=projects/*/locations/*/quotaPreferences/*}Z;\x12\x39/v1/{name=organizations/*/locations/*/quotaPreferences/*}Z5\x12\x33/v1/{name=folders/*/locations/*/quotaPreferences/*}\xda\x41\x04name\x12\xae\x03\n\x15\x43reateQuotaPreference\x12\x37.google.api.cloudquotas.v1.CreateQuotaPreferenceRequest\x1a*.google.api.cloudquotas.v1.QuotaPreference\"\xaf\x02\x82\xd3\xe4\x93\x02\xe0\x01\"4/v1/{parent=projects/*/locations/*}/quotaPreferences:\x10quota_preferenceZG\"3/v1/{parent=folders/*/locations/*}/quotaPreferences:\x10quota_preferenceZM\"9/v1/{parent=organizations/*/locations/*}/quotaPreferences:\x10quota_preference\xda\x41+parent,quota_preference,quota_preference_id\xda\x41\x17parent,quota_preference\x12\xb8\x03\n\x15UpdateQuotaPreference\x12\x37.google.api.cloudquotas.v1.UpdateQuotaPreferenceRequest\x1a*.google.api.cloudquotas.v1.QuotaPreference\"\xb9\x02\x82\xd3\xe4\x93\x02\x93\x02\x32\x45/v1/{quota_preference.name=projects/*/locations/*/quotaPreferences/*}:\x10quota_preferenceZX2D/v1/{quota_preference.name=folders/*/locations/*/quotaPreferences/*}:\x10quota_preferenceZ^2J/v1/{quota_preference.name=organizations/*/locations/*/quotaPreferences/*}:\x10quota_preference\xda\x41\x1cquota_preference,update_mask\x1aN\xca\x41\x1a\x63loudquotas.googleapis.com\xd2\x41.https://www.googleapis.com/auth/cloud-platformB\xe3\x04\n\x1d\x63om.google.api.cloudquotas.v1B\x10\x43loudquotasProtoP\x01ZAcloud.google.com/go/cloudquotas/apiv1/cloudquotaspb;cloudquotaspb\xaa\x02\x1bGoogle.Cloud.CloudQuotas.V1\xca\x02\x1bGoogle\\Cloud\\CloudQuotas\\V1\xea\x02\x1eGoogle::Cloud::CloudQuotas::V1\xea\x41\xe0\x01\n\"cloudquotas.googleapis.com/Service\x12:projects/{project}/locations/{location}/services/{service}\x12\x38\x66olders/{folder}/locations/{location}/services/{service}\x12\x44organizations/{organization}/locations/{location}/services/{service}\xea\x41\xa8\x01\n#cloudquotas.googleapis.com/Location\x12\'projects/{project}/locations/{location}\x12%folders/{folder}/locations/{location}\x12\x31organizations/{organization}/locations/{location}b\x06proto3"
|
16
|
+
|
17
|
+
pool = Google::Protobuf::DescriptorPool.generated_pool
|
18
|
+
|
19
|
+
begin
|
20
|
+
pool.add_serialized_file(descriptor_data)
|
21
|
+
rescue TypeError => e
|
22
|
+
# Compatibility code: will be removed in the next major version.
|
23
|
+
require 'google/protobuf/descriptor_pb'
|
24
|
+
parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
|
25
|
+
parsed.clear_dependency
|
26
|
+
serialized = parsed.class.encode(parsed)
|
27
|
+
file = pool.add_serialized_file(serialized)
|
28
|
+
warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
|
29
|
+
imports = [
|
30
|
+
["google.api.cloudquotas.v1.QuotaInfo", "google/api/cloudquotas/v1/resources.proto"],
|
31
|
+
["google.protobuf.FieldMask", "google/protobuf/field_mask.proto"],
|
32
|
+
]
|
33
|
+
imports.each do |type_name, expected_filename|
|
34
|
+
import_file = pool.lookup(type_name).file_descriptor
|
35
|
+
if import_file.name != expected_filename
|
36
|
+
warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
|
37
|
+
end
|
38
|
+
end
|
39
|
+
warn "Each proto file must use a consistent fully-qualified name."
|
40
|
+
warn "This will become an error in the next major version."
|
41
|
+
end
|
42
|
+
|
43
|
+
module Google
|
44
|
+
module Cloud
|
45
|
+
module CloudQuotas
|
46
|
+
module V1
|
47
|
+
ListQuotaInfosRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.api.cloudquotas.v1.ListQuotaInfosRequest").msgclass
|
48
|
+
ListQuotaInfosResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.api.cloudquotas.v1.ListQuotaInfosResponse").msgclass
|
49
|
+
GetQuotaInfoRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.api.cloudquotas.v1.GetQuotaInfoRequest").msgclass
|
50
|
+
ListQuotaPreferencesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.api.cloudquotas.v1.ListQuotaPreferencesRequest").msgclass
|
51
|
+
ListQuotaPreferencesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.api.cloudquotas.v1.ListQuotaPreferencesResponse").msgclass
|
52
|
+
GetQuotaPreferenceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.api.cloudquotas.v1.GetQuotaPreferenceRequest").msgclass
|
53
|
+
CreateQuotaPreferenceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.api.cloudquotas.v1.CreateQuotaPreferenceRequest").msgclass
|
54
|
+
UpdateQuotaPreferenceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.api.cloudquotas.v1.UpdateQuotaPreferenceRequest").msgclass
|
55
|
+
end
|
56
|
+
end
|
57
|
+
end
|
58
|
+
end
|
@@ -0,0 +1,62 @@
|
|
1
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
|
+
# Source: google/api/cloudquotas/v1/cloudquotas.proto for package 'Google.Cloud.CloudQuotas.V1'
|
3
|
+
# Original file comments:
|
4
|
+
# Copyright 2023 Google LLC
|
5
|
+
#
|
6
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
7
|
+
# you may not use this file except in compliance with the License.
|
8
|
+
# You may obtain a copy of the License at
|
9
|
+
#
|
10
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
11
|
+
#
|
12
|
+
# Unless required by applicable law or agreed to in writing, software
|
13
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
14
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
15
|
+
# See the License for the specific language governing permissions and
|
16
|
+
# limitations under the License.
|
17
|
+
#
|
18
|
+
|
19
|
+
require 'grpc'
|
20
|
+
require 'google/api/cloudquotas/v1/cloudquotas_pb'
|
21
|
+
|
22
|
+
module Google
|
23
|
+
module Cloud
|
24
|
+
module CloudQuotas
|
25
|
+
module V1
|
26
|
+
module CloudQuotas
|
27
|
+
# The Cloud Quotas API is an infrastructure service for Google Cloud that lets
|
28
|
+
# service consumers list and manage their resource usage limits.
|
29
|
+
#
|
30
|
+
# - List/Get the metadata and current status of the quotas for a service.
|
31
|
+
# - Create/Update quota preferencess that declare the preferred quota values.
|
32
|
+
# - Check the status of a quota preference request.
|
33
|
+
# - List/Get pending and historical quota preference.
|
34
|
+
class Service
|
35
|
+
|
36
|
+
include ::GRPC::GenericService
|
37
|
+
|
38
|
+
self.marshal_class_method = :encode
|
39
|
+
self.unmarshal_class_method = :decode
|
40
|
+
self.service_name = 'google.api.cloudquotas.v1.CloudQuotas'
|
41
|
+
|
42
|
+
# Lists QuotaInfos of all quotas for a given project, folder or organization.
|
43
|
+
rpc :ListQuotaInfos, ::Google::Cloud::CloudQuotas::V1::ListQuotaInfosRequest, ::Google::Cloud::CloudQuotas::V1::ListQuotaInfosResponse
|
44
|
+
# Retrieve the QuotaInfo of a quota for a project, folder or organization.
|
45
|
+
rpc :GetQuotaInfo, ::Google::Cloud::CloudQuotas::V1::GetQuotaInfoRequest, ::Google::Cloud::CloudQuotas::V1::QuotaInfo
|
46
|
+
# Lists QuotaPreferences in a given project, folder or organization.
|
47
|
+
rpc :ListQuotaPreferences, ::Google::Cloud::CloudQuotas::V1::ListQuotaPreferencesRequest, ::Google::Cloud::CloudQuotas::V1::ListQuotaPreferencesResponse
|
48
|
+
# Gets details of a single QuotaPreference.
|
49
|
+
rpc :GetQuotaPreference, ::Google::Cloud::CloudQuotas::V1::GetQuotaPreferenceRequest, ::Google::Cloud::CloudQuotas::V1::QuotaPreference
|
50
|
+
# Creates a new QuotaPreference that declares the desired value for a quota.
|
51
|
+
rpc :CreateQuotaPreference, ::Google::Cloud::CloudQuotas::V1::CreateQuotaPreferenceRequest, ::Google::Cloud::CloudQuotas::V1::QuotaPreference
|
52
|
+
# Updates the parameters of a single QuotaPreference. It can updates the
|
53
|
+
# config in any states, not just the ones pending approval.
|
54
|
+
rpc :UpdateQuotaPreference, ::Google::Cloud::CloudQuotas::V1::UpdateQuotaPreferenceRequest, ::Google::Cloud::CloudQuotas::V1::QuotaPreference
|
55
|
+
end
|
56
|
+
|
57
|
+
Stub = Service.rpc_stub_class
|
58
|
+
end
|
59
|
+
end
|
60
|
+
end
|
61
|
+
end
|
62
|
+
end
|
@@ -0,0 +1,58 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
3
|
+
# source: google/api/cloudquotas/v1/resources.proto
|
4
|
+
|
5
|
+
require 'google/protobuf'
|
6
|
+
|
7
|
+
require 'google/api/field_behavior_pb'
|
8
|
+
require 'google/api/resource_pb'
|
9
|
+
require 'google/protobuf/timestamp_pb'
|
10
|
+
require 'google/protobuf/wrappers_pb'
|
11
|
+
|
12
|
+
|
13
|
+
descriptor_data = "\n)google/api/cloudquotas/v1/resources.proto\x12\x19google.api.cloudquotas.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x1fgoogle/protobuf/timestamp.proto\x1a\x1egoogle/protobuf/wrappers.proto\"\x9f\x07\n\tQuotaInfo\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x10\n\x08quota_id\x18\x02 \x01(\t\x12\x0e\n\x06metric\x18\x03 \x01(\t\x12\x0f\n\x07service\x18\x04 \x01(\t\x12\x12\n\nis_precise\x18\x05 \x01(\x08\x12\x18\n\x10refresh_interval\x18\x06 \x01(\t\x12J\n\x0e\x63ontainer_type\x18\x07 \x01(\x0e\x32\x32.google.api.cloudquotas.v1.QuotaInfo.ContainerType\x12\x12\n\ndimensions\x18\x08 \x03(\t\x12\x1b\n\x13metric_display_name\x18\t \x01(\t\x12\x1a\n\x12quota_display_name\x18\n \x01(\t\x12\x13\n\x0bmetric_unit\x18\x0b \x01(\t\x12W\n\x1aquota_increase_eligibility\x18\x0c \x01(\x0b\x32\x33.google.api.cloudquotas.v1.QuotaIncreaseEligibility\x12\x10\n\x08is_fixed\x18\r \x01(\x08\x12\x43\n\x10\x64imensions_infos\x18\x0e \x03(\x0b\x32).google.api.cloudquotas.v1.DimensionsInfo\x12\x15\n\ris_concurrent\x18\x0f \x01(\x08\x12!\n\x19service_request_quota_uri\x18\x11 \x01(\t\"Z\n\rContainerType\x12\x1e\n\x1a\x43ONTAINER_TYPE_UNSPECIFIED\x10\x00\x12\x0b\n\x07PROJECT\x10\x01\x12\n\n\x06\x46OLDER\x10\x02\x12\x10\n\x0cORGANIZATION\x10\x03:\xae\x02\xea\x41\xaa\x02\n$cloudquotas.googleapis.com/QuotaInfo\x12Rprojects/{project}/locations/{location}/services/{service}/quotaInfos/{quota_info}\x12Pfolders/{folder}/locations/{location}/services/{service}/quotaInfos/{quota_info}\x12\\organizations/{organization}/locations/{location}/services/{service}/quotaInfos/{quota_info}\"\xfc\x01\n\x18QuotaIncreaseEligibility\x12\x13\n\x0bis_eligible\x18\x01 \x01(\x08\x12\x65\n\x14ineligibility_reason\x18\x02 \x01(\x0e\x32G.google.api.cloudquotas.v1.QuotaIncreaseEligibility.IneligibilityReason\"d\n\x13IneligibilityReason\x12$\n INELIGIBILITY_REASON_UNSPECIFIED\x10\x00\x12\x1c\n\x18NO_VALID_BILLING_ACCOUNT\x10\x01\x12\t\n\x05OTHER\x10\x02\"\x83\x06\n\x0fQuotaPreference\x12\x0c\n\x04name\x18\x01 \x01(\t\x12N\n\ndimensions\x18\x02 \x03(\x0b\x32:.google.api.cloudquotas.v1.QuotaPreference.DimensionsEntry\x12\x41\n\x0cquota_config\x18\x03 \x01(\x0b\x32&.google.api.cloudquotas.v1.QuotaConfigB\x03\xe0\x41\x02\x12\x11\n\x04\x65tag\x18\x04 \x01(\tB\x03\xe0\x41\x01\x12\x34\n\x0b\x63reate_time\x18\x05 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x34\n\x0bupdate_time\x18\x06 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x14\n\x07service\x18\x07 \x01(\tB\x03\xe0\x41\x02\x12\x15\n\x08quota_id\x18\x08 \x01(\tB\x03\xe0\x41\x02\x12\x18\n\x0breconciling\x18\n \x01(\x08\x42\x03\xe0\x41\x03\x12\x15\n\rjustification\x18\x0b \x01(\t\x12\x1d\n\rcontact_email\x18\x0c \x01(\tB\x06\xe0\x41\x04\xe0\x41\x02\x1a\x31\n\x0f\x44imensionsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01:\x9f\x02\xea\x41\x9b\x02\n*cloudquotas.googleapis.com/QuotaPreference\x12Kprojects/{project}/locations/{location}/quotaPreferences/{quota_preference}\x12Ifolders/{folder}/locations/{location}/quotaPreferences/{quota_preference}\x12Uorganizations/{organization}/locations/{location}/quotaPreferences/{quota_preference}\"\xac\x03\n\x0bQuotaConfig\x12\x1c\n\x0fpreferred_value\x18\x01 \x01(\x03\x42\x03\xe0\x41\x02\x12\x19\n\x0cstate_detail\x18\x02 \x01(\tB\x03\xe0\x41\x03\x12\x37\n\rgranted_value\x18\x03 \x01(\x0b\x32\x1b.google.protobuf.Int64ValueB\x03\xe0\x41\x03\x12\x15\n\x08trace_id\x18\x04 \x01(\tB\x03\xe0\x41\x03\x12L\n\x0b\x61nnotations\x18\x05 \x03(\x0b\x32\x37.google.api.cloudquotas.v1.QuotaConfig.AnnotationsEntry\x12J\n\x0erequest_origin\x18\x06 \x01(\x0e\x32-.google.api.cloudquotas.v1.QuotaConfig.OriginB\x03\xe0\x41\x03\x1a\x32\n\x10\x41nnotationsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\"F\n\x06Origin\x12\x16\n\x12ORIGIN_UNSPECIFIED\x10\x00\x12\x11\n\rCLOUD_CONSOLE\x10\x01\x12\x11\n\rAUTO_ADJUSTER\x10\x02\"\xea\x01\n\x0e\x44imensionsInfo\x12M\n\ndimensions\x18\x01 \x03(\x0b\x32\x39.google.api.cloudquotas.v1.DimensionsInfo.DimensionsEntry\x12\x38\n\x07\x64\x65tails\x18\x02 \x01(\x0b\x32\'.google.api.cloudquotas.v1.QuotaDetails\x12\x1c\n\x14\x61pplicable_locations\x18\x03 \x03(\t\x1a\x31\n\x0f\x44imensionsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\"\x1d\n\x0cQuotaDetails\x12\r\n\x05value\x18\x01 \x01(\x03*~\n\x10QuotaSafetyCheck\x12\"\n\x1eQUOTA_SAFETY_CHECK_UNSPECIFIED\x10\x00\x12\x1e\n\x1aQUOTA_DECREASE_BELOW_USAGE\x10\x01\x12&\n\"QUOTA_DECREASE_PERCENTAGE_TOO_HIGH\x10\x02\x42\xd1\x01\n\x1d\x63om.google.api.cloudquotas.v1B\x0eResourcesProtoP\x01ZAcloud.google.com/go/cloudquotas/apiv1/cloudquotaspb;cloudquotaspb\xaa\x02\x1bGoogle.Cloud.CloudQuotas.V1\xca\x02\x1bGoogle\\Cloud\\CloudQuotas\\V1\xea\x02\x1eGoogle::Cloud::CloudQuotas::V1b\x06proto3"
|
14
|
+
|
15
|
+
pool = Google::Protobuf::DescriptorPool.generated_pool
|
16
|
+
|
17
|
+
begin
|
18
|
+
pool.add_serialized_file(descriptor_data)
|
19
|
+
rescue TypeError => e
|
20
|
+
# Compatibility code: will be removed in the next major version.
|
21
|
+
require 'google/protobuf/descriptor_pb'
|
22
|
+
parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
|
23
|
+
parsed.clear_dependency
|
24
|
+
serialized = parsed.class.encode(parsed)
|
25
|
+
file = pool.add_serialized_file(serialized)
|
26
|
+
warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
|
27
|
+
imports = [
|
28
|
+
["google.protobuf.Timestamp", "google/protobuf/timestamp.proto"],
|
29
|
+
["google.protobuf.Int64Value", "google/protobuf/wrappers.proto"],
|
30
|
+
]
|
31
|
+
imports.each do |type_name, expected_filename|
|
32
|
+
import_file = pool.lookup(type_name).file_descriptor
|
33
|
+
if import_file.name != expected_filename
|
34
|
+
warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
|
35
|
+
end
|
36
|
+
end
|
37
|
+
warn "Each proto file must use a consistent fully-qualified name."
|
38
|
+
warn "This will become an error in the next major version."
|
39
|
+
end
|
40
|
+
|
41
|
+
module Google
|
42
|
+
module Cloud
|
43
|
+
module CloudQuotas
|
44
|
+
module V1
|
45
|
+
QuotaInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.api.cloudquotas.v1.QuotaInfo").msgclass
|
46
|
+
QuotaInfo::ContainerType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.api.cloudquotas.v1.QuotaInfo.ContainerType").enummodule
|
47
|
+
QuotaIncreaseEligibility = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.api.cloudquotas.v1.QuotaIncreaseEligibility").msgclass
|
48
|
+
QuotaIncreaseEligibility::IneligibilityReason = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.api.cloudquotas.v1.QuotaIncreaseEligibility.IneligibilityReason").enummodule
|
49
|
+
QuotaPreference = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.api.cloudquotas.v1.QuotaPreference").msgclass
|
50
|
+
QuotaConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.api.cloudquotas.v1.QuotaConfig").msgclass
|
51
|
+
QuotaConfig::Origin = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.api.cloudquotas.v1.QuotaConfig.Origin").enummodule
|
52
|
+
DimensionsInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.api.cloudquotas.v1.DimensionsInfo").msgclass
|
53
|
+
QuotaDetails = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.api.cloudquotas.v1.QuotaDetails").msgclass
|
54
|
+
QuotaSafetyCheck = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.api.cloudquotas.v1.QuotaSafetyCheck").enummodule
|
55
|
+
end
|
56
|
+
end
|
57
|
+
end
|
58
|
+
end
|