google-cloud-spanner 1.6.3 → 1.6.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/LOGGING.md +1 -1
- data/OVERVIEW.md +1 -1
- data/lib/google/cloud/spanner/admin/database/v1/database_admin_client.rb +29 -29
- data/lib/google/cloud/spanner/admin/database/v1/doc/google/iam/v1/iam_policy.rb +13 -13
- data/lib/google/cloud/spanner/admin/database/v1/doc/google/iam/v1/policy.rb +28 -28
- data/lib/google/cloud/spanner/admin/database/v1/doc/google/longrunning/operations.rb +9 -9
- data/lib/google/cloud/spanner/admin/database/v1/doc/google/protobuf/any.rb +8 -8
- data/lib/google/cloud/spanner/admin/database/v1/doc/google/protobuf/empty.rb +1 -1
- data/lib/google/cloud/spanner/admin/database/v1/doc/google/rpc/status.rb +11 -11
- data/lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/spanner_database_admin.rb +21 -21
- data/lib/google/cloud/spanner/admin/database/v1.rb +4 -4
- data/lib/google/cloud/spanner/admin/database.rb +4 -4
- data/lib/google/cloud/spanner/admin/instance/v1/doc/google/iam/v1/iam_policy.rb +13 -13
- data/lib/google/cloud/spanner/admin/instance/v1/doc/google/iam/v1/policy.rb +28 -28
- data/lib/google/cloud/spanner/admin/instance/v1/doc/google/longrunning/operations.rb +9 -9
- data/lib/google/cloud/spanner/admin/instance/v1/doc/google/protobuf/any.rb +8 -8
- data/lib/google/cloud/spanner/admin/instance/v1/doc/google/protobuf/empty.rb +1 -1
- data/lib/google/cloud/spanner/admin/instance/v1/doc/google/protobuf/field_mask.rb +7 -7
- data/lib/google/cloud/spanner/admin/instance/v1/doc/google/rpc/status.rb +11 -11
- data/lib/google/cloud/spanner/admin/instance/v1/doc/google/spanner/admin/instance/v1/spanner_instance_admin.rb +30 -30
- data/lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb +44 -44
- data/lib/google/cloud/spanner/admin/instance/v1.rb +4 -4
- data/lib/google/cloud/spanner/admin/instance.rb +4 -4
- data/lib/google/cloud/spanner/v1/doc/google/protobuf/duration.rb +3 -3
- data/lib/google/cloud/spanner/v1/doc/google/protobuf/empty.rb +1 -1
- data/lib/google/cloud/spanner/v1/doc/google/protobuf/struct.rb +11 -11
- data/lib/google/cloud/spanner/v1/doc/google/protobuf/timestamp.rb +7 -7
- data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/keys.rb +19 -19
- data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/mutation.rb +6 -6
- data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/query_plan.rb +11 -11
- data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/result_set.rb +33 -19
- data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb +65 -39
- data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/transaction.rb +91 -21
- data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/type.rb +25 -25
- data/lib/google/cloud/spanner/v1/spanner_client.rb +139 -79
- data/lib/google/cloud/spanner/version.rb +1 -1
- data/lib/google/spanner/admin/database/v1/spanner_database_admin_services_pb.rb +1 -1
- data/lib/google/spanner/admin/instance/v1/spanner_instance_admin_services_pb.rb +1 -1
- data/lib/google/spanner/v1/result_set_pb.rb +4 -0
- data/lib/google/spanner/v1/spanner_pb.rb +1 -0
- data/lib/google/spanner/v1/spanner_services_pb.rb +14 -6
- data/lib/google/spanner/v1/transaction_pb.rb +4 -0
- data/lib/google-cloud-spanner.rb +1 -1
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 7a7e4d511e0da87129eb3b33152dda498583baf5832222808867822a7097d79a
|
4
|
+
data.tar.gz: 18ada9b93ec395b625c1439a90a2968c495c62eb1fdee3f1ecbbcae79c33f329
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 50c14a7f74a351318c61fe1ad2b2342231f8997db010c5793d5d0112e4e545399476c2a2ab3aa3b0505cdef63430d710d864346bca611be19a78861af82a04d0
|
7
|
+
data.tar.gz: d244fd5a527e3759536e797bee8354a7263898a5ac6bd7941d4815c02de432d4b83ef72dbe81cd8fbd7c4d259b59b21bc70311d9e81b5f7ed62ea3d5ee8da9ec
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,13 @@
|
|
1
1
|
# Release History
|
2
2
|
|
3
|
+
### 1.6.4 / 2018-09-20
|
4
|
+
|
5
|
+
* Update Spanner generated files.
|
6
|
+
* Add DML/PDML code structures.
|
7
|
+
* Update documentation.
|
8
|
+
* Change documentation URL to googleapis GitHub org.
|
9
|
+
* Fix circular require warning.
|
10
|
+
|
3
11
|
### 1.6.3 / 2018-09-12
|
4
12
|
|
5
13
|
* Add missing documentation files to package.
|
data/LOGGING.md
CHANGED
@@ -5,7 +5,7 @@ To enable logging for this library, set the logger for the underlying
|
|
5
5
|
that you set may be a Ruby stdlib
|
6
6
|
[`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as
|
7
7
|
shown below, or a
|
8
|
-
[`Google::Cloud::Logging::Logger`](https://
|
8
|
+
[`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/docs/google-cloud-logging/latest/Google/Cloud/Logging/Logger)
|
9
9
|
that will write logs to [Stackdriver
|
10
10
|
Logging](https://cloud.google.com/logging/). See
|
11
11
|
[grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
|
data/OVERVIEW.md
CHANGED
@@ -21,7 +21,7 @@ When you first use Cloud Spanner, you must create an instance, which is an
|
|
21
21
|
allocation of resources that are used by Cloud Spanner databases. When you
|
22
22
|
create an instance, you choose where your data is stored and how many nodes are
|
23
23
|
used for your data. (For more information, see [Configuration
|
24
|
-
Guide](https://
|
24
|
+
Guide](https://googleapis.github.io/google-cloud-ruby/docs/stackdriver/latest/file.INSTRUMENTATION_CONFIGURATION)).
|
25
25
|
|
26
26
|
Use {Google::Cloud::Spanner::Project#create_instance Project#create_instance} to
|
27
27
|
create an instance:
|
@@ -282,7 +282,7 @@ module Google
|
|
282
282
|
#
|
283
283
|
# @param parent [String]
|
284
284
|
# Required. The instance whose databases should be listed.
|
285
|
-
# Values are of the form
|
285
|
+
# Values are of the form `projects/<project>/instances/<instance>`.
|
286
286
|
# @param page_size [Integer]
|
287
287
|
# The maximum number of resources contained in the underlying API
|
288
288
|
# response. If page streaming is performed per-resource, this
|
@@ -335,7 +335,7 @@ module Google
|
|
335
335
|
|
336
336
|
# Creates a new Cloud Spanner database and starts to prepare it for serving.
|
337
337
|
# The returned {Google::Longrunning::Operation long-running operation} will
|
338
|
-
# have a name of the format
|
338
|
+
# have a name of the format `<database_name>/operations/<operation_id>` and
|
339
339
|
# can be used to track preparation of the database. The
|
340
340
|
# {Google::Longrunning::Operation#metadata metadata} field type is
|
341
341
|
# {Google::Spanner::Admin::Database::V1::CreateDatabaseMetadata CreateDatabaseMetadata}. The
|
@@ -344,13 +344,13 @@ module Google
|
|
344
344
|
#
|
345
345
|
# @param parent [String]
|
346
346
|
# Required. The name of the instance that will serve the new database.
|
347
|
-
# Values are of the form
|
347
|
+
# Values are of the form `projects/<project>/instances/<instance>`.
|
348
348
|
# @param create_statement [String]
|
349
|
-
# Required. A
|
349
|
+
# Required. A `CREATE DATABASE` statement, which specifies the ID of the
|
350
350
|
# new database. The database ID must conform to the regular expression
|
351
|
-
#
|
351
|
+
# `[a-z][a-z0-9_\-]*[a-z0-9]` and be between 2 and 30 characters in length.
|
352
352
|
# If the database ID is a reserved word or if it contains a hyphen, the
|
353
|
-
# database ID must be enclosed in backticks (
|
353
|
+
# database ID must be enclosed in backticks (`` ` ``).
|
354
354
|
# @param extra_statements [Array<String>]
|
355
355
|
# An optional list of DDL statements to run inside the newly created
|
356
356
|
# database. Statements can create tables, indexes, etc. These
|
@@ -367,7 +367,7 @@ module Google
|
|
367
367
|
# database_admin_client = Google::Cloud::Spanner::Admin::Database.new(version: :v1)
|
368
368
|
# formatted_parent = Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdminClient.instance_path("[PROJECT]", "[INSTANCE]")
|
369
369
|
#
|
370
|
-
# # TODO: Initialize
|
370
|
+
# # TODO: Initialize `create_statement`:
|
371
371
|
# create_statement = ''
|
372
372
|
#
|
373
373
|
# # Register a callback during the method call.
|
@@ -423,7 +423,7 @@ module Google
|
|
423
423
|
#
|
424
424
|
# @param name [String]
|
425
425
|
# Required. The name of the requested database. Values are of the form
|
426
|
-
#
|
426
|
+
# `projects/<project>/instances/<instance>/databases/<database>`.
|
427
427
|
# @param options [Google::Gax::CallOptions]
|
428
428
|
# Overrides the default settings for this call, e.g, timeout,
|
429
429
|
# retries, etc.
|
@@ -453,7 +453,7 @@ module Google
|
|
453
453
|
# Updates the schema of a Cloud Spanner database by
|
454
454
|
# creating/altering/dropping tables, columns, indexes, etc. The returned
|
455
455
|
# {Google::Longrunning::Operation long-running operation} will have a name of
|
456
|
-
# the format
|
456
|
+
# the format `<database_name>/operations/<operation_id>` and can be used to
|
457
457
|
# track execution of the schema change(s). The
|
458
458
|
# {Google::Longrunning::Operation#metadata metadata} field type is
|
459
459
|
# {Google::Spanner::Admin::Database::V1::UpdateDatabaseDdlMetadata UpdateDatabaseDdlMetadata}. The operation has no response.
|
@@ -464,7 +464,7 @@ module Google
|
|
464
464
|
# DDL statements to be applied to the database.
|
465
465
|
# @param operation_id [String]
|
466
466
|
# If empty, the new update request is assigned an
|
467
|
-
# automatically-generated operation ID. Otherwise,
|
467
|
+
# automatically-generated operation ID. Otherwise, `operation_id`
|
468
468
|
# is used to construct the name of the resulting
|
469
469
|
# {Google::Longrunning::Operation Operation}.
|
470
470
|
#
|
@@ -472,16 +472,16 @@ module Google
|
|
472
472
|
# whether the statements were executed in the event that the
|
473
473
|
# {Google::Spanner::Admin::Database::V1::DatabaseAdmin::UpdateDatabaseDdl UpdateDatabaseDdl} call is replayed,
|
474
474
|
# or the return value is otherwise lost: the {Google::Spanner::Admin::Database::V1::UpdateDatabaseDdlRequest#database database} and
|
475
|
-
#
|
475
|
+
# `operation_id` fields can be combined to form the
|
476
476
|
# {Google::Longrunning::Operation#name name} of the resulting
|
477
|
-
# {Google::Longrunning::Operation longrunning::Operation}:
|
477
|
+
# {Google::Longrunning::Operation longrunning::Operation}: `<database>/operations/<operation_id>`.
|
478
478
|
#
|
479
|
-
#
|
480
|
-
# a valid identifier:
|
479
|
+
# `operation_id` should be unique within the database, and must be
|
480
|
+
# a valid identifier: `[a-z][a-z0-9_]*`. Note that
|
481
481
|
# automatically-generated operation IDs always begin with an
|
482
482
|
# underscore. If the named operation already exists,
|
483
483
|
# {Google::Spanner::Admin::Database::V1::DatabaseAdmin::UpdateDatabaseDdl UpdateDatabaseDdl} returns
|
484
|
-
#
|
484
|
+
# `ALREADY_EXISTS`.
|
485
485
|
# @param options [Google::Gax::CallOptions]
|
486
486
|
# Overrides the default settings for this call, e.g, timeout,
|
487
487
|
# retries, etc.
|
@@ -493,7 +493,7 @@ module Google
|
|
493
493
|
# database_admin_client = Google::Cloud::Spanner::Admin::Database.new(version: :v1)
|
494
494
|
# formatted_database = Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdminClient.database_path("[PROJECT]", "[INSTANCE]", "[DATABASE]")
|
495
495
|
#
|
496
|
-
# # TODO: Initialize
|
496
|
+
# # TODO: Initialize `statements`:
|
497
497
|
# statements = []
|
498
498
|
#
|
499
499
|
# # Register a callback during the method call.
|
@@ -610,15 +610,15 @@ module Google
|
|
610
610
|
# Sets the access control policy on a database resource. Replaces any
|
611
611
|
# existing policy.
|
612
612
|
#
|
613
|
-
# Authorization requires
|
613
|
+
# Authorization requires `spanner.databases.setIamPolicy` permission on
|
614
614
|
# {Google::Iam::V1::SetIamPolicyRequest#resource resource}.
|
615
615
|
#
|
616
616
|
# @param resource [String]
|
617
617
|
# REQUIRED: The resource for which the policy is being specified.
|
618
|
-
#
|
619
|
-
# resource is specified as
|
618
|
+
# `resource` is usually specified as a path. For example, a Project
|
619
|
+
# resource is specified as `projects/{project}`.
|
620
620
|
# @param policy [Google::Iam::V1::Policy | Hash]
|
621
|
-
# REQUIRED: The complete policy to be applied to the
|
621
|
+
# REQUIRED: The complete policy to be applied to the `resource`. The size of
|
622
622
|
# the policy is limited to a few 10s of KB. An empty policy is a
|
623
623
|
# valid policy but certain Cloud Platform services (such as Projects)
|
624
624
|
# might reject them.
|
@@ -638,7 +638,7 @@ module Google
|
|
638
638
|
# database_admin_client = Google::Cloud::Spanner::Admin::Database.new(version: :v1)
|
639
639
|
# formatted_resource = Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdminClient.database_path("[PROJECT]", "[INSTANCE]", "[DATABASE]")
|
640
640
|
#
|
641
|
-
# # TODO: Initialize
|
641
|
+
# # TODO: Initialize `policy`:
|
642
642
|
# policy = {}
|
643
643
|
# response = database_admin_client.set_iam_policy(formatted_resource, policy)
|
644
644
|
|
@@ -658,13 +658,13 @@ module Google
|
|
658
658
|
# Gets the access control policy for a database resource. Returns an empty
|
659
659
|
# policy if a database exists but does not have a policy set.
|
660
660
|
#
|
661
|
-
# Authorization requires
|
661
|
+
# Authorization requires `spanner.databases.getIamPolicy` permission on
|
662
662
|
# {Google::Iam::V1::GetIamPolicyRequest#resource resource}.
|
663
663
|
#
|
664
664
|
# @param resource [String]
|
665
665
|
# REQUIRED: The resource for which the policy is being requested.
|
666
|
-
#
|
667
|
-
# resource is specified as
|
666
|
+
# `resource` is usually specified as a path. For example, a Project
|
667
|
+
# resource is specified as `projects/{project}`.
|
668
668
|
# @param options [Google::Gax::CallOptions]
|
669
669
|
# Overrides the default settings for this call, e.g, timeout,
|
670
670
|
# retries, etc.
|
@@ -694,16 +694,16 @@ module Google
|
|
694
694
|
# Returns permissions that the caller has on the specified database resource.
|
695
695
|
#
|
696
696
|
# Attempting this RPC on a non-existent Cloud Spanner database will result in
|
697
|
-
# a NOT_FOUND error if the user has
|
697
|
+
# a NOT_FOUND error if the user has `spanner.databases.list` permission on
|
698
698
|
# the containing Cloud Spanner instance. Otherwise returns an empty set of
|
699
699
|
# permissions.
|
700
700
|
#
|
701
701
|
# @param resource [String]
|
702
702
|
# REQUIRED: The resource for which the policy detail is being requested.
|
703
|
-
#
|
704
|
-
# resource is specified as
|
703
|
+
# `resource` is usually specified as a path. For example, a Project
|
704
|
+
# resource is specified as `projects/{project}`.
|
705
705
|
# @param permissions [Array<String>]
|
706
|
-
# The set of permissions to check for the
|
706
|
+
# The set of permissions to check for the `resource`. Permissions with
|
707
707
|
# wildcards (such as '*' or 'storage.*') are not allowed. For more
|
708
708
|
# information see
|
709
709
|
# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
|
@@ -721,7 +721,7 @@ module Google
|
|
721
721
|
# database_admin_client = Google::Cloud::Spanner::Admin::Database.new(version: :v1)
|
722
722
|
# formatted_resource = Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdminClient.database_path("[PROJECT]", "[INSTANCE]", "[DATABASE]")
|
723
723
|
#
|
724
|
-
# # TODO: Initialize
|
724
|
+
# # TODO: Initialize `permissions`:
|
725
725
|
# permissions = []
|
726
726
|
# response = database_admin_client.test_iam_permissions(formatted_resource, permissions)
|
727
727
|
|
@@ -16,46 +16,46 @@
|
|
16
16
|
module Google
|
17
17
|
module Iam
|
18
18
|
module V1
|
19
|
-
# Request message for
|
19
|
+
# Request message for `SetIamPolicy` method.
|
20
20
|
# @!attribute [rw] resource
|
21
21
|
# @return [String]
|
22
22
|
# REQUIRED: The resource for which the policy is being specified.
|
23
|
-
#
|
24
|
-
# resource is specified as
|
23
|
+
# `resource` is usually specified as a path. For example, a Project
|
24
|
+
# resource is specified as `projects/{project}`.
|
25
25
|
# @!attribute [rw] policy
|
26
26
|
# @return [Google::Iam::V1::Policy]
|
27
|
-
# REQUIRED: The complete policy to be applied to the
|
27
|
+
# REQUIRED: The complete policy to be applied to the `resource`. The size of
|
28
28
|
# the policy is limited to a few 10s of KB. An empty policy is a
|
29
29
|
# valid policy but certain Cloud Platform services (such as Projects)
|
30
30
|
# might reject them.
|
31
31
|
class SetIamPolicyRequest; end
|
32
32
|
|
33
|
-
# Request message for
|
33
|
+
# Request message for `GetIamPolicy` method.
|
34
34
|
# @!attribute [rw] resource
|
35
35
|
# @return [String]
|
36
36
|
# REQUIRED: The resource for which the policy is being requested.
|
37
|
-
#
|
38
|
-
# resource is specified as
|
37
|
+
# `resource` is usually specified as a path. For example, a Project
|
38
|
+
# resource is specified as `projects/{project}`.
|
39
39
|
class GetIamPolicyRequest; end
|
40
40
|
|
41
|
-
# Request message for
|
41
|
+
# Request message for `TestIamPermissions` method.
|
42
42
|
# @!attribute [rw] resource
|
43
43
|
# @return [String]
|
44
44
|
# REQUIRED: The resource for which the policy detail is being requested.
|
45
|
-
#
|
46
|
-
# resource is specified as
|
45
|
+
# `resource` is usually specified as a path. For example, a Project
|
46
|
+
# resource is specified as `projects/{project}`.
|
47
47
|
# @!attribute [rw] permissions
|
48
48
|
# @return [Array<String>]
|
49
|
-
# The set of permissions to check for the
|
49
|
+
# The set of permissions to check for the `resource`. Permissions with
|
50
50
|
# wildcards (such as '*' or 'storage.*') are not allowed. For more
|
51
51
|
# information see
|
52
52
|
# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
|
53
53
|
class TestIamPermissionsRequest; end
|
54
54
|
|
55
|
-
# Response message for
|
55
|
+
# Response message for `TestIamPermissions` method.
|
56
56
|
# @!attribute [rw] permissions
|
57
57
|
# @return [Array<String>]
|
58
|
-
# A subset of
|
58
|
+
# A subset of `TestPermissionsRequest.permissions` that the caller is
|
59
59
|
# allowed.
|
60
60
|
class TestIamPermissionsResponse; end
|
61
61
|
end
|
@@ -20,9 +20,9 @@ module Google
|
|
20
20
|
# specify access control policies for Cloud Platform resources.
|
21
21
|
#
|
22
22
|
#
|
23
|
-
# A
|
24
|
-
#
|
25
|
-
# Google domains, and service accounts. A
|
23
|
+
# A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
|
24
|
+
# `members` to a `role`, where the members can be user accounts, Google groups,
|
25
|
+
# Google domains, and service accounts. A `role` is a named list of permissions
|
26
26
|
# defined by IAM.
|
27
27
|
#
|
28
28
|
# **Example**
|
@@ -49,55 +49,55 @@ module Google
|
|
49
49
|
# [IAM developer's guide](https://cloud.google.com/iam).
|
50
50
|
# @!attribute [rw] version
|
51
51
|
# @return [Integer]
|
52
|
-
# Version of the
|
52
|
+
# Version of the `Policy`. The default version is 0.
|
53
53
|
# @!attribute [rw] bindings
|
54
54
|
# @return [Array<Google::Iam::V1::Binding>]
|
55
|
-
# Associates a list of
|
56
|
-
# Multiple
|
57
|
-
#
|
55
|
+
# Associates a list of `members` to a `role`.
|
56
|
+
# Multiple `bindings` must not be specified for the same `role`.
|
57
|
+
# `bindings` with no members will result in an error.
|
58
58
|
# @!attribute [rw] etag
|
59
59
|
# @return [String]
|
60
|
-
#
|
60
|
+
# `etag` is used for optimistic concurrency control as a way to help
|
61
61
|
# prevent simultaneous updates of a policy from overwriting each other.
|
62
|
-
# It is strongly suggested that systems make use of the
|
62
|
+
# It is strongly suggested that systems make use of the `etag` in the
|
63
63
|
# read-modify-write cycle to perform policy updates in order to avoid race
|
64
|
-
# conditions: An
|
65
|
-
# systems are expected to put that etag in the request to
|
64
|
+
# conditions: An `etag` is returned in the response to `getIamPolicy`, and
|
65
|
+
# systems are expected to put that etag in the request to `setIamPolicy` to
|
66
66
|
# ensure that their change will be applied to the same version of the policy.
|
67
67
|
#
|
68
|
-
# If no
|
68
|
+
# If no `etag` is provided in the call to `setIamPolicy`, then the existing
|
69
69
|
# policy is overwritten blindly.
|
70
70
|
class Policy; end
|
71
71
|
|
72
|
-
# Associates
|
72
|
+
# Associates `members` with a `role`.
|
73
73
|
# @!attribute [rw] role
|
74
74
|
# @return [String]
|
75
|
-
# Role that is assigned to
|
76
|
-
# For example,
|
75
|
+
# Role that is assigned to `members`.
|
76
|
+
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
|
77
77
|
# Required
|
78
78
|
# @!attribute [rw] members
|
79
79
|
# @return [Array<String>]
|
80
80
|
# Specifies the identities requesting access for a Cloud Platform resource.
|
81
|
-
#
|
81
|
+
# `members` can have the following values:
|
82
82
|
#
|
83
|
-
# *
|
83
|
+
# * `allUsers`: A special identifier that represents anyone who is
|
84
84
|
# on the internet; with or without a Google account.
|
85
85
|
#
|
86
|
-
# *
|
86
|
+
# * `allAuthenticatedUsers`: A special identifier that represents anyone
|
87
87
|
# who is authenticated with a Google account or a service account.
|
88
88
|
#
|
89
|
-
# *
|
90
|
-
# account. For example,
|
89
|
+
# * `user:{emailid}`: An email address that represents a specific Google
|
90
|
+
# account. For example, `alice@gmail.com` or `joe@example.com`.
|
91
91
|
#
|
92
92
|
#
|
93
|
-
# *
|
94
|
-
# account. For example,
|
93
|
+
# * `serviceAccount:{emailid}`: An email address that represents a service
|
94
|
+
# account. For example, `my-other-app@appspot.gserviceaccount.com`.
|
95
95
|
#
|
96
|
-
# *
|
97
|
-
# For example,
|
96
|
+
# * `group:{emailid}`: An email address that represents a Google group.
|
97
|
+
# For example, `admins@example.com`.
|
98
98
|
#
|
99
|
-
# *
|
100
|
-
# users of that domain. For example,
|
99
|
+
# * `domain:{domain}`: A Google Apps domain name that represents all the
|
100
|
+
# users of that domain. For example, `google.com` or `example.com`.
|
101
101
|
class Binding; end
|
102
102
|
|
103
103
|
# The difference delta between two policies.
|
@@ -114,8 +114,8 @@ module Google
|
|
114
114
|
# Required
|
115
115
|
# @!attribute [rw] role
|
116
116
|
# @return [String]
|
117
|
-
# Role that is assigned to
|
118
|
-
# For example,
|
117
|
+
# Role that is assigned to `members`.
|
118
|
+
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
|
119
119
|
# Required
|
120
120
|
# @!attribute [rw] member
|
121
121
|
# @return [String]
|
@@ -21,7 +21,7 @@ module Google
|
|
21
21
|
# @return [String]
|
22
22
|
# The server-assigned name, which is only unique within the same service that
|
23
23
|
# originally returns it. If you use the default HTTP mapping, the
|
24
|
-
#
|
24
|
+
# `name` should have the format of `operations/some/unique/name`.
|
25
25
|
# @!attribute [rw] metadata
|
26
26
|
# @return [Google::Protobuf::Any]
|
27
27
|
# Service-specific metadata associated with the operation. It typically
|
@@ -30,8 +30,8 @@ module Google
|
|
30
30
|
# long-running operation should document the metadata type, if any.
|
31
31
|
# @!attribute [rw] done
|
32
32
|
# @return [true, false]
|
33
|
-
# If the value is
|
34
|
-
# If true, the operation is completed, and either
|
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
35
|
# available.
|
36
36
|
# @!attribute [rw] error
|
37
37
|
# @return [Google::Rpc::Status]
|
@@ -39,13 +39,13 @@ module Google
|
|
39
39
|
# @!attribute [rw] response
|
40
40
|
# @return [Google::Protobuf::Any]
|
41
41
|
# The normal response of the operation in case of success. If the original
|
42
|
-
# method returns no data on success, such as
|
43
|
-
#
|
44
|
-
#
|
45
|
-
# methods, the response should have the type
|
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
46
|
# is the original method name. For example, if the original method name
|
47
|
-
# is
|
48
|
-
#
|
47
|
+
# is `TakeSnapshot()`, the inferred response type is
|
48
|
+
# `TakeSnapshotResponse`.
|
49
49
|
class Operation; end
|
50
50
|
|
51
51
|
# The request message for {Google::Longrunning::Operations::GetOperation Operations::GetOperation}.
|
@@ -15,7 +15,7 @@
|
|
15
15
|
|
16
16
|
module Google
|
17
17
|
module Protobuf
|
18
|
-
#
|
18
|
+
# `Any` contains an arbitrary serialized protocol buffer message along with a
|
19
19
|
# URL that describes the type of the serialized message.
|
20
20
|
#
|
21
21
|
# Protobuf library provides support to pack/unpack Any values in the form
|
@@ -69,9 +69,9 @@ module Google
|
|
69
69
|
#
|
70
70
|
# = JSON
|
71
71
|
#
|
72
|
-
# The JSON representation of an
|
72
|
+
# The JSON representation of an `Any` value uses the regular
|
73
73
|
# representation of the deserialized, embedded message, with an
|
74
|
-
# additional field
|
74
|
+
# additional field `@type` which contains the type URL. Example:
|
75
75
|
#
|
76
76
|
# package google.profile;
|
77
77
|
# message Person {
|
@@ -87,7 +87,7 @@ module Google
|
|
87
87
|
#
|
88
88
|
# If the embedded message type is well-known and has a custom JSON
|
89
89
|
# representation, that representation will be embedded adding a field
|
90
|
-
#
|
90
|
+
# `value` which holds the custom JSON in addition to the `@type`
|
91
91
|
# field. Example (for message {Google::Protobuf::Duration}):
|
92
92
|
#
|
93
93
|
# {
|
@@ -99,15 +99,15 @@ module Google
|
|
99
99
|
# A URL/resource name that uniquely identifies the type of the serialized
|
100
100
|
# protocol buffer message. The last segment of the URL's path must represent
|
101
101
|
# the fully qualified name of the type (as in
|
102
|
-
#
|
102
|
+
# `path/google.protobuf.Duration`). The name should be in a canonical form
|
103
103
|
# (e.g., leading "." is not accepted).
|
104
104
|
#
|
105
105
|
# In practice, teams usually precompile into the binary all types that they
|
106
106
|
# expect it to use in the context of Any. However, for URLs which use the
|
107
|
-
# scheme
|
107
|
+
# scheme `http`, `https`, or no scheme, one can optionally set up a type
|
108
108
|
# server that maps type URLs to message definitions as follows:
|
109
109
|
#
|
110
|
-
# * If no scheme is provided,
|
110
|
+
# * If no scheme is provided, `https` is assumed.
|
111
111
|
# * An HTTP GET on the URL must yield a {Google::Protobuf::Type}
|
112
112
|
# value in binary format, or produce an error.
|
113
113
|
# * Applications are allowed to cache lookup results based on the
|
@@ -120,7 +120,7 @@ module Google
|
|
120
120
|
# protobuf release, and it is not used for type URLs beginning with
|
121
121
|
# type.googleapis.com.
|
122
122
|
#
|
123
|
-
# Schemes other than
|
123
|
+
# Schemes other than `http`, `https` (or the empty scheme) might be
|
124
124
|
# used with implementation specific semantics.
|
125
125
|
# @!attribute [rw] value
|
126
126
|
# @return [String]
|
@@ -23,7 +23,7 @@ module Google
|
|
23
23
|
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
|
24
24
|
# }
|
25
25
|
#
|
26
|
-
# The JSON representation for
|
26
|
+
# The JSON representation for `Empty` is empty JSON object `{}`.
|
27
27
|
class Empty; end
|
28
28
|
end
|
29
29
|
end
|
@@ -15,7 +15,7 @@
|
|
15
15
|
|
16
16
|
module Google
|
17
17
|
module Rpc
|
18
|
-
# The
|
18
|
+
# The `Status` type defines a logical error model that is suitable for different
|
19
19
|
# programming environments, including REST APIs and RPC APIs. It is used by
|
20
20
|
# [gRPC](https://github.com/grpc). The error model is designed to be:
|
21
21
|
#
|
@@ -24,7 +24,7 @@ module Google
|
|
24
24
|
#
|
25
25
|
# = Overview
|
26
26
|
#
|
27
|
-
# The
|
27
|
+
# The `Status` message contains three pieces of data: error code, error message,
|
28
28
|
# and error details. The error code should be an enum value of
|
29
29
|
# {Google::Rpc::Code}, but it may accept additional error codes if needed. The
|
30
30
|
# error message should be a developer-facing English message that helps
|
@@ -32,40 +32,40 @@ module Google
|
|
32
32
|
# error message is needed, put the localized message in the error details or
|
33
33
|
# localize it in the client. The optional error details may contain arbitrary
|
34
34
|
# information about the error. There is a predefined set of error detail types
|
35
|
-
# in the package
|
35
|
+
# in the package `google.rpc` that can be used for common error conditions.
|
36
36
|
#
|
37
37
|
# = Language mapping
|
38
38
|
#
|
39
|
-
# The
|
40
|
-
# is not necessarily the actual wire format. When the
|
39
|
+
# The `Status` message is the logical representation of the error model, but it
|
40
|
+
# is not necessarily the actual wire format. When the `Status` message is
|
41
41
|
# exposed in different client libraries and different wire protocols, it can be
|
42
42
|
# mapped differently. For example, it will likely be mapped to some exceptions
|
43
43
|
# in Java, but more likely mapped to some error codes in C.
|
44
44
|
#
|
45
45
|
# = Other uses
|
46
46
|
#
|
47
|
-
# The error model and the
|
47
|
+
# The error model and the `Status` message can be used in a variety of
|
48
48
|
# environments, either with or without APIs, to provide a
|
49
49
|
# consistent developer experience across different environments.
|
50
50
|
#
|
51
51
|
# Example uses of this error model include:
|
52
52
|
#
|
53
53
|
# * Partial errors. If a service needs to return partial errors to the client,
|
54
|
-
# it may embed the
|
54
|
+
# it may embed the `Status` in the normal response to indicate the partial
|
55
55
|
# errors.
|
56
56
|
#
|
57
57
|
# * Workflow errors. A typical workflow has multiple steps. Each step may
|
58
|
-
# have a
|
58
|
+
# have a `Status` message for error reporting.
|
59
59
|
#
|
60
60
|
# * Batch operations. If a client uses batch request and batch response, the
|
61
|
-
#
|
61
|
+
# `Status` message should be used directly inside batch response, one for
|
62
62
|
# each error sub-response.
|
63
63
|
#
|
64
64
|
# * Asynchronous operations. If an API call embeds asynchronous operation
|
65
65
|
# results in its response, the status of those operations should be
|
66
|
-
# represented directly using the
|
66
|
+
# represented directly using the `Status` message.
|
67
67
|
#
|
68
|
-
# * Logging. If some API errors are stored in logs, the message
|
68
|
+
# * Logging. If some API errors are stored in logs, the message `Status` could
|
69
69
|
# be used directly after any stripping needed for security/privacy reasons.
|
70
70
|
# @!attribute [rw] code
|
71
71
|
# @return [Integer]
|