google-cloud-functions-v2 0.5.0 → 0.6.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +72 -101
- data/lib/google/cloud/functions/v2/function_service/client.rb +34 -8
- data/lib/google/cloud/functions/v2/function_service/operations.rb +28 -6
- data/lib/google/cloud/functions/v2/function_service/rest/client.rb +36 -7
- data/lib/google/cloud/functions/v2/function_service/rest/operations.rb +33 -8
- data/lib/google/cloud/functions/v2/function_service/rest/service_stub.rb +14 -2
- data/lib/google/cloud/functions/v2/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: 62865f496c0c020486ce7ebda8b4216f9ab5781604840c590082309fffdf7177
|
|
4
|
+
data.tar.gz: c4a5a1c021c64be9d261cfd4fc33df6cc429ee82b44211358c33777aa1c036f0
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 21cda9ce638e65683f258b601a2ca9cefd3f79d2ea7d84585eff269dfa202721da8feeffd670dd29d86c5fe4dd0c0230cef9659b710f77388a61c91fc1f9ba0a
|
|
7
|
+
data.tar.gz: 9256e00d08e38bc8740f70e65d68ccf83b0f565cb529a89f8eac4c0680e1da1cb1b08e0043772ee14aefef629f02ab84a54edc085f7b82db86f3a17b841ce860
|
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-v2 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-v2 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-v2 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::V2::FunctionService::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/v2"
|
|
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/v2"
|
|
90
58
|
|
|
91
59
|
client = ::Google::Cloud::Functions::V2::FunctionService::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/v2"
|
|
100
68
|
|
|
101
69
|
::Google::Cloud::Functions::V2::FunctionService::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::V2::FunctionService::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-v2
|
|
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/v2"
|
|
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-v2.
|
|
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::V2::FunctionService::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).
|
|
@@ -37,6 +37,9 @@ module Google
|
|
|
37
37
|
# executed and how it is triggered.
|
|
38
38
|
#
|
|
39
39
|
class Client
|
|
40
|
+
# @private
|
|
41
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudfunctions.$UNIVERSE_DOMAIN$"
|
|
42
|
+
|
|
40
43
|
include Paths
|
|
41
44
|
|
|
42
45
|
# @private
|
|
@@ -97,6 +100,15 @@ module Google
|
|
|
97
100
|
@config
|
|
98
101
|
end
|
|
99
102
|
|
|
103
|
+
##
|
|
104
|
+
# The effective universe domain
|
|
105
|
+
#
|
|
106
|
+
# @return [String]
|
|
107
|
+
#
|
|
108
|
+
def universe_domain
|
|
109
|
+
@function_service_stub.universe_domain
|
|
110
|
+
end
|
|
111
|
+
|
|
100
112
|
##
|
|
101
113
|
# Create a new FunctionService client object.
|
|
102
114
|
#
|
|
@@ -130,8 +142,9 @@ module Google
|
|
|
130
142
|
credentials = @config.credentials
|
|
131
143
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
132
144
|
# but only if the default endpoint does not have a region prefix.
|
|
133
|
-
enable_self_signed_jwt = @config.endpoint
|
|
134
|
-
|
|
145
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
146
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
147
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
135
148
|
credentials ||= Credentials.default scope: @config.scope,
|
|
136
149
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
137
150
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -144,24 +157,29 @@ module Google
|
|
|
144
157
|
config.credentials = credentials
|
|
145
158
|
config.quota_project = @quota_project_id
|
|
146
159
|
config.endpoint = @config.endpoint
|
|
160
|
+
config.universe_domain = @config.universe_domain
|
|
147
161
|
end
|
|
148
162
|
|
|
149
163
|
@location_client = Google::Cloud::Location::Locations::Client.new do |config|
|
|
150
164
|
config.credentials = credentials
|
|
151
165
|
config.quota_project = @quota_project_id
|
|
152
166
|
config.endpoint = @config.endpoint
|
|
167
|
+
config.universe_domain = @config.universe_domain
|
|
153
168
|
end
|
|
154
169
|
|
|
155
170
|
@iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
|
|
156
171
|
config.credentials = credentials
|
|
157
172
|
config.quota_project = @quota_project_id
|
|
158
173
|
config.endpoint = @config.endpoint
|
|
174
|
+
config.universe_domain = @config.universe_domain
|
|
159
175
|
end
|
|
160
176
|
|
|
161
177
|
@function_service_stub = ::Gapic::ServiceStub.new(
|
|
162
178
|
::Google::Cloud::Functions::V2::FunctionService::Stub,
|
|
163
|
-
credentials:
|
|
164
|
-
endpoint:
|
|
179
|
+
credentials: credentials,
|
|
180
|
+
endpoint: @config.endpoint,
|
|
181
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
182
|
+
universe_domain: @config.universe_domain,
|
|
165
183
|
channel_args: @config.channel_args,
|
|
166
184
|
interceptors: @config.interceptors,
|
|
167
185
|
channel_pool_config: @config.channel_pool
|
|
@@ -1017,9 +1035,9 @@ module Google
|
|
|
1017
1035
|
# end
|
|
1018
1036
|
#
|
|
1019
1037
|
# @!attribute [rw] endpoint
|
|
1020
|
-
#
|
|
1021
|
-
#
|
|
1022
|
-
# @return [::String]
|
|
1038
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
1039
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
1040
|
+
# @return [::String,nil]
|
|
1023
1041
|
# @!attribute [rw] credentials
|
|
1024
1042
|
# Credentials to send with calls. You may provide any of the following types:
|
|
1025
1043
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -1065,13 +1083,20 @@ module Google
|
|
|
1065
1083
|
# @!attribute [rw] quota_project
|
|
1066
1084
|
# A separate project against which to charge quota.
|
|
1067
1085
|
# @return [::String]
|
|
1086
|
+
# @!attribute [rw] universe_domain
|
|
1087
|
+
# The universe domain within which to make requests. This determines the
|
|
1088
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
1089
|
+
# universe (usually the default "googleapis.com" universe).
|
|
1090
|
+
# @return [::String,nil]
|
|
1068
1091
|
#
|
|
1069
1092
|
class Configuration
|
|
1070
1093
|
extend ::Gapic::Config
|
|
1071
1094
|
|
|
1095
|
+
# @private
|
|
1096
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
1072
1097
|
DEFAULT_ENDPOINT = "cloudfunctions.googleapis.com"
|
|
1073
1098
|
|
|
1074
|
-
config_attr :endpoint,
|
|
1099
|
+
config_attr :endpoint, nil, ::String, nil
|
|
1075
1100
|
config_attr :credentials, nil do |value|
|
|
1076
1101
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
1077
1102
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -1086,6 +1111,7 @@ module Google
|
|
|
1086
1111
|
config_attr :metadata, nil, ::Hash, nil
|
|
1087
1112
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
1088
1113
|
config_attr :quota_project, nil, ::String, nil
|
|
1114
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
1089
1115
|
|
|
1090
1116
|
# @private
|
|
1091
1117
|
def initialize parent_config = nil
|
|
@@ -26,6 +26,9 @@ module Google
|
|
|
26
26
|
module FunctionService
|
|
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
|
|
@@ -613,9 +627,9 @@ module Google
|
|
|
613
627
|
# end
|
|
614
628
|
#
|
|
615
629
|
# @!attribute [rw] endpoint
|
|
616
|
-
#
|
|
617
|
-
#
|
|
618
|
-
# @return [::String]
|
|
630
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
631
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
632
|
+
# @return [::String,nil]
|
|
619
633
|
# @!attribute [rw] credentials
|
|
620
634
|
# Credentials to send with calls. You may provide any of the following types:
|
|
621
635
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -661,13 +675,20 @@ module Google
|
|
|
661
675
|
# @!attribute [rw] quota_project
|
|
662
676
|
# A separate project against which to charge quota.
|
|
663
677
|
# @return [::String]
|
|
678
|
+
# @!attribute [rw] universe_domain
|
|
679
|
+
# The universe domain within which to make requests. This determines the
|
|
680
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
681
|
+
# universe (usually the default "googleapis.com" universe).
|
|
682
|
+
# @return [::String,nil]
|
|
664
683
|
#
|
|
665
684
|
class Configuration
|
|
666
685
|
extend ::Gapic::Config
|
|
667
686
|
|
|
687
|
+
# @private
|
|
688
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
668
689
|
DEFAULT_ENDPOINT = "cloudfunctions.googleapis.com"
|
|
669
690
|
|
|
670
|
-
config_attr :endpoint,
|
|
691
|
+
config_attr :endpoint, nil, ::String, nil
|
|
671
692
|
config_attr :credentials, nil do |value|
|
|
672
693
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
673
694
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -682,6 +703,7 @@ module Google
|
|
|
682
703
|
config_attr :metadata, nil, ::Hash, nil
|
|
683
704
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
684
705
|
config_attr :quota_project, nil, ::String, nil
|
|
706
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
685
707
|
|
|
686
708
|
# @private
|
|
687
709
|
def initialize parent_config = nil
|
|
@@ -39,6 +39,9 @@ module Google
|
|
|
39
39
|
# executed and how it is triggered.
|
|
40
40
|
#
|
|
41
41
|
class Client
|
|
42
|
+
# @private
|
|
43
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudfunctions.$UNIVERSE_DOMAIN$"
|
|
44
|
+
|
|
42
45
|
include Paths
|
|
43
46
|
|
|
44
47
|
# @private
|
|
@@ -99,6 +102,15 @@ module Google
|
|
|
99
102
|
@config
|
|
100
103
|
end
|
|
101
104
|
|
|
105
|
+
##
|
|
106
|
+
# The effective universe domain
|
|
107
|
+
#
|
|
108
|
+
# @return [String]
|
|
109
|
+
#
|
|
110
|
+
def universe_domain
|
|
111
|
+
@function_service_stub.universe_domain
|
|
112
|
+
end
|
|
113
|
+
|
|
102
114
|
##
|
|
103
115
|
# Create a new FunctionService REST client object.
|
|
104
116
|
#
|
|
@@ -126,8 +138,9 @@ module Google
|
|
|
126
138
|
credentials = @config.credentials
|
|
127
139
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
128
140
|
# but only if the default endpoint does not have a region prefix.
|
|
129
|
-
enable_self_signed_jwt = @config.endpoint
|
|
130
|
-
|
|
141
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
142
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
143
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
131
144
|
credentials ||= Credentials.default scope: @config.scope,
|
|
132
145
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
133
146
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -141,12 +154,14 @@ module Google
|
|
|
141
154
|
config.credentials = credentials
|
|
142
155
|
config.quota_project = @quota_project_id
|
|
143
156
|
config.endpoint = @config.endpoint
|
|
157
|
+
config.universe_domain = @config.universe_domain
|
|
144
158
|
end
|
|
145
159
|
|
|
146
160
|
@location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
|
|
147
161
|
config.credentials = credentials
|
|
148
162
|
config.quota_project = @quota_project_id
|
|
149
163
|
config.endpoint = @config.endpoint
|
|
164
|
+
config.universe_domain = @config.universe_domain
|
|
150
165
|
config.bindings_override = @config.bindings_override
|
|
151
166
|
end
|
|
152
167
|
|
|
@@ -154,10 +169,16 @@ module Google
|
|
|
154
169
|
config.credentials = credentials
|
|
155
170
|
config.quota_project = @quota_project_id
|
|
156
171
|
config.endpoint = @config.endpoint
|
|
172
|
+
config.universe_domain = @config.universe_domain
|
|
157
173
|
config.bindings_override = @config.bindings_override
|
|
158
174
|
end
|
|
159
175
|
|
|
160
|
-
@function_service_stub = ::Google::Cloud::Functions::V2::FunctionService::Rest::ServiceStub.new
|
|
176
|
+
@function_service_stub = ::Google::Cloud::Functions::V2::FunctionService::Rest::ServiceStub.new(
|
|
177
|
+
endpoint: @config.endpoint,
|
|
178
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
179
|
+
universe_domain: @config.universe_domain,
|
|
180
|
+
credentials: credentials
|
|
181
|
+
)
|
|
161
182
|
end
|
|
162
183
|
|
|
163
184
|
##
|
|
@@ -952,9 +973,9 @@ module Google
|
|
|
952
973
|
# end
|
|
953
974
|
#
|
|
954
975
|
# @!attribute [rw] endpoint
|
|
955
|
-
#
|
|
956
|
-
#
|
|
957
|
-
# @return [::String]
|
|
976
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
977
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
978
|
+
# @return [::String,nil]
|
|
958
979
|
# @!attribute [rw] credentials
|
|
959
980
|
# Credentials to send with calls. You may provide any of the following types:
|
|
960
981
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -991,13 +1012,20 @@ module Google
|
|
|
991
1012
|
# @!attribute [rw] quota_project
|
|
992
1013
|
# A separate project against which to charge quota.
|
|
993
1014
|
# @return [::String]
|
|
1015
|
+
# @!attribute [rw] universe_domain
|
|
1016
|
+
# The universe domain within which to make requests. This determines the
|
|
1017
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
1018
|
+
# universe (usually the default "googleapis.com" universe).
|
|
1019
|
+
# @return [::String,nil]
|
|
994
1020
|
#
|
|
995
1021
|
class Configuration
|
|
996
1022
|
extend ::Gapic::Config
|
|
997
1023
|
|
|
1024
|
+
# @private
|
|
1025
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
998
1026
|
DEFAULT_ENDPOINT = "cloudfunctions.googleapis.com"
|
|
999
1027
|
|
|
1000
|
-
config_attr :endpoint,
|
|
1028
|
+
config_attr :endpoint, nil, ::String, nil
|
|
1001
1029
|
config_attr :credentials, nil do |value|
|
|
1002
1030
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
1003
1031
|
allowed.any? { |klass| klass === value }
|
|
@@ -1009,6 +1037,7 @@ module Google
|
|
|
1009
1037
|
config_attr :metadata, nil, ::Hash, nil
|
|
1010
1038
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
1011
1039
|
config_attr :quota_project, nil, ::String, nil
|
|
1040
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
1012
1041
|
|
|
1013
1042
|
# @private
|
|
1014
1043
|
# 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 get_function 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-v2
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.6.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
|
|
@@ -258,7 +258,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
258
258
|
- !ruby/object:Gem::Version
|
|
259
259
|
version: '0'
|
|
260
260
|
requirements: []
|
|
261
|
-
rubygems_version: 3.
|
|
261
|
+
rubygems_version: 3.5.3
|
|
262
262
|
signing_key:
|
|
263
263
|
specification_version: 4
|
|
264
264
|
summary: Manages lightweight user-provided functions executed in response to events.
|