Class: OCI::TenantManagerControlPlane::GovernanceClientCompositeOperations

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/tenant_manager_control_plane/governance_client_composite_operations.rb

Overview

This class provides a wrapper around GovernanceClient 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::TenantManagerControlPlane::GovernanceClient.new) ⇒ GovernanceClientCompositeOperations

Initializes a new GovernanceClientCompositeOperations

Parameters:



22
23
24
 
# File 'lib/oci/tenant_manager_control_plane/governance_client_composite_operations.rb', line 22

def initialize(service_client = OCI::TenantManagerControlPlane::GovernanceClient.new)
  @service_client = service_client
end

Instance Attribute Details

#service_client ⇒ OCI::TenantManagerControlPlane::GovernanceClient (readonly)

The OCI::TenantManagerControlPlane::GovernanceClient used to communicate with the service_client

Returns:



16
17
18
 
# File 'lib/oci/tenant_manager_control_plane/governance_client_composite_operations.rb', line 16

def service_client
  @service_client
end

Instance Method Details

#add_governance_and_wait_for_state(organization_id, organization_tenancy_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::TenantManagerControlPlane::GovernanceClient#add_governance and then waits for the Models::WorkRequest to enter the given state(s).

Parameters:

  • organization_id (String) —

    OCID of the organization.

  • organization_tenancy_id (String) —

    OCID of tenancy that is opting in to governance rules.

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

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

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

    Any optional arguments accepted by OCI::TenantManagerControlPlane::GovernanceClient#add_governance

  • 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:



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/oci/tenant_manager_control_plane/governance_client_composite_operations.rb', line 42

def add_governance_and_wait_for_state(organization_id, organization_tenancy_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.add_governance(organization_id, organization_tenancy_id, base_operation_opts)
  use_util = OCI::TenantManagerControlPlane::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::TenantManagerControlPlane::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

#remove_governance_and_wait_for_state(organization_id, organization_tenancy_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::TenantManagerControlPlane::GovernanceClient#remove_governance and then waits for the Models::WorkRequest to enter the given state(s).

Parameters:

  • organization_id (String) —

    OCID of the organization.

  • organization_tenancy_id (String) —

    OCID of tenancy that is opting out of governance rules.

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

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

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

    Any optional arguments accepted by OCI::TenantManagerControlPlane::GovernanceClient#remove_governance

  • 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:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/oci/tenant_manager_control_plane/governance_client_composite_operations.rb', line 93

def remove_governance_and_wait_for_state(organization_id, organization_tenancy_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.remove_governance(organization_id, organization_tenancy_id, base_operation_opts)
  use_util = OCI::TenantManagerControlPlane::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::TenantManagerControlPlane::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