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.
Files changed (46) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/LOGGING.md +1 -1
  4. data/OVERVIEW.md +1 -1
  5. data/lib/google/cloud/spanner/admin/database/v1/database_admin_client.rb +29 -29
  6. data/lib/google/cloud/spanner/admin/database/v1/doc/google/iam/v1/iam_policy.rb +13 -13
  7. data/lib/google/cloud/spanner/admin/database/v1/doc/google/iam/v1/policy.rb +28 -28
  8. data/lib/google/cloud/spanner/admin/database/v1/doc/google/longrunning/operations.rb +9 -9
  9. data/lib/google/cloud/spanner/admin/database/v1/doc/google/protobuf/any.rb +8 -8
  10. data/lib/google/cloud/spanner/admin/database/v1/doc/google/protobuf/empty.rb +1 -1
  11. data/lib/google/cloud/spanner/admin/database/v1/doc/google/rpc/status.rb +11 -11
  12. data/lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/spanner_database_admin.rb +21 -21
  13. data/lib/google/cloud/spanner/admin/database/v1.rb +4 -4
  14. data/lib/google/cloud/spanner/admin/database.rb +4 -4
  15. data/lib/google/cloud/spanner/admin/instance/v1/doc/google/iam/v1/iam_policy.rb +13 -13
  16. data/lib/google/cloud/spanner/admin/instance/v1/doc/google/iam/v1/policy.rb +28 -28
  17. data/lib/google/cloud/spanner/admin/instance/v1/doc/google/longrunning/operations.rb +9 -9
  18. data/lib/google/cloud/spanner/admin/instance/v1/doc/google/protobuf/any.rb +8 -8
  19. data/lib/google/cloud/spanner/admin/instance/v1/doc/google/protobuf/empty.rb +1 -1
  20. data/lib/google/cloud/spanner/admin/instance/v1/doc/google/protobuf/field_mask.rb +7 -7
  21. data/lib/google/cloud/spanner/admin/instance/v1/doc/google/rpc/status.rb +11 -11
  22. data/lib/google/cloud/spanner/admin/instance/v1/doc/google/spanner/admin/instance/v1/spanner_instance_admin.rb +30 -30
  23. data/lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb +44 -44
  24. data/lib/google/cloud/spanner/admin/instance/v1.rb +4 -4
  25. data/lib/google/cloud/spanner/admin/instance.rb +4 -4
  26. data/lib/google/cloud/spanner/v1/doc/google/protobuf/duration.rb +3 -3
  27. data/lib/google/cloud/spanner/v1/doc/google/protobuf/empty.rb +1 -1
  28. data/lib/google/cloud/spanner/v1/doc/google/protobuf/struct.rb +11 -11
  29. data/lib/google/cloud/spanner/v1/doc/google/protobuf/timestamp.rb +7 -7
  30. data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/keys.rb +19 -19
  31. data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/mutation.rb +6 -6
  32. data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/query_plan.rb +11 -11
  33. data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/result_set.rb +33 -19
  34. data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb +65 -39
  35. data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/transaction.rb +91 -21
  36. data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/type.rb +25 -25
  37. data/lib/google/cloud/spanner/v1/spanner_client.rb +139 -79
  38. data/lib/google/cloud/spanner/version.rb +1 -1
  39. data/lib/google/spanner/admin/database/v1/spanner_database_admin_services_pb.rb +1 -1
  40. data/lib/google/spanner/admin/instance/v1/spanner_instance_admin_services_pb.rb +1 -1
  41. data/lib/google/spanner/v1/result_set_pb.rb +4 -0
  42. data/lib/google/spanner/v1/spanner_pb.rb +1 -0
  43. data/lib/google/spanner/v1/spanner_services_pb.rb +14 -6
  44. data/lib/google/spanner/v1/transaction_pb.rb +4 -0
  45. data/lib/google-cloud-spanner.rb +1 -1
  46. metadata +3 -3
@@ -22,8 +22,8 @@ module Google
22
22
  # @!attribute [rw] name
23
23
  # @return [String]
24
24
  # Required. The name of the database. Values are of the form
