google-cloud-service_control-v1 0.3.2 → 0.4.3

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f5dd0df1092b74cdfd9603daffcc73dbaaa292081b2dea796d03872cc602e2ff
4
- data.tar.gz: ac82224a83097a1873ba9948d0240092785e05171ee412ba78ddba810200dda1
3
+ metadata.gz: 01da9ad01ff745f86d6149371feaa9b7a569ed2c4421d3a4ac753e1fc62d3546
4
+ data.tar.gz: d5553dff2b6f72f20109f438c08fdb0f71deb0261c67e15ecd4af52c68e12369
5
5
  SHA512:
6
- metadata.gz: 77c3f8b6c71a3d7ccd865e51a4c0bdfec7bf69f1c358cb8a45a4c0c3c2703621fa3de40b7975e38e4594a5d8fcadafe0f5f86766804326028b6c57a53d31e663
7
- data.tar.gz: d4baf4c2c54e33ef8170a0075b5adc6c954fcf411eae9861736b1244df8f17874d100e00e5cf41849b72f13ff18b8805f1e44f6766718dd75f3a7d48f7961231
6
+ metadata.gz: 51708eefede90d41a2d25882171aa636cabf4100c64c5d9e2778eb9fd1043f27fafa245ece9bf30b3b82dcf2a077ecd9002f4e48852823c0122df2206cc51f57
7
+ data.tar.gz: 2743c1e542657c945d8f76c12b3c12c7880b566621fbf702a31280a2bcad5e57f0ed0e689a10bfd897bef2715ae61cc2944d31e9d91fcb9dc7e8c1ce020db930
data/AUTHENTICATION.md CHANGED
@@ -66,11 +66,11 @@ The environment variables that google-cloud-service_control-v1
66
66
  checks for credentials are configured on the service Credentials class (such as
67
67
  {::Google::Cloud::ServiceControl::V1::QuotaController::Credentials}):
68
68
 
69
- 1. `SERVICE_CONTROL_CREDENTIALS` - Path to JSON file, or JSON contents
70
- 2. `SERVICE_CONTROL_KEYFILE` - Path to JSON file, or JSON contents
71
- 3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
- 4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
- 5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
69
+ * `SERVICE_CONTROL_CREDENTIALS` - Path to JSON file, or JSON contents
70
+ * `SERVICE_CONTROL_KEYFILE` - Path to JSON file, or JSON contents
71
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
+ * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
74
74
 
75
75
  ```ruby
76
76
  require "google/cloud/service_control/v1"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::ServiceControl::V1::QuotaController::Client.new
82
82
 
83
83
  ### Configuration
84
84
 
85
- The **Credentials JSON** can be configured instead of placing them in
86
- environment variables. Either on an individual client initialization:
85
+ The path to the **Credentials JSON** file can be configured instead of storing
86
+ it in an environment variable. Either on an individual client initialization:
87
87
 
88
88
  ```ruby
89
89
  require "google/cloud/service_control/v1"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::ServiceControl::V1::QuotaController::Client.new do |co
93
93
  end
94
94
  ```
95
95
 
96
- Or configured globally for all clients:
96
+ Or globally for all clients:
97
97
 
98
98
  ```ruby
99
99
  require "google/cloud/service_control/v1"
data/README.md CHANGED
@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
33
33
  require "google/cloud/service_control/v1"
34
34
 
35
35
  client = ::Google::Cloud::ServiceControl::V1::QuotaController::Client.new
36
- request = my_create_request
36
+ request = ::Google::Cloud::ServiceControl::V1::AllocateQuotaRequest.new # (request fields as keyword arguments...)
37
37
  response = client.allocate_quota request
