google-analytics-data-v1beta 0.5.0 → 0.7.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -122,8 +122,8 @@ module Google
122
122
  # for examples. Metrics cannot be used in this filter.
123
123
  # @!attribute [rw] metric_filter
124
124
  # @return [::Google::Analytics::Data::V1beta::FilterExpression]
125
- # The filter clause of metrics. Applied at post aggregation phase, similar to
126
- # SQL having-clause. Dimensions cannot be used in this filter.
125
+ # The filter clause of metrics. Applied after aggregating the report's rows,
126
+ # similar to SQL having-clause. Dimensions cannot be used in this filter.
127
127
  # @!attribute [rw] offset
128
128
  # @return [::Integer]
129
129
  # The row count of the start row. The first row is counted as row 0.
@@ -467,13 +467,11 @@ module Google
467
467
  # The metrics requested and displayed.
468
468
  # @!attribute [rw] dimension_filter
469
469
  # @return [::Google::Analytics::Data::V1beta::FilterExpression]
470
- # The filter clause of dimensions. Dimensions must be requested to be used in
471
- # this filter. Metrics cannot be used in this filter.
470
+ # The filter clause of dimensions. Metrics cannot be used in this filter.
472
471
  # @!attribute [rw] metric_filter
473
472
  # @return [::Google::Analytics::Data::V1beta::FilterExpression]
474
473
  # The filter clause of metrics. Applied at post aggregation phase, similar to
475
- # SQL having-clause. Metrics must be requested to be used in this filter.
476
- # Dimensions cannot be used in this filter.
474
+ # SQL having-clause. Dimensions cannot be used in this filter.
477
475
  # @!attribute [rw] limit
478
476
  # @return [::Integer]
479
477
  # The number of rows to return. If unspecified, 10,000 rows are returned. The
@@ -56,8 +56,8 @@ module Google
56
56
  #
57
57
  # If unspecified, `startMinutesAgo` is defaulted to 29. Standard Analytics
58
58
  # properties can request up to the last 30 minutes of event data
59
- # (`startMinutesAgo <= 29`), and Google Analytics 360 properties can request
60
- # up to the last 60 minutes of event data (`startMinutesAgo <= 59`).
59
+ # (`startMinutesAgo <= 29`), and 360 Analytics properties can request up to
60
+ # the last 60 minutes of event data (`startMinutesAgo <= 59`).
61
61
  # @!attribute [rw] end_minutes_ago
62
62
  # @return [::Integer]
63
63
  # The inclusive end minute for the query as a number of minutes before now.
@@ -67,8 +67,8 @@ module Google
67
67
  #
68
68
  # If unspecified, `endMinutesAgo` is defaulted to 0. Standard Analytics
69
69
  # properties can request any minute in the last 30 minutes of event data
70
- # (`endMinutesAgo <= 29`), and Google Analytics 360 properties can request
71
- # any minute in the last 60 minutes of event data (`endMinutesAgo <= 59`).
70
+ # (`endMinutesAgo <= 29`), and 360 Analytics properties can request any
71
+ # minute in the last 60 minutes of event data (`endMinutesAgo <= 59`).
72
72
  # @!attribute [rw] name
73
73
  # @return [::String]
74
74
  # Assigns a name to this minute range. The dimension `dateRange` is valued to
@@ -82,7 +82,7 @@ module Google
82
82
 
83
83
  # Dimensions are attributes of your data. For example, the dimension city
84
84
  # indicates the city from which an event originates. Dimension values in report
85
- # responses are strings; for example, city could be "Paris" or "New York".
85
+ # responses are strings; for example, the city could be "Paris" or "New York".
86
86
  # Requests are allowed up to 9 dimensions.
87
87
  # @!attribute [rw] name
88
88
  # @return [::String]
@@ -186,9 +186,8 @@ module Google
186
186
  extend ::Google::Protobuf::MessageExts::ClassMethods
187
187
  end
188
188
 
