google-cloud-bigtable 1.0.0 → 1.2.1

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

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# Copyright 2020 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -19,16 +19,15 @@ module Google
       module V2
         # A collection of Bigtable {Google::Bigtable::Admin::V2::Table Tables} and
         # the resources that serve them.
-        # All tables in an instance are served from a single
-        # {Google::Bigtable::Admin::V2::Cluster Cluster}.
+        # All tables in an instance are served from all
+        # {Google::Bigtable::Admin::V2::Cluster Clusters} in the instance.
         # @!attribute [rw] name
         #   @return [String]
-        #     (`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.
+        #     Required. The descriptive name for this instance as it appears in UIs.
         #     Can be changed at any time, but should be kept globally unique
         #     to avoid confusion.
         # @!attribute [rw] state
@@ -93,24 +92,22 @@ module Google
         # {Google::Bigtable::Admin::V2::Instance Instance}.
         # @!attribute [rw] name
         #   @return [String]
-        #     (`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`)
         #     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`)
         #     The current state of the cluster.
         # @!attribute [rw] serve_nodes
         #   @return [Integer]
-        #     The number of nodes allocated to this cluster. More nodes enable higher
-        #     throughput and more consistent performance.
+        #     Required. The number of nodes allocated to this cluster. More nodes enable
+        #     higher throughput and more consistent performance.
         # @!attribute [rw] default_storage_type
         #   @return [Google::Bigtable::Admin::V2::StorageType]
         #     (`CreationOnly`)
@@ -165,19 +162,20 @@ module Google
         #     Optional long form description of the use case for this AppProfile.
         # @!attribute [rw] multi_cluster_routing_use_any
         #   @return [Google::Bigtable::Admin::V2::AppProfile::MultiClusterRoutingUseAny]
-        #     Use a multi-cluster routing policy that may pick any cluster.
+        #     Use a multi-cluster routing policy.
         # @!attribute [rw] single_cluster_routing
         #   @return [Google::Bigtable::Admin::V2::AppProfile::SingleClusterRouting]
         #     Use a single-cluster routing policy.
         class AppProfile
-          # Read/write requests may be routed to any cluster in the instance, and will
-          # fail over to another cluster in the event of transient errors or delays.
-          # Choosing this option sacrifices read-your-writes consistency to improve
-          # availability.
+          # Read/write requests are routed to the nearest cluster in the instance, and
+          # will fail over to the nearest cluster that is available in the event of
+          # transient errors or delays. Clusters in a region are considered
+          # equidistant. Choosing this option sacrifices read-your-writes consistency
+          # to improve availability.
           class MultiClusterRoutingUseAny; end
 
           # Unconditionally routes all read/write requests to a specific cluster.
-          # This option preserves read-your-writes consistency, but does not improve
+          # This option preserves read-your-writes consistency but does not improve
           # availability.
           # @!attribute [rw] cluster_id
           #   @return [String]

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

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# Copyright 2020 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -17,18 +17,26 @@ module Google
   module Bigtable
     module Admin
       module V2
+        # Information about a table restore.
+        # @!attribute [rw] source_type
+        #   @return [Google::Bigtable::Admin::V2::RestoreSourceType]
+        #     The type of the restore source.
+        # @!attribute [rw] backup_info
+        #   @return [Google::Bigtable::Admin::V2::BackupInfo]
+        #     Information about the backup used to restore the table. The backup
+        #     may no longer exist.
+        class RestoreInfo; end
+
         # A collection of user data indexed by row, column, and timestamp.
         # Each table is served using the resources of its parent cluster.
         # @!attribute [rw] name
         #   @return [String]
-        #     (`OutputOnly`)
-        #     The unique name of the table. Values are of the form
+        #     Output only. 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`
         # @!attribute [rw] cluster_states
         #   @return [Hash{String => Google::Bigtable::Admin::V2::Table::ClusterState}]
-        #     (`OutputOnly`)
-        #     Map from cluster ID to per-cluster table state.
+        #     Output only. 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`.
@@ -44,13 +52,16 @@ module Google
         #     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`
