lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/bigtable_table_admin.rb in google-cloud-bigtable-0.1.2 vs lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/bigtable_table_admin.rb in google-cloud-bigtable-0.1.3

- old
+ new

@@ -20,36 +20,36 @@ # Request message for # {Google::Bigtable::Admin::V2::BigtableTableAdmin::CreateTable} # @!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. # @!attribute [rw] initial_splits # @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 # @return [String] # Row key to use as an initial tablet boundary. @@ -64,30 +64,30 @@ # feature might be changed in backward-incompatible ways and is not recommended # for production use. It is not subject to any SLA or deprecation policy. # @!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 # {Google::Bigtable::Admin::V2::BigtableTableAdmin::DropRowRange} # @!attribute [rw] name # @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 # zero length. # @!attribute [rw] delete_all_data_from_table @@ -98,65 +98,65 @@ # Request message for # {Google::Bigtable::Admin::V2::BigtableTableAdmin::ListTables} # @!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 # {Google::Bigtable::Admin::V2::BigtableTableAdmin::ListTables} # @!attribute [rw] tables # @return [Array<Google::Bigtable::Admin::V2::Table>] # The tables present in the requested instance. # @!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 # Request message for # {Google::Bigtable::Admin::V2::BigtableTableAdmin::GetTable} # @!attribute [rw] name # @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 # {Google::Bigtable::Admin::V2::BigtableTableAdmin::DeleteTable} # @!attribute [rw] name # @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 # {Google::Bigtable::Admin::V2::BigtableTableAdmin::ModifyColumnFamilies} # @!attribute [rw] name # @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. # Entries are applied in order, meaning that earlier modifications can be # masked by later ones (in the case of repeated updates to the same family, @@ -185,11 +185,11 @@ # {Google::Bigtable::Admin::V2::BigtableTableAdmin::GenerateConsistencyToken} # @!attribute [rw] name # @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 # {Google::Bigtable::Admin::V2::BigtableTableAdmin::GenerateConsistencyToken} # @!attribute [rw] consistency_token @@ -201,11 +201,11 @@ # {Google::Bigtable::Admin::V2::BigtableTableAdmin::CheckConsistency} # @!attribute [rw] name # @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. class CheckConsistencyRequest; end @@ -226,22 +226,22 @@ # for production use. It is not subject to any SLA or deprecation policy. # @!attribute [rw] name # @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 # created. Once 'ttl' expires, the snapshot will get deleted. The maximum # amount of time a snapshot can stay active is 7 days. If 'ttl' is not @@ -260,11 +260,11 @@ # for production use. It is not subject to any SLA or deprecation policy. # @!attribute [rw] name # @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 # {Google::Bigtable::Admin::V2::BigtableTableAdmin::ListSnapshots} # @@ -274,20 +274,20 @@ # for production use. It is not subject to any SLA or deprecation policy. # @!attribute [rw] parent # @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 # {Google::Bigtable::Admin::V2::BigtableTableAdmin::ListSnapshots} # @@ -299,11 +299,11 @@ # @return [Array<Google::Bigtable::Admin::V2::Snapshot>] # The snapshots present in the requested cluster. # @!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 # Request message for # {Google::Bigtable::Admin::V2::BigtableTableAdmin::DeleteSnapshot} @@ -314,10 +314,10 @@ # for production use. It is not subject to any SLA or deprecation policy. # @!attribute [rw] name # @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. # # Note: This is a private alpha release of Cloud Bigtable snapshots. This \ No newline at end of file