google-cloud-service_management-v1 0.3.0 → 0.3.4

Sign up to get free protection for your applications and to get access to all the features.
@@ -25,49 +25,68 @@ module Google
25
25
  # for monitoring. In the example, a monitored resource and two metrics are
26
26
  # defined. The `library.googleapis.com/book/returned_count` metric is sent
27
27
  # to both producer and consumer projects, whereas the
28
- # `library.googleapis.com/book/overdue_count` metric is only sent to the
28
+ # `library.googleapis.com/book/num_overdue` metric is only sent to the
29
29
  # consumer project.
30
30
  #
31
31
  # monitored_resources:
32
- # - type: library.googleapis.com/branch
32
+ # - type: library.googleapis.com/Branch
33
+ # display_name: "Library Branch"
34
+ # description: "A branch of a library."
35
+ # launch_stage: GA
33
36
  # labels:
34
- # - key: /city
35
- # description: The city where the library branch is located in.
36
- # - key: /name
37
- # description: The name of the branch.
37
+ # - key: resource_container
38
+ # description: "The Cloud container (ie. project id) for the Branch."
39
+ # - key: location
40
+ # description: "The location of the library branch."
41
+ # - key: branch_id
42
+ # description: "The id of the branch."
38
43
  # metrics:
39
44
  # - name: library.googleapis.com/book/returned_count
45
+ # display_name: "Books Returned"
46
+ # description: "The count of books that have been returned."
47
+ # launch_stage: GA
40
48
  # metric_kind: DELTA
41
49
  # value_type: INT64
50
+ # unit: "1"
42
51
  # labels:
43
- # - key: /customer_id
44
- # - name: library.googleapis.com/book/overdue_count
52
+ # - key: customer_id
53
+ # description: "The id of the customer."
54
+ # - name: library.googleapis.com/book/num_overdue
55
+ # display_name: "Books Overdue"
56
+ # description: "The current number of overdue books."
57
+ # launch_stage: GA
45
58
  # metric_kind: GAUGE
46
59
  # value_type: INT64
60
+ # unit: "1"
47
61
  # labels:
48
- # - key: /customer_id
62
+ # - key: customer_id
63
+ # description: "The id of the customer."
49
64
  # monitoring:
50
65
  # producer_destinations:
51
- # - monitored_resource: library.googleapis.com/branch
66
+ # - monitored_resource: library.googleapis.com/Branch
52
67
  # metrics:
53
68
  # - library.googleapis.com/book/returned_count
54
69
  # consumer_destinations:
55
- # - monitored_resource: library.googleapis.com/branch
70
+ # - monitored_resource: library.googleapis.com/Branch
56
71
  # metrics:
57
72
  # - library.googleapis.com/book/returned_count
58
- # - library.googleapis.com/book/overdue_count
73
+ # - library.googleapis.com/book/num_overdue
59
74
  # @!attribute [rw] producer_destinations
60
75
  # @return [::Array<::Google::Api::Monitoring::MonitoringDestination>]
61
76
  # Monitoring configurations for sending metrics to the producer project.
62
- # There can be multiple producer destinations, each one must have a
63
- # different monitored resource type. A metric can be used in at most
64
- # one producer destination.
77
+ # There can be multiple producer destinations. A monitored resource type may
78
+ # appear in multiple monitoring destinations if different aggregations are
79
+ # needed for different sets of metrics associated with that monitored
80
+ # resource type. A monitored resource and metric pair may only be used once
81
+ # in the Monitoring configuration.
65
82
  # @!attribute [rw] consumer_destinations
66
83
  # @return [::Array<::Google::Api::Monitoring::MonitoringDestination>]
67
84
  # Monitoring configurations for sending metrics to the consumer project.