+        #     Views: `SCHEMA_VIEW`, `FULL`.
+        # @!attribute [rw] restore_info
+        #   @return [Google::Bigtable::Admin::V2::RestoreInfo]
+        #     Output only. If this table was restored from another data source (e.g. a
+        #     backup), this field will be populated with information about the restore.
         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`)
-          #     The state of replication for the table in this cluster.
+          #     Output only. The state of replication for the table in this cluster.
           class ClusterState
             # Table replication states.
             module ReplicationState
@@ -74,6 +85,11 @@ module Google
               # replication delay, reads may not immediately reflect the state of the
               # table in other clusters.
               READY = 4
+
+              # The table is fully created and ready for use after a restore, and is
+              # being optimized for performance. When optimizations are complete, the
+              # table will transition to `READY` state.
+              READY_OPTIMIZING = 5
             end
           end
 
@@ -99,8 +115,8 @@ module Google
             # Only populates `name` and fields related to the table's schema.
             SCHEMA_VIEW = 2
 
-            # Only populates `name` and fields related to the table's
-            # replication state.
+            # Only populates `name` and fields related to the table's replication
+            # state.
             REPLICATION_VIEW = 3
 
             # Populates all fields.
@@ -157,38 +173,32 @@ module Google
         # for production use. It is not subject to any SLA or deprecation policy.
         # @!attribute [rw] name
         #   @return [String]
-        #     (`OutputOnly`)
-        #     The unique name of the snapshot.
+        #     Output only. The unique name of the snapshot.
         #     Values are of the form
         #     `projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>`.
         # @!attribute [rw] source_table
         #   @return [Google::Bigtable::Admin::V2::Table]
-        #     (`OutputOnly`)
-        #     The source table at the time the snapshot was taken.
+        #     Output only. The source table at the time the snapshot was taken.
         # @!attribute [rw] data_size_bytes
         #   @return [Integer]
-        #     (`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.
+        #     Output only. 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`)
-        #     The time when the snapshot is created.
+        #     Output only. The time when the snapshot is created.
         # @!attribute [rw] delete_time
         #   @return [Google::Protobuf::Timestamp]
-        #     (`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,
+        #     Output only. 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`)
-        #     The current state of the snapshot.
+        #     Output only. The current state of the snapshot.
         # @!attribute [rw] description
         #   @return [String]
-        #     (`OutputOnly`)
-        #     Description of the snapshot.
+        #     Output only. Description of the snapshot.
         class Snapshot
           # Possible states of a snapshot.
           module State
@@ -204,6 +214,89 @@ module Google
             CREATING = 2
           end
         end
+
+        # A backup of a Cloud Bigtable table.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Output only. A globally unique identifier for the backup which cannot be
+        #     changed. Values are of the form
+        #     `projects/{project}/instances/{instance}/clusters/{cluster}/
+        #        backups/[_a-zA-Z0-9][-_.a-zA-Z0-9]*`
+        #     The final segment of the name must be between 1 and 50 characters
+        #     in length.
+        #
+        #     The backup is stored in the cluster identified by the prefix of the backup
+        #     name of the form
+        #     `projects/{project}/instances/{instance}/clusters/{cluster}`.
+        # @!attribute [rw] source_table
+        #   @return [String]
+        #     Required. Immutable. Name of the table from which this backup was created.
+        #     This needs to be in the same instance as the backup. Values are of the form
+        #     `projects/{project}/instances/{instance}/tables/{source_table}`.
+        # @!attribute [rw] expire_time
+        #   @return [Google::Protobuf::Timestamp]
+        #     Required. The expiration time of the backup, with microseconds
+        #     granularity that must be at least 6 hours and at most 30 days
+        #     from the time the request is received. Once the `expire_time`
+        #     has passed, Cloud Bigtable will delete the backup and free the
+        #     resources used by the backup.
+        # @!attribute [rw] start_time
+        #   @return [Google::Protobuf::Timestamp]
+        #     Output only. `start_time` is the time that the backup was started
+        #     (i.e. approximately the time the
+        #     {Google::Bigtable::Admin::V2::BigtableTableAdmin::CreateBackup CreateBackup}
+        #     request is received).  The row data in this backup will be no older than
+        #     this timestamp.
+        # @!attribute [rw] end_time
+        #   @return [Google::Protobuf::Timestamp]
+        #     Output only. `end_time` is the time that the backup was finished. The row
+        #     data in the backup will be no newer than this timestamp.
+        # @!attribute [rw] size_bytes
+        #   @return [Integer]
+        #     Output only. Size of the backup in bytes.
+        # @!attribute [rw] state
+        #   @return [Google::Bigtable::Admin::V2::Backup::State]
+        #     Output only. The current state of the backup.
+        class Backup
+          # Indicates the current state of the backup.
+          module State
+            # Not specified.
+            STATE_UNSPECIFIED = 0
+
+            # The pending backup is still being created. Operations on the
+            # backup may fail with `FAILED_PRECONDITION` in this state.
+            CREATING = 1
+
+            # The backup is complete and ready for use.
+            READY = 2
+          end
+        end
+
+        # Information about a backup.
+        # @!attribute [rw] backup
+        #   @return [String]
+        #     Output only. Name of the backup.
+        # @!attribute [rw] start_time
+        #   @return [Google::Protobuf::Timestamp]
+        #     Output only. The time that the backup was started. Row data in the backup
+        #     will be no older than this timestamp.
+        # @!attribute [rw] end_time
+        #   @return [Google::Protobuf::Timestamp]
+        #     Output only. This time that the backup was finished. Row data in the
+        #     backup will be no newer than this timestamp.
+        # @!attribute [rw] source_table
+        #   @return [String]
+        #     Output only. Name of the table the backup was created from.
+        class BackupInfo; end
+
+        # Indicates the type of the restore source.
+        module RestoreSourceType
+          # No restore associated.
+          RESTORE_SOURCE_TYPE_UNSPECIFIED = 0
+
+          # A backup was used as the source of the restore.
+          BACKUP = 1
+        end
       end
     end
   end

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

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# Copyright 2020 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# Copyright 2020 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# Copyright 2020 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# Copyright 2020 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -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 be a resource name ending with `operations/{unique_id}`.
     # @!attribute [rw] metadata
     #   @return [Google::Protobuf::Any]
     #     Service-specific metadata associated with the operation.  It typically

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

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# Copyright 2020 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# Copyright 2020 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# Copyright 2020 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# Copyright 2020 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# Copyright 2020 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# Copyright 2020 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -17,67 +17,19 @@ module Google
   module Rpc
     # 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:
+    # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+    # three pieces of data: error code, error message, and error details.
     #
-    # * Simple to use and understand for most users
-    # * Flexible enough to meet unexpected needs
-    #
-    # = Overview
-    #
-    # 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 developers *understand* and *resolve* the error. If a localized
-    # user-facing 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.
-    #
-    # = 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
-    # 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
-    # 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
-    #   errors.
-    #
-    # * Workflow errors. A typical workflow has multiple steps. Each step may
-    #   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
-    #   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.
-    #
-    # * Logging. If some API errors are stored in logs, the message `Status` could
-    #   be used directly after any stripping needed for security/privacy reasons.
+    # You can find out more about this error model and how to work with it in the
+    # [API Design Guide](https://cloud.google.com/apis/design/errors).
     # @!attribute [rw] code
     #   @return [Integer]
-    #     The status code, which should be an enum value of
-    #     {Google::Rpc::Code}.
+    #     The status code, which should be an enum value of {Google::Rpc::Code}.
     # @!attribute [rw] message
     #   @return [String]
     #     A developer-facing error message, which should be in English. Any
     #     user-facing error message should be localized and sent in the
-    #     {Google::Rpc::Status#details} field, or localized
-    #     by the client.
+    #     {Google::Rpc::Status#details} field, or localized by the client.
     # @!attribute [rw] details
     #   @return [Array<Google::Protobuf::Any>]
     #     A list of messages that carry the error details.  There is a common set of

data/lib/google/cloud/bigtable/admin/v2/doc/google/type/expr.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# Copyright 2020 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.