google-cloud-spanner 1.16.0 → 2.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (106) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +1 -1
  3. data/CHANGELOG.md +54 -0
  4. data/CONTRIBUTING.md +5 -5
  5. data/TROUBLESHOOTING.md +0 -6
  6. data/lib/google-cloud-spanner.rb +11 -13
  7. data/lib/google/cloud/spanner.rb +6 -8
  8. data/lib/google/cloud/spanner/admin/database/credentials.rb +2 -2
  9. data/lib/google/cloud/spanner/admin/instance/credentials.rb +2 -2
  10. data/lib/google/cloud/spanner/backup.rb +1 -1
  11. data/lib/google/cloud/spanner/backup/job.rb +2 -2
  12. data/lib/google/cloud/spanner/backup/job/list.rb +2 -2
  13. data/lib/google/cloud/spanner/backup/list.rb +1 -2
  14. data/lib/google/cloud/spanner/backup/restore/job.rb +2 -2
  15. data/lib/google/cloud/spanner/batch_client.rb +2 -2
  16. data/lib/google/cloud/spanner/batch_snapshot.rb +120 -23
  17. data/lib/google/cloud/spanner/batch_update.rb +1 -1
  18. data/lib/google/cloud/spanner/client.rb +189 -30
  19. data/lib/google/cloud/spanner/commit.rb +14 -14
  20. data/lib/google/cloud/spanner/convert.rb +16 -7
  21. data/lib/google/cloud/spanner/credentials.rb +2 -2
  22. data/lib/google/cloud/spanner/data.rb +2 -2
  23. data/lib/google/cloud/spanner/database.rb +22 -22
  24. data/lib/google/cloud/spanner/database/backup_info.rb +1 -1
  25. data/lib/google/cloud/spanner/database/job.rb +3 -3
  26. data/lib/google/cloud/spanner/database/job/list.rb +2 -2
  27. data/lib/google/cloud/spanner/database/list.rb +1 -1
  28. data/lib/google/cloud/spanner/database/restore_info.rb +1 -1
  29. data/lib/google/cloud/spanner/fields.rb +8 -8
  30. data/lib/google/cloud/spanner/instance.rb +5 -12
  31. data/lib/google/cloud/spanner/instance/config.rb +1 -1
  32. data/lib/google/cloud/spanner/instance/config/list.rb +1 -1
  33. data/lib/google/cloud/spanner/instance/job.rb +2 -2
  34. data/lib/google/cloud/spanner/instance/list.rb +1 -1
  35. data/lib/google/cloud/spanner/partition.rb +4 -4
  36. data/lib/google/cloud/spanner/policy.rb +2 -2
  37. data/lib/google/cloud/spanner/results.rb +103 -24
  38. data/lib/google/cloud/spanner/service.rb +363 -350
  39. data/lib/google/cloud/spanner/session.rb +186 -31
  40. data/lib/google/cloud/spanner/snapshot.rb +60 -6
  41. data/lib/google/cloud/spanner/transaction.rb +116 -10
  42. data/lib/google/cloud/spanner/version.rb +1 -1
  43. metadata +20 -109
  44. data/lib/google/cloud/spanner/admin/database.rb +0 -149
  45. data/lib/google/cloud/spanner/admin/database/v1.rb +0 -147
  46. data/lib/google/cloud/spanner/admin/database/v1/credentials.rb +0 -46
  47. data/lib/google/cloud/spanner/admin/database/v1/database_admin_client.rb +0 -1513
  48. data/lib/google/cloud/spanner/admin/database/v1/database_admin_client_config.json +0 -111
  49. data/lib/google/cloud/spanner/admin/database/v1/doc/google/iam/v1/iam_policy.rb +0 -64
  50. data/lib/google/cloud/spanner/admin/database/v1/doc/google/iam/v1/options.rb +0 -33
  51. data/lib/google/cloud/spanner/admin/database/v1/doc/google/iam/v1/policy.rb +0 -151
  52. data/lib/google/cloud/spanner/admin/database/v1/doc/google/longrunning/operations.rb +0 -51
  53. data/lib/google/cloud/spanner/admin/database/v1/doc/google/protobuf/any.rb +0 -131
  54. data/lib/google/cloud/spanner/admin/database/v1/doc/google/protobuf/empty.rb +0 -29
  55. data/lib/google/cloud/spanner/admin/database/v1/doc/google/protobuf/field_mask.rb +0 -222
  56. data/lib/google/cloud/spanner/admin/database/v1/doc/google/protobuf/timestamp.rb +0 -113
  57. data/lib/google/cloud/spanner/admin/database/v1/doc/google/rpc/status.rb +0 -39
  58. data/lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/backup.rb +0 -325
  59. data/lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/spanner_database_admin.rb +0 -368
  60. data/lib/google/cloud/spanner/admin/database/v1/doc/google/type/expr.rb +0 -45
  61. data/lib/google/cloud/spanner/admin/instance.rb +0 -164
  62. data/lib/google/cloud/spanner/admin/instance/v1.rb +0 -162
  63. data/lib/google/cloud/spanner/admin/instance/v1/credentials.rb +0 -46
  64. data/lib/google/cloud/spanner/admin/instance/v1/doc/google/iam/v1/iam_policy.rb +0 -64
  65. data/lib/google/cloud/spanner/admin/instance/v1/doc/google/iam/v1/options.rb +0 -33
  66. data/lib/google/cloud/spanner/admin/instance/v1/doc/google/iam/v1/policy.rb +0 -151
  67. data/lib/google/cloud/spanner/admin/instance/v1/doc/google/longrunning/operations.rb +0 -51
  68. data/lib/google/cloud/spanner/admin/instance/v1/doc/google/protobuf/any.rb +0 -131
  69. data/lib/google/cloud/spanner/admin/instance/v1/doc/google/protobuf/empty.rb +0 -29
  70. data/lib/google/cloud/spanner/admin/instance/v1/doc/google/protobuf/field_mask.rb +0 -222
  71. data/lib/google/cloud/spanner/admin/instance/v1/doc/google/rpc/status.rb +0 -39
  72. data/lib/google/cloud/spanner/admin/instance/v1/doc/google/spanner/admin/instance/v1/spanner_instance_admin.rb +0 -334
  73. data/lib/google/cloud/spanner/admin/instance/v1/doc/google/type/expr.rb +0 -45
  74. data/lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb +0 -975
  75. data/lib/google/cloud/spanner/admin/instance/v1/instance_admin_client_config.json +0 -76
  76. data/lib/google/cloud/spanner/v1.rb +0 -16
  77. data/lib/google/cloud/spanner/v1/credentials.rb +0 -42
  78. data/lib/google/cloud/spanner/v1/doc/google/protobuf/any.rb +0 -131
  79. data/lib/google/cloud/spanner/v1/doc/google/protobuf/duration.rb +0 -91
  80. data/lib/google/cloud/spanner/v1/doc/google/protobuf/empty.rb +0 -29
  81. data/lib/google/cloud/spanner/v1/doc/google/protobuf/struct.rb +0 -74
  82. data/lib/google/cloud/spanner/v1/doc/google/protobuf/timestamp.rb +0 -113
  83. data/lib/google/cloud/spanner/v1/doc/google/rpc/status.rb +0 -39
  84. data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/keys.rb +0 -150
  85. data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/mutation.rb +0 -95
  86. data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/query_plan.rb +0 -121
  87. data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/result_set.rb +0 -190
  88. data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb +0 -570
  89. data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/transaction.rb +0 -432
  90. data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/type.rb +0 -112
  91. data/lib/google/cloud/spanner/v1/spanner_client.rb +0 -1485
  92. data/lib/google/cloud/spanner/v1/spanner_client_config.json +0 -121
  93. data/lib/google/spanner/admin/database/v1/backup_pb.rb +0 -98
  94. data/lib/google/spanner/admin/database/v1/common_pb.rb +0 -28
  95. data/lib/google/spanner/admin/database/v1/spanner_database_admin_pb.rb +0 -141
  96. data/lib/google/spanner/admin/database/v1/spanner_database_admin_services_pb.rb +0 -169
  97. data/lib/google/spanner/admin/instance/v1/spanner_instance_admin_pb.rb +0 -125
  98. data/lib/google/spanner/admin/instance/v1/spanner_instance_admin_services_pb.rb +0 -181
  99. data/lib/google/spanner/v1/keys_pb.rb +0 -34
  100. data/lib/google/spanner/v1/mutation_pb.rb +0 -39
  101. data/lib/google/spanner/v1/query_plan_pb.rb +0 -48
  102. data/lib/google/spanner/v1/result_set_pb.rb +0 -48
  103. data/lib/google/spanner/v1/spanner_pb.rb +0 -179
  104. data/lib/google/spanner/v1/spanner_services_pb.rb +0 -179
  105. data/lib/google/spanner/v1/transaction_pb.rb +0 -56
  106. data/lib/google/spanner/v1/type_pb.rb +0 -44
