Class: OCI::Marketplace::MarketplaceClientCompositeOperations

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/marketplace/marketplace_client_composite_operations.rb

Overview

This class provides a wrapper around MarketplaceClient and offers convenience methods for operations that would otherwise need to be chained together. For example, instead of performing an action on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource to enter a given state, you can call a single method in this class to accomplish the same functionality

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(service_client = OCI::Marketplace::MarketplaceClient.new) ⇒ MarketplaceClientCompositeOperations

Initializes a new MarketplaceClientCompositeOperations

Parameters:



22
23
24
 
# File 'lib/oci/marketplace/marketplace_client_composite_operations.rb', line 22

def initialize(service_client = OCI::Marketplace::MarketplaceClient.new)
  @service_client = service_client
end

Instance Attribute Details

#service_client ⇒ OCI::Marketplace::MarketplaceClient (readonly)

The OCI::Marketplace::MarketplaceClient used to communicate with the service_client

Returns:



16
17
18
 
# File 'lib/oci/marketplace/marketplace_client_composite_operations.rb', line 16

def service_client
  @service_client
end

Instance Method Details

#create_publication_and_wait_for_state(create_publication_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::Marketplace::MarketplaceClient#create_publication and then waits for the OCI::Marketplace::Models::Publication acted upon to enter the given state(s).

Parameters:

Returns:



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/marketplace/marketplace_client_composite_operations.rb', line 41

