DnsClientCompositeOperations¶

class oci.dns.DnsClientCompositeOperations(client, **kwargs)¶

This class provides a wrapper around DnsClient 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 DnsClientCompositeOperations object
`create_resolver_endpoint_and_wait_for_state`(…)	Calls `create_resolver_endpoint()` and waits for the `ResolverEndpoint` acted upon to enter the given state(s).
`create_steering_policy_and_wait_for_state`(…)	Calls `create_steering_policy()` and waits for the `SteeringPolicy` acted upon to enter the given state(s).
`create_steering_policy_attachment_and_wait_for_state`(…)	Calls `create_steering_policy_attachment()` and waits for the `SteeringPolicyAttachment` acted upon to enter the given state(s).
`create_tsig_key_and_wait_for_state`(…[, …])	Calls `create_tsig_key()` and waits for the `TsigKey` acted upon to enter the given state(s).
`create_view_and_wait_for_state`(…[, …])	Calls `create_view()` and waits for the `View` acted upon to enter the given state(s).
`create_zone_and_wait_for_state`(…[, …])	Calls `create_zone()` and waits for the `Zone` acted upon to enter the given state(s).
`delete_steering_policy_and_wait_for_state`(…)	Calls `delete_steering_policy()` and waits for the `SteeringPolicy` acted upon to enter the given state(s).
`delete_steering_policy_attachment_and_wait_for_state`(…)	Calls `delete_steering_policy_attachment()` and waits for the `SteeringPolicyAttachment` acted upon to enter the given state(s).
`delete_tsig_key_and_wait_for_state`(tsig_key_id)	Calls `delete_tsig_key()` and waits for the `TsigKey` acted upon to enter the given state(s).
`delete_view_and_wait_for_state`(view_id[, …])	Calls `delete_view()` and waits for the `View` acted upon to enter the given state(s).
`delete_zone_and_wait_for_state`(zone_name_or_id)	Calls `delete_zone()` and waits for the `Zone` acted upon to enter the given state(s).
`update_resolver_and_wait_for_state`(…[, …])	Calls `update_resolver()` and waits for the `Resolver` acted upon to enter the given state(s).
`update_resolver_endpoint_and_wait_for_state`(…)	Calls `update_resolver_endpoint()` and waits for the `ResolverEndpoint` acted upon to enter the given state(s).
`update_steering_policy_and_wait_for_state`(…)	Calls `update_steering_policy()` and waits for the `SteeringPolicy` acted upon to enter the given state(s).
`update_steering_policy_attachment_and_wait_for_state`(…)	Calls `update_steering_policy_attachment()` and waits for the `SteeringPolicyAttachment` acted upon to enter the given state(s).
`update_tsig_key_and_wait_for_state`(…[, …])	Calls `update_tsig_key()` and waits for the `TsigKey` acted upon to enter the given state(s).
`update_view_and_wait_for_state`(view_id, …)	Calls `update_view()` and waits for the `View` acted upon to enter the given state(s).
`update_zone_and_wait_for_state`(…[, …])	Calls `update_zone()` and waits for the `Zone` acted upon to enter the given state(s).

__init__(client, **kwargs)¶

Creates a new DnsClientCompositeOperations object

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