68
- # There can be multiple consumer destinations, each one must have a
69
- # different monitored resource type. A metric can be used in at most
70
- # one consumer destination.
85
+ # There can be multiple consumer destinations. A monitored resource type may
86
+ # appear in multiple monitoring destinations if different aggregations are
87
+ # needed for different sets of metrics associated with that monitored
88
+ # resource type. A monitored resource and metric pair may only be used once
89
+ # in the Monitoring configuration.
71
90
  class Monitoring
72
91
  include ::Google::Protobuf::MessageExts
73
92
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -80,8 +99,8 @@ module Google
80
99
  # {::Google::Api::Service#monitored_resources Service.monitored_resources} section.
81
100
  # @!attribute [rw] metrics
82
101
  # @return [::Array<::String>]
83
- # Names of the metrics to report to this monitoring destination.
84
- # Each name must be defined in {::Google::Api::Service#metrics Service.metrics} section.
102
+ # Types of the metrics to report to this monitoring destination.
103
+ # Each type must be defined in {::Google::Api::Service#metrics Service.metrics} section.
85
104
  class MonitoringDestination
86
105
  include ::Google::Protobuf::MessageExts
87
106
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -22,7 +22,7 @@ module Google
22
22
  # Quota configuration helps to achieve fairness and budgeting in service
23
23
  # usage.
24
24
  #
25
- # The quota configuration works this way:
25
+ # The metric based quota configuration works this way:
26
26
  # - The service configuration defines a set of metrics.
27
27
  # - For API calls, the quota.metric_rules maps methods to metrics with
28
28
  # corresponding costs.
@@ -40,6 +40,7 @@ module Google
40
40
  # values:
41
41
  # STANDARD: 10000
42
42
  #
43
+ #
43
44
  # # The metric rules bind all methods to the read_calls metric,
44
45
  # # except for the UpdateBook and DeleteBook methods. These two methods
45
46
  # # are mapped to the write_calls metric, with the UpdateBook method
@@ -70,24 +71,17 @@ module Google
70
71
  # @!attribute [rw] limits
71
72
  # @return [::Array<::Google::Api::QuotaLimit>]
72
73
  # List of `QuotaLimit` definitions for the service.
73
- #
74
- # Used by metric-based quotas only.
75
74
  # @!attribute [rw] metric_rules
76
75
  # @return [::Array<::Google::Api::MetricRule>]
77
76
  # List of `MetricRule` definitions, each one mapping a selected method to one
78
77
  # or more metrics.
79
- #
80
- # Used by metric-based quotas only.
81
78
  class Quota
82
79
  include ::Google::Protobuf::MessageExts
83
80
  extend ::Google::Protobuf::MessageExts::ClassMethods
84
81
  end
85
82
 
86
83
  # Bind API methods to metrics. Binding a method to a metric causes that
87
- # metric's configured quota, billing, and monitoring behaviors to apply to the
88
- # method call.
89
- #
90
- # Used by metric-based quotas only.
84
+ # metric's configured quota behaviors to apply to the method call.
91
85
  # @!attribute [rw] selector
92
86
  # @return [::String]
93
87
  # Selects the methods to which this rule applies.
@@ -120,24 +114,12 @@ module Google
120
114
  # type combination defined within a `QuotaGroup`.
121
115
  # @!attribute [rw] name
122
116
  # @return [::String]
123
- # Name of the quota limit. The name is used to refer to the limit when
124
- # overriding the default limit on per-consumer basis.
117
+ # Name of the quota limit.
125
118
  #
126
- # For group-based quota limits, the name must be unique within the quota
127
- # group. If a name is not provided, it will be generated from the limit_by
128
- # and duration fields.
129
- #
130
- # For metric-based quota limits, the name must be provided, and it must be
131
- # unique within the service. The name can only include alphanumeric
132
- # characters as well as '-'.
119
+ # The name must be provided, and it must be unique within the service. The
120
+ # name can only include alphanumeric characters as well as '-'.
133
121
  #
134
122
  # The maximum length of the limit name is 64 characters.