def create_publication_and_wait_for_state(create_publication_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.create_publication(create_publication_details, base_operation_opts)

  return operation_result if wait_for_states.empty?

  lowered_wait_for_states = wait_for_states.map(&:downcase)
  wait_for_resource_id = operation_result.data.id

  begin
    waiter_result = @service_client.get_publication(wait_for_resource_id).wait_until(
      eval_proc: ->(response) { response.data.respond_to?(:lifecycle_state) && lowered_wait_for_states.include?(response.data.lifecycle_state.downcase) },
      max_interval_seconds: waiter_opts.key?(:max_interval_seconds) ? waiter_opts[:max_interval_seconds] : 30,
      max_wait_seconds: waiter_opts.key?(:max_wait_seconds) ? waiter_opts[:max_wait_seconds] : 1200
    )
    result_to_return = waiter_result

    return result_to_return
  rescue StandardError
    raise OCI::Errors::CompositeOperationError.new(partial_results: [operation_result])
  end
end

#delete_publication_and_wait_for_state(publication_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::Marketplace::MarketplaceClient#delete_publication and then waits for the OCI::Marketplace::Models::Publication acted upon to enter the given state(s).

Parameters:

  • publication_id (String) —

    The unique identifier for the publication.

  • wait_for_states (Array<String>) (defaults to: []) —

    An array of states to wait on. These should be valid values for OCI::Marketplace::Models::Publication#lifecycle_state

  • base_operation_opts (Hash) (defaults to: {}) —

    Any optional arguments accepted by OCI::Marketplace::MarketplaceClient#delete_publication

  • waiter_opts (Hash) (defaults to: {}) —

    Optional arguments for the waiter. Keys should be symbols, and the following keys are supported: * max_interval_seconds: The maximum interval between queries, in seconds. * max_wait_seconds The maximum time to wait, in seconds

Returns:



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/oci/marketplace/marketplace_client_composite_operations.rb', line 80

def delete_publication_and_wait_for_state(publication_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  initial_get_result = @service_client.get_publication(publication_id)
  operation_result = @service_client.delete_publication(publication_id, base_operation_opts)

  return operation_result if wait_for_states.empty?

  lowered_wait_for_states = wait_for_states.map(&:downcase)

  begin
    waiter_result = initial_get_result.wait_until(
      eval_proc: ->(response) { response.data.respond_to?(:lifecycle_state) && lowered_wait_for_states.include?(response.data.lifecycle_state.downcase) },
      max_interval_seconds: waiter_opts.key?(:max_interval_seconds) ? waiter_opts[:max_interval_seconds] : 30,
      max_wait_seconds: waiter_opts.key?(:max_wait_seconds) ? waiter_opts[:max_wait_seconds] : 1200,
      succeed_on_not_found: true
    )
    result_to_return = waiter_result

    return result_to_return
  rescue StandardError
    raise OCI::Errors::CompositeOperationError.new(partial_results: [operation_result])
  end
end

#export_listing_and_wait_for_state(listing_id, package_version, export_package_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::Marketplace::MarketplaceClient#export_listing and then waits for the OCI::Marketplace::Models::WorkRequest to enter the given state(s).

Parameters:

  • listing_id (String) —

    The unique identifier for the listing.

  • package_version (String) —

    The version of the package. Package versions are unique within a listing.

  • export_package_details (OCI::Marketplace::Models::ExportPackageDetails) —

    The details for exporting container images or helm chart.

  • wait_for_states (Array<String>) (defaults to: []) —

    An array of states to wait on. These should be valid values for OCI::Marketplace::Models::WorkRequest#status

  • base_operation_opts (Hash) (defaults to: {}) —

    Any optional arguments accepted by OCI::Marketplace::MarketplaceClient#export_listing

  • waiter_opts (Hash) (defaults to: {}) —

    Optional arguments for the waiter. Keys should be symbols, and the following keys are supported: * max_interval_seconds: The maximum interval between queries, in seconds. * max_wait_seconds The maximum time to wait, in seconds

Returns:



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/marketplace/marketplace_client_composite_operations.rb', line 122

def export_listing_and_wait_for_state(listing_id, package_version, export_package_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.export_listing(listing_id, package_version, export_package_details, base_operation_opts)
  use_util = OCI::Marketplace::Util.respond_to?(:wait_on_work_request)

  return operation_result if wait_for_states.empty? && !use_util

  lowered_wait_for_states = wait_for_states.map(&:downcase)
  wait_for_resource_id = operation_result.headers['opc-work-request-id']
  return operation_result if wait_for_resource_id.nil? || wait_for_resource_id.empty?

  begin
    if use_util
      waiter_result = OCI::Marketplace::Util.wait_on_work_request(
        @service_client,
        wait_for_resource_id,
        max_interval_seconds: waiter_opts.key?(:max_interval_seconds) ? waiter_opts[:max_interval_seconds] : 30,
        max_wait_seconds: waiter_opts.key?(:max_wait_seconds) ? waiter_opts[:max_wait_seconds] : 1200
      )
    else
      waiter_result = @service_client.get_work_request(wait_for_resource_id).wait_until(
        eval_proc: ->(response) { response.data.respond_to?(:status) && lowered_wait_for_states.include?(response.data.status.downcase) },
        max_interval_seconds: waiter_opts.key?(:max_interval_seconds) ? waiter_opts[:max_interval_seconds] : 30,
        max_wait_seconds: waiter_opts.key?(:max_wait_seconds) ? waiter_opts[:max_wait_seconds] : 1200
      )
    end
    result_to_return = waiter_result

    return result_to_return
  rescue StandardError
    raise OCI::Errors::CompositeOperationError.new(partial_results: [operation_result])
  end
end

#update_publication_and_wait_for_state(publication_id, update_publication_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::Marketplace::MarketplaceClient#update_publication and then waits for the OCI::Marketplace::Models::Publication acted upon to enter the given state(s).

Parameters:

Returns:



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/oci/marketplace/marketplace_client_composite_operations.rb', line 173

def update_publication_and_wait_for_state(publication_id, update_publication_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.update_publication(publication_id, update_publication_details, base_operation_opts)

  return operation_result if wait_for_states.empty?

  lowered_wait_for_states = wait_for_states.map(&:downcase)
  wait_for_resource_id = operation_result.data.id

  begin
    waiter_result = @service_client.get_publication(wait_for_resource_id).wait_until(
      eval_proc: ->(response) { response.data.respond_to?(:lifecycle_state) && lowered_wait_for_states.include?(response.data.lifecycle_state.downcase) },
      max_interval_seconds: waiter_opts.key?(:max_interval_seconds) ? waiter_opts[:max_interval_seconds] : 30,
      max_wait_seconds: waiter_opts.key?(:max_wait_seconds) ? waiter_opts[:max_wait_seconds] : 1200
    )
    result_to_return = waiter_result

    return result_to_return
  rescue StandardError
    raise OCI::Errors::CompositeOperationError.new(partial_results: [operation_result])
  end
end