25
- # +projects/<project>/instances/<instance>/databases/<database>+,
26
- # where +<database>+ is as specified in the +CREATE DATABASE+
25
+ # `projects/<project>/instances/<instance>/databases/<database>`,
26
+ # where `<database>` is as specified in the `CREATE DATABASE`
27
27
  # statement. This name can be passed to other API methods to
28
28
  # identify the database.
29
29
  # @!attribute [rw] state
@@ -36,7 +36,7 @@ module Google
36
36
  STATE_UNSPECIFIED = 0
37
37
 
38
38
  # The database is still being created. Operations on the database may fail
39
- # with +FAILED_PRECONDITION+ in this state.
39
+ # with `FAILED_PRECONDITION` in this state.
40
40
  CREATING = 1
41
41
 
42
42
  # The database is fully created and ready for use.
@@ -48,14 +48,14 @@ module Google
48
48
  # @!attribute [rw] parent
49
49
  # @return [String]
50
50
  # Required. The instance whose databases should be listed.
51
- # Values are of the form +projects/<project>/instances/<instance>+.
51
+ # Values are of the form `projects/<project>/instances/<instance>`.
52
52
  # @!attribute [rw] page_size
53
53
  # @return [Integer]
54
54
  # Number of databases to be returned in the response. If 0 or less,
55
55
  # defaults to the server's maximum allowed page size.
56
56
  # @!attribute [rw] page_token
57
57
  # @return [String]
58
- # If non-empty, +page_token+ should contain a
58
+ # If non-empty, `page_token` should contain a
59
59
  # {Google::Spanner::Admin::Database::V1::ListDatabasesResponse#next_page_token next_page_token} from a
60
60
  # previous {Google::Spanner::Admin::Database::V1::ListDatabasesResponse ListDatabasesResponse}.
61
61
  class ListDatabasesRequest; end
@@ -66,7 +66,7 @@ module Google
66
66
  # Databases that matched the request.
67
67
  # @!attribute [rw] next_page_token
68
68
  # @return [String]
69
- # +next_page_token+ can be sent in a subsequent
69
+ # `next_page_token` can be sent in a subsequent
70
70
  # {Google::Spanner::Admin::Database::V1::DatabaseAdmin::ListDatabases ListDatabases} call to fetch more
71
71
  # of the matching databases.
72
72
  class ListDatabasesResponse; end
@@ -75,14 +75,14 @@ module Google
75
75
  # @!attribute [rw] parent
76
76
  # @return [String]
77
77
  # Required. The name of the instance that will serve the new database.
78
- # Values are of the form +projects/<project>/instances/<instance>+.
78
+ # Values are of the form `projects/<project>/instances/<instance>`.
79
79
  # @!attribute [rw] create_statement
80
80
  # @return [String]
81
- # Required. A +CREATE DATABASE+ statement, which specifies the ID of the
81
+ # Required. A `CREATE DATABASE` statement, which specifies the ID of the
82
82
  # new database. The database ID must conform to the regular expression
83
- # +[a-z][a-z0-9_\-]*[a-z0-9]+ and be between 2 and 30 characters in length.
83
+ # `[a-z][a-z0-9_\-]*[a-z0-9]` and be between 2 and 30 characters in length.
84
84
  # If the database ID is a reserved word or if it contains a hyphen, the
85
- # database ID must be enclosed in backticks (+ + +).
85
+ # database ID must be enclosed in backticks (`` ` ``).
86
86
  # @!attribute [rw] extra_statements
87
87
  # @return [Array<String>]
88
88
  # An optional list of DDL statements to run inside the newly created
@@ -102,7 +102,7 @@ module Google
102
102
  # @!attribute [rw] name
103
103
  # @return [String]
104
104
  # Required. The name of the requested database. Values are of the form
105
- # +projects/<project>/instances/<instance>/databases/<database>+.
105
+ # `projects/<project>/instances/<instance>/databases/<database>`.
106
106
  class GetDatabaseRequest; end
107
107
 
108
108
  # Enqueues the given DDL statements to be applied, in order but not
@@ -112,8 +112,8 @@ module Google
112
112
  # before enqueueing them, but they may still fail upon
113
113
  # later execution (e.g., if a statement from another batch of
114
114
  # statements is applied first and it conflicts in some way, or if
