google-cloud-functions-v2 0.4.1 → 0.6.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/v2/function_service/client.rb +44 -9
- data/lib/google/cloud/functions/v2/function_service/operations.rb +38 -7
- data/lib/google/cloud/functions/v2/function_service/rest/client.rb +189 -7
- data/lib/google/cloud/functions/v2/function_service/rest/operations.rb +108 -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
- 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: 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,26 +157,32 @@ 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
|
-
interceptors: @config.interceptors
|
|
184
|
+
interceptors: @config.interceptors,
|
|
185
|
+
channel_pool_config: @config.channel_pool
|
|
167
186
|
)
|
|
168
187
|
end
|
|
169
188
|
|
|
@@ -1016,9 +1035,9 @@ module Google
|
|
|
1016
1035
|
# end
|
|
1017
1036
|
#
|
|
1018
1037
|
# @!attribute [rw] endpoint
|
|
1019
|
-
#
|
|
1020
|
-
#
|
|
1021
|
-
# @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]
|
|
1022
1041
|
# @!attribute [rw] credentials
|
|
1023
1042
|
# Credentials to send with calls. You may provide any of the following types:
|
|
1024
1043
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -1064,13 +1083,20 @@ module Google
|
|
|
1064
1083
|
# @!attribute [rw] quota_project
|
|
1065
1084
|
# A separate project against which to charge quota.
|
|
1066
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]
|
|
1067
1091
|
#
|
|
1068
1092
|
class Configuration
|
|
1069
1093
|
extend ::Gapic::Config
|
|
1070
1094
|
|
|
1095
|
+
# @private
|
|
1096
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
1071
1097
|
DEFAULT_ENDPOINT = "cloudfunctions.googleapis.com"
|
|
1072
1098
|
|
|
1073
|
-
config_attr :endpoint,
|
|
1099
|
+
config_attr :endpoint, nil, ::String, nil
|
|
1074
1100
|
config_attr :credentials, nil do |value|
|
|
1075
1101
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
1076
1102
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -1085,6 +1111,7 @@ module Google
|
|
|
1085
1111
|
config_attr :metadata, nil, ::Hash, nil
|
|
1086
1112
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
1087
1113
|
config_attr :quota_project, nil, ::String, nil
|
|
1114
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
1088
1115
|
|
|
1089
1116
|
# @private
|
|
1090
1117
|
def initialize parent_config = nil
|
|
@@ -1105,6 +1132,14 @@ module Google
|
|
|
1105
1132
|
end
|
|
1106
1133
|
end
|
|
1107
1134
|
|
|
1135
|
+
##
|
|
1136
|
+
# Configuration for the channel pool
|
|
1137
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
|
1138
|
+
#
|
|
1139
|
+
def channel_pool
|
|
1140
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
|
1141
|
+
end
|
|
1142
|
+
|
|
1108
1143
|
##
|
|
1109
1144
|
# Configuration RPC class for the FunctionService API.
|
|
1110
1145
|
#
|
|
@@ -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,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
|
|
@@ -612,9 +627,9 @@ module Google
|
|
|
612
627
|
# end
|
|
613
628
|
#
|
|
614
629
|
# @!attribute [rw] endpoint
|
|
615
|
-
#
|
|
616
|
-
#
|
|
617
|
-
# @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]
|
|
618
633
|
# @!attribute [rw] credentials
|
|
619
634
|
# Credentials to send with calls. You may provide any of the following types:
|
|
620
635
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -660,13 +675,20 @@ module Google
|
|
|
660
675
|
# @!attribute [rw] quota_project
|
|
661
676
|
# A separate project against which to charge quota.
|
|
662
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]
|
|
663
683
|
#
|
|
664
684
|
class Configuration
|
|
665
685
|
extend ::Gapic::Config
|
|
666
686
|
|
|
687
|
+
# @private
|
|
688
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
667
689
|
DEFAULT_ENDPOINT = "cloudfunctions.googleapis.com"
|
|
668
690
|
|
|
669
|
-
config_attr :endpoint,
|
|
691
|
+
config_attr :endpoint, nil, ::String, nil
|
|
670
692
|
config_attr :credentials, nil do |value|
|
|
671
693
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
672
694
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -681,6 +703,7 @@ module Google
|
|
|
681
703
|
config_attr :metadata, nil, ::Hash, nil
|
|
682
704
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
683
705
|
config_attr :quota_project, nil, ::String, nil
|
|
706
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
684
707
|
|
|
685
708
|
# @private
|
|
686
709
|
def initialize parent_config = nil
|
|
@@ -701,6 +724,14 @@ module Google
|
|
|
701
724
|
end
|
|
702
725
|
end
|
|
703
726
|
|
|
727
|
+
##
|
|
728
|
+
# Configuration for the channel pool
|
|
729
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
|
730
|
+
#
|
|
731
|
+
def channel_pool
|
|
732
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
|
733
|
+
end
|
|
734
|
+
|
|
704
735
|
##
|
|
705
736
|
# Configuration RPC class for the Operations API.
|
|
706
737
|
#
|
|
@@ -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
|
##
|
|
@@ -210,6 +231,22 @@ module Google
|
|
|
210
231
|
# @return [::Google::Cloud::Functions::V2::Function]
|
|
211
232
|
#
|
|
212
233
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
234
|
+
#
|
|
235
|
+
# @example Basic example
|
|
236
|
+
# require "google/cloud/functions/v2"
|
|
237
|
+
#
|
|
238
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
239
|
+
# client = Google::Cloud::Functions::V2::FunctionService::Rest::Client.new
|
|
240
|
+
#
|
|
241
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
242
|
+
# request = Google::Cloud::Functions::V2::GetFunctionRequest.new
|
|
243
|
+
#
|
|
244
|
+
# # Call the get_function method.
|
|
245
|
+
# result = client.get_function request
|
|
246
|
+
#
|
|
247
|
+
# # The returned object is of type Google::Cloud::Functions::V2::Function.
|
|
248
|
+
# p result
|
|
249
|
+
#
|
|
213
250
|
def get_function request, options = nil
|
|
214
251
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
215
252
|
|
|
@@ -294,6 +331,26 @@ module Google
|
|
|
294
331
|
# @return [::Google::Cloud::Functions::V2::ListFunctionsResponse]
|
|
295
332
|
#
|
|
296
333
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
334
|
+
#
|
|
335
|
+
# @example Basic example
|
|
336
|
+
# require "google/cloud/functions/v2"
|
|
337
|
+
#
|
|
338
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
339
|
+
# client = Google::Cloud::Functions::V2::FunctionService::Rest::Client.new
|
|
340
|
+
#
|
|
341
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
342
|
+
# request = Google::Cloud::Functions::V2::ListFunctionsRequest.new
|
|
343
|
+
#
|
|
344
|
+
# # Call the list_functions method.
|
|
345
|
+
# result = client.list_functions request
|
|
346
|
+
#
|
|
347
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
|
348
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
|
349
|
+
# result.each do |item|
|
|
350
|
+
# # Each element is of type ::Google::Cloud::Functions::V2::Function.
|
|
351
|
+
# p item
|
|
352
|
+
# end
|
|
353
|
+
#
|
|
297
354
|
def list_functions request, options = nil
|
|
298
355
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
299
356
|
|
|
@@ -367,6 +424,29 @@ module Google
|
|
|
367
424
|
# @return [::Gapic::Operation]
|
|
368
425
|
#
|
|
369
426
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
427
|
+
#
|
|
428
|
+
# @example Basic example
|
|
429
|
+
# require "google/cloud/functions/v2"
|
|
430
|
+
#
|
|
431
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
432
|
+
# client = Google::Cloud::Functions::V2::FunctionService::Rest::Client.new
|
|
433
|
+
#
|
|
434
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
435
|
+
# request = Google::Cloud::Functions::V2::CreateFunctionRequest.new
|
|
436
|
+
#
|
|
437
|
+
# # Call the create_function method.
|
|
438
|
+
# result = client.create_function request
|
|
439
|
+
#
|
|
440
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
|
441
|
+
# # check the status of an operation, cancel it, or wait for results.
|
|
442
|
+
# # Here is how to wait for a response.
|
|
443
|
+
# result.wait_until_done! timeout: 60
|
|
444
|
+
# if result.response?
|
|
445
|
+
# p result.response
|
|
446
|
+
# else
|
|
447
|
+
# puts "No response received."
|
|
448
|
+
# end
|
|
449
|
+
#
|
|
370
450
|
def create_function request, options = nil
|
|
371
451
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
372
452
|
|
|
@@ -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/v2"
|
|
520
|
+
#
|
|
521
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
522
|
+
# client = Google::Cloud::Functions::V2::FunctionService::Rest::Client.new
|
|
523
|
+
#
|
|
524
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
525
|
+
# request = Google::Cloud::Functions::V2::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/v2"
|
|
608
|
+
#
|
|
609
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
610
|
+
# client = Google::Cloud::Functions::V2::FunctionService::Rest::Client.new
|
|
611
|
+
#
|
|
612
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
613
|
+
# request = Google::Cloud::Functions::V2::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
|
|
|
@@ -601,6 +727,22 @@ module Google
|
|
|
601
727
|
# @return [::Google::Cloud::Functions::V2::GenerateUploadUrlResponse]
|
|
602
728
|
#
|
|
603
729
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
730
|
+
#
|
|
731
|
+
# @example Basic example
|
|
732
|
+
# require "google/cloud/functions/v2"
|
|
733
|
+
#
|
|
734
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
735
|
+
# client = Google::Cloud::Functions::V2::FunctionService::Rest::Client.new
|
|
736
|
+
#
|
|
737
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
738
|
+
# request = Google::Cloud::Functions::V2::GenerateUploadUrlRequest.new
|
|
739
|
+
#
|
|
740
|
+
# # Call the generate_upload_url method.
|
|
741
|
+
# result = client.generate_upload_url request
|
|
742
|
+
#
|
|
743
|
+
# # The returned object is of type Google::Cloud::Functions::V2::GenerateUploadUrlResponse.
|
|
744
|
+
# p result
|
|
745
|
+
#
|
|
604
746
|
def generate_upload_url request, options = nil
|
|
605
747
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
606
748
|
|
|
@@ -668,6 +810,22 @@ module Google
|
|
|
668
810
|
# @return [::Google::Cloud::Functions::V2::GenerateDownloadUrlResponse]
|
|
669
811
|
#
|
|
670
812
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
813
|
+
#
|
|
814
|
+
# @example Basic example
|
|
815
|
+
# require "google/cloud/functions/v2"
|
|
816
|
+
#
|
|
817
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
818
|
+
# client = Google::Cloud::Functions::V2::FunctionService::Rest::Client.new
|
|
819
|
+
#
|
|
820
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
821
|
+
# request = Google::Cloud::Functions::V2::GenerateDownloadUrlRequest.new
|
|
822
|
+
#
|
|
823
|
+
# # Call the generate_download_url method.
|
|
824
|
+
# result = client.generate_download_url request
|
|
825
|
+
#
|
|
826
|
+
# # The returned object is of type Google::Cloud::Functions::V2::GenerateDownloadUrlResponse.
|
|
827
|
+
# p result
|
|
828
|
+
#
|
|
671
829
|
def generate_download_url request, options = nil
|
|
672
830
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
673
831
|
|
|
@@ -734,6 +892,22 @@ module Google
|
|
|
734
892
|
# @return [::Google::Cloud::Functions::V2::ListRuntimesResponse]
|
|
735
893
|
#
|
|
736
894
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
895
|
+
#
|
|
896
|
+
# @example Basic example
|
|
897
|
+
# require "google/cloud/functions/v2"
|
|
898
|
+
#
|
|
899
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
900
|
+
# client = Google::Cloud::Functions::V2::FunctionService::Rest::Client.new
|
|
901
|
+
#
|
|
902
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
903
|
+
# request = Google::Cloud::Functions::V2::ListRuntimesRequest.new
|
|
904
|
+
#
|
|
905
|
+
# # Call the list_runtimes method.
|
|
906
|
+
# result = client.list_runtimes request
|
|
907
|
+
#
|
|
908
|
+
# # The returned object is of type Google::Cloud::Functions::V2::ListRuntimesResponse.
|
|
909
|
+
# p result
|
|
910
|
+
#
|
|
737
911
|
def list_runtimes request, options = nil
|
|
738
912
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
739
913
|
|
|
@@ -799,9 +973,9 @@ module Google
|
|
|
799
973
|
# end
|
|
800
974
|
#
|
|
801
975
|
# @!attribute [rw] endpoint
|
|
802
|
-
#
|
|
803
|
-
#
|
|
804
|
-
# @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]
|
|
805
979
|
# @!attribute [rw] credentials
|
|
806
980
|
# Credentials to send with calls. You may provide any of the following types:
|
|
807
981
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -838,13 +1012,20 @@ module Google
|
|
|
838
1012
|
# @!attribute [rw] quota_project
|
|
839
1013
|
# A separate project against which to charge quota.
|
|
840
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]
|
|
841
1020
|
#
|
|
842
1021
|
class Configuration
|
|
843
1022
|
extend ::Gapic::Config
|
|
844
1023
|
|
|
1024
|
+
# @private
|
|
1025
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
845
1026
|
DEFAULT_ENDPOINT = "cloudfunctions.googleapis.com"
|
|
846
1027
|
|
|
847
|
-
config_attr :endpoint,
|
|
1028
|
+
config_attr :endpoint, nil, ::String, nil
|
|
848
1029
|
config_attr :credentials, nil do |value|
|
|
849
1030
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
850
1031
|
allowed.any? { |klass| klass === value }
|
|
@@ -856,6 +1037,7 @@ module Google
|
|
|
856
1037
|
config_attr :metadata, nil, ::Hash, nil
|
|
857
1038
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
858
1039
|
config_attr :quota_project, nil, ::String, nil
|
|
1040
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
859
1041
|
|
|
860
1042
|
# @private
|
|
861
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
|
|
@@ -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 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
|
|
@@ -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-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.
|