135
- #
136
- # The name of a limit is used as a unique identifier for this limit.
137
- # Therefore, once a limit has been put into use, its name should be
138
- # immutable. You can use the display_name field to provide a user-friendly
139
- # name for the limit. The display name can be evolved over time without
140
- # affecting the identity of the limit.
141
123
  # @!attribute [rw] description
142
124
  # @return [::String]
143
125
  # Optional. User-visible, extended description for this quota limit.
@@ -178,10 +160,7 @@ module Google
178
160
  # Used by group-based quotas only.
179
161
  # @!attribute [rw] duration
180
162
  # @return [::String]
181
- # Duration of this limit in textual notation. Example: "100s", "24h", "1d".
182
- # For duration longer than a day, only multiple of days is supported. We
183
- # support only "100s" and "1d" for now. Additional support will be added in
184
- # the future. "0" indicates indefinite duration.
163
+ # Duration of this limit in textual notation. Must be "100s" or "1d".
185
164
  #
186
165
  # Used by group-based quotas only.
187
166
  # @!attribute [rw] metric
@@ -189,75 +168,22 @@ module Google
189
168
  # The name of the metric this quota limit applies to. The quota limits with
190
169
  # the same metric will be checked together during runtime. The metric must be
191
170
  # defined within the service config.
192
- #
193
- # Used by metric-based quotas only.
194
171
  # @!attribute [rw] unit
195
172
  # @return [::String]
196
173
  # Specify the unit of the quota limit. It uses the same syntax as
197
174
  # [Metric.unit][]. The supported unit kinds are determined by the quota
198
175
  # backend system.
199
176
  #
200
- # The [Google Service Control](https://cloud.google.com/service-control)
201
- # supports the following unit components:
202
- # * One of the time intevals:
203
- # * "/min" for quota every minute.
204
- # * "/d" for quota every 24 hours, starting 00:00 US Pacific Time.
205
- # * Otherwise the quota won't be reset by time, such as storage limit.
206
- # * One and only one of the granted containers:
207
- # * "/\\{organization}" quota for an organization.
208
- # * "/\\{project}" quota for a project.
209
- # * "/\\{folder}" quota for a folder.
210
- # * "/\\{resource}" quota for a universal resource.
211
- # * Zero or more quota segmentation dimension. Not all combos are valid.
212
- # * "/\\{region}" quota for every region. Not to be used with time intervals.
213
- # * Otherwise the resources granted on the target is not segmented.
214
- # * "/\\{zone}" quota for every zone. Not to be used with time intervals.
215
- # * Otherwise the resources granted on the target is not segmented.
216
- # * "/\\{resource}" quota for a resource associated with a project or org.
217
- #
218
177
  # Here are some examples:
219
178
  # * "1/min/\\{project}" for quota per minute per project.
220
- # * "1/min/\\{user}" for quota per minute per user.
221
- # * "1/min/\\{organization}" for quota per minute per organization.
222
179
  #
223
180
  # Note: the order of unit components is insignificant.
224
181
  # The "1" at the beginning is required to follow the metric unit syntax.
225
- #
226
- # Used by metric-based quotas only.
227
182
  # @!attribute [rw] values
228
183
  # @return [::Google::Protobuf::Map{::String => ::Integer}]