189
- # To express dimension or metric filters.
190
- # The fields in the same FilterExpression need to be either all dimensions or
191
- # all metrics.
189
+ # To express dimension or metric filters. The fields in the same
190
+ # FilterExpression need to be either all dimensions or all metrics.
192
191
  # @!attribute [rw] and_group
193
192
  # @return [::Google::Analytics::Data::V1beta::FilterExpressionList]
194
193
  # The FilterExpressions in and_group have an AND relationship.
@@ -200,9 +199,8 @@ module Google
200
199
  # The FilterExpression is NOT of not_expression.
201
200
  # @!attribute [rw] filter
202
201
  # @return [::Google::Analytics::Data::V1beta::Filter]
203
- # A primitive filter.
204
- # All fields in filter in same FilterExpression needs to be either all
205
- # dimensions or metrics.
202
+ # A primitive filter. In the same FilterExpression, all of the filter's
203
+ # field names need to be either all dimensions or all metrics.
206
204
  class FilterExpression
207
205
  include ::Google::Protobuf::MessageExts
208
206
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -220,8 +218,12 @@ module Google
220
218
  # An expression to filter dimension or metric values.
221
219
  # @!attribute [rw] field_name
222
220
  # @return [::String]
223
- # The dimension name or metric name. Must be a name defined in dimensions
224
- # or metrics.
221
+ # The dimension name or metric name.
222
+ #
223
+ # In most methods, dimensions & metrics can be used for the first time in
224
+ # this field. However in a RunPivotReportRequest, this field must be
225
+ # additionally specified by name in the RunPivotReportRequest's dimensions or
226
+ # metrics.
225
227
  # @!attribute [rw] string_filter
226
228
  # @return [::Google::Analytics::Data::V1beta::Filter::StringFilter]
227
229
  # Strings related filter.
@@ -269,10 +271,10 @@ module Google
269
271
  # Contains the string value.
270
272
  CONTAINS = 4
271
273
 
272
- # Full regular expression match with the string value.
274
+ # Full match for the regular expression with the string value.
273
275
  FULL_REGEXP = 5
274
276
 
275
- # Partial regular expression match with the string value.
277
+ # Partial match for the regular expression with the string value.
276
278
  PARTIAL_REGEXP = 6
277
279
  end
278
280
  end
@@ -336,7 +338,9 @@ module Google
336
338
  end
337
339
  end
338
340
 
339
- # The sort options.
341
+ # Order bys define how rows will be sorted in the response. For example,
342
+ # ordering rows by descending event count is one ordering, and ordering rows by
343
+ # the event name string is a different ordering.
340
344
  # @!attribute [rw] metric
341
345
  # @return [::Google::Analytics::Data::V1beta::OrderBy::MetricOrderBy]
342
346
  # Sorts results by a metric's values.
@@ -644,6 +648,16 @@ module Google
644
648
  # @!attribute [rw] empty_reason
645
649
  # @return [::String]
646
650
  # If empty reason is specified, the report is empty for this reason.
651
+ # @!attribute [rw] subject_to_thresholding
652
+ # @return [::Boolean]
653
+ # If `subjectToThresholding` is true, this report is subject to thresholding
654
+ # and only returns data that meets the minimum aggregation thresholds. It is
655
+ # possible for a request to be subject to thresholding thresholding and no
656
+ # data is absent from the report, and this happens when all data is above the
657
+ # thresholds. To learn more, see [Data
658
+ # thresholds](https://support.google.com/analytics/answer/9383630) and [About
659
+ # Demographics and
660
+ # Interests](https://support.google.com/analytics/answer/2799357).
647
661
  class ResponseMetaData
648
662
  include ::Google::Protobuf::MessageExts
649
663
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -817,8 +831,8 @@ module Google
817
831
  # @return [::Google::Analytics::Data::V1beta::QuotaStatus]
818
832
  # Standard Analytics Properties can use up to 5,000 tokens per hour;
819
833
  # Analytics 360 Properties can use 50,000 tokens per hour. An API request
