class Google::Cloud::Compute::V1::ImageFamilyViews::Rest::Client
REST client for the ImageFamilyViews
service.
The ImageFamilyViews
API.
Attributes
@private
Public Class Methods
Configure the ImageFamilyViews
Client
class.
See {::Google::Cloud::Compute::V1::ImageFamilyViews::Rest::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all ImageFamilyViews clients ::Google::Cloud::Compute::V1::ImageFamilyViews::Rest::Client.configure do |config| config.timeout = 10.0 end
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/compute/v1/image_family_views/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.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 end yield @configure if block_given? @configure end
Create a new ImageFamilyViews
REST client object.
@example
# Create a client using the default configuration client = ::Google::Cloud::Compute::V1::ImageFamilyViews::Rest::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Compute::V1::ImageFamilyViews::Rest::Client.new do |config| config.timeout = 10.0 end
@yield [config] Configure the ImageFamilyViews
client. @yieldparam config [Client::Configuration]
# File lib/google/cloud/compute/v1/image_family_views/rest/client.rb, line 114 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 @image_family_views_stub = ::Google::Cloud::Compute::V1::ImageFamilyViews::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials end
Public Instance Methods
Configure the ImageFamilyViews
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 {Client.configure}.
See {::Google::Cloud::Compute::V1::ImageFamilyViews::Rest::Client::Configuration} for a description of the configuration fields.
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/compute/v1/image_family_views/rest/client.rb, line 93 def configure yield @config if block_given? @config end
Returns the latest image that is part of an image family, is not deprecated and is rolled out in the specified zone.
@overload get(request, options = nil)
Pass arguments to `get` via a request object, either of type {::Google::Cloud::Compute::V1::GetImageFamilyViewRequest} or an equivalent Hash. @param request [::Google::Cloud::Compute::V1::GetImageFamilyViewRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries etc. Optional. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
@overload get(family: nil, project: nil, zone: nil)
Pass arguments to `get` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param family [::String] Name of the image family to search for. @param project [::String] Project ID for this request. @param zone [::String] The name of the zone for this request.
@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Google::Cloud::Compute::V1::ImageFamilyView] @yieldparam response [::Faraday::Response]
@return [::Google::Cloud::Compute::V1::ImageFamilyView]
@raise [::Google::Cloud::Error] if the REST call is aborted.
# File lib/google/cloud/compute/v1/image_family_views/rest/client.rb, line 166 def get request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::GetImageFamilyViewRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.get.metadata.to_h # Set x-goog-api-client header call_metadata[:"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] options.apply_defaults timeout: @config.rpcs.get.timeout, metadata: call_metadata options.apply_defaults timeout: @config.timeout, metadata: @config.metadata @image_family_views_stub.get request, options do |result, response| yield result, response if block_given? return result end rescue ::Faraday::Error => e begin raise ::Gapic::Rest::Error.wrap_faraday_error e rescue ::Gapic::Rest::Error => gapic_error raise ::Google::Cloud::Error.from_error gapic_error end end