google-cloud-resource_settings-v1 1.2.0 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,71 +0,0 @@
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
@@ -1,227 +0,0 @@
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
- # A simple descriptor of a resource type.
23
- #
24
- # ResourceDescriptor annotates a resource message (either by means of a
25
- # protobuf annotation or use in the service config), and associates the
26
- # resource's schema, the resource type, and the pattern of the resource name.
27
- #
28
- # Example:
29
- #
30
- # message Topic {
31
- # // Indicates this message defines a resource schema.
32
- # // Declares the resource type in the format of {service}/{kind}.
33
- # // For Kubernetes resources, the format is {api group}/{kind}.
34
- # option (google.api.resource) = {
35
- # type: "pubsub.googleapis.com/Topic"
36
- # pattern: "projects/{project}/topics/{topic}"
37
- # };
38
- # }
39
- #
40
- # The ResourceDescriptor Yaml config will look like:
41
- #
42
- # resources:
43
- # - type: "pubsub.googleapis.com/Topic"
44
- # pattern: "projects/{project}/topics/{topic}"
45
- #
46
- # Sometimes, resources have multiple patterns, typically because they can
47
- # live under multiple parents.
48
- #
49
- # Example:
50
- #
51
- # message LogEntry {
52
- # option (google.api.resource) = {
53
- # type: "logging.googleapis.com/LogEntry"
54
- # pattern: "projects/{project}/logs/{log}"
55
- # pattern: "folders/{folder}/logs/{log}"
56
- # pattern: "organizations/{organization}/logs/{log}"
57
- # pattern: "billingAccounts/{billing_account}/logs/{log}"
58
- # };
59
- # }
60
- #
61
- # The ResourceDescriptor Yaml config will look like:
62
- #
63
- # resources:
64
- # - type: 'logging.googleapis.com/LogEntry'
65
- # pattern: "projects/{project}/logs/{log}"
66
- # pattern: "folders/{folder}/logs/{log}"
67
- # pattern: "organizations/{organization}/logs/{log}"
68
- # pattern: "billingAccounts/{billing_account}/logs/{log}"
69
- # @!attribute [rw] type
70
- # @return [::String]
71
- # The resource type. It must be in the format of
72
- # \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
73
- # singular and must not include version numbers.
74
- #
75
- # Example: `storage.googleapis.com/Bucket`
76
- #
77
- # The value of the resource_type_kind must follow the regular expression
78
- # /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
79
- # should use PascalCase (UpperCamelCase). The maximum number of
80
- # characters allowed for the `resource_type_kind` is 100.
81
- # @!attribute [rw] pattern
82
- # @return [::Array<::String>]
83
- # Optional. The relative resource name pattern associated with this resource
84
- # type. The DNS prefix of the full resource name shouldn't be specified here.
85
- #
86
- # The path pattern must follow the syntax, which aligns with HTTP binding
87
- # syntax:
88
- #
89
- # Template = Segment { "/" Segment } ;
90
- # Segment = LITERAL | Variable ;
91
- # Variable = "{" LITERAL "}" ;
92
- #
93
- # Examples:
94
- #
95
- # - "projects/\\{project}/topics/\\{topic}"
96
- # - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
97
- #
98
- # The components in braces correspond to the IDs for each resource in the
99
- # hierarchy. It is expected that, if multiple patterns are provided,
100
- # the same component name (e.g. "project") refers to IDs of the same
101
- # type of resource.
102
- # @!attribute [rw] name_field
103
- # @return [::String]
104
- # Optional. The field on the resource that designates the resource name
105
- # field. If omitted, this is assumed to be "name".
106
- # @!attribute [rw] history
107
- # @return [::Google::Api::ResourceDescriptor::History]
108
- # Optional. The historical or future-looking state of the resource pattern.
109
- #
110
- # Example:
111
- #
112
- # // The InspectTemplate message originally only supported resource
113
- # // names with organization, and project was added later.
114
- # message InspectTemplate {
115
- # option (google.api.resource) = {
116
- # type: "dlp.googleapis.com/InspectTemplate"
117
- # pattern:
118
- # "organizations/{organization}/inspectTemplates/{inspect_template}"
119
- # pattern: "projects/{project}/inspectTemplates/{inspect_template}"
120
- # history: ORIGINALLY_SINGLE_PATTERN
121
- # };
122
- # }
123
- # @!attribute [rw] plural
124
- # @return [::String]
125
- # The plural name used in the resource name and permission names, such as
126
- # 'projects' for the resource name of 'projects/\\{project}' and the permission
127
- # name of 'cloudresourcemanager.googleapis.com/projects.get'. One exception
128
- # to this is for Nested Collections that have stuttering names, as defined
129
- # in [AIP-122](https://google.aip.dev/122#nested-collections), where the
130
- # collection ID in the resource name pattern does not necessarily directly
131
- # match the `plural` value.
132
- #
133
- # It is the same concept of the `plural` field in k8s CRD spec
134
- # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
135
- #
136
- # Note: The plural form is required even for singleton resources. See
137
- # https://aip.dev/156
138
- # @!attribute [rw] singular
139
- # @return [::String]
140
- # The same concept of the `singular` field in k8s CRD spec
141
- # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
142
- # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
143
- # @!attribute [rw] style
144
- # @return [::Array<::Google::Api::ResourceDescriptor::Style>]
145
- # Style flag(s) for this resource.
146
- # These indicate that a resource is expected to conform to a given
147
- # style. See the specific style flags for additional information.
148
- class ResourceDescriptor
149
- include ::Google::Protobuf::MessageExts
150
- extend ::Google::Protobuf::MessageExts::ClassMethods
151
-
152
- # A description of the historical or future-looking state of the
153
- # resource pattern.
154
- module History
155
- # The "unset" value.
156
- HISTORY_UNSPECIFIED = 0
157
-
158
- # The resource originally had one pattern and launched as such, and
159
- # additional patterns were added later.
160
- ORIGINALLY_SINGLE_PATTERN = 1
161
-
162
- # The resource has one pattern, but the API owner expects to add more
163
- # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
164
- # that from being necessary once there are multiple patterns.)
165
- FUTURE_MULTI_PATTERN = 2
166
- end
167
-
168
- # A flag representing a specific style that a resource claims to conform to.
169
- module Style
170
- # The unspecified value. Do not use.
171
- STYLE_UNSPECIFIED = 0
172
-
173
- # This resource is intended to be "declarative-friendly".
174
- #
175
- # Declarative-friendly resources must be more strictly consistent, and
176
- # setting this to true communicates to tools that this resource should
177
- # adhere to declarative-friendly expectations.
178
- #
179
- # Note: This is used by the API linter (linter.aip.dev) to enable
180
- # additional checks.
181
- DECLARATIVE_FRIENDLY = 1
182
- end
183
- end
184
-
185
- # Defines a proto annotation that describes a string field that refers to
186
- # an API resource.
187
- # @!attribute [rw] type
188
- # @return [::String]
189
- # The resource type that the annotated field references.
190
- #
191
- # Example:
192
- #
193
- # message Subscription {
194
- # string topic = 2 [(google.api.resource_reference) = {
195
- # type: "pubsub.googleapis.com/Topic"
196
- # }];
197
- # }
198
- #
199
- # Occasionally, a field may reference an arbitrary resource. In this case,
200
- # APIs use the special value * in their resource reference.
201
- #
202
- # Example:
203
- #
204
- # message GetIamPolicyRequest {
205
- # string resource = 2 [(google.api.resource_reference) = {
206
- # type: "*"
207
- # }];
208
- # }
209
- # @!attribute [rw] child_type
210
- # @return [::String]
211
- # The resource type of a child collection that the annotated field
212
- # references. This is useful for annotating the `parent` field that
213
- # doesn't have a fixed resource type.
214
- #
215
- # Example:
216
- #
217
- # message ListLogEntriesRequest {
218
- # string parent = 1 [(google.api.resource_reference) = {
219
- # child_type: "logging.googleapis.com/LogEntry"
220
- # };
221
- # }
222
- class ResourceReference
223
- include ::Google::Protobuf::MessageExts
224
- extend ::Google::Protobuf::MessageExts::ClassMethods
225
- end
226
- end
227
- end
@@ -1,253 +0,0 @@
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 Cloud
22
- module ResourceSettings
23
- module V1
24
- # The schema for settings.
25
- # @!attribute [rw] name
26
- # @return [::String]
27
- # The resource name of the setting. Must be in one of the following forms:
28
- #
29
- # * `projects/{project_number}/settings/{setting_name}`
30
- # * `folders/{folder_id}/settings/{setting_name}`
31
- # * `organizations/{organization_id}/settings/{setting_name}`
32
- #
33
- # For example, "/projects/123/settings/gcp-enableMyFeature"
34
- # @!attribute [r] metadata
35
- # @return [::Google::Cloud::ResourceSettings::V1::SettingMetadata]
36
- # Output only. Metadata about a setting which is not editable by the end
37
- # user.
38
- # @!attribute [rw] local_value
39
- # @return [::Google::Cloud::ResourceSettings::V1::Value]
40
- # The configured value of the setting at the given parent resource (ignoring
41
- # the resource hierarchy). The data type of
42
- # {::Google::Cloud::ResourceSettings::V1::Value Value} must always be consistent
43
- # with the data type defined in
44
- # {::Google::Cloud::ResourceSettings::V1::Setting#metadata Setting.metadata}.
45
- # @!attribute [r] effective_value
46
- # @return [::Google::Cloud::ResourceSettings::V1::Value]
47
- # Output only. The computed effective value of the setting at the given
48
- # parent resource (based on the resource hierarchy).
49
- #
50
- # The effective value evaluates to one of the following options in the given
51
- # order (the next option is used if the previous one does not exist):
52
- #
53
- # 1. the local setting value on the given resource:
54
- # {::Google::Cloud::ResourceSettings::V1::Setting#local_value Setting.local_value}
55
- # 2. if one of the given resource's ancestors have a local setting value,
56
- # the local value at the nearest such ancestor
57
- # 3. the setting's default value:
58
- # {::Google::Cloud::ResourceSettings::V1::SettingMetadata#default_value SettingMetadata.default_value}
59
- # 4. an empty value (defined as a `Value` with all fields unset)
60
- #
61
- # The data type of {::Google::Cloud::ResourceSettings::V1::Value Value} must
62
- # always be consistent with the data type defined in
63
- # {::Google::Cloud::ResourceSettings::V1::Setting#metadata Setting.metadata}.
64
- # @!attribute [rw] etag
65
- # @return [::String]
66
- # A fingerprint used for optimistic concurrency. See
67
- # {::Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Client#update_setting UpdateSetting}
68
- # for more details.
69
- class Setting
70
- include ::Google::Protobuf::MessageExts
71
- extend ::Google::Protobuf::MessageExts::ClassMethods
72
- end
73
-
74
- # Metadata about a setting which is not editable by the end user.
75
- # @!attribute [rw] display_name
76
- # @return [::String]
77
- # The human readable name for this setting.
78
- # @!attribute [rw] description
79
- # @return [::String]
80
- # A detailed description of what this setting does.
81
- # @!attribute [rw] read_only
82
- # @return [::Boolean]
83
- # A flag indicating that values of this setting cannot be modified (see
84
- # documentation of the specific setting for updates and reasons).
85
- # @!attribute [rw] data_type
86
- # @return [::Google::Cloud::ResourceSettings::V1::SettingMetadata::DataType]
87
- # The data type for this setting.
88
- # @!attribute [rw] default_value
89
- # @return [::Google::Cloud::ResourceSettings::V1::Value]
90
- # The value provided by
91
- # {::Google::Cloud::ResourceSettings::V1::Setting#effective_value Setting.effective_value}
92
- # if no setting value is explicitly set.
93
- #
94
- # Note: not all settings have a default value.
95
- class SettingMetadata
96
- include ::Google::Protobuf::MessageExts
97
- extend ::Google::Protobuf::MessageExts::ClassMethods
98
-
99
- # The data type for setting values of this setting. See
100
- # {::Google::Cloud::ResourceSettings::V1::Value Value} for more details on the
101
- # available data types.
102
- module DataType
103
- # Unspecified data type.
104
- DATA_TYPE_UNSPECIFIED = 0
105
-
106
- # A boolean setting.
107
- BOOLEAN = 1
108
-
109
- # A string setting.
110
- STRING = 2
111
-
112
- # A string set setting.
113
- STRING_SET = 3
114
-
115
- # A Enum setting
116
- ENUM_VALUE = 4
117
- end
118
- end
119
-
120
- # The data in a setting value.
121
- # @!attribute [rw] boolean_value
122
- # @return [::Boolean]
123
- # Defines this value as being a boolean value.
124
- #
125
- # Note: The following fields are mutually exclusive: `boolean_value`, `string_value`, `string_set_value`, `enum_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
126
- # @!attribute [rw] string_value
127
- # @return [::String]
128
- # Defines this value as being a string value.
129
- #
130
- # Note: The following fields are mutually exclusive: `string_value`, `boolean_value`, `string_set_value`, `enum_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
131
- # @!attribute [rw] string_set_value
132
- # @return [::Google::Cloud::ResourceSettings::V1::Value::StringSet]
133
- # Defines this value as being a StringSet.
134
- #
135
- # Note: The following fields are mutually exclusive: `string_set_value`, `boolean_value`, `string_value`, `enum_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
136
- # @!attribute [rw] enum_value
137
- # @return [::Google::Cloud::ResourceSettings::V1::Value::EnumValue]
138
- # Defines this value as being a Enum.
139
- #
140
- # Note: The following fields are mutually exclusive: `enum_value`, `boolean_value`, `string_value`, `string_set_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
141
- class Value
142
- include ::Google::Protobuf::MessageExts
143
- extend ::Google::Protobuf::MessageExts::ClassMethods
144
-
145
- # A string set value that can hold a set of strings. The maximum length of
146
- # each string is 200 characters and there can be a maximum of 50 strings in
147
- # the string set.
148
- # @!attribute [rw] values
149
- # @return [::Array<::String>]
150
- # The strings in the set
151
- class StringSet
152
- include ::Google::Protobuf::MessageExts
153
- extend ::Google::Protobuf::MessageExts::ClassMethods
154
- end
155
-
156
- # A enum value that can hold any enum type setting values.
157
- # Each enum type is represented by a number, this representation
158
- # is stored in the definitions.
159
- # @!attribute [rw] value
160
- # @return [::String]
161
- # The value of this enum
162
- class EnumValue
163
- include ::Google::Protobuf::MessageExts
164
- extend ::Google::Protobuf::MessageExts::ClassMethods
165
- end
166
- end
167
-
168
- # The request for ListSettings.
169
- # @!attribute [rw] parent
170
- # @return [::String]
171
- # Required. The Cloud resource that parents the setting. Must be in one of
172
- # the following forms:
173
- #
174
- # * `projects/{project_number}`
175
- # * `projects/{project_id}`
176
- # * `folders/{folder_id}`
177
- # * `organizations/{organization_id}`
178
- # @!attribute [rw] page_size
179
- # @return [::Integer]
180
- # Unused. The size of the page to be returned.
181
- # @!attribute [rw] page_token
182
- # @return [::String]
183
- # Unused. A page token used to retrieve the next page.
184
- # @!attribute [rw] view
185
- # @return [::Google::Cloud::ResourceSettings::V1::SettingView]
186
- # The SettingView for this request.
187
- class ListSettingsRequest
188
- include ::Google::Protobuf::MessageExts
189
- extend ::Google::Protobuf::MessageExts::ClassMethods
190
- end
191
-
192
- # The response from ListSettings.
193
- # @!attribute [rw] settings
194
- # @return [::Array<::Google::Cloud::ResourceSettings::V1::Setting>]
195
- # A list of settings that are available at the specified Cloud resource.
196
- # @!attribute [rw] next_page_token
197
- # @return [::String]
198
- # Unused. A page token used to retrieve the next page.
199
- class ListSettingsResponse
200
- include ::Google::Protobuf::MessageExts
201
- extend ::Google::Protobuf::MessageExts::ClassMethods
202
- end
203
-
204
- # The request for GetSetting.
205
- # @!attribute [rw] name
206
- # @return [::String]
207
- # Required. The name of the setting to get. See
208
- # {::Google::Cloud::ResourceSettings::V1::Setting Setting} for naming
209
- # requirements.
210
- # @!attribute [rw] view
211
- # @return [::Google::Cloud::ResourceSettings::V1::SettingView]
212
- # The SettingView for this request.
213
- class GetSettingRequest
214
- include ::Google::Protobuf::MessageExts
215
- extend ::Google::Protobuf::MessageExts::ClassMethods
216
- end
217
-
218
- # The request for UpdateSetting.
219
- # @!attribute [rw] setting
220
- # @return [::Google::Cloud::ResourceSettings::V1::Setting]
221
- # Required. The setting to update. See
222
- # {::Google::Cloud::ResourceSettings::V1::Setting Setting} for field requirements.
223
- class UpdateSettingRequest
224
- include ::Google::Protobuf::MessageExts
225
- extend ::Google::Protobuf::MessageExts::ClassMethods
226
- end
227
-
228
- # View options for Settings.
229
- module SettingView
230
- # The default / unset value.
231
- # The API will default to the SETTING_VIEW_BASIC view.
232
- SETTING_VIEW_UNSPECIFIED = 0
233
-
234
- # Include
235
- # {::Google::Cloud::ResourceSettings::V1::Setting#metadata Setting.metadata}, but
236
- # nothing else. This is the default value (for both ListSettings and
237
- # GetSetting).
238
- SETTING_VIEW_BASIC = 1
239
-
240
- # Include
241
- # {::Google::Cloud::ResourceSettings::V1::Setting#effective_value Setting.effective_value},
242
- # but nothing else.
243
- SETTING_VIEW_EFFECTIVE_VALUE = 2
244
-
245
- # Include
246
- # {::Google::Cloud::ResourceSettings::V1::Setting#local_value Setting.local_value},
247
- # but nothing else.
248
- SETTING_VIEW_LOCAL_VALUE = 3
249
- end
250
- end
251
- end
252
- end
253
- end
@@ -1,98 +0,0 @@
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