Skip to content

Commit

Permalink
docs: Update description on allowed_locations in LocationPolicy field
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 629311450

Source-Link: googleapis/googleapis@869b3b2

Source-Link: googleapis/googleapis-gen@5ed7b07
Copy-Tag: eyJwIjoiZ29vZ2xlLWNsb3VkLWJhdGNoLXYxLy5Pd2xCb3QueWFtbCIsImgiOiI1ZWQ3YjA3Nzg5ZmJhNTQ4MWU4YjBhMGE1N2RmYmUxMWM0OWFmNjQ3In0=
  • Loading branch information
gcf-owl-bot[bot] committed Apr 30, 2024
1 parent f0c0c82 commit fed4d76
Show file tree
Hide file tree
Showing 81 changed files with 14,284 additions and 0 deletions.
22 changes: 22 additions & 0 deletions owl-bot-staging/google-cloud-batch-v1/.gitignore
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__
15 changes: 15 additions & 0 deletions owl-bot-staging/google-cloud-batch-v1/.repo-metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"api_id": "batch.googleapis.com",
"api_shortname": "batch",
"client_documentation": "https://cloud.google.com/ruby/docs/reference/google-cloud-batch-v1/latest",
"distribution_name": "google-cloud-batch-v1",
"is_cloud": true,
"language": "ruby",
"name": "batch",
"name_pretty": "Batch V1 API",
"release_level": "unreleased",
"repo": "googleapis/google-cloud-ruby",
"requires_billing": true,
"ruby-cloud-description": "Google Cloud Batch is a fully managed service used by scientists, VFX artists, developers to easily and efficiently run batch workloads on Google Cloud. This service manages provisioning of resources to satisfy the requirements of the batch jobs for a variety of workloads including ML, HPC, VFX rendering, transcoding, genomics and others. Note that google-cloud-batch-v1 is a version-specific client library. For most uses, we recommend installing the main client library google-cloud-batch instead. See the readme for more details.",
"library_type": "GAPIC_AUTO"
}
33 changes: 33 additions & 0 deletions owl-bot-staging/google-cloud-batch-v1/.rubocop.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
inherit_gem:
google-style: google-style.yml

AllCops:
Exclude:
- "google-cloud-batch-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/AccessorMethodName:
Exclude:
- "snippets/**/*.rb"
Naming/FileName:
Exclude:
- "lib/google-cloud-batch-v1.rb"
28 changes: 28 additions & 0 deletions owl-bot-staging/google-cloud-batch-v1/.toys.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# frozen_string_literal: true

# Copyright 2024 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.

# Auto-generated by gapic-generator-ruby. DO NOT EDIT!

toys_version! ">= 0.15.3"

if ENV["RUBY_COMMON_TOOLS"]
common_tools_dir = File.expand_path ENV["RUBY_COMMON_TOOLS"]
load File.join(common_tools_dir, "toys", "gapic")
else
load_git remote: "https://github.com/googleapis/ruby-common-tools.git",
path: "toys/gapic",
update: true
end
12 changes: 12 additions & 0 deletions owl-bot-staging/google-cloud-batch-v1/.yardopts
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
--no-private
--title="Batch V1 API"
--exclude _pb\.rb$
--markup markdown
--markup-provider redcarpet

./lib/**/*.rb
./proto_docs/**/*.rb
-
README.md
LICENSE.md
AUTHENTICATION.md
122 changes: 122 additions & 0 deletions owl-bot-staging/google-cloud-batch-v1/AUTHENTICATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
# Authentication

The recommended way to authenticate to the google-cloud-batch-v1 library is to use
[Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
To review all of your authentication options, see [Credentials lookup](#credential-lookup).

## Quickstart

The following example shows how to set up authentication for a local development
environment with your user credentials.

**NOTE:** This method is _not_ recommended for running in production. User credentials
should be used only during development.

1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
2. Set up a local ADC file with your user credentials:

```sh
gcloud auth application-default login
```

3. Write code as if already authenticated.

For more information about setting up authentication for a local development environment, see
[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).

## Credential Lookup

The google-cloud-batch-v1 library provides several mechanisms to configure your system.
Generally, using Application Default Credentials to facilitate automatic
credentials discovery is the easist method. But if you need to explicitly specify
credentials, there are several methods available to you.

Credentials are accepted in the following ways, in the following order or precedence:

1. Credentials specified in method arguments
2. Credentials specified in configuration
3. Credentials pointed to or included in environment variables
4. Credentials found in local ADC file
5. Credentials returned by the metadata server for the attached service account (GCP)

### Configuration

You can configure a path to a JSON credentials file, either for an individual client object or
globally, for all client objects. The JSON file can contain credentials created for
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).

Note: Service account keys are a security risk if not managed correctly. You should
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
whenever possible.

To configure a credentials file for an individual client initialization:

```ruby
require "google/cloud/batch/v1"

client = ::Google::Cloud::Batch::V1::BatchService::Client.new do |config|
config.credentials = "path/to/credentialfile.json"
end
```

To configure a credentials file globally for all clients:

```ruby
require "google/cloud/batch/v1"

::Google::Cloud::Batch::V1::BatchService::Client.configure do |config|
config.credentials = "path/to/credentialfile.json"
end

client = ::Google::Cloud::Batch::V1::BatchService::Client.new
```

### Environment Variables

You can also use an environment variable to provide a JSON credentials file.
The environment variable can contain a path to the credentials file or, for
environments such as Docker containers where writing files is not encouraged,
you can include the credentials file itself.

The JSON file can contain credentials created for
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).

Note: Service account keys are a security risk if not managed correctly. You should
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
whenever possible.

The environment variables that google-cloud-batch-v1
checks for credentials are:

* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file

```ruby
require "google/cloud/batch/v1"

ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"

client = ::Google::Cloud::Batch::V1::BatchService::Client.new
```

### Local ADC file

You can set up a local ADC file with your user credentials for authentication during
development. If credentials are not provided in code or in environment variables,
then the local ADC credentials are discovered.

Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.

### 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 retrieved from the attached
service account automatically. Code should be written as if already authenticated.

For more information, see
[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
2 changes: 2 additions & 0 deletions owl-bot-staging/google-cloud-batch-v1/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Release History

11 changes: 11 additions & 0 deletions owl-bot-staging/google-cloud-batch-v1/Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
source "https://rubygems.org"

gemspec

gem "google-style", "~> 1.27.1"
gem "minitest", "~> 5.22"
gem "minitest-focus", "~> 1.4"
gem "minitest-rg", "~> 5.3"
gem "rake", ">= 13.0"
gem "redcarpet", "~> 3.6"
gem "yard", "~> 0.9"

0 comments on commit fed4d76

Please sign in to comment.