115
- # there is some data-related problem like a +NULL+ value in a column to
116
- # which +NOT NULL+ would be added). If a statement fails, all
115
+ # there is some data-related problem like a `NULL` value in a column to
116
+ # which `NOT NULL` would be added). If a statement fails, all
117
117
  # subsequent statements in the batch are automatically cancelled.
118
118
  #
119
119
  # Each batch of statements is assigned a name which can be used with
@@ -130,7 +130,7 @@ module Google
130
130
  # @!attribute [rw] operation_id
131
131
  # @return [String]
132
132
  # If empty, the new update request is assigned an
133
- # automatically-generated operation ID. Otherwise, +operation_id+
133
+ # automatically-generated operation ID. Otherwise, `operation_id`
134
134
  # is used to construct the name of the resulting
135
135
  # {Google::Longrunning::Operation Operation}.
136
136
  #
@@ -138,16 +138,16 @@ module Google
138
138
  # whether the statements were executed in the event that the
139
139
  # {Google::Spanner::Admin::Database::V1::DatabaseAdmin::UpdateDatabaseDdl UpdateDatabaseDdl} call is replayed,
140
140
  # or the return value is otherwise lost: the {Google::Spanner::Admin::Database::V1::UpdateDatabaseDdlRequest#database database} and
141
- # +operation_id+ fields can be combined to form the
141
+ # `operation_id` fields can be combined to form the
142
142
  # {Google::Longrunning::Operation#name name} of the resulting
143
- # {Google::Longrunning::Operation longrunning::Operation}: +<database>/operations/<operation_id>+.
143
+ # {Google::Longrunning::Operation longrunning::Operation}: `<database>/operations/<operation_id>`.
144
144
  #
145
- # +operation_id+ should be unique within the database, and must be
146
- # a valid identifier: +[a-z][a-z0-9_]*+. Note that
145
+ # `operation_id` should be unique within the database, and must be
146
+ # a valid identifier: `[a-z][a-z0-9_]*`. Note that
147
147
  # automatically-generated operation IDs always begin with an
148
148
  # underscore. If the named operation already exists,
149
149
  # {Google::Spanner::Admin::Database::V1::DatabaseAdmin::UpdateDatabaseDdl UpdateDatabaseDdl} returns
150
- # +ALREADY_EXISTS+.
150
+ # `ALREADY_EXISTS`.
151
151
  class UpdateDatabaseDdlRequest; end
152
152
 
153
153
  # Metadata type for the operation returned by
@@ -162,8 +162,8 @@ module Google
162
162
  # @!attribute [rw] commit_timestamps
163
163
  # @return [Array<Google::Protobuf::Timestamp>]
164
164
  # Reports the commit timestamps of all statements that have
165
- # succeeded so far, where +commit_timestamps[i]+ is the commit
166
- # timestamp for the statement +statements[i]+.
165
+ # succeeded so far, where `commit_timestamps[i]` is the commit
166
+ # timestamp for the statement `statements[i]`.
167
167
  class UpdateDatabaseDdlMetadata; end
168
168
 
169
169
  # The request for {Google::Spanner::Admin::Database::V1::DatabaseAdmin::DropDatabase DropDatabase}.
@@ -24,7 +24,7 @@ module Google
24
24
  # rubocop:disable LineLength
25
25
 
26
26
  ##
27
- # # Ruby Client for Cloud Spanner Database Admin API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
27
+ # # Ruby Client for Cloud Spanner Database Admin API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
28
28
  #
29
29
  # [Cloud Spanner Database Admin API][Product Documentation]:
30
30
  #
@@ -37,7 +37,7 @@ module Google
37
37
  # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
38
38
  # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
39
39
  # 3. [Enable the Cloud Spanner Database Admin API.](https://console.cloud.google.com/apis/library/spanner.googleapis.com)
40
- # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
40
+ # 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
41
41
  #
42
42
  # ### Installation
43
43
  # ```
@@ -47,7 +47,7 @@ module Google
47
47
  # ### Next Steps
48
48
  # - Read the [Cloud Spanner Database Admin API Product documentation][Product Documentation]
49
49
  # to learn more about the product and see How-to Guides.
50
- # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
50
+ # - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
51
51
  # to see the full list of Cloud APIs that we cover.
52
52
  #
53
53
  # [Product Documentation]: https://cloud.google.com/spanner
@@ -56,7 +56,7 @@ module Google
56
56
  #
