google-cloud-bigtable 0.1.2 → 0.1.3

data/lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/bigtable_table_admin.rb

@@ -22,11 +22,11 @@ module Google
         # @!attribute [rw] parent
         #   @return [String]
         #     The unique name of the instance in which to create the table.
-        #     Values are of the form +projects/<project>/instances/<instance>+.
+        #     Values are of the form `projects/<project>/instances/<instance>`.
         # @!attribute [rw] table_id
         #   @return [String]
         #     The name by which the new table should be referred to within the parent
-        #     instance, e.g., +foobar+ rather than +<parent>/tables/foobar+.
+        #     instance, e.g., `foobar` rather than `<parent>/tables/foobar`.
         # @!attribute [rw] table
         #   @return [Google::Bigtable::Admin::V2::Table]
         #     The Table to create.
@@ -34,20 +34,20 @@ module Google
         #   @return [Array<Google::Bigtable::Admin::V2::CreateTableRequest::Split>]
         #     The optional list of row keys that will be used to initially split the
         #     table into several tablets (tablets are similar to HBase regions).
-        #     Given two split keys, +s1+ and +s2+, three tablets will be created,
-        #     spanning the key ranges: +[, s1), [s1, s2), [s2, )+.
+        #     Given two split keys, `s1` and `s2`, three tablets will be created,
+        #     spanning the key ranges: `[, s1), [s1, s2), [s2, )`.
         #
         #     Example:
         #
-        #     * Row keys := +["a", "apple", "custom", "customer_1", "customer_2",+
-        #       +"other", "zz"]+
-        #     * initial_split_keys := +["apple", "customer_1", "customer_2", "other"]+
+        #     * Row keys := `["a", "apple", "custom", "customer_1", "customer_2",`
+        #       `"other", "zz"]`
+        #     * initial_split_keys := `["apple", "customer_1", "customer_2", "other"]`
         #     * Key assignment:
-        #       * Tablet 1 +[, apple)                => {"a"}.+
-        #         * Tablet 2 +[apple, customer_1)      => {"apple", "custom"}.+
-        #         * Tablet 3 +[customer_1, customer_2) => {"customer_1"}.+
-        #         * Tablet 4 +[customer_2, other)      => {"customer_2"}.+
-        #         * Tablet 5 +[other, )                => {"other", "zz"}.+
+        #       * Tablet 1 `[, apple)                => {"a"}.`
+        #         * Tablet 2 `[apple, customer_1)      => {"apple", "custom"}.`
+        #         * Tablet 3 `[customer_1, customer_2) => {"customer_1"}.`
+        #         * Tablet 4 `[customer_2, other)      => {"customer_2"}.`
+        #         * Tablet 5 `[other, )                => {"other", "zz"}.`
         class CreateTableRequest
           # An initial split point for a newly created table.
           # @!attribute [rw] key
@@ -66,17 +66,17 @@ module Google
         # @!attribute [rw] parent
         #   @return [String]
         #     The unique name of the instance in which to create the table.
-        #     Values are of the form +projects/<project>/instances/<instance>+.
+        #     Values are of the form `projects/<project>/instances/<instance>`.
         # @!attribute [rw] table_id
         #   @return [String]
         #     The name by which the new table should be referred to within the parent
-        #     instance, e.g., +foobar+ rather than +<parent>/tables/foobar+.
+        #     instance, e.g., `foobar` rather than `<parent>/tables/foobar`.
         # @!attribute [rw] source_snapshot
         #   @return [String]
         #     The unique name of the snapshot from which to restore the table. The
         #     snapshot and the table must be in the same instance.
         #     Values are of the form
-        #     +projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>+.
+        #     `projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>`.
         class CreateTableFromSnapshotRequest; end
 
         # Request message for
@@ -85,7 +85,7 @@ module Google
         #   @return [String]
         #     The unique name of the table on which to drop a range of rows.
         #     Values are of the form
