google-cloud-bigtable 0.1.2 → 0.1.3

data/lib/google/cloud/bigtable/admin/v2/doc/google/iam/v1/iam_policy.rb

@@ -16,46 +16,46 @@
 module Google
   module Iam
     module V1
-      # Request message for +SetIamPolicy+ method.
+      # Request message for `SetIamPolicy` method.
       # @!attribute [rw] resource
       #   @return [String]
       #     REQUIRED: The resource for which the policy is being specified.
-      #     +resource+ is usually specified as a path. For example, a Project
-      #     resource is specified as +projects/\\{project}+.
+      #     `resource` is usually specified as a path. For example, a Project
+      #     resource is specified as `projects/{project}`.
       # @!attribute [rw] policy
       #   @return [Google::Iam::V1::Policy]
-      #     REQUIRED: The complete policy to be applied to the +resource+. The size of
+      #     REQUIRED: The complete policy to be applied to the `resource`. The size of
       #     the policy is limited to a few 10s of KB. An empty policy is a
       #     valid policy but certain Cloud Platform services (such as Projects)
       #     might reject them.
       class SetIamPolicyRequest; end
 
-      # Request message for +GetIamPolicy+ method.
+      # Request message for `GetIamPolicy` method.
       # @!attribute [rw] resource
       #   @return [String]
       #     REQUIRED: The resource for which the policy is being requested.
-      #     +resource+ is usually specified as a path. For example, a Project
-      #     resource is specified as +projects/\\{project}+.
+      #     `resource` is usually specified as a path. For example, a Project
+      #     resource is specified as `projects/{project}`.
       class GetIamPolicyRequest; end
 
-      # Request message for +TestIamPermissions+ method.
+      # Request message for `TestIamPermissions` method.
       # @!attribute [rw] resource
       #   @return [String]
       #     REQUIRED: The resource for which the policy detail is being requested.
-      #     +resource+ is usually specified as a path. For example, a Project
-      #     resource is specified as +projects/\\{project}+.
+      #     `resource` is usually specified as a path. For example, a Project
+      #     resource is specified as `projects/{project}`.
       # @!attribute [rw] permissions
       #   @return [Array<String>]
-      #     The set of permissions to check for the +resource+. Permissions with
+      #     The set of permissions to check for the `resource`. Permissions with
       #     wildcards (such as '*' or 'storage.*') are not allowed. For more
       #     information see
       #     [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
       class TestIamPermissionsRequest; end
 
-      # Response message for +TestIamPermissions+ method.
+      # Response message for `TestIamPermissions` method.
       # @!attribute [rw] permissions
       #   @return [Array<String>]
-      #     A subset of +TestPermissionsRequest.permissions+ that the caller is
+      #     A subset of `TestPermissionsRequest.permissions` that the caller is
       #     allowed.
       class TestIamPermissionsResponse; end
     end

data/lib/google/cloud/bigtable/admin/v2/doc/google/iam/v1/policy.rb

@@ -20,9 +20,9 @@ module Google
       # specify access control policies for Cloud Platform resources.
       #
       #
-      # A +Policy+ consists of a list of +bindings+. A +Binding+ binds a list of
-      # +members+ to a +role+, where the members can be user accounts, Google groups,
-      # Google domains, and service accounts. A +role+ is a named list of permissions
+      # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
+      # `members` to a `role`, where the members can be user accounts, Google groups,
+      # Google domains, and service accounts. A `role` is a named list of permissions
       # defined by IAM.
       #
       # **Example**
@@ -49,55 +49,55 @@ module Google
       # [IAM developer's guide](https://cloud.google.com/iam).
       # @!attribute [rw] version
       #   @return [Integer]
-      #     Version of the +Policy+. The default version is 0.
+      #     Version of the `Policy`. The default version is 0.
       # @!attribute [rw] bindings
       #   @return [Array<Google::Iam::V1::Binding>]
-      #     Associates a list of +members+ to a +role+.
-      #     Multiple +bindings+ must not be specified for the same +role+.
-      #     +bindings+ with no members will result in an error.
+      #     Associates a list of `members` to a `role`.
+      #     Multiple `bindings` must not be specified for the same `role`.
+      #     `bindings` with no members will result in an error.
       # @!attribute [rw] etag
       #   @return [String]