57
57
  # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
58
58
  # The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
59
- # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
59
+ # or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
60
60
  # that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
61
61
  # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
62
62
  #
@@ -23,7 +23,7 @@ module Google
23
23
  # rubocop:disable LineLength
24
24
 
25
25
  ##
26
- # # Ruby Client for Cloud Spanner Database Admin API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
26
+ # # Ruby Client for Cloud Spanner Database Admin API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
27
27
  #
28
28
  # [Cloud Spanner Database Admin API][Product Documentation]:
29
29
  #
@@ -36,7 +36,7 @@ module Google
36
36
  # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
37
37
  # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
38
38
  # 3. [Enable the Cloud Spanner Database Admin API.](https://console.cloud.google.com/apis/library/spanner.googleapis.com)
39
- # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
39
+ # 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
40
40
  #
41
41
  # ### Installation
42
42
  # ```
@@ -46,7 +46,7 @@ module Google
46
46
  # ### Next Steps
47
47
  # - Read the [Cloud Spanner Database Admin API Product documentation][Product Documentation]
48
48
  # to learn more about the product and see How-to Guides.
49
- # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
49
+ # - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
50
50
  # to see the full list of Cloud APIs that we cover.
51
51
  #
52
52
  # [Product Documentation]: https://cloud.google.com/spanner
@@ -55,7 +55,7 @@ module Google
55
55
  #
56
56
  # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
57
57
  # The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
58
- # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
58
+ # or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
59
59
  # that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
60
60
  # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
61
61
  #
@@ -16,46 +16,46 @@
16
16
  module Google
17
17
  module Iam
18
18
  module V1
19
- # Request message for +SetIamPolicy+ method.
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
- # +resource+ is usually specified as a path. For example, a Project
24
- # resource is specified as +projects/\\{project}+.
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 +resource+. The size of
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 +GetIamPolicy+ method.
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
- # +resource+ is usually specified as a path. For example, a Project
38
- # resource is specified as +projects/\\{project}+.
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 +TestIamPermissions+ method.
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
- # +resource+ is usually specified as a path. For example, a Project
46
- # resource is specified as +projects/\\{project}+.
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 +resource+. Permissions with
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 +TestIamPermissions+ method.
55
+ # Response message for `TestIamPermissions` method.
56
56
  # @!attribute [rw] permissions
57
57
  # @return [Array<String>]
58
- # A subset of +TestPermissionsRequest.permissions+ that the caller is
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 +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
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 +Policy+. The default version is 0.
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 +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.
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
- # +etag+ is used for optimistic concurrency control as a way to help
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 +etag+ in 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 +etag+ is returned in the response to +getIamPolicy+, and
65
- # systems are expected to put that etag in the request to +setIamPolicy+ 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 +etag+ is provided in the call to +setIamPolicy+, then the existing
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 +members+ with a +role+.
72
+ # Associates `members` with a `role`.
73
73
  # @!attribute [rw] role
74
74
  # @return [String]
75
- # Role that is assigned to +members+.
76
- # For example, +roles/viewer+, +roles/editor+, or +roles/owner+.
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
- # +members+ can have the following values:
81
+ # `members` can have the following values:
82
82
  #
83
- # * +allUsers+: A special identifier that represents anyone who is
83
+ # * `allUsers`: A special identifier that represents anyone who is
84
84
  # on the internet; with or without a Google account.
85
85
  #
86
- # * +allAuthenticatedUsers+: A special identifier that represents anyone
86
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone
87
87
  # who is authenticated with a Google account or a service account.
88
88
  #
89
- # * +user:\\{emailid}+: An email address that represents a specific Google
90
- # account. For example, +alice@gmail.com+ or +joe@example.com+.
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
- # * +serviceAccount:\\{emailid}+: An email address that represents a service
94
- # account. For example, +my-other-app@appspot.gserviceaccount.com+.
93
+ # * `serviceAccount:{emailid}`: An email address that represents a service
94
+ # account. For example, `my-other-app@appspot.gserviceaccount.com`.
95
95
  #
96
- # * +group:\\{emailid}+: An email address that represents a Google group.
97
- # For example, +admins@example.com+.
96
+ # * `group:{emailid}`: An email address that represents a Google group.
97
+ # For example, `admins@example.com`.
98
98
  #
