NetworkLoadBalancerClientCompositeOperations¶

class oci.network_load_balancer.NetworkLoadBalancerClientCompositeOperations(client, **kwargs)¶

This class provides a wrapper around NetworkLoadBalancerClient 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 NetworkLoadBalancerClientCompositeOperations object
`change_network_load_balancer_compartment_and_wait_for_state`(…)	Calls `change_network_load_balancer_compartment()` and waits for the `WorkRequest` to enter the given state(s).
`create_backend_and_wait_for_state`(…[, …])	Calls `create_backend()` and waits for the `WorkRequest` to enter the given state(s).
`create_backend_set_and_wait_for_state`(…[, …])	Calls `create_backend_set()` and waits for the `WorkRequest` to enter the given state(s).
`create_listener_and_wait_for_state`(…[, …])	Calls `create_listener()` and waits for the `WorkRequest` to enter the given state(s).
`create_network_load_balancer_and_wait_for_state`(…)	Calls `create_network_load_balancer()` and waits for the `WorkRequest` to enter the given state(s).
`delete_backend_and_wait_for_state`(…[, …])	Calls `delete_backend()` and waits for the `WorkRequest` to enter the given state(s).
`delete_backend_set_and_wait_for_state`(…[, …])	Calls `delete_backend_set()` and waits for the `WorkRequest` to enter the given state(s).
`delete_listener_and_wait_for_state`(…[, …])	Calls `delete_listener()` and waits for the `WorkRequest` to enter the given state(s).
`delete_network_load_balancer_and_wait_for_state`(…)	Calls `delete_network_load_balancer()` and waits for the `WorkRequest` to enter the given state(s).
`update_backend_and_wait_for_state`(…[, …])	Calls `update_backend()` and waits for the `WorkRequest` to enter the given state(s).
`update_backend_set_and_wait_for_state`(…[, …])	Calls `update_backend_set()` and waits for the `WorkRequest` to enter the given state(s).
`update_health_checker_and_wait_for_state`(…)	Calls `update_health_checker()` and waits for the `WorkRequest` to enter the given state(s).
`update_listener_and_wait_for_state`(…[, …])	Calls `update_listener()` and waits for the `WorkRequest` to enter the given state(s).
`update_network_load_balancer_and_wait_for_state`(…)	Calls `update_network_load_balancer()` and waits for the `WorkRequest` to enter the given state(s).
`update_network_security_groups_and_wait_for_state`(…)	Calls `update_network_security_groups()` and waits for the `WorkRequest` to enter the given state(s).

__init__(client, **kwargs)¶

Creates a new NetworkLoadBalancerClientCompositeOperations object

Parameters:	client (NetworkLoadBalancerClient) – The service client which will be wrapped by this object