-      #     +etag+ is used for optimistic concurrency control as a way to help
+      #     `etag` is used for optimistic concurrency control as a way to help
       #     prevent simultaneous updates of a policy from overwriting each other.
-      #     It is strongly suggested that systems make use of the +etag+ in the
+      #     It is strongly suggested that systems make use of the `etag` in the
       #     read-modify-write cycle to perform policy updates in order to avoid race
-      #     conditions: An +etag+ is returned in the response to +getIamPolicy+, and
-      #     systems are expected to put that etag in the request to +setIamPolicy+ to
+      #     conditions: An `etag` is returned in the response to `getIamPolicy`, and
+      #     systems are expected to put that etag in the request to `setIamPolicy` to
       #     ensure that their change will be applied to the same version of the policy.
       #
-      #     If no +etag+ is provided in the call to +setIamPolicy+, then the existing
+      #     If no `etag` is provided in the call to `setIamPolicy`, then the existing
       #     policy is overwritten blindly.
       class Policy; end
 
-      # Associates +members+ with a +role+.
+      # Associates `members` with a `role`.
       # @!attribute [rw] role
       #   @return [String]
-      #     Role that is assigned to +members+.
-      #     For example, +roles/viewer+, +roles/editor+, or +roles/owner+.
+      #     Role that is assigned to `members`.
+      #     For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
       #     Required
       # @!attribute [rw] members
       #   @return [Array<String>]
       #     Specifies the identities requesting access for a Cloud Platform resource.
-      #     +members+ can have the following values:
+      #     `members` can have the following values:
       #
-      #     * +allUsers+: A special identifier that represents anyone who is
+      #     * `allUsers`: A special identifier that represents anyone who is
       #       on the internet; with or without a Google account.
       #
-      #     * +allAuthenticatedUsers+: A special identifier that represents anyone
+      #     * `allAuthenticatedUsers`: A special identifier that represents anyone
       #       who is authenticated with a Google account or a service account.
       #
-      #     * +user:\\{emailid}+: An email address that represents a specific Google
-      #       account. For example, +alice@gmail.com+ or +joe@example.com+.
+      #     * `user:{emailid}`: An email address that represents a specific Google
+      #       account. For example, `alice@gmail.com` or `joe@example.com`.
       #
       #
-      #     * +serviceAccount:\\{emailid}+: An email address that represents a service
-      #       account. For example, +my-other-app@appspot.gserviceaccount.com+.
+      #     * `serviceAccount:{emailid}`: An email address that represents a service
+      #       account. For example, `my-other-app@appspot.gserviceaccount.com`.
       #
-      #     * +group:\\{emailid}+: An email address that represents a Google group.
-      #       For example, +admins@example.com+.
+      #     * `group:{emailid}`: An email address that represents a Google group.
+      #       For example, `admins@example.com`.
       #
-      #     * +domain:\\{domain}+: A Google Apps domain name that represents all the
-      #       users of that domain. For example, +google.com+ or +example.com+.
+      #     * `domain:{domain}`: A Google Apps domain name that represents all the
+      #       users of that domain. For example, `google.com` or `example.com`.
       class Binding; end
 
       # The difference delta between two policies.
@@ -114,8 +114,8 @@ module Google
       #     Required
       # @!attribute [rw] role
       #   @return [String]
-      #     Role that is assigned to +members+.
-      #     For example, +roles/viewer+, +roles/editor+, or +roles/owner+.
+      #     Role that is assigned to `members`.
+      #     For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
       #     Required
       # @!attribute [rw] member
       #   @return [String]

data/lib/google/cloud/bigtable/admin/v2/doc/google/longrunning/operations.rb

@@ -21,7 +21,7 @@ module Google
     #   @return [String]
     #     The server-assigned name, which is only unique within the same service that
     #     originally returns it. If you use the default HTTP mapping, the
-    #     +name+ should have the format of +operations/some/unique/name+.
+    #     `name` should have the format of `operations/some/unique/name`.
     # @!attribute [rw] metadata
     #   @return [Google::Protobuf::Any]
     #     Service-specific metadata associated with the operation.  It typically
