Class: Google::Cloud::Compute::V1::PublicAdvertisedPrefixes::Rest::Client
- Inherits:
-
Object
- Object
- Google::Cloud::Compute::V1::PublicAdvertisedPrefixes::Rest::Client
- Defined in:
- lib/google/cloud/compute/v1/public_advertised_prefixes/rest/client.rb
Overview
REST client for the PublicAdvertisedPrefixes service.
The PublicAdvertisedPrefixes API.
Defined Under Namespace
Classes: Configuration
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the PublicAdvertisedPrefixes Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the PublicAdvertisedPrefixes Client instance.
-
#delete(request, options = nil) {|result, response| ... } ⇒ ::Gapic::Rest::BaseOperation
Deletes the specified PublicAdvertisedPrefix.
-
#get(request, options = nil) {|result, response| ... } ⇒ ::Google::Cloud::Compute::V1::PublicAdvertisedPrefix
Returns the specified PublicAdvertisedPrefix resource.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new PublicAdvertisedPrefixes REST client object.
-
#insert(request, options = nil) {|result, response| ... } ⇒ ::Gapic::Rest::BaseOperation
Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.
-
#list(request, options = nil) {|result, response| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::PublicAdvertisedPrefix>
Lists the PublicAdvertisedPrefixes for a project.
-
#patch(request, options = nil) {|result, response| ... } ⇒ ::Gapic::Rest::BaseOperation
Patches the specified Router resource with the data included in the request.
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new PublicAdvertisedPrefixes REST client object.
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/google/cloud/compute/v1/public_advertised_prefixes/rest/client.rb', line 125 def initialize # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials credentials ||= Credentials.default scope: @config.scope if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @public_advertised_prefixes_stub = ::Google::Cloud::Compute::V1::PublicAdvertisedPrefixes::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the PublicAdvertisedPrefixes Client class.
See Configuration for a description of the configuration fields.
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
# File 'lib/google/cloud/compute/v1/public_advertised_prefixes/rest/client.rb', line 56 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Compute", "V1"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.rpcs.delete.timeout = 600.0 default_config.rpcs.get.timeout = 600.0 default_config.rpcs.get.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.insert.timeout = 600.0 default_config.rpcs.list.timeout = 600.0 default_config.rpcs.list.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.patch.timeout = 600.0 default_config end yield @configure if block_given? @configure end |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
Configure the PublicAdvertisedPrefixes Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.
See Configuration for a description of the configuration fields.
104 105 106 107 |
# File 'lib/google/cloud/compute/v1/public_advertised_prefixes/rest/client.rb', line 104 def configure yield @config if block_given? @config end |
#delete(request, options = nil) ⇒ ::Gapic::Rest::BaseOperation #delete(project: nil, public_advertised_prefix: nil, request_id: nil) ⇒ ::Gapic::Rest::BaseOperation
Deletes the specified PublicAdvertisedPrefix
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 |
# File 'lib/google/cloud/compute/v1/public_advertised_prefixes/rest/client.rb', line 177 def delete request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::DeletePublicAdvertisedPrefixeRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.delete..to_h # Set x-goog-api-client header [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] .apply_defaults timeout: @config.rpcs.delete.timeout, metadata: .apply_defaults timeout: @config.timeout, metadata: @config. @public_advertised_prefixes_stub.delete request, do |result, response| result = ::Gapic::Rest::BaseOperation.new result yield result, response if block_given? return result end rescue ::Faraday::Error => e gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e raise ::Google::Cloud::Error.from_error(gapic_error) end |
#get(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::PublicAdvertisedPrefix #get(project: nil, public_advertised_prefix: nil) ⇒ ::Google::Cloud::Compute::V1::PublicAdvertisedPrefix
Returns the specified PublicAdvertisedPrefix resource.
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 |
# File 'lib/google/cloud/compute/v1/public_advertised_prefixes/rest/client.rb', line 241 def get request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::GetPublicAdvertisedPrefixeRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get..to_h # Set x-goog-api-client header [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] .apply_defaults timeout: @config.rpcs.get.timeout, metadata: .apply_defaults timeout: @config.timeout, metadata: @config. @public_advertised_prefixes_stub.get request, do |result, response| yield result, response if block_given? return result end rescue ::Faraday::Error => e gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e raise ::Google::Cloud::Error.from_error(gapic_error) end |
#insert(request, options = nil) ⇒ ::Gapic::Rest::BaseOperation #insert(project: nil, public_advertised_prefix_resource: nil, request_id: nil) ⇒ ::Gapic::Rest::BaseOperation
Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 |
# File 'lib/google/cloud/compute/v1/public_advertised_prefixes/rest/client.rb', line 306 def insert request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::InsertPublicAdvertisedPrefixeRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.insert..to_h # Set x-goog-api-client header [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] .apply_defaults timeout: @config.rpcs.insert.timeout, metadata: .apply_defaults timeout: @config.timeout, metadata: @config. @public_advertised_prefixes_stub.insert request, do |result, response| result = ::Gapic::Rest::BaseOperation.new result yield result, response if block_given? return result end rescue ::Faraday::Error => e gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e raise ::Google::Cloud::Error.from_error(gapic_error) end |
#list(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::PublicAdvertisedPrefix> #list(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::PublicAdvertisedPrefix>
Lists the PublicAdvertisedPrefixes for a project.
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 |
# File 'lib/google/cloud/compute/v1/public_advertised_prefixes/rest/client.rb', line 378 def list request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::ListPublicAdvertisedPrefixesRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.list..to_h # Set x-goog-api-client header [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] .apply_defaults timeout: @config.rpcs.list.timeout, metadata: .apply_defaults timeout: @config.timeout, metadata: @config. @public_advertised_prefixes_stub.list request, do |result, response| result = ::Gapic::Rest::PagedEnumerable.new @public_advertised_prefixes_stub, :list, "items", request, result, yield result, response if block_given? return result end rescue ::Faraday::Error => e gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e raise ::Google::Cloud::Error.from_error(gapic_error) end |
#patch(request, options = nil) ⇒ ::Gapic::Rest::BaseOperation #patch(project: nil, public_advertised_prefix: nil, public_advertised_prefix_resource: nil, request_id: nil) ⇒ ::Gapic::Rest::BaseOperation
Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 |
# File 'lib/google/cloud/compute/v1/public_advertised_prefixes/rest/client.rb', line 446 def patch request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::PatchPublicAdvertisedPrefixeRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.patch..to_h # Set x-goog-api-client header [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] .apply_defaults timeout: @config.rpcs.patch.timeout, metadata: .apply_defaults timeout: @config.timeout, metadata: @config. @public_advertised_prefixes_stub.patch request, do |result, response| result = ::Gapic::Rest::BaseOperation.new result yield result, response if block_given? return result end rescue ::Faraday::Error => e gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e raise ::Google::Cloud::Error.from_error(gapic_error) end |