229
- # Tiered limit values. Also allows for regional or zone overrides for these
230
- # values if "/\\{region}" or "/\\{zone}" is specified in the unit field.
231
- #
232
- # Currently supported tiers from low to high:
233
- # VERY_LOW, LOW, STANDARD, HIGH, VERY_HIGH
234
- #
235
- # To apply different limit values for users according to their tiers, specify
236
- # the values for the tiers you want to differentiate. For example:
237
- # \\{LOW:100, STANDARD:500, HIGH:1000, VERY_HIGH:5000}
238
- #
239
- # The limit value for each tier is optional except for the tier STANDARD.
240
- # The limit value for an unspecified tier falls to the value of its next
241
- # tier towards tier STANDARD. For the above example, the limit value for tier
242
- # STANDARD is 500.
243
- #
244
- # To apply the same limit value for all users, just specify limit value for
245
- # tier STANDARD. For example: \\{STANDARD:500}.
246
- #
247
- # To apply a regional overide for a tier, add a map entry with key
248
- # "<TIER>/<region>", where <region> is a region name. Similarly, for a zone
249
- # override, add a map entry with key "<TIER>/\\{zone}".
250
- # Further, a wildcard can be used at the end of a zone name in order to
251
- # specify zone level overrides. For example:
252
- # LOW: 10, STANDARD: 50, HIGH: 100,
253
- # LOW/us-central1: 20, STANDARD/us-central1: 60, HIGH/us-central1: 200,
254
- # LOW/us-central1-*: 10, STANDARD/us-central1-*: 20, HIGH/us-central1-*: 80
255
- #
256
- # The regional overrides tier set for each region must be the same as
257
- # the tier set for default limit values. Same rule applies for zone overrides
258
- # tier as well.
259
- #
260
- # Used by metric-based quotas only.
184
+ # Tiered limit values. You must specify this as a key:value pair, with an
185
+ # integer value that is the maximum number of requests allowed for the
186
+ # specified unit. Currently only STANDARD is supported.
261
187
  # @!attribute [rw] display_name
262
188
  # @return [::String]
263
189
  # User-visible display name for this limit.
@@ -28,7 +28,6 @@ module Google
28
28
  # Example:
29
29
  #
30
30
  # type: google.api.Service
31
- # config_version: 3
32
31
  # name: calendar.googleapis.com
33
32
  # title: Google Calendar API
34
33
  # apis:
@@ -42,27 +41,24 @@ module Google
42
41
  # - selector: "*"
43
42
  # requirements:
44
43
  # provider_id: google_calendar_auth
45
- # @!attribute [rw] config_version
46
- # @return [::Google::Protobuf::UInt32Value]
47
- # The semantic version of the service configuration. The config version
48
- # affects the interpretation of the service configuration. For example,
49
- # certain features are enabled by default for certain config versions.
50
- # The latest config version is `3`.
51
44
  # @!attribute [rw] name
52
45
  # @return [::String]
53
- # The DNS address at which this service is available,
54
- # e.g. `calendar.googleapis.com`.
55
- # @!attribute [rw] id
56
- # @return [::String]
57
- # A unique ID for a specific instance of this message, typically assigned
58
- # by the client for tracking purpose. If empty, the server may choose to
59
- # generate one instead.
46
+ # The service name, which is a DNS-like logical identifier for the
47
+ # service, such as `calendar.googleapis.com`. The service name
48
+ # typically goes through DNS verification to make sure the owner
49
+ # of the service also owns the DNS name.
60
50
  # @!attribute [rw] title
61
51
  # @return [::String]
62
52
  # The product title for this service.
63
53
  # @!attribute [rw] producer_project_id
64
54
  # @return [::String]
65
55
  # The Google project that owns this service.
56
+ # @!attribute [rw] id
57
+ # @return [::String]
58
+ # A unique ID for a specific instance of this message, typically assigned
59
+ # by the client for tracking purpose. Must be no longer than 63 characters
60
+ # and only lower case letters, digits, '.', '_' and '-' are allowed. If
61
+ # empty, the server may choose to generate one instead.
66
62
  # @!attribute [rw] apis
67
63
  # @return [::Array<::Google::Protobuf::Api>]
68
64
  # A list of API interfaces exported by this service. Only the `name` field
@@ -143,6 +139,12 @@ module Google
143
139
  # @!attribute [rw] source_info
144
140
  # @return [::Google::Api::SourceInfo]
145
141
  # Output only. The source information for this configuration if available.
142
+ # @!attribute [rw] config_version
143
+ # @return [::Google::Protobuf::UInt32Value]
144
+ # Obsolete. Do not use.
145
+ #
146
+ # This field has no semantic meaning. The service config compiler always
147
+ # sets this field to `3`.
146
148
  class Service