-        #     +projects/<project>/instances/<instance>/tables/<table>+.
+        #     `projects/<project>/instances/<instance>/tables/<table>`.
         # @!attribute [rw] row_key_prefix
         #   @return [String]
         #     Delete all rows that start with this row key prefix. Prefix cannot be
@@ -100,18 +100,18 @@ module Google
         # @!attribute [rw] parent
         #   @return [String]
         #     The unique name of the instance for which tables should be listed.
-        #     Values are of the form +projects/<project>/instances/<instance>+.
+        #     Values are of the form `projects/<project>/instances/<instance>`.
         # @!attribute [rw] view
         #   @return [Google::Bigtable::Admin::V2::Table::View]
         #     The view to be applied to the returned tables' fields.
-        #     Defaults to +NAME_ONLY+ if unspecified; no others are currently supported.
+        #     Defaults to `NAME_ONLY` if unspecified; no others are currently supported.
         # @!attribute [rw] page_size
         #   @return [Integer]
         #     Maximum number of results per page.
         #     CURRENTLY UNIMPLEMENTED AND IGNORED.
         # @!attribute [rw] page_token
         #   @return [String]
-        #     The value of +next_page_token+ returned by a previous call.
+        #     The value of `next_page_token` returned by a previous call.
         class ListTablesRequest; end
 
         # Response message for
@@ -122,7 +122,7 @@ module Google
         # @!attribute [rw] next_page_token
         #   @return [String]
         #     Set if not all tables could be returned in a single response.
-        #     Pass this value to +page_token+ in another request to get the next
+        #     Pass this value to `page_token` in another request to get the next
         #     page of results.
         class ListTablesResponse; end
 
@@ -132,11 +132,11 @@ module Google
         #   @return [String]
         #     The unique name of the requested table.
         #     Values are of the form
-        #     +projects/<project>/instances/<instance>/tables/<table>+.
+        #     `projects/<project>/instances/<instance>/tables/<table>`.
         # @!attribute [rw] view
         #   @return [Google::Bigtable::Admin::V2::Table::View]
         #     The view to be applied to the returned table's fields.
-        #     Defaults to +SCHEMA_VIEW+ if unspecified.
+        #     Defaults to `SCHEMA_VIEW` if unspecified.
         class GetTableRequest; end
 
         # Request message for
@@ -145,7 +145,7 @@ module Google
         #   @return [String]
         #     The unique name of the table to be deleted.
         #     Values are of the form
-        #     +projects/<project>/instances/<instance>/tables/<table>+.
+        #     `projects/<project>/instances/<instance>/tables/<table>`.
         class DeleteTableRequest; end
 
         # Request message for
@@ -154,7 +154,7 @@ module Google
         #   @return [String]
         #     The unique name of the table whose families should be modified.
         #     Values are of the form
-        #     +projects/<project>/instances/<instance>/tables/<table>+.
+        #     `projects/<project>/instances/<instance>/tables/<table>`.
         # @!attribute [rw] modifications
         #   @return [Array<Google::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification>]
         #     Modifications to be atomically applied to the specified table's families.
@@ -187,7 +187,7 @@ module Google
         #   @return [String]
         #     The unique name of the Table for which to create a consistency token.
         #     Values are of the form
-        #     +projects/<project>/instances/<instance>/tables/<table>+.
+        #     `projects/<project>/instances/<instance>/tables/<table>`.
         class GenerateConsistencyTokenRequest; end
 
         # Response message for
@@ -203,7 +203,7 @@ module Google
         #   @return [String]
         #     The unique name of the Table for which to check replication consistency.
         #     Values are of the form
-        #     +projects/<project>/instances/<instance>/tables/<table>+.
+        #     `projects/<project>/instances/<instance>/tables/<table>`.
         # @!attribute [rw] consistency_token
         #   @return [String]
         #     The token created using GenerateConsistencyToken for the Table.
@@ -228,18 +228,18 @@ module Google
         #   @return [String]
         #     The unique name of the table to have the snapshot taken.
         #     Values are of the form
-        #     +projects/<project>/instances/<instance>/tables/<table>+.
+        #     `projects/<project>/instances/<instance>/tables/<table>`.
         # @!attribute [rw] cluster
         #   @return [String]
         #     The name of the cluster where the snapshot will be created in.
         #     Values are of the form
-        #     +projects/<project>/instances/<instance>/clusters/<cluster>+.
+        #     `projects/<project>/instances/<instance>/clusters/<cluster>`.
         # @!attribute [rw] snapshot_id
         #   @return [String]
         #     The ID by which the new snapshot should be referred to within the parent
-        #     cluster, e.g., +mysnapshot+ of the form: +[_a-zA-Z0-9][-_.a-zA-Z0-9]*+
+        #     cluster, e.g., `mysnapshot` of the form: `[_a-zA-Z0-9][-_.a-zA-Z0-9]*`
         #     rather than
-        #     +projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/mysnapshot+.
+        #     `projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/mysnapshot`.
         # @!attribute [rw] ttl
         #   @return [Google::Protobuf::Duration]
         #     The amount of time that the new snapshot can stay active after it is
@@ -262,7 +262,7 @@ module Google
         #   @return [String]
         #     The unique name of the requested snapshot.
         #     Values are of the form
-        #     +projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>+.
+        #     `projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>`.
         class GetSnapshotRequest; end
 
         # Request message for
@@ -276,16 +276,16 @@ module Google
         #   @return [String]
         #     The unique name of the cluster for which snapshots should be listed.
         #     Values are of the form
-        #     +projects/<project>/instances/<instance>/clusters/<cluster>+.
-        #     Use +<cluster> = '-'+ to list snapshots for all clusters in an instance,
-        #     e.g., +projects/<project>/instances/<instance>/clusters/-+.
+        #     `projects/<project>/instances/<instance>/clusters/<cluster>`.
+        #     Use `<cluster> = '-'` to list snapshots for all clusters in an instance,
+        #     e.g., `projects/<project>/instances/<instance>/clusters/-`.
         # @!attribute [rw] page_size
         #   @return [Integer]
         #     The maximum number of snapshots to return per page.
         #     CURRENTLY UNIMPLEMENTED AND IGNORED.
         # @!attribute [rw] page_token
         #   @return [String]
-        #     The value of +next_page_token+ returned by a previous call.
+        #     The value of `next_page_token` returned by a previous call.
         class ListSnapshotsRequest; end
 
         # Response message for
@@ -301,7 +301,7 @@ module Google
         # @!attribute [rw] next_page_token
         #   @return [String]
         #     Set if not all snapshots could be returned in a single response.
-        #     Pass this value to +page_token+ in another request to get the next
+        #     Pass this value to `page_token` in another request to get the next
         #     page of results.
         class ListSnapshotsResponse; end
 
@@ -316,7 +316,7 @@ module Google
         #   @return [String]
         #     The unique name of the snapshot to be deleted.
         #     Values are of the form
-        #     +projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>+.
+        #     `projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>`.
         class DeleteSnapshotRequest; end
 
         # The metadata for the Operation returned by SnapshotTable.

data/lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/instance.rb

@@ -23,9 +23,9 @@ module Google
         # {Google::Bigtable::Admin::V2::Cluster Cluster}.
         # @!attribute [rw] name
         #   @return [String]
-        #     (+OutputOnly+)
+        #     (`OutputOnly`)
         #     The unique name of the instance. Values are of the form
-        #     +projects/<project>/instances/[a-z][a-z0-9\\-]+[a-z0-9]+.
+        #     `projects/<project>/instances/[a-z][a-z0-9\\-]+[a-z0-9]`.
         # @!attribute [rw] display_name
         #   @return [String]
         #     The descriptive name for this instance as it appears in UIs.
