google-cloud-scheduler-v1 0.9.0 → 0.10.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/scheduler/v1/cloud_scheduler/client.rb +32 -8
- data/lib/google/cloud/scheduler/v1/cloud_scheduler/rest/client.rb +34 -7
- data/lib/google/cloud/scheduler/v1/cloud_scheduler/rest/service_stub.rb +14 -2
- data/lib/google/cloud/scheduler/v1/version.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -0
- data/proto_docs/google/cloud/scheduler/v1/target.rb +4 -4
- metadata +7 -7
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 19ee29dec8647cbb9bd68feb3852d31c61e9a91e7abe1470a9f44a2fb4e0db35
|
|
4
|
+
data.tar.gz: a46da7f83e4b05a3df3ecd25e0b449c0fe8085a7aeabf8b6fa560671dde7f62f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 9dde9956b35af48d842ceb4607150de936eecd3f1fe086fe867b6e4f1db3b353e05a96bd07fceb7641405129486edc1e95c8a9799e83010a08d0adec19459eb5
|
|
7
|
+
data.tar.gz: dbccd1a8d4a541f72198902951c227fa67fae102f2c61e2608d7b4050e078fa6ab679adf82e620a061a6d10b10ab3fb2cd11f2fa546cc8e0abece1d65cfd8224
|
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-scheduler-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-scheduler-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-scheduler-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::Scheduler::V1::CloudScheduler::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/scheduler/v1"
|
|
77
|
-
|
|
78
|
-
ENV["SCHEDULER_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/scheduler/v1"
|
|
90
58
|
|
|
91
59
|
client = ::Google::Cloud::Scheduler::V1::CloudScheduler::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/scheduler/v1"
|
|
100
68
|
|
|
101
69
|
::Google::Cloud::Scheduler::V1::CloudScheduler::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::Scheduler::V1::CloudScheduler::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-scheduler-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/scheduler/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-scheduler-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::Scheduler::V1::CloudScheduler::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
|
# schedule asynchronous jobs.
|
|
33
33
|
#
|
|
34
34
|
class Client
|
|
35
|
+
# @private
|
|
36
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudscheduler.$UNIVERSE_DOMAIN$"
|
|
37
|
+
|
|
35
38
|
include Paths
|
|
36
39
|
|
|
37
40
|
# @private
|
|
@@ -117,6 +120,15 @@ module Google
|
|
|
117
120
|
@config
|
|
118
121
|
end
|
|
119
122
|
|
|
123
|
+
##
|
|
124
|
+
# The effective universe domain
|
|
125
|
+
#
|
|
126
|
+
# @return [String]
|
|
127
|
+
#
|
|
128
|
+
def universe_domain
|
|
129
|
+
@cloud_scheduler_stub.universe_domain
|
|
130
|
+
end
|
|
131
|
+
|
|
120
132
|
##
|
|
121
133
|
# Create a new CloudScheduler client object.
|
|
122
134
|
#
|
|
@@ -150,8 +162,9 @@ module Google
|
|
|
150
162
|
credentials = @config.credentials
|
|
151
163
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
152
164
|
# but only if the default endpoint does not have a region prefix.
|
|
153
|
-
enable_self_signed_jwt = @config.endpoint
|
|
154
|
-
|
|
165
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
166
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
167
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
155
168
|
credentials ||= Credentials.default scope: @config.scope,
|
|
156
169
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
157
170
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -164,12 +177,15 @@ module Google
|
|
|
164
177
|
config.credentials = credentials
|
|
165
178
|
config.quota_project = @quota_project_id
|
|
166
179
|
config.endpoint = @config.endpoint
|
|
180
|
+
config.universe_domain = @config.universe_domain
|
|
167
181
|
end
|
|
168
182
|
|
|
169
183
|
@cloud_scheduler_stub = ::Gapic::ServiceStub.new(
|
|
170
184
|
::Google::Cloud::Scheduler::V1::CloudScheduler::Stub,
|
|
171
|
-
credentials:
|
|
172
|
-
endpoint:
|
|
185
|
+
credentials: credentials,
|
|
186
|
+
endpoint: @config.endpoint,
|
|
187
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
188
|
+
universe_domain: @config.universe_domain,
|
|
173
189
|
channel_args: @config.channel_args,
|
|
174
190
|
interceptors: @config.interceptors,
|
|
175
191
|
channel_pool_config: @config.channel_pool
|
|
@@ -967,9 +983,9 @@ module Google
|
|
|
967
983
|
# end
|
|
968
984
|
#
|
|
969
985
|
# @!attribute [rw] endpoint
|
|
970
|
-
#
|
|
971
|
-
#
|
|
972
|
-
# @return [::String]
|
|
986
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
987
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
988
|
+
# @return [::String,nil]
|
|
973
989
|
# @!attribute [rw] credentials
|
|
974
990
|
# Credentials to send with calls. You may provide any of the following types:
|
|
975
991
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -1015,13 +1031,20 @@ module Google
|
|
|
1015
1031
|
# @!attribute [rw] quota_project
|
|
1016
1032
|
# A separate project against which to charge quota.
|
|
1017
1033
|
# @return [::String]
|
|
1034
|
+
# @!attribute [rw] universe_domain
|
|
1035
|
+
# The universe domain within which to make requests. This determines the
|
|
1036
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
1037
|
+
# universe (usually the default "googleapis.com" universe).
|
|
1038
|
+
# @return [::String,nil]
|
|
1018
1039
|
#
|
|
1019
1040
|
class Configuration
|
|
1020
1041
|
extend ::Gapic::Config
|
|
1021
1042
|
|
|
1043
|
+
# @private
|
|
1044
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
1022
1045
|
DEFAULT_ENDPOINT = "cloudscheduler.googleapis.com"
|
|
1023
1046
|
|
|
1024
|
-
config_attr :endpoint,
|
|
1047
|
+
config_attr :endpoint, nil, ::String, nil
|
|
1025
1048
|
config_attr :credentials, nil do |value|
|
|
1026
1049
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
1027
1050
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -1036,6 +1059,7 @@ module Google
|
|
|
1036
1059
|
config_attr :metadata, nil, ::Hash, nil
|
|
1037
1060
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
1038
1061
|
config_attr :quota_project, nil, ::String, nil
|
|
1062
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
1039
1063
|
|
|
1040
1064
|
# @private
|
|
1041
1065
|
def initialize parent_config = nil
|
|
@@ -34,6 +34,9 @@ module Google
|
|
|
34
34
|
# schedule asynchronous jobs.
|
|
35
35
|
#
|
|
36
36
|
class Client
|
|
37
|
+
# @private
|
|
38
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudscheduler.$UNIVERSE_DOMAIN$"
|
|
39
|
+
|
|
37
40
|
include Paths
|
|
38
41
|
|
|
39
42
|
# @private
|
|
@@ -119,6 +122,15 @@ module Google
|
|
|
119
122
|
@config
|
|
120
123
|
end
|
|
121
124
|
|
|
125
|
+
##
|
|
126
|
+
# The effective universe domain
|
|
127
|
+
#
|
|
128
|
+
# @return [String]
|
|
129
|
+
#
|
|
130
|
+
def universe_domain
|
|
131
|
+
@cloud_scheduler_stub.universe_domain
|
|
132
|
+
end
|
|
133
|
+
|
|
122
134
|
##
|
|
123
135
|
# Create a new CloudScheduler REST client object.
|
|
124
136
|
#
|
|
@@ -146,8 +158,9 @@ module Google
|
|
|
146
158
|
credentials = @config.credentials
|
|
147
159
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
148
160
|
# but only if the default endpoint does not have a region prefix.
|
|
149
|
-
enable_self_signed_jwt = @config.endpoint
|
|
150
|
-
|
|
161
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
162
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
163
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
151
164
|
credentials ||= Credentials.default scope: @config.scope,
|
|
152
165
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
153
166
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -161,10 +174,16 @@ module Google
|
|
|
161
174
|
config.credentials = credentials
|
|
162
175
|
config.quota_project = @quota_project_id
|
|
163
176
|
config.endpoint = @config.endpoint
|
|
177
|
+
config.universe_domain = @config.universe_domain
|
|
164
178
|
config.bindings_override = @config.bindings_override
|
|
165
179
|
end
|
|
166
180
|
|
|
167
|
-
@cloud_scheduler_stub = ::Google::Cloud::Scheduler::V1::CloudScheduler::Rest::ServiceStub.new
|
|
181
|
+
@cloud_scheduler_stub = ::Google::Cloud::Scheduler::V1::CloudScheduler::Rest::ServiceStub.new(
|
|
182
|
+
endpoint: @config.endpoint,
|
|
183
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
184
|
+
universe_domain: @config.universe_domain,
|
|
185
|
+
credentials: credentials
|
|
186
|
+
)
|
|
168
187
|
end
|
|
169
188
|
|
|
170
189
|
##
|
|
@@ -902,9 +921,9 @@ module Google
|
|
|
902
921
|
# end
|
|
903
922
|
#
|
|
904
923
|
# @!attribute [rw] endpoint
|
|
905
|
-
#
|
|
906
|
-
#
|
|
907
|
-
# @return [::String]
|
|
924
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
925
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
926
|
+
# @return [::String,nil]
|
|
908
927
|
# @!attribute [rw] credentials
|
|
909
928
|
# Credentials to send with calls. You may provide any of the following types:
|
|
910
929
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -941,13 +960,20 @@ module Google
|
|
|
941
960
|
# @!attribute [rw] quota_project
|
|
942
961
|
# A separate project against which to charge quota.
|
|
943
962
|
# @return [::String]
|
|
963
|
+
# @!attribute [rw] universe_domain
|
|
964
|
+
# The universe domain within which to make requests. This determines the
|
|
965
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
966
|
+
# universe (usually the default "googleapis.com" universe).
|
|
967
|
+
# @return [::String,nil]
|
|
944
968
|
#
|
|
945
969
|
class Configuration
|
|
946
970
|
extend ::Gapic::Config
|
|
947
971
|
|
|
972
|
+
# @private
|
|
973
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
948
974
|
DEFAULT_ENDPOINT = "cloudscheduler.googleapis.com"
|
|
949
975
|
|
|
950
|
-
config_attr :endpoint,
|
|
976
|
+
config_attr :endpoint, nil, ::String, nil
|
|
951
977
|
config_attr :credentials, nil do |value|
|
|
952
978
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
953
979
|
allowed.any? { |klass| klass === value }
|
|
@@ -959,6 +985,7 @@ module Google
|
|
|
959
985
|
config_attr :metadata, nil, ::Hash, nil
|
|
960
986
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
961
987
|
config_attr :quota_project, nil, ::String, nil
|
|
988
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
962
989
|
|
|
963
990
|
# @private
|
|
964
991
|
# Overrides for http bindings for the RPCs of this service
|
|
@@ -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_jobs 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
|
|
@@ -57,8 +57,8 @@ module Google
|
|
|
57
57
|
# * `X-CloudScheduler`: This header will be set to true.
|
|
58
58
|
# * `X-CloudScheduler-JobName`: This header will contain the job name.
|
|
59
59
|
# * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
|
|
60
|
-
# the unix-cron format, this header will contain the job schedule
|
|
61
|
-
#
|
|
60
|
+
# the unix-cron format, this header will contain the job schedule as an
|
|
61
|
+
# offset of UTC parsed according to RFC3339.
|
|
62
62
|
#
|
|
63
63
|
# The total size of headers must be less than 80KB.
|
|
64
64
|
# @!attribute [rw] body
|
|
@@ -141,8 +141,8 @@ module Google
|
|
|
141
141
|
# * `X-CloudScheduler`: This header will be set to true.
|
|
142
142
|
# * `X-CloudScheduler-JobName`: This header will contain the job name.
|
|
143
143
|
# * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
|
|
144
|
-
# the unix-cron format, this header will contain the job schedule
|
|
145
|
-
#
|
|
144
|
+
# the unix-cron format, this header will contain the job schedule as an
|
|
145
|
+
# offset of UTC parsed according to RFC3339.
|
|
146
146
|
#
|
|
147
147
|
# If the job has an
|
|
148
148
|
# {::Google::Cloud::Scheduler::V1::AppEngineHttpTarget#body body}, Cloud Scheduler
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-scheduler-v1
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.10.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
|
|
@@ -242,7 +242,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
242
242
|
- !ruby/object:Gem::Version
|
|
243
243
|
version: '0'
|
|
244
244
|
requirements: []
|
|
245
|
-
rubygems_version: 3.
|
|
245
|
+
rubygems_version: 3.5.3
|
|
246
246
|
signing_key:
|
|
247
247
|
specification_version: 4
|
|
248
248
|
summary: Creates and manages jobs run on a regular recurring schedule.
|