google-cloud-resource_manager-v3 0.6.2 → 0.8.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +72 -101
- data/lib/google/cloud/resource_manager/v3/folders/client.rb +42 -9
- data/lib/google/cloud/resource_manager/v3/folders/operations.rb +38 -7
- data/lib/google/cloud/resource_manager/v3/folders/rest/client.rb +253 -7
- data/lib/google/cloud/resource_manager/v3/folders/rest/operations.rb +108 -8
- data/lib/google/cloud/resource_manager/v3/folders/rest/service_stub.rb +14 -2
- data/lib/google/cloud/resource_manager/v3/organizations/client.rb +41 -9
- data/lib/google/cloud/resource_manager/v3/organizations/rest/client.rb +117 -7
- data/lib/google/cloud/resource_manager/v3/organizations/rest/service_stub.rb +14 -2
- data/lib/google/cloud/resource_manager/v3/projects/client.rb +42 -9
- data/lib/google/cloud/resource_manager/v3/projects/operations.rb +38 -7
- data/lib/google/cloud/resource_manager/v3/projects/rest/client.rb +253 -7
- data/lib/google/cloud/resource_manager/v3/projects/rest/operations.rb +108 -8
- data/lib/google/cloud/resource_manager/v3/projects/rest/service_stub.rb +14 -2
- data/lib/google/cloud/resource_manager/v3/tag_bindings/client.rb +42 -9
- data/lib/google/cloud/resource_manager/v3/tag_bindings/operations.rb +38 -7
- data/lib/google/cloud/resource_manager/v3/tag_bindings/rest/client.rb +120 -7
- data/lib/google/cloud/resource_manager/v3/tag_bindings/rest/operations.rb +108 -8
- data/lib/google/cloud/resource_manager/v3/tag_bindings/rest/service_stub.rb +14 -2
- data/lib/google/cloud/resource_manager/v3/tag_holds/client.rb +42 -9
- data/lib/google/cloud/resource_manager/v3/tag_holds/operations.rb +38 -7
- data/lib/google/cloud/resource_manager/v3/tag_holds/rest/client.rb +100 -7
- data/lib/google/cloud/resource_manager/v3/tag_holds/rest/operations.rb +108 -8
- data/lib/google/cloud/resource_manager/v3/tag_holds/rest/service_stub.rb +14 -2
- data/lib/google/cloud/resource_manager/v3/tag_keys/client.rb +42 -9
- data/lib/google/cloud/resource_manager/v3/tag_keys/operations.rb +38 -7
- data/lib/google/cloud/resource_manager/v3/tag_keys/rest/client.rb +203 -7
- data/lib/google/cloud/resource_manager/v3/tag_keys/rest/operations.rb +108 -8
- data/lib/google/cloud/resource_manager/v3/tag_keys/rest/service_stub.rb +14 -2
- data/lib/google/cloud/resource_manager/v3/tag_values/client.rb +42 -9
- data/lib/google/cloud/resource_manager/v3/tag_values/operations.rb +38 -7
- data/lib/google/cloud/resource_manager/v3/tag_values/rest/client.rb +203 -7
- data/lib/google/cloud/resource_manager/v3/tag_values/rest/operations.rb +108 -8
- data/lib/google/cloud/resource_manager/v3/tag_values/rest/service_stub.rb +14 -2
- data/lib/google/cloud/resource_manager/v3/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
@@ -31,6 +31,9 @@ module Google
|
|
31
31
|
# different Google Cloud resources throughout the GCP resource hierarchy.
|
32
32
|
#
|
33
33
|
class Client
|
34
|
+
# @private
|
35
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudresourcemanager.$UNIVERSE_DOMAIN$"
|
36
|
+
|
34
37
|
include Paths
|
35
38
|
|
36
39
|
# @private
|
@@ -100,6 +103,15 @@ module Google
|
|
100
103
|
@config
|
101
104
|
end
|
102
105
|
|
106
|
+
##
|
107
|
+
# The effective universe domain
|
108
|
+
#
|
109
|
+
# @return [String]
|
110
|
+
#
|
111
|
+
def universe_domain
|
112
|
+
@tag_bindings_stub.universe_domain
|
113
|
+
end
|
114
|
+
|
103
115
|
##
|
104
116
|
# Create a new TagBindings client object.
|
105
117
|
#
|
@@ -133,8 +145,9 @@ module Google
|
|
133
145
|
credentials = @config.credentials
|
134
146
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
135
147
|
# but only if the default endpoint does not have a region prefix.
|
136
|
-
enable_self_signed_jwt = @config.endpoint
|
137
|
-
|
148
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
149
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
150
|
+
!@config.endpoint.split(".").first.include?("-"))
|
138
151
|
credentials ||= Credentials.default scope: @config.scope,
|
139
152
|
enable_self_signed_jwt: enable_self_signed_jwt
|
140
153
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
@@ -147,14 +160,18 @@ module Google
|
|
147
160
|
config.credentials = credentials
|
148
161
|
config.quota_project = @quota_project_id
|
149
162
|
config.endpoint = @config.endpoint
|
163
|
+
config.universe_domain = @config.universe_domain
|
150
164
|
end
|
151
165
|
|
152
166
|
@tag_bindings_stub = ::Gapic::ServiceStub.new(
|
153
167
|
::Google::Cloud::ResourceManager::V3::TagBindings::Stub,
|
154
|
-
credentials:
|
155
|
-
endpoint:
|
168
|
+
credentials: credentials,
|
169
|
+
endpoint: @config.endpoint,
|
170
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
171
|
+
universe_domain: @config.universe_domain,
|
156
172
|
channel_args: @config.channel_args,
|
157
|
-
interceptors: @config.interceptors
|
173
|
+
interceptors: @config.interceptors,
|
174
|
+
channel_pool_config: @config.channel_pool
|
158
175
|
)
|
159
176
|
end
|
160
177
|
|
@@ -567,9 +584,9 @@ module Google
|
|
567
584
|
# end
|
568
585
|
#
|
569
586
|
# @!attribute [rw] endpoint
|
570
|
-
#
|
571
|
-
#
|
572
|
-
# @return [::String]
|
587
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
588
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
589
|
+
# @return [::String,nil]
|
573
590
|
# @!attribute [rw] credentials
|
574
591
|
# Credentials to send with calls. You may provide any of the following types:
|
575
592
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -615,13 +632,20 @@ module Google
|
|
615
632
|
# @!attribute [rw] quota_project
|
616
633
|
# A separate project against which to charge quota.
|
617
634
|
# @return [::String]
|
635
|
+
# @!attribute [rw] universe_domain
|
636
|
+
# The universe domain within which to make requests. This determines the
|
637
|
+
# default endpoint URL. The default value of nil uses the environment
|
638
|
+
# universe (usually the default "googleapis.com" universe).
|
639
|
+
# @return [::String,nil]
|
618
640
|
#
|
619
641
|
class Configuration
|
620
642
|
extend ::Gapic::Config
|
621
643
|
|
644
|
+
# @private
|
645
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
622
646
|
DEFAULT_ENDPOINT = "cloudresourcemanager.googleapis.com"
|
623
647
|
|
624
|
-
config_attr :endpoint,
|
648
|
+
config_attr :endpoint, nil, ::String, nil
|
625
649
|
config_attr :credentials, nil do |value|
|
626
650
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
627
651
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
@@ -636,6 +660,7 @@ module Google
|
|
636
660
|
config_attr :metadata, nil, ::Hash, nil
|
637
661
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
638
662
|
config_attr :quota_project, nil, ::String, nil
|
663
|
+
config_attr :universe_domain, nil, ::String, nil
|
639
664
|
|
640
665
|
# @private
|
641
666
|
def initialize parent_config = nil
|
@@ -656,6 +681,14 @@ module Google
|
|
656
681
|
end
|
657
682
|
end
|
658
683
|
|
684
|
+
##
|
685
|
+
# Configuration for the channel pool
|
686
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
687
|
+
#
|
688
|
+
def channel_pool
|
689
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
690
|
+
end
|
691
|
+
|
659
692
|
##
|
660
693
|
# Configuration RPC class for the TagBindings API.
|
661
694
|
#
|
@@ -26,6 +26,9 @@ module Google
|
|
26
26
|
module TagBindings
|
27
27
|
# Service that implements Longrunning Operations API.
|
28
28
|
class Operations
|
29
|
+
# @private
|
30
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudresourcemanager.$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 = "cloudresourcemanager.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
|
#
|
@@ -33,6 +33,9 @@ module Google
|
|
33
33
|
# different Google Cloud resources throughout the GCP resource hierarchy.
|
34
34
|
#
|
35
35
|
class Client
|
36
|
+
# @private
|
37
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudresourcemanager.$UNIVERSE_DOMAIN$"
|
38
|
+
|
36
39
|
include Paths
|
37
40
|
|
38
41
|
# @private
|
@@ -102,6 +105,15 @@ module Google
|
|
102
105
|
@config
|
103
106
|
end
|
104
107
|
|
108
|
+
##
|
109
|
+
# The effective universe domain
|
110
|
+
#
|
111
|
+
# @return [String]
|
112
|
+
#
|
113
|
+
def universe_domain
|
114
|
+
@tag_bindings_stub.universe_domain
|
115
|
+
end
|
116
|
+
|
105
117
|
##
|
106
118
|
# Create a new TagBindings REST client object.
|
107
119
|
#
|
@@ -129,8 +141,9 @@ module Google
|
|
129
141
|
credentials = @config.credentials
|
130
142
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
131
143
|
# but only if the default endpoint does not have a region prefix.
|
132
|
-
enable_self_signed_jwt = @config.endpoint
|
133
|
-
|
144
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
145
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
146
|
+
!@config.endpoint.split(".").first.include?("-"))
|
134
147
|
credentials ||= Credentials.default scope: @config.scope,
|
135
148
|
enable_self_signed_jwt: enable_self_signed_jwt
|
136
149
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
@@ -144,9 +157,15 @@ 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
|
-
@tag_bindings_stub = ::Google::Cloud::ResourceManager::V3::TagBindings::Rest::ServiceStub.new
|
163
|
+
@tag_bindings_stub = ::Google::Cloud::ResourceManager::V3::TagBindings::Rest::ServiceStub.new(
|
164
|
+
endpoint: @config.endpoint,
|
165
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
166
|
+
universe_domain: @config.universe_domain,
|
167
|
+
credentials: credentials
|
168
|
+
)
|
150
169
|
end
|
151
170
|
|
152
171
|
##
|
@@ -198,6 +217,26 @@ module Google
|
|
198
217
|
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::ResourceManager::V3::TagBinding>]
|
199
218
|
#
|
200
219
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
220
|
+
#
|
221
|
+
# @example Basic example
|
222
|
+
# require "google/cloud/resource_manager/v3"
|
223
|
+
#
|
224
|
+
# # Create a client object. The client can be reused for multiple calls.
|
225
|
+
# client = Google::Cloud::ResourceManager::V3::TagBindings::Rest::Client.new
|
226
|
+
#
|
227
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
228
|
+
# request = Google::Cloud::ResourceManager::V3::ListTagBindingsRequest.new
|
229
|
+
#
|
230
|
+
# # Call the list_tag_bindings method.
|
231
|
+
# result = client.list_tag_bindings request
|
232
|
+
#
|
233
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
234
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
235
|
+
# result.each do |item|
|
236
|
+
# # Each element is of type ::Google::Cloud::ResourceManager::V3::TagBinding.
|
237
|
+
# p item
|
238
|
+
# end
|
239
|
+
#
|
201
240
|
def list_tag_bindings request, options = nil
|
202
241
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
203
242
|
|
@@ -264,6 +303,29 @@ module Google
|
|
264
303
|
# @return [::Gapic::Operation]
|
265
304
|
#
|
266
305
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
306
|
+
#
|
307
|
+
# @example Basic example
|
308
|
+
# require "google/cloud/resource_manager/v3"
|
309
|
+
#
|
310
|
+
# # Create a client object. The client can be reused for multiple calls.
|
311
|
+
# client = Google::Cloud::ResourceManager::V3::TagBindings::Rest::Client.new
|
312
|
+
#
|
313
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
314
|
+
# request = Google::Cloud::ResourceManager::V3::CreateTagBindingRequest.new
|
315
|
+
#
|
316
|
+
# # Call the create_tag_binding method.
|
317
|
+
# result = client.create_tag_binding request
|
318
|
+
#
|
319
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
320
|
+
# # check the status of an operation, cancel it, or wait for results.
|
321
|
+
# # Here is how to wait for a response.
|
322
|
+
# result.wait_until_done! timeout: 60
|
323
|
+
# if result.response?
|
324
|
+
# p result.response
|
325
|
+
# else
|
326
|
+
# puts "No response received."
|
327
|
+
# end
|
328
|
+
#
|
267
329
|
def create_tag_binding request, options = nil
|
268
330
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
269
331
|
|
@@ -329,6 +391,29 @@ module Google
|
|
329
391
|
# @return [::Gapic::Operation]
|
330
392
|
#
|
331
393
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
394
|
+
#
|
395
|
+
# @example Basic example
|
396
|
+
# require "google/cloud/resource_manager/v3"
|
397
|
+
#
|
398
|
+
# # Create a client object. The client can be reused for multiple calls.
|
399
|
+
# client = Google::Cloud::ResourceManager::V3::TagBindings::Rest::Client.new
|
400
|
+
#
|
401
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
402
|
+
# request = Google::Cloud::ResourceManager::V3::DeleteTagBindingRequest.new
|
403
|
+
#
|
404
|
+
# # Call the delete_tag_binding method.
|
405
|
+
# result = client.delete_tag_binding request
|
406
|
+
#
|
407
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
408
|
+
# # check the status of an operation, cancel it, or wait for results.
|
409
|
+
# # Here is how to wait for a response.
|
410
|
+
# result.wait_until_done! timeout: 60
|
411
|
+
# if result.response?
|
412
|
+
# p result.response
|
413
|
+
# else
|
414
|
+
# puts "No response received."
|
415
|
+
# end
|
416
|
+
#
|
332
417
|
def delete_tag_binding request, options = nil
|
333
418
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
334
419
|
|
@@ -402,6 +487,26 @@ module Google
|
|
402
487
|
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::ResourceManager::V3::EffectiveTag>]
|
403
488
|
#
|
404
489
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
490
|
+
#
|
491
|
+
# @example Basic example
|
492
|
+
# require "google/cloud/resource_manager/v3"
|
493
|
+
#
|
494
|
+
# # Create a client object. The client can be reused for multiple calls.
|
495
|
+
# client = Google::Cloud::ResourceManager::V3::TagBindings::Rest::Client.new
|
496
|
+
#
|
497
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
498
|
+
# request = Google::Cloud::ResourceManager::V3::ListEffectiveTagsRequest.new
|
499
|
+
#
|
500
|
+
# # Call the list_effective_tags method.
|
501
|
+
# result = client.list_effective_tags request
|
502
|
+
#
|
503
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
504
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
505
|
+
# result.each do |item|
|
506
|
+
# # Each element is of type ::Google::Cloud::ResourceManager::V3::EffectiveTag.
|
507
|
+
# p item
|
508
|
+
# end
|
509
|
+
#
|
405
510
|
def list_effective_tags request, options = nil
|
406
511
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
407
512
|
|
@@ -468,9 +573,9 @@ module Google
|
|
468
573
|
# end
|
469
574
|
#
|
470
575
|
# @!attribute [rw] endpoint
|
471
|
-
#
|
472
|
-
#
|
473
|
-
# @return [::String]
|
576
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
577
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
578
|
+
# @return [::String,nil]
|
474
579
|
# @!attribute [rw] credentials
|
475
580
|
# Credentials to send with calls. You may provide any of the following types:
|
476
581
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -507,13 +612,20 @@ module Google
|
|
507
612
|
# @!attribute [rw] quota_project
|
508
613
|
# A separate project against which to charge quota.
|
509
614
|
# @return [::String]
|
615
|
+
# @!attribute [rw] universe_domain
|
616
|
+
# The universe domain within which to make requests. This determines the
|
617
|
+
# default endpoint URL. The default value of nil uses the environment
|
618
|
+
# universe (usually the default "googleapis.com" universe).
|
619
|
+
# @return [::String,nil]
|
510
620
|
#
|
511
621
|
class Configuration
|
512
622
|
extend ::Gapic::Config
|
513
623
|
|
624
|
+
# @private
|
625
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
514
626
|
DEFAULT_ENDPOINT = "cloudresourcemanager.googleapis.com"
|
515
627
|
|
516
|
-
config_attr :endpoint,
|
628
|
+
config_attr :endpoint, nil, ::String, nil
|
517
629
|
config_attr :credentials, nil do |value|
|
518
630
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
519
631
|
allowed.any? { |klass| klass === value }
|
@@ -525,6 +637,7 @@ module Google
|
|
525
637
|
config_attr :metadata, nil, ::Hash, nil
|
526
638
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
527
639
|
config_attr :quota_project, nil, ::String, nil
|
640
|
+
config_attr :universe_domain, nil, ::String, nil
|
528
641
|
|
529
642
|
# @private
|
530
643
|
def initialize parent_config = nil
|
@@ -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 = "cloudresourcemanager.$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 = "cloudresourcemanager.googleapis.com"
|
450
546
|
|
451
|
-
config_attr :endpoint,
|
547
|
+
config_attr :endpoint, nil, ::String, nil
|
452
548
|
config_attr :credentials, nil do |value|
|
453
549
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
454
550
|
allowed.any? { |klass| klass === value }
|
@@ -460,6 +556,7 @@ module Google
|
|
460
556
|
config_attr :metadata, nil, ::Hash, nil
|
461
557
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
462
558
|
config_attr :quota_project, nil, ::String, nil
|
559
|
+
config_attr :universe_domain, nil, ::String, nil
|
463
560
|
|
464
561
|
# @private
|
465
562
|
def initialize parent_config = nil
|
@@ -542,12 +639,15 @@ module Google
|
|
542
639
|
# Service stub contains baseline method implementations
|
543
640
|
# including transcoding, making the REST call, and deserialing the response.
|
544
641
|
class OperationsServiceStub
|
545
|
-
def initialize endpoint:, credentials:
|
642
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
546
643
|
# These require statements are intentionally placed here to initialize
|
547
644
|
# the REST modules only when it's required.
|
548
645
|
require "gapic/rest"
|
549
646
|
|
550
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
647
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
648
|
+
endpoint_template: endpoint_template,
|
649
|
+
universe_domain: universe_domain,
|
650
|
+
credentials: credentials
|
551
651
|
end
|
552
652
|
|
553
653
|
##
|
@@ -30,16 +30,28 @@ module Google
|
|
30
30
|
# including transcoding, making the REST call, and deserialing the response.
|
31
31
|
#
|
32
32
|
class ServiceStub
|
33
|
-
def initialize endpoint:, credentials:
|
33
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
34
34
|
# These require statements are intentionally placed here to initialize
|
35
35
|
# the REST modules only when it's required.
|
36
36
|
require "gapic/rest"
|
37
37
|
|
38
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
38
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
39
|
+
endpoint_template: endpoint_template,
|
40
|
+
universe_domain: universe_domain,
|
41
|
+
credentials: credentials,
|
39
42
|
numeric_enums: true,
|
40
43
|
raise_faraday_errors: false
|
41
44
|
end
|
42
45
|
|
46
|
+
##
|
47
|
+
# The effective universe domain
|
48
|
+
#
|
49
|
+
# @return [String]
|
50
|
+
#
|
51
|
+
def universe_domain
|
52
|
+
@client_stub.universe_domain
|
53
|
+
end
|
54
|
+
|
43
55
|
##
|
44
56
|
# Baseline implementation for the list_tag_bindings REST call
|
45
57
|
#
|