google-cloud-datastore-admin-v1 0.9.1 → 0.11.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/datastore/admin/v1/datastore_admin/client.rb +42 -9
- data/lib/google/cloud/datastore/admin/v1/datastore_admin/operations.rb +38 -7
- data/lib/google/cloud/datastore/admin/v1/datastore_admin/rest/client.rb +162 -7
- data/lib/google/cloud/datastore/admin/v1/datastore_admin/rest/operations.rb +108 -8
- data/lib/google/cloud/datastore/admin/v1/datastore_admin/rest/service_stub.rb +14 -2
- data/lib/google/cloud/datastore/admin/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 +5 -5
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 49f0789af14b1582fe3824cd633ce4cf7d5c197db50c80ac757f2f9de34c6802
|
|
4
|
+
data.tar.gz: 14246712b6c762b4ea63897666c66068e93362585b20d4119383641fb71f6af1
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 04dffb94adca37a82a5d2f4066a0ec8d01477fa4a49744c6855fc9224530fc9273333c80d22f974d76775ebb55ee6760d98d2db8b327f6f1f03d516a7991807c
|
|
7
|
+
data.tar.gz: 962de77b344302832fa02027b447c606fcde819fcc5ec1ed501ffa369a36a4539e2d83d23c2eec38f8f170b1b614e85f5a97e1252559ff5f08b7901ec94a053f
|
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-datastore-admin-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-datastore-admin-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-datastore-admin-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::Datastore::Admin::V1::DatastoreAdmin::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/datastore/admin/v1"
|
|
77
|
-
|
|
78
|
-
ENV["DATASTORE_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/datastore/admin/v1"
|
|
90
58
|
|
|
91
59
|
client = ::Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::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/datastore/admin/v1"
|
|
100
68
|
|
|
101
69
|
::Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::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::Datastore::Admin::V1::DatastoreAdmin::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-datastore-admin-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/datastore/admin/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-datastore-admin-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::Datastore::Admin::V1::DatastoreAdmin::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).
|
|
@@ -77,6 +77,9 @@ module Google
|
|
|
77
77
|
# service google.longrunning.Operations.
|
|
78
78
|
#
|
|
79
79
|
class Client
|
|
80
|
+
# @private
|
|
81
|
+
DEFAULT_ENDPOINT_TEMPLATE = "datastore.$UNIVERSE_DOMAIN$"
|
|
82
|
+
|
|
80
83
|
# @private
|
|
81
84
|
attr_reader :datastore_admin_stub
|
|
82
85
|
|
|
@@ -153,6 +156,15 @@ module Google
|
|
|
153
156
|
@config
|
|
154
157
|
end
|
|
155
158
|
|
|
159
|
+
##
|
|
160
|
+
# The effective universe domain
|
|
161
|
+
#
|
|
162
|
+
# @return [String]
|
|
163
|
+
#
|
|
164
|
+
def universe_domain
|
|
165
|
+
@datastore_admin_stub.universe_domain
|
|
166
|
+
end
|
|
167
|
+
|
|
156
168
|
##
|
|
157
169
|
# Create a new DatastoreAdmin client object.
|
|
158
170
|
#
|
|
@@ -186,8 +198,9 @@ module Google
|
|
|
186
198
|
credentials = @config.credentials
|
|
187
199
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
188
200
|
# but only if the default endpoint does not have a region prefix.
|
|
189
|
-
enable_self_signed_jwt = @config.endpoint
|
|
190
|
-
|
|
201
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
202
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
203
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
191
204
|
credentials ||= Credentials.default scope: @config.scope,
|
|
192
205
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
193
206
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -200,14 +213,18 @@ module Google
|
|
|
200
213
|
config.credentials = credentials
|
|
201
214
|
config.quota_project = @quota_project_id
|
|
202
215
|
config.endpoint = @config.endpoint
|
|
216
|
+
config.universe_domain = @config.universe_domain
|
|
203
217
|
end
|
|
204
218
|
|
|
205
219
|
@datastore_admin_stub = ::Gapic::ServiceStub.new(
|
|
206
220
|
::Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Stub,
|
|
207
|
-
credentials:
|
|
208
|
-
endpoint:
|
|
221
|
+
credentials: credentials,
|
|
222
|
+
endpoint: @config.endpoint,
|
|
223
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
224
|
+
universe_domain: @config.universe_domain,
|
|
209
225
|
channel_args: @config.channel_args,
|
|
210
|
-
interceptors: @config.interceptors
|
|
226
|
+
interceptors: @config.interceptors,
|
|
227
|
+
channel_pool_config: @config.channel_pool
|
|
211
228
|
)
|
|
212
229
|
end
|
|
213
230
|
|
|
@@ -897,9 +914,9 @@ module Google
|
|
|
897
914
|
# end
|
|
898
915
|
#
|
|
899
916
|
# @!attribute [rw] endpoint
|
|
900
|
-
#
|
|
901
|
-
#
|
|
902
|
-
# @return [::String]
|
|
917
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
918
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
919
|
+
# @return [::String,nil]
|
|
903
920
|
# @!attribute [rw] credentials
|
|
904
921
|
# Credentials to send with calls. You may provide any of the following types:
|
|
905
922
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -945,13 +962,20 @@ module Google
|
|
|
945
962
|
# @!attribute [rw] quota_project
|
|
946
963
|
# A separate project against which to charge quota.
|
|
947
964
|
# @return [::String]
|
|
965
|
+
# @!attribute [rw] universe_domain
|
|
966
|
+
# The universe domain within which to make requests. This determines the
|
|
967
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
968
|
+
# universe (usually the default "googleapis.com" universe).
|
|
969
|
+
# @return [::String,nil]
|
|
948
970
|
#
|
|
949
971
|
class Configuration
|
|
950
972
|
extend ::Gapic::Config
|
|
951
973
|
|
|
974
|
+
# @private
|
|
975
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
952
976
|
DEFAULT_ENDPOINT = "datastore.googleapis.com"
|
|
953
977
|
|
|
954
|
-
config_attr :endpoint,
|
|
978
|
+
config_attr :endpoint, nil, ::String, nil
|
|
955
979
|
config_attr :credentials, nil do |value|
|
|
956
980
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
957
981
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -966,6 +990,7 @@ module Google
|
|
|
966
990
|
config_attr :metadata, nil, ::Hash, nil
|
|
967
991
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
968
992
|
config_attr :quota_project, nil, ::String, nil
|
|
993
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
969
994
|
|
|
970
995
|
# @private
|
|
971
996
|
def initialize parent_config = nil
|
|
@@ -986,6 +1011,14 @@ module Google
|
|
|
986
1011
|
end
|
|
987
1012
|
end
|
|
988
1013
|
|
|
1014
|
+
##
|
|
1015
|
+
# Configuration for the channel pool
|
|
1016
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
|
1017
|
+
#
|
|
1018
|
+
def channel_pool
|
|
1019
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
|
1020
|
+
end
|
|
1021
|
+
|
|
989
1022
|
##
|
|
990
1023
|
# Configuration RPC class for the DatastoreAdmin API.
|
|
991
1024
|
#
|
|
@@ -27,6 +27,9 @@ module Google
|
|
|
27
27
|
module DatastoreAdmin
|
|
28
28
|
# Service that implements Longrunning Operations API.
|
|
29
29
|
class Operations
|
|
30
|
+
# @private
|
|
31
|
+
DEFAULT_ENDPOINT_TEMPLATE = "datastore.$UNIVERSE_DOMAIN$"
|
|
32
|
+
|
|
30
33
|
# @private
|
|
31
34
|
attr_reader :operations_stub
|
|
32
35
|
|
|
@@ -61,6 +64,15 @@ module Google
|
|
|
61
64
|
@config
|
|
62
65
|
end
|
|
63
66
|
|
|
67
|
+
##
|
|
68
|
+
# The effective universe domain
|
|
69
|
+
#
|
|
70
|
+
# @return [String]
|
|
71
|
+
#
|
|
72
|
+
def universe_domain
|
|
73
|
+
@operations_stub.universe_domain
|
|
74
|
+
end
|
|
75
|
+
|
|
64
76
|
##
|
|
65
77
|
# Create a new Operations client object.
|
|
66
78
|
#
|
|
@@ -91,10 +103,13 @@ module Google
|
|
|
91
103
|
|
|
92
104
|
@operations_stub = ::Gapic::ServiceStub.new(
|
|
93
105
|
::Google::Longrunning::Operations::Stub,
|
|
94
|
-
credentials:
|
|
95
|
-
endpoint:
|
|
106
|
+
credentials: credentials,
|
|
107
|
+
endpoint: @config.endpoint,
|
|
108
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
109
|
+
universe_domain: @config.universe_domain,
|
|
96
110
|
channel_args: @config.channel_args,
|
|
97
|
-
interceptors: @config.interceptors
|
|
111
|
+
interceptors: @config.interceptors,
|
|
112
|
+
channel_pool_config: @config.channel_pool
|
|
98
113
|
)
|
|
99
114
|
|
|
100
115
|
# Used by an LRO wrapper for some methods of this service
|
|
@@ -613,9 +628,9 @@ module Google
|
|
|
613
628
|
# end
|
|
614
629
|
#
|
|
615
630
|
# @!attribute [rw] endpoint
|
|
616
|
-
#
|
|
617
|
-
#
|
|
618
|
-
# @return [::String]
|
|
631
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
632
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
633
|
+
# @return [::String,nil]
|
|
619
634
|
# @!attribute [rw] credentials
|
|
620
635
|
# Credentials to send with calls. You may provide any of the following types:
|
|
621
636
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -661,13 +676,20 @@ module Google
|
|
|
661
676
|
# @!attribute [rw] quota_project
|
|
662
677
|
# A separate project against which to charge quota.
|
|
663
678
|
# @return [::String]
|
|
679
|
+
# @!attribute [rw] universe_domain
|
|
680
|
+
# The universe domain within which to make requests. This determines the
|
|
681
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
682
|
+
# universe (usually the default "googleapis.com" universe).
|
|
683
|
+
# @return [::String,nil]
|
|
664
684
|
#
|
|
665
685
|
class Configuration
|
|
666
686
|
extend ::Gapic::Config
|
|
667
687
|
|
|
688
|
+
# @private
|
|
689
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
668
690
|
DEFAULT_ENDPOINT = "datastore.googleapis.com"
|
|
669
691
|
|
|
670
|
-
config_attr :endpoint,
|
|
692
|
+
config_attr :endpoint, nil, ::String, nil
|
|
671
693
|
config_attr :credentials, nil do |value|
|
|
672
694
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
673
695
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -682,6 +704,7 @@ module Google
|
|
|
682
704
|
config_attr :metadata, nil, ::Hash, nil
|
|
683
705
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
684
706
|
config_attr :quota_project, nil, ::String, nil
|
|
707
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
685
708
|
|
|
686
709
|
# @private
|
|
687
710
|
def initialize parent_config = nil
|
|
@@ -702,6 +725,14 @@ module Google
|
|
|
702
725
|
end
|
|
703
726
|
end
|
|
704
727
|
|
|
728
|
+
##
|
|
729
|
+
# Configuration for the channel pool
|
|
730
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
|
731
|
+
#
|
|
732
|
+
def channel_pool
|
|
733
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
|
734
|
+
end
|
|
735
|
+
|
|
705
736
|
##
|
|
706
737
|
# Configuration RPC class for the Operations API.
|
|
707
738
|
#
|
|
@@ -79,6 +79,9 @@ module Google
|
|
|
79
79
|
# service google.longrunning.Operations.
|
|
80
80
|
#
|
|
81
81
|
class Client
|
|
82
|
+
# @private
|
|
83
|
+
DEFAULT_ENDPOINT_TEMPLATE = "datastore.$UNIVERSE_DOMAIN$"
|
|
84
|
+
|
|
82
85
|
# @private
|
|
83
86
|
attr_reader :datastore_admin_stub
|
|
84
87
|
|
|
@@ -155,6 +158,15 @@ module Google
|
|
|
155
158
|
@config
|
|
156
159
|
end
|
|
157
160
|
|
|
161
|
+
##
|
|
162
|
+
# The effective universe domain
|
|
163
|
+
#
|
|
164
|
+
# @return [String]
|
|
165
|
+
#
|
|
166
|
+
def universe_domain
|
|
167
|
+
@datastore_admin_stub.universe_domain
|
|
168
|
+
end
|
|
169
|
+
|
|
158
170
|
##
|
|
159
171
|
# Create a new DatastoreAdmin REST client object.
|
|
160
172
|
#
|
|
@@ -182,8 +194,9 @@ module Google
|
|
|
182
194
|
credentials = @config.credentials
|
|
183
195
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
184
196
|
# but only if the default endpoint does not have a region prefix.
|
|
185
|
-
enable_self_signed_jwt = @config.endpoint
|
|
186
|
-
|
|
197
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
198
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
199
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
187
200
|
credentials ||= Credentials.default scope: @config.scope,
|
|
188
201
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
189
202
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -197,9 +210,15 @@ module Google
|
|
|
197
210
|
config.credentials = credentials
|
|
198
211
|
config.quota_project = @quota_project_id
|
|
199
212
|
config.endpoint = @config.endpoint
|
|
213
|
+
config.universe_domain = @config.universe_domain
|
|
200
214
|
end
|
|
201
215
|
|
|
202
|
-
@datastore_admin_stub = ::Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Rest::ServiceStub.new
|
|
216
|
+
@datastore_admin_stub = ::Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Rest::ServiceStub.new(
|
|
217
|
+
endpoint: @config.endpoint,
|
|
218
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
219
|
+
universe_domain: @config.universe_domain,
|
|
220
|
+
credentials: credentials
|
|
221
|
+
)
|
|
203
222
|
end
|
|
204
223
|
|
|
205
224
|
##
|
|
@@ -268,6 +287,29 @@ module Google
|
|
|
268
287
|
# @return [::Gapic::Operation]
|
|
269
288
|
#
|
|
270
289
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
290
|
+
#
|
|
291
|
+
# @example Basic example
|
|
292
|
+
# require "google/cloud/datastore/admin/v1"
|
|
293
|
+
#
|
|
294
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
295
|
+
# client = Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Rest::Client.new
|
|
296
|
+
#
|
|
297
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
298
|
+
# request = Google::Cloud::Datastore::Admin::V1::ExportEntitiesRequest.new
|
|
299
|
+
#
|
|
300
|
+
# # Call the export_entities method.
|
|
301
|
+
# result = client.export_entities request
|
|
302
|
+
#
|
|
303
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
|
304
|
+
# # check the status of an operation, cancel it, or wait for results.
|
|
305
|
+
# # Here is how to wait for a response.
|
|
306
|
+
# result.wait_until_done! timeout: 60
|
|
307
|
+
# if result.response?
|
|
308
|
+
# p result.response
|
|
309
|
+
# else
|
|
310
|
+
# puts "No response received."
|
|
311
|
+
# end
|
|
312
|
+
#
|
|
271
313
|
def export_entities request, options = nil
|
|
272
314
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
273
315
|
|
|
@@ -357,6 +399,29 @@ module Google
|
|
|
357
399
|
# @return [::Gapic::Operation]
|
|
358
400
|
#
|
|
359
401
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
402
|
+
#
|
|
403
|
+
# @example Basic example
|
|
404
|
+
# require "google/cloud/datastore/admin/v1"
|
|
405
|
+
#
|
|
406
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
407
|
+
# client = Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Rest::Client.new
|
|
408
|
+
#
|
|
409
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
410
|
+
# request = Google::Cloud::Datastore::Admin::V1::ImportEntitiesRequest.new
|
|
411
|
+
#
|
|
412
|
+
# # Call the import_entities method.
|
|
413
|
+
# result = client.import_entities request
|
|
414
|
+
#
|
|
415
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
|
416
|
+
# # check the status of an operation, cancel it, or wait for results.
|
|
417
|
+
# # Here is how to wait for a response.
|
|
418
|
+
# result.wait_until_done! timeout: 60
|
|
419
|
+
# if result.response?
|
|
420
|
+
# p result.response
|
|
421
|
+
# else
|
|
422
|
+
# puts "No response received."
|
|
423
|
+
# end
|
|
424
|
+
#
|
|
360
425
|
def import_entities request, options = nil
|
|
361
426
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
362
427
|
|
|
@@ -436,6 +501,29 @@ module Google
|
|
|
436
501
|
# @return [::Gapic::Operation]
|
|
437
502
|
#
|
|
438
503
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
504
|
+
#
|
|
505
|
+
# @example Basic example
|
|
506
|
+
# require "google/cloud/datastore/admin/v1"
|
|
507
|
+
#
|
|
508
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
509
|
+
# client = Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Rest::Client.new
|
|
510
|
+
#
|
|
511
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
512
|
+
# request = Google::Cloud::Datastore::Admin::V1::CreateIndexRequest.new
|
|
513
|
+
#
|
|
514
|
+
# # Call the create_index method.
|
|
515
|
+
# result = client.create_index request
|
|
516
|
+
#
|
|
517
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
|
518
|
+
# # check the status of an operation, cancel it, or wait for results.
|
|
519
|
+
# # Here is how to wait for a response.
|
|
520
|
+
# result.wait_until_done! timeout: 60
|
|
521
|
+
# if result.response?
|
|
522
|
+
# p result.response
|
|
523
|
+
# else
|
|
524
|
+
# puts "No response received."
|
|
525
|
+
# end
|
|
526
|
+
#
|
|
439
527
|
def create_index request, options = nil
|
|
440
528
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
441
529
|
|
|
@@ -511,6 +599,29 @@ module Google
|
|
|
511
599
|
# @return [::Gapic::Operation]
|
|
512
600
|
#
|
|
513
601
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
602
|
+
#
|
|
603
|
+
# @example Basic example
|
|
604
|
+
# require "google/cloud/datastore/admin/v1"
|
|
605
|
+
#
|
|
606
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
607
|
+
# client = Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Rest::Client.new
|
|
608
|
+
#
|
|
609
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
610
|
+
# request = Google::Cloud::Datastore::Admin::V1::DeleteIndexRequest.new
|
|
611
|
+
#
|
|
612
|
+
# # Call the delete_index method.
|
|
613
|
+
# result = client.delete_index request
|
|
614
|
+
#
|
|
615
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
|
616
|
+
# # check the status of an operation, cancel it, or wait for results.
|
|
617
|
+
# # Here is how to wait for a response.
|
|
618
|
+
# result.wait_until_done! timeout: 60
|
|
619
|
+
# if result.response?
|
|
620
|
+
# p result.response
|
|
621
|
+
# else
|
|
622
|
+
# puts "No response received."
|
|
623
|
+
# end
|
|
624
|
+
#
|
|
514
625
|
def delete_index request, options = nil
|
|
515
626
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
516
627
|
|
|
@@ -576,6 +687,22 @@ module Google
|
|
|
576
687
|
# @return [::Google::Cloud::Datastore::Admin::V1::Index]
|
|
577
688
|
#
|
|
578
689
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
690
|
+
#
|
|
691
|
+
# @example Basic example
|
|
692
|
+
# require "google/cloud/datastore/admin/v1"
|
|
693
|
+
#
|
|
694
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
695
|
+
# client = Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Rest::Client.new
|
|
696
|
+
#
|
|
697
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
698
|
+
# request = Google::Cloud::Datastore::Admin::V1::GetIndexRequest.new
|
|
699
|
+
#
|
|
700
|
+
# # Call the get_index method.
|
|
701
|
+
# result = client.get_index request
|
|
702
|
+
#
|
|
703
|
+
# # The returned object is of type Google::Cloud::Datastore::Admin::V1::Index.
|
|
704
|
+
# p result
|
|
705
|
+
#
|
|
579
706
|
def get_index request, options = nil
|
|
580
707
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
581
708
|
|
|
@@ -646,6 +773,26 @@ module Google
|
|
|
646
773
|
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Datastore::Admin::V1::Index>]
|
|
647
774
|
#
|
|
648
775
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
776
|
+
#
|
|
777
|
+
# @example Basic example
|
|
778
|
+
# require "google/cloud/datastore/admin/v1"
|
|
779
|
+
#
|
|
780
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
781
|
+
# client = Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Rest::Client.new
|
|
782
|
+
#
|
|
783
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
784
|
+
# request = Google::Cloud::Datastore::Admin::V1::ListIndexesRequest.new
|
|
785
|
+
#
|
|
786
|
+
# # Call the list_indexes method.
|
|
787
|
+
# result = client.list_indexes request
|
|
788
|
+
#
|
|
789
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
|
790
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
|
791
|
+
# result.each do |item|
|
|
792
|
+
# # Each element is of type ::Google::Cloud::Datastore::Admin::V1::Index.
|
|
793
|
+
# p item
|
|
794
|
+
# end
|
|
795
|
+
#
|
|
649
796
|
def list_indexes request, options = nil
|
|
650
797
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
651
798
|
|
|
@@ -712,9 +859,9 @@ module Google
|
|
|
712
859
|
# end
|
|
713
860
|
#
|
|
714
861
|
# @!attribute [rw] endpoint
|
|
715
|
-
#
|
|
716
|
-
#
|
|
717
|
-
# @return [::String]
|
|
862
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
863
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
864
|
+
# @return [::String,nil]
|
|
718
865
|
# @!attribute [rw] credentials
|
|
719
866
|
# Credentials to send with calls. You may provide any of the following types:
|
|
720
867
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -751,13 +898,20 @@ module Google
|
|
|
751
898
|
# @!attribute [rw] quota_project
|
|
752
899
|
# A separate project against which to charge quota.
|
|
753
900
|
# @return [::String]
|
|
901
|
+
# @!attribute [rw] universe_domain
|
|
902
|
+
# The universe domain within which to make requests. This determines the
|
|
903
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
904
|
+
# universe (usually the default "googleapis.com" universe).
|
|
905
|
+
# @return [::String,nil]
|
|
754
906
|
#
|
|
755
907
|
class Configuration
|
|
756
908
|
extend ::Gapic::Config
|
|
757
909
|
|
|
910
|
+
# @private
|
|
911
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
758
912
|
DEFAULT_ENDPOINT = "datastore.googleapis.com"
|
|
759
913
|
|
|
760
|
-
config_attr :endpoint,
|
|
914
|
+
config_attr :endpoint, nil, ::String, nil
|
|
761
915
|
config_attr :credentials, nil do |value|
|
|
762
916
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
763
917
|
allowed.any? { |klass| klass === value }
|
|
@@ -769,6 +923,7 @@ module Google
|
|
|
769
923
|
config_attr :metadata, nil, ::Hash, nil
|
|
770
924
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
771
925
|
config_attr :quota_project, nil, ::String, nil
|
|
926
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
772
927
|
|
|
773
928
|
# @private
|
|
774
929
|
def initialize parent_config = nil
|
|
@@ -27,6 +27,9 @@ module Google
|
|
|
27
27
|
module Rest
|
|
28
28
|
# Service that implements Longrunning Operations API.
|
|
29
29
|
class Operations
|
|
30
|
+
# @private
|
|
31
|
+
DEFAULT_ENDPOINT_TEMPLATE = "datastore.$UNIVERSE_DOMAIN$"
|
|
32
|
+
|
|
30
33
|
# @private
|
|
31
34
|
attr_reader :operations_stub
|
|
32
35
|
|
|
@@ -61,6 +64,15 @@ module Google
|
|
|
61
64
|
@config
|
|
62
65
|
end
|
|
63
66
|
|
|
67
|
+
##
|
|
68
|
+
# The effective universe domain
|
|
69
|
+
#
|
|
70
|
+
# @return [String]
|
|
71
|
+
#
|
|
72
|
+
def universe_domain
|
|
73
|
+
@operations_stub.universe_domain
|
|
74
|
+
end
|
|
75
|
+
|
|
64
76
|
##
|
|
65
77
|
# Create a new Operations client object.
|
|
66
78
|
#
|
|
@@ -85,8 +97,10 @@ module Google
|
|
|
85
97
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
|
86
98
|
|
|
87
99
|
@operations_stub = OperationsServiceStub.new(
|
|
88
|
-
endpoint:
|
|
89
|
-
|
|
100
|
+
endpoint: @config.endpoint,
|
|
101
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
102
|
+
universe_domain: @config.universe_domain,
|
|
103
|
+
credentials: credentials
|
|
90
104
|
)
|
|
91
105
|
|
|
92
106
|
# Used by an LRO wrapper for some methods of this service
|
|
@@ -137,6 +151,26 @@ module Google
|
|
|
137
151
|
# @return [::Gapic::Operation]
|
|
138
152
|
#
|
|
139
153
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
154
|
+
#
|
|
155
|
+
# @example Basic example
|
|
156
|
+
# require "google/longrunning"
|
|
157
|
+
#
|
|
158
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
159
|
+
# client = Google::Longrunning::Operations::Rest::Client.new
|
|
160
|
+
#
|
|
161
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
162
|
+
# request = Google::Longrunning::ListOperationsRequest.new
|
|
163
|
+
#
|
|
164
|
+
# # Call the list_operations method.
|
|
165
|
+
# result = client.list_operations request
|
|
166
|
+
#
|
|
167
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
|
168
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
|
169
|
+
# result.each do |item|
|
|
170
|
+
# # Each element is of type ::Google::Longrunning::Operation.
|
|
171
|
+
# p item
|
|
172
|
+
# end
|
|
173
|
+
#
|
|
140
174
|
def list_operations request, options = nil
|
|
141
175
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
142
176
|
|
|
@@ -202,6 +236,29 @@ module Google
|
|
|
202
236
|
# @return [::Gapic::Operation]
|
|
203
237
|
#
|
|
204
238
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
239
|
+
#
|
|
240
|
+
# @example Basic example
|
|
241
|
+
# require "google/longrunning"
|
|
242
|
+
#
|
|
243
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
244
|
+
# client = Google::Longrunning::Operations::Rest::Client.new
|
|
245
|
+
#
|
|
246
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
247
|
+
# request = Google::Longrunning::GetOperationRequest.new
|
|
248
|
+
#
|
|
249
|
+
# # Call the get_operation method.
|
|
250
|
+
# result = client.get_operation request
|
|
251
|
+
#
|
|
252
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
|
253
|
+
# # check the status of an operation, cancel it, or wait for results.
|
|
254
|
+
# # Here is how to wait for a response.
|
|
255
|
+
# result.wait_until_done! timeout: 60
|
|
256
|
+
# if result.response?
|
|
257
|
+
# p result.response
|
|
258
|
+
# else
|
|
259
|
+
# puts "No response received."
|
|
260
|
+
# end
|
|
261
|
+
#
|
|
205
262
|
def get_operation request, options = nil
|
|
206
263
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
207
264
|
|
|
@@ -268,6 +325,22 @@ module Google
|
|
|
268
325
|
# @return [::Google::Protobuf::Empty]
|
|
269
326
|
#
|
|
270
327
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
328
|
+
#
|
|
329
|
+
# @example Basic example
|
|
330
|
+
# require "google/longrunning"
|
|
331
|
+
#
|
|
332
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
333
|
+
# client = Google::Longrunning::Operations::Rest::Client.new
|
|
334
|
+
#
|
|
335
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
336
|
+
# request = Google::Longrunning::DeleteOperationRequest.new
|
|
337
|
+
#
|
|
338
|
+
# # Call the delete_operation method.
|
|
339
|
+
# result = client.delete_operation request
|
|
340
|
+
#
|
|
341
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
|
342
|
+
# p result
|
|
343
|
+
#
|
|
271
344
|
def delete_operation request, options = nil
|
|
272
345
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
273
346
|
|
|
@@ -339,6 +412,22 @@ module Google
|
|
|
339
412
|
# @return [::Google::Protobuf::Empty]
|
|
340
413
|
#
|
|
341
414
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
415
|
+
#
|
|
416
|
+
# @example Basic example
|
|
417
|
+
# require "google/longrunning"
|
|
418
|
+
#
|
|
419
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
420
|
+
# client = Google::Longrunning::Operations::Rest::Client.new
|
|
421
|
+
#
|
|
422
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
423
|
+
# request = Google::Longrunning::CancelOperationRequest.new
|
|
424
|
+
#
|
|
425
|
+
# # Call the cancel_operation method.
|
|
426
|
+
# result = client.cancel_operation request
|
|
427
|
+
#
|
|
428
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
|
429
|
+
# p result
|
|
430
|
+
#
|
|
342
431
|
def cancel_operation request, options = nil
|
|
343
432
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
344
433
|
|
|
@@ -404,9 +493,9 @@ module Google
|
|
|
404
493
|
# end
|
|
405
494
|
#
|
|
406
495
|
# @!attribute [rw] endpoint
|
|
407
|
-
#
|
|
408
|
-
#
|
|
409
|
-
# @return [::String]
|
|
496
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
497
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
498
|
+
# @return [::String,nil]
|
|
410
499
|
# @!attribute [rw] credentials
|
|
411
500
|
# Credentials to send with calls. You may provide any of the following types:
|
|
412
501
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -443,13 +532,20 @@ module Google
|
|
|
443
532
|
# @!attribute [rw] quota_project
|
|
444
533
|
# A separate project against which to charge quota.
|
|
445
534
|
# @return [::String]
|
|
535
|
+
# @!attribute [rw] universe_domain
|
|
536
|
+
# The universe domain within which to make requests. This determines the
|
|
537
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
538
|
+
# universe (usually the default "googleapis.com" universe).
|
|
539
|
+
# @return [::String,nil]
|
|
446
540
|
#
|
|
447
541
|
class Configuration
|
|
448
542
|
extend ::Gapic::Config
|
|
449
543
|
|
|
544
|
+
# @private
|
|
545
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
450
546
|
DEFAULT_ENDPOINT = "datastore.googleapis.com"
|
|
451
547
|
|
|
452
|
-
config_attr :endpoint,
|
|
548
|
+
config_attr :endpoint, nil, ::String, nil
|
|
453
549
|
config_attr :credentials, nil do |value|
|
|
454
550
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
455
551
|
allowed.any? { |klass| klass === value }
|
|
@@ -461,6 +557,7 @@ module Google
|
|
|
461
557
|
config_attr :metadata, nil, ::Hash, nil
|
|
462
558
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
463
559
|
config_attr :quota_project, nil, ::String, nil
|
|
560
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
464
561
|
|
|
465
562
|
# @private
|
|
466
563
|
def initialize parent_config = nil
|
|
@@ -543,12 +640,15 @@ module Google
|
|
|
543
640
|
# Service stub contains baseline method implementations
|
|
544
641
|
# including transcoding, making the REST call, and deserialing the response.
|
|
545
642
|
class OperationsServiceStub
|
|
546
|
-
def initialize endpoint:, credentials:
|
|
643
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
|
547
644
|
# These require statements are intentionally placed here to initialize
|
|
548
645
|
# the REST modules only when it's required.
|
|
549
646
|
require "gapic/rest"
|
|
550
647
|
|
|
551
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
648
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
649
|
+
endpoint_template: endpoint_template,
|
|
650
|
+
universe_domain: universe_domain,
|
|
651
|
+
credentials: credentials
|
|
552
652
|
end
|
|
553
653
|
|
|
554
654
|
##
|
|
@@ -31,16 +31,28 @@ module Google
|
|
|
31
31
|
# including transcoding, making the REST call, and deserialing the response.
|
|
32
32
|
#
|
|
33
33
|
class ServiceStub
|
|
34
|
-
def initialize endpoint:, credentials:
|
|
34
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
|
35
35
|
# These require statements are intentionally placed here to initialize
|
|
36
36
|
# the REST modules only when it's required.
|
|
37
37
|
require "gapic/rest"
|
|
38
38
|
|
|
39
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
39
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
40
|
+
endpoint_template: endpoint_template,
|
|
41
|
+
universe_domain: universe_domain,
|
|
42
|
+
credentials: credentials,
|
|
40
43
|
numeric_enums: true,
|
|
41
44
|
raise_faraday_errors: false
|
|
42
45
|
end
|
|
43
46
|
|
|
47
|
+
##
|
|
48
|
+
# The effective universe domain
|
|
49
|
+
#
|
|
50
|
+
# @return [String]
|
|
51
|
+
#
|
|
52
|
+
def universe_domain
|
|
53
|
+
@client_stub.universe_domain
|
|
54
|
+
end
|
|
55
|
+
|
|
44
56
|
##
|
|
45
57
|
# Baseline implementation for the export_entities REST call
|
|
46
58
|
#
|
|
@@ -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-datastore-admin-v1
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.11.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
|
|
@@ -219,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
219
219
|
- !ruby/object:Gem::Version
|
|
220
220
|
version: '0'
|
|
221
221
|
requirements: []
|
|
222
|
-
rubygems_version: 3.
|
|
222
|
+
rubygems_version: 3.5.3
|
|
223
223
|
signing_key:
|
|
224
224
|
specification_version: 4
|
|
225
225
|
summary: Accesses the schemaless NoSQL database to provide fully managed, robust,
|