@@ -30,8 +30,8 @@ module Google
     #     long-running operation should document the metadata type, if any.
     # @!attribute [rw] done
     #   @return [true, false]
-    #     If the value is +false+, it means the operation is still in progress.
-    #     If true, the operation is completed, and either +error+ or +response+ is
+    #     If the value is `false`, it means the operation is still in progress.
+    #     If true, the operation is completed, and either `error` or `response` is
     #     available.
     # @!attribute [rw] error
     #   @return [Google::Rpc::Status]
@@ -39,13 +39,13 @@ module Google
     # @!attribute [rw] response
     #   @return [Google::Protobuf::Any]
     #     The normal response of the operation in case of success.  If the original
-    #     method returns no data on success, such as +Delete+, the response is
-    #     +google.protobuf.Empty+.  If the original method is standard
-    #     +Get+/+Create+/+Update+, the response should be the resource.  For other
-    #     methods, the response should have the type +XxxResponse+, where +Xxx+
+    #     method returns no data on success, such as `Delete`, the response is
+    #     `google.protobuf.Empty`.  If the original method is standard
+    #     `Get`/`Create`/`Update`, the response should be the resource.  For other
+    #     methods, the response should have the type `XxxResponse`, where `Xxx`
     #     is the original method name.  For example, if the original method name
-    #     is +TakeSnapshot()+, the inferred response type is
-    #     +TakeSnapshotResponse+.
+    #     is `TakeSnapshot()`, the inferred response type is
+    #     `TakeSnapshotResponse`.
     class Operation; end
 
     # The request message for {Google::Longrunning::Operations::GetOperation Operations::GetOperation}.

data/lib/google/cloud/bigtable/admin/v2/doc/google/protobuf/any.rb

@@ -15,7 +15,7 @@
 
 module Google
   module Protobuf
-    # +Any+ contains an arbitrary serialized protocol buffer message along with a
+    # `Any` contains an arbitrary serialized protocol buffer message along with a
     # URL that describes the type of the serialized message.
     #
     # Protobuf library provides support to pack/unpack Any values in the form
@@ -69,9 +69,9 @@ module Google
     #
     # = JSON
     #
-    # The JSON representation of an +Any+ value uses the regular
+    # The JSON representation of an `Any` value uses the regular
     # representation of the deserialized, embedded message, with an
-    # additional field +@type+ which contains the type URL. Example:
+    # additional field `@type` which contains the type URL. Example:
     #
     #     package google.profile;
     #     message Person {
@@ -87,7 +87,7 @@ module Google
     #
     # If the embedded message type is well-known and has a custom JSON
     # representation, that representation will be embedded adding a field
-    # +value+ which holds the custom JSON in addition to the +@type+
+    # `value` which holds the custom JSON in addition to the `@type`
     # field. Example (for message {Google::Protobuf::Duration}):
     #
     #     {
@@ -99,15 +99,15 @@ module Google
     #     A URL/resource name that uniquely identifies the type of the serialized
     #     protocol buffer message. The last segment of the URL's path must represent
     #     the fully qualified name of the type (as in
-    #     +path/google.protobuf.Duration+). The name should be in a canonical form
+    #     `path/google.protobuf.Duration`). The name should be in a canonical form
     #     (e.g., leading "." is not accepted).
     #
     #     In practice, teams usually precompile into the binary all types that they
     #     expect it to use in the context of Any. However, for URLs which use the
-    #     scheme +http+, +https+, or no scheme, one can optionally set up a type
+    #     scheme `http`, `https`, or no scheme, one can optionally set up a type
     #     server that maps type URLs to message definitions as follows:
     #
-    #     * If no scheme is provided, +https+ is assumed.
+    #     * If no scheme is provided, `https` is assumed.
     #     * An HTTP GET on the URL must yield a {Google::Protobuf::Type}
     #       value in binary format, or produce an error.
     #     * Applications are allowed to cache lookup results based on the
@@ -120,7 +120,7 @@ module Google
     #     protobuf release, and it is not used for type URLs beginning with
     #     type.googleapis.com.
     #
-    #     Schemes other than +http+, +https+ (or the empty scheme) might be
+    #     Schemes other than `http`, `https` (or the empty scheme) might be
     #     used with implementation specific semantics.
     # @!attribute [rw] value
     #   @return [String]