change_network_load_balancer_compartment_and_wait_for_state(network_load_balancer_id, change_network_load_balancer_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

network_load_balancer_id (str) –
(required) The OCID of the network load balancer to update.
change_network_load_balancer_compartment_details (oci.network_load_balancer.models.ChangeNetworkLoadBalancerCompartmentDetails) – (required) The configuration details for moving a network load balancer to a different 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_network_load_balancer_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_backend_and_wait_for_state(network_load_balancer_id, create_backend_details, backend_set_name, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

network_load_balancer_id (str) –
(required) The OCID of the network load balancer to update.
create_backend_details (oci.network_load_balancer.models.CreateBackendDetails) – (required) The details to add a backend server to a backend set.
backend_set_name (str) –
(required) The name of the backend set to which to add the backend server.

Example: example_backend_set
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_backend()
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_backend_set_and_wait_for_state(network_load_balancer_id, create_backend_set_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

network_load_balancer_id (str) –
(required) The OCID of the network load balancer to update.
create_backend_set_details (oci.network_load_balancer.models.CreateBackendSetDetails) – (required) The details for adding a backend set.
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_backend_set()
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_listener_and_wait_for_state(network_load_balancer_id, create_listener_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

network_load_balancer_id (str) –
(required) The OCID of the network load balancer to update.
create_listener_details (oci.network_load_balancer.models.CreateListenerDetails) – (required) Details to add a listener.
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_listener()
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_network_load_balancer_and_wait_for_state(create_network_load_balancer_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

create_network_load_balancer_details (oci.network_load_balancer.models.CreateNetworkLoadBalancerDetails) – (required) Details for the new network load balancer.
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_network_load_balancer()
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_backend_and_wait_for_state(network_load_balancer_id, backend_set_name, backend_name, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

network_load_balancer_id (str) –
(required) The OCID of the network load balancer to update.
backend_set_name (str) –
(required) The name of the backend set associated with the backend server.

Example: example_backend_set
backend_name (str) –
(required) The name of the backend server to remove. If the backend was created with an explicitly specified name, that name should be used here. If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as <ipAddress>:<port>. If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as <targetId>:<port>.

Example: 10.0.0.3:8080 or ocid1.privateip..oc1.<var><unique_ID></var>:8080
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_backend()
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_backend_set_and_wait_for_state(network_load_balancer_id, backend_set_name, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

network_load_balancer_id (str) –
(required) The OCID of the network load balancer to update.
backend_set_name (str) –
(required) The name of the backend set to delete.

Example: example_backend_set
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_backend_set()
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_listener_and_wait_for_state(network_load_balancer_id, listener_name, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

network_load_balancer_id (str) –
(required) The OCID of the network load balancer to update.
listener_name (str) –
(required) The name of the listener to delete.

Example: example_listener
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_listener()
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_network_load_balancer_and_wait_for_state(network_load_balancer_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

network_load_balancer_id (str) –
(required) The OCID of the network load balancer to update.
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_network_load_balancer()
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_backend_and_wait_for_state(network_load_balancer_id, update_backend_details, backend_set_name, backend_name, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

network_load_balancer_id (str) –
(required) The OCID of the network load balancer to update.
update_backend_details (oci.network_load_balancer.models.UpdateBackendDetails) – (required) Details for updating a backend server.
backend_set_name (str) –
(required) The name of the backend set associated with the backend server.

Example: example_backend_set
backend_name (str) –
(required) The name of the backend server to update. If the backend was created with an explicitly specified name, that name should be used here. If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as <ipAddress>:<port>. If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as <targetId>:<port>.

Example: 10.0.0.3:8080 or ocid1.privateip..oc1.<var><unique_ID></var>:8080
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_backend()
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_backend_set_and_wait_for_state(network_load_balancer_id, update_backend_set_details, backend_set_name, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

network_load_balancer_id (str) –
(required) The OCID of the network load balancer to update.
update_backend_set_details (oci.network_load_balancer.models.UpdateBackendSetDetails) – (required) The details to update a backend set.
backend_set_name (str) –
(required) The name of the backend set to update.

Example: example_backend_set
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_backend_set()
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_health_checker_and_wait_for_state(network_load_balancer_id, update_health_checker_details, backend_set_name, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

network_load_balancer_id (str) –
(required) The OCID of the network load balancer to update.
update_health_checker_details (oci.network_load_balancer.models.UpdateHealthCheckerDetails) – (required) The health check policy configuration details.
backend_set_name (str) –
(required) The name of the backend set associated with the health check policy to be retrieved.

Example: example_backend_set
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_health_checker()
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_listener_and_wait_for_state(network_load_balancer_id, update_listener_details, listener_name, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

network_load_balancer_id (str) –
(required) The OCID of the network load balancer to update.
update_listener_details (oci.network_load_balancer.models.UpdateListenerDetails) – (required) Details to update a listener.
listener_name (str) –
(required) The name of the listener to update.

Example: example_listener
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_listener()
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_network_load_balancer_and_wait_for_state(network_load_balancer_id, update_network_load_balancer_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

network_load_balancer_id (str) –
(required) The OCID of the network load balancer to update.
update_network_load_balancer_details (oci.network_load_balancer.models.UpdateNetworkLoadBalancerDetails) – (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_network_load_balancer()
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_network_security_groups_and_wait_for_state(network_load_balancer_id, update_network_security_groups_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

network_load_balancer_id (str) –
(required) The OCID of the network load balancer to update.
update_network_security_groups_details (oci.network_load_balancer.models.UpdateNetworkSecurityGroupsDetails) – (required) The details for updating the network security groups associated with the specified network load balancer.
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_network_security_groups()
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