google-cloud-bigtable 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 109fb6841cdecd45ebfadc3c2bafd019010847bbe9592ad9f2d9d44e56000d06
+  data.tar.gz: 41b10cd762bc1c11ef42754af3fb6dc3e9bc5d97bd75e84c74752228596bb245
+SHA512:
+  metadata.gz: 63fda26d33b5b2185086377ecf4ca64d99d20e19013b97b7a34a11164baefbc2e09e444e4304a22a4ac5da49013bb09803e0d81b55bcd3ac8f94f712e320043d
+  data.tar.gz: ec6d0a4356a0fb357264bd72654cfb21581c9787e5594e016e81d286345ef25ad6b8b8eb450dd26de061e5ca0ee32bf337fb43beb0847197d039b4007f74b5f0

data/.yardopts

@@ -0,0 +1,19 @@
+--no-private
+--title=Cloud Bigtable API
+--exclude _pb\.rb$
+--markup markdown
+--markup-provider redcarpet
+--embed-mixins
+--main OVERVIEW.md
+
+./lib/**/*.rb
+-
+OVERVIEW.md
+AUTHENTICATION.md
+EMULATOR.md
+LOGGING.md
+CONTRIBUTING.md
+TROUBLESHOOTING.md
+CHANGELOG.md
+CODE_OF_CONDUCT.md
+LICENSE

data/AUTHENTICATION.md