@@ -33,11 +33,11 @@ module Google
         #     to avoid confusion.
         # @!attribute [rw] state
         #   @return [Google::Bigtable::Admin::V2::Instance::State]
-        #     (+OutputOnly+)
+        #     (`OutputOnly`)
         #     The current state of the instance.
         # @!attribute [rw] type
         #   @return [Google::Bigtable::Admin::V2::Instance::Type]
-        #     The type of the instance. Defaults to +PRODUCTION+.
+        #     The type of the instance. Defaults to `PRODUCTION`.
         # @!attribute [rw] labels
         #   @return [Hash{String => String}]
         #     Labels are a flexible and lightweight mechanism for organizing cloud
@@ -46,9 +46,9 @@ module Google
         #     metrics.
         #
         #     * Label keys must be between 1 and 63 characters long and must conform to
-        #       the regular expression: +[\p\\{Ll}\p\\{Lo}][\p\\{Ll}\p\\{Lo}\p\\{N}_-]\\{0,62}+.
+        #       the regular expression: `[\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}`.
         #     * Label values must be between 0 and 63 characters long and must conform to
-        #       the regular expression: +[\p\\{Ll}\p\\{Lo}\p\\{N}_-]\\{0,63}+.
+        #       the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`.
         #     * No more than 64 labels can be associated with a given resource.
         #     * Keys and values must both be under 128 bytes.
         class Instance
@@ -69,20 +69,20 @@ module Google
           # The type of the instance.
           module Type
             # The type of the instance is unspecified. If set when creating an
-            # instance, a +PRODUCTION+ instance will be created. If set when updating
+            # instance, a `PRODUCTION` instance will be created. If set when updating
             # an instance, the type will be left unchanged.
             TYPE_UNSPECIFIED = 0
 
-            # An instance meant for production use. +serve_nodes+ must be set
+            # An instance meant for production use. `serve_nodes` must be set
             # on the cluster.
             PRODUCTION = 1
 
             # The instance is meant for development and testing purposes only; it has
             # no performance or uptime guarantees and is not covered by SLA.
             # After a development instance is created, it can be upgraded by
-            # updating the instance to type +PRODUCTION+. An instance created
+            # updating the instance to type `PRODUCTION`. An instance created
             # as a production instance cannot be changed to a development instance.
-            # When creating a development instance, +serve_nodes+ on the cluster must
+            # When creating a development instance, `serve_nodes` on the cluster must
             # not be set.
             DEVELOPMENT = 2
           end
@@ -93,19 +93,19 @@ module Google
         # {Google::Bigtable::Admin::V2::Instance Instance}.
         # @!attribute [rw] name
         #   @return [String]
-        #     (+OutputOnly+)
+        #     (`OutputOnly`)
         #     The unique name of the cluster. Values are of the form
-        #     +projects/<project>/instances/<instance>/clusters/[a-z][-a-z0-9]*+.
+        #     `projects/<project>/instances/<instance>/clusters/[a-z][-a-z0-9]*`.
         # @!attribute [rw] location
         #   @return [String]
-        #     (+CreationOnly+)
+        #     (`CreationOnly`)
         #     The location where this cluster's nodes and storage reside. For best
         #     performance, clients should be located as close as possible to this
         #     cluster. Currently only zones are supported, so values should be of the
-        #     form +projects/<project>/locations/<zone>+.
+        #     form `projects/<project>/locations/<zone>`.
         # @!attribute [rw] state
         #   @return [Google::Bigtable::Admin::V2::Cluster::State]
-        #     (+OutputOnly+)
+        #     (`OutputOnly`)
         #     The current state of the cluster.
         # @!attribute [rw] serve_nodes
         #   @return [Integer]
@@ -113,7 +113,7 @@ module Google
         #     throughput and more consistent performance.
         # @!attribute [rw] default_storage_type
         #   @return [Google::Bigtable::Admin::V2::StorageType]