820
- # consumes a single number of tokens, and that number is deducted from both
821
- # the hourly and daily quotas.
834
+ # consumes a single number of tokens, and that number is deducted from all of
835
+ # the hourly, daily, and per project hourly quotas.
822
836
  # @!attribute [rw] concurrent_requests
823
837
  # @return [::Google::Analytics::Data::V1beta::QuotaStatus]
824
838
  # Standard Analytics Properties can send up to 10 concurrent requests;
@@ -834,6 +848,14 @@ module Google
834
848
  # thresholded dimensions per hour. In a batch request, each report request
835
849
  # is individually counted for this quota if the request contains potentially
836
850
  # thresholded dimensions.
851
+ # @!attribute [rw] tokens_per_project_per_hour
852
+ # @return [::Google::Analytics::Data::V1beta::QuotaStatus]
853
+ # Analytics Properties can use up to 25% of their tokens per project per
854
+ # hour. This amounts to standard Analytics Properties can use up to 1,250
855
+ # tokens per project per hour, and Analytics 360 Properties can use 12,500
856
+ # tokens per project per hour. An API request consumes a single number of
857
+ # tokens, and that number is deducted from all of the hourly, daily, and per
858
+ # project hourly quotas.
837
859
  class PropertyQuota
838
860
  include ::Google::Protobuf::MessageExts