create_resolver_endpoint_and_wait_for_state(resolver_id, create_resolver_endpoint_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_resolver_endpoint() and waits for the ResolverEndpoint acted upon to enter the given state(s).

Parameters:

resolver_id (str) – (required) The OCID of the target resolver.
create_resolver_endpoint_details (oci.dns.models.CreateResolverEndpointDetails) – (required) Details for creating a new resolver endpoint.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_resolver_endpoint()
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_steering_policy_and_wait_for_state(create_steering_policy_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_steering_policy() and waits for the SteeringPolicy acted upon to enter the given state(s).

Parameters:

create_steering_policy_details (oci.dns.models.CreateSteeringPolicyDetails) – (required) Details for creating a new steering policy.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_steering_policy()
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_steering_policy_attachment_and_wait_for_state(create_steering_policy_attachment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_steering_policy_attachment() and waits for the SteeringPolicyAttachment acted upon to enter the given state(s).

Parameters:

create_steering_policy_attachment_details (oci.dns.models.CreateSteeringPolicyAttachmentDetails) – (required) Details for creating a new steering policy attachment.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_steering_policy_attachment()
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_tsig_key_and_wait_for_state(create_tsig_key_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_tsig_key() and waits for the TsigKey acted upon to enter the given state(s).

Parameters:

create_tsig_key_details (oci.dns.models.CreateTsigKeyDetails) – (required) Details for creating a new TSIG key.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_tsig_key()
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_view_and_wait_for_state(create_view_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_view() and waits for the View acted upon to enter the given state(s).

Parameters:

create_view_details (oci.dns.models.CreateViewDetails) – (required) Details for creating a new view.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_view()
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_zone_and_wait_for_state(create_zone_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_zone() and waits for the Zone acted upon to enter the given state(s).

Parameters:

create_zone_details (oci.dns.models.CreateZoneBaseDetails) – (required) Details for creating a new zone.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_zone()
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_steering_policy_and_wait_for_state(steering_policy_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls delete_steering_policy() and waits for the SteeringPolicy acted upon to enter the given state(s).

Parameters:

steering_policy_id (str) – (required) The OCID of the target steering policy.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_steering_policy()
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_steering_policy_attachment_and_wait_for_state(steering_policy_attachment_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls delete_steering_policy_attachment() and waits for the SteeringPolicyAttachment acted upon to enter the given state(s).

Parameters:

steering_policy_attachment_id (str) – (required) The OCID of the target steering policy attachment.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_steering_policy_attachment()
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_tsig_key_and_wait_for_state(tsig_key_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls delete_tsig_key() and waits for the TsigKey acted upon to enter the given state(s).

Parameters:

tsig_key_id (str) – (required) The OCID of the target TSIG key.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_tsig_key()
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_view_and_wait_for_state(view_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls delete_view() and waits for the View acted upon to enter the given state(s).

Parameters:

view_id (str) – (required) The OCID of the target view.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_view()
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_zone_and_wait_for_state(zone_name_or_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls delete_zone() and waits for the Zone acted upon to enter the given state(s).

Parameters:

zone_name_or_id (str) – (required) The name or OCID of the target zone.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_zone()
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_resolver_and_wait_for_state(resolver_id, update_resolver_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls update_resolver() and waits for the Resolver acted upon to enter the given state(s).

Parameters:

resolver_id (str) – (required) The OCID of the target resolver.
update_resolver_details (oci.dns.models.UpdateResolverDetails) – (required) New data for the resolver.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_resolver()
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_resolver_endpoint_and_wait_for_state(resolver_id, resolver_endpoint_name, update_resolver_endpoint_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls update_resolver_endpoint() and waits for the ResolverEndpoint acted upon to enter the given state(s).

Parameters:

resolver_id (str) – (required) The OCID of the target resolver.
resolver_endpoint_name (str) – (required) The name of the target resolver endpoint.
update_resolver_endpoint_details (oci.dns.models.UpdateResolverEndpointDetails) – (required) New data for the resolver endpoint.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_resolver_endpoint()
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_steering_policy_and_wait_for_state(steering_policy_id, update_steering_policy_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls update_steering_policy() and waits for the SteeringPolicy acted upon to enter the given state(s).

Parameters:

steering_policy_id (str) – (required) The OCID of the target steering policy.
update_steering_policy_details (oci.dns.models.UpdateSteeringPolicyDetails) – (required) New data for the steering policy.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_steering_policy()
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_steering_policy_attachment_and_wait_for_state(steering_policy_attachment_id, update_steering_policy_attachment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls update_steering_policy_attachment() and waits for the SteeringPolicyAttachment acted upon to enter the given state(s).

Parameters:

steering_policy_attachment_id (str) – (required) The OCID of the target steering policy attachment.
update_steering_policy_attachment_details (oci.dns.models.UpdateSteeringPolicyAttachmentDetails) – (required) New data for the steering policy attachment.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_steering_policy_attachment()
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_tsig_key_and_wait_for_state(tsig_key_id, update_tsig_key_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls update_tsig_key() and waits for the TsigKey acted upon to enter the given state(s).

Parameters:

tsig_key_id (str) – (required) The OCID of the target TSIG key.
update_tsig_key_details (oci.dns.models.UpdateTsigKeyDetails) – (required) New data for the TSIG key.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_tsig_key()
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_view_and_wait_for_state(view_id, update_view_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls update_view() and waits for the View acted upon to enter the given state(s).

Parameters:

view_id (str) – (required) The OCID of the target view.
update_view_details (oci.dns.models.UpdateViewDetails) – (required) New data for the view.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_view()
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_zone_and_wait_for_state(zone_name_or_id, update_zone_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls update_zone() and waits for the Zone acted upon to enter the given state(s).

Parameters:

zone_name_or_id (str) – (required) The name or OCID of the target zone.
update_zone_details (oci.dns.models.UpdateZoneDetails) – (required) New data for the zone.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_zone()
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