-        #     (+CreationOnly+)
+        #     (`CreationOnly`)
         #     The type of storage used by this cluster to serve its
         #     parent instance's tables, unless explicitly overridden.
         class Cluster
@@ -147,15 +147,15 @@ module Google
         # from a particular end user application.
         # @!attribute [rw] name
         #   @return [String]
-        #     (+OutputOnly+)
+        #     (`OutputOnly`)
         #     The unique name of the app profile. Values are of the form
-        #     +projects/<project>/instances/<instance>/appProfiles/[_a-zA-Z0-9][-_.a-zA-Z0-9]*+.
+        #     `projects/<project>/instances/<instance>/appProfiles/[_a-zA-Z0-9][-_.a-zA-Z0-9]*`.
         # @!attribute [rw] etag
         #   @return [String]
         #     Strongly validated etag for optimistic concurrency control. Preserve the
-        #     value returned from +GetAppProfile+ when calling +UpdateAppProfile+ to
+        #     value returned from `GetAppProfile` when calling `UpdateAppProfile` to
         #     fail the request if there has been a modification in the mean time. The
-        #     +update_mask+ of the request need not include +etag+ for this protection
+        #     `update_mask` of the request need not include `etag` for this protection
         #     to apply.
         #     See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and
         #     [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more
@@ -184,7 +184,7 @@ module Google
           #     The cluster to which read/write requests should be routed.
           # @!attribute [rw] allow_transactional_writes
           #   @return [true, false]
-          #     Whether or not +CheckAndMutateRow+ and +ReadModifyWriteRow+ requests are
+          #     Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are
           #     allowed by this app profile. It is unsafe to send these requests to
           #     the same table/row/column in multiple clusters.
           class SingleClusterRouting; end

data/lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/table.rb

@@ -21,35 +21,35 @@ module Google
         # Each table is served using the resources of its parent cluster.
         # @!attribute [rw] name
         #   @return [String]
-        #     (+OutputOnly+)
+        #     (`OutputOnly`)
         #     The unique name of the table. Values are of the form
-        #     +projects/<project>/instances/<instance>/tables/[_a-zA-Z0-9][-_.a-zA-Z0-9]*+.
-        #     Views: +NAME_ONLY+, +SCHEMA_VIEW+, +REPLICATION_VIEW+, +FULL+
+        #     `projects/<project>/instances/<instance>/tables/[_a-zA-Z0-9][-_.a-zA-Z0-9]*`.
+        #     Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
         # @!attribute [rw] cluster_states
         #   @return [Hash{String => Google::Bigtable::Admin::V2::Table::ClusterState}]
-        #     (+OutputOnly+)
+        #     (`OutputOnly`)
         #     Map from cluster ID to per-cluster table state.
         #     If it could not be determined whether or not the table has data in a
         #     particular cluster (for example, if its zone is unavailable), then
-        #     there will be an entry for the cluster with UNKNOWN +replication_status+.
-        #     Views: +REPLICATION_VIEW+, +FULL+
+        #     there will be an entry for the cluster with UNKNOWN `replication_status`.
+        #     Views: `REPLICATION_VIEW`, `FULL`
         # @!attribute [rw] column_families
         #   @return [Hash{String => Google::Bigtable::Admin::V2::ColumnFamily}]
-        #     (+CreationOnly+)
+        #     (`CreationOnly`)
         #     The column families configured for this table, mapped by column family ID.
-        #     Views: +SCHEMA_VIEW+, +FULL+
+        #     Views: `SCHEMA_VIEW`, `FULL`
         # @!attribute [rw] granularity
         #   @return [Google::Bigtable::Admin::V2::Table::TimestampGranularity]
-        #     (+CreationOnly+)
-        #     The granularity (i.e. +MILLIS+) at which timestamps are stored in
+        #     (`CreationOnly`)
+        #     The granularity (i.e. `MILLIS`) at which timestamps are stored in
         #     this table. Timestamps not matching the granularity will be rejected.