data/lib/google/cloud/bigtable/admin/v2/doc/google/protobuf/duration.rb

@@ -82,9 +82,9 @@ module Google
     #   @return [Integer]
     #     Signed fractions of a second at nanosecond resolution of the span
     #     of time. Durations less than one second are represented with a 0
-    #     +seconds+ field and a positive or negative +nanos+ field. For durations
-    #     of one second or more, a non-zero value for the +nanos+ field must be
-    #     of the same sign as the +seconds+ field. Must be from -999,999,999
+    #     `seconds` field and a positive or negative `nanos` field. For durations
+    #     of one second or more, a non-zero value for the `nanos` field must be
+    #     of the same sign as the `seconds` field. Must be from -999,999,999
     #     to +999,999,999 inclusive.
     class Duration; end
   end

data/lib/google/cloud/bigtable/admin/v2/doc/google/protobuf/empty.rb

@@ -23,7 +23,7 @@ module Google
     #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
     #     }
     #
-    # The JSON representation for +Empty+ is empty JSON object +{}+.
+    # The JSON representation for `Empty` is empty JSON object `{}`.
     class Empty; end
   end
 end

data/lib/google/cloud/bigtable/admin/v2/doc/google/protobuf/field_mask.rb

@@ -15,14 +15,14 @@
 
 module Google
   module Protobuf
-    # +FieldMask+ represents a set of symbolic field paths, for example:
+    # `FieldMask` represents a set of symbolic field paths, for example:
     #
     #     paths: "f.a"
     #     paths: "f.b.d"
     #
-    # Here +f+ represents a field in some root message, +a+ and +b+
-    # fields in the message found in +f+, and +d+ a field found in the
-    # message in +f.b+.
+    # Here `f` represents a field in some root message, `a` and `b`
+    # fields in the message found in `f`, and `d` a field found in the
+    # message in `f.b`.
     #
     # Field masks are used to specify a subset of fields that should be
     # returned by a get operation or modified by an update operation.
@@ -85,7 +85,7 @@ module Google
     #
     # If a repeated field is specified for an update operation, the existing
     # repeated values in the target resource will be overwritten by the new values.
-    # Note that a repeated field is only allowed in the last position of a +paths+
+    # Note that a repeated field is only allowed in the last position of a `paths`
     # string.
     #
     # If a sub-message is specified in the last position of the field mask for an
@@ -177,7 +177,7 @@ module Google
     #       string address = 2;
     #     }
     #
-    # In proto a field mask for +Profile+ may look as such:
+    # In proto a field mask for `Profile` may look as such:
     #
     #     mask {
     #       paths: "user.display_name"
@@ -221,7 +221,7 @@ module Google
     #
     # The implementation of any API method which has a FieldMask type field in the
     # request should verify the included field paths, and return an
-    # +INVALID_ARGUMENT+ error if any path is duplicated or unmappable.
+    # `INVALID_ARGUMENT` error if any path is duplicated or unmappable.
     # @!attribute [rw] paths
     #   @return [Array<String>]
     #     The set of field mask paths.

data/lib/google/cloud/bigtable/admin/v2/doc/google/protobuf/timestamp.rb

@@ -29,13 +29,13 @@ module Google
     #
     # = Examples
     #
-    # Example 1: Compute Timestamp from POSIX +time()+.
+    # Example 1: Compute Timestamp from POSIX `time()`.
     #
     #     Timestamp timestamp;
     #     timestamp.set_seconds(time(NULL));
     #     timestamp.set_nanos(0);
     #
-    # Example 2: Compute Timestamp from POSIX +gettimeofday()+.
+    # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
     #
     #     struct timeval tv;
     #     gettimeofday(&tv, NULL);
@@ -44,7 +44,7 @@ module Google
     #     timestamp.set_seconds(tv.tv_sec);
     #     timestamp.set_nanos(tv.tv_usec * 1000);
     #
-    # Example 3: Compute Timestamp from Win32 +GetSystemTimeAsFileTime()+.
+    # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
     #
     #     FILETIME ft;
     #     GetSystemTimeAsFileTime(&ft);
@@ -56,7 +56,7 @@ module Google
     #     timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
     #     timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
     #