@@ -0,0 +1,177 @@
+# Authentication
+
+In general, the google-cloud-bigtable library uses [Service
+Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
+credentials to connect to Google Cloud services. When running within [Google
+Cloud Platform environments](#google-cloud-platform-environments)
+the credentials will be discovered automatically. When running on other
+environments, the Service Account credentials can be specified by providing the
+path to the [JSON
+keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys) for
+the account (or the JSON itself) in [environment
+variables](#environment-variables). Additionally, Cloud SDK credentials can also
+be discovered automatically, but this is only recommended during development.
+
+## Quickstart
+
+1. [Create a service account and credentials](#creating-a-service-account).
+2. Set the [environment variable](#environment-variables).
+
+```sh
+export BIGTABLE_CREDENTIALS=/path/to/json`
+```
+
+3. Initialize the client.
+
+```ruby
+require "google/cloud/bigtable"
+
+client = Google::Cloud::Bigtable.new
+```
+
+## Project and Credential Lookup
+
+The google-cloud-bigtable library aims to make authentication
+as simple as possible, and provides several mechanisms to configure your system
+without providing **Project ID** and **Service Account Credentials** directly in
+code.
+
+**Project ID** is discovered in the following order:
+
+1. Specify project ID in method arguments
+2. Specify project ID in configuration
+3. Discover project ID in environment variables
+4. Discover GCE project ID
+5. Discover project ID in credentials JSON
+
+**Credentials** are discovered in the following order:
+
+1. Specify credentials in method arguments
+2. Specify credentials in configuration
+3. Discover credentials path in environment variables
+4. Discover credentials JSON in environment variables
+5. Discover credentials file in the Cloud SDK's path
+6. Discover GCE credentials
+
+### Google Cloud Platform environments
+
+When running on Google Cloud Platform (GCP), including Google Compute Engine (GCE),
+Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud Functions
+(GCF) and Cloud Run, the **Project ID** and **Credentials** and are discovered
+automatically. Code should be written as if already authenticated.
+
+### Environment Variables
+
+The **Project ID** and **Credentials JSON** can be placed in environment
+variables instead of declaring them directly in code. Each service has its own
+environment variable, allowing for different service accounts to be used for
+different services. (See the READMEs for the individual service gems for
+details.) The path to the **Credentials JSON** file can be stored in the
+environment variable, or the **Credentials JSON** itself can be stored for
+environments such as Docker containers where writing files is difficult or not
+encouraged.
+
+The environment variables that google-cloud-bigtable checks for project ID are:
+
+1. `BIGTABLE_PROJECT`
+2. `GOOGLE_CLOUD_PROJECT`
+
+The environment variables that google-cloud-bigtable checks for credentials are configured on {Google::Cloud::Bigtable::V2::Credentials}:
+
+1. `BIGTABLE_CREDENTIALS` - Path to JSON file, or JSON contents
+2. `BIGTABLE_KEYFILE` - Path to JSON file, or JSON contents
+3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
+5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+
+```ruby
+require "google/cloud/bigtable"
+
+ENV["BIGTABLE_PROJECT"]     = "my-project-id"
+ENV["BIGTABLE_CREDENTIALS"] = "path/to/keyfile.json"
+
+client = Google::Cloud::Bigtable.new
+```
+
+### Configuration
+
+The **Project ID** and **Credentials JSON** can be configured instead of placing them in environment variables or providing them as arguments.
+
+```ruby
+require "google/cloud/bigtable"
+
+Google::Cloud::Bigtable.configure do |config|
+  config.project_id  = "my-project-id"
+  config.credentials = "path/to/keyfile.json"
+end
+
+client = Google::Cloud::Bigtable.new
+```
+
+### Cloud SDK
+
+This option allows for an easy way to authenticate during development. If
+credentials are not provided in code or in environment variables, then Cloud SDK
+credentials are discovered.
+
+To configure your system for this, simply:
+
+1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
+2. Authenticate using OAuth 2.0 `$ gcloud auth login`
+3. Write code as if already authenticated.
+
+**NOTE:** This is _not_ recommended for running in production. The Cloud SDK
+*should* only be used during development.
+
+[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
+[dev-console]: https://console.cloud.google.com/project
+
+[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
+
+[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
+[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
+[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
+
+## Creating a Service Account
+
+Google Cloud requires a **Project ID** and **Service Account Credentials** to
+connect to the APIs. You will use the **Project ID** and **JSON key file** to
+connect to most services with google-cloud-bigtable.
+
+If you are not running this client within [Google Cloud Platform
+environments](#google-cloud-platform-environments), you need a Google
+Developers service account.
+
+1. Visit the [Google Developers Console][dev-console].
+1. Create a new project or click on an existing project.
+1. Activate the slide-out navigation tray and select **API Manager**. From
+   here, you will enable the APIs that your application requires.
+
+   ![Enable the APIs that your application requires][enable-apis]
+
+   *Note: You may need to enable billing in order to use these services.*
+
+1. Select **Credentials** from the side navigation.
+
+   You should see a screen like one of the following.
+
+   ![Create a new service account][create-new-service-account]
+
+   ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
+
+   Find the "Add credentials" drop down and select "Service account" to be
+   guided through downloading a new JSON key file.
+
+   If you want to re-use an existing service account, you can easily generate a
+   new key file. Just select the account you wish to re-use, and click "Generate
+   new JSON key":
+
+   ![Re-use an existing service account][reuse-service-account]
+
+   The key file you download will be used by this library to authenticate API
+   requests and should be stored in a secure location.
+
+## Troubleshooting
+
+If you're having trouble authenticating you can ask for help by following the
+{file:TROUBLESHOOTING.md Troubleshooting Guide}.

data/CHANGELOG.md

@@ -0,0 +1,223 @@
+# Release History
+
+### 1.3.0 / 2020-07-21
+
+#### Features
+
+* Add Managed Backups
+  * Add Cluster#create_backup, Cluster#backup and Cluster#backups
+  * Add Backup, Backup::Job and Backup::List
+  * Add Table::RestoreJob
+  * Add ClusterState#ready_optimizing?
+
+### 1.2.2 / 2020-05-28
+
+#### Documentation
+
+* Fix a few broken links
+
+### 1.2.1 / 2020-05-21
+
+#### Bug Fixes
+
+* Disable streaming RPC retries in lower-level client
+
+### 1.2.0 / 2020-03-11
+
+#### Features
+
+* Support separate project setting for quota/billing
+
+### 1.1.0 / 2020-02-10
+
+#### Features
+
+* Add Table-level IAM Policy support
+
+### 1.0.2 / 2020-01-23
+
+#### Documentation
+
+* Update copyright year
+* Update Status documentation
+
+### 1.0.1 / 2020-01-15
+
+#### Documentation
+
+* Update lower-level API documentation
+
+### 1.0.0 / 2019-12-03
+
+#### Documentation
+
+* Update release level to GA
+* Add OVERVIEW.md guide with samples
+* Add sample to README.md
+* Fix samples and copy edit all in-line documentation
+* Correct error in lower-level API Table IAM documentation
+* Update lower-level API documentation to indicate attributes as required
+* Update low-level IAM Policy documentation
+
+### 0.8.0 / 2019-11-01
+
+#### ⚠ BREAKING CHANGES
+
+* The following methods now raise Google::Cloud::Error instead of
+  Google::Gax::GaxError and/or GRPC::BadStatus:
+  * Table#mutate_row
+  * Table#read_modify_write_row
+  * Table#check_and_mutate_row
+  * Table#sample_row_keys
+
+#### Features
+
+* Raise Google::Cloud::Error from Table#mutate_row, Table#read_modify_write_row,
+  Table#check_and_mutate_row, and Table#sample_row_keys.
+
+#### Bug Fixes
+
+* Update minimum runtime dependencies
+
+#### Documentation
+
+* Update the list of GCP environments for automatic authentication
+
+### 0.7.0 / 2019-10-22
+
+#### Features
+
+* Update Table#column_families to yield ColumnFamilyMap for updates.
+  * ColumnFamilyMap now manages ColumnFamily lifecycle.
+* Add MutationOperations::Response.
+* Add Bigtable::Status.
+* Add Bigtable::RoutingPolicy.
+* Update Ruby dependency to minimum of 2.4.
+
+#### BREAKING CHANGES
+
+* Remove ColumnFamily lifecycle methods (create, save, delete, and related class methods).
+  * Replaced by Table#column_families yield block.
+* Move Google::Cloud::Bigtable::Table::ColumnFamilyMap to Google::Cloud::Bigtable::ColumnFamilyMap.
+  * This should only affect introspection, since the constructor was previously undocumented.
+* Remove Project#modify_column_families.
+  * Replaced by Table#column_families yield block.
+* Remove Table#column_family.
+  * Replaced by ColumnFamilyMap lifecycle methods.
+* Remove Table#modify_column_families.
+  * Replaced by Table#column_families yield block.
+* Update GcRule#union and #intersection to not return lower-level API types.
+* Update all return types and parameters associated with AppProfile routing policy to not use lower-level API types.
+  * The new types have exactly the same API as the old types, so this change should only affect type introspection.
+* Update return types of Chain and Interleave row filters to not use lower-level API types.
+* Change return type of MutationOperations#mutate_rows from lower-level API types to wrapper types.
+* Remove private MutationEntry#mutations from documentation.
+* Update GcRule#max_age to microsecond precision.
+
+#### Documentation
+
+* Update sample code.
+* Update documentation.
+
+### 0.6.2 / 2019-10-01
+
+#### Documentation
+
+* Fix role string in low-level IAM Policy JSON example
+* Update low-level IAM Policy class description and sample code
+
+### 0.6.1 / 2019-09-05
+
+#### Features
+	
+* Add IAM to low-level API client
+  * Add BigtableTableAdminClient#get_iam_policy
+  * Add BigtableTableAdminClient#set_iam_policy
+  * Add BigtableTableAdminClient#test_iam_permissions
+
+#### Documentation
+
+* Update low-level IAM documentation
+  * Update GetPolicyOption#requested_policy_version docs
+  * Un-deprecate Policy#version
+
+### 0.6.0 / 2019-08-23
+
+#### Features
+
+* Support overriding of the service endpoint
+
+#### Documentation
+
+* Update documentation
+
+### 0.5.0 / 2019-08-05
+
+* Accept nil gc_rule arguments for column_family create/update
+* Update documentation
+
+### 0.4.3 / 2019-07-12
+
+* Update #to_hash to #to_h for compatibility with google-protobuf >= 3.9.0
+
+### 0.4.2 / 2019-07-09
+
+* Add IAM GetPolicyOptions in the lower-level interface.
+* Custom metadata headers are honored by long running operations calls.
+* Support overriding service host and port in the lower-level interface.
+
+### 0.4.1 / 2019-06-11
+
+* Enable grpc.service_config_disable_resolution
+* Add VERSION constant
+
+### 0.4.0 / 2019-05-21
+
+* Add Google::Cloud::Bigtable::VERSION
+* Set gRPC headers to allow maximum message size
+* Fix errors in code sample documentation
+
+### 0.3.1 / 2019-04-29
+
+* Add AUTHENTICATION.md guide.
+* Update generated documentation.
+* Update generated code examples.
+* Extract gRPC header values from request.
+
+### 0.3.0 / 2019-02-01
+
+* Move library to Beta.
+* Make use of Credentials#project_id
+  * Use Credentials#project_id
+    If a project_id is not provided, use the value on the Credentials object.
+    This value was added in googleauth 0.7.0.
+  * Loosen googleauth dependency
+    Allow for new releases up to 0.10.
+    The googleauth devs have committed to maintaining the current API
+    and will not make backwards compatible changes before 0.10.
+
+### 0.2.0 / 2018-11-15
+
+* Update network configuration.
+* Allow the emulator host to be provided in the BIGTABLE_EMULATOR_HOST
+  environment variable, or the emulator_host argument.
+* Add EMULATOR guide to show how to configure and use the emulator.
+* Update documentation.
+
+### 0.1.3 / 2018-09-20
+
+* Update connectivity configuration.
+* Update documentation.
+  * Change documentation URL to googleapis GitHub org.
+
+### 0.1.2 / 2018-09-12
+
+* Add missing documentation files to package.
+
+### 0.1.1 / 2018-09-10
+
+* Update documentation.
+
+### 0.1.0 / 2018-08-16
+
+* Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,40 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct. By adopting this Code of Conduct, project
+maintainers commit themselves to fairly and consistently applying these
+principles to every aspect of managing this project. Project maintainers who do
+not follow or enforce the Code of Conduct may be permanently removed from the
+project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by opening an issue or contacting one or more of the project
+maintainers.
+
+This Code of Conduct is adapted from the [Contributor
+Covenant](http://contributor-covenant.org), version 1.2.0, available at
+[http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)