google-cloud-functions-v1 0.11.0 → 0.13.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/v1/cloud_functions_service/client.rb +44 -9
- data/lib/google/cloud/functions/v1/cloud_functions_service/operations.rb +38 -7
- data/lib/google/cloud/functions/v1/cloud_functions_service/rest/client.rb +237 -7
- data/lib/google/cloud/functions/v1/cloud_functions_service/rest/operations.rb +108 -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
- data/proto_docs/google/api/field_behavior.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,26 +176,32 @@ 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
|
-
interceptors: @config.interceptors
|
203
|
+
interceptors: @config.interceptors,
|
204
|
+
channel_pool_config: @config.channel_pool
|
186
205
|
)
|
187
206
|
end
|
188
207
|
|
@@ -1308,9 +1327,9 @@ module Google
|
|
1308
1327
|
# end
|
1309
1328
|
#
|
1310
1329
|
# @!attribute [rw] endpoint
|
1311
|
-
#
|
1312
|
-
#
|
1313
|
-
# @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]
|
1314
1333
|
# @!attribute [rw] credentials
|
1315
1334
|
# Credentials to send with calls. You may provide any of the following types:
|
1316
1335
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -1356,13 +1375,20 @@ module Google
|
|
1356
1375
|
# @!attribute [rw] quota_project
|
1357
1376
|
# A separate project against which to charge quota.
|
1358
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]
|
1359
1383
|
#
|
1360
1384
|
class Configuration
|
1361
1385
|
extend ::Gapic::Config
|
1362
1386
|
|
1387
|
+
# @private
|
1388
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
1363
1389
|
DEFAULT_ENDPOINT = "cloudfunctions.googleapis.com"
|
1364
1390
|
|
1365
|
-
config_attr :endpoint,
|
1391
|
+
config_attr :endpoint, nil, ::String, nil
|
1366
1392
|
config_attr :credentials, nil do |value|
|
1367
1393
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
1368
1394
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
@@ -1377,6 +1403,7 @@ module Google
|
|
1377
1403
|
config_attr :metadata, nil, ::Hash, nil
|
1378
1404
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
1379
1405
|
config_attr :quota_project, nil, ::String, nil
|
1406
|
+
config_attr :universe_domain, nil, ::String, nil
|
1380
1407
|
|
1381
1408
|
# @private
|
1382
1409
|
def initialize parent_config = nil
|
@@ -1397,6 +1424,14 @@ module Google
|
|
1397
1424
|
end
|
1398
1425
|
end
|
1399
1426
|
|
1427
|
+
##
|
1428
|
+
# Configuration for the channel pool
|
1429
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
1430
|
+
#
|
1431
|
+
def channel_pool
|
1432
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
1433
|
+
end
|
1434
|
+
|
1400
1435
|
##
|
1401
1436
|
# Configuration RPC class for the CloudFunctionsService API.
|
1402
1437
|
#
|
@@ -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,10 +102,13 @@ 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
|
-
interceptors: @config.interceptors
|
110
|
+
interceptors: @config.interceptors,
|
111
|
+
channel_pool_config: @config.channel_pool
|
97
112
|
)
|
98
113
|
|
99
114
|
# Used by an LRO wrapper for some methods of this service
|
@@ -604,9 +619,9 @@ module Google
|
|
604
619
|
# end
|
605
620
|
#
|
606
621
|
# @!attribute [rw] endpoint
|
607
|
-
#
|
608
|
-
#
|
609
|
-
# @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]
|
610
625
|
# @!attribute [rw] credentials
|
611
626
|
# Credentials to send with calls. You may provide any of the following types:
|
612
627
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -652,13 +667,20 @@ module Google
|
|
652
667
|
# @!attribute [rw] quota_project
|
653
668
|
# A separate project against which to charge quota.
|
654
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]
|
655
675
|
#
|
656
676
|
class Configuration
|
657
677
|
extend ::Gapic::Config
|
658
678
|
|
679
|
+
# @private
|
680
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
659
681
|
DEFAULT_ENDPOINT = "cloudfunctions.googleapis.com"
|
660
682
|
|
661
|
-
config_attr :endpoint,
|
683
|
+
config_attr :endpoint, nil, ::String, nil
|
662
684
|
config_attr :credentials, nil do |value|
|
663
685
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
664
686
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
@@ -673,6 +695,7 @@ module Google
|
|
673
695
|
config_attr :metadata, nil, ::Hash, nil
|
674
696
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
675
697
|
config_attr :quota_project, nil, ::String, nil
|
698
|
+
config_attr :universe_domain, nil, ::String, nil
|
676
699
|
|
677
700
|
# @private
|
678
701
|
def initialize parent_config = nil
|
@@ -693,6 +716,14 @@ module Google
|
|
693
716
|
end
|
694
717
|
end
|
695
718
|
|
719
|
+
##
|
720
|
+
# Configuration for the channel pool
|
721
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
722
|
+
#
|
723
|
+
def channel_pool
|
724
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
725
|
+
end
|
726
|
+
|
696
727
|
##
|
697
728
|
# Configuration RPC class for the Operations API.
|
698
729
|
#
|
@@ -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
|
##
|
@@ -240,6 +261,26 @@ module Google
|
|
240
261
|
# @return [::Google::Cloud::Functions::V1::ListFunctionsResponse]
|
241
262
|
#
|
242
263
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
264
|
+
#
|
265
|
+
# @example Basic example
|
266
|
+
# require "google/cloud/functions/v1"
|
267
|
+
#
|
268
|
+
# # Create a client object. The client can be reused for multiple calls.
|
269
|
+
# client = Google::Cloud::Functions::V1::CloudFunctionsService::Rest::Client.new
|
270
|
+
#
|
271
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
272
|
+
# request = Google::Cloud::Functions::V1::ListFunctionsRequest.new
|
273
|
+
#
|
274
|
+
# # Call the list_functions method.
|
275
|
+
# result = client.list_functions request
|
276
|
+
#
|
277
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
278
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
279
|
+
# result.each do |item|
|
280
|
+
# # Each element is of type ::Google::Cloud::Functions::V1::CloudFunction.
|
281
|
+
# p item
|
282
|
+
# end
|
283
|
+
#
|
243
284
|
def list_functions request, options = nil
|
244
285
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
245
286
|
|
@@ -302,6 +343,22 @@ module Google
|
|
302
343
|
# @return [::Google::Cloud::Functions::V1::CloudFunction]
|
303
344
|
#
|
304
345
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
346
|
+
#
|
347
|
+
# @example Basic example
|
348
|
+
# require "google/cloud/functions/v1"
|
349
|
+
#
|
350
|
+
# # Create a client object. The client can be reused for multiple calls.
|
351
|
+
# client = Google::Cloud::Functions::V1::CloudFunctionsService::Rest::Client.new
|
352
|
+
#
|
353
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
354
|
+
# request = Google::Cloud::Functions::V1::GetFunctionRequest.new
|
355
|
+
#
|
356
|
+
# # Call the get_function method.
|
357
|
+
# result = client.get_function request
|
358
|
+
#
|
359
|
+
# # The returned object is of type Google::Cloud::Functions::V1::CloudFunction.
|
360
|
+
# p result
|
361
|
+
#
|
305
362
|
def get_function request, options = nil
|
306
363
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
307
364
|
|
@@ -369,6 +426,29 @@ module Google
|
|
369
426
|
# @return [::Gapic::Operation]
|
370
427
|
#
|
371
428
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
429
|
+
#
|
430
|
+
# @example Basic example
|
431
|
+
# require "google/cloud/functions/v1"
|
432
|
+
#
|
433
|
+
# # Create a client object. The client can be reused for multiple calls.
|
434
|
+
# client = Google::Cloud::Functions::V1::CloudFunctionsService::Rest::Client.new
|
435
|
+
#
|
436
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
437
|
+
# request = Google::Cloud::Functions::V1::CreateFunctionRequest.new
|
438
|
+
#
|
439
|
+
# # Call the create_function method.
|
440
|
+
# result = client.create_function request
|
441
|
+
#
|
442
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
443
|
+
# # check the status of an operation, cancel it, or wait for results.
|
444
|
+
# # Here is how to wait for a response.
|
445
|
+
# result.wait_until_done! timeout: 60
|
446
|
+
# if result.response?
|
447
|
+
# p result.response
|
448
|
+
# else
|
449
|
+
# puts "No response received."
|
450
|
+
# end
|
451
|
+
#
|
372
452
|
def create_function request, options = nil
|
373
453
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
374
454
|
|
@@ -434,6 +514,29 @@ module Google
|
|
434
514
|
# @return [::Gapic::Operation]
|
435
515
|
#
|
436
516
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
517
|
+
#
|
518
|
+
# @example Basic example
|
519
|
+
# require "google/cloud/functions/v1"
|
520
|
+
#
|
521
|
+
# # Create a client object. The client can be reused for multiple calls.
|
522
|
+
# client = Google::Cloud::Functions::V1::CloudFunctionsService::Rest::Client.new
|
523
|
+
#
|
524
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
525
|
+
# request = Google::Cloud::Functions::V1::UpdateFunctionRequest.new
|
526
|
+
#
|
527
|
+
# # Call the update_function method.
|
528
|
+
# result = client.update_function request
|
529
|
+
#
|
530
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
531
|
+
# # check the status of an operation, cancel it, or wait for results.
|
532
|
+
# # Here is how to wait for a response.
|
533
|
+
# result.wait_until_done! timeout: 60
|
534
|
+
# if result.response?
|
535
|
+
# p result.response
|
536
|
+
# else
|
537
|
+
# puts "No response received."
|
538
|
+
# end
|
539
|
+
#
|
437
540
|
def update_function request, options = nil
|
438
541
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
439
542
|
|
@@ -499,6 +602,29 @@ module Google
|
|
499
602
|
# @return [::Gapic::Operation]
|
500
603
|
#
|
501
604
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
605
|
+
#
|
606
|
+
# @example Basic example
|
607
|
+
# require "google/cloud/functions/v1"
|
608
|
+
#
|
609
|
+
# # Create a client object. The client can be reused for multiple calls.
|
610
|
+
# client = Google::Cloud::Functions::V1::CloudFunctionsService::Rest::Client.new
|
611
|
+
#
|
612
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
613
|
+
# request = Google::Cloud::Functions::V1::DeleteFunctionRequest.new
|
614
|
+
#
|
615
|
+
# # Call the delete_function method.
|
616
|
+
# result = client.delete_function request
|
617
|
+
#
|
618
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
619
|
+
# # check the status of an operation, cancel it, or wait for results.
|
620
|
+
# # Here is how to wait for a response.
|
621
|
+
# result.wait_until_done! timeout: 60
|
622
|
+
# if result.response?
|
623
|
+
# p result.response
|
624
|
+
# else
|
625
|
+
# puts "No response received."
|
626
|
+
# end
|
627
|
+
#
|
502
628
|
def delete_function request, options = nil
|
503
629
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
504
630
|
|
@@ -567,6 +693,22 @@ module Google
|
|
567
693
|
# @return [::Google::Cloud::Functions::V1::CallFunctionResponse]
|
568
694
|
#
|
569
695
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
696
|
+
#
|
697
|
+
# @example Basic example
|
698
|
+
# require "google/cloud/functions/v1"
|
699
|
+
#
|
700
|
+
# # Create a client object. The client can be reused for multiple calls.
|
701
|
+
# client = Google::Cloud::Functions::V1::CloudFunctionsService::Rest::Client.new
|
702
|
+
#
|
703
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
704
|
+
# request = Google::Cloud::Functions::V1::CallFunctionRequest.new
|
705
|
+
#
|
706
|
+
# # Call the call_function method.
|
707
|
+
# result = client.call_function request
|
708
|
+
#
|
709
|
+
# # The returned object is of type Google::Cloud::Functions::V1::CallFunctionResponse.
|
710
|
+
# p result
|
711
|
+
#
|
570
712
|
def call_function request, options = nil
|
571
713
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
572
714
|
|
@@ -672,6 +814,22 @@ module Google
|
|
672
814
|
# @return [::Google::Cloud::Functions::V1::GenerateUploadUrlResponse]
|
673
815
|
#
|
674
816
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
817
|
+
#
|
818
|
+
# @example Basic example
|
819
|
+
# require "google/cloud/functions/v1"
|
820
|
+
#
|
821
|
+
# # Create a client object. The client can be reused for multiple calls.
|
822
|
+
# client = Google::Cloud::Functions::V1::CloudFunctionsService::Rest::Client.new
|
823
|
+
#
|
824
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
825
|
+
# request = Google::Cloud::Functions::V1::GenerateUploadUrlRequest.new
|
826
|
+
#
|
827
|
+
# # Call the generate_upload_url method.
|
828
|
+
# result = client.generate_upload_url request
|
829
|
+
#
|
830
|
+
# # The returned object is of type Google::Cloud::Functions::V1::GenerateUploadUrlResponse.
|
831
|
+
# p result
|
832
|
+
#
|
675
833
|
def generate_upload_url request, options = nil
|
676
834
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
677
835
|
|
@@ -742,6 +900,22 @@ module Google
|
|
742
900
|
# @return [::Google::Cloud::Functions::V1::GenerateDownloadUrlResponse]
|
743
901
|
#
|
744
902
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
903
|
+
#
|
904
|
+
# @example Basic example
|
905
|
+
# require "google/cloud/functions/v1"
|
906
|
+
#
|
907
|
+
# # Create a client object. The client can be reused for multiple calls.
|
908
|
+
# client = Google::Cloud::Functions::V1::CloudFunctionsService::Rest::Client.new
|
909
|
+
#
|
910
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
911
|
+
# request = Google::Cloud::Functions::V1::GenerateDownloadUrlRequest.new
|
912
|
+
#
|
913
|
+
# # Call the generate_download_url method.
|
914
|
+
# result = client.generate_download_url request
|
915
|
+
#
|
916
|
+
# # The returned object is of type Google::Cloud::Functions::V1::GenerateDownloadUrlResponse.
|
917
|
+
# p result
|
918
|
+
#
|
745
919
|
def generate_download_url request, options = nil
|
746
920
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
747
921
|
|
@@ -817,6 +991,22 @@ module Google
|
|
817
991
|
# @return [::Google::Iam::V1::Policy]
|
818
992
|
#
|
819
993
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
994
|
+
#
|
995
|
+
# @example Basic example
|
996
|
+
# require "google/cloud/functions/v1"
|
997
|
+
#
|
998
|
+
# # Create a client object. The client can be reused for multiple calls.
|
999
|
+
# client = Google::Cloud::Functions::V1::CloudFunctionsService::Rest::Client.new
|
1000
|
+
#
|
1001
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1002
|
+
# request = Google::Iam::V1::SetIamPolicyRequest.new
|
1003
|
+
#
|
1004
|
+
# # Call the set_iam_policy method.
|
1005
|
+
# result = client.set_iam_policy request
|
1006
|
+
#
|
1007
|
+
# # The returned object is of type Google::Iam::V1::Policy.
|
1008
|
+
# p result
|
1009
|
+
#
|
820
1010
|
def set_iam_policy request, options = nil
|
821
1011
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
822
1012
|
|
@@ -885,6 +1075,22 @@ module Google
|
|
885
1075
|
# @return [::Google::Iam::V1::Policy]
|
886
1076
|
#
|
887
1077
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1078
|
+
#
|
1079
|
+
# @example Basic example
|
1080
|
+
# require "google/cloud/functions/v1"
|
1081
|
+
#
|
1082
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1083
|
+
# client = Google::Cloud::Functions::V1::CloudFunctionsService::Rest::Client.new
|
1084
|
+
#
|
1085
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1086
|
+
# request = Google::Iam::V1::GetIamPolicyRequest.new
|
1087
|
+
#
|
1088
|
+
# # Call the get_iam_policy method.
|
1089
|
+
# result = client.get_iam_policy request
|
1090
|
+
#
|
1091
|
+
# # The returned object is of type Google::Iam::V1::Policy.
|
1092
|
+
# p result
|
1093
|
+
#
|
888
1094
|
def get_iam_policy request, options = nil
|
889
1095
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
890
1096
|
|
@@ -956,6 +1162,22 @@ module Google
|
|
956
1162
|
# @return [::Google::Iam::V1::TestIamPermissionsResponse]
|
957
1163
|
#
|
958
1164
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1165
|
+
#
|
1166
|
+
# @example Basic example
|
1167
|
+
# require "google/cloud/functions/v1"
|
1168
|
+
#
|
1169
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1170
|
+
# client = Google::Cloud::Functions::V1::CloudFunctionsService::Rest::Client.new
|
1171
|
+
#
|
1172
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1173
|
+
# request = Google::Iam::V1::TestIamPermissionsRequest.new
|
1174
|
+
#
|
1175
|
+
# # Call the test_iam_permissions method.
|
1176
|
+
# result = client.test_iam_permissions request
|
1177
|
+
#
|
1178
|
+
# # The returned object is of type Google::Iam::V1::TestIamPermissionsResponse.
|
1179
|
+
# p result
|
1180
|
+
#
|
959
1181
|
def test_iam_permissions request, options = nil
|
960
1182
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
961
1183
|
|
@@ -1021,9 +1243,9 @@ module Google
|
|
1021
1243
|
# end
|
1022
1244
|
#
|
1023
1245
|
# @!attribute [rw] endpoint
|
1024
|
-
#
|
1025
|
-
#
|
1026
|
-
# @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]
|
1027
1249
|
# @!attribute [rw] credentials
|
1028
1250
|
# Credentials to send with calls. You may provide any of the following types:
|
1029
1251
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -1060,13 +1282,20 @@ module Google
|
|
1060
1282
|
# @!attribute [rw] quota_project
|
1061
1283
|
# A separate project against which to charge quota.
|
1062
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]
|
1063
1290
|
#
|
1064
1291
|
class Configuration
|
1065
1292
|
extend ::Gapic::Config
|
1066
1293
|
|
1294
|
+
# @private
|
1295
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
1067
1296
|
DEFAULT_ENDPOINT = "cloudfunctions.googleapis.com"
|
1068
1297
|
|
1069
|
-
config_attr :endpoint,
|
1298
|
+
config_attr :endpoint, nil, ::String, nil
|
1070
1299
|
config_attr :credentials, nil do |value|
|
1071
1300
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
1072
1301
|
allowed.any? { |klass| klass === value }
|
@@ -1078,6 +1307,7 @@ module Google
|
|
1078
1307
|
config_attr :metadata, nil, ::Hash, nil
|
1079
1308
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
1080
1309
|
config_attr :quota_project, nil, ::String, nil
|
1310
|
+
config_attr :universe_domain, nil, ::String, nil
|
1081
1311
|
|
1082
1312
|
# @private
|
1083
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
|
@@ -136,6 +150,26 @@ module Google
|
|
136
150
|
# @return [::Gapic::Operation]
|
137
151
|
#
|
138
152
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
153
|
+
#
|
154
|
+
# @example Basic example
|
155
|
+
# require "google/longrunning"
|
156
|
+
#
|
157
|
+
# # Create a client object. The client can be reused for multiple calls.
|
158
|
+
# client = Google::Longrunning::Operations::Rest::Client.new
|
159
|
+
#
|
160
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
161
|
+
# request = Google::Longrunning::ListOperationsRequest.new
|
162
|
+
#
|
163
|
+
# # Call the list_operations method.
|
164
|
+
# result = client.list_operations request
|
165
|
+
#
|
166
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
167
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
168
|
+
# result.each do |item|
|
169
|
+
# # Each element is of type ::Google::Longrunning::Operation.
|
170
|
+
# p item
|
171
|
+
# end
|
172
|
+
#
|
139
173
|
def list_operations request, options = nil
|
140
174
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
141
175
|
|
@@ -201,6 +235,29 @@ module Google
|
|
201
235
|
# @return [::Gapic::Operation]
|
202
236
|
#
|
203
237
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
238
|
+
#
|
239
|
+
# @example Basic example
|
240
|
+
# require "google/longrunning"
|
241
|
+
#
|
242
|
+
# # Create a client object. The client can be reused for multiple calls.
|
243
|
+
# client = Google::Longrunning::Operations::Rest::Client.new
|
244
|
+
#
|
245
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
246
|
+
# request = Google::Longrunning::GetOperationRequest.new
|
247
|
+
#
|
248
|
+
# # Call the get_operation method.
|
249
|
+
# result = client.get_operation request
|
250
|
+
#
|
251
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
252
|
+
# # check the status of an operation, cancel it, or wait for results.
|
253
|
+
# # Here is how to wait for a response.
|
254
|
+
# result.wait_until_done! timeout: 60
|
255
|
+
# if result.response?
|
256
|
+
# p result.response
|
257
|
+
# else
|
258
|
+
# puts "No response received."
|
259
|
+
# end
|
260
|
+
#
|
204
261
|
def get_operation request, options = nil
|
205
262
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
206
263
|
|
@@ -267,6 +324,22 @@ module Google
|
|
267
324
|
# @return [::Google::Protobuf::Empty]
|
268
325
|
#
|
269
326
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
327
|
+
#
|
328
|
+
# @example Basic example
|
329
|
+
# require "google/longrunning"
|
330
|
+
#
|
331
|
+
# # Create a client object. The client can be reused for multiple calls.
|
332
|
+
# client = Google::Longrunning::Operations::Rest::Client.new
|
333
|
+
#
|
334
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
335
|
+
# request = Google::Longrunning::DeleteOperationRequest.new
|
336
|
+
#
|
337
|
+
# # Call the delete_operation method.
|
338
|
+
# result = client.delete_operation request
|
339
|
+
#
|
340
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
341
|
+
# p result
|
342
|
+
#
|
270
343
|
def delete_operation request, options = nil
|
271
344
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
272
345
|
|
@@ -338,6 +411,22 @@ module Google
|
|
338
411
|
# @return [::Google::Protobuf::Empty]
|
339
412
|
#
|
340
413
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
414
|
+
#
|
415
|
+
# @example Basic example
|
416
|
+
# require "google/longrunning"
|
417
|
+
#
|
418
|
+
# # Create a client object. The client can be reused for multiple calls.
|
419
|
+
# client = Google::Longrunning::Operations::Rest::Client.new
|
420
|
+
#
|
421
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
422
|
+
# request = Google::Longrunning::CancelOperationRequest.new
|
423
|
+
#
|
424
|
+
# # Call the cancel_operation method.
|
425
|
+
# result = client.cancel_operation request
|
426
|
+
#
|
427
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
428
|
+
# p result
|
429
|
+
#
|
341
430
|
def cancel_operation request, options = nil
|
342
431
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
343
432
|
|
@@ -403,9 +492,9 @@ module Google
|
|
403
492
|
# end
|
404
493
|
#
|
405
494
|
# @!attribute [rw] endpoint
|
406
|
-
#
|
407
|
-
#
|
408
|
-
# @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]
|
409
498
|
# @!attribute [rw] credentials
|
410
499
|
# Credentials to send with calls. You may provide any of the following types:
|
411
500
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -442,13 +531,20 @@ module Google
|
|
442
531
|
# @!attribute [rw] quota_project
|
443
532
|
# A separate project against which to charge quota.
|
444
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]
|
445
539
|
#
|
446
540
|
class Configuration
|
447
541
|
extend ::Gapic::Config
|
448
542
|
|
543
|
+
# @private
|
544
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
449
545
|
DEFAULT_ENDPOINT = "cloudfunctions.googleapis.com"
|
450
546
|
|
451
|
-
config_attr :endpoint,
|
547
|
+
config_attr :endpoint, nil, ::String, nil
|
452
548
|
config_attr :credentials, nil do |value|
|
453
549
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
454
550
|
allowed.any? { |klass| klass === value }
|
@@ -460,6 +556,7 @@ module Google
|
|
460
556
|
config_attr :metadata, nil, ::Hash, nil
|
461
557
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
462
558
|
config_attr :quota_project, nil, ::String, nil
|
559
|
+
config_attr :universe_domain, nil, ::String, nil
|
463
560
|
|
464
561
|
# @private
|
465
562
|
def initialize parent_config = nil
|
@@ -542,12 +639,15 @@ module Google
|
|
542
639
|
# Service stub contains baseline method implementations
|
543
640
|
# including transcoding, making the REST call, and deserialing the response.
|
544
641
|
class OperationsServiceStub
|
545
|
-
def initialize endpoint:, credentials:
|
642
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
546
643
|
# These require statements are intentionally placed here to initialize
|
547
644
|
# the REST modules only when it's required.
|
548
645
|
require "gapic/rest"
|
549
646
|
|
550
|
-
@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
|
551
651
|
end
|
552
652
|
|
553
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
|
@@ -66,6 +66,20 @@ module Google
|
|
66
66
|
# a non-empty value will be returned. The user will not be aware of what
|
67
67
|
# non-empty value to expect.
|
68
68
|
NON_EMPTY_DEFAULT = 7
|
69
|
+
|
70
|
+
# Denotes that the field in a resource (a message annotated with
|
71
|
+
# google.api.resource) is used in the resource name to uniquely identify the
|
72
|
+
# resource. For AIP-compliant APIs, this should only be applied to the
|
73
|
+
# `name` field on the resource.
|
74
|
+
#
|
75
|
+
# This behavior should not be applied to references to other resources within
|
76
|
+
# the message.
|
77
|
+
#
|
78
|
+
# The identifier field of resources often have different field behavior
|
79
|
+
# depending on the request it is embedded in (e.g. for Create methods name
|
80
|
+
# is optional and unused, while for Update methods it is required). Instead
|
81
|
+
# of method-specific annotations, only `IDENTIFIER` is required.
|
82
|
+
IDENTIFIER = 8
|
69
83
|
end
|
70
84
|
end
|
71
85
|
end
|
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.
|