-    # Example 4: Compute Timestamp from Java +System.currentTimeMillis()+.
+    # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
     #
     #     long millis = System.currentTimeMillis();
     #
@@ -87,10 +87,10 @@ module Google
     #
     # In JavaScript, one can convert a Date object to this format using the
     # standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString]
-    # method. In Python, a standard +datetime.datetime+ object can be converted
-    # to this format using [+strftime+](https://docs.python.org/2/library/time.html#time.strftime)
+    # method. In Python, a standard `datetime.datetime` object can be converted
+    # to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime)
     # with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one
-    # can use the Joda Time's [+ISODateTimeFormat.dateTime()+](
+    # can use the Joda Time's [`ISODateTimeFormat.dateTime()`](
     # http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime--
     # ) to obtain a formatter capable of generating timestamps in this format.
     # @!attribute [rw] seconds

data/lib/google/cloud/bigtable/admin/v2/doc/google/rpc/status.rb

@@ -15,7 +15,7 @@
 
 module Google
   module Rpc
-    # The +Status+ type defines a logical error model that is suitable for different
+    # The `Status` type defines a logical error model that is suitable for different
     # programming environments, including REST APIs and RPC APIs. It is used by
     # [gRPC](https://github.com/grpc). The error model is designed to be:
     #
@@ -24,7 +24,7 @@ module Google
     #
     # = Overview
     #
-    # The +Status+ message contains three pieces of data: error code, error message,
+    # The `Status` message contains three pieces of data: error code, error message,
     # and error details. The error code should be an enum value of
     # {Google::Rpc::Code}, but it may accept additional error codes if needed.  The
     # error message should be a developer-facing English message that helps
@@ -32,40 +32,40 @@ module Google
     # error message is needed, put the localized message in the error details or
     # localize it in the client. The optional error details may contain arbitrary
     # information about the error. There is a predefined set of error detail types
-    # in the package +google.rpc+ that can be used for common error conditions.
+    # in the package `google.rpc` that can be used for common error conditions.
     #
     # = Language mapping
     #
-    # The +Status+ message is the logical representation of the error model, but it
-    # is not necessarily the actual wire format. When the +Status+ message is
+    # The `Status` message is the logical representation of the error model, but it
+    # is not necessarily the actual wire format. When the `Status` message is
     # exposed in different client libraries and different wire protocols, it can be
     # mapped differently. For example, it will likely be mapped to some exceptions
     # in Java, but more likely mapped to some error codes in C.
     #
     # = Other uses
     #
-    # The error model and the +Status+ message can be used in a variety of
+    # The error model and the `Status` message can be used in a variety of
     # environments, either with or without APIs, to provide a
     # consistent developer experience across different environments.
     #
     # Example uses of this error model include:
     #
     # * Partial errors. If a service needs to return partial errors to the client,
-    #   it may embed the +Status+ in the normal response to indicate the partial
+    #   it may embed the `Status` in the normal response to indicate the partial
     #   errors.
     #
     # * Workflow errors. A typical workflow has multiple steps. Each step may
-    #   have a +Status+ message for error reporting.
+    #   have a `Status` message for error reporting.
     #
     # * Batch operations. If a client uses batch request and batch response, the
-    #   +Status+ message should be used directly inside batch response, one for
+    #   `Status` message should be used directly inside batch response, one for
     #   each error sub-response.
     #
     # * Asynchronous operations. If an API call embeds asynchronous operation
     #   results in its response, the status of those operations should be
-    #   represented directly using the +Status+ message.
+    #   represented directly using the `Status` message.
     #
-    # * Logging. If some API errors are stored in logs, the message +Status+ could
+    # * Logging. If some API errors are stored in logs, the message `Status` could
     #   be used directly after any stripping needed for security/privacy reasons.
     # @!attribute [rw] code
     #   @return [Integer]

data/lib/google/cloud/bigtable/column_family.rb

@@ -131,7 +131,7 @@ module Google
 
         # Permanently delete column family from table.
         #
-        # @return [Google::Cloud::Bigtable::Table]
+        # @return [Boolean] Whether the column family was deleted.
         #
         # @example
         #   require "google/cloud/bigtable"