99
- # * +domain:\\{domain}+: A Google Apps domain name that represents all the
100
- # users of that domain. For example, +google.com+ or +example.com+.
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 +members+.
118
- # For example, +roles/viewer+, +roles/editor+, or +roles/owner+.
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
- # +name+ should have the format of +operations/some/unique/name+.
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 +false+, it means the operation is still in progress.
34
- # If true, the operation is completed, and either +error+ or +response+ is
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 +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+
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 +TakeSnapshot()+, the inferred response type is
48
- # +TakeSnapshotResponse+.
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
- # +Any+ contains an arbitrary serialized protocol buffer message along with a
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 +Any+ value uses the regular
72
+ # The JSON representation of an `Any` value uses the regular
73
73
  # representation of the deserialized, embedded message, with an
74
- # additional field +@type+ which contains the type URL. Example:
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
- # +value+ which holds the custom JSON in addition to the +@type+
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
- # +path/google.protobuf.Duration+). The name should be in a canonical form
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 +http+, +https+, or no scheme, one can optionally set up a type
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, +https+ is assumed.
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 +http+, +https+ (or the empty scheme) might be
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 +Empty+ is empty JSON object +{}+.
26
+ # The JSON representation for `Empty` is empty JSON object `{}`.
27
27
  class Empty; end
28
28
  end
29
29
  end
@@ -15,14 +15,14 @@
15
15
 
16
16
  module Google
17
17
  module Protobuf
18
- # +FieldMask+ represents a set of symbolic field paths, for example:
18
+ # `FieldMask` represents a set of symbolic field paths, for example:
19
19
  #
20
20
  # paths: "f.a"
21
21
  # paths: "f.b.d"
22
22
  #
23
- # Here +f+ represents a field in some root message, +a+ and +b+
24
- # fields in the message found in +f+, and +d+ a field found in the
25
- # message in +f.b+.
23
+ # Here `f` represents a field in some root message, `a` and `b`
24
+ # fields in the message found in `f`, and `d` a field found in the
25
+ # message in `f.b`.
26
26
  #
27
27
  # Field masks are used to specify a subset of fields that should be
28
28
  # returned by a get operation or modified by an update operation.
@@ -85,7 +85,7 @@ module Google
85
85
  #
86
86
  # If a repeated field is specified for an update operation, the existing
87
87
  # repeated values in the target resource will be overwritten by the new values.
88
- # Note that a repeated field is only allowed in the last position of a +paths+
88
+ # Note that a repeated field is only allowed in the last position of a `paths`
89
89
  # string.
90
90
  #
91
91
  # If a sub-message is specified in the last position of the field mask for an
@@ -177,7 +177,7 @@ module Google
177
177
  # string address = 2;
178
178
  # }
179
179
  #
180
- # In proto a field mask for +Profile+ may look as such:
180
+ # In proto a field mask for `Profile` may look as such:
181
181
  #
182
182
  # mask {
183
183
  # paths: "user.display_name"
@@ -221,7 +221,7 @@ module Google
221
221
  #
222
222
  # The implementation of any API method which has a FieldMask type field in the
223
223
  # request should verify the included field paths, and return an
224
- # +INVALID_ARGUMENT+ error if any path is duplicated or unmappable.
224
+ # `INVALID_ARGUMENT` error if any path is duplicated or unmappable.
225
225
  # @!attribute [rw] paths
226
226
  # @return [Array<String>]
227
227
  # The set of field mask paths.
@@ -15,7 +15,7 @@
15
15
 
16
16
  module Google
17
17
  module Rpc
18
- # The +Status+ type defines a logical error model that is suitable for different
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 +Status+ message contains three pieces of data: error code, error message,
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 +google.rpc+ that can be used for common error conditions.
35
+ # in the package `google.rpc` that can be used for common error conditions.
36
36
  #
37
37
  # = Language mapping
38
38
  #
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
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 +Status+ message can be used in a variety of
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 +Status+ in the normal response to indicate the partial
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 +Status+ message for error reporting.
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
- # +Status+ message should be used directly inside batch response, one for
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 +Status+ message.
66
+ # represented directly using the `Status` message.
67
67
  #
68
- # * Logging. If some API errors are stored in logs, the message +Status+ could
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]