google-cloud-location 0.1.0 → 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.yardopts +1 -1
- data/AUTHENTICATION.md +7 -25
- data/lib/google/cloud/location/locations/client.rb +46 -6
- data/lib/google/cloud/location/locations_pb.rb +2 -1
- data/lib/google/cloud/location/version.rb +1 -1
- data/lib/google/cloud/location.rb +2 -0
- data/proto_docs/google/api/resource.rb +10 -71
- data/proto_docs/google/protobuf/any.rb +3 -3
- metadata +12 -12
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: '0962f8206b145aa8889c014015dcf1051c400c8287c2ed7c42d6a348175cc858'
|
4
|
+
data.tar.gz: b44971705b3afc1ff2873b562d1504b500bde4b8e0816b0f4558c661847335a1
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 510c7182786ba700b46b8295c4aa9040e8b6b00e34aab17c37dc0f0a4c3c50a8593194395744a2e52e921f17086f289d38e8bffc9479a22e37aba975dff348ce
|
7
|
+
data.tar.gz: e864db74c317e78bba110f3f5d536ce60a20c73d22d5beac4d787d28bd27c415d9e5e8ec1dd5413de493db35c83da97bc9414387f9675fcff762a098f5e2be5a
|
data/.yardopts
CHANGED
data/AUTHENTICATION.md
CHANGED
@@ -118,15 +118,6 @@ To configure your system for this, simply:
|
|
118
118
|
**NOTE:** This is _not_ recommended for running in production. The Cloud SDK
|
119
119
|
*should* only be used during development.
|
120
120
|
|
121
|
-
[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
|
122
|
-
[dev-console]: https://console.cloud.google.com/project
|
123
|
-
|
124
|
-
[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
|
125
|
-
|
126
|
-
[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
|
127
|
-
[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
|
128
|
-
[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
|
129
|
-
|
130
121
|
## Creating a Service Account
|
131
122
|
|
132
123
|
Google Cloud requires **Service Account Credentials** to
|
@@ -137,31 +128,22 @@ If you are not running this client within
|
|
137
128
|
[Google Cloud Platform environments](#google-cloud-platform-environments), you
|
138
129
|
need a Google Developers service account.
|
139
130
|
|
140
|
-
1. Visit the [Google
|
131
|
+
1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
|
141
132
|
2. Create a new project or click on an existing project.
|
142
|
-
3. Activate the
|
133
|
+
3. Activate the menu in the upper left and select **APIs & Services**. From
|
143
134
|
here, you will enable the APIs that your application requires.
|
144
135
|
|
145
|
-
![Enable the APIs that your application requires][enable-apis]
|
146
|
-
|
147
136
|
*Note: You may need to enable billing in order to use these services.*
|
148
137
|
|
149
138
|
4. Select **Credentials** from the side navigation.
|
150
139
|
|
151
|
-
|
152
|
-
|
153
|
-
![Create a new service account][create-new-service-account]
|
154
|
-
|
155
|
-
![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
|
156
|
-
|
157
|
-
Find the "Add credentials" drop down and select "Service account" to be
|
158
|
-
guided through downloading a new JSON key file.
|
140
|
+
Find the "Create credentials" drop down near the top of the page, and select
|
141
|
+
"Service account" to be guided through downloading a new JSON key file.
|
159
142
|
|
160
143
|
If you want to re-use an existing service account, you can easily generate a
|
161
|
-
new key file. Just select the account you wish to re-use,
|
162
|
-
|
163
|
-
|
164
|
-
![Re-use an existing service account][reuse-service-account]
|
144
|
+
new key file. Just select the account you wish to re-use, click the pencil
|
145
|
+
tool on the right side to edit the service account, select the **Keys** tab,
|
146
|
+
and then select **Add Key**.
|
165
147
|
|
166
148
|
The key file you download will be used by this library to authenticate API
|
167
149
|
requests and should be stored in a secure location.
|
@@ -178,6 +178,27 @@ module Google
|
|
178
178
|
#
|
179
179
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
180
180
|
#
|
181
|
+
# @example Basic example
|
182
|
+
# require "google/cloud/location"
|
183
|
+
#
|
184
|
+
# # Create a client object. The client can be reused for multiple calls.
|
185
|
+
# client = Google::Cloud::Location::Locations::Client.new
|
186
|
+
#
|
187
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
188
|
+
# request = Google::Cloud::Location::ListLocationsRequest.new
|
189
|
+
#
|
190
|
+
# # Call the list_locations method.
|
191
|
+
# result = client.list_locations request
|
192
|
+
#
|
193
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can
|
194
|
+
# # iterate over all elements by calling #each, and the enumerable
|
195
|
+
# # will lazily make API calls to fetch subsequent pages. Other
|
196
|
+
# # methods are also available for managing paging directly.
|
197
|
+
# result.each do |response|
|
198
|
+
# # Each element is of type ::Google::Cloud::Location::Location.
|
199
|
+
# p response
|
200
|
+
# end
|
201
|
+
#
|
181
202
|
def list_locations request, options = nil
|
182
203
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
183
204
|
|
@@ -195,9 +216,11 @@ module Google
|
|
195
216
|
gapic_version: ::Google::Cloud::Location::VERSION
|
196
217
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
197
218
|
|
198
|
-
header_params = {
|
199
|
-
|
200
|
-
|
219
|
+
header_params = {}
|
220
|
+
if request.name
|
221
|
+
header_params["name"] = request.name
|
222
|
+
end
|
223
|
+
|
201
224
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
202
225
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
203
226
|
|
@@ -247,6 +270,21 @@ module Google
|
|
247
270
|
#
|
248
271
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
249
272
|
#
|
273
|
+
# @example Basic example
|
274
|
+
# require "google/cloud/location"
|
275
|
+
#
|
276
|
+
# # Create a client object. The client can be reused for multiple calls.
|
277
|
+
# client = Google::Cloud::Location::Locations::Client.new
|
278
|
+
#
|
279
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
280
|
+
# request = Google::Cloud::Location::GetLocationRequest.new
|
281
|
+
#
|
282
|
+
# # Call the get_location method.
|
283
|
+
# result = client.get_location request
|
284
|
+
#
|
285
|
+
# # The returned object is of type Google::Cloud::Location::Location.
|
286
|
+
# p result
|
287
|
+
#
|
250
288
|
def get_location request, options = nil
|
251
289
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
252
290
|
|
@@ -264,9 +302,11 @@ module Google
|
|
264
302
|
gapic_version: ::Google::Cloud::Location::VERSION
|
265
303
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
266
304
|
|
267
|
-
header_params = {
|
268
|
-
|
269
|
-
|
305
|
+
header_params = {}
|
306
|
+
if request.name
|
307
|
+
header_params["name"] = request.name
|
308
|
+
end
|
309
|
+
|
270
310
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
271
311
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
272
312
|
|
@@ -1,10 +1,11 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/cloud/location/locations.proto
|
3
3
|
|
4
|
+
require 'google/protobuf'
|
5
|
+
|
4
6
|
require 'google/api/annotations_pb'
|
5
7
|
require 'google/protobuf/any_pb'
|
6
8
|
require 'google/api/client_pb'
|
7
|
-
require 'google/protobuf'
|
8
9
|
|
9
10
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
10
11
|
add_file("google/cloud/location/locations.proto", :syntax => :proto3) do
|
@@ -33,11 +33,7 @@ module Google
|
|
33
33
|
# // For Kubernetes resources, the format is {api group}/{kind}.
|
34
34
|
# option (google.api.resource) = {
|
35
35
|
# type: "pubsub.googleapis.com/Topic"
|
36
|
-
#
|
37
|
-
# pattern: "projects/{project}/topics/{topic}"
|
38
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
39
|
-
# parent_name_extractor: "projects/{project}"
|
40
|
-
# }
|
36
|
+
# pattern: "projects/{project}/topics/{topic}"
|
41
37
|
# };
|
42
38
|
# }
|
43
39
|
#
|
@@ -45,10 +41,7 @@ module Google
|
|
45
41
|
#
|
46
42
|
# resources:
|
47
43
|
# - type: "pubsub.googleapis.com/Topic"
|
48
|
-
#
|
49
|
-
# - pattern: "projects/{project}/topics/{topic}"
|
50
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
51
|
-
# parent_name_extractor: "projects/{project}"
|
44
|
+
# pattern: "projects/{project}/topics/{topic}"
|
52
45
|
#
|
53
46
|
# Sometimes, resources have multiple patterns, typically because they can
|
54
47
|
# live under multiple parents.
|
@@ -58,26 +51,10 @@ module Google
|
|
58
51
|
# message LogEntry {
|
59
52
|
# option (google.api.resource) = {
|
60
53
|
# type: "logging.googleapis.com/LogEntry"
|
61
|
-
#
|
62
|
-
#
|
63
|
-
#
|
64
|
-
#
|
65
|
-
# }
|
66
|
-
# name_descriptor: {
|
67
|
-
# pattern: "folders/{folder}/logs/{log}"
|
68
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
69
|
-
# parent_name_extractor: "folders/{folder}"
|
70
|
-
# }
|
71
|
-
# name_descriptor: {
|
72
|
-
# pattern: "organizations/{organization}/logs/{log}"
|
73
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Organization"
|
74
|
-
# parent_name_extractor: "organizations/{organization}"
|
75
|
-
# }
|
76
|
-
# name_descriptor: {
|
77
|
-
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
78
|
-
# parent_type: "billing.googleapis.com/BillingAccount"
|
79
|
-
# parent_name_extractor: "billingAccounts/{billing_account}"
|
80
|
-
# }
|
54
|
+
# pattern: "projects/{project}/logs/{log}"
|
55
|
+
# pattern: "folders/{folder}/logs/{log}"
|
56
|
+
# pattern: "organizations/{organization}/logs/{log}"
|
57
|
+
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
81
58
|
# };
|
82
59
|
# }
|
83
60
|
#
|
@@ -85,48 +62,10 @@ module Google
|
|
85
62
|
#
|
86
63
|
# resources:
|
87
64
|
# - type: 'logging.googleapis.com/LogEntry'
|
88
|
-
#
|
89
|
-
#
|
90
|
-
#
|
91
|
-
#
|
92
|
-
# - pattern: "folders/{folder}/logs/{log}"
|
93
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
94
|
-
# parent_name_extractor: "folders/{folder}"
|
95
|
-
# - pattern: "organizations/{organization}/logs/{log}"
|
96
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Organization"
|
97
|
-
# parent_name_extractor: "organizations/{organization}"
|
98
|
-
# - pattern: "billingAccounts/{billing_account}/logs/{log}"
|
99
|
-
# parent_type: "billing.googleapis.com/BillingAccount"
|
100
|
-
# parent_name_extractor: "billingAccounts/{billing_account}"
|
101
|
-
#
|
102
|
-
# For flexible resources, the resource name doesn't contain parent names, but
|
103
|
-
# the resource itself has parents for policy evaluation.
|
104
|
-
#
|
105
|
-
# Example:
|
106
|
-
#
|
107
|
-
# message Shelf {
|
108
|
-
# option (google.api.resource) = {
|
109
|
-
# type: "library.googleapis.com/Shelf"
|
110
|
-
# name_descriptor: {
|
111
|
-
# pattern: "shelves/{shelf}"
|
112
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
113
|
-
# }
|
114
|
-
# name_descriptor: {
|
115
|
-
# pattern: "shelves/{shelf}"
|
116
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
117
|
-
# }
|
118
|
-
# };
|
119
|
-
# }
|
120
|
-
#
|
121
|
-
# The ResourceDescriptor Yaml config will look like:
|
122
|
-
#
|
123
|
-
# resources:
|
124
|
-
# - type: 'library.googleapis.com/Shelf'
|
125
|
-
# name_descriptor:
|
126
|
-
# - pattern: "shelves/{shelf}"
|
127
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
128
|
-
# - pattern: "shelves/{shelf}"
|
129
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
65
|
+
# pattern: "projects/{project}/logs/{log}"
|
66
|
+
# pattern: "folders/{folder}/logs/{log}"
|
67
|
+
# pattern: "organizations/{organization}/logs/{log}"
|
68
|
+
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
130
69
|
# @!attribute [rw] type
|
131
70
|
# @return [::String]
|
132
71
|
# The resource type. It must be in the format of
|
@@ -44,7 +44,7 @@ module Google
|
|
44
44
|
# foo = any.unpack(Foo.class);
|
45
45
|
# }
|
46
46
|
#
|
47
|
-
#
|
47
|
+
# Example 3: Pack and unpack a message in Python.
|
48
48
|
#
|
49
49
|
# foo = Foo(...)
|
50
50
|
# any = Any()
|
@@ -54,7 +54,7 @@ module Google
|
|
54
54
|
# any.Unpack(foo)
|
55
55
|
# ...
|
56
56
|
#
|
57
|
-
#
|
57
|
+
# Example 4: Pack and unpack a message in Go
|
58
58
|
#
|
59
59
|
# foo := &pb.Foo{...}
|
60
60
|
# any, err := anypb.New(foo)
|
@@ -75,7 +75,7 @@ module Google
|
|
75
75
|
#
|
76
76
|
#
|
77
77
|
# JSON
|
78
|
-
#
|
78
|
+
#
|
79
79
|
# The JSON representation of an `Any` value uses the regular
|
80
80
|
# representation of the deserialized, embedded message, with an
|
81
81
|
# additional field `@type` which contains the type URL. Example:
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-location
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.2.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: 2022-07-04 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.10'
|
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.10'
|
30
30
|
- - "<"
|
31
31
|
- !ruby/object:Gem::Version
|
32
32
|
version: 2.a
|
@@ -50,28 +50,28 @@ dependencies:
|
|
50
50
|
requirements:
|
51
51
|
- - "~>"
|
52
52
|
- !ruby/object:Gem::Version
|
53
|
-
version: 1.
|
53
|
+
version: 1.26.1
|
54
54
|
type: :development
|
55
55
|
prerelease: false
|
56
56
|
version_requirements: !ruby/object:Gem::Requirement
|
57
57
|
requirements:
|
58
58
|
- - "~>"
|
59
59
|
- !ruby/object:Gem::Version
|
60
|
-
version: 1.
|
60
|
+
version: 1.26.1
|
61
61
|
- !ruby/object:Gem::Dependency
|
62
62
|
name: minitest
|
63
63
|
requirement: !ruby/object:Gem::Requirement
|
64
64
|
requirements:
|
65
65
|
- - "~>"
|
66
66
|
- !ruby/object:Gem::Version
|
67
|
-
version: '5.
|
67
|
+
version: '5.16'
|
68
68
|
type: :development
|
69
69
|
prerelease: false
|
70
70
|
version_requirements: !ruby/object:Gem::Requirement
|
71
71
|
requirements:
|
72
72
|
- - "~>"
|
73
73
|
- !ruby/object:Gem::Version
|
74
|
-
version: '5.
|
74
|
+
version: '5.16'
|
75
75
|
- !ruby/object:Gem::Dependency
|
76
76
|
name: minitest-focus
|
77
77
|
requirement: !ruby/object:Gem::Requirement
|
@@ -106,14 +106,14 @@ dependencies:
|
|
106
106
|
requirements:
|
107
107
|
- - ">="
|
108
108
|
- !ruby/object:Gem::Version
|
109
|
-
version: '
|
109
|
+
version: '13.0'
|
110
110
|
type: :development
|
111
111
|
prerelease: false
|
112
112
|
version_requirements: !ruby/object:Gem::Requirement
|
113
113
|
requirements:
|
114
114
|
- - ">="
|
115
115
|
- !ruby/object:Gem::Version
|
116
|
-
version: '
|
116
|
+
version: '13.0'
|
117
117
|
- !ruby/object:Gem::Dependency
|
118
118
|
name: redcarpet
|
119
119
|
requirement: !ruby/object:Gem::Requirement
|
@@ -191,14 +191,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
191
191
|
requirements:
|
192
192
|
- - ">="
|
193
193
|
- !ruby/object:Gem::Version
|
194
|
-
version: '2.
|
194
|
+
version: '2.6'
|
195
195
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
196
196
|
requirements:
|
197
197
|
- - ">="
|
198
198
|
- !ruby/object:Gem::Version
|
199
199
|
version: '0'
|
200
200
|
requirements: []
|
201
|
-
rubygems_version: 3.
|
201
|
+
rubygems_version: 3.3.14
|
202
202
|
signing_key:
|
203
203
|
specification_version: 4
|
204
204
|
summary: API Client library for the Locations API
|