google-cloud-tasks-v2 0.1.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.
- checksums.yaml +7 -0
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +169 -0
- data/LICENSE.md +203 -0
- data/README.md +71 -0
- data/lib/google-cloud-tasks-v2.rb +21 -0
- data/lib/google/cloud/common_resources_pb.rb +15 -0
- data/lib/google/cloud/tasks/v2.rb +35 -0
- data/lib/google/cloud/tasks/v2/cloud_tasks.rb +50 -0
- data/lib/google/cloud/tasks/v2/cloud_tasks/client.rb +1849 -0
- data/lib/google/cloud/tasks/v2/cloud_tasks/credentials.rb +51 -0
- data/lib/google/cloud/tasks/v2/cloud_tasks/paths.rb +90 -0
- data/lib/google/cloud/tasks/v2/cloudtasks_pb.rb +102 -0
- data/lib/google/cloud/tasks/v2/cloudtasks_services_pb.rb +202 -0
- data/lib/google/cloud/tasks/v2/queue_pb.rb +58 -0
- data/lib/google/cloud/tasks/v2/target_pb.rb +67 -0
- data/lib/google/cloud/tasks/v2/task_pb.rb +53 -0
- data/lib/google/cloud/tasks/v2/version.rb +28 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/field_behavior.rb +59 -0
- data/proto_docs/google/api/resource.rb +247 -0
- data/proto_docs/google/cloud/tasks/v2/cloudtasks.rb +361 -0
- data/proto_docs/google/cloud/tasks/v2/queue.rb +364 -0
- data/proto_docs/google/cloud/tasks/v2/target.rb +451 -0
- data/proto_docs/google/cloud/tasks/v2/task.rb +185 -0
- data/proto_docs/google/iam/v1/iam_policy.rb +80 -0
- data/proto_docs/google/iam/v1/options.rb +40 -0
- data/proto_docs/google/iam/v1/policy.rb +248 -0
- data/proto_docs/google/protobuf/any.rb +138 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +36 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/protobuf/timestamp.rb +120 -0
- data/proto_docs/google/rpc/status.rb +46 -0
- data/proto_docs/google/type/expr.rb +52 -0
- metadata +211 -0
@@ -0,0 +1,80 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2020 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 Iam
|
22
|
+
module V1
|
23
|
+
# Request message for `SetIamPolicy` method.
|
24
|
+
# @!attribute [rw] resource
|
25
|
+
# @return [::String]
|
26
|
+
# REQUIRED: The resource for which the policy is being specified.
|
27
|
+
# See the operation documentation for the appropriate value for this field.
|
28
|
+
# @!attribute [rw] policy
|
29
|
+
# @return [::Google::Iam::V1::Policy]
|
30
|
+
# REQUIRED: The complete policy to be applied to the `resource`. The size of
|
31
|
+
# the policy is limited to a few 10s of KB. An empty policy is a
|
32
|
+
# valid policy but certain Cloud Platform services (such as Projects)
|
33
|
+
# might reject them.
|
34
|
+
class SetIamPolicyRequest
|
35
|
+
include ::Google::Protobuf::MessageExts
|
36
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
37
|
+
end
|
38
|
+
|
39
|
+
# Request message for `GetIamPolicy` method.
|
40
|
+
# @!attribute [rw] resource
|
41
|
+
# @return [::String]
|
42
|
+
# REQUIRED: The resource for which the policy is being requested.
|
43
|
+
# See the operation documentation for the appropriate value for this field.
|
44
|
+
# @!attribute [rw] options
|
45
|
+
# @return [::Google::Iam::V1::GetPolicyOptions]
|
46
|
+
# OPTIONAL: A `GetPolicyOptions` object for specifying options to
|
47
|
+
# `GetIamPolicy`. This field is only used by Cloud IAM.
|
48
|
+
class GetIamPolicyRequest
|
49
|
+
include ::Google::Protobuf::MessageExts
|
50
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
51
|
+
end
|
52
|
+
|
53
|
+
# Request message for `TestIamPermissions` method.
|
54
|
+
# @!attribute [rw] resource
|
55
|
+
# @return [::String]
|
56
|
+
# REQUIRED: The resource for which the policy detail is being requested.
|
57
|
+
# See the operation documentation for the appropriate value for this field.
|
58
|
+
# @!attribute [rw] permissions
|
59
|
+
# @return [::Array<::String>]
|
60
|
+
# The set of permissions to check for the `resource`. Permissions with
|
61
|
+
# wildcards (such as '*' or 'storage.*') are not allowed. For more
|
62
|
+
# information see
|
63
|
+
# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
|
64
|
+
class TestIamPermissionsRequest
|
65
|
+
include ::Google::Protobuf::MessageExts
|
66
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
67
|
+
end
|
68
|
+
|
69
|
+
# Response message for `TestIamPermissions` method.
|
70
|
+
# @!attribute [rw] permissions
|
71
|
+
# @return [::Array<::String>]
|
72
|
+
# A subset of `TestPermissionsRequest.permissions` that the caller is
|
73
|
+
# allowed.
|
74
|
+
class TestIamPermissionsResponse
|
75
|
+
include ::Google::Protobuf::MessageExts
|
76
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
77
|
+
end
|
78
|
+
end
|
79
|
+
end
|
80
|
+
end
|
@@ -0,0 +1,40 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2020 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 Iam
|
22
|
+
module V1
|
23
|
+
# Encapsulates settings provided to GetIamPolicy.
|
24
|
+
# @!attribute [rw] requested_policy_version
|
25
|
+
# @return [::Integer]
|
26
|
+
# Optional. The policy format version to be returned.
|
27
|
+
#
|
28
|
+
# Valid values are 0, 1, and 3. Requests specifying an invalid value will be
|
29
|
+
# rejected.
|
30
|
+
#
|
31
|
+
# Requests for policies with any conditional bindings must specify version 3.
|
32
|
+
# Policies without any conditional bindings may specify any valid value or
|
33
|
+
# leave the field unset.
|
34
|
+
class GetPolicyOptions
|
35
|
+
include ::Google::Protobuf::MessageExts
|
36
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
40
|
+
end
|
@@ -0,0 +1,248 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2020 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 Iam
|
22
|
+
module V1
|
23
|
+
# Defines an Identity and Access Management (IAM) policy. It is used to
|
24
|
+
# specify access control policies for Cloud Platform resources.
|
25
|
+
#
|
26
|
+
#
|
27
|
+
# A `Policy` is a collection of `bindings`. A `binding` binds one or more
|
28
|
+
# `members` to a single `role`. Members can be user accounts, service accounts,
|
29
|
+
# Google groups, and domains (such as G Suite). A `role` is a named list of
|
30
|
+
# permissions (defined by IAM or configured by users). A `binding` can
|
31
|
+
# optionally specify a `condition`, which is a logic expression that further
|
32
|
+
# constrains the role binding based on attributes about the request and/or
|
33
|
+
# target resource.
|
34
|
+
#
|
35
|
+
# **JSON Example**
|
36
|
+
#
|
37
|
+
# {
|
38
|
+
# "bindings": [
|
39
|
+
# {
|
40
|
+
# "role": "roles/resourcemanager.organizationAdmin",
|
41
|
+
# "members": [
|
42
|
+
# "user:mike@example.com",
|
43
|
+
# "group:admins@example.com",
|
44
|
+
# "domain:google.com",
|
45
|
+
# "serviceAccount:my-project-id@appspot.gserviceaccount.com"
|
46
|
+
# ]
|
47
|
+
# },
|
48
|
+
# {
|
49
|
+
# "role": "roles/resourcemanager.organizationViewer",
|
50
|
+
# "members": ["user:eve@example.com"],
|
51
|
+
# "condition": {
|
52
|
+
# "title": "expirable access",
|
53
|
+
# "description": "Does not grant access after Sep 2020",
|
54
|
+
# "expression": "request.time <
|
55
|
+
# timestamp('2020-10-01T00:00:00.000Z')",
|
56
|
+
# }
|
57
|
+
# }
|
58
|
+
# ]
|
59
|
+
# }
|
60
|
+
#
|
61
|
+
# **YAML Example**
|
62
|
+
#
|
63
|
+
# bindings:
|
64
|
+
# - members:
|
65
|
+
# - user:mike@example.com
|
66
|
+
# - group:admins@example.com
|
67
|
+
# - domain:google.com
|
68
|
+
# - serviceAccount:my-project-id@appspot.gserviceaccount.com
|
69
|
+
# role: roles/resourcemanager.organizationAdmin
|
70
|
+
# - members:
|
71
|
+
# - user:eve@example.com
|
72
|
+
# role: roles/resourcemanager.organizationViewer
|
73
|
+
# condition:
|
74
|
+
# title: expirable access
|
75
|
+
# description: Does not grant access after Sep 2020
|
76
|
+
# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
|
77
|
+
#
|
78
|
+
# For a description of IAM and its features, see the
|
79
|
+
# [IAM developer's guide](https://cloud.google.com/iam/docs).
|
80
|
+
# @!attribute [rw] version
|
81
|
+
# @return [::Integer]
|
82
|
+
# Specifies the format of the policy.
|
83
|
+
#
|
84
|
+
# Valid values are 0, 1, and 3. Requests specifying an invalid value will be
|
85
|
+
# rejected.
|
86
|
+
#
|
87
|
+
# Operations affecting conditional bindings must specify version 3. This can
|
88
|
+
# be either setting a conditional policy, modifying a conditional binding,
|
89
|
+
# or removing a binding (conditional or unconditional) from the stored
|
90
|
+
# conditional policy.
|
91
|
+
# Operations on non-conditional policies may specify any valid value or
|
92
|
+
# leave the field unset.
|
93
|
+
#
|
94
|
+
# If no etag is provided in the call to `setIamPolicy`, version compliance
|
95
|
+
# checks against the stored policy is skipped.
|
96
|
+
# @!attribute [rw] bindings
|
97
|
+
# @return [::Array<::Google::Iam::V1::Binding>]
|
98
|
+
# Associates a list of `members` to a `role`. Optionally may specify a
|
99
|
+
# `condition` that determines when binding is in effect.
|
100
|
+
# `bindings` with no members will result in an error.
|
101
|
+
# @!attribute [rw] etag
|
102
|
+
# @return [::String]
|
103
|
+
# `etag` is used for optimistic concurrency control as a way to help
|
104
|
+
# prevent simultaneous updates of a policy from overwriting each other.
|
105
|
+
# It is strongly suggested that systems make use of the `etag` in the
|
106
|
+
# read-modify-write cycle to perform policy updates in order to avoid race
|
107
|
+
# conditions: An `etag` is returned in the response to `getIamPolicy`, and
|
108
|
+
# systems are expected to put that etag in the request to `setIamPolicy` to
|
109
|
+
# ensure that their change will be applied to the same version of the policy.
|
110
|
+
#
|
111
|
+
# If no `etag` is provided in the call to `setIamPolicy`, then the existing
|
112
|
+
# policy is overwritten. Due to blind-set semantics of an etag-less policy,
|
113
|
+
# 'setIamPolicy' will not fail even if the incoming policy version does not
|
114
|
+
# meet the requirements for modifying the stored policy.
|
115
|
+
class Policy
|
116
|
+
include ::Google::Protobuf::MessageExts
|
117
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
118
|
+
end
|
119
|
+
|
120
|
+
# Associates `members` with a `role`.
|
121
|
+
# @!attribute [rw] role
|
122
|
+
# @return [::String]
|
123
|
+
# Role that is assigned to `members`.
|
124
|
+
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
|
125
|
+
# @!attribute [rw] members
|
126
|
+
# @return [::Array<::String>]
|
127
|
+
# Specifies the identities requesting access for a Cloud Platform resource.
|
128
|
+
# `members` can have the following values:
|
129
|
+
#
|
130
|
+
# * `allUsers`: A special identifier that represents anyone who is
|
131
|
+
# on the internet; with or without a Google account.
|
132
|
+
#
|
133
|
+
# * `allAuthenticatedUsers`: A special identifier that represents anyone
|
134
|
+
# who is authenticated with a Google account or a service account.
|
135
|
+
#
|
136
|
+
# * `user:{emailid}`: An email address that represents a specific Google
|
137
|
+
# account. For example, `alice@example.com` .
|
138
|
+
#
|
139
|
+
#
|
140
|
+
# * `serviceAccount:{emailid}`: An email address that represents a service
|
141
|
+
# account. For example, `my-other-app@appspot.gserviceaccount.com`.
|
142
|
+
#
|
143
|
+
# * `group:{emailid}`: An email address that represents a Google group.
|
144
|
+
# For example, `admins@example.com`.
|
145
|
+
#
|
146
|
+
#
|
147
|
+
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
|
148
|
+
# users of that domain. For example, `google.com` or `example.com`.
|
149
|
+
# @!attribute [rw] condition
|
150
|
+
# @return [::Google::Type::Expr]
|
151
|
+
# The condition that is associated with this binding.
|
152
|
+
# NOTE: An unsatisfied condition will not allow user access via current
|
153
|
+
# binding. Different bindings, including their conditions, are examined
|
154
|
+
# independently.
|
155
|
+
class Binding
|
156
|
+
include ::Google::Protobuf::MessageExts
|
157
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
158
|
+
end
|
159
|
+
|
160
|
+
# The difference delta between two policies.
|
161
|
+
# @!attribute [rw] binding_deltas
|
162
|
+
# @return [::Array<::Google::Iam::V1::BindingDelta>]
|
163
|
+
# The delta for Bindings between two policies.
|
164
|
+
# @!attribute [rw] audit_config_deltas
|
165
|
+
# @return [::Array<::Google::Iam::V1::AuditConfigDelta>]
|
166
|
+
# The delta for AuditConfigs between two policies.
|
167
|
+
class PolicyDelta
|
168
|
+
include ::Google::Protobuf::MessageExts
|
169
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
170
|
+
end
|
171
|
+
|
172
|
+
# One delta entry for Binding. Each individual change (only one member in each
|
173
|
+
# entry) to a binding will be a separate entry.
|
174
|
+
# @!attribute [rw] action
|
175
|
+
# @return [::Google::Iam::V1::BindingDelta::Action]
|
176
|
+
# The action that was performed on a Binding.
|
177
|
+
# Required
|
178
|
+
# @!attribute [rw] role
|
179
|
+
# @return [::String]
|
180
|
+
# Role that is assigned to `members`.
|
181
|
+
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
|
182
|
+
# Required
|
183
|
+
# @!attribute [rw] member
|
184
|
+
# @return [::String]
|
185
|
+
# A single identity requesting access for a Cloud Platform resource.
|
186
|
+
# Follows the same format of Binding.members.
|
187
|
+
# Required
|
188
|
+
# @!attribute [rw] condition
|
189
|
+
# @return [::Google::Type::Expr]
|
190
|
+
# The condition that is associated with this binding.
|
191
|
+
class BindingDelta
|
192
|
+
include ::Google::Protobuf::MessageExts
|
193
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
194
|
+
|
195
|
+
# The type of action performed on a Binding in a policy.
|
196
|
+
module Action
|
197
|
+
# Unspecified.
|
198
|
+
ACTION_UNSPECIFIED = 0
|
199
|
+
|
200
|
+
# Addition of a Binding.
|
201
|
+
ADD = 1
|
202
|
+
|
203
|
+
# Removal of a Binding.
|
204
|
+
REMOVE = 2
|
205
|
+
end
|
206
|
+
end
|
207
|
+
|
208
|
+
# One delta entry for AuditConfig. Each individual change (only one
|
209
|
+
# exempted_member in each entry) to a AuditConfig will be a separate entry.
|
210
|
+
# @!attribute [rw] action
|
211
|
+
# @return [::Google::Iam::V1::AuditConfigDelta::Action]
|
212
|
+
# The action that was performed on an audit configuration in a policy.
|
213
|
+
# Required
|
214
|
+
# @!attribute [rw] service
|
215
|
+
# @return [::String]
|
216
|
+
# Specifies a service that was configured for Cloud Audit Logging.
|
217
|
+
# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
|
218
|
+
# `allServices` is a special value that covers all services.
|
219
|
+
# Required
|
220
|
+
# @!attribute [rw] exempted_member
|
221
|
+
# @return [::String]
|
222
|
+
# A single identity that is exempted from "data access" audit
|
223
|
+
# logging for the `service` specified above.
|
224
|
+
# Follows the same format of Binding.members.
|
225
|
+
# @!attribute [rw] log_type
|
226
|
+
# @return [::String]
|
227
|
+
# Specifies the log_type that was be enabled. ADMIN_ACTIVITY is always
|
228
|
+
# enabled, and cannot be configured.
|
229
|
+
# Required
|
230
|
+
class AuditConfigDelta
|
231
|
+
include ::Google::Protobuf::MessageExts
|
232
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
233
|
+
|
234
|
+
# The type of action performed on an audit configuration in a policy.
|
235
|
+
module Action
|
236
|
+
# Unspecified.
|
237
|
+
ACTION_UNSPECIFIED = 0
|
238
|
+
|
239
|
+
# Addition of an audit configuration.
|
240
|
+
ADD = 1
|
241
|
+
|
242
|
+
# Removal of an audit configuration.
|
243
|
+
REMOVE = 2
|
244
|
+
end
|
245
|
+
end
|
246
|
+
end
|
247
|
+
end
|
248
|
+
end
|
@@ -0,0 +1,138 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2020 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
|
+
# `Any` contains an arbitrary serialized protocol buffer message along with a
|
23
|
+
# URL that describes the type of the serialized message.
|
24
|
+
#
|
25
|
+
# Protobuf library provides support to pack/unpack Any values in the form
|
26
|
+
# of utility functions or additional generated methods of the Any type.
|
27
|
+
#
|
28
|
+
# Example 1: Pack and unpack a message in C++.
|
29
|
+
#
|
30
|
+
# Foo foo = ...;
|
31
|
+
# Any any;
|
32
|
+
# any.PackFrom(foo);
|
33
|
+
# ...
|
34
|
+
# if (any.UnpackTo(&foo)) {
|
35
|
+
# ...
|
36
|
+
# }
|
37
|
+
#
|
38
|
+
# Example 2: Pack and unpack a message in Java.
|
39
|
+
#
|
40
|
+
# Foo foo = ...;
|
41
|
+
# Any any = Any.pack(foo);
|
42
|
+
# ...
|
43
|
+
# if (any.is(Foo.class)) {
|
44
|
+
# foo = any.unpack(Foo.class);
|
45
|
+
# }
|
46
|
+
#
|
47
|
+
# Example 3: Pack and unpack a message in Python.
|
48
|
+
#
|
49
|
+
# foo = Foo(...)
|
50
|
+
# any = Any()
|
51
|
+
# any.Pack(foo)
|
52
|
+
# ...
|
53
|
+
# if any.Is(Foo.DESCRIPTOR):
|
54
|
+
# any.Unpack(foo)
|
55
|
+
# ...
|
56
|
+
#
|
57
|
+
# Example 4: Pack and unpack a message in Go
|
58
|
+
#
|
59
|
+
# foo := &pb.Foo{...}
|
60
|
+
# any, err := ptypes.MarshalAny(foo)
|
61
|
+
# ...
|
62
|
+
# foo := &pb.Foo{}
|
63
|
+
# if err := ptypes.UnmarshalAny(any, foo); err != nil {
|
64
|
+
# ...
|
65
|
+
# }
|
66
|
+
#
|
67
|
+
# The pack methods provided by protobuf library will by default use
|
68
|
+
# 'type.googleapis.com/full.type.name' as the type URL and the unpack
|
69
|
+
# methods only use the fully qualified type name after the last '/'
|
70
|
+
# in the type URL, for example "foo.bar.com/x/y.z" will yield type
|
71
|
+
# name "y.z".
|
72
|
+
#
|
73
|
+
#
|
74
|
+
# JSON
|
75
|
+
# ====
|
76
|
+
# The JSON representation of an `Any` value uses the regular
|
77
|
+
# representation of the deserialized, embedded message, with an
|
78
|
+
# additional field `@type` which contains the type URL. Example:
|
79
|
+
#
|
80
|
+
# package google.profile;
|
81
|
+
# message Person {
|
82
|
+
# string first_name = 1;
|
83
|
+
# string last_name = 2;
|
84
|
+
# }
|
85
|
+
#
|
86
|
+
# {
|
87
|
+
# "@type": "type.googleapis.com/google.profile.Person",
|
88
|
+
# "firstName": <string>,
|
89
|
+
# "lastName": <string>
|
90
|
+
# }
|
91
|
+
#
|
92
|
+
# If the embedded message type is well-known and has a custom JSON
|
93
|
+
# representation, that representation will be embedded adding a field
|
94
|
+
# `value` which holds the custom JSON in addition to the `@type`
|
95
|
+
# field. Example (for message [google.protobuf.Duration][]):
|
96
|
+
#
|
97
|
+
# {
|
98
|
+
# "@type": "type.googleapis.com/google.protobuf.Duration",
|
99
|
+
# "value": "1.212s"
|
100
|
+
# }
|
101
|
+
# @!attribute [rw] type_url
|
102
|
+
# @return [::String]
|
103
|
+
# A URL/resource name that uniquely identifies the type of the serialized
|
104
|
+
# protocol buffer message. This string must contain at least
|
105
|
+
# one "/" character. The last segment of the URL's path must represent
|
106
|
+
# the fully qualified name of the type (as in
|
107
|
+
# `path/google.protobuf.Duration`). The name should be in a canonical form
|
108
|
+
# (e.g., leading "." is not accepted).
|
109
|
+
#
|
110
|
+
# In practice, teams usually precompile into the binary all types that they
|
111
|
+
# expect it to use in the context of Any. However, for URLs which use the
|
112
|
+
# scheme `http`, `https`, or no scheme, one can optionally set up a type
|
113
|
+
# server that maps type URLs to message definitions as follows:
|
114
|
+
#
|
115
|
+
# * If no scheme is provided, `https` is assumed.
|
116
|
+
# * An HTTP GET on the URL must yield a [google.protobuf.Type][]
|
117
|
+
# value in binary format, or produce an error.
|
118
|
+
# * Applications are allowed to cache lookup results based on the
|
119
|
+
# URL, or have them precompiled into a binary to avoid any
|
120
|
+
# lookup. Therefore, binary compatibility needs to be preserved
|
121
|
+
# on changes to types. (Use versioned type names to manage
|
122
|
+
# breaking changes.)
|
123
|
+
#
|
124
|
+
# Note: this functionality is not currently available in the official
|
125
|
+
# protobuf release, and it is not used for type URLs beginning with
|
126
|
+
# type.googleapis.com.
|
127
|
+
#
|
128
|
+
# Schemes other than `http`, `https` (or the empty scheme) might be
|
129
|
+
# used with implementation specific semantics.
|
130
|
+
# @!attribute [rw] value
|
131
|
+
# @return [::String]
|
132
|
+
# Must be a valid serialized protocol buffer of the above specified type.
|
133
|
+
class Any
|
134
|
+
include ::Google::Protobuf::MessageExts
|
135
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
136
|
+
end
|
137
|
+
end
|
138
|
+
end
|