839
861
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -0,0 +1,318 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 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
+ # Required information for every language.
23
+ # @!attribute [rw] reference_docs_uri
24
+ # @return [::String]
25
+ # Link to automatically generated reference documentation. Example:
26
+ # https://cloud.google.com/nodejs/docs/reference/asset/latest
27
+ # @!attribute [rw] destinations
28
+ # @return [::Array<::Google::Api::ClientLibraryDestination>]
29
+ # The destination where API teams want this client library to be published.
30
+ class CommonLanguageSettings
31
+ include ::Google::Protobuf::MessageExts
32
+ extend ::Google::Protobuf::MessageExts::ClassMethods
33
+ end
34
+
35
+ # Details about how and where to publish client libraries.
36
+ # @!attribute [rw] version
37
+ # @return [::String]
38
+ # Version of the API to apply these settings to.
39
+ # @!attribute [rw] launch_stage
40
+ # @return [::Google::Api::LaunchStage]
41
+ # Launch stage of this version of the API.
42
+ # @!attribute [rw] rest_numeric_enums
43
+ # @return [::Boolean]
44
+ # When using transport=rest, the client request will encode enums as
45
+ # numbers rather than strings.
46
+ # @!attribute [rw] java_settings
47
+ # @return [::Google::Api::JavaSettings]
48
+ # Settings for legacy Java features, supported in the Service YAML.
49
+ # @!attribute [rw] cpp_settings
50
+ # @return [::Google::Api::CppSettings]
51
+ # Settings for C++ client libraries.
52
+ # @!attribute [rw] php_settings
53
+ # @return [::Google::Api::PhpSettings]
54
+ # Settings for PHP client libraries.
55
+ # @!attribute [rw] python_settings
56
+ # @return [::Google::Api::PythonSettings]
57
+ # Settings for Python client libraries.
58
+ # @!attribute [rw] node_settings
59
+ # @return [::Google::Api::NodeSettings]
60
+ # Settings for Node client libraries.
61
+ # @!attribute [rw] dotnet_settings
62
+ # @return [::Google::Api::DotnetSettings]
63
+ # Settings for .NET client libraries.
64
+ # @!attribute [rw] ruby_settings
65
+ # @return [::Google::Api::RubySettings]
66
+ # Settings for Ruby client libraries.
67
+ # @!attribute [rw] go_settings
68
+ # @return [::Google::Api::GoSettings]
69
+ # Settings for Go client libraries.
70
+ class ClientLibrarySettings
71
+ include ::Google::Protobuf::MessageExts
72
+ extend ::Google::Protobuf::MessageExts::ClassMethods
73
+ end
74
+
75
+ # This message configures the settings for publishing [Google Cloud Client
76
+ # libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
77
+ # generated from the service config.
78
+ # @!attribute [rw] method_settings
79
+ # @return [::Array<::Google::Api::MethodSettings>]
80
+ # A list of API method settings, e.g. the behavior for methods that use the
81
+ # long-running operation pattern.
82
+ # @!attribute [rw] new_issue_uri
83
+ # @return [::String]
84
+ # Link to a place that API users can report issues. Example:
85
+ # https://issuetracker.google.com/issues/new?component=190865&template=1161103
86
+ # @!attribute [rw] documentation_uri
87
+ # @return [::String]
88
+ # Link to product home page. Example:
89
+ # https://cloud.google.com/asset-inventory/docs/overview
90
+ # @!attribute [rw] api_short_name
91
+ # @return [::String]
92
+ # Used as a tracking tag when collecting data about the APIs developer
93
+ # relations artifacts like docs, packages delivered to package managers,
94
+ # etc. Example: "speech".
95
+ # @!attribute [rw] github_label
96
+ # @return [::String]
97
+ # GitHub label to apply to issues and pull requests opened for this API.
98
+ # @!attribute [rw] codeowner_github_teams
99
+ # @return [::Array<::String>]
100
+ # GitHub teams to be added to CODEOWNERS in the directory in GitHub
101
+ # containing source code for the client libraries for this API.
102
+ # @!attribute [rw] doc_tag_prefix
103
+ # @return [::String]
104
+ # A prefix used in sample code when demarking regions to be included in
105
+ # documentation.
106
+ # @!attribute [rw] organization
107
+ # @return [::Google::Api::ClientLibraryOrganization]
108
+ # For whom the client library is being published.
109
+ # @!attribute [rw] library_settings
110
+ # @return [::Array<::Google::Api::ClientLibrarySettings>]
111
+ # Client library settings. If the same version string appears multiple
112
+ # times in this list, then the last one wins. Settings from earlier
113
+ # settings with the same version string are discarded.
114
+ class Publishing
115
+ include ::Google::Protobuf::MessageExts
116
+ extend ::Google::Protobuf::MessageExts::ClassMethods
117
+ end
118
+
119
+ # Settings for Java client libraries.
120
+ # @!attribute [rw] library_package
121
+ # @return [::String]
122
+ # The package name to use in Java. Clobbers the java_package option
123
+ # set in the protobuf. This should be used **only** by APIs
124
+ # who have already set the language_settings.java.package_name" field
125
+ # in gapic.yaml. API teams should use the protobuf java_package option
126
+ # where possible.
127
+ #
128
+ # Example of a YAML configuration::
129
+ #
130
+ # publishing:
131
+ # java_settings:
132
+ # library_package: com.google.cloud.pubsub.v1
133
+ # @!attribute [rw] service_class_names
134
+ # @return [::Google::Protobuf::Map{::String => ::String}]
135
+ # Configure the Java class name to use instead of the service's for its
136
+ # corresponding generated GAPIC client. Keys are fully-qualified
137
+ # service names as they appear in the protobuf (including the full
138
+ # the language_settings.java.interface_names" field in gapic.yaml. API
139
+ # teams should otherwise use the service name as it appears in the
140
+ # protobuf.
141
+ #
142
+ # Example of a YAML configuration::
143
+ #
144
+ # publishing:
145
+ # java_settings:
146
+ # service_class_names:
147
+ # - google.pubsub.v1.Publisher: TopicAdmin
148
+ # - google.pubsub.v1.Subscriber: SubscriptionAdmin
149
+ # @!attribute [rw] common
150
+ # @return [::Google::Api::CommonLanguageSettings]
151
+ # Some settings.
152
+ class JavaSettings
153
+ include ::Google::Protobuf::MessageExts
154
+ extend ::Google::Protobuf::MessageExts::ClassMethods
155
+
156
+ # @!attribute [rw] key
157
+ # @return [::String]
158
+ # @!attribute [rw] value
159
+ # @return [::String]
160
+ class ServiceClassNamesEntry
161
+ include ::Google::Protobuf::MessageExts
162
+ extend ::Google::Protobuf::MessageExts::ClassMethods
163
+ end
164
+ end
165
+
166
+ # Settings for C++ client libraries.
167
+ # @!attribute [rw] common
168
+ # @return [::Google::Api::CommonLanguageSettings]
169
+ # Some settings.
170
+ class CppSettings
171
+ include ::Google::Protobuf::MessageExts
172
+ extend ::Google::Protobuf::MessageExts::ClassMethods
173
+ end
174
+
175
+ # Settings for Php client libraries.
176
+ # @!attribute [rw] common
177
+ # @return [::Google::Api::CommonLanguageSettings]
178
+ # Some settings.
179
+ class PhpSettings
180
+ include ::Google::Protobuf::MessageExts
181
+ extend ::Google::Protobuf::MessageExts::ClassMethods
182
+ end
183
+
184
+ # Settings for Python client libraries.
185
+ # @!attribute [rw] common
186
+ # @return [::Google::Api::CommonLanguageSettings]
187
+ # Some settings.
188
+ class PythonSettings
189
+ include ::Google::Protobuf::MessageExts
190
+ extend ::Google::Protobuf::MessageExts::ClassMethods
191
+ end
192
+
193
+ # Settings for Node client libraries.
194
+ # @!attribute [rw] common
195
+ # @return [::Google::Api::CommonLanguageSettings]
196
+ # Some settings.
197
+ class NodeSettings
198
+ include ::Google::Protobuf::MessageExts
199
+ extend ::Google::Protobuf::MessageExts::ClassMethods
200
+ end
201
+
202
+ # Settings for Dotnet client libraries.
203
+ # @!attribute [rw] common
204
+ # @return [::Google::Api::CommonLanguageSettings]
205
+ # Some settings.
206
+ class DotnetSettings
207
+ include ::Google::Protobuf::MessageExts
208
+ extend ::Google::Protobuf::MessageExts::ClassMethods
209
+ end
210
+
211
+ # Settings for Ruby client libraries.
212
+ # @!attribute [rw] common
213
+ # @return [::Google::Api::CommonLanguageSettings]
214
+ # Some settings.
215
+ class RubySettings
216
+ include ::Google::Protobuf::MessageExts
217
+ extend ::Google::Protobuf::MessageExts::ClassMethods
218
+ end
219
+
220
+ # Settings for Go client libraries.
221
+ # @!attribute [rw] common
222
+ # @return [::Google::Api::CommonLanguageSettings]
223
+ # Some settings.
224
+ class GoSettings
225
+ include ::Google::Protobuf::MessageExts
226
+ extend ::Google::Protobuf::MessageExts::ClassMethods
227
+ end
228
+
229
+ # Describes the generator configuration for a method.
230
+ # @!attribute [rw] selector
231
+ # @return [::String]
232
+ # The fully qualified name of the method, for which the options below apply.
233
+ # This is used to find the method to apply the options.
234
+ # @!attribute [rw] long_running
235
+ # @return [::Google::Api::MethodSettings::LongRunning]
236
+ # Describes settings to use for long-running operations when generating
237
+ # API methods for RPCs. Complements RPCs that use the annotations in
238
+ # google/longrunning/operations.proto.
239
+ #
240
+ # Example of a YAML configuration::
241
+ #
242
+ # publishing:
243
+ # method_behavior:
244
+ # - selector: CreateAdDomain
245
+ # long_running:
246
+ # initial_poll_delay:
247
+ # seconds: 60 # 1 minute
248
+ # poll_delay_multiplier: 1.5
249
+ # max_poll_delay:
250
+ # seconds: 360 # 6 minutes
251
+ # total_poll_timeout:
252
+ # seconds: 54000 # 90 minutes
253
+ class MethodSettings
254
+ include ::Google::Protobuf::MessageExts
255
+ extend ::Google::Protobuf::MessageExts::ClassMethods
256
+
257
+ # Describes settings to use when generating API methods that use the
258
+ # long-running operation pattern.
259
+ # All default values below are from those used in the client library
260
+ # generators (e.g.
261
+ # [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
262
+ # @!attribute [rw] initial_poll_delay
263
+ # @return [::Google::Protobuf::Duration]
264
+ # Initial delay after which the first poll request will be made.
265
+ # Default value: 5 seconds.
266
+ # @!attribute [rw] poll_delay_multiplier
267
+ # @return [::Float]
268
+ # Multiplier to gradually increase delay between subsequent polls until it
269
+ # reaches max_poll_delay.
270
+ # Default value: 1.5.
271
+ # @!attribute [rw] max_poll_delay
272
+ # @return [::Google::Protobuf::Duration]
273
+ # Maximum time between two subsequent poll requests.
274
+ # Default value: 45 seconds.
275
+ # @!attribute [rw] total_poll_timeout
276
+ # @return [::Google::Protobuf::Duration]
277
+ # Total polling timeout.
278
+ # Default value: 5 minutes.
279
+ class LongRunning
280
+ include ::Google::Protobuf::MessageExts
281
+ extend ::Google::Protobuf::MessageExts::ClassMethods
282
+ end
283
+ end
284
+
285
+ # The organization for which the client libraries are being published.
286
+ # Affects the url where generated docs are published, etc.
287
+ module ClientLibraryOrganization
288
+ # Not useful.
289
+ CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0
290
+
291
+ # Google Cloud Platform Org.
292
+ CLOUD = 1
293
+
294
+ # Ads (Advertising) Org.
295
+ ADS = 2
296
+
297
+ # Photos Org.
298
+ PHOTOS = 3
299
+
300
+ # Street View Org.
301
+ STREET_VIEW = 4
302
+ end
303
+
304
+ # To where should client libraries be published?
305
+ module ClientLibraryDestination
306
+ # Client libraries will neither be generated nor published to package
307
+ # managers.
308
+ CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0
309
+
310
+ # Generate the client library in a repo under github.com/googleapis,
311
+ # but don't publish it to package managers.
312
+ GITHUB = 10
313
+
314
+ # Publish the library to package managers like nuget.org and npmjs.com.
315
+ PACKAGE_MANAGER = 20
316
+ end
317
+ end
318
+ end
@@ -0,0 +1,71 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 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
+ # The launch stage as defined by [Google Cloud Platform
23
+ # Launch Stages](https://cloud.google.com/terms/launch-stages).
24
+ module LaunchStage
25
+ # Do not use this default value.
26
+ LAUNCH_STAGE_UNSPECIFIED = 0
27
+
28
+ # The feature is not yet implemented. Users can not use it.
29
+ UNIMPLEMENTED = 6
30
+
31
+ # Prelaunch features are hidden from users and are only visible internally.
32
+ PRELAUNCH = 7
33
+
34
+ # Early Access features are limited to a closed group of testers. To use
35
+ # these features, you must sign up in advance and sign a Trusted Tester
36
+ # agreement (which includes confidentiality provisions). These features may
37
+ # be unstable, changed in backward-incompatible ways, and are not
38
+ # guaranteed to be released.
39
+ EARLY_ACCESS = 1
40
+
41
+ # Alpha is a limited availability test for releases before they are cleared
42
+ # for widespread use. By Alpha, all significant design issues are resolved
43
+ # and we are in the process of verifying functionality. Alpha customers
44
+ # need to apply for access, agree to applicable terms, and have their
45
+ # projects allowlisted. Alpha releases don't have to be feature complete,
46
+ # no SLAs are provided, and there are no technical support obligations, but
47
+ # they will be far enough along that customers can actually use them in
48
+ # test environments or for limited-use tests -- just like they would in
49
+ # normal production cases.
50
+ ALPHA = 2
51
+
52
+ # Beta is the point at which we are ready to open a release for any
53
+ # customer to use. There are no SLA or technical support obligations in a
54
+ # Beta release. Products will be complete from a feature perspective, but
55
+ # may have some open outstanding issues. Beta releases are suitable for
56
+ # limited production use cases.
57
+ BETA = 3
58
+
59
+ # GA features are open to all developers and are considered stable and
60
+ # fully qualified for production use.
61
+ GA = 4
62
+
63
+ # Deprecated features are scheduled to be shut down and removed. For more
64
+ # information, see the "Deprecation Policy" section of our [Terms of
65
+ # Service](https://cloud.google.com/terms/)
66
+ # and the [Google Cloud Platform Subject to the Deprecation
67
+ # Policy](https://cloud.google.com/terms/deprecation) documentation.
68
+ DEPRECATED = 5
69
+ end
70
+ end
71
+ end
@@ -0,0 +1,98 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 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 Protobuf
22
+ # A Duration represents a signed, fixed-length span of time represented
23
+ # as a count of seconds and fractions of seconds at nanosecond
24
+ # resolution. It is independent of any calendar and concepts like "day"
25
+ # or "month". It is related to Timestamp in that the difference between
26
+ # two Timestamp values is a Duration and it can be added or subtracted
27
+ # from a Timestamp. Range is approximately +-10,000 years.
28
+ #
29
+ # # Examples
30
+ #
31
+ # Example 1: Compute Duration from two Timestamps in pseudo code.
32
+ #
33
+ # Timestamp start = ...;
34
+ # Timestamp end = ...;
35
+ # Duration duration = ...;
36
+ #
37
+ # duration.seconds = end.seconds - start.seconds;
38
+ # duration.nanos = end.nanos - start.nanos;
39
+ #
40
+ # if (duration.seconds < 0 && duration.nanos > 0) {
41
+ # duration.seconds += 1;
42
+ # duration.nanos -= 1000000000;
43
+ # } else if (duration.seconds > 0 && duration.nanos < 0) {
44
+ # duration.seconds -= 1;
45
+ # duration.nanos += 1000000000;
46
+ # }
47
+ #
48
+ # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
49
+ #
50
+ # Timestamp start = ...;
51
+ # Duration duration = ...;
52
+ # Timestamp end = ...;
53
+ #
54
+ # end.seconds = start.seconds + duration.seconds;
55
+ # end.nanos = start.nanos + duration.nanos;
56
+ #
57
+ # if (end.nanos < 0) {
58
+ # end.seconds -= 1;
59
+ # end.nanos += 1000000000;
60
+ # } else if (end.nanos >= 1000000000) {
61
+ # end.seconds += 1;
62
+ # end.nanos -= 1000000000;
63
+ # }
64
+ #
65
+ # Example 3: Compute Duration from datetime.timedelta in Python.
66
+ #
67
+ # td = datetime.timedelta(days=3, minutes=10)
68
+ # duration = Duration()
69
+ # duration.FromTimedelta(td)
70
+ #
71
+ # # JSON Mapping
72
+ #
73
+ # In JSON format, the Duration type is encoded as a string rather than an
74
+ # object, where the string ends in the suffix "s" (indicating seconds) and
75
+ # is preceded by the number of seconds, with nanoseconds expressed as
76
+ # fractional seconds. For example, 3 seconds with 0 nanoseconds should be
77
+ # encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
78
+ # be expressed in JSON format as "3.000000001s", and 3 seconds and 1
79
+ # microsecond should be expressed in JSON format as "3.000001s".
80
+ # @!attribute [rw] seconds
81
+ # @return [::Integer]
82
+ # Signed seconds of the span of time. Must be from -315,576,000,000
83
+ # to +315,576,000,000 inclusive. Note: these bounds are computed from:
84
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
85
+ # @!attribute [rw] nanos
86
+ # @return [::Integer]
87
+ # Signed fractions of a second at nanosecond resolution of the span
88
+ # of time. Durations less than one second are represented with a 0
89
+ # `seconds` field and a positive or negative `nanos` field. For durations
90
+ # of one second or more, a non-zero value for the `nanos` field must be
91
+ # of the same sign as the `seconds` field. Must be from -999,999,999
92
+ # to +999,999,999 inclusive.
93
+ class Duration
94
+ include ::Google::Protobuf::MessageExts
95
+ extend ::Google::Protobuf::MessageExts::ClassMethods
96
+ end
97
+ end
98
+ end