@@ -1,111 +0,0 @@
1
- {
2
- "interfaces": {
3
- "google.spanner.admin.database.v1.DatabaseAdmin": {
4
- "retry_codes": {
5
- "idempotent": [
6
- "DEADLINE_EXCEEDED",
7
- "UNAVAILABLE"
8
- ],
9
- "non_idempotent": []
10
- },
11
- "retry_params": {
12
- "default": {
13
- "initial_retry_delay_millis": 1000,
14
- "retry_delay_multiplier": 1.3,
15
- "max_retry_delay_millis": 32000,
16
- "initial_rpc_timeout_millis": 60000,
17
- "rpc_timeout_multiplier": 1.0,
18
- "max_rpc_timeout_millis": 60000,
19
- "total_timeout_millis": 600000
20
- }
21
- },
22
- "methods": {
23
- "ListDatabases": {
24
- "timeout_millis": 30000,
25
- "retry_codes_name": "idempotent",
26
- "retry_params_name": "default"
27
- },
28
- "CreateDatabase": {
29
- "timeout_millis": 3600000,
30
- "retry_codes_name": "non_idempotent",
31
- "retry_params_name": "default"
32
- },
33
- "GetDatabase": {
34
- "timeout_millis": 30000,
35
- "retry_codes_name": "idempotent",
36
- "retry_params_name": "default"
37
- },
38
- "UpdateDatabaseDdl": {
39
- "timeout_millis": 3600000,
40
- "retry_codes_name": "idempotent",
41
- "retry_params_name": "default"
42
- },
43
- "DropDatabase": {
44
- "timeout_millis": 3600000,
45
- "retry_codes_name": "idempotent",
46
- "retry_params_name": "default"
47
- },
48
- "GetDatabaseDdl": {
49
- "timeout_millis": 30000,
50
- "retry_codes_name": "idempotent",
51
- "retry_params_name": "default"
52
- },
53
- "SetIamPolicy": {
54
- "timeout_millis": 30000,
55
- "retry_codes_name": "non_idempotent",
56
- "retry_params_name": "default"
57
- },
58
- "GetIamPolicy": {
59
- "timeout_millis": 30000,
60
- "retry_codes_name": "idempotent",
61
- "retry_params_name": "default"
62
- },
63
- "TestIamPermissions": {
64
- "timeout_millis": 30000,
65
- "retry_codes_name": "non_idempotent",
66
- "retry_params_name": "default"
67
- },
68
- "CreateBackup": {
69
- "timeout_millis": 3600000,
70
- "retry_codes_name": "non_idempotent",
71
- "retry_params_name": "default"
72
- },
73
- "GetBackup": {
74
- "timeout_millis": 30000,
75
- "retry_codes_name": "idempotent",
76
- "retry_params_name": "default"
77
- },
78
- "UpdateBackup": {
79
- "timeout_millis": 3600000,
80
- "retry_codes_name": "non_idempotent",
81
- "retry_params_name": "default"
82
- },
83
- "DeleteBackup": {
84
- "timeout_millis": 3600000,
85
- "retry_codes_name": "idempotent",
86
- "retry_params_name": "default"
87
- },
88
- "ListBackups": {
89
- "timeout_millis": 30000,
90
- "retry_codes_name": "idempotent",
91
- "retry_params_name": "default"
92
- },
93
- "RestoreDatabase": {
94
- "timeout_millis": 3600000,
95
- "retry_codes_name": "non_idempotent",
96
- "retry_params_name": "default"
97
- },
98
- "ListDatabaseOperations": {
99
- "timeout_millis": 30000,
100
- "retry_codes_name": "idempotent",
101
- "retry_params_name": "default"
102
- },
103
- "ListBackupOperations": {
104
- "timeout_millis": 30000,
105
- "retry_codes_name": "idempotent",
106
- "retry_params_name": "default"
107
- }
108
- }
109
- }
110
- }
111
- }
@@ -1,64 +0,0 @@
1
- # Copyright 2020 Google LLC
2
- #
3
- # Licensed under the Apache License, Version 2.0 (the "License");
4
- # you may not use this file except in compliance with the License.
5
- # You may obtain a copy of the License at
6
- #
7
- # https://www.apache.org/licenses/LICENSE-2.0
8
- #
9
- # Unless required by applicable law or agreed to in writing, software
10
- # distributed under the License is distributed on an "AS IS" BASIS,
11
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- # See the License for the specific language governing permissions and
13
- # limitations under the License.
14
-
15
-
16
- module Google
17
- module Iam
18
- module V1
19
- # Request message for `SetIamPolicy` method.
20
- # @!attribute [rw] resource
21
- # @return [String]
22
- # REQUIRED: The resource for which the policy is being specified.
23
- # See the operation documentation for the appropriate value for this field.
24
- # @!attribute [rw] policy
25
- # @return [Google::Iam::V1::Policy]
26
- # REQUIRED: The complete policy to be applied to the `resource`. The size of
27
- # the policy is limited to a few 10s of KB. An empty policy is a
28
- # valid policy but certain Cloud Platform services (such as Projects)
29
- # might reject them.
30
- class SetIamPolicyRequest; end
31
-
32
- # Request message for `GetIamPolicy` method.
33
- # @!attribute [rw] resource
34
- # @return [String]
35
- # REQUIRED: The resource for which the policy is being requested.
36
- # See the operation documentation for the appropriate value for this field.
37
- # @!attribute [rw] options
38
- # @return [Google::Iam::V1::GetPolicyOptions]
39
- # OPTIONAL: A `GetPolicyOptions` object for specifying options to
40
- # `GetIamPolicy`. This field is only used by Cloud IAM.
41
- class GetIamPolicyRequest; end
42
-
43
- # Request message for `TestIamPermissions` method.
44
- # @!attribute [rw] resource
45
- # @return [String]
46
- # REQUIRED: The resource for which the policy detail is being requested.
47
- # See the operation documentation for the appropriate value for this field.
48
- # @!attribute [rw] permissions
49
- # @return [Array<String>]
50
- # The set of permissions to check for the `resource`. Permissions with
51
- # wildcards (such as '*' or 'storage.*') are not allowed. For more
52
- # information see
53
- # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
54
- class TestIamPermissionsRequest; end
55
-
56
- # Response message for `TestIamPermissions` method.
57
- # @!attribute [rw] permissions
58
- # @return [Array<String>]
59
- # A subset of `TestPermissionsRequest.permissions` that the caller is
60
- # allowed.
61
- class TestIamPermissionsResponse; end
62
- end
63
- end
64
- end
@@ -1,33 +0,0 @@
1
- # Copyright 2020 Google LLC
2
- #
3
- # Licensed under the Apache License, Version 2.0 (the "License");
4
- # you may not use this file except in compliance with the License.
5
- # You may obtain a copy of the License at
6
- #
7
- # https://www.apache.org/licenses/LICENSE-2.0
8
- #
9
- # Unless required by applicable law or agreed to in writing, software
10
- # distributed under the License is distributed on an "AS IS" BASIS,
11
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- # See the License for the specific language governing permissions and
13
- # limitations under the License.
14
-
15
-
16
- module Google
17
- module Iam
18
- module V1
19
- # Encapsulates settings provided to GetIamPolicy.
20
- # @!attribute [rw] requested_policy_version
21
- # @return [Integer]
22
- # Optional. The policy format version to be returned.
23
- #
24
- # Valid values are 0, 1, and 3. Requests specifying an invalid value will be
25
- # rejected.
26
- #
27
- # Requests for policies with any conditional bindings must specify version 3.
28
- # Policies without any conditional bindings may specify any valid value or
29
- # leave the field unset.
30
- class GetPolicyOptions; end
31
- end
32
- end
33
- end
@@ -1,151 +0,0 @@
1
- # Copyright 2020 Google LLC
2
- #
3
- # Licensed under the Apache License, Version 2.0 (the "License");
4
- # you may not use this file except in compliance with the License.
5
- # You may obtain a copy of the License at
6
- #
7
- # https://www.apache.org/licenses/LICENSE-2.0
8
- #
9
- # Unless required by applicable law or agreed to in writing, software
10
- # distributed under the License is distributed on an "AS IS" BASIS,
11
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- # See the License for the specific language governing permissions and
13
- # limitations under the License.
14
-
15
-
16
- module Google
17
- module Iam
18
- module V1
19
- # Defines an Identity and Access Management (IAM) policy. It is used to
20
- # specify access control policies for Cloud Platform resources.
21
- #
22
- #
23
- # A `Policy` is a collection of `bindings`. A `binding` binds one or more
24
- # `members` to a single `role`. Members can be user accounts, service accounts,
25
- # Google groups, and domains (such as G Suite). A `role` is a named list of
26
- # permissions (defined by IAM or configured by users). A `binding` can
27
- # optionally specify a `condition`, which is a logic expression that further
28
- # constrains the role binding based on attributes about the request and/or
29
- # target resource.
30
- #
31
- # **JSON Example**
32
- #
33
- # {
34
- # "bindings": [
35
- # {
36
- # "role": "roles/resourcemanager.organizationAdmin",
37
- # "members": [
38
- # "user:mike@example.com",
39
- # "group:admins@example.com",
40
- # "domain:google.com",
41
- # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
42
- # ]
43
- # },
44
- # {
45
- # "role": "roles/resourcemanager.organizationViewer",
46
- # "members": ["user:eve@example.com"],
47
- # "condition": {
48
- # "title": "expirable access",
49
- # "description": "Does not grant access after Sep 2020",
50
- # "expression": "request.time <
51
- # timestamp('2020-10-01T00:00:00.000Z')",
52
- # }
53
- # }
54
- # ]
55
- # }
56
- #
57
- # **YAML Example**
58
- #
59
- # bindings:
60
- # * members:
61
- # * user:mike@example.com
62
- # * group:admins@example.com
63
- # * domain:google.com
64
- # * serviceAccount:my-project-id@appspot.gserviceaccount.com
65
- # role: roles/resourcemanager.organizationAdmin
66
- # * members:
67
- # * user:eve@example.com
68
- # role: roles/resourcemanager.organizationViewer
69
- # condition:
70
- # title: expirable access
71
- # description: Does not grant access after Sep 2020
72
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
73
- #
74
- # For a description of IAM and its features, see the
75
- # [IAM developer's guide](https://cloud.google.com/iam/docs).
76
- # @!attribute [rw] version
77
- # @return [Integer]
78
- # Specifies the format of the policy.
79
- #
80
- # Valid values are 0, 1, and 3. Requests specifying an invalid value will be
81
- # rejected.
82
- #
83
- # Operations affecting conditional bindings must specify version 3. This can
84
- # be either setting a conditional policy, modifying a conditional binding,
85
- # or removing a binding (conditional or unconditional) from the stored
86
- # conditional policy.
87
- # Operations on non-conditional policies may specify any valid value or
88
- # leave the field unset.
89
- #
90
- # If no etag is provided in the call to `setIamPolicy`, version compliance
91
- # checks against the stored policy is skipped.
92
- # @!attribute [rw] bindings
93
- # @return [Array<Google::Iam::V1::Binding>]
94
- # Associates a list of `members` to a `role`. Optionally may specify a
95
- # `condition` that determines when binding is in effect.
96
- # `bindings` with no members will result in an error.
97
- # @!attribute [rw] etag
98
- # @return [String]
99
- # `etag` is used for optimistic concurrency control as a way to help
100
- # prevent simultaneous updates of a policy from overwriting each other.
101
- # It is strongly suggested that systems make use of the `etag` in the
102
- # read-modify-write cycle to perform policy updates in order to avoid race
103
- # conditions: An `etag` is returned in the response to `getIamPolicy`, and
104
- # systems are expected to put that etag in the request to `setIamPolicy` to
105
- # ensure that their change will be applied to the same version of the policy.
106
- #
107
- # If no `etag` is provided in the call to `setIamPolicy`, then the existing
108
- # policy is overwritten. Due to blind-set semantics of an etag-less policy,
109
- # 'setIamPolicy' will not fail even if the incoming policy version does not
110
- # meet the requirements for modifying the stored policy.
111
- class Policy; end
112
-
113
- # Associates `members` with a `role`.
114
- # @!attribute [rw] role
115
- # @return [String]
116
- # Role that is assigned to `members`.
117
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
118
- # @!attribute [rw] members
119
- # @return [Array<String>]
120
- # Specifies the identities requesting access for a Cloud Platform resource.
121
- # `members` can have the following values:
122
- #
123
- # * `allUsers`: A special identifier that represents anyone who is
124
- # on the internet; with or without a Google account.
125
- #
126
- # * `allAuthenticatedUsers`: A special identifier that represents anyone
127
- # who is authenticated with a Google account or a service account.
128
- #
129
- # * `user:{emailid}`: An email address that represents a specific Google
130
- # account. For example, `alice@example.com` .
131
- #
132
- #
133
- # * `serviceAccount:{emailid}`: An email address that represents a service
134
- # account. For example, `my-other-app@appspot.gserviceaccount.com`.
135
- #
136
- # * `group:{emailid}`: An email address that represents a Google group.
137
- # For example, `admins@example.com`.
138
- #
139
- #
140
- # * `domain:{domain}`: The G Suite domain (primary) that represents all the
141
- # users of that domain. For example, `google.com` or `example.com`.
142
- # @!attribute [rw] condition
143
- # @return [Google::Type::Expr]
144
- # The condition that is associated with this binding.
145
- # NOTE: An unsatisfied condition will not allow user access via current
146
- # binding. Different bindings, including their conditions, are examined
147
- # independently.
148
- class Binding; end
149
- end
150
- end
151
- end
@@ -1,51 +0,0 @@
1
- # Copyright 2020 Google LLC
2
- #
3
- # Licensed under the Apache License, Version 2.0 (the "License");
4
- # you may not use this file except in compliance with the License.
5
- # You may obtain a copy of the License at
6
- #
7
- # https://www.apache.org/licenses/LICENSE-2.0
8
- #
9
- # Unless required by applicable law or agreed to in writing, software
10
- # distributed under the License is distributed on an "AS IS" BASIS,
11
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- # See the License for the specific language governing permissions and
13
- # limitations under the License.
14
-
15
-
16
- module Google
17
- module Longrunning
18
- # This resource represents a long-running operation that is the result of a
19
- # network API call.
20
- # @!attribute [rw] name
21
- # @return [String]
22
- # The server-assigned name, which is only unique within the same service that
23
- # originally returns it. If you use the default HTTP mapping, the
24
- # `name` should be a resource name ending with `operations/{unique_id}`.
25
- # @!attribute [rw] metadata
26
- # @return [Google::Protobuf::Any]
27
- # Service-specific metadata associated with the operation. It typically
28
- # contains progress information and common metadata such as create time.
29
- # Some services might not provide such metadata. Any method that returns a
30
- # long-running operation should document the metadata type, if any.
31
- # @!attribute [rw] done
32
- # @return [true, false]
33
- # If the value is `false`, it means the operation is still in progress.
34
- # If `true`, the operation is completed, and either `error` or `response` is
35
- # available.
36
- # @!attribute [rw] error
37
- # @return [Google::Rpc::Status]
38
- # The error result of the operation in case of failure or cancellation.
39
- # @!attribute [rw] response
40
- # @return [Google::Protobuf::Any]
41
- # The normal response of the operation in case of success. If the original
42
- # method returns no data on success, such as `Delete`, the response is
43
- # `google.protobuf.Empty`. If the original method is standard
44
- # `Get`/`Create`/`Update`, the response should be the resource. For other
45
- # methods, the response should have the type `XxxResponse`, where `Xxx`
46
- # is the original method name. For example, if the original method name
47
- # is `TakeSnapshot()`, the inferred response type is
48
- # `TakeSnapshotResponse`.
49
- class Operation; end
50
- end
51
- end
@@ -1,131 +0,0 @@
1
- # Copyright 2020 Google LLC
2
- #
3
- # Licensed under the Apache License, Version 2.0 (the "License");
4
- # you may not use this file except in compliance with the License.
5
- # You may obtain a copy of the License at
6
- #
7
- # https://www.apache.org/licenses/LICENSE-2.0
8
- #
9
- # Unless required by applicable law or agreed to in writing, software
10
- # distributed under the License is distributed on an "AS IS" BASIS,
11
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- # See the License for the specific language governing permissions and
13
- # limitations under the License.
14
-
15
-
16
- module Google
17
- module Protobuf
18
- # `Any` contains an arbitrary serialized protocol buffer message along with a
19
- # URL that describes the type of the serialized message.
20
- #
21
- # Protobuf library provides support to pack/unpack Any values in the form
22
- # of utility functions or additional generated methods of the Any type.
23
- #
24
- # Example 1: Pack and unpack a message in C++.
25
- #
26
- # Foo foo = ...;
27
- # Any any;
28
- # any.PackFrom(foo);
29
- # ...
30
- # if (any.UnpackTo(&foo)) {
31
- # ...
32
- # }
33
- #
34
- # Example 2: Pack and unpack a message in Java.
35
- #
36
- # Foo foo = ...;
37
- # Any any = Any.pack(foo);
38
- # ...
39
- # if (any.is(Foo.class)) {
40
- # foo = any.unpack(Foo.class);
41
- # }
42
- #
43
- # Example 3: Pack and unpack a message in Python.
44
- #
45
- # foo = Foo(...)
46
- # any = Any()
47
- # any.Pack(foo)
48
- # ...
49
- # if any.Is(Foo.DESCRIPTOR):
50
- # any.Unpack(foo)
51
- # ...
52
- #
53
- # Example 4: Pack and unpack a message in Go
54
- #
55
- # foo := &pb.Foo{...}
56
- # any, err := ptypes.MarshalAny(foo)
57
- # ...
58
- # foo := &pb.Foo{}
59
- # if err := ptypes.UnmarshalAny(any, foo); err != nil {
60
- # ...
61
- # }
62
- #
63
- # The pack methods provided by protobuf library will by default use
64
- # 'type.googleapis.com/full.type.name' as the type URL and the unpack
65
- # methods only use the fully qualified type name after the last '/'
66
- # in the type URL, for example "foo.bar.com/x/y.z" will yield type
67
- # name "y.z".
68
- #
69
- #
70
- # = JSON
71
- #
72
- # The JSON representation of an `Any` value uses the regular
73
- # representation of the deserialized, embedded message, with an
74
- # additional field `@type` which contains the type URL. Example:
75
- #
76
- # package google.profile;
77
- # message Person {
78
- # string first_name = 1;
79
- # string last_name = 2;
80
- # }
81
- #
82
- # {
83
- # "@type": "type.googleapis.com/google.profile.Person",
84
- # "firstName": <string>,
85
- # "lastName": <string>
86
- # }
87
- #
88
- # If the embedded message type is well-known and has a custom JSON
89
- # representation, that representation will be embedded adding a field
90
- # `value` which holds the custom JSON in addition to the `@type`
91
- # field. Example (for message {Google::Protobuf::Duration}):
92
- #
93
- # {
94
- # "@type": "type.googleapis.com/google.protobuf.Duration",
95
- # "value": "1.212s"
96
- # }
97
- # @!attribute [rw] type_url
98
- # @return [String]
99
- # A URL/resource name that uniquely identifies the type of the serialized
100
- # protocol buffer message. This string must contain at least
101
- # one "/" character. The last segment of the URL's path must represent
102
- # the fully qualified name of the type (as in
103
- # `path/google.protobuf.Duration`). The name should be in a canonical form
104
- # (e.g., leading "." is not accepted).
105
- #
106
- # In practice, teams usually precompile into the binary all types that they
107
- # expect it to use in the context of Any. However, for URLs which use the
108
- # scheme `http`, `https`, or no scheme, one can optionally set up a type
109
- # server that maps type URLs to message definitions as follows:
110
- #
111
- # * If no scheme is provided, `https` is assumed.
112
- # * An HTTP GET on the URL must yield a {Google::Protobuf::Type}
113
- # value in binary format, or produce an error.
114
- # * Applications are allowed to cache lookup results based on the
115
- # URL, or have them precompiled into a binary to avoid any
116
- # lookup. Therefore, binary compatibility needs to be preserved
117
- # on changes to types. (Use versioned type names to manage
118
- # breaking changes.)
119
- #
120
- # Note: this functionality is not currently available in the official
121
- # protobuf release, and it is not used for type URLs beginning with
122
- # type.googleapis.com.
123
- #
124
- # Schemes other than `http`, `https` (or the empty scheme) might be
125
- # used with implementation specific semantics.
126
- # @!attribute [rw] value
127
- # @return [String]
128
- # Must be a valid serialized protocol buffer of the above specified type.
129
- class Any; end
130
- end
131
- end