-        #     If unspecified at creation time, the value will be set to +MILLIS+.
-        #     Views: +SCHEMA_VIEW+, +FULL+
+        #     If unspecified at creation time, the value will be set to `MILLIS`.
+        #     Views: `SCHEMA_VIEW`, `FULL`
         class Table
           # The state of a table's data in a particular cluster.
           # @!attribute [rw] replication_state
           #   @return [Google::Bigtable::Admin::V2::Table::ClusterState::ReplicationState]
-          #     (+OutputOnly+)
+          #     (`OutputOnly`)
           #     The state of replication for the table in this cluster.
           class ClusterState
             # Table replication states.
@@ -93,13 +93,13 @@ module Google
             # Uses the default view for each method as documented in its request.
             VIEW_UNSPECIFIED = 0
 
-            # Only populates +name+.
+            # Only populates `name`.
             NAME_ONLY = 1
 
-            # Only populates +name+ and fields related to the table's schema.
+            # Only populates `name` and fields related to the table's schema.
             SCHEMA_VIEW = 2
 
-            # Only populates +name+ and fields related to the table's
+            # Only populates `name` and fields related to the table's
             # replication state.
             REPLICATION_VIEW = 3
 
@@ -138,13 +138,13 @@ module Google
           # A GcRule which deletes cells matching all of the given rules.
           # @!attribute [rw] rules
           #   @return [Array<Google::Bigtable::Admin::V2::GcRule>]
-          #     Only delete cells which would be deleted by every element of +rules+.
+          #     Only delete cells which would be deleted by every element of `rules`.
           class Intersection; end
 
           # A GcRule which deletes cells matching any of the given rules.
           # @!attribute [rw] rules
           #   @return [Array<Google::Bigtable::Admin::V2::GcRule>]
-          #     Delete cells which would be deleted by any element of +rules+.
+          #     Delete cells which would be deleted by any element of `rules`.
           class Union; end
         end
 
@@ -157,37 +157,37 @@ module Google
         # for production use. It is not subject to any SLA or deprecation policy.
         # @!attribute [rw] name
         #   @return [String]
-        #     (+OutputOnly+)
+        #     (`OutputOnly`)
         #     The unique name of the snapshot.
         #     Values are of the form
-        #     +projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>+.
+        #     `projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>`.
         # @!attribute [rw] source_table
         #   @return [Google::Bigtable::Admin::V2::Table]
-        #     (+OutputOnly+)
+        #     (`OutputOnly`)
         #     The source table at the time the snapshot was taken.
         # @!attribute [rw] data_size_bytes
         #   @return [Integer]
-        #     (+OutputOnly+)
+        #     (`OutputOnly`)
         #     The size of the data in the source table at the time the snapshot was
         #     taken. In some cases, this value may be computed asynchronously via a
         #     background process and a placeholder of 0 will be used in the meantime.
         # @!attribute [rw] create_time
         #   @return [Google::Protobuf::Timestamp]
-        #     (+OutputOnly+)
+        #     (`OutputOnly`)
         #     The time when the snapshot is created.
         # @!attribute [rw] delete_time
         #   @return [Google::Protobuf::Timestamp]
-        #     (+OutputOnly+)
+        #     (`OutputOnly`)
         #     The time when the snapshot will be deleted. The maximum amount of time a
         #     snapshot can stay active is 365 days. If 'ttl' is not specified,
         #     the default maximum of 365 days will be used.
         # @!attribute [rw] state
         #   @return [Google::Bigtable::Admin::V2::Snapshot::State]
-        #     (+OutputOnly+)
+        #     (`OutputOnly`)
         #     The current state of the snapshot.
         # @!attribute [rw] description
         #   @return [String]
-        #     (+OutputOnly+)
+        #     (`OutputOnly`)
         #     Description of the snapshot.
         class Snapshot
           # Possible states of a snapshot.