38
38
  ```
39
39
 
@@ -3,6 +3,7 @@
3
3
 
4
4
  require 'google/protobuf'
5
5
 
6
+ require 'google/api/distribution_pb'
6
7
  Google::Protobuf::DescriptorPool.generated_pool.build do
7
8
  add_file("google/api/servicecontrol/v1/distribution.proto", :syntax => :proto3) do
8
9
  add_message "google.api.servicecontrol.v1.Distribution" do
@@ -12,6 +13,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
12
13
  optional :maximum, :double, 4
13
14
  optional :sum_of_squared_deviation, :double, 5
14
15
  repeated :bucket_counts, :int64, 6
16
+ repeated :exemplars, :message, 10, "google.api.Distribution.Exemplar"
15
17
  oneof :bucket_option do
16
18
  optional :linear_buckets, :message, 7, "google.api.servicecontrol.v1.Distribution.LinearBuckets"
17
19
  optional :exponential_buckets, :message, 8, "google.api.servicecontrol.v1.Distribution.ExponentialBuckets"
@@ -5,6 +5,7 @@ require 'google/protobuf'
5
5
 
6
6
  require 'google/api/annotations_pb'
7
7
  require 'google/api/servicecontrol/v1/metric_value_pb'
8
+ require 'google/rpc/status_pb'
8
9
  require 'google/api/client_pb'
9
10
  Google::Protobuf::DescriptorPool.generated_pool.build do
10
11
  add_file("google/api/servicecontrol/v1/quota_controller.proto", :syntax => :proto3) do
@@ -39,6 +40,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
39
40
  optional :code, :enum, 1, "google.api.servicecontrol.v1.QuotaError.Code"
40
41
  optional :subject, :string, 2
41
42
  optional :description, :string, 3
43
+ optional :status, :message, 4, "google.rpc.Status"
42
44
  end
43
45
  add_enum "google.api.servicecontrol.v1.QuotaError.Code" do
44
46
  value :UNSPECIFIED, 0
@@ -24,13 +24,13 @@ module Google
24
24
  module ServiceControl
25
25
  module V1
26
26
  module QuotaController
27
- # [Google Quota Control API](https://cloud.google.com/service-control/overview)
27
+ # [Google Quota Control API](/service-control/overview)
28
28
  #
29
29
  # Allows clients to allocate and release quota against a [managed
30
30
  # service](https://cloud.google.com/service-management/reference/rpc/google.api/servicemanagement.v1#google.api.servicemanagement.v1.ManagedService).
31
31
  class Service
32
32
 
33
- include ::GRPC::GenericService
33
+ include GRPC::GenericService
34
34
 
35
35
  self.marshal_class_method = :encode
36
36
  self.unmarshal_class_method = :decode
@@ -4,11 +4,11 @@
4
4
  require 'google/protobuf'
5
5
 
6
6
  require 'google/api/annotations_pb'
7
+ require 'google/api/client_pb'
7
8
  require 'google/api/servicecontrol/v1/check_error_pb'
8
9
  require 'google/api/servicecontrol/v1/operation_pb'
9
10
  require 'google/protobuf/timestamp_pb'
10
11
  require 'google/rpc/status_pb'
11
- require 'google/api/client_pb'
12
12
  Google::Protobuf::DescriptorPool.generated_pool.build do
13
13
  add_file("google/api/servicecontrol/v1/service_controller.proto", :syntax => :proto3) do
14
14
  add_message "google.api.servicecontrol.v1.CheckRequest" do
@@ -24,13 +24,13 @@ module Google
24
24
  module ServiceControl
25
25
  module V1
26
26
  module ServiceController
27
- # [Google Service Control API](https://cloud.google.com/service-control/overview)
27
+ # [Google Service Control API](/service-control/overview)
28
28
  #
29
29
  # Lets clients check and report operations against a [managed
30
30
  # service](https://cloud.google.com/service-management/reference/rpc/google.api/servicemanagement.v1#google.api.servicemanagement.v1.ManagedService).
31
31
  class Service
32
32
 
33
- include ::GRPC::GenericService
33
+ include GRPC::GenericService
34
34
 
35
35
  self.marshal_class_method = :encode
36
36
  self.unmarshal_class_method = :decode
@@ -47,7 +47,8 @@ module Google
47
47
  # propagation, therefore callers MUST NOT depend on the `Check` method having
48
48
  # the latest policy information.
49
49
  #
50
- # NOTE: the [CheckRequest][google.api.servicecontrol.v1.CheckRequest] has the size limit of 64KB.
50
+ # NOTE: the [CheckRequest][google.api.servicecontrol.v1.CheckRequest] has
51
+ # the size limit (wire-format byte size) of 1MB.
51
52
  #
52
53
  # This method requires the `servicemanagement.services.check` permission
53
54
  # on the specified service. For more information, see
@@ -62,8 +63,8 @@ module Google
62
63
  # the aggregation time window to avoid data loss risk more than 0.01%
63
64
  # for business and compliance reasons.
64
65
  #
65
- # NOTE: the [ReportRequest][google.api.servicecontrol.v1.ReportRequest] has the size limit (wire-format byte size) of
66
- # 1MB.
66
+ # NOTE: the [ReportRequest][google.api.servicecontrol.v1.ReportRequest] has
67
+ # the size limit (wire-format byte size) of 1MB.
67
68
  #
68
69
  # This method requires the `servicemanagement.services.report` permission
69
70
  # on the specified service. For more information, see
@@ -30,7 +30,7 @@ module Google
30
30
  module ServiceControl
31
31
  module V1
32
32
  ##
33
- # [Google Quota Control API](https://cloud.google.com/service-control/overview)
33
+ # [Google Quota Control API](/service-control/overview)
34
34
  #
35
35
  # Allows clients to allocate and release quota against a [managed
36
36
  # service](https://cloud.google.com/service-management/reference/rpc/google.api/servicemanagement.v1#google.api.servicemanagement.v1.ManagedService).
@@ -27,7 +27,7 @@ module Google
27
27
  ##
28
28
  # Client for the QuotaController service.
29
29
  #
30
- # [Google Quota Control API](https://cloud.google.com/service-control/overview)
30
+ # [Google Quota Control API](/service-control/overview)
31
31
  #
32
32
  # Allows clients to allocate and release quota against a [managed
33
33
  # service](https://cloud.google.com/service-management/reference/rpc/google.api/servicemanagement.v1#google.api.servicemanagement.v1.ManagedService).
@@ -42,13 +42,12 @@ module Google
42
42
  # See {::Google::Cloud::ServiceControl::V1::QuotaController::Client::Configuration}
43
43
  # for a description of the configuration fields.
44
44
  #
45
- # ## Example
45
+ # @example
46
46
  #
47
- # To modify the configuration for all QuotaController clients:
48
- #
49
- # ::Google::Cloud::ServiceControl::V1::QuotaController::Client.configure do |config|
50
- # config.timeout = 10.0
51
- # end
47
+ # # Modify the configuration for all QuotaController clients
48
+ # ::Google::Cloud::ServiceControl::V1::QuotaController::Client.configure do |config|
49
+ # config.timeout = 10.0
50
+ # end
52
51
  #
53
52
  # @yield [config] Configure the Client client.
54
53
  # @yieldparam config [Client::Configuration]
@@ -95,19 +94,15 @@ module Google
95
94
  ##
96
95
  # Create a new QuotaController client object.
97
96
  #
98
- # ## Examples
99
- #
100
- # To create a new QuotaController client with the default
101
- # configuration:
97
+ # @example
102
98
  #
103
- # client = ::Google::Cloud::ServiceControl::V1::QuotaController::Client.new
99
+ # # Create a client using the default configuration
100
+ # client = ::Google::Cloud::ServiceControl::V1::QuotaController::Client.new
104
101
  #
105
- # To create a new QuotaController client with a custom
106
- # configuration:
107
- #
108
- # client = ::Google::Cloud::ServiceControl::V1::QuotaController::Client.new do |config|
109
- # config.timeout = 10.0
110
- # end
102
+ # # Create a client using a custom configuration
103
+ # client = ::Google::Cloud::ServiceControl::V1::QuotaController::Client.new do |config|
104
+ # config.timeout = 10.0
105
+ # end
111
106
  #
112
107
  # @yield [config] Configure the QuotaController client.
113
108
  # @yieldparam config [Client::Configuration]
@@ -127,14 +122,13 @@ module Google
127
122
 
128
123
  # Create credentials
129
124
  credentials = @config.credentials
130
- # Use self-signed JWT if the scope and endpoint are unchanged from default,
125
+ # Use self-signed JWT if the endpoint is unchanged from default,
131
126
  # but only if the default endpoint does not have a region prefix.
132
- enable_self_signed_jwt = @config.scope == Client.configure.scope &&
133
- @config.endpoint == Client.configure.endpoint &&
127
+ enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
134
128
  !@config.endpoint.split(".").first.include?("-")
135
129
  credentials ||= Credentials.default scope: @config.scope,
136
130
  enable_self_signed_jwt: enable_self_signed_jwt
137
- if credentials.is_a?(String) || credentials.is_a?(Hash)
131
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
138
132
  credentials = Credentials.new credentials, scope: @config.scope
139
133
  end
140
134
  @quota_project_id = @config.quota_project
@@ -225,7 +219,9 @@ module Google
225
219
  options.apply_defaults timeout: @config.rpcs.allocate_quota.timeout,
226
220
  metadata: metadata,
227
221
  retry_policy: @config.rpcs.allocate_quota.retry_policy
228
- options.apply_defaults metadata: @config.metadata,
222
+
223
+ options.apply_defaults timeout: @config.timeout,
224
+ metadata: @config.metadata,
229
225
  retry_policy: @config.retry_policy
230
226
 
231
227
  @quota_controller_stub.call_rpc :allocate_quota, request, options: options do |response, operation|
@@ -249,22 +245,21 @@ module Google
249
245
  # Configuration can be applied globally to all clients, or to a single client
250
246
  # on construction.
251
247
  #
252
- # # Examples
253
- #
254
- # To modify the global config, setting the timeout for allocate_quota
255
- # to 20 seconds, and all remaining timeouts to 10 seconds:
256
- #
257
- # ::Google::Cloud::ServiceControl::V1::QuotaController::Client.configure do |config|
258
- # config.timeout = 10.0
259
- # config.rpcs.allocate_quota.timeout = 20.0
260
- # end
261
- #
262
- # To apply the above configuration only to a new client:
263
- #
264
- # client = ::Google::Cloud::ServiceControl::V1::QuotaController::Client.new do |config|
265
- # config.timeout = 10.0
266
- # config.rpcs.allocate_quota.timeout = 20.0
267
- # end
248
+ # @example
249
+ #
250
+ # # Modify the global config, setting the timeout for
251
+ # # allocate_quota to 20 seconds,
252
+ # # and all remaining timeouts to 10 seconds.
253
+ # ::Google::Cloud::ServiceControl::V1::QuotaController::Client.configure do |config|
254
+ # config.timeout = 10.0
255
+ # config.rpcs.allocate_quota.timeout = 20.0
256
+ # end
257
+ #
258
+ # # Apply the above configuration only to a new client.
259
+ # client = ::Google::Cloud::ServiceControl::V1::QuotaController::Client.new do |config|
260
+ # config.timeout = 10.0
261
+ # config.rpcs.allocate_quota.timeout = 20.0
262
+ # end
268
263
  #
269
264
  # @!attribute [rw] endpoint
270
265
  # The hostname or hostname:port of the service endpoint.
@@ -30,7 +30,7 @@ module Google
30
30
  module ServiceControl
31
31
  module V1
32
32
  ##
33
- # [Google Service Control API](https://cloud.google.com/service-control/overview)
33
+ # [Google Service Control API](/service-control/overview)
34
34
  #
35
35
  # Lets clients check and report operations against a [managed
36
36
  # service](https://cloud.google.com/service-management/reference/rpc/google.api/servicemanagement.v1#google.api.servicemanagement.v1.ManagedService).
@@ -27,7 +27,7 @@ module Google
27
27
  ##
28
28
  # Client for the ServiceController service.
29
29
  #
30
- # [Google Service Control API](https://cloud.google.com/service-control/overview)
30
+ # [Google Service Control API](/service-control/overview)
31
31
  #
32
32
  # Lets clients check and report operations against a [managed
33
33
  # service](https://cloud.google.com/service-management/reference/rpc/google.api/servicemanagement.v1#google.api.servicemanagement.v1.ManagedService).
@@ -42,13 +42,12 @@ module Google
42
42
  # See {::Google::Cloud::ServiceControl::V1::ServiceController::Client::Configuration}
43
43
  # for a description of the configuration fields.
44
44
  #
45
- # ## Example
45
+ # @example
46
46
  #
47
- # To modify the configuration for all ServiceController clients:
48
- #
49
- # ::Google::Cloud::ServiceControl::V1::ServiceController::Client.configure do |config|
50
- # config.timeout = 10.0
51
- # end
47
+ # # Modify the configuration for all ServiceController clients
48
+ # ::Google::Cloud::ServiceControl::V1::ServiceController::Client.configure do |config|
49
+ # config.timeout = 10.0
50
+ # end
52
51
  #
53
52
  # @yield [config] Configure the Client client.
54
53
  # @yieldparam config [Client::Configuration]
@@ -66,6 +65,13 @@ module Google
66
65
  end
67
66
  default_config = Client::Configuration.new parent_config
68
67
 
68
+ default_config.rpcs.check.timeout = 5.0
69
+ default_config.rpcs.check.retry_policy = {
70
+ initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
71
+ }
72
+
73
+ default_config.rpcs.report.timeout = 16.0
74
+
69
75
  default_config
70
76
  end
71
77
  yield @configure if block_given?
@@ -95,19 +101,15 @@ module Google
95
101
  ##
96
102
  # Create a new ServiceController client object.
97
103
  #
98
- # ## Examples
104
+ # @example
99
105
  #
100
- # To create a new ServiceController client with the default
101
- # configuration:
106
+ # # Create a client using the default configuration
107
+ # client = ::Google::Cloud::ServiceControl::V1::ServiceController::Client.new
102
108
  #
103
- # client = ::Google::Cloud::ServiceControl::V1::ServiceController::Client.new
104
- #
105
- # To create a new ServiceController client with a custom
106
- # configuration:
107
- #
108
- # client = ::Google::Cloud::ServiceControl::V1::ServiceController::Client.new do |config|
109
- # config.timeout = 10.0
110
- # end
109
+ # # Create a client using a custom configuration
110
+ # client = ::Google::Cloud::ServiceControl::V1::ServiceController::Client.new do |config|
111
+ # config.timeout = 10.0
112
+ # end
111
113
  #
112
114
  # @yield [config] Configure the ServiceController client.
113
115
  # @yieldparam config [Client::Configuration]
@@ -127,14 +129,13 @@ module Google
127
129
 
128
130
  # Create credentials
129
131
  credentials = @config.credentials
130
- # Use self-signed JWT if the scope and endpoint are unchanged from default,
132
+ # Use self-signed JWT if the endpoint is unchanged from default,
131
133
  # but only if the default endpoint does not have a region prefix.
132
- enable_self_signed_jwt = @config.scope == Client.configure.scope &&
133
- @config.endpoint == Client.configure.endpoint &&
134
+ enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
134
135
  !@config.endpoint.split(".").first.include?("-")
135
136
  credentials ||= Credentials.default scope: @config.scope,
136
137
  enable_self_signed_jwt: enable_self_signed_jwt
137
- if credentials.is_a?(String) || credentials.is_a?(Hash)
138
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
138
139
  credentials = Credentials.new credentials, scope: @config.scope
139
140
  end
140
141
  @quota_project_id = @config.quota_project
@@ -163,7 +164,8 @@ module Google
163
164
  # propagation, therefore callers MUST NOT depend on the `Check` method having
164
165
  # the latest policy information.
165
166
  #
166
- # NOTE: the {::Google::Cloud::ServiceControl::V1::CheckRequest CheckRequest} has the size limit of 64KB.
167
+ # NOTE: the {::Google::Cloud::ServiceControl::V1::CheckRequest CheckRequest} has
168
+ # the size limit (wire-format byte size) of 1MB.
167
169
  #
168
170
  # This method requires the `servicemanagement.services.check` permission
169
171
  # on the specified service. For more information, see
@@ -234,7 +236,9 @@ module Google
234
236
  options.apply_defaults timeout: @config.rpcs.check.timeout,
235
237
  metadata: metadata,
236
238
  retry_policy: @config.rpcs.check.retry_policy
237
- options.apply_defaults metadata: @config.metadata,
239
+
240
+ options.apply_defaults timeout: @config.timeout,
241
+ metadata: @config.metadata,
238
242
  retry_policy: @config.retry_policy
239
243
 
240
244
  @service_controller_stub.call_rpc :check, request, options: options do |response, operation|
@@ -255,8 +259,8 @@ module Google
255
259
  # the aggregation time window to avoid data loss risk more than 0.01%
256
260
  # for business and compliance reasons.
257
261
  #
258
- # NOTE: the {::Google::Cloud::ServiceControl::V1::ReportRequest ReportRequest} has the size limit (wire-format byte size) of
259
- # 1MB.
262
+ # NOTE: the {::Google::Cloud::ServiceControl::V1::ReportRequest ReportRequest} has
263
+ # the size limit (wire-format byte size) of 1MB.
260
264
  #
261
265
  # This method requires the `servicemanagement.services.report` permission
262
266
  # on the specified service. For more information, see
@@ -294,7 +298,8 @@ module Google
294
298
  #
295
299
  # There is no limit on the number of operations in the same ReportRequest,
296
300
  # however the ReportRequest size should be no larger than 1MB. See
297
- # {::Google::Cloud::ServiceControl::V1::ReportResponse#report_errors ReportResponse.report_errors} for partial failure behavior.
301
+ # {::Google::Cloud::ServiceControl::V1::ReportResponse#report_errors ReportResponse.report_errors}
302
+ # for partial failure behavior.
298
303
  # @param service_config_id [::String]
299
304
  # Specifies which version of service config should be used to process the
300
305
  # request.
@@ -336,7 +341,9 @@ module Google
336
341
  options.apply_defaults timeout: @config.rpcs.report.timeout,
337
342
  metadata: metadata,
338
343
  retry_policy: @config.rpcs.report.retry_policy
339
- options.apply_defaults metadata: @config.metadata,
344
+
345
+ options.apply_defaults timeout: @config.timeout,
346
+ metadata: @config.metadata,
340
347
  retry_policy: @config.retry_policy
341
348
 
342
349
  @service_controller_stub.call_rpc :report, request, options: options do |response, operation|
@@ -360,22 +367,21 @@ module Google
360
367
  # Configuration can be applied globally to all clients, or to a single client
361
368
  # on construction.
362
369
  #
363
- # # Examples
364
- #
365
- # To modify the global config, setting the timeout for check
366
- # to 20 seconds, and all remaining timeouts to 10 seconds:
367
- #
368
- # ::Google::Cloud::ServiceControl::V1::ServiceController::Client.configure do |config|
369
- # config.timeout = 10.0
370
- # config.rpcs.check.timeout = 20.0
371
- # end
372
- #
373
- # To apply the above configuration only to a new client:
374
- #
375
- # client = ::Google::Cloud::ServiceControl::V1::ServiceController::Client.new do |config|
376
- # config.timeout = 10.0
377
- # config.rpcs.check.timeout = 20.0
378
- # end
370
+ # @example
371
+ #
372
+ # # Modify the global config, setting the timeout for
373
+ # # check to 20 seconds,
374
+ # # and all remaining timeouts to 10 seconds.
375
+ # ::Google::Cloud::ServiceControl::V1::ServiceController::Client.configure do |config|
376
+ # config.timeout = 10.0
377
+ # config.rpcs.check.timeout = 20.0
378
+ # end
379
+ #
380
+ # # Apply the above configuration only to a new client.
381
+ # client = ::Google::Cloud::ServiceControl::V1::ServiceController::Client.new do |config|
382
+ # config.timeout = 10.0
383
+ # config.rpcs.check.timeout = 20.0
384
+ # end
379
385
  #
380
386
  # @!attribute [rw] endpoint
381
387
  # The hostname or hostname:port of the service endpoint.
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module ServiceControl
23
23
  module V1
24
- VERSION = "0.3.2"
24
+ VERSION = "0.4.3"
25
25
  end
26
26
  end
27
27
  end
@@ -0,0 +1,225 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2021 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Api
22
+ # `Distribution` contains summary statistics for a population of values. It
23
+ # optionally contains a histogram representing the distribution of those values
24
+ # across a set of buckets.
25
+ #
26
+ # The summary statistics are the count, mean, sum of the squared deviation from
27
+ # the mean, the minimum, and the maximum of the set of population of values.
28
+ # The histogram is based on a sequence of buckets and gives a count of values
29
+ # that fall into each bucket. The boundaries of the buckets are given either
30
+ # explicitly or by formulas for buckets of fixed or exponentially increasing
31
+ # widths.
32
+ #
33
+ # Although it is not forbidden, it is generally a bad idea to include
34
+ # non-finite values (infinities or NaNs) in the population of values, as this
35
+ # will render the `mean` and `sum_of_squared_deviation` fields meaningless.
36
+ # @!attribute [rw] count
37
+ # @return [::Integer]
38
+ # The number of values in the population. Must be non-negative. This value
39
+ # must equal the sum of the values in `bucket_counts` if a histogram is
40
+ # provided.
41
+ # @!attribute [rw] mean
42
+ # @return [::Float]
43
+ # The arithmetic mean of the values in the population. If `count` is zero
44
+ # then this field must be zero.
45
+ # @!attribute [rw] sum_of_squared_deviation
46
+ # @return [::Float]
47
+ # The sum of squared deviations from the mean of the values in the
48
+ # population. For values x_i this is:
49
+ #
50
+ # Sum[i=1..n]((x_i - mean)^2)
51
+ #
52
+ # Knuth, "The Art of Computer Programming", Vol. 2, page 232, 3rd edition
53
+ # describes Welford's method for accumulating this sum in one pass.
54
+ #
55
+ # If `count` is zero then this field must be zero.
56
+ # @!attribute [rw] range
57
+ # @return [::Google::Api::Distribution::Range]
58
+ # If specified, contains the range of the population values. The field
59
+ # must not be present if the `count` is zero.
60
+ # @!attribute [rw] bucket_options
61
+ # @return [::Google::Api::Distribution::BucketOptions]
62
+ # Defines the histogram bucket boundaries. If the distribution does not
63
+ # contain a histogram, then omit this field.
64
+ # @!attribute [rw] bucket_counts
65
+ # @return [::Array<::Integer>]
66
+ # The number of values in each bucket of the histogram, as described in
67
+ # `bucket_options`. If the distribution does not have a histogram, then omit
68
+ # this field. If there is a histogram, then the sum of the values in
69
+ # `bucket_counts` must equal the value in the `count` field of the
70
+ # distribution.
71
+ #
72
+ # If present, `bucket_counts` should contain N values, where N is the number
73
+ # of buckets specified in `bucket_options`. If you supply fewer than N
74
+ # values, the remaining values are assumed to be 0.
75
+ #
76
+ # The order of the values in `bucket_counts` follows the bucket numbering
77
+ # schemes described for the three bucket types. The first value must be the
78
+ # count for the underflow bucket (number 0). The next N-2 values are the
79
+ # counts for the finite buckets (number 1 through N-2). The N'th value in
80
+ # `bucket_counts` is the count for the overflow bucket (number N-1).
81
+ # @!attribute [rw] exemplars
82
+ # @return [::Array<::Google::Api::Distribution::Exemplar>]
83
+ # Must be in increasing order of `value` field.
84
+ class Distribution
85
+ include ::Google::Protobuf::MessageExts
86
+ extend ::Google::Protobuf::MessageExts::ClassMethods
87
+
88
+ # The range of the population values.
89
+ # @!attribute [rw] min
90
+ # @return [::Float]
91
+ # The minimum of the population values.
92
+ # @!attribute [rw] max
93
+ # @return [::Float]
94
+ # The maximum of the population values.
95
+ class Range
96
+ include ::Google::Protobuf::MessageExts
97
+ extend ::Google::Protobuf::MessageExts::ClassMethods
98
+ end
99
+
100
+ # `BucketOptions` describes the bucket boundaries used to create a histogram
101
+ # for the distribution. The buckets can be in a linear sequence, an
102
+ # exponential sequence, or each bucket can be specified explicitly.
103
+ # `BucketOptions` does not include the number of values in each bucket.
104
+ #
105
+ # A bucket has an inclusive lower bound and exclusive upper bound for the
106
+ # values that are counted for that bucket. The upper bound of a bucket must
107
+ # be strictly greater than the lower bound. The sequence of N buckets for a
108
+ # distribution consists of an underflow bucket (number 0), zero or more
109
+ # finite buckets (number 1 through N - 2) and an overflow bucket (number N -
110
+ # 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the
111
+ # same as the upper bound of bucket i - 1. The buckets span the whole range
112
+ # of finite values: lower bound of the underflow bucket is -infinity and the
113
+ # upper bound of the overflow bucket is +infinity. The finite buckets are
114
+ # so-called because both bounds are finite.
115
+ # @!attribute [rw] linear_buckets
116
+ # @return [::Google::Api::Distribution::BucketOptions::Linear]
117
+ # The linear bucket.
118
+ # @!attribute [rw] exponential_buckets
119
+ # @return [::Google::Api::Distribution::BucketOptions::Exponential]
120
+ # The exponential buckets.
121
+ # @!attribute [rw] explicit_buckets
122
+ # @return [::Google::Api::Distribution::BucketOptions::Explicit]
123
+ # The explicit buckets.
124
+ class BucketOptions
125
+ include ::Google::Protobuf::MessageExts
126
+ extend ::Google::Protobuf::MessageExts::ClassMethods
127
+
128
+ # Specifies a linear sequence of buckets that all have the same width
129
+ # (except overflow and underflow). Each bucket represents a constant
130
+ # absolute uncertainty on the specific value in the bucket.
131
+ #
132
+ # There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the
133
+ # following boundaries:
134
+ #
135
+ # Upper bound (0 <= i < N-1): offset + (width * i).
136
+ # Lower bound (1 <= i < N): offset + (width * (i - 1)).
137
+ # @!attribute [rw] num_finite_buckets
138
+ # @return [::Integer]
139
+ # Must be greater than 0.
140
+ # @!attribute [rw] width
141
+ # @return [::Float]
142
+ # Must be greater than 0.
143
+ # @!attribute [rw] offset
144
+ # @return [::Float]
145
+ # Lower bound of the first bucket.
146
+ class Linear
147
+ include ::Google::Protobuf::MessageExts
148
+ extend ::Google::Protobuf::MessageExts::ClassMethods
149
+ end
150
+
151
+ # Specifies an exponential sequence of buckets that have a width that is
152
+ # proportional to the value of the lower bound. Each bucket represents a
153
+ # constant relative uncertainty on a specific value in the bucket.
154
+ #
155
+ # There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the
156
+ # following boundaries:
157
+ #
158
+ # Upper bound (0 <= i < N-1): scale * (growth_factor ^ i).
159
+ # Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)).
160
+ # @!attribute [rw] num_finite_buckets
161
+ # @return [::Integer]
162
+ # Must be greater than 0.
163
+ # @!attribute [rw] growth_factor
164
+ # @return [::Float]
165
+ # Must be greater than 1.
166
+ # @!attribute [rw] scale
167
+ # @return [::Float]
168
+ # Must be greater than 0.
169
+ class Exponential
170
+ include ::Google::Protobuf::MessageExts
171
+ extend ::Google::Protobuf::MessageExts::ClassMethods
172
+ end
173
+
174
+ # Specifies a set of buckets with arbitrary widths.
175
+ #
176
+ # There are `size(bounds) + 1` (= N) buckets. Bucket `i` has the following
177
+ # boundaries:
178
+ #
179
+ # Upper bound (0 <= i < N-1): bounds[i]
180
+ # Lower bound (1 <= i < N); bounds[i - 1]
181
+ #
182
+ # The `bounds` field must contain at least one element. If `bounds` has
183
+ # only one element, then there are no finite buckets, and that single
184
+ # element is the common boundary of the overflow and underflow buckets.
185
+ # @!attribute [rw] bounds
186
+ # @return [::Array<::Float>]
187
+ # The values must be monotonically increasing.
188
+ class Explicit
189
+ include ::Google::Protobuf::MessageExts
190
+ extend ::Google::Protobuf::MessageExts::ClassMethods
191
+ end
192
+ end
193
+
194
+ # Exemplars are example points that may be used to annotate aggregated
195
+ # distribution values. They are metadata that gives information about a
196
+ # particular value added to a Distribution bucket, such as a trace ID that
197
+ # was active when a value was added. They may contain further information,
198
+ # such as a example values and timestamps, origin, etc.
199
+ # @!attribute [rw] value
200
+ # @return [::Float]
201
+ # Value of the exemplar point. This value determines to which bucket the
202
+ # exemplar belongs.
203
+ # @!attribute [rw] timestamp
204
+ # @return [::Google::Protobuf::Timestamp]
205
+ # The observation (sampling) time of the above value.
206
+ # @!attribute [rw] attachments
207
+ # @return [::Array<::Google::Protobuf::Any>]
208
+ # Contextual information about the example value. Examples are:
209
+ #
210
+ # Trace: type.googleapis.com/google.monitoring.v3.SpanContext
211
+ #
212
+ # Literal string: type.googleapis.com/google.protobuf.StringValue
213
+ #
214
+ # Labels dropped during aggregation:
215
+ # type.googleapis.com/google.monitoring.v3.DroppedLabels
216
+ #
217
+ # There may be only a single attachment of any given message type in a
218
+ # single exemplar, and this is enforced by the system.
219
+ class Exemplar
220
+ include ::Google::Protobuf::MessageExts
221
+ extend ::Google::Protobuf::MessageExts::ClassMethods
222
+ end
223
+ end
224
+ end
225
+ end
@@ -70,6 +70,9 @@ module Google
70
70
  # @!attribute [rw] explicit_buckets
71
71
  # @return [::Google::Cloud::ServiceControl::V1::Distribution::ExplicitBuckets]
72
72
  # Buckets with arbitrary user-provided width.
73
+ # @!attribute [rw] exemplars
74
+ # @return [::Array<::Google::Api::Distribution::Exemplar>]
75
+ # Example points. Must be in increasing order of `value` field.
73
76
  class Distribution
74
77
  include ::Google::Protobuf::MessageExts
75
78
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -31,7 +31,7 @@ module Google
31
31
  # The time the event described by the log entry occurred. If
32
32
  # omitted, defaults to operation start time.
33
33
  # @!attribute [rw] severity
34
- # @return [::Google::Logging::Type::LogSeverity]
34
+ # @return [::Google::Cloud::Logging::Type::LogSeverity]
35
35
  # The severity of the log entry. The default value is
36
36
  # `LogSeverity.DEFAULT`.
37
37
  # @!attribute [rw] http_request
@@ -33,11 +33,13 @@ module Google
33
33
  # The start of the time period over which this metric value's measurement
34
34
  # applies. The time period has different semantics for different metric
35
35
  # types (cumulative, delta, and gauge). See the metric definition
36
- # documentation in the service configuration for details.
36
+ # documentation in the service configuration for details. If not specified,
37
+ # {::Google::Cloud::ServiceControl::V1::Operation#start_time google.api.servicecontrol.v1.Operation.start_time} will be used.
37
38
  # @!attribute [rw] end_time
38
39
  # @return [::Google::Protobuf::Timestamp]
39
40
  # The end of the time period over which this metric value's measurement
40
- # applies.
41
+ # applies. If not specified,
42
+ # {::Google::Cloud::ServiceControl::V1::Operation#end_time google.api.servicecontrol.v1.Operation.end_time} will be used.
41
43
  # @!attribute [rw] bool_value
42
44
  # @return [::Boolean]
43
45
  # A boolean value.
@@ -56,8 +56,10 @@ module Google
56
56
  # @!attribute [rw] end_time
57
57
  # @return [::Google::Protobuf::Timestamp]
58
58
  # End time of the operation.
59
- # Required when the operation is used in {::Google::Cloud::ServiceControl::V1::ServiceController::Client#report ServiceController.Report},
60
- # but optional when the operation is used in {::Google::Cloud::ServiceControl::V1::ServiceController::Client#check ServiceController.Check}.
59
+ # Required when the operation is used in
60
+ # {::Google::Cloud::ServiceControl::V1::ServiceController::Client#report ServiceController.Report},
61
+ # but optional when the operation is used in
62
+ # {::Google::Cloud::ServiceControl::V1::ServiceController::Client#check ServiceController.Check}.
61
63
  # @!attribute [rw] labels
62
64
  # @return [::Google::Protobuf::Map{::String => ::String}]
63
65
  # Labels describing the operation. Only the following labels are allowed:
@@ -112,13 +114,13 @@ module Google
112
114
 
113
115
  # Defines the importance of the data contained in the operation.
114
116
  module Importance
115
- # The API implementation may cache and aggregate the data.
116
- # The data may be lost when rare and unexpected system failures occur.
117
+ # Allows data caching, batching, and aggregation. It provides
118
+ # higher performance with higher data loss risk.
117
119
  LOW = 0
118
120
 
119
- # The API implementation doesn't cache and aggregate the data.
120
- # If the method returns successfully, it's guaranteed that the data has
121
- # been persisted in durable storage.
121
+ # Disables data aggregation to minimize data loss. It is for operations
122
+ # that contains significant monetary value or audit trail. This feature
123
+ # only applies to the client libraries.
122
124
  HIGH = 1
123
125
  end
124
126
  end
@@ -63,6 +63,7 @@ module Google
63
63
  # (1) the quota operation is performed on non-API resources.
64
64
  # (2) quota_metrics is set because the caller is doing quota override.
65
65
  #
66
+ #
66
67
  # Example of an RPC method name:
67
68
  # google.example.library.v1.LibraryService.CreateShelf
68
69
  # @!attribute [rw] consumer_id
@@ -137,14 +138,14 @@ module Google
137
138
  # Unimplemented. When used in AllocateQuotaRequest, this returns the
138
139
  # effective quota limit(s) in the response, and no quota check will be
139
140
  # performed. Not supported for other requests, and even for
140
- # AllocateQuotaRequest, this is currently supported only for whitelisted
141
+ # AllocateQuotaRequest, this is currently supported only for allowlisted
141
142
  # services.
142
143
  QUERY_ONLY = 4
143
144
 
144
145
  # The operation allocates quota for the amount specified in the service
145
146
  # configuration or specified using the quota metrics. If the requested
146
147
  # amount is higher than the available quota, request does not fail and
147
- # remaining quota would become negative (going over the limit)
148
+ # remaining quota would become negative (going over the limit).
148
149
  # Not supported for Rate Quota.
149
150
  ADJUST_ONLY = 5
150
151
  end
@@ -190,6 +191,10 @@ module Google
190
191
  # @!attribute [rw] description
191
192
  # @return [::String]
192
193
  # Free-form text that provides details on the cause of the error.
194
+ # @!attribute [rw] status
195
+ # @return [::Google::Rpc::Status]
196
+ # Contains additional information about the quota error.
197
+ # If available, `status.code` will be non zero.
193
198
  class QuotaError
194
199
  include ::Google::Protobuf::MessageExts
195
200
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -48,8 +48,9 @@ module Google
48
48
  # Response message for the Check method.
49
49
  # @!attribute [rw] operation_id
50
50
  # @return [::String]
51
- # The same operation_id value used in the {::Google::Cloud::ServiceControl::V1::CheckRequest CheckRequest}.
52
- # Used for logging and diagnostics purposes.
51
+ # The same operation_id value used in the
52
+ # {::Google::Cloud::ServiceControl::V1::CheckRequest CheckRequest}. Used for logging
53
+ # and diagnostics purposes.
53
54
  # @!attribute [rw] check_errors
54
55
  # @return [::Array<::Google::Cloud::ServiceControl::V1::CheckError>]
55
56
  # Indicate the decision of the check.
@@ -148,7 +149,8 @@ module Google
148
149
  #
149
150
  # There is no limit on the number of operations in the same ReportRequest,
150
151
  # however the ReportRequest size should be no larger than 1MB. See
151
- # {::Google::Cloud::ServiceControl::V1::ReportResponse#report_errors ReportResponse.report_errors} for partial failure behavior.
152
+ # {::Google::Cloud::ServiceControl::V1::ReportResponse#report_errors ReportResponse.report_errors}
153
+ # for partial failure behavior.
152
154
  # @!attribute [rw] service_config_id
153
155
  # @return [::String]
154
156
  # Specifies which version of service config should be used to process the
@@ -188,13 +190,17 @@ module Google
188
190
  include ::Google::Protobuf::MessageExts
189
191
  extend ::Google::Protobuf::MessageExts::ClassMethods
190
192
 
191
- # Represents the processing error of one {::Google::Cloud::ServiceControl::V1::Operation Operation} in the request.
193
+ # Represents the processing error of one
194
+ # {::Google::Cloud::ServiceControl::V1::Operation Operation} in the request.
192
195
  # @!attribute [rw] operation_id
193
196
  # @return [::String]
194
- # The {::Google::Cloud::ServiceControl::V1::Operation#operation_id Operation.operation_id} value from the request.
197
+ # The
198
+ # {::Google::Cloud::ServiceControl::V1::Operation#operation_id Operation.operation_id}
199
+ # value from the request.
195
200
  # @!attribute [rw] status
196
201
  # @return [::Google::Rpc::Status]
197
- # Details of the error when processing the {::Google::Cloud::ServiceControl::V1::Operation Operation}.
202
+ # Details of the error when processing the
203
+ # {::Google::Cloud::ServiceControl::V1::Operation Operation}.
198
204
  class ReportError
199
205
  include ::Google::Protobuf::MessageExts
200
206
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -18,51 +18,53 @@
18
18
 
19
19
 
20
20
  module Google
21
- module Logging
22
- module Type
23
- # The severity of the event described in a log entry, expressed as one of the
24
- # standard severity levels listed below. For your reference, the levels are
25
- # assigned the listed numeric values. The effect of using numeric values other
26
- # than those listed is undefined.
27
- #
28
- # You can filter for log entries by severity. For example, the following
29
- # filter expression will match log entries with severities `INFO`, `NOTICE`,
30
- # and `WARNING`:
31
- #
32
- # severity > DEBUG AND severity <= WARNING
33
- #
34
- # If you are writing log entries, you should map other severity encodings to
35
- # one of these standard levels. For example, you might map all of Java's FINE,
36
- # FINER, and FINEST levels to `LogSeverity.DEBUG`. You can preserve the
37
- # original severity level in the log entry payload if you wish.
38
- module LogSeverity
39
- # (0) The log entry has no assigned severity level.
40
- DEFAULT = 0
21
+ module Cloud
22
+ module Logging
23
+ module Type
24
+ # The severity of the event described in a log entry, expressed as one of the
25
+ # standard severity levels listed below. For your reference, the levels are
26
+ # assigned the listed numeric values. The effect of using numeric values other
27
+ # than those listed is undefined.
28
+ #
29
+ # You can filter for log entries by severity. For example, the following
30
+ # filter expression will match log entries with severities `INFO`, `NOTICE`,
31
+ # and `WARNING`:
32
+ #
33
+ # severity > DEBUG AND severity <= WARNING
34
+ #
35
+ # If you are writing log entries, you should map other severity encodings to
36
+ # one of these standard levels. For example, you might map all of Java's FINE,
37
+ # FINER, and FINEST levels to `LogSeverity.DEBUG`. You can preserve the
38
+ # original severity level in the log entry payload if you wish.
39
+ module LogSeverity
40
+ # (0) The log entry has no assigned severity level.
41
+ DEFAULT = 0
41
42
 
42
- # (100) Debug or trace information.
43
- DEBUG = 100
43
+ # (100) Debug or trace information.
44
+ DEBUG = 100
44
45
 
45
- # (200) Routine information, such as ongoing status or performance.
46
- INFO = 200
46
+ # (200) Routine information, such as ongoing status or performance.
47
+ INFO = 200
47
48
 
48
- # (300) Normal but significant events, such as start up, shut down, or
49
- # a configuration change.
50
- NOTICE = 300
49
+ # (300) Normal but significant events, such as start up, shut down, or
50
+ # a configuration change.
51
+ NOTICE = 300
51
52
 
52
- # (400) Warning events might cause problems.
53
- WARNING = 400
53
+ # (400) Warning events might cause problems.
54
+ WARNING = 400
54
55
 
55
- # (500) Error events are likely to cause problems.
56
- ERROR = 500
56
+ # (500) Error events are likely to cause problems.
57
+ ERROR = 500
57
58
 
58
- # (600) Critical events cause more severe problems or outages.
59
- CRITICAL = 600
59
+ # (600) Critical events cause more severe problems or outages.
60
+ CRITICAL = 600
60
61
 
61
- # (700) A person must take an action immediately.
62
- ALERT = 700
62
+ # (700) A person must take an action immediately.
63
+ ALERT = 700
63
64
 
64
- # (800) One or more systems are unusable.
65
- EMERGENCY = 800
65
+ # (800) One or more systems are unusable.
66
+ EMERGENCY = 800
67
+ end
66
68
  end
67
69
  end
68
70
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-service_control-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.2
4
+ version: 0.4.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-06-17 00:00:00.000000000 Z
11
+ date: 2021-08-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: '0.5'
19
+ version: '0.7'
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: '0.5'
29
+ version: '0.7'
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -190,6 +190,7 @@ files:
190
190
  - lib/google/cloud/service_control/v1/service_controller/credentials.rb
191
191
  - lib/google/cloud/service_control/v1/version.rb
192
192
  - proto_docs/README.md
193
+ - proto_docs/google/api/distribution.rb
193
194
  - proto_docs/google/api/resource.rb
194
195
  - proto_docs/google/api/servicecontrol/v1/check_error.rb
195
196
  - proto_docs/google/api/servicecontrol/v1/distribution.rb