147
149
  include ::Google::Protobuf::MessageExts
148
150
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -25,7 +25,7 @@ module Google
25
25
  # Google Service Management.
26
26
  # @!attribute [rw] service_name
27
27
  # @return [::String]
28
- # The name of the service. See the [overview](/service-management/overview)
28
+ # The name of the service. See the [overview](https://cloud.google.com/service-management/overview)
29
29
  # for naming requirements.
30
30
  # @!attribute [rw] producer_project_id
31
31
  # @return [::String]
@@ -79,7 +79,7 @@ module Google
79
79
  # Request message for DeleteService method.
80
80
  # @!attribute [rw] service_name
81
81
  # @return [::String]
82
- # Required. The name of the service. See the [overview](/service-management/overview)
82
+ # Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview)
83
83
  # for naming requirements. For example: `example.googleapis.com`.
84
84
  class DeleteServiceRequest
85
85
  include ::Google::Protobuf::MessageExts
@@ -89,7 +89,7 @@ module Google
89
89
  # Request message for UndeleteService method.
90
90
  # @!attribute [rw] service_name
91
91
  # @return [::String]
92
- # Required. The name of the service. See the [overview](/service-management/overview)
92
+ # Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview)
93
93
  # for naming requirements. For example: `example.googleapis.com`.
94
94
  class UndeleteServiceRequest
95
95
  include ::Google::Protobuf::MessageExts
@@ -108,7 +108,7 @@ module Google
108
108
  # Request message for GetServiceConfig method.
109
109
  # @!attribute [rw] service_name
110
110
  # @return [::String]
111
- # Required. The name of the service. See the [overview](/service-management/overview)
111
+ # Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview)
112
112
  # for naming requirements. For example: `example.googleapis.com`.
113
113
  # @!attribute [rw] config_id
114
114
  # @return [::String]
@@ -139,7 +139,7 @@ module Google
139
139
  # Request message for ListServiceConfigs method.
140
140
  # @!attribute [rw] service_name
141
141
  # @return [::String]
142
- # Required. The name of the service. See the [overview](/service-management/overview)
142
+ # Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview)
143
143
  # for naming requirements. For example: `example.googleapis.com`.
144
144
  # @!attribute [rw] page_token
145
145
  # @return [::String]
@@ -168,7 +168,7 @@ module Google
168
168
  # Request message for CreateServiceConfig method.
169
169
  # @!attribute [rw] service_name
170
170
  # @return [::String]
171
- # Required. The name of the service. See the [overview](/service-management/overview)
171
+ # Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview)
172
172
  # for naming requirements. For example: `example.googleapis.com`.
173
173
  # @!attribute [rw] service_config
174
174
  # @return [::Google::Api::Service]
@@ -181,7 +181,7 @@ module Google
181
181
  # Request message for SubmitConfigSource method.
182
182
  # @!attribute [rw] service_name
183
183
  # @return [::String]
184
- # Required. The name of the service. See the [overview](/service-management/overview)
184
+ # Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview)
185
185
  # for naming requirements. For example: `example.googleapis.com`.
186
186
  # @!attribute [rw] config_source
187
187
  # @return [::Google::Cloud::ServiceManagement::V1::ConfigSource]
@@ -208,7 +208,7 @@ module Google
208
208
  # Request message for 'CreateServiceRollout'
209
209
  # @!attribute [rw] service_name
210
210
  # @return [::String]
211
- # Required. The name of the service. See the [overview](/service-management/overview)
211
+ # Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview)
212
212
  # for naming requirements. For example: `example.googleapis.com`.
213
213
  # @!attribute [rw] rollout
214
214
  # @return [::Google::Cloud::ServiceManagement::V1::Rollout]
@@ -221,7 +221,7 @@ module Google
221
221
  # Request message for 'ListServiceRollouts'
