google-cloud-app_engine 1.1.0 → 1.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (6) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -101
  3. data/README.md +1 -27
  4. data/lib/google/cloud/app_engine/version.rb +1 -1
  5. data/lib/google/cloud/app_engine.rb +91 -58
  6. metadata +5 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c83d4f450164b641813c8d8e61edc00ffb060f271c1cf74f1f877409df10c2b8
4
- data.tar.gz: 9ee1fc22d3e5f07999d9479264ec656421de11178b5da45e30b076bfde6f4624
3
+ metadata.gz: 654f45cff73f88a3bddf3039f06100a74894578e96a07ba3b301f26c8deb0460
4
+ data.tar.gz: '08f67c491112cf36fda74714d9e5619d82af5077cb9ab1b39d79d8ad59844652'
5
5
  SHA512:
6
- metadata.gz: 00ba517fba08fc82e3d7e137a1ad9c4fc7b7463c46548902a526b3ab47597e856206efba608af932afd866e698e6baef3fb66c53af9609657c540bef1dc6a085
7
- data.tar.gz: 701696931403045a1ff72a1478504592a7e076f20d6447e1131aa66043009033a775565ce59d037305ff0e71f9f156a2bc2b40c49e7dffabea56d1dee7a9cb05
6
+ metadata.gz: 32f19eb60e3766f9ff51e91a9597649adb01593609931b38916ac1444a1127321b1585adae7db8b61ed78bc75924478b2b6e60f8d5681f97fd335e42963e62e5
7
+ data.tar.gz: 247e8d13b9c72e7eb0f36d2c7213bfa90a0b2b5b40297e2f4a18876bc3becf247463511eacac03a7b39a0f6cd142ed25a753674522a6431d3be64b1c3e3d38aa
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-app_engine library uses
4
- [Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
5
- credentials to connect to Google Cloud services. When running within
6
- [Google Cloud Platform environments](#google-cloud-platform-environments) the
7
- credentials will be discovered automatically. When running on other
8
- environments, the Service Account credentials can be specified by providing the
9
- path to the
10
- [JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
11
- for the account (or the JSON itself) in
12
- [environment variables](#environment-variables). Additionally, Cloud SDK
13
- credentials can also be discovered automatically, but this is only recommended
14
- during development.
3
+ The recommended way to authenticate to the google-cloud-app_engine library is to use
4
+ [Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
5
+ To review all of your authentication options, see [Credentials lookup](#credential-lookup).
15
6
 
16
7
  ## Quickstart
17
8
 
18
- 1. [Create a service account and credentials](#creating-a-service-account).
19
- 2. Set the [environment variable](#environment-variables).
9
+ The following example shows how to set up authentication for a local development
10
+ environment with your user credentials.
20
11
 
21
- ```sh
22
- export APP_ENGINE_CREDENTIALS=path/to/keyfile.json
23
- ```
24
-
25
- 3. Initialize the client.
12
+ **NOTE:** This method is _not_ recommended for running in production. User credentials
13
+ should be used only during development.
26
14
 
27
- ```ruby
28
- require "google/cloud/app_engine"
15
+ 1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
16
+ 2. Set up a local ADC file with your user credentials:
29
17
 
30
- client = Google::Cloud::AppEngine.applications
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-app_engine library aims to make authentication
36
- as simple as possible, and provides several mechanisms to configure your system
37
- without requiring **Service Account Credentials** directly in code.
38
-
39
- **Credentials** are discovered in the following order:
40
-
41
- 1. Specify credentials in method arguments
42
- 2. Specify credentials in configuration
43
- 3. Discover credentials path in environment variables
44
- 4. Discover credentials JSON in environment variables
45
- 5. Discover credentials file in the Cloud SDK's path
46
- 6. Discover GCP credentials
47
-
48
- ### Google Cloud Platform environments
22
+ 3. Write code as if already authenticated.
49
23
 
50
- When running on Google Cloud Platform (GCP), including Google Compute Engine
51
- (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
52
- Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
53
- Code should be written as if already authenticated.
24
+ For more information about setting up authentication for a local development environment, see
25
+ [Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
54
26
 
55
- ### Environment Variables
27
+ ## Credential Lookup
56
28
 
57
- The **Credentials JSON** can be placed in environment variables instead of
58
- declaring them directly in code. Each service has its own environment variable,
59
- allowing for different service accounts to be used for different services. (See
60
- the READMEs for the individual service gems for details.) The path to the
61
- **Credentials JSON** file can be stored in the environment variable, or the
62
- **Credentials JSON** itself can be stored for environments such as Docker
63
- containers where writing files is difficult or not encouraged.
29
+ The google-cloud-app_engine library provides several mechanisms to configure your system.
30
+ Generally, using Application Default Credentials to facilitate automatic
31
+ credentials discovery is the easist method. But if you need to explicitly specify
32
+ credentials, there are several methods available to you.
64
33
 
65
- The environment variables that google-cloud-app_engine
66
- checks for credentials are configured on the service Credentials class (such as
67
- `::Google::Cloud::AppEngine::V1::Applications::Credentials`):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `APP_ENGINE_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `APP_ENGINE_KEYFILE` - Path to JSON file, or JSON contents
71
- * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
- * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
- * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
36
+ 1. Credentials specified in method arguments
37
+ 2. Credentials specified in configuration
38
+ 3. Credentials pointed to or included in environment variables
39
+ 4. Credentials found in local ADC file
40
+ 5. Credentials returned by the metadata server for the attached service account (GCP)
74
41
 
75
- ```ruby
76
- require "google/cloud/app_engine"
77
-
78
- ENV["APP_ENGINE_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = Google::Cloud::AppEngine.applications
81
- ```
44
+ You can configure a path to a JSON credentials file, either for an individual client object or
45
+ globally, for all client objects. The JSON file can contain credentials created for
46
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
47
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
48
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
82
49
 
83
- ### Configuration
50
+ Note: Service account keys are a security risk if not managed correctly. You should
51
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
52
+ whenever possible.
84
53
 
85
- The path to the **Credentials JSON** file can be configured instead of storing
86
- it in an environment variable. Either on an individual client initialization:
54
+ To configure a credentials file for an individual client initialization:
87
55
 
88
56
  ```ruby
89
57
  require "google/cloud/app_engine"
90
58
 
91
59
  client = Google::Cloud::AppEngine.applications do |config|
92
- config.credentials = "path/to/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
93
61
  end
94
62
  ```
95
63
 
96
- Or globally for all clients:
64
+ To configure a credentials file globally for all clients:
97
65
 
98
66
  ```ruby
99
67
  require "google/cloud/app_engine"
100
68
 
101
69
  Google::Cloud::AppEngine.configure do |config|
102
- config.credentials = "path/to/keyfile.json"
70
+ config.credentials = "path/to/credentialfile.json"
103
71
  end
104
72
 
105
73
  client = Google::Cloud::AppEngine.applications
106
74
  ```
107
75
 
108
- ### Cloud SDK
76
+ ### Environment Variables
109
77
 
110
- This option allows for an easy way to authenticate during development. If
111
- credentials are not provided in code or in environment variables, then Cloud SDK
112
- credentials are discovered.
78
+ You can also use an environment variable to provide a JSON credentials file.
79
+ The environment variable can contain a path to the credentials file or, for
80
+ environments such as Docker containers where writing files is not encouraged,
81
+ you can include the credentials file itself.
113
82
 
114
- To configure your system for this, simply:
83
+ The JSON file can contain credentials created for
84
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
85
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
86
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
115
87
 
116
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
117
- 2. Authenticate using OAuth 2.0 `$ gcloud auth login`
118
- 3. Write code as if already authenticated.
88
+ Note: Service account keys are a security risk if not managed correctly. You should
89
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
90
+ whenever possible.
91
+
92
+ The environment variables that google-cloud-app_engine
93
+ checks for credentials are:
119
94
 
120
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
121
- *should* only be used during development.
95
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
96
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
122
97
 
123
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/app_engine"
124
100
 
125
- Google Cloud requires **Service Account Credentials** to
126
- connect to the APIs. You will use the **JSON key file** to
127
- connect to most services with google-cloud-app_engine.
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
128
102
 
129
- If you are not running this client within
130
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
131
- need a Google Developers service account.
103
+ client = Google::Cloud::AppEngine.applications
104
+ ```
132
105
 
133
- 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
134
- 2. Create a new project or click on an existing project.
135
- 3. Activate the menu in the upper left and select **APIs & Services**. From
136
- here, you will enable the APIs that your application requires.
106
+ ### Local ADC file
137
107
 
138
- *Note: You may need to enable billing in order to use these services.*
108
+ You can set up a local ADC file with your user credentials for authentication during
109
+ development. If credentials are not provided in code or in environment variables,
110
+ then the local ADC credentials are discovered.
139
111
 
140
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
141
113
 
142
- Find the "Create credentials" drop down near the top of the page, and select
143
- "Service account" to be guided through downloading a new JSON key file.
114
+ ### Google Cloud Platform environments
144
115
 
145
- If you want to re-use an existing service account, you can easily generate a
146
- new key file. Just select the account you wish to re-use, click the pencil
147
- tool on the right side to edit the service account, select the **Keys** tab,
148
- and then select **Add Key**.
116
+ When running on Google Cloud Platform (GCP), including Google Compute Engine
117
+ (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
118
+ Functions (GCF) and Cloud Run, credentials are retrieved from the attached
119
+ service account automatically. Code should be written as if already authenticated.
149
120
 
150
- The key file you download will be used by this library to authenticate API
151
- requests and should be stored in a secure location.
121
+ For more information, see
122
+ [Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
data/README.md CHANGED
@@ -16,7 +16,7 @@ for this library, google-cloud-app_engine, to see the convenience methods for
16
16
  constructing client objects. Reference documentation for the client objects
17
17
  themselves can be found in the client library documentation for the versioned
18
18
  client gems:
19
- [google-cloud-app_engine-v1](https://googleapis.dev/ruby/google-cloud-app_engine-v1/latest).
19
+ [google-cloud-app_engine-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest).
20
20
 
21
21
  See also the [Product Documentation](https://cloud.google.com/appengine/docs/admin-api/)
22
22
  for more usage information.
@@ -34,32 +34,6 @@ In order to use this library, you first need to go through the following steps:
34
34
  1. [Enable the API.](https://console.cloud.google.com/apis/library/appengine.googleapis.com)
35
35
  1. {file:AUTHENTICATION.md Set up authentication.}
36
36
 
37
- ## Enabling Logging
38
-
39
- To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
40
- The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
41
- or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
42
- that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
43
- and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
44
-
45
- Configuring a Ruby stdlib logger:
46
-
47
- ```ruby
48
- require "logger"
49
-
50
- module MyLogger
51
- LOGGER = Logger.new $stderr, level: Logger::WARN
52
- def logger
53
- LOGGER
54
- end
55
- end
56
-
57
- # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
58
- module GRPC
59
- extend MyLogger
60
- end
61
- ```
62
-
63
37
  ## Supported Ruby Versions
64
38
 
65
39
  This library is supported on Ruby 2.6+.
data/lib/google/cloud/app_engine/version.rb CHANGED
@@ -20,7 +20,7 @@
20
20
  module Google
21
21
  module Cloud
22
22
  module AppEngine
23
- VERSION = "1.1.0"
23
+ VERSION = "1.3.0"
24
24
  end
25
25
  end
26
26
  end
data/lib/google/cloud/app_engine.rb CHANGED
@@ -29,7 +29,7 @@ require "google/cloud/config"
29
29
 
30
30
  # Set the default configuration
31
31
  ::Google::Cloud.configure.add_config! :app_engine do |config|
32
- config.add_field! :endpoint, "appengine.googleapis.com", match: ::String
32
+ config.add_field! :endpoint, nil, match: ::String
33
33
  config.add_field! :credentials, nil, match: [::String, ::Hash, ::Google::Auth::Credentials]
34
34
  config.add_field! :scope, nil, match: [::Array, ::String]
35
35
  config.add_field! :lib_name, nil, match: ::String
@@ -39,6 +39,7 @@ require "google/cloud/config"
39
39
  config.add_field! :metadata, nil, match: ::Hash
40
40
  config.add_field! :retry_policy, nil, match: [::Hash, ::Proc]
41
41
  config.add_field! :quota_project, nil, match: ::String
42
+ config.add_field! :universe_domain, nil, match: ::String
42
43
  end
43
44
 
44
45
  module Google
@@ -48,12 +49,14 @@ module Google
48
49
  # Create a new client object for Applications.
49
50
  #
50
51
  # By default, this returns an instance of
51
- # [Google::Cloud::AppEngine::V1::Applications::Client](https://googleapis.dev/ruby/google-cloud-app_engine-v1/latest/Google/Cloud/AppEngine/V1/Applications/Client.html)
52
- # for version V1 of the API.
53
- # However, you can specify specify a different API version by passing it in the
52
+ # [Google::Cloud::AppEngine::V1::Applications::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-Applications-Client)
53
+ # for a gRPC client for version V1 of the API.
54
+ # However, you can specify a different API version by passing it in the
54
55
  # `version` parameter. If the Applications service is
55
56
  # supported by that API version, and the corresponding gem is available, the
56
57
  # appropriate versioned client will be returned.
58
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
59
+ # the `transport` parameter.
57
60
  #
58
61
  # ## About Applications
59
62
  #
@@ -61,29 +64,33 @@ module Google
61
64
  #
62
65
  # @param version [::String, ::Symbol] The API version to connect to. Optional.
63
66
  # Defaults to `:v1`.
64
- # @return [Applications::Client] A client object for the specified version.
67
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
68
+ # @return [::Object] A client object for the specified version.
65
69
  #
66
- def self.applications version: :v1, &block
70
+ def self.applications version: :v1, transport: :grpc, &block
67
71
  require "google/cloud/app_engine/#{version.to_s.downcase}"
68
72
 
69
73
  package_name = Google::Cloud::AppEngine
70
74
  .constants
71
75
  .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
72
76
  .first
73
- package_module = Google::Cloud::AppEngine.const_get package_name
74
- package_module.const_get(:Applications).const_get(:Client).new(&block)
77
+ service_module = Google::Cloud::AppEngine.const_get(package_name).const_get(:Applications)
78
+ service_module = service_module.const_get(:Rest) if transport == :rest
79
+ service_module.const_get(:Client).new(&block)
75
80
  end
76
81
 
77
82
  ##
78
83
  # Create a new client object for Services.
79
84
  #
80
85
  # By default, this returns an instance of
81
- # [Google::Cloud::AppEngine::V1::Services::Client](https://googleapis.dev/ruby/google-cloud-app_engine-v1/latest/Google/Cloud/AppEngine/V1/Services/Client.html)
82
- # for version V1 of the API.
83
- # However, you can specify specify a different API version by passing it in the
86
+ # [Google::Cloud::AppEngine::V1::Services::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-Services-Client)
87
+ # for a gRPC client for version V1 of the API.
88
+ # However, you can specify a different API version by passing it in the
84
89
  # `version` parameter. If the Services service is
85
90
  # supported by that API version, and the corresponding gem is available, the
86
91
  # appropriate versioned client will be returned.
92
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
93
+ # the `transport` parameter.
87
94
  #
88
95
  # ## About Services
89
96
  #
@@ -91,29 +98,33 @@ module Google
91
98
  #
92
99
  # @param version [::String, ::Symbol] The API version to connect to. Optional.
93
100
  # Defaults to `:v1`.
94
- # @return [Services::Client] A client object for the specified version.
101
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
102
+ # @return [::Object] A client object for the specified version.
95
103
  #
96
- def self.services version: :v1, &block
104
+ def self.services version: :v1, transport: :grpc, &block
97
105
  require "google/cloud/app_engine/#{version.to_s.downcase}"
98
106
 
99
107
  package_name = Google::Cloud::AppEngine
100
108
  .constants
101
109
  .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
102
110
  .first
103
- package_module = Google::Cloud::AppEngine.const_get package_name
104
- package_module.const_get(:Services).const_get(:Client).new(&block)
111
+ service_module = Google::Cloud::AppEngine.const_get(package_name).const_get(:Services)
112
+ service_module = service_module.const_get(:Rest) if transport == :rest
113
+ service_module.const_get(:Client).new(&block)
105
114
  end
106
115
 
107
116
  ##
108
117
  # Create a new client object for Versions.
109
118
  #
110
119
  # By default, this returns an instance of
111
- # [Google::Cloud::AppEngine::V1::Versions::Client](https://googleapis.dev/ruby/google-cloud-app_engine-v1/latest/Google/Cloud/AppEngine/V1/Versions/Client.html)
112
- # for version V1 of the API.
113
- # However, you can specify specify a different API version by passing it in the
120
+ # [Google::Cloud::AppEngine::V1::Versions::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-Versions-Client)
121
+ # for a gRPC client for version V1 of the API.
122
+ # However, you can specify a different API version by passing it in the
114
123
  # `version` parameter. If the Versions service is
115
124
  # supported by that API version, and the corresponding gem is available, the
116
125
  # appropriate versioned client will be returned.
126
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
127
+ # the `transport` parameter.
117
128
  #
118
129
  # ## About Versions
119
130
  #
@@ -121,29 +132,33 @@ module Google
121
132
  #
122
133
  # @param version [::String, ::Symbol] The API version to connect to. Optional.
123
134
  # Defaults to `:v1`.
124
- # @return [Versions::Client] A client object for the specified version.
135
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
136
+ # @return [::Object] A client object for the specified version.
125
137
  #
126
- def self.versions version: :v1, &block
138
+ def self.versions version: :v1, transport: :grpc, &block
127
139
  require "google/cloud/app_engine/#{version.to_s.downcase}"
128
140
 
129
141
  package_name = Google::Cloud::AppEngine
130
142
  .constants
131
143
  .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
132
144
  .first
133
- package_module = Google::Cloud::AppEngine.const_get package_name
134
- package_module.const_get(:Versions).const_get(:Client).new(&block)
145
+ service_module = Google::Cloud::AppEngine.const_get(package_name).const_get(:Versions)
146
+ service_module = service_module.const_get(:Rest) if transport == :rest
147
+ service_module.const_get(:Client).new(&block)
135
148
  end
136
149
 
137
150
  ##
138
151
  # Create a new client object for Instances.
139
152
  #
140
153
  # By default, this returns an instance of
141
- # [Google::Cloud::AppEngine::V1::Instances::Client](https://googleapis.dev/ruby/google-cloud-app_engine-v1/latest/Google/Cloud/AppEngine/V1/Instances/Client.html)
142
- # for version V1 of the API.
143
- # However, you can specify specify a different API version by passing it in the
154
+ # [Google::Cloud::AppEngine::V1::Instances::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-Instances-Client)
155
+ # for a gRPC client for version V1 of the API.
156
+ # However, you can specify a different API version by passing it in the
144
157
  # `version` parameter. If the Instances service is
145
158
  # supported by that API version, and the corresponding gem is available, the
146
159
  # appropriate versioned client will be returned.
160
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
161
+ # the `transport` parameter.
147
162
  #
148
163
  # ## About Instances
149
164
  #
@@ -151,29 +166,33 @@ module Google
151
166
  #
152
167
  # @param version [::String, ::Symbol] The API version to connect to. Optional.
153
168
  # Defaults to `:v1`.
154
- # @return [Instances::Client] A client object for the specified version.
169
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
170
+ # @return [::Object] A client object for the specified version.
155
171
  #
156
- def self.instances version: :v1, &block
172
+ def self.instances version: :v1, transport: :grpc, &block
157
173
  require "google/cloud/app_engine/#{version.to_s.downcase}"
158
174
 
159
175
  package_name = Google::Cloud::AppEngine
160
176
  .constants
161
177
  .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
162
178
  .first
163
- package_module = Google::Cloud::AppEngine.const_get package_name
164
- package_module.const_get(:Instances).const_get(:Client).new(&block)
179
+ service_module = Google::Cloud::AppEngine.const_get(package_name).const_get(:Instances)
180
+ service_module = service_module.const_get(:Rest) if transport == :rest
181
+ service_module.const_get(:Client).new(&block)
165
182
  end
166
183
 
167
184
  ##
168
185
  # Create a new client object for Firewall.
169
186
  #
170
187
  # By default, this returns an instance of
171
- # [Google::Cloud::AppEngine::V1::Firewall::Client](https://googleapis.dev/ruby/google-cloud-app_engine-v1/latest/Google/Cloud/AppEngine/V1/Firewall/Client.html)
172
- # for version V1 of the API.
173
- # However, you can specify specify a different API version by passing it in the
188
+ # [Google::Cloud::AppEngine::V1::Firewall::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-Firewall-Client)
189
+ # for a gRPC client for version V1 of the API.
190
+ # However, you can specify a different API version by passing it in the
174
191
  # `version` parameter. If the Firewall service is
175
192
  # supported by that API version, and the corresponding gem is available, the
176
193
  # appropriate versioned client will be returned.
194
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
195
+ # the `transport` parameter.
177
196
  #
178
197
  # ## About Firewall
179
198
  #
@@ -190,29 +209,33 @@ module Google
190
209
  #
191
210
  # @param version [::String, ::Symbol] The API version to connect to. Optional.
192
211
  # Defaults to `:v1`.
193
- # @return [Firewall::Client] A client object for the specified version.
212
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
213
+ # @return [::Object] A client object for the specified version.
194
214
  #
195
- def self.firewall version: :v1, &block
215
+ def self.firewall version: :v1, transport: :grpc, &block
196
216
  require "google/cloud/app_engine/#{version.to_s.downcase}"
197
217
 
198
218
  package_name = Google::Cloud::AppEngine
199
219
  .constants
200
220
  .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
201
221
  .first
202
- package_module = Google::Cloud::AppEngine.const_get package_name
203
- package_module.const_get(:Firewall).const_get(:Client).new(&block)
222
+ service_module = Google::Cloud::AppEngine.const_get(package_name).const_get(:Firewall)
223
+ service_module = service_module.const_get(:Rest) if transport == :rest
224
+ service_module.const_get(:Client).new(&block)
204
225
  end
205
226
 
206
227
  ##
207
228
  # Create a new client object for AuthorizedDomains.
208
229
  #
209
230
  # By default, this returns an instance of
210
- # [Google::Cloud::AppEngine::V1::AuthorizedDomains::Client](https://googleapis.dev/ruby/google-cloud-app_engine-v1/latest/Google/Cloud/AppEngine/V1/AuthorizedDomains/Client.html)
211
- # for version V1 of the API.
212
- # However, you can specify specify a different API version by passing it in the
231
+ # [Google::Cloud::AppEngine::V1::AuthorizedDomains::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-AuthorizedDomains-Client)
232
+ # for a gRPC client for version V1 of the API.
233
+ # However, you can specify a different API version by passing it in the
213
234
  # `version` parameter. If the AuthorizedDomains service is
214
235
  # supported by that API version, and the corresponding gem is available, the
215
236
  # appropriate versioned client will be returned.
237
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
238
+ # the `transport` parameter.
216
239
  #
217
240
  # ## About AuthorizedDomains
218
241
  #
@@ -222,29 +245,33 @@ module Google
222
245
  #
223
246
  # @param version [::String, ::Symbol] The API version to connect to. Optional.
224
247
  # Defaults to `:v1`.
225
- # @return [AuthorizedDomains::Client] A client object for the specified version.
248
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
249
+ # @return [::Object] A client object for the specified version.
226
250
  #
227
- def self.authorized_domains version: :v1, &block
251
+ def self.authorized_domains version: :v1, transport: :grpc, &block
228
252
  require "google/cloud/app_engine/#{version.to_s.downcase}"
229
253
 
230
254
  package_name = Google::Cloud::AppEngine
231
255
  .constants
232
256
  .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
233
257
  .first
234
- package_module = Google::Cloud::AppEngine.const_get package_name
235
- package_module.const_get(:AuthorizedDomains).const_get(:Client).new(&block)
258
+ service_module = Google::Cloud::AppEngine.const_get(package_name).const_get(:AuthorizedDomains)
259
+ service_module = service_module.const_get(:Rest) if transport == :rest
260
+ service_module.const_get(:Client).new(&block)
236
261
  end
237
262
 
238
263
  ##
239
264
  # Create a new client object for AuthorizedCertificates.
240
265
  #
241
266
  # By default, this returns an instance of
242
- # [Google::Cloud::AppEngine::V1::AuthorizedCertificates::Client](https://googleapis.dev/ruby/google-cloud-app_engine-v1/latest/Google/Cloud/AppEngine/V1/AuthorizedCertificates/Client.html)
243
- # for version V1 of the API.
244
- # However, you can specify specify a different API version by passing it in the
267
+ # [Google::Cloud::AppEngine::V1::AuthorizedCertificates::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-AuthorizedCertificates-Client)
268
+ # for a gRPC client for version V1 of the API.
269
+ # However, you can specify a different API version by passing it in the
245
270
  # `version` parameter. If the AuthorizedCertificates service is
246
271
  # supported by that API version, and the corresponding gem is available, the
247
272
  # appropriate versioned client will be returned.
273
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
274
+ # the `transport` parameter.
248
275
  #
249
276
  # ## About AuthorizedCertificates
250
277
  #
@@ -253,29 +280,33 @@ module Google
253
280
  #
254
281
  # @param version [::String, ::Symbol] The API version to connect to. Optional.
255
282
  # Defaults to `:v1`.
256
- # @return [AuthorizedCertificates::Client] A client object for the specified version.
283
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
284
+ # @return [::Object] A client object for the specified version.
257
285
  #
258
- def self.authorized_certificates version: :v1, &block
286
+ def self.authorized_certificates version: :v1, transport: :grpc, &block
259
287
  require "google/cloud/app_engine/#{version.to_s.downcase}"
260
288
 
261
289
  package_name = Google::Cloud::AppEngine
262
290
  .constants
263
291
  .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
264
292
  .first
265
- package_module = Google::Cloud::AppEngine.const_get package_name
266
- package_module.const_get(:AuthorizedCertificates).const_get(:Client).new(&block)
293
+ service_module = Google::Cloud::AppEngine.const_get(package_name).const_get(:AuthorizedCertificates)
294
+ service_module = service_module.const_get(:Rest) if transport == :rest
295
+ service_module.const_get(:Client).new(&block)
267
296
  end
268
297
 
269
298
  ##
270
299
  # Create a new client object for DomainMappings.
271
300
  #
272
301
  # By default, this returns an instance of
273
- # [Google::Cloud::AppEngine::V1::DomainMappings::Client](https://googleapis.dev/ruby/google-cloud-app_engine-v1/latest/Google/Cloud/AppEngine/V1/DomainMappings/Client.html)
274
- # for version V1 of the API.
275
- # However, you can specify specify a different API version by passing it in the
302
+ # [Google::Cloud::AppEngine::V1::DomainMappings::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-DomainMappings-Client)
303
+ # for a gRPC client for version V1 of the API.
304
+ # However, you can specify a different API version by passing it in the
276
305
  # `version` parameter. If the DomainMappings service is
277
306
  # supported by that API version, and the corresponding gem is available, the
278
307
  # appropriate versioned client will be returned.
308
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
309
+ # the `transport` parameter.
279
310
  #
280
311
  # ## About DomainMappings
281
312
  #
@@ -283,17 +314,19 @@ module Google
283
314
  #
284
315
  # @param version [::String, ::Symbol] The API version to connect to. Optional.
285
316
  # Defaults to `:v1`.
286
- # @return [DomainMappings::Client] A client object for the specified version.
317
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
318
+ # @return [::Object] A client object for the specified version.
287
319
  #
288
- def self.domain_mappings version: :v1, &block
320
+ def self.domain_mappings version: :v1, transport: :grpc, &block
289
321
  require "google/cloud/app_engine/#{version.to_s.downcase}"
290
322
 
291
323
  package_name = Google::Cloud::AppEngine
292
324
  .constants
293
325
  .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
294
326
  .first
295
- package_module = Google::Cloud::AppEngine.const_get package_name
296
- package_module.const_get(:DomainMappings).const_get(:Client).new(&block)
327
+ service_module = Google::Cloud::AppEngine.const_get(package_name).const_get(:DomainMappings)
328
+ service_module = service_module.const_get(:Rest) if transport == :rest
329
+ service_module.const_get(:Client).new(&block)
297
330
  end
298
331
 
299
332
  ##
@@ -313,7 +346,7 @@ module Google
313
346
  # * `timeout` (*type:* `Numeric`) -
314
347
  # Default timeout in seconds.
315
348
  # * `metadata` (*type:* `Hash{Symbol=>String}`) -
316
- # Additional gRPC headers to be sent with the call.
349
+ # Additional headers to be sent with the call.
317
350
  # * `retry_policy` (*type:* `Hash`) -
318
351
  # The retry policy. The value is a hash with the following keys:
319
352
  # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-app_engine
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.1.0
4
+ version: 1.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-07-01 00:00:00.000000000 Z
11
+ date: 2024-01-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-cloud-app_engine-v1
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: '0.3'
19
+ version: '0.9'
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: '0.3'
29
+ version: '0.9'
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -188,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
188
188
  - !ruby/object:Gem::Version
189
189
  version: '0'
190
190
  requirements: []
191
- rubygems_version: 3.3.14
191
+ rubygems_version: 3.5.3
192
192
  signing_key:
193
193
  specification_version: 4
194
194
  summary: API Client library for the App Engine Admin API