forked from googleapis/google-cloud-ruby
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add content to individual gems READMEs
[closes googleapis#832]
- Loading branch information
Showing
12 changed files
with
720 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,30 @@ | ||
# gcloud | ||
|
||
This library exists to facilitate the transition of legacy code using the `Gcloud` namespace to the current `Google::Cloud` namespace. Please see the top-level project [README](../README.md) for general information about the google-cloud gems. | ||
|
||
## Supported Ruby Versions | ||
|
||
This library is supported on Ruby 2.0+. | ||
|
||
## Versioning | ||
|
||
This library follows [Semantic Versioning](http://semver.org/). | ||
|
||
It is currently in major version zero (0.y.z), which means that anything may change at any time and the public API should not be considered stable. | ||
|
||
## Contributing | ||
|
||
Contributions to this library are always welcome and highly encouraged. | ||
|
||
See the [Contributing Guide](https://googlecloudplatform.github.io/gcloud-ruby/#/docs/guides/contributing) for more information on how to get started. | ||
|
||
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See [Code of Conduct](../CODE_OF_CONDUCT.md) for more information. | ||
|
||
## License | ||
|
||
This library is licensed under Apache 2.0. Full license text is available in [LICENSE](../LICENSE). | ||
|
||
## Support | ||
|
||
Please [report bugs at the project on Github](https://github.com/GoogleCloudPlatform/gcloud-ruby/issues). | ||
Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/gcloud-ruby) about the client or APIs on [StackOverflow](http://stackoverflow.com). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,67 @@ | ||
# google-cloud-bigquery | ||
|
||
Google Cloud BigQuery enables super-fast, SQL-like queries against massive | ||
datasets, using the processing power of Google's infrastructure. | ||
|
||
- [google-cloud-bigquery API documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs/google-cloud-bigquery/google/cloud/bigquery) | ||
- [Google Cloud BigQuery documentation](https://cloud.google.com/bigquery/docs) | ||
|
||
## Authentication | ||
|
||
This library uses Service Account credentials to connect to Google Cloud services. When running on Compute Engine 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 file, or the JSON itself, in environment variables. | ||
|
||
Instructions and configuration options are covered in the [Authentication Guide](https://googlecloudplatform.github.io/gcloud-ruby/#/docs/google-cloud-bigquery/guides/authentication). | ||
|
||
## Example | ||
|
||
```ruby | ||
require "google/cloud" | ||
|
||
gcloud = Google::Cloud.new "my-todo-project-id", | ||
"/path/to/keyfile.json" | ||
bigquery = gcloud.bigquery | ||
|
||
# Create a new table to archive todos | ||
dataset = bigquery.dataset "my-todo-archive" | ||
table = dataset.create_table "todos", | ||
name: "Todos Archive", | ||
description: "Archive for completed TODO records" | ||
|
||
# Load data into the table | ||
file = File.open "/archive/todos/completed-todos.csv" | ||
load_job = table.load file | ||
|
||
# Run a query for the number of completed todos by owner | ||
count_sql = "SELECT owner, COUNT(*) AS complete_count FROM todos GROUP BY owner" | ||
data = bigquery.query count_sql | ||
data.each do |row| | ||
puts row["name"] | ||
end | ||
``` | ||
|
||
## Supported Ruby Versions | ||
|
||
This library is supported on Ruby 2.0+. | ||
|
||
## Versioning | ||
|
||
This library follows [Semantic Versioning](http://semver.org/). | ||
|
||
It is currently in major version zero (0.y.z), which means that anything may change at any time and the public API should not be considered stable. | ||
|
||
## Contributing | ||
|
||
Contributions to this library are always welcome and highly encouraged. | ||
|
||
See the [Contributing Guide](https://googlecloudplatform.github.io/gcloud-ruby/#/docs/guides/contributing) for more information on how to get started. | ||
|
||
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See [Code of Conduct](../CODE_OF_CONDUCT.md) for more information. | ||
|
||
## License | ||
|
||
This library is licensed under Apache 2.0. Full license text is available in [LICENSE](../LICENSE). | ||
|
||
## Support | ||
|
||
Please [report bugs at the project on Github](https://github.com/GoogleCloudPlatform/gcloud-ruby/issues). | ||
Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/gcloud-ruby) about the client or APIs on [StackOverflow](http://stackoverflow.com). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,32 @@ | ||
# google-cloud-core | ||
|
||
This library contains shared types, such as error classes, for the google-cloud project. Please see the top-level project [README](../README.md) for general information. | ||
|
||
- [google-cloud-core API documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs/google-cloud-core/google/cloud/errors) | ||
|
||
## Supported Ruby Versions | ||
|
||
This library is supported on Ruby 2.0+. | ||
|
||
## Versioning | ||
|
||
This library follows [Semantic Versioning](http://semver.org/). | ||
|
||
It is currently in major version zero (0.y.z), which means that anything may change at any time and the public API should not be considered stable. | ||
|
||
## Contributing | ||
|
||
Contributions to this library are always welcome and highly encouraged. | ||
|
||
See the [Contributing Guide](https://googlecloudplatform.github.io/gcloud-ruby/#/docs/guides/contributing) for more information on how to get started. | ||
|
||
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See [Code of Conduct](../CODE_OF_CONDUCT.md) for more information. | ||
|
||
## License | ||
|
||
This library is licensed under Apache 2.0. Full license text is available in [LICENSE](../LICENSE). | ||
|
||
## Support | ||
|
||
Please [report bugs at the project on Github](https://github.com/GoogleCloudPlatform/gcloud-ruby/issues). | ||
Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/gcloud-ruby) about the client or APIs on [StackOverflow](http://stackoverflow.com). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,70 @@ | ||
# google-cloud-datastore | ||
|
||
Google Cloud Datastore is a fully managed, schemaless database for storing | ||
non-relational data. You should feel at home if you are familiar with | ||
relational databases, but there are some key differences to be aware of to | ||
make the most of using Datastore. | ||
|
||
- [google-cloud-datastore API documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs/google-cloud-datastore/google/cloud/datastore) | ||
- [Google Cloud Datastore documentation](https://cloud.google.com/datastore/docs) | ||
|
||
*Follow the [activation instructions](https://cloud.google.com/datastore/docs/activate) to use the Google Cloud Datastore API with your project.* | ||
|
||
## Authentication | ||
|
||
This library uses Service Account credentials to connect to Google Cloud services. When running on Compute Engine 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 file, or the JSON itself, in environment variables. | ||
|
||
Instructions and configuration options are covered in the [Authentication Guide](https://googlecloudplatform.github.io/gcloud-ruby/#/docs/google-cloud-datastore/guides/authentication). | ||
|
||
## Example | ||
|
||
```ruby | ||
require "google/cloud" | ||
|
||
gcloud = Google::Cloud.new "my-todo-project-id", | ||
"/path/to/keyfile.json" | ||
datastore = gcloud.datastore | ||
|
||
# Create a new task to demo datastore | ||
task = datastore.entity "Task", "sampleTask" do |t| | ||
t["type"] = "Personal" | ||
t["done"] = false | ||
t["priority"] = 4 | ||
t["description"] = "Learn Cloud Datastore" | ||
end | ||
|
||
# Save the new task | ||
datastore.save task | ||
|
||
# Run a query for all completed tasks | ||
query = datastore.query("Task"). | ||
where("done", "=", false) | ||
tasks = datastore.run query | ||
``` | ||
|
||
## Supported Ruby Versions | ||
|
||
This library is supported on Ruby 2.0+. | ||
|
||
## Versioning | ||
|
||
This library follows [Semantic Versioning](http://semver.org/). | ||
|
||
It is currently in major version zero (0.y.z), which means that anything may change at any time and the public API should not be considered stable. | ||
|
||
## Contributing | ||
|
||
Contributions to this library are always welcome and highly encouraged. | ||
|
||
See the [Contributing Guide](https://googlecloudplatform.github.io/gcloud-ruby/#/docs/guides/contributing) for more information on how to get started. | ||
|
||
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See [Code of Conduct](../CODE_OF_CONDUCT.md) for more information. | ||
|
||
## License | ||
|
||
This library is licensed under Apache 2.0. Full license text is available in [LICENSE](../LICENSE). | ||
|
||
## Support | ||
|
||
Please [report bugs at the project on Github](https://github.com/GoogleCloudPlatform/gcloud-ruby/issues). | ||
Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/gcloud-ruby) about the client or APIs on [StackOverflow](http://stackoverflow.com). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,67 @@ | ||
# google-cloud-dns | ||
|
||
Google Cloud DNS is a high-performance, resilient, global DNS service that | ||
provides a cost-effective way to make your applications and services | ||
available to your users. This programmable, authoritative DNS service can | ||
be used to easily publish and manage DNS records using the same | ||
infrastructure relied upon by Google. To learn more, read [What is Google | ||
Cloud DNS?](https://cloud.google.com/dns/what-is-cloud-dns). | ||
|
||
- [google-cloud-dns API documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs/google-cloud-dns/google/cloud/dns) | ||
- [Google Cloud DNS documentation](https://cloud.google.com/dns/docs) | ||
|
||
## Authentication | ||
|
||
This library uses Service Account credentials to connect to Google Cloud services. When running on Compute Engine 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 file, or the JSON itself, in environment variables. | ||
|
||
Instructions and configuration options are covered in the [Authentication Guide](https://googlecloudplatform.github.io/gcloud-ruby/#/docs/google-cloud-dns/guides/authentication). | ||
|
||
## Example | ||
|
||
```ruby | ||
require "google/cloud" | ||
|
||
gcloud = Google::Cloud.new | ||
dns = gcloud.dns | ||
|
||
# Retrieve a zone | ||
zone = dns.zone "example-com" | ||
|
||
# Update records in the zone | ||
change = zone.update do |tx| | ||
tx.add "www", "A", 86400, "1.2.3.4" | ||
tx.remove "example.com.", "TXT" | ||
tx.replace "example.com.", "MX", 86400, ["10 mail1.example.com.", | ||
"20 mail2.example.com."] | ||
tx.modify "www.example.com.", "CNAME" do |r| | ||
r.ttl = 86400 # only change the TTL | ||
end | ||
end | ||
``` | ||
|
||
## Supported Ruby Versions | ||
|
||
This library is supported on Ruby 2.0+. | ||
|
||
## Versioning | ||
|
||
This library follows [Semantic Versioning](http://semver.org/). | ||
|
||
It is currently in major version zero (0.y.z), which means that anything may change at any time and the public API should not be considered stable. | ||
|
||
## Contributing | ||
|
||
Contributions to this library are always welcome and highly encouraged. | ||
|
||
See the [Contributing Guide](https://googlecloudplatform.github.io/gcloud-ruby/#/docs/guides/contributing) for more information on how to get started. | ||
|
||
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See [Code of Conduct](../CODE_OF_CONDUCT.md) for more information. | ||
|
||
## License | ||
|
||
This library is licensed under Apache 2.0. Full license text is available in [LICENSE](../LICENSE). | ||
|
||
## Support | ||
|
||
Please [report bugs at the project on Github](https://github.com/GoogleCloudPlatform/gcloud-ruby/issues). | ||
Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/gcloud-ruby) about the client or APIs on [StackOverflow](http://stackoverflow.com). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,78 @@ | ||
# google-cloud-logging | ||
|
||
The Stackdriver Logging service collects and stores logs from applications | ||
and services on the Google Cloud Platform, giving you fine-grained, | ||
programmatic control over your projects' logs. You can use the Stackdriver | ||
Logging API to: | ||
|
||
* [Read and filter log entries](#listing-log-entries) | ||
* [Export your log entries](#exporting-log-entries) to Cloud Storage, | ||
BigQuery, or Cloud Pub/Sub | ||
* [Create logs-based metrics](#creating-logs-based-metrics) for use in | ||
Cloud Monitoring | ||
* [Write log entries](#writing-log-entries) | ||
|
||
## Resources | ||
|
||
- [google-cloud-logging API documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs/google-cloud-logging/google/cloud/logging) | ||
- [Stackdriver Logging documentation](https://cloud.google.com/logging/docs/) | ||
|
||
## Authentication | ||
|
||
This library uses Service Account credentials to connect to Google Cloud services. When running on Compute Engine 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 file, or the JSON itself, in environment variables. | ||
|
||
Instructions and configuration options are covered in the [Authentication Guide](https://googlecloudplatform.github.io/gcloud-ruby/#/docs/google-cloud-logging/guides/authentication). | ||
|
||
## Example | ||
|
||
```ruby | ||
require "google/cloud" | ||
|
||
gcloud = Google::Cloud.new | ||
logging = gcloud.logging | ||
|
||
# List all log entries | ||
logging.entries.each do |e| | ||
puts "[#{e.timestamp}] #{e.log_name} #{e.payload.inspect}" | ||
end | ||
|
||
# List only entries from a single log | ||
entries = logging.entries filter: "log:syslog" | ||
|
||
# Write a log entry | ||
entry = logging.entry | ||
entry.payload = "Job started." | ||
entry.log_name = "my_app_log" | ||
entry.resource.type = "gae_app" | ||
entry.resource.labels[:module_id] = "1" | ||
entry.resource.labels[:version_id] = "20150925t173233" | ||
|
||
logging.write_entries entry | ||
``` | ||
|
||
## Supported Ruby Versions | ||
|
||
This library is supported on Ruby 2.0+. | ||
|
||
## Versioning | ||
|
||
This library follows [Semantic Versioning](http://semver.org/). | ||
|
||
It is currently in major version zero (0.y.z), which means that anything may change at any time and the public API should not be considered stable. | ||
|
||
## Contributing | ||
|
||
Contributions to this library are always welcome and highly encouraged. | ||
|
||
See the [Contributing Guide](https://googlecloudplatform.github.io/gcloud-ruby/#/docs/guides/contributing) for more information on how to get started. | ||
|
||
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See [Code of Conduct](../CODE_OF_CONDUCT.md) for more information. | ||
|
||
## License | ||
|
||
This library is licensed under Apache 2.0. Full license text is available in [LICENSE](../LICENSE). | ||
|
||
## Support | ||
|
||
Please [report bugs at the project on Github](https://github.com/GoogleCloudPlatform/gcloud-ruby/issues). | ||
Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/gcloud-ruby) about the client or APIs on [StackOverflow](http://stackoverflow.com). |
Oops, something went wrong.