222
222
  # @!attribute [rw] service_name
223
223
  # @return [::String]
224
- # Required. The name of the service. See the [overview](/service-management/overview)
224
+ # Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview)
225
225
  # for naming requirements. For example: `example.googleapis.com`.
226
226
  # @!attribute [rw] page_token
227
227
  # @return [::String]
@@ -235,10 +235,10 @@ module Google
235
235
  # Required. Use `filter` to return subset of rollouts.
236
236
  # The following filters are supported:
237
237
  # -- To limit the results to only those in
238
- # [status](google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS',
238
+ # status (google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS',
239
239
  # use filter='status=SUCCESS'
240
240
  # -- To limit the results to those in
241
- # [status](google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED'
241
+ # status (google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED'
242
242
  # or 'FAILED', use filter='status=CANCELLED OR status=FAILED'
243
243
  class ListServiceRolloutsRequest
244
244
  include ::Google::Protobuf::MessageExts
@@ -260,7 +260,7 @@ module Google
260
260
  # Request message for GetServiceRollout method.
261
261
  # @!attribute [rw] service_name
262
262
  # @return [::String]
263
- # Required. The name of the service. See the [overview](/service-management/overview)
263
+ # Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview)
264
264
  # for naming requirements. For example: `example.googleapis.com`.
265
265
  # @!attribute [rw] rollout_id
266
266
  # @return [::String]
@@ -25,6 +25,12 @@ module Google
25
25
  # Requirements that must be satisfied before a consumer project can use the
26
26
  # service. Each requirement is of the form <service.name>/<requirement-id>;
27
27
  # for example 'serviceusage.googleapis.com/billing-enabled'.
28
+ #
29
+ # For Google APIs, a Terms of Service requirement must be included here.
30
+ # Google Cloud APIs must include "serviceusage.googleapis.com/tos/cloud".
31
+ # Other Google APIs should include
32
+ # "serviceusage.googleapis.com/tos/universal". Additional ToS can be
33
+ # included based on the business needs.
28
34
  # @!attribute [rw] rules
29
35
  # @return [::Array<::Google::Api::UsageRule>]
30
36
  # A list of usage rules that apply to individual API methods.
metadata CHANGED
@@ -1,29 +1,35 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-service_management-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.0
4
+ version: 0.3.4
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-03-09 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
15
15
  requirement: !ruby/object:Gem::Requirement
16
16
  requirements:
17
- - - "~>"
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0.7'
20
+ - - "<"
18
21
  - !ruby/object:Gem::Version
19
- version: '0.3'
22
+ version: 2.a
20
23
  type: :runtime
21
24
  prerelease: false
22
25
  version_requirements: !ruby/object:Gem::Requirement
23
26
  requirements:
24
- - - "~>"
27
+ - - ">="
28
+ - !ruby/object:Gem::Version
29
+ version: '0.7'
30
+ - - "<"
25
31
  - !ruby/object:Gem::Version
26
- version: '0.3'
32
+ version: 2.a
27
33
  - !ruby/object:Gem::Dependency
28
34
  name: google-cloud-errors
29
35
  requirement: !ruby/object:Gem::Requirement
@@ -185,6 +191,7 @@ files:
185
191
  - proto_docs/google/api/endpoint.rb
186
192
  - proto_docs/google/api/field_behavior.rb
187
193
  - proto_docs/google/api/label.rb
194
+ - proto_docs/google/api/launch_stage.rb
188
195
  - proto_docs/google/api/log.rb
189
196
  - proto_docs/google/api/logging.rb
190
197
  - proto_docs/google/api/metric.rb
@@ -229,7 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
229
236
  - !ruby/object:Gem::Version
230
237
  version: '0'
231
238
  requirements: []
232
- rubygems_version: 3.2.13
239
+ rubygems_version: 3.2.17
233
240
  signing_key:
234
241
  specification_version: 4
235
242
  summary: API Client library for the Service Management API V1 API