GatewayClientCompositeOperations

class oci.apigateway.GatewayClientCompositeOperations(client, **kwargs)

This class provides a wrapper around GatewayClient 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

Methods

__init__(client, **kwargs) Creates a new GatewayClientCompositeOperations object
change_gateway_compartment_and_wait_for_state(…) Calls change_gateway_compartment() and waits for the WorkRequest to enter the given state(s).
create_gateway_and_wait_for_state(…[, …]) Calls create_gateway() and waits for the WorkRequest to enter the given state(s).
delete_gateway_and_wait_for_state(gateway_id) Calls delete_gateway() and waits for the WorkRequest to enter the given state(s).
update_gateway_and_wait_for_state(…[, …]) Calls update_gateway() and waits for the WorkRequest to enter the given state(s).
__init__(client, **kwargs)

Creates a new GatewayClientCompositeOperations object

Parameters:client (GatewayClient) – The service client which will be wrapped by this object
change_gateway_compartment_and_wait_for_state(gateway_id, change_gateway_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls change_gateway_compartment() and waits for the WorkRequest to enter the given state(s).

Parameters:
  • gateway_id (str) – (required) The ocid of the gateway.
  • change_gateway_compartment_details (ChangeGatewayCompartmentDetails) – (required) Details of the target compartment.
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to change_gateway_compartment()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
create_gateway_and_wait_for_state(create_gateway_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_gateway() and waits for the WorkRequest to enter the given state(s).

Parameters:
  • create_gateway_details (CreateGatewayDetails) – (required) Details for the new gateway.
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_gateway()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
delete_gateway_and_wait_for_state(gateway_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_gateway() and waits for the WorkRequest to enter the given state(s).

Parameters:
  • gateway_id (str) – (required) The ocid of the gateway.
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_gateway()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
update_gateway_and_wait_for_state(gateway_id, update_gateway_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_gateway() and waits for the WorkRequest to enter the given state(s).

Parameters:
  • gateway_id (str) – (required) The ocid of the gateway.
  • update_gateway_details (UpdateGatewayDetails) – (required) The information to be updated.
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_gateway()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait