google-cloud-bigtable 1.2.0 → 2.1.0

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

@@ -1,200 +0,0 @@
-# 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.
-# You may obtain a copy of the License at
-#
-#     https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-
-module Google
-  module Bigtable
-    module Admin
-      module V2
-        # 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]
-        #     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}]
-        #     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`.
-        #     Views: `REPLICATION_VIEW`, `FULL`
-        # @!attribute [rw] column_families
-        #   @return [Hash{String => Google::Bigtable::Admin::V2::ColumnFamily}]
-        #     (`CreationOnly`)
-        #     The column families configured for this table, mapped by column family ID.
-        #     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
-        #     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`.
-        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]
-          #     Output only. The state of replication for the table in this cluster.
-          class ClusterState
-            # Table replication states.
-            module ReplicationState
-              # The replication state of the table is unknown in this cluster.
-              STATE_NOT_KNOWN = 0
-
-              # The cluster was recently created, and the table must finish copying
-              # over pre-existing data from other clusters before it can begin
-              # receiving live replication updates and serving Data API requests.
-              INITIALIZING = 1
-
-              # The table is temporarily unable to serve Data API requests from this
-              # cluster due to planned internal maintenance.
-              PLANNED_MAINTENANCE = 2
-
-              # The table is temporarily unable to serve Data API requests from this
-              # cluster due to unplanned or emergency maintenance.
-              UNPLANNED_MAINTENANCE = 3
-
-              # The table can serve Data API requests from this cluster. Depending on
-              # replication delay, reads may not immediately reflect the state of the
-              # table in other clusters.
-              READY = 4
-            end
-          end
-
-          # Possible timestamp granularities to use when keeping multiple versions
-          # of data in a table.
-          module TimestampGranularity
-            # The user did not specify a granularity. Should not be returned.
-            # When specified during table creation, MILLIS will be used.
-            TIMESTAMP_GRANULARITY_UNSPECIFIED = 0
-
-            # The table keeps data versioned at a granularity of 1ms.
-            MILLIS = 1
-          end
-
-          # Defines a view over a table's fields.
-          module View
-            # Uses the default view for each method as documented in its request.
-            VIEW_UNSPECIFIED = 0
-
-            # Only populates `name`.
-            NAME_ONLY = 1
-
-            # 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.
-            REPLICATION_VIEW = 3
-
-            # Populates all fields.
-            FULL = 4
-          end
-        end
-
-        # A set of columns within a table which share a common configuration.
-        # @!attribute [rw] gc_rule
-        #   @return [Google::Bigtable::Admin::V2::GcRule]
-        #     Garbage collection rule specified as a protobuf.
-        #     Must serialize to at most 500 bytes.
-        #
-        #     NOTE: Garbage collection executes opportunistically in the background, and
-        #     so it's possible for reads to return a cell even if it matches the active
-        #     GC expression for its family.
-        class ColumnFamily; end
-
-        # Rule for determining which cells to delete during garbage collection.
-        # @!attribute [rw] max_num_versions
-        #   @return [Integer]
-        #     Delete all cells in a column except the most recent N.
-        # @!attribute [rw] max_age
-        #   @return [Google::Protobuf::Duration]
-        #     Delete cells in a column older than the given age.
-        #     Values must be at least one millisecond, and will be truncated to
-        #     microsecond granularity.
-        # @!attribute [rw] intersection
-        #   @return [Google::Bigtable::Admin::V2::GcRule::Intersection]
-        #     Delete cells that would be deleted by every nested rule.
-        # @!attribute [rw] union
-        #   @return [Google::Bigtable::Admin::V2::GcRule::Union]
-        #     Delete cells that would be deleted by any nested rule.
-        class GcRule
-          # 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`.
-          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`.
-          class Union; end
-        end
-
-        # A snapshot of a table at a particular time. A snapshot can be used as a
-        # checkpoint for data restoration or a data source for a new table.
-        #
-        # Note: This is a private alpha release of Cloud Bigtable snapshots. This
-        # feature is not currently available to most Cloud Bigtable customers. This
-        # 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] name
-        #   @return [String]
-        #     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]
-        #     Output only. The source table at the time the snapshot was taken.
-        # @!attribute [rw] data_size_bytes
-        #   @return [Integer]
-        #     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]
-        #     Output only. The time when the snapshot is created.
-        # @!attribute [rw] delete_time
-        #   @return [Google::Protobuf::Timestamp]
-        #     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]
-        #     Output only. The current state of the snapshot.
-        # @!attribute [rw] description
-        #   @return [String]
-        #     Output only. Description of the snapshot.
-        class Snapshot
-          # Possible states of a snapshot.
-          module State
-            # The state of the snapshot could not be determined.
-            STATE_NOT_KNOWN = 0
-
-            # The snapshot has been successfully created and can serve all requests.
-            READY = 1
-
-            # The snapshot is currently being created, and may be destroyed if the
-            # creation process encounters an error. A snapshot may not be restored to a
-            # table while it is being created.
-            CREATING = 2
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,64 +0,0 @@
-# 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.
-# You may obtain a copy of the License at
-#
-#     https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-
-module Google
-  module Iam
-    module V1
-      # Request message for `SetIamPolicy` method.
-      # @!attribute [rw] resource
-      #   @return [String]
-      #     REQUIRED: The resource for which the policy is being specified.
-      #     See the operation documentation for the appropriate value for this field.
-      # @!attribute [rw] policy
-      #   @return [Google::Iam::V1::Policy]
-      #     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.
-      # @!attribute [rw] resource
-      #   @return [String]
-      #     REQUIRED: The resource for which the policy is being requested.
-      #     See the operation documentation for the appropriate value for this field.
-      # @!attribute [rw] options
-      #   @return [Google::Iam::V1::GetPolicyOptions]
-      #     OPTIONAL: A `GetPolicyOptions` object for specifying options to
-      #     `GetIamPolicy`. This field is only used by Cloud IAM.
-      class GetIamPolicyRequest; end
-
-      # Request message for `TestIamPermissions` method.
-      # @!attribute [rw] resource
-      #   @return [String]
-      #     REQUIRED: The resource for which the policy detail is being requested.
-      #     See the operation documentation for the appropriate value for this field.
-      # @!attribute [rw] permissions
-      #   @return [Array<String>]
-      #     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.
-      # @!attribute [rw] permissions
-      #   @return [Array<String>]
-      #     A subset of `TestPermissionsRequest.permissions` that the caller is
-      #     allowed.
-      class TestIamPermissionsResponse; end
-    end
-  end
-end

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

@@ -1,33 +0,0 @@
-# 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.
-# You may obtain a copy of the License at
-#
-#     https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-
-module Google
-  module Iam
-    module V1
-      # Encapsulates settings provided to GetIamPolicy.
-      # @!attribute [rw] requested_policy_version
-      #   @return [Integer]
-      #     Optional. The policy format version to be returned.
-      #
-      #     Valid values are 0, 1, and 3. Requests specifying an invalid value will be
-      #     rejected.
-      #
-      #     Requests for policies with any conditional bindings must specify version 3.
-      #     Policies without any conditional bindings may specify any valid value or
-      #     leave the field unset.
-      class GetPolicyOptions; end
-    end
-  end
-end

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

@@ -1,151 +0,0 @@
-# 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.
-# You may obtain a copy of the License at
-#
-#     https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-
-module Google
-  module Iam
-    module V1
-      # Defines an Identity and Access Management (IAM) policy. It is used to
-      # specify access control policies for Cloud Platform resources.
-      #
-      #
-      # A `Policy` is a collection of `bindings`. A `binding` binds one or more
-      # `members` to a single `role`. Members can be user accounts, service accounts,
-      # Google groups, and domains (such as G Suite). A `role` is a named list of
-      # permissions (defined by IAM or configured by users). A `binding` can
-      # optionally specify a `condition`, which is a logic expression that further
-      # constrains the role binding based on attributes about the request and/or
-      # target resource.
-      #
-      # **JSON Example**
-      #
-      #     {
-      #       "bindings": [
-      #         {
-      #           "role": "roles/resourcemanager.organizationAdmin",
-      #           "members": [
-      #             "user:mike@example.com",
-      #             "group:admins@example.com",
-      #             "domain:google.com",
-      #             "serviceAccount:my-project-id@appspot.gserviceaccount.com"
-      #           ]
-      #         },
-      #         {
-      #           "role": "roles/resourcemanager.organizationViewer",
-      #           "members": ["user:eve@example.com"],
-      #           "condition": {
-      #             "title": "expirable access",
-      #             "description": "Does not grant access after Sep 2020",
-      #             "expression": "request.time <
-      #             timestamp('2020-10-01T00:00:00.000Z')",
-      #           }
-      #         }
-      #       ]
-      #     }
-      #
-      # **YAML Example**
-      #
-      #     bindings:
-      # * members:
-      #   * user:mike@example.com
-      #     * group:admins@example.com
-      #       * domain:google.com
-      #       * serviceAccount:my-project-id@appspot.gserviceaccount.com
-      #         role: roles/resourcemanager.organizationAdmin
-      #       * members:
-      #       * user:eve@example.com
-      #         role: roles/resourcemanager.organizationViewer
-      #         condition:
-      #         title: expirable access
-      #         description: Does not grant access after Sep 2020
-      #         expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
-      #
-      #       For a description of IAM and its features, see the
-      #       [IAM developer's guide](https://cloud.google.com/iam/docs).
-      # @!attribute [rw] version
-      #   @return [Integer]
-      #     Specifies the format of the policy.
-      #
-      #     Valid values are 0, 1, and 3. Requests specifying an invalid value will be
-      #     rejected.
-      #
-      #     Operations affecting conditional bindings must specify version 3. This can
-      #     be either setting a conditional policy, modifying a conditional binding,
-      #     or removing a binding (conditional or unconditional) from the stored
-      #     conditional policy.
-      #     Operations on non-conditional policies may specify any valid value or
-      #     leave the field unset.
-      #
-      #     If no etag is provided in the call to `setIamPolicy`, version compliance
-      #     checks against the stored policy is skipped.
-      # @!attribute [rw] bindings
-      #   @return [Array<Google::Iam::V1::Binding>]
-      #     Associates a list of `members` to a `role`. Optionally may specify a
-      #     `condition` that determines when binding is in effect.
-      #     `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
-      #     prevent simultaneous updates of a policy from overwriting each other.
-      #     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
-      #     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
-      #     policy is overwritten. Due to blind-set semantics of an etag-less policy,
-      #     'setIamPolicy' will not fail even if the incoming policy version does not
-      #     meet the requirements for modifying the stored policy.
-      class Policy; end
-
-      # 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`.
-      # @!attribute [rw] members
-      #   @return [Array<String>]
-      #     Specifies the identities requesting access for a Cloud Platform resource.
-      #     `members` can have the following values:
-      #
-      #     * `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
-      #       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@example.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`.
-      #
-      #
-      #     * `domain:{domain}`: The G Suite domain (primary) that represents all the
-      #       users of that domain. For example, `google.com` or `example.com`.
-      # @!attribute [rw] condition
-      #   @return [Google::Type::Expr]
-      #     The condition that is associated with this binding.
-      #     NOTE: An unsatisfied condition will not allow user access via current
-      #     binding. Different bindings, including their conditions, are examined
-      #     independently.
-      class Binding; end
-    end
-  end
-end