google-cloud-functions-v1 0.12.0 → 0.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +72 -101
- data/lib/google/cloud/functions/v1/cloud_functions_service/client.rb +34 -8
- data/lib/google/cloud/functions/v1/cloud_functions_service/operations.rb +28 -6
- data/lib/google/cloud/functions/v1/cloud_functions_service/rest/client.rb +36 -7
- data/lib/google/cloud/functions/v1/cloud_functions_service/rest/operations.rb +33 -8
- data/lib/google/cloud/functions/v1/cloud_functions_service/rest/service_stub.rb +14 -2
- data/lib/google/cloud/functions/v1/version.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -0
- metadata +9 -9
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: aafbf0da70385e7e918d3e419cab8b0d5afd18d08312ab6052cc3d586ff8ee8b
|
|
4
|
+
data.tar.gz: b7ac8c2b9205c7c9d9d9a5c476691e63d47db181dff4bf9d0274a2296fb30e32
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 947c35e3f87158a0e80231f741c52b7f9a32be98b7c7458b85c6b9b1958362de3035fe054e056e45f81c34732c85ab5d2c1bb6f89cfb144222622ee47f342cde
|
|
7
|
+
data.tar.gz: 88e0b86990dad6ae38df05536acbf71e35eeaf793e6d31d3bf737533e90a474847ba54cb16c21c7999d1ac21d9c89f0d72222c20efc20fc29554101a346b97f8
|
data/AUTHENTICATION.md
CHANGED
|
@@ -1,151 +1,122 @@
|
|
|
1
1
|
# Authentication
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
[
|
|
5
|
-
|
|
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-functions-v1 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
|
-
|
|
19
|
-
|
|
9
|
+
The following example shows how to set up authentication for a local development
|
|
10
|
+
environment with your user credentials.
|
|
20
11
|
|
|
21
|
-
|
|
22
|
-
|
|
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
|
-
|
|
28
|
-
|
|
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
|
-
|
|
18
|
+
```sh
|
|
19
|
+
gcloud auth application-default login
|
|
31
20
|
```
|
|
32
21
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
The google-cloud-functions-v1 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
|
-
|
|
51
|
-
|
|
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
|
-
|
|
27
|
+
## Credential Lookup
|
|
56
28
|
|
|
57
|
-
The
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
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-functions-v1 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
|
-
|
|
66
|
-
checks for credentials are configured on the service Credentials class (such as
|
|
67
|
-
{::Google::Cloud::Functions::V1::CloudFunctionsService::Credentials}):
|
|
34
|
+
Credentials are accepted in the following ways, in the following order or precedence:
|
|
68
35
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
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
|
-
|
|
76
|
-
require "google/cloud/functions/v1"
|
|
77
|
-
|
|
78
|
-
ENV["FUNCTIONS_CREDENTIALS"] = "path/to/keyfile.json"
|
|
42
|
+
### Configuration
|
|
79
43
|
|
|
80
|
-
client
|
|
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
|
-
|
|
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
|
-
|
|
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/functions/v1"
|
|
90
58
|
|
|
91
59
|
client = ::Google::Cloud::Functions::V1::CloudFunctionsService::Client.new do |config|
|
|
92
|
-
config.credentials = "path/to/
|
|
60
|
+
config.credentials = "path/to/credentialfile.json"
|
|
93
61
|
end
|
|
94
62
|
```
|
|
95
63
|
|
|
96
|
-
|
|
64
|
+
To configure a credentials file globally for all clients:
|
|
97
65
|
|
|
98
66
|
```ruby
|
|
99
67
|
require "google/cloud/functions/v1"
|
|
100
68
|
|
|
101
69
|
::Google::Cloud::Functions::V1::CloudFunctionsService::Client.configure do |config|
|
|
102
|
-
config.credentials = "path/to/
|
|
70
|
+
config.credentials = "path/to/credentialfile.json"
|
|
103
71
|
end
|
|
104
72
|
|
|
105
73
|
client = ::Google::Cloud::Functions::V1::CloudFunctionsService::Client.new
|
|
106
74
|
```
|
|
107
75
|
|
|
108
|
-
###
|
|
76
|
+
### Environment Variables
|
|
109
77
|
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
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
|
-
|
|
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
|
-
|
|
117
|
-
|
|
118
|
-
|
|
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-functions-v1
|
|
93
|
+
checks for credentials are:
|
|
119
94
|
|
|
120
|
-
|
|
121
|
-
*
|
|
95
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
96
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
|
122
97
|
|
|
123
|
-
|
|
98
|
+
```ruby
|
|
99
|
+
require "google/cloud/functions/v1"
|
|
124
100
|
|
|
125
|
-
|
|
126
|
-
connect to the APIs. You will use the **JSON key file** to
|
|
127
|
-
connect to most services with google-cloud-functions-v1.
|
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
|
128
102
|
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
need a Google Developers service account.
|
|
103
|
+
client = ::Google::Cloud::Functions::V1::CloudFunctionsService::Client.new
|
|
104
|
+
```
|
|
132
105
|
|
|
133
|
-
|
|
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
|
-
|
|
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
|
-
|
|
112
|
+
Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
|
|
141
113
|
|
|
142
|
-
|
|
143
|
-
"Service account" to be guided through downloading a new JSON key file.
|
|
114
|
+
### Google Cloud Platform environments
|
|
144
115
|
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
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
|
-
|
|
151
|
-
|
|
121
|
+
For more information, see
|
|
122
|
+
[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
|
|
@@ -32,6 +32,9 @@ module Google
|
|
|
32
32
|
# A service that application uses to manipulate triggers and functions.
|
|
33
33
|
#
|
|
34
34
|
class Client
|
|
35
|
+
# @private
|
|
36
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudfunctions.$UNIVERSE_DOMAIN$"
|
|
37
|
+
|
|
35
38
|
include Paths
|
|
36
39
|
|
|
37
40
|
# @private
|
|
@@ -116,6 +119,15 @@ module Google
|
|
|
116
119
|
@config
|
|
117
120
|
end
|
|
118
121
|
|
|
122
|
+
##
|
|
123
|
+
# The effective universe domain
|
|
124
|
+
#
|
|
125
|
+
# @return [String]
|
|
126
|
+
#
|
|
127
|
+
def universe_domain
|
|
128
|
+
@cloud_functions_service_stub.universe_domain
|
|
129
|
+
end
|
|
130
|
+
|
|
119
131
|
##
|
|
120
132
|
# Create a new CloudFunctionsService client object.
|
|
121
133
|
#
|
|
@@ -149,8 +161,9 @@ module Google
|
|
|
149
161
|
credentials = @config.credentials
|
|
150
162
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
151
163
|
# but only if the default endpoint does not have a region prefix.
|
|
152
|
-
enable_self_signed_jwt = @config.endpoint
|
|
153
|
-
|
|
164
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
165
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
166
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
154
167
|
credentials ||= Credentials.default scope: @config.scope,
|
|
155
168
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
156
169
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -163,24 +176,29 @@ module Google
|
|
|
163
176
|
config.credentials = credentials
|
|
164
177
|
config.quota_project = @quota_project_id
|
|
165
178
|
config.endpoint = @config.endpoint
|
|
179
|
+
config.universe_domain = @config.universe_domain
|
|
166
180
|
end
|
|
167
181
|
|
|
168
182
|
@location_client = Google::Cloud::Location::Locations::Client.new do |config|
|
|
169
183
|
config.credentials = credentials
|
|
170
184
|
config.quota_project = @quota_project_id
|
|
171
185
|
config.endpoint = @config.endpoint
|
|
186
|
+
config.universe_domain = @config.universe_domain
|
|
172
187
|
end
|
|
173
188
|
|
|
174
189
|
@iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
|
|
175
190
|
config.credentials = credentials
|
|
176
191
|
config.quota_project = @quota_project_id
|
|
177
192
|
config.endpoint = @config.endpoint
|
|
193
|
+
config.universe_domain = @config.universe_domain
|
|
178
194
|
end
|
|
179
195
|
|
|
180
196
|
@cloud_functions_service_stub = ::Gapic::ServiceStub.new(
|
|
181
197
|
::Google::Cloud::Functions::V1::CloudFunctionsService::Stub,
|
|
182
|
-
credentials:
|
|
183
|
-
endpoint:
|
|
198
|
+
credentials: credentials,
|
|
199
|
+
endpoint: @config.endpoint,
|
|
200
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
201
|
+
universe_domain: @config.universe_domain,
|
|
184
202
|
channel_args: @config.channel_args,
|
|
185
203
|
interceptors: @config.interceptors,
|
|
186
204
|
channel_pool_config: @config.channel_pool
|
|
@@ -1309,9 +1327,9 @@ module Google
|
|
|
1309
1327
|
# end
|
|
1310
1328
|
#
|
|
1311
1329
|
# @!attribute [rw] endpoint
|
|
1312
|
-
#
|
|
1313
|
-
#
|
|
1314
|
-
# @return [::String]
|
|
1330
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
1331
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
1332
|
+
# @return [::String,nil]
|
|
1315
1333
|
# @!attribute [rw] credentials
|
|
1316
1334
|
# Credentials to send with calls. You may provide any of the following types:
|
|
1317
1335
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -1357,13 +1375,20 @@ module Google
|
|
|
1357
1375
|
# @!attribute [rw] quota_project
|
|
1358
1376
|
# A separate project against which to charge quota.
|
|
1359
1377
|
# @return [::String]
|
|
1378
|
+
# @!attribute [rw] universe_domain
|
|
1379
|
+
# The universe domain within which to make requests. This determines the
|
|
1380
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
1381
|
+
# universe (usually the default "googleapis.com" universe).
|
|
1382
|
+
# @return [::String,nil]
|
|
1360
1383
|
#
|
|
1361
1384
|
class Configuration
|
|
1362
1385
|
extend ::Gapic::Config
|
|
1363
1386
|
|
|
1387
|
+
# @private
|
|
1388
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
1364
1389
|
DEFAULT_ENDPOINT = "cloudfunctions.googleapis.com"
|
|
1365
1390
|
|
|
1366
|
-
config_attr :endpoint,
|
|
1391
|
+
config_attr :endpoint, nil, ::String, nil
|
|
1367
1392
|
config_attr :credentials, nil do |value|
|
|
1368
1393
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
1369
1394
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -1378,6 +1403,7 @@ module Google
|
|
|
1378
1403
|
config_attr :metadata, nil, ::Hash, nil
|
|
1379
1404
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
1380
1405
|
config_attr :quota_project, nil, ::String, nil
|
|
1406
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
1381
1407
|
|
|
1382
1408
|
# @private
|
|
1383
1409
|
def initialize parent_config = nil
|
|
@@ -26,6 +26,9 @@ module Google
|
|
|
26
26
|
module CloudFunctionsService
|
|
27
27
|
# Service that implements Longrunning Operations API.
|
|
28
28
|
class Operations
|
|
29
|
+
# @private
|
|
30
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudfunctions.$UNIVERSE_DOMAIN$"
|
|
31
|
+
|
|
29
32
|
# @private
|
|
30
33
|
attr_reader :operations_stub
|
|
31
34
|
|
|
@@ -60,6 +63,15 @@ module Google
|
|
|
60
63
|
@config
|
|
61
64
|
end
|
|
62
65
|
|
|
66
|
+
##
|
|
67
|
+
# The effective universe domain
|
|
68
|
+
#
|
|
69
|
+
# @return [String]
|
|
70
|
+
#
|
|
71
|
+
def universe_domain
|
|
72
|
+
@operations_stub.universe_domain
|
|
73
|
+
end
|
|
74
|
+
|
|
63
75
|
##
|
|
64
76
|
# Create a new Operations client object.
|
|
65
77
|
#
|
|
@@ -90,8 +102,10 @@ module Google
|
|
|
90
102
|
|
|
91
103
|
@operations_stub = ::Gapic::ServiceStub.new(
|
|
92
104
|
::Google::Longrunning::Operations::Stub,
|
|
93
|
-
credentials:
|
|
94
|
-
endpoint:
|
|
105
|
+
credentials: credentials,
|
|
106
|
+
endpoint: @config.endpoint,
|
|
107
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
108
|
+
universe_domain: @config.universe_domain,
|
|
95
109
|
channel_args: @config.channel_args,
|
|
96
110
|
interceptors: @config.interceptors,
|
|
97
111
|
channel_pool_config: @config.channel_pool
|
|
@@ -605,9 +619,9 @@ module Google
|
|
|
605
619
|
# end
|
|
606
620
|
#
|
|
607
621
|
# @!attribute [rw] endpoint
|
|
608
|
-
#
|
|
609
|
-
#
|
|
610
|
-
# @return [::String]
|
|
622
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
623
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
624
|
+
# @return [::String,nil]
|
|
611
625
|
# @!attribute [rw] credentials
|
|
612
626
|
# Credentials to send with calls. You may provide any of the following types:
|
|
613
627
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -653,13 +667,20 @@ module Google
|
|
|
653
667
|
# @!attribute [rw] quota_project
|
|
654
668
|
# A separate project against which to charge quota.
|
|
655
669
|
# @return [::String]
|
|
670
|
+
# @!attribute [rw] universe_domain
|
|
671
|
+
# The universe domain within which to make requests. This determines the
|
|
672
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
673
|
+
# universe (usually the default "googleapis.com" universe).
|
|
674
|
+
# @return [::String,nil]
|
|
656
675
|
#
|
|
657
676
|
class Configuration
|
|
658
677
|
extend ::Gapic::Config
|
|
659
678
|
|
|
679
|
+
# @private
|
|
680
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
660
681
|
DEFAULT_ENDPOINT = "cloudfunctions.googleapis.com"
|
|
661
682
|
|
|
662
|
-
config_attr :endpoint,
|
|
683
|
+
config_attr :endpoint, nil, ::String, nil
|
|
663
684
|
config_attr :credentials, nil do |value|
|
|
664
685
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
665
686
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -674,6 +695,7 @@ module Google
|
|
|
674
695
|
config_attr :metadata, nil, ::Hash, nil
|
|
675
696
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
676
697
|
config_attr :quota_project, nil, ::String, nil
|
|
698
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
677
699
|
|
|
678
700
|
# @private
|
|
679
701
|
def initialize parent_config = nil
|
|
@@ -34,6 +34,9 @@ module Google
|
|
|
34
34
|
# A service that application uses to manipulate triggers and functions.
|
|
35
35
|
#
|
|
36
36
|
class Client
|
|
37
|
+
# @private
|
|
38
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudfunctions.$UNIVERSE_DOMAIN$"
|
|
39
|
+
|
|
37
40
|
include Paths
|
|
38
41
|
|
|
39
42
|
# @private
|
|
@@ -118,6 +121,15 @@ module Google
|
|
|
118
121
|
@config
|
|
119
122
|
end
|
|
120
123
|
|
|
124
|
+
##
|
|
125
|
+
# The effective universe domain
|
|
126
|
+
#
|
|
127
|
+
# @return [String]
|
|
128
|
+
#
|
|
129
|
+
def universe_domain
|
|
130
|
+
@cloud_functions_service_stub.universe_domain
|
|
131
|
+
end
|
|
132
|
+
|
|
121
133
|
##
|
|
122
134
|
# Create a new CloudFunctionsService REST client object.
|
|
123
135
|
#
|
|
@@ -145,8 +157,9 @@ module Google
|
|
|
145
157
|
credentials = @config.credentials
|
|
146
158
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
147
159
|
# but only if the default endpoint does not have a region prefix.
|
|
148
|
-
enable_self_signed_jwt = @config.endpoint
|
|
149
|
-
|
|
160
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
161
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
162
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
150
163
|
credentials ||= Credentials.default scope: @config.scope,
|
|
151
164
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
152
165
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -160,12 +173,14 @@ module Google
|
|
|
160
173
|
config.credentials = credentials
|
|
161
174
|
config.quota_project = @quota_project_id
|
|
162
175
|
config.endpoint = @config.endpoint
|
|
176
|
+
config.universe_domain = @config.universe_domain
|
|
163
177
|
end
|
|
164
178
|
|
|
165
179
|
@location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
|
|
166
180
|
config.credentials = credentials
|
|
167
181
|
config.quota_project = @quota_project_id
|
|
168
182
|
config.endpoint = @config.endpoint
|
|
183
|
+
config.universe_domain = @config.universe_domain
|
|
169
184
|
config.bindings_override = @config.bindings_override
|
|
170
185
|
end
|
|
171
186
|
|
|
@@ -173,9 +188,15 @@ module Google
|
|
|
173
188
|
config.credentials = credentials
|
|
174
189
|
config.quota_project = @quota_project_id
|
|
175
190
|
config.endpoint = @config.endpoint
|
|
191
|
+
config.universe_domain = @config.universe_domain
|
|
176
192
|
end
|
|
177
193
|
|
|
178
|
-
@cloud_functions_service_stub = ::Google::Cloud::Functions::V1::CloudFunctionsService::Rest::ServiceStub.new
|
|
194
|
+
@cloud_functions_service_stub = ::Google::Cloud::Functions::V1::CloudFunctionsService::Rest::ServiceStub.new(
|
|
195
|
+
endpoint: @config.endpoint,
|
|
196
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
197
|
+
universe_domain: @config.universe_domain,
|
|
198
|
+
credentials: credentials
|
|
199
|
+
)
|
|
179
200
|
end
|
|
180
201
|
|
|
181
202
|
##
|
|
@@ -1222,9 +1243,9 @@ module Google
|
|
|
1222
1243
|
# end
|
|
1223
1244
|
#
|
|
1224
1245
|
# @!attribute [rw] endpoint
|
|
1225
|
-
#
|
|
1226
|
-
#
|
|
1227
|
-
# @return [::String]
|
|
1246
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
1247
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
1248
|
+
# @return [::String,nil]
|
|
1228
1249
|
# @!attribute [rw] credentials
|
|
1229
1250
|
# Credentials to send with calls. You may provide any of the following types:
|
|
1230
1251
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -1261,13 +1282,20 @@ module Google
|
|
|
1261
1282
|
# @!attribute [rw] quota_project
|
|
1262
1283
|
# A separate project against which to charge quota.
|
|
1263
1284
|
# @return [::String]
|
|
1285
|
+
# @!attribute [rw] universe_domain
|
|
1286
|
+
# The universe domain within which to make requests. This determines the
|
|
1287
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
1288
|
+
# universe (usually the default "googleapis.com" universe).
|
|
1289
|
+
# @return [::String,nil]
|
|
1264
1290
|
#
|
|
1265
1291
|
class Configuration
|
|
1266
1292
|
extend ::Gapic::Config
|
|
1267
1293
|
|
|
1294
|
+
# @private
|
|
1295
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
1268
1296
|
DEFAULT_ENDPOINT = "cloudfunctions.googleapis.com"
|
|
1269
1297
|
|
|
1270
|
-
config_attr :endpoint,
|
|
1298
|
+
config_attr :endpoint, nil, ::String, nil
|
|
1271
1299
|
config_attr :credentials, nil do |value|
|
|
1272
1300
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
1273
1301
|
allowed.any? { |klass| klass === value }
|
|
@@ -1279,6 +1307,7 @@ module Google
|
|
|
1279
1307
|
config_attr :metadata, nil, ::Hash, nil
|
|
1280
1308
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
1281
1309
|
config_attr :quota_project, nil, ::String, nil
|
|
1310
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
1282
1311
|
|
|
1283
1312
|
# @private
|
|
1284
1313
|
# Overrides for http bindings for the RPCs of this service
|
|
@@ -26,6 +26,9 @@ module Google
|
|
|
26
26
|
module Rest
|
|
27
27
|
# Service that implements Longrunning Operations API.
|
|
28
28
|
class Operations
|
|
29
|
+
# @private
|
|
30
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudfunctions.$UNIVERSE_DOMAIN$"
|
|
31
|
+
|
|
29
32
|
# @private
|
|
30
33
|
attr_reader :operations_stub
|
|
31
34
|
|
|
@@ -60,6 +63,15 @@ module Google
|
|
|
60
63
|
@config
|
|
61
64
|
end
|
|
62
65
|
|
|
66
|
+
##
|
|
67
|
+
# The effective universe domain
|
|
68
|
+
#
|
|
69
|
+
# @return [String]
|
|
70
|
+
#
|
|
71
|
+
def universe_domain
|
|
72
|
+
@operations_stub.universe_domain
|
|
73
|
+
end
|
|
74
|
+
|
|
63
75
|
##
|
|
64
76
|
# Create a new Operations client object.
|
|
65
77
|
#
|
|
@@ -84,8 +96,10 @@ module Google
|
|
|
84
96
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
|
85
97
|
|
|
86
98
|
@operations_stub = OperationsServiceStub.new(
|
|
87
|
-
endpoint:
|
|
88
|
-
|
|
99
|
+
endpoint: @config.endpoint,
|
|
100
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
101
|
+
universe_domain: @config.universe_domain,
|
|
102
|
+
credentials: credentials
|
|
89
103
|
)
|
|
90
104
|
|
|
91
105
|
# Used by an LRO wrapper for some methods of this service
|
|
@@ -478,9 +492,9 @@ module Google
|
|
|
478
492
|
# end
|
|
479
493
|
#
|
|
480
494
|
# @!attribute [rw] endpoint
|
|
481
|
-
#
|
|
482
|
-
#
|
|
483
|
-
# @return [::String]
|
|
495
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
496
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
497
|
+
# @return [::String,nil]
|
|
484
498
|
# @!attribute [rw] credentials
|
|
485
499
|
# Credentials to send with calls. You may provide any of the following types:
|
|
486
500
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -517,13 +531,20 @@ module Google
|
|
|
517
531
|
# @!attribute [rw] quota_project
|
|
518
532
|
# A separate project against which to charge quota.
|
|
519
533
|
# @return [::String]
|
|
534
|
+
# @!attribute [rw] universe_domain
|
|
535
|
+
# The universe domain within which to make requests. This determines the
|
|
536
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
537
|
+
# universe (usually the default "googleapis.com" universe).
|
|
538
|
+
# @return [::String,nil]
|
|
520
539
|
#
|
|
521
540
|
class Configuration
|
|
522
541
|
extend ::Gapic::Config
|
|
523
542
|
|
|
543
|
+
# @private
|
|
544
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
524
545
|
DEFAULT_ENDPOINT = "cloudfunctions.googleapis.com"
|
|
525
546
|
|
|
526
|
-
config_attr :endpoint,
|
|
547
|
+
config_attr :endpoint, nil, ::String, nil
|
|
527
548
|
config_attr :credentials, nil do |value|
|
|
528
549
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
529
550
|
allowed.any? { |klass| klass === value }
|
|
@@ -535,6 +556,7 @@ module Google
|
|
|
535
556
|
config_attr :metadata, nil, ::Hash, nil
|
|
536
557
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
537
558
|
config_attr :quota_project, nil, ::String, nil
|
|
559
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
538
560
|
|
|
539
561
|
# @private
|
|
540
562
|
def initialize parent_config = nil
|
|
@@ -617,12 +639,15 @@ module Google
|
|
|
617
639
|
# Service stub contains baseline method implementations
|
|
618
640
|
# including transcoding, making the REST call, and deserialing the response.
|
|
619
641
|
class OperationsServiceStub
|
|
620
|
-
def initialize endpoint:, credentials:
|
|
642
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
|
621
643
|
# These require statements are intentionally placed here to initialize
|
|
622
644
|
# the REST modules only when it's required.
|
|
623
645
|
require "gapic/rest"
|
|
624
646
|
|
|
625
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
647
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
648
|
+
endpoint_template: endpoint_template,
|
|
649
|
+
universe_domain: universe_domain,
|
|
650
|
+
credentials: credentials
|
|
626
651
|
end
|
|
627
652
|
|
|
628
653
|
##
|
|
@@ -30,16 +30,28 @@ module Google
|
|
|
30
30
|
# including transcoding, making the REST call, and deserialing the response.
|
|
31
31
|
#
|
|
32
32
|
class ServiceStub
|
|
33
|
-
def initialize endpoint:, credentials:
|
|
33
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
|
34
34
|
# These require statements are intentionally placed here to initialize
|
|
35
35
|
# the REST modules only when it's required.
|
|
36
36
|
require "gapic/rest"
|
|
37
37
|
|
|
38
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
38
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
39
|
+
endpoint_template: endpoint_template,
|
|
40
|
+
universe_domain: universe_domain,
|
|
41
|
+
credentials: credentials,
|
|
39
42
|
numeric_enums: true,
|
|
40
43
|
raise_faraday_errors: false
|
|
41
44
|
end
|
|
42
45
|
|
|
46
|
+
##
|
|
47
|
+
# The effective universe domain
|
|
48
|
+
#
|
|
49
|
+
# @return [String]
|
|
50
|
+
#
|
|
51
|
+
def universe_domain
|
|
52
|
+
@client_stub.universe_domain
|
|
53
|
+
end
|
|
54
|
+
|
|
43
55
|
##
|
|
44
56
|
# Baseline implementation for the list_functions REST call
|
|
45
57
|
#
|
|
@@ -21,6 +21,7 @@ module Google
|
|
|
21
21
|
module Api
|
|
22
22
|
# Required information for every language.
|
|
23
23
|
# @!attribute [rw] reference_docs_uri
|
|
24
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
24
25
|
# @return [::String]
|
|
25
26
|
# Link to automatically generated reference documentation. Example:
|
|
26
27
|
# https://cloud.google.com/nodejs/docs/reference/asset/latest
|
|
@@ -304,6 +305,19 @@ module Google
|
|
|
304
305
|
# seconds: 360 # 6 minutes
|
|
305
306
|
# total_poll_timeout:
|
|
306
307
|
# seconds: 54000 # 90 minutes
|
|
308
|
+
# @!attribute [rw] auto_populated_fields
|
|
309
|
+
# @return [::Array<::String>]
|
|
310
|
+
# List of top-level fields of the request message, that should be
|
|
311
|
+
# automatically populated by the client libraries based on their
|
|
312
|
+
# (google.api.field_info).format. Currently supported format: UUID4.
|
|
313
|
+
#
|
|
314
|
+
# Example of a YAML configuration:
|
|
315
|
+
#
|
|
316
|
+
# publishing:
|
|
317
|
+
# method_settings:
|
|
318
|
+
# - selector: google.example.v1.ExampleService.CreateExample
|
|
319
|
+
# auto_populated_fields:
|
|
320
|
+
# - request_id
|
|
307
321
|
class MethodSettings
|
|
308
322
|
include ::Google::Protobuf::MessageExts
|
|
309
323
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-functions-v1
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.13.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:
|
|
11
|
+
date: 2024-01-11 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: gapic-common
|
|
@@ -16,7 +16,7 @@ dependencies:
|
|
|
16
16
|
requirements:
|
|
17
17
|
- - ">="
|
|
18
18
|
- !ruby/object:Gem::Version
|
|
19
|
-
version: 0.
|
|
19
|
+
version: 0.21.1
|
|
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.
|
|
29
|
+
version: 0.21.1
|
|
30
30
|
- - "<"
|
|
31
31
|
- !ruby/object:Gem::Version
|
|
32
32
|
version: 2.a
|
|
@@ -50,7 +50,7 @@ dependencies:
|
|
|
50
50
|
requirements:
|
|
51
51
|
- - ">="
|
|
52
52
|
- !ruby/object:Gem::Version
|
|
53
|
-
version: '0.
|
|
53
|
+
version: '0.7'
|
|
54
54
|
- - "<"
|
|
55
55
|
- !ruby/object:Gem::Version
|
|
56
56
|
version: 2.a
|
|
@@ -60,7 +60,7 @@ dependencies:
|
|
|
60
60
|
requirements:
|
|
61
61
|
- - ">="
|
|
62
62
|
- !ruby/object:Gem::Version
|
|
63
|
-
version: '0.
|
|
63
|
+
version: '0.7'
|
|
64
64
|
- - "<"
|
|
65
65
|
- !ruby/object:Gem::Version
|
|
66
66
|
version: 2.a
|
|
@@ -70,7 +70,7 @@ dependencies:
|
|
|
70
70
|
requirements:
|
|
71
71
|
- - ">="
|
|
72
72
|
- !ruby/object:Gem::Version
|
|
73
|
-
version: '0.
|
|
73
|
+
version: '0.7'
|
|
74
74
|
- - "<"
|
|
75
75
|
- !ruby/object:Gem::Version
|
|
76
76
|
version: 2.a
|
|
@@ -80,7 +80,7 @@ dependencies:
|
|
|
80
80
|
requirements:
|
|
81
81
|
- - ">="
|
|
82
82
|
- !ruby/object:Gem::Version
|
|
83
|
-
version: '0.
|
|
83
|
+
version: '0.7'
|
|
84
84
|
- - "<"
|
|
85
85
|
- !ruby/object:Gem::Version
|
|
86
86
|
version: 2.a
|
|
@@ -260,7 +260,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
260
260
|
- !ruby/object:Gem::Version
|
|
261
261
|
version: '0'
|
|
262
262
|
requirements: []
|
|
263
|
-
rubygems_version: 3.
|
|
263
|
+
rubygems_version: 3.5.3
|
|
264
264
|
signing_key:
|
|
265
265
|
specification_version: 4
|
|
266
266
|
summary: Manages lightweight user-provided functions executed in response to events.
|