ApiGatewayClientCompositeOperations

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

This class provides a wrapper around ApiGatewayClient 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 ApiGatewayClientCompositeOperations object
change_api_compartment_and_wait_for_state(…) Calls change_api_compartment() and waits for the WorkRequest to enter the given state(s).
create_api_and_wait_for_state(create_api_details) Calls create_api() and waits for the WorkRequest to enter the given state(s).
create_certificate_and_wait_for_state(…[, …]) Calls create_certificate() and waits for the WorkRequest to enter the given state(s).
delete_api_and_wait_for_state(api_id[, …]) Calls delete_api() and waits for the WorkRequest to enter the given state(s).
delete_certificate_and_wait_for_state(…[, …]) Calls delete_certificate() and waits for the WorkRequest to enter the given state(s).
update_api_and_wait_for_state(api_id, …[, …]) Calls update_api() and waits for the WorkRequest to enter the given state(s).
update_certificate_and_wait_for_state(…[, …]) Calls update_certificate() and waits for the WorkRequest to enter the given state(s).
__init__(client, **kwargs)

Creates a new ApiGatewayClientCompositeOperations object

Parameters:client (ApiGatewayClient) – The service client which will be wrapped by this object
change_api_compartment_and_wait_for_state(api_id, change_api_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • api_id (str) – (required) The ocid of the API.
  • change_api_compartment_details (oci.apigateway.models.ChangeApiCompartmentDetails) – (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_api_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_api_and_wait_for_state(create_api_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • create_api_details (oci.apigateway.models.CreateApiDetails) – (required) Details for the new API.
  • 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_api()
  • 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_certificate_and_wait_for_state(create_certificate_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • create_certificate_details (oci.apigateway.models.CreateCertificateDetails) – (required) Details for the new certificate
  • 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_certificate()
  • 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_api_and_wait_for_state(api_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • api_id (str) – (required) The ocid of the API.
  • 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_api()
  • 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_certificate_and_wait_for_state(certificate_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • certificate_id (str) – (required) The ocid of the certificate.
  • 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_certificate()
  • 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_api_and_wait_for_state(api_id, update_api_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • api_id (str) – (required) The ocid of the API.
  • update_api_details (oci.apigateway.models.UpdateApiDetails) – (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_api()
  • 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_certificate_and_wait_for_state(certificate_id, update_certificate_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • certificate_id (str) – (required) The ocid of the certificate.
  • update_certificate_details (oci.apigateway.models.UpdateCertificateDetails) – (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_certificate()
  • 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