-
Notifications
You must be signed in to change notification settings - Fork 553
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(compute): remove proto3_optional from parent_id (#712)
Source-Link: googleapis/googleapis@fd16b6a Source-Link: googleapis/googleapis-gen@d935b98 Copy-Tag: eyJwIjoiZ29vZ2xlLWNsb3VkLWNvbXB1dGUtdjEvLk93bEJvdC55YW1sIiwiaCI6ImQ5MzViOTg0N2ExYjcwOGFiNGU2OTYzMjBiYTYwY2UwMzQxYzVkN2EifQ==
- Loading branch information
1 parent
11033cc
commit 7595c8c
Showing
1,180 changed files
with
229,655 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 |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Ignore bundler lockfiles | ||
Gemfile.lock | ||
gems.locked | ||
|
||
# Ignore documentation output | ||
doc/* | ||
.yardoc/* | ||
|
||
# Ignore test output | ||
coverage/* | ||
|
||
# Ignore build artifacts | ||
pkg/* | ||
|
||
# Ignore files commonly present in certain dev environments | ||
.vagrant | ||
.DS_STORE | ||
.idea | ||
*.iml | ||
|
||
# Ignore synth output | ||
__pycache__ |
17 changes: 17 additions & 0 deletions
17
owl-bot-staging/google-cloud-compute-v1/.repo-metadata.json
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 |
---|---|---|
@@ -0,0 +1,17 @@ | ||
{ | ||
"api_id": "compute.googleapis.com", | ||
"api_shortname": "compute", | ||
"client_documentation": "https://cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest", | ||
"distribution_name": "google-cloud-compute-v1", | ||
"language": "ruby", | ||
"name": "compute", | ||
"name_pretty": "Google Cloud Compute V1 API", | ||
"product_documentation": "https://cloud.google.com/compute/", | ||
"release_level": "unknown", | ||
"repo": "googleapis/google-cloud-ruby", | ||
"requires_billing": true, | ||
"ruby-cloud-description": "google-cloud-compute-v1 is the official client library for the Google Cloud Compute V1 API.", | ||
"ruby-cloud-env-prefix": "COMPUTE", | ||
"ruby-cloud-product-url": "https://cloud.google.com/compute/", | ||
"library_type": "GAPIC_AUTO" | ||
} |
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 |
---|---|---|
@@ -0,0 +1,30 @@ | ||
inherit_gem: | ||
google-style: google-style.yml | ||
|
||
AllCops: | ||
Exclude: | ||
- "google-cloud-compute-v1.gemspec" | ||
- "lib/**/*_pb.rb" | ||
- "proto_docs/**/*" | ||
- "test/**/*" | ||
- "acceptance/**/*" | ||
- "samples/acceptance/**/*" | ||
- "Rakefile" | ||
|
||
Layout/LineLength: | ||
Enabled: false | ||
Metrics/AbcSize: | ||
Enabled: false | ||
Metrics/ClassLength: | ||
Enabled: false | ||
Metrics/CyclomaticComplexity: | ||
Enabled: false | ||
Metrics/MethodLength: | ||
Enabled: false | ||
Metrics/ModuleLength: | ||
Enabled: false | ||
Metrics/PerceivedComplexity: | ||
Enabled: false | ||
Naming/FileName: | ||
Exclude: | ||
- "lib/google-cloud-compute-v1.rb" |
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 |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--no-private | ||
--title="Google Cloud Compute V1 API" | ||
--exclude _pb\.rb$ | ||
--markup markdown | ||
--markup-provider redcarpet | ||
|
||
./lib/**/*.rb | ||
./proto_docs/**/*.rb | ||
- | ||
README.md | ||
LICENSE.md | ||
AUTHENTICATION.md |
151 changes: 151 additions & 0 deletions
151
owl-bot-staging/google-cloud-compute-v1/AUTHENTICATION.md
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 |
---|---|---|
@@ -0,0 +1,151 @@ | ||
# Authentication | ||
|
||
In general, the google-cloud-compute-v1 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 COMPUTE_CREDENTIALS=path/to/keyfile.json | ||
``` | ||
|
||
3. Initialize the client. | ||
|
||
```ruby | ||
require "google/cloud/compute/v1" | ||
|
||
client = ::Google::Cloud::Compute::V1::AcceleratorTypes::Rest::Client.new | ||
``` | ||
|
||
## Credential Lookup | ||
|
||
The google-cloud-compute-v1 library aims to make authentication | ||
as simple as possible, and provides several mechanisms to configure your system | ||
without requiring **Service Account Credentials** directly in code. | ||
|
||
**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 GCP 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, **Credentials** are discovered automatically. | ||
Code should be written as if already authenticated. | ||
|
||
### Environment Variables | ||
|
||
The **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-compute-v1 | ||
checks for credentials are configured on the service Credentials class (such as | ||
{::Google::Cloud::Compute::V1::AcceleratorTypes::Credentials}): | ||
|
||
* `COMPUTE_CREDENTIALS` - Path to JSON file, or JSON contents | ||
* `COMPUTE_KEYFILE` - Path to JSON file, or JSON contents | ||
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents | ||
* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents | ||
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file | ||
|
||
```ruby | ||
require "google/cloud/compute/v1" | ||
|
||
ENV["COMPUTE_CREDENTIALS"] = "path/to/keyfile.json" | ||
|
||
client = ::Google::Cloud::Compute::V1::AcceleratorTypes::Rest::Client.new | ||
``` | ||
|
||
### Configuration | ||
|
||
The path to the **Credentials JSON** file can be configured instead of storing | ||
it in an environment variable. Either on an individual client initialization: | ||
|
||
```ruby | ||
require "google/cloud/compute/v1" | ||
|
||
client = ::Google::Cloud::Compute::V1::AcceleratorTypes::Rest::Client.new do |config| | ||
config.credentials = "path/to/keyfile.json" | ||
end | ||
``` | ||
|
||
Or globally for all clients: | ||
|
||
```ruby | ||
require "google/cloud/compute/v1" | ||
|
||
::Google::Cloud::Compute::V1::AcceleratorTypes::Rest::Client.configure do |config| | ||
config.credentials = "path/to/keyfile.json" | ||
end | ||
|
||
client = ::Google::Cloud::Compute::V1::AcceleratorTypes::Rest::Client.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. | ||
|
||
## Creating a Service Account | ||
|
||
Google Cloud requires **Service Account Credentials** to | ||
connect to the APIs. You will use the **JSON key file** to | ||
connect to most services with google-cloud-compute-v1. | ||
|
||
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 Cloud Console](https://console.cloud.google.com/project). | ||
2. Create a new project or click on an existing project. | ||
3. Activate the menu in the upper left and select **APIs & Services**. From | ||
here, you will enable the APIs that your application requires. | ||
|
||
*Note: You may need to enable billing in order to use these services.* | ||
|
||
4. Select **Credentials** from the side navigation. | ||
|
||
Find the "Create credentials" drop down near the top of the page, 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, click the pencil | ||
tool on the right side to edit the service account, select the **Keys** tab, | ||
and then select **Add Key**. | ||
|
||
The key file you download will be used by this library to authenticate API | ||
requests and should be stored in a secure location. |
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 |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# Release History | ||
|
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 |
---|---|---|
@@ -0,0 +1,3 @@ | ||
source "https://rubygems.org" | ||
|
||
gemspec |
Oops, something went wrong.