class Google::Cloud::Orchestration::Airflow::Service::V1::ImageVersions::Client

Client for the ImageVersions service.

Readonly service to query available ImageVersions.

Attributes

image_versions_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the ImageVersions Client class.

See {::Google::Cloud::Orchestration::Airflow::Service::V1::ImageVersions::Client::Configuration} for a description of the configuration fields.

@example

# Modify the configuration for all ImageVersions clients
::Google::Cloud::Orchestration::Airflow::Service::V1::ImageVersions::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/orchestration/airflow/service/v1/image_versions/client.rb, line 56
def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Orchestration", "Airflow", "Service", "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
  end
  yield @configure if block_given?
  @configure
end
new() { |config| ... } click to toggle source

Create a new ImageVersions client object.

@example

# Create a client using the default configuration
client = ::Google::Cloud::Orchestration::Airflow::Service::V1::ImageVersions::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Orchestration::Airflow::Service::V1::ImageVersions::Client.new do |config|
  config.timeout = 10.0
end

@yield [config] Configure the ImageVersions client. @yieldparam config [Client::Configuration]

# File lib/google/cloud/orchestration/airflow/service/v1/image_versions/client.rb, line 109
def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/orchestration/airflow/service/v1/image_versions_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                           !@config.endpoint.split(".").first.include?("-")
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @image_versions_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Orchestration::Airflow::Service::V1::ImageVersions::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

configure() { |config| ... } click to toggle source

Configure the ImageVersions 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::Orchestration::Airflow::Service::V1::ImageVersions::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/orchestration/airflow/service/v1/image_versions/client.rb, line 88
def configure
  yield @config if block_given?
  @config
end
list_image_versions(request, options = nil) { |response, operation| ... } click to toggle source

List ImageVersions for provided location.

@overload list_image_versions(request, options = nil)

Pass arguments to `list_image_versions` via a request object, either of type
{::Google::Cloud::Orchestration::Airflow::Service::V1::ListImageVersionsRequest} or an equivalent Hash.

@param request [::Google::Cloud::Orchestration::Airflow::Service::V1::ListImageVersionsRequest, ::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.

@overload list_image_versions(parent: nil, page_size: nil, page_token: nil, include_past_releases: nil)

Pass arguments to `list_image_versions` 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 parent [::String]
  List ImageVersions in the given project and location, in the form:
  "projects/\\{projectId}/locations/\\{locationId}"
@param page_size [::Integer]
  The maximum number of image_versions to return.
@param page_token [::String]
  The next_page_token value returned from a previous List request, if any.
@param include_past_releases [::Boolean]
  Whether or not image versions from old releases should be included.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Orchestration::Airflow::Service::V1::ImageVersion>] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::PagedEnumerable<::Google::Cloud::Orchestration::Airflow::Service::V1::ImageVersion>]

@raise [::Google::Cloud::Error] if the RPC is aborted.

@example Basic example

require "google/cloud/orchestration/airflow/service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Orchestration::Airflow::Service::V1::ImageVersions::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Orchestration::Airflow::Service::V1::ListImageVersionsRequest.new

# Call the list_image_versions method.
result = client.list_image_versions request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Cloud::Orchestration::Airflow::Service::V1::ImageVersion.
  p response
end
# File lib/google/cloud/orchestration/airflow/service/v1/image_versions/client.rb, line 204
def list_image_versions request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Orchestration::Airflow::Service::V1::ListImageVersionsRequest

  # 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
  metadata = @config.rpcs.list_image_versions.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  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::Orchestration::Airflow::Service::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_image_versions.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_image_versions.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @image_versions_stub.call_rpc :list_image_versions, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @image_versions_stub, :list_image_versions, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end