Class: OCI::Dns::DnsClient

#change_resolver_compartment(resolver_id, change_resolver_compartment_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use change_resolver_compartment API.

Moves a resolver into a different compartment along with its protected default view and any endpoints.

Zones in the default view are not moved. VCN-dedicated resolvers are initially created in the same compartment as their corresponding VCN, but can then be moved to a different compartment.

Parameters:

resolver_id (String) —

The OCID of the target resolver.
change_resolver_compartment_details (OCI::Dns::Models::ChangeResolverCompartmentDetails) —

Details for moving a resolver, along with its protected default view and endpoints, into a different compartment.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

The If-Match header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is *, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.
:opc_retry_token (String) —

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/dns/dns_client.rb', line 137

def change_resolver_compartment(resolver_id, change_resolver_compartment_details, opts = {})
  logger.debug 'Calling operation DnsClient#change_resolver_compartment.' if logger

  raise "Missing the required parameter 'resolver_id' when calling change_resolver_compartment." if resolver_id.nil?
  raise "Missing the required parameter 'change_resolver_compartment_details' when calling change_resolver_compartment." if change_resolver_compartment_details.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'resolver_id' must not be blank" if OCI::Internal::Util.blank_string?(resolver_id)

  path = '/resolvers/{resolverId}/actions/changeCompartment'.sub('{resolverId}', resolver_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_resolver_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#change_resolver_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_steering_policy_compartment(steering_policy_id, change_steering_policy_compartment_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use change_steering_policy_compartment API.

Moves a steering policy into a different compartment.

Parameters:

steering_policy_id (String) —

The OCID of the target steering policy.
change_steering_policy_compartment_details (OCI::Dns::Models::ChangeSteeringPolicyCompartmentDetails) —

Details for moving a steering policy into a different compartment.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

The If-Match header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is *, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.
:opc_retry_token (String) —

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/dns/dns_client.rb', line 219

def change_steering_policy_compartment(steering_policy_id, change_steering_policy_compartment_details, opts = {})
  logger.debug 'Calling operation DnsClient#change_steering_policy_compartment.' if logger

  raise "Missing the required parameter 'steering_policy_id' when calling change_steering_policy_compartment." if steering_policy_id.nil?
  raise "Missing the required parameter 'change_steering_policy_compartment_details' when calling change_steering_policy_compartment." if change_steering_policy_compartment_details.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'steering_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(steering_policy_id)

  path = '/steeringPolicies/{steeringPolicyId}/actions/changeCompartment'.sub('{steeringPolicyId}', steering_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_steering_policy_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#change_steering_policy_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_tsig_key_compartment(tsig_key_id, change_tsig_key_compartment_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use change_tsig_key_compartment API.

Moves a TSIG key into a different compartment.

Parameters:

tsig_key_id (String) —

The OCID of the target TSIG key.
change_tsig_key_compartment_details (OCI::Dns::Models::ChangeTsigKeyCompartmentDetails) —

Details for moving a TSIG key into a different compartment.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

The If-Match header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is *, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.
:opc_retry_token (String) —

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/dns/dns_client.rb', line 301

def change_tsig_key_compartment(tsig_key_id, change_tsig_key_compartment_details, opts = {})
  logger.debug 'Calling operation DnsClient#change_tsig_key_compartment.' if logger

  raise "Missing the required parameter 'tsig_key_id' when calling change_tsig_key_compartment." if tsig_key_id.nil?
  raise "Missing the required parameter 'change_tsig_key_compartment_details' when calling change_tsig_key_compartment." if change_tsig_key_compartment_details.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'tsig_key_id' must not be blank" if OCI::Internal::Util.blank_string?(tsig_key_id)

  path = '/tsigKeys/{tsigKeyId}/actions/changeCompartment'.sub('{tsigKeyId}', tsig_key_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_tsig_key_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#change_tsig_key_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_view_compartment(view_id, change_view_compartment_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use change_view_compartment API.

Moves a view into a different compartment.

To change the compartment of a protected view, change the compartment of its corresponding resolver.

Parameters:

view_id (String) —

The OCID of the target view.
change_view_compartment_details (OCI::Dns::Models::ChangeViewCompartmentDetails) —

Details for moving a view into a different compartment.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

The If-Match header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is *, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.
:opc_retry_token (String) —

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/dns/dns_client.rb', line 385

def change_view_compartment(view_id, change_view_compartment_details, opts = {})
  logger.debug 'Calling operation DnsClient#change_view_compartment.' if logger

  raise "Missing the required parameter 'view_id' when calling change_view_compartment." if view_id.nil?
  raise "Missing the required parameter 'change_view_compartment_details' when calling change_view_compartment." if change_view_compartment_details.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'view_id' must not be blank" if OCI::Internal::Util.blank_string?(view_id)

  path = '/views/{viewId}/actions/changeCompartment'.sub('{viewId}', view_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_view_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#change_view_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_zone_compartment(zone_id, change_zone_compartment_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use change_zone_compartment API.

Moves a zone into a different compartment.

Protected zones cannot have their compartment changed. When the zone name is provided as a path parameter and PRIVATE is used for the scope query parameter then the viewId query parameter is required.

Note: All SteeringPolicyAttachment objects associated with this zone will also be moved into the provided compartment.

Parameters:

zone_id (String) —

The OCID of the target zone.
change_zone_compartment_details (OCI::Dns::Models::ChangeZoneCompartmentDetails) —

Details for moving a zone into a different compartment.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

The If-Match header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is *, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.
:opc_retry_token (String) —

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/dns/dns_client.rb', line 474

def change_zone_compartment(zone_id, change_zone_compartment_details, opts = {})
  logger.debug 'Calling operation DnsClient#change_zone_compartment.' if logger

  raise "Missing the required parameter 'zone_id' when calling change_zone_compartment." if zone_id.nil?
  raise "Missing the required parameter 'change_zone_compartment_details' when calling change_zone_compartment." if change_zone_compartment_details.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'zone_id' must not be blank" if OCI::Internal::Util.blank_string?(zone_id)

  path = '/zones/{zoneId}/actions/changeCompartment'.sub('{zoneId}', zone_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_zone_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#change_zone_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_resolver_endpoint(resolver_id, create_resolver_endpoint_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use create_resolver_endpoint API.

Creates a new resolver endpoint in the same compartment as the resolver.

Parameters:

resolver_id (String) —

The OCID of the target resolver.
create_resolver_endpoint_details (OCI::Dns::Models::CreateResolverEndpointDetails) —

Details for creating a new resolver endpoint.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:opc_retry_token (String) —

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type ResolverEndpoint

# File 'lib/oci/dns/dns_client.rb', line 550

def create_resolver_endpoint(resolver_id, create_resolver_endpoint_details, opts = {})
  logger.debug 'Calling operation DnsClient#create_resolver_endpoint.' if logger

  raise "Missing the required parameter 'resolver_id' when calling create_resolver_endpoint." if resolver_id.nil?
  raise "Missing the required parameter 'create_resolver_endpoint_details' when calling create_resolver_endpoint." if create_resolver_endpoint_details.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'resolver_id' must not be blank" if OCI::Internal::Util.blank_string?(resolver_id)

  path = '/resolvers/{resolverId}/endpoints'.sub('{resolverId}', resolver_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_resolver_endpoint_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#create_resolver_endpoint') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dns::Models::ResolverEndpoint'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_steering_policy(create_steering_policy_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use create_steering_policy API.

Creates a new steering policy in the specified compartment. For more information on creating policies with templates, see Traffic Management API Guide.

Parameters:

create_steering_policy_details (OCI::Dns::Models::CreateSteeringPolicyDetails) —

Details for creating a new steering policy.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:opc_retry_token (String) —

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type SteeringPolicy

# File 'lib/oci/dns/dns_client.rb', line 626

def create_steering_policy(create_steering_policy_details, opts = {})
  logger.debug 'Calling operation DnsClient#create_steering_policy.' if logger

  raise "Missing the required parameter 'create_steering_policy_details' when calling create_steering_policy." if create_steering_policy_details.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end

  path = '/steeringPolicies'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_steering_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#create_steering_policy') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dns::Models::SteeringPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_steering_policy_attachment(create_steering_policy_attachment_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use create_steering_policy_attachment API.

Creates a new attachment between a steering policy and a domain, giving the policy permission to answer queries for the specified domain. A steering policy must be attached to a domain for the policy to answer DNS queries for that domain.

For the purposes of access control, the attachment is automatically placed into the same compartment as the domain's zone.

Parameters:

create_steering_policy_attachment_details (OCI::Dns::Models::CreateSteeringPolicyAttachmentDetails) —

Details for creating a new steering policy attachment.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:opc_retry_token (String) —

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type SteeringPolicyAttachment

# File 'lib/oci/dns/dns_client.rb', line 704

def create_steering_policy_attachment(create_steering_policy_attachment_details, opts = {})
  logger.debug 'Calling operation DnsClient#create_steering_policy_attachment.' if logger

  raise "Missing the required parameter 'create_steering_policy_attachment_details' when calling create_steering_policy_attachment." if create_steering_policy_attachment_details.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end

  path = '/steeringPolicyAttachments'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_steering_policy_attachment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#create_steering_policy_attachment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dns::Models::SteeringPolicyAttachment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_tsig_key(create_tsig_key_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use create_tsig_key API.

Creates a new TSIG key in the specified compartment. There is no opc-retry-token header since TSIG key names must be globally unique.

Parameters:

create_tsig_key_details (OCI::Dns::Models::CreateTsigKeyDetails) —

Details for creating a new TSIG key.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type TsigKey

# File 'lib/oci/dns/dns_client.rb', line 771

def create_tsig_key(create_tsig_key_details, opts = {})
  logger.debug 'Calling operation DnsClient#create_tsig_key.' if logger

  raise "Missing the required parameter 'create_tsig_key_details' when calling create_tsig_key." if create_tsig_key_details.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end

  path = '/tsigKeys'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(create_tsig_key_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#create_tsig_key') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dns::Models::TsigKey'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_view(create_view_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use create_view API.

Creates a new view in the specified compartment.

Parameters:

create_view_details (OCI::Dns::Models::CreateViewDetails) —

Details for creating a new view.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:opc_retry_token (String) —

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type View

# File 'lib/oci/dns/dns_client.rb', line 842

def create_view(create_view_details, opts = {})
  logger.debug 'Calling operation DnsClient#create_view.' if logger

  raise "Missing the required parameter 'create_view_details' when calling create_view." if create_view_details.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end

  path = '/views'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_view_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#create_view') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dns::Models::View'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_zone(create_zone_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use create_zone API.

Creates a new zone in the specified compartment.

Private zones must have a zone type of PRIMARY. Creating a private zone at or under oraclevcn.com within the default protected view of a VCN-dedicated resolver is not permitted.

Parameters:

create_zone_details (OCI::Dns::Models::CreateZoneBaseDetails) —

Details for creating a new zone.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:compartment_id (String) —

The OCID of the compartment the zone belongs to.

This parameter is deprecated and should be omitted.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.
:view_id (String) —

The OCID of the view the resource is associated with.

Returns:

(Response) —

A Response object with data of type Zone

# File 'lib/oci/dns/dns_client.rb', line 916

def create_zone(create_zone_details, opts = {})
  logger.debug 'Calling operation DnsClient#create_zone.' if logger

  raise "Missing the required parameter 'create_zone_details' when calling create_zone." if create_zone_details.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end

  path = '/zones'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:scope] = opts[:scope] if opts[:scope]
  query_params[:viewId] = opts[:view_id] if opts[:view_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(create_zone_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#create_zone') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dns::Models::Zone'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_zone_from_zone_file(compartment_id, create_zone_from_zone_file_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use create_zone_from_zone_file API.

Creates a new zone from a zone file in the specified compartment. Not supported for private zones.

Parameters:

compartment_id (String) —

The OCID of the compartment the resource belongs to.
create_zone_from_zone_file_details (String, IO) —

The zone file contents.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.
:view_id (String) —

The OCID of the view the resource is associated with.

Returns:

(Response) —

A Response object with data of type Zone

# File 'lib/oci/dns/dns_client.rb', line 984

def create_zone_from_zone_file(compartment_id, create_zone_from_zone_file_details, opts = {})
  logger.debug 'Calling operation DnsClient#create_zone_from_zone_file.' if logger

  raise "Missing the required parameter 'compartment_id' when calling create_zone_from_zone_file." if compartment_id.nil?
  raise "Missing the required parameter 'create_zone_from_zone_file_details' when calling create_zone_from_zone_file." if create_zone_from_zone_file_details.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end

  path = '/actions/createZoneFromZoneFile'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:scope] = opts[:scope] if opts[:scope]
  query_params[:viewId] = opts[:view_id] if opts[:view_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'content-type'] ||= 'application/octet-stream'

  post_body = @api_client.object_to_http_body(create_zone_from_zone_file_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#create_zone_from_zone_file') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dns::Models::Zone'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_domain_records(zone_name_or_id, domain, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use delete_domain_records API.

Deletes all records at the specified zone and domain.

When the zone name is provided as a path parameter and PRIVATE is used for the scope query parameter then the viewId query parameter is required.

Parameters:

zone_name_or_id (String) —

The name or OCID of the target zone.
domain (String) —

The target fully-qualified domain name (FQDN) within the target zone.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

The If-Match header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is *, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.
:if_unmodified_since (String) —

The If-Unmodified-Since header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.
:view_id (String) —

The OCID of the view the zone is associated with. Required when accessing a private zone by name.
:compartment_id (String) —

The OCID of the compartment the zone belongs to.

This parameter is deprecated and should be omitted.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/dns/dns_client.rb', line 1072

def delete_domain_records(zone_name_or_id, domain, opts = {})
  logger.debug 'Calling operation DnsClient#delete_domain_records.' if logger

  raise "Missing the required parameter 'zone_name_or_id' when calling delete_domain_records." if zone_name_or_id.nil?
  raise "Missing the required parameter 'domain' when calling delete_domain_records." if domain.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'zone_name_or_id' must not be blank" if OCI::Internal::Util.blank_string?(zone_name_or_id)
  raise "Parameter value for 'domain' must not be blank" if OCI::Internal::Util.blank_string?(domain)

  path = '/zones/{zoneNameOrId}/records/{domain}'.sub('{zoneNameOrId}', zone_name_or_id.to_s).sub('{domain}', domain.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]
  query_params[:viewId] = opts[:view_id] if opts[:view_id]
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'if-unmodified-since'] = opts[:if_unmodified_since] if opts[:if_unmodified_since]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#delete_domain_records') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_resolver_endpoint(resolver_id, resolver_endpoint_name, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use delete_resolver_endpoint API.

Deletes the specified resolver endpoint.

Note that attempting to delete a resolver endpoint in the DELETED lifecycle state will result in a 404 response to be consistent with other operations of the API. Resolver endpoints may not be deleted if they are referenced by a resolver rule.

Parameters:

resolver_id (String) —

The OCID of the target resolver.
resolver_endpoint_name (String) —

The name of the target resolver endpoint.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

The If-Match header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is *, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.
:if_unmodified_since (String) —

The If-Unmodified-Since header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/dns/dns_client.rb', line 1159

def delete_resolver_endpoint(resolver_id, resolver_endpoint_name, opts = {})
  logger.debug 'Calling operation DnsClient#delete_resolver_endpoint.' if logger

  raise "Missing the required parameter 'resolver_id' when calling delete_resolver_endpoint." if resolver_id.nil?
  raise "Missing the required parameter 'resolver_endpoint_name' when calling delete_resolver_endpoint." if resolver_endpoint_name.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'resolver_id' must not be blank" if OCI::Internal::Util.blank_string?(resolver_id)
  raise "Parameter value for 'resolver_endpoint_name' must not be blank" if OCI::Internal::Util.blank_string?(resolver_endpoint_name)

  path = '/resolvers/{resolverId}/endpoints/{resolverEndpointName}'.sub('{resolverId}', resolver_id.to_s).sub('{resolverEndpointName}', resolver_endpoint_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'if-unmodified-since'] = opts[:if_unmodified_since] if opts[:if_unmodified_since]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#delete_resolver_endpoint') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_rr_set(zone_name_or_id, domain, rtype, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use delete_rr_set API.

Deletes all records in the specified RRSet.

When the zone name is provided as a path parameter and PRIVATE is used for the scope query parameter then the viewId query parameter is required.

Parameters:

zone_name_or_id (String) —

The name or OCID of the target zone.
domain (String) —

The target fully-qualified domain name (FQDN) within the target zone.
rtype (String) —

The type of the target RRSet within the target zone.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

The If-Match header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is *, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.
:if_unmodified_since (String) —

The If-Unmodified-Since header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:compartment_id (String) —

The OCID of the compartment the zone belongs to.

This parameter is deprecated and should be omitted.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.
:view_id (String) —

The OCID of the view the zone is associated with. Required when accessing a private zone by name.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/dns/dns_client.rb', line 1249

def delete_rr_set(zone_name_or_id, domain, rtype, opts = {})
  logger.debug 'Calling operation DnsClient#delete_rr_set.' if logger

  raise "Missing the required parameter 'zone_name_or_id' when calling delete_rr_set." if zone_name_or_id.nil?
  raise "Missing the required parameter 'domain' when calling delete_rr_set." if domain.nil?
  raise "Missing the required parameter 'rtype' when calling delete_rr_set." if rtype.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'zone_name_or_id' must not be blank" if OCI::Internal::Util.blank_string?(zone_name_or_id)
  raise "Parameter value for 'domain' must not be blank" if OCI::Internal::Util.blank_string?(domain)
  raise "Parameter value for 'rtype' must not be blank" if OCI::Internal::Util.blank_string?(rtype)

  path = '/zones/{zoneNameOrId}/records/{domain}/{rtype}'.sub('{zoneNameOrId}', zone_name_or_id.to_s).sub('{domain}', domain.to_s).sub('{rtype}', rtype.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:scope] = opts[:scope] if opts[:scope]
  query_params[:viewId] = opts[:view_id] if opts[:view_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'if-unmodified-since'] = opts[:if_unmodified_since] if opts[:if_unmodified_since]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#delete_rr_set') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_steering_policy(steering_policy_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use delete_steering_policy API.

Deletes the specified steering policy.

A 204 response indicates that the delete has been successful. Deletion will fail if the policy is attached to any zones. To detach a policy from a zone, see DeleteSteeringPolicyAttachment.

Parameters:

steering_policy_id (String) —

The OCID of the target steering policy.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

The If-Match header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is *, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.
:if_unmodified_since (String) —

The If-Unmodified-Since header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/dns/dns_client.rb', line 1337

def delete_steering_policy(steering_policy_id, opts = {})
  logger.debug 'Calling operation DnsClient#delete_steering_policy.' if logger

  raise "Missing the required parameter 'steering_policy_id' when calling delete_steering_policy." if steering_policy_id.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'steering_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(steering_policy_id)

  path = '/steeringPolicies/{steeringPolicyId}'.sub('{steeringPolicyId}', steering_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'if-unmodified-since'] = opts[:if_unmodified_since] if opts[:if_unmodified_since]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#delete_steering_policy') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_steering_policy_attachment(steering_policy_attachment_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use delete_steering_policy_attachment API.

Deletes the specified steering policy attachment. A 204 response indicates that the delete has been successful.

Parameters:

steering_policy_attachment_id (String) —

The OCID of the target steering policy attachment.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

The If-Match header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is *, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.
:if_unmodified_since (String) —

The If-Unmodified-Since header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/dns/dns_client.rb', line 1416

def delete_steering_policy_attachment(steering_policy_attachment_id, opts = {})
  logger.debug 'Calling operation DnsClient#delete_steering_policy_attachment.' if logger

  raise "Missing the required parameter 'steering_policy_attachment_id' when calling delete_steering_policy_attachment." if steering_policy_attachment_id.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'steering_policy_attachment_id' must not be blank" if OCI::Internal::Util.blank_string?(steering_policy_attachment_id)

  path = '/steeringPolicyAttachments/{steeringPolicyAttachmentId}'.sub('{steeringPolicyAttachmentId}', steering_policy_attachment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'if-unmodified-since'] = opts[:if_unmodified_since] if opts[:if_unmodified_since]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#delete_steering_policy_attachment') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_tsig_key(tsig_key_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use delete_tsig_key API.

Deletes the specified TSIG key.

Parameters:

tsig_key_id (String) —

The OCID of the target TSIG key.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

The If-Match header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is *, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.
:if_unmodified_since (String) —

The If-Unmodified-Since header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/dns/dns_client.rb', line 1494

def delete_tsig_key(tsig_key_id, opts = {})
  logger.debug 'Calling operation DnsClient#delete_tsig_key.' if logger

  raise "Missing the required parameter 'tsig_key_id' when calling delete_tsig_key." if tsig_key_id.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'tsig_key_id' must not be blank" if OCI::Internal::Util.blank_string?(tsig_key_id)

  path = '/tsigKeys/{tsigKeyId}'.sub('{tsigKeyId}', tsig_key_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'if-unmodified-since'] = opts[:if_unmodified_since] if opts[:if_unmodified_since]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#delete_tsig_key') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_view(view_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use delete_view API.

Deletes the specified view.

Note that attempting to delete a view in the DELETED lifecycleState will result in a 404 response to be consistent with other operations of the API. Views cannot be deleted if they are referenced by non-deleted zones or resolvers. Protected views cannot be deleted.

Parameters:

view_id (String) —

The OCID of the target view.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

The If-Match header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is *, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.
:if_unmodified_since (String) —

The If-Unmodified-Since header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/dns/dns_client.rb', line 1577

def delete_view(view_id, opts = {})
  logger.debug 'Calling operation DnsClient#delete_view.' if logger

  raise "Missing the required parameter 'view_id' when calling delete_view." if view_id.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'view_id' must not be blank" if OCI::Internal::Util.blank_string?(view_id)

  path = '/views/{viewId}'.sub('{viewId}', view_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'if-unmodified-since'] = opts[:if_unmodified_since] if opts[:if_unmodified_since]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#delete_view') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_zone(zone_name_or_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use delete_zone API.

Deletes the specified zone and all its steering policy attachments.

A 204 response indicates that the zone has been successfully deleted. Protected zones cannot be deleted. When the zone name is provided as a path parameter and PRIVATE is used for the scope query parameter then the viewId query parameter is required.

Parameters:

zone_name_or_id (String) —

The name or OCID of the target zone.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

The If-Match header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is *, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.
:if_unmodified_since (String) —

The If-Unmodified-Since header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.
:view_id (String) —

The OCID of the view the zone is associated with. Required when accessing a private zone by name.
:compartment_id (String) —

The OCID of the compartment the zone belongs to.

This parameter is deprecated and should be omitted.

Returns:

(Response) —

A Response object with data of type nil

# File 'lib/oci/dns/dns_client.rb', line 1664

def delete_zone(zone_name_or_id, opts = {})
  logger.debug 'Calling operation DnsClient#delete_zone.' if logger

  raise "Missing the required parameter 'zone_name_or_id' when calling delete_zone." if zone_name_or_id.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'zone_name_or_id' must not be blank" if OCI::Internal::Util.blank_string?(zone_name_or_id)

  path = '/zones/{zoneNameOrId}'.sub('{zoneNameOrId}', zone_name_or_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]
  query_params[:viewId] = opts[:view_id] if opts[:view_id]
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'if-unmodified-since'] = opts[:if_unmodified_since] if opts[:if_unmodified_since]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#delete_zone') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_domain_records(zone_name_or_id, domain, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use get_domain_records API.

Gets a list of all records at the specified zone and domain.

The results are sorted by rtype in alphabetical order by default. You can optionally filter and/or sort the results using the listed parameters. When the zone name is provided as a path parameter and PRIVATE is used for the scope query parameter then the viewId query parameter is required.

Parameters:

zone_name_or_id (String) —

The name or OCID of the target zone.
domain (String) —

The target fully-qualified domain name (FQDN) within the target zone.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_none_match (String) —

The If-None-Match header field makes the request method conditional on the absence of any current representation of the target resource, when the field-value is *, or having a selected representation with an entity-tag that does not match any of those listed in the field-value.
:if_modified_since (String) —

The If-Modified-Since header field makes a GET or HEAD request method conditional on the selected representation's modification date being more recent than the date provided in the field-value. Transfer of the selected representation's data is avoided if that data has not changed.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:limit (Integer) —

The maximum number of items to return in a page of the collection. (default to 50)
:page (String) —

The value of the opc-next-page response header from the previous "List" call.
:zone_version (String) —

The version of the zone for which data is requested.
:rtype (String) —

Search by record type. Will match any record whose type (case-insensitive) equals the provided value.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.
:view_id (String) —

The OCID of the view the zone is associated with. Required when accessing a private zone by name.
:sort_by (String) —

The field by which to sort records. (default to rtype) Allowed values are: rtype, ttl
:sort_order (String) —

The order to sort the resources. (default to ASC)
:compartment_id (String) —

The OCID of the compartment the zone belongs to.

This parameter is deprecated and should be omitted.

Returns:

(Response) —

A Response object with data of type RecordCollection

# File 'lib/oci/dns/dns_client.rb', line 1765

def get_domain_records(zone_name_or_id, domain, opts = {})
  logger.debug 'Calling operation DnsClient#get_domain_records.' if logger

  raise "Missing the required parameter 'zone_name_or_id' when calling get_domain_records." if zone_name_or_id.nil?
  raise "Missing the required parameter 'domain' when calling get_domain_records." if domain.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end

  if opts[:sort_by] && !%w[rtype ttl].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of rtype, ttl.'
  end

  if opts[:sort_order] && !OCI::Dns::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Dns::Models::SORT_ORDER_ENUM.'
  end
  raise "Parameter value for 'zone_name_or_id' must not be blank" if OCI::Internal::Util.blank_string?(zone_name_or_id)
  raise "Parameter value for 'domain' must not be blank" if OCI::Internal::Util.blank_string?(domain)

  path = '/zones/{zoneNameOrId}/records/{domain}'.sub('{zoneNameOrId}', zone_name_or_id.to_s).sub('{domain}', domain.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:zoneVersion] = opts[:zone_version] if opts[:zone_version]
  query_params[:rtype] = opts[:rtype] if opts[:rtype]
  query_params[:scope] = opts[:scope] if opts[:scope]
  query_params[:viewId] = opts[:view_id] if opts[:view_id]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match]
  header_params[:'if-modified-since'] = opts[:if_modified_since] if opts[:if_modified_since]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#get_domain_records') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dns::Models::RecordCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_resolver(resolver_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use get_resolver API.

Gets information about a specific resolver.

Note that attempting to get a resolver in the DELETED lifecycleState will result in a 404 response to be consistent with other operations of the API.

Parameters:

resolver_id (String) —

The OCID of the target resolver.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_modified_since (String) —

The If-Modified-Since header field makes a GET or HEAD request method conditional on the selected representation's modification date being more recent than the date provided in the field-value. Transfer of the selected representation's data is avoided if that data has not changed.
:if_none_match (String) —

The If-None-Match header field makes the request method conditional on the absence of any current representation of the target resource, when the field-value is *, or having a selected representation with an entity-tag that does not match any of those listed in the field-value.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type Resolver

# File 'lib/oci/dns/dns_client.rb', line 1863

def get_resolver(resolver_id, opts = {})
  logger.debug 'Calling operation DnsClient#get_resolver.' if logger

  raise "Missing the required parameter 'resolver_id' when calling get_resolver." if resolver_id.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'resolver_id' must not be blank" if OCI::Internal::Util.blank_string?(resolver_id)

  path = '/resolvers/{resolverId}'.sub('{resolverId}', resolver_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-modified-since'] = opts[:if_modified_since] if opts[:if_modified_since]
  header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#get_resolver') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dns::Models::Resolver'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_resolver_endpoint(resolver_id, resolver_endpoint_name, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use get_resolver_endpoint API.

Gets information about a specific resolver endpoint.

Note that attempting to get a resolver endpoint in the DELETED lifecycle state will result in a 404 response to be consistent with other operations of the API.

Parameters:

resolver_id (String) —

The OCID of the target resolver.
resolver_endpoint_name (String) —

The name of the target resolver endpoint.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_modified_since (String) —

The If-Modified-Since header field makes a GET or HEAD request method conditional on the selected representation's modification date being more recent than the date provided in the field-value. Transfer of the selected representation's data is avoided if that data has not changed.
:if_none_match (String) —

The If-None-Match header field makes the request method conditional on the absence of any current representation of the target resource, when the field-value is *, or having a selected representation with an entity-tag that does not match any of those listed in the field-value.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type ResolverEndpoint

# File 'lib/oci/dns/dns_client.rb', line 1944

def get_resolver_endpoint(resolver_id, resolver_endpoint_name, opts = {})
  logger.debug 'Calling operation DnsClient#get_resolver_endpoint.' if logger

  raise "Missing the required parameter 'resolver_id' when calling get_resolver_endpoint." if resolver_id.nil?
  raise "Missing the required parameter 'resolver_endpoint_name' when calling get_resolver_endpoint." if resolver_endpoint_name.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'resolver_id' must not be blank" if OCI::Internal::Util.blank_string?(resolver_id)
  raise "Parameter value for 'resolver_endpoint_name' must not be blank" if OCI::Internal::Util.blank_string?(resolver_endpoint_name)

  path = '/resolvers/{resolverId}/endpoints/{resolverEndpointName}'.sub('{resolverId}', resolver_id.to_s).sub('{resolverEndpointName}', resolver_endpoint_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-modified-since'] = opts[:if_modified_since] if opts[:if_modified_since]
  header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#get_resolver_endpoint') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dns::Models::ResolverEndpoint'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_rr_set(zone_name_or_id, domain, rtype, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use get_rr_set API.

Gets a list of all records in the specified RRSet.

The results are sorted by recordHash by default. When the zone name is provided as a path parameter and PRIVATE is used for the scope query parameter then the viewId query parameter is required.

Parameters:

zone_name_or_id (String) —

The name or OCID of the target zone.
domain (String) —

The target fully-qualified domain name (FQDN) within the target zone.
rtype (String) —

The type of the target RRSet within the target zone.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_none_match (String) —

The If-None-Match header field makes the request method conditional on the absence of any current representation of the target resource, when the field-value is *, or having a selected representation with an entity-tag that does not match any of those listed in the field-value.
:if_modified_since (String) —

The If-Modified-Since header field makes a GET or HEAD request method conditional on the selected representation's modification date being more recent than the date provided in the field-value. Transfer of the selected representation's data is avoided if that data has not changed.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:limit (Integer) —

The maximum number of items to return in a page of the collection. (default to 50)
:page (String) —

The value of the opc-next-page response header from the previous "List" call.
:zone_version (String) —

The version of the zone for which data is requested.
:compartment_id (String) —

The OCID of the compartment the zone belongs to.

This parameter is deprecated and should be omitted.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.
:view_id (String) —

The OCID of the view the zone is associated with. Required when accessing a private zone by name.

Returns:

(Response) —

A Response object with data of type RRSet

# File 'lib/oci/dns/dns_client.rb', line 2039

def get_rr_set(zone_name_or_id, domain, rtype, opts = {})
  logger.debug 'Calling operation DnsClient#get_rr_set.' if logger

  raise "Missing the required parameter 'zone_name_or_id' when calling get_rr_set." if zone_name_or_id.nil?
  raise "Missing the required parameter 'domain' when calling get_rr_set." if domain.nil?
  raise "Missing the required parameter 'rtype' when calling get_rr_set." if rtype.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'zone_name_or_id' must not be blank" if OCI::Internal::Util.blank_string?(zone_name_or_id)
  raise "Parameter value for 'domain' must not be blank" if OCI::Internal::Util.blank_string?(domain)
  raise "Parameter value for 'rtype' must not be blank" if OCI::Internal::Util.blank_string?(rtype)

  path = '/zones/{zoneNameOrId}/records/{domain}/{rtype}'.sub('{zoneNameOrId}', zone_name_or_id.to_s).sub('{domain}', domain.to_s).sub('{rtype}', rtype.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:zoneVersion] = opts[:zone_version] if opts[:zone_version]
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:scope] = opts[:scope] if opts[:scope]
  query_params[:viewId] = opts[:view_id] if opts[:view_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match]
  header_params[:'if-modified-since'] = opts[:if_modified_since] if opts[:if_modified_since]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#get_rr_set') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dns::Models::RRSet'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_steering_policy(steering_policy_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use get_steering_policy API.

Gets information about the specified steering policy.

Parameters:

steering_policy_id (String) —

The OCID of the target steering policy.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_none_match (String) —

The If-None-Match header field makes the request method conditional on the absence of any current representation of the target resource, when the field-value is *, or having a selected representation with an entity-tag that does not match any of those listed in the field-value.
:if_modified_since (String) —

The If-Modified-Since header field makes a GET or HEAD request method conditional on the selected representation's modification date being more recent than the date provided in the field-value. Transfer of the selected representation's data is avoided if that data has not changed.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type SteeringPolicy

# File 'lib/oci/dns/dns_client.rb', line 2125

def get_steering_policy(steering_policy_id, opts = {})
  logger.debug 'Calling operation DnsClient#get_steering_policy.' if logger

  raise "Missing the required parameter 'steering_policy_id' when calling get_steering_policy." if steering_policy_id.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'steering_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(steering_policy_id)

  path = '/steeringPolicies/{steeringPolicyId}'.sub('{steeringPolicyId}', steering_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match]
  header_params[:'if-modified-since'] = opts[:if_modified_since] if opts[:if_modified_since]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#get_steering_policy') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dns::Models::SteeringPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_steering_policy_attachment(steering_policy_attachment_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use get_steering_policy_attachment API.

Gets information about the specified steering policy attachment.

Parameters:

steering_policy_attachment_id (String) —

The OCID of the target steering policy attachment.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_none_match (String) —

The If-None-Match header field makes the request method conditional on the absence of any current representation of the target resource, when the field-value is *, or having a selected representation with an entity-tag that does not match any of those listed in the field-value.
:if_modified_since (String) —

The If-Modified-Since header field makes a GET or HEAD request method conditional on the selected representation's modification date being more recent than the date provided in the field-value. Transfer of the selected representation's data is avoided if that data has not changed.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type SteeringPolicyAttachment

# File 'lib/oci/dns/dns_client.rb', line 2202

def get_steering_policy_attachment(steering_policy_attachment_id, opts = {})
  logger.debug 'Calling operation DnsClient#get_steering_policy_attachment.' if logger

  raise "Missing the required parameter 'steering_policy_attachment_id' when calling get_steering_policy_attachment." if steering_policy_attachment_id.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'steering_policy_attachment_id' must not be blank" if OCI::Internal::Util.blank_string?(steering_policy_attachment_id)

  path = '/steeringPolicyAttachments/{steeringPolicyAttachmentId}'.sub('{steeringPolicyAttachmentId}', steering_policy_attachment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match]
  header_params[:'if-modified-since'] = opts[:if_modified_since] if opts[:if_modified_since]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#get_steering_policy_attachment') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dns::Models::SteeringPolicyAttachment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_tsig_key(tsig_key_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use get_tsig_key API.

Gets information about the specified TSIG key.

Parameters:

tsig_key_id (String) —

The OCID of the target TSIG key.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_none_match (String) —

The If-None-Match header field makes the request method conditional on the absence of any current representation of the target resource, when the field-value is *, or having a selected representation with an entity-tag that does not match any of those listed in the field-value.
:if_modified_since (String) —

The If-Modified-Since header field makes a GET or HEAD request method conditional on the selected representation's modification date being more recent than the date provided in the field-value. Transfer of the selected representation's data is avoided if that data has not changed.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type TsigKey

# File 'lib/oci/dns/dns_client.rb', line 2279

def get_tsig_key(tsig_key_id, opts = {})
  logger.debug 'Calling operation DnsClient#get_tsig_key.' if logger

  raise "Missing the required parameter 'tsig_key_id' when calling get_tsig_key." if tsig_key_id.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'tsig_key_id' must not be blank" if OCI::Internal::Util.blank_string?(tsig_key_id)

  path = '/tsigKeys/{tsigKeyId}'.sub('{tsigKeyId}', tsig_key_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match]
  header_params[:'if-modified-since'] = opts[:if_modified_since] if opts[:if_modified_since]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#get_tsig_key') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dns::Models::TsigKey'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_view(view_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use get_view API.

Gets information about a specific view.

Note that attempting to get a view in the DELETED lifecycleState will result in a 404 response to be consistent with other operations of the API.

Parameters:

view_id (String) —

The OCID of the target view.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_modified_since (String) —

The If-Modified-Since header field makes a GET or HEAD request method conditional on the selected representation's modification date being more recent than the date provided in the field-value. Transfer of the selected representation's data is avoided if that data has not changed.
:if_none_match (String) —

The If-None-Match header field makes the request method conditional on the absence of any current representation of the target resource, when the field-value is *, or having a selected representation with an entity-tag that does not match any of those listed in the field-value.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type View

# File 'lib/oci/dns/dns_client.rb', line 2360

def get_view(view_id, opts = {})
  logger.debug 'Calling operation DnsClient#get_view.' if logger

  raise "Missing the required parameter 'view_id' when calling get_view." if view_id.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'view_id' must not be blank" if OCI::Internal::Util.blank_string?(view_id)

  path = '/views/{viewId}'.sub('{viewId}', view_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-modified-since'] = opts[:if_modified_since] if opts[:if_modified_since]
  header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#get_view') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dns::Models::View'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_zone(zone_name_or_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use get_zone API.

Gets information about the specified zone, including its creation date, zone type, and serial.

When the zone name is provided as a path parameter and PRIVATE is used for the scope query parameter then the viewId query parameter is required.

Parameters:

zone_name_or_id (String) —

The name or OCID of the target zone.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_none_match (String) —

The If-None-Match header field makes the request method conditional on the absence of any current representation of the target resource, when the field-value is *, or having a selected representation with an entity-tag that does not match any of those listed in the field-value.
:if_modified_since (String) —

The If-Modified-Since header field makes a GET or HEAD request method conditional on the selected representation's modification date being more recent than the date provided in the field-value. Transfer of the selected representation's data is avoided if that data has not changed.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.
:view_id (String) —

The OCID of the view the zone is associated with. Required when accessing a private zone by name.
:compartment_id (String) —

The OCID of the compartment the zone belongs to.

This parameter is deprecated and should be omitted.

Returns:

(Response) —

A Response object with data of type Zone

# File 'lib/oci/dns/dns_client.rb', line 2445

def get_zone(zone_name_or_id, opts = {})
  logger.debug 'Calling operation DnsClient#get_zone.' if logger

  raise "Missing the required parameter 'zone_name_or_id' when calling get_zone." if zone_name_or_id.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'zone_name_or_id' must not be blank" if OCI::Internal::Util.blank_string?(zone_name_or_id)

  path = '/zones/{zoneNameOrId}'.sub('{zoneNameOrId}', zone_name_or_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]
  query_params[:viewId] = opts[:view_id] if opts[:view_id]
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match]
  header_params[:'if-modified-since'] = opts[:if_modified_since] if opts[:if_modified_since]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#get_zone') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dns::Models::Zone'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_zone_content(zone_name_or_id, opts = {}, &block) ⇒ `Response`

Note:

Click here to see an example of how to use get_zone_content API.

Gets the requested zone's zone file.

Parameters:

zone_name_or_id (String) —

The name or OCID of the target zone.
opts (Hash) (defaults to: {}) —

the optional parameters
[Block] (Hash) —

a customizable set of options

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_none_match (String) —

The If-None-Match header field makes the request method conditional on the absence of any current representation of the target resource, when the field-value is *, or having a selected representation with an entity-tag that does not match any of those listed in the field-value.
:if_modified_since (String) —

The If-Modified-Since header field makes a GET or HEAD request method conditional on the selected representation's modification date being more recent than the date provided in the field-value. Transfer of the selected representation's data is avoided if that data has not changed.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.
:view_id (String) —

The OCID of the view the zone is associated with. Required when accessing a private zone by name.
:response_target (String, IO) —

Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

(Response) —

A Response object with data of type String if response_target and block are not given, otherwise with nil data

# File 'lib/oci/dns/dns_client.rb', line 2527

def get_zone_content(zone_name_or_id, opts = {}, &block)
  logger.debug 'Calling operation DnsClient#get_zone_content.' if logger

  raise "Missing the required parameter 'zone_name_or_id' when calling get_zone_content." if zone_name_or_id.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'zone_name_or_id' must not be blank" if OCI::Internal::Util.blank_string?(zone_name_or_id)

  path = '/zones/{zoneNameOrId}/content'.sub('{zoneNameOrId}', zone_name_or_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]
  query_params[:viewId] = opts[:view_id] if opts[:view_id]

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'text/dns'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match]
  header_params[:'if-modified-since'] = opts[:if_modified_since] if opts[:if_modified_since]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#get_zone_content') do
    if !block.nil?
      @api_client.call_api(
        :GET,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @api_client.call_api(
          :GET,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :GET,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :GET,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#get_zone_records(zone_name_or_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use get_zone_records API.

Gets all records in the specified zone.

The results are sorted by domain in alphabetical order by default. For more information about records, see Resource Record (RR) TYPEs. When the zone name is provided as a path parameter and PRIVATE is used for the scope query parameter then the viewId query parameter is required.

Parameters:

zone_name_or_id (String) —

The name or OCID of the target zone.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_none_match (String) —

The If-None-Match header field makes the request method conditional on the absence of any current representation of the target resource, when the field-value is *, or having a selected representation with an entity-tag that does not match any of those listed in the field-value.
:if_modified_since (String) —

The If-Modified-Since header field makes a GET or HEAD request method conditional on the selected representation's modification date being more recent than the date provided in the field-value. Transfer of the selected representation's data is avoided if that data has not changed.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:limit (Integer) —

The maximum number of items to return in a page of the collection. (default to 50)
:page (String) —

The value of the opc-next-page response header from the previous "List" call.
:zone_version (String) —

The version of the zone for which data is requested.
:domain (String) —

Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.
:domain_contains (String) —

Search by domain. Will match any record whose domain (case-insensitive) contains the provided value.
:rtype (String) —

Search by record type. Will match any record whose type (case-insensitive) equals the provided value.
:sort_by (String) —

The field by which to sort records. (default to domain) Allowed values are: domain, rtype, ttl
:sort_order (String) —

The order to sort the resources. (default to ASC)
:compartment_id (String) —

The OCID of the compartment the zone belongs to.

This parameter is deprecated and should be omitted.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.
:view_id (String) —

The OCID of the view the zone is associated with. Required when accessing a private zone by name.

Returns:

(Response) —

A Response object with data of type RecordCollection

# File 'lib/oci/dns/dns_client.rb', line 2678

def get_zone_records(zone_name_or_id, opts = {})
  logger.debug 'Calling operation DnsClient#get_zone_records.' if logger

  raise "Missing the required parameter 'zone_name_or_id' when calling get_zone_records." if zone_name_or_id.nil?

  if opts[:sort_by] && !%w[domain rtype ttl].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of domain, rtype, ttl.'
  end

  if opts[:sort_order] && !OCI::Dns::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Dns::Models::SORT_ORDER_ENUM.'
  end

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'zone_name_or_id' must not be blank" if OCI::Internal::Util.blank_string?(zone_name_or_id)

  path = '/zones/{zoneNameOrId}/records'.sub('{zoneNameOrId}', zone_name_or_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:zoneVersion] = opts[:zone_version] if opts[:zone_version]
  query_params[:domain] = opts[:domain] if opts[:domain]
  query_params[:domainContains] = opts[:domain_contains] if opts[:domain_contains]
  query_params[:rtype] = opts[:rtype] if opts[:rtype]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:scope] = opts[:scope] if opts[:scope]
  query_params[:viewId] = opts[:view_id] if opts[:view_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match]
  header_params[:'if-modified-since'] = opts[:if_modified_since] if opts[:if_modified_since]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#get_zone_records') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dns::Models::RecordCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_resolver_endpoints(resolver_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use list_resolver_endpoints API.

Gets a list of all endpoints within a resolver. The collection can be filtered by name or lifecycle state. It can be sorted on creation time or name both in ASC or DESC order. Note that when no lifecycleState query parameter is provided, the collection does not include resolver endpoints in the DELETED lifecycle state to be consistent with other operations of the API.

Parameters:

resolver_id (String) —

The OCID of the target resolver.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:name (String) —

The name of a resource.
:page (String) —

The value of the opc-next-page response header from the previous "List" call.
:limit (Integer) —

The maximum number of items to return in a page of the collection. (default to 50)
:sort_order (String) —

The order to sort the resources. (default to DESC)
:sort_by (String) —

The field by which to sort resolver endpoints. (default to timeCreated) Allowed values are: name, timeCreated
:lifecycle_state (String) —

The state of a resource.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type Array<ResolverEndpointSummary>

# File 'lib/oci/dns/dns_client.rb', line 2776

def list_resolver_endpoints(resolver_id, opts = {})
  logger.debug 'Calling operation DnsClient#list_resolver_endpoints.' if logger

  raise "Missing the required parameter 'resolver_id' when calling list_resolver_endpoints." if resolver_id.nil?

  if opts[:sort_order] && !OCI::Dns::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Dns::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[name timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of name, timeCreated.'
  end

  if opts[:lifecycle_state] && !OCI::Dns::Models::ResolverEndpointSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Dns::Models::ResolverEndpointSummary::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'resolver_id' must not be blank" if OCI::Internal::Util.blank_string?(resolver_id)

  path = '/resolvers/{resolverId}/endpoints'.sub('{resolverId}', resolver_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#list_resolver_endpoints') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Dns::Models::ResolverEndpointSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_resolvers(compartment_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use list_resolvers API.

Gets a list of all resolvers within a compartment.

The collection can be filtered by display name, id, or lifecycle state. It can be sorted on creation time or displayName both in ASC or DESC order. Note that when no lifecycleState query parameter is provided, the collection does not include resolvers in the DELETED lifecycleState to be consistent with other operations of the API.

Parameters:

compartment_id (String) —

The OCID of the compartment the resource belongs to.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:display_name (String) —

The displayName of a resource.
:id (String) —

The OCID of a resource.
:page (String) —

The value of the opc-next-page response header from the previous "List" call.
:limit (Integer) —

The maximum number of items to return in a page of the collection. (default to 50)
:sort_order (String) —

The order to sort the resources. (default to DESC)
:sort_by (String) —

The field by which to sort resolvers. (default to timeCreated) Allowed values are: displayName, timeCreated
:lifecycle_state (String) —

The state of a resource.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type Array<ResolverSummary>

# File 'lib/oci/dns/dns_client.rb', line 2875

def list_resolvers(compartment_id, opts = {})
  logger.debug 'Calling operation DnsClient#list_resolvers.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_resolvers." if compartment_id.nil?

  if opts[:sort_order] && !OCI::Dns::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Dns::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[displayName timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, timeCreated.'
  end

  if opts[:lifecycle_state] && !OCI::Dns::Models::ResolverSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Dns::Models::ResolverSummary::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end

  path = '/resolvers'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#list_resolvers') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Dns::Models::ResolverSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_steering_policies(compartment_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use list_steering_policies API.

Gets a list of all steering policies in the specified compartment.

Parameters:

compartment_id (String) —

The OCID of the compartment the resource belongs to.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:limit (Integer) —

The maximum number of items to return in a page of the collection. (default to 50)
:page (String) —

The value of the opc-next-page response header from the previous "List" call.
:id (String) —

The OCID of a resource.
:display_name (String) —

The displayName of a resource.
:display_name_contains (String) —

The partial displayName of a resource. Will match any resource whose name (case-insensitive) contains the provided value.
:health_check_monitor_id (String) —

Search by health check monitor OCID. Will match any resource whose health check monitor ID matches the provided value.
:time_created_greater_than_or_equal_to (DateTime) —

An RFC 3339 timestamp that states all returned resources were created on or after the indicated time.
:time_created_less_than (DateTime) —

An RFC 3339 timestamp that states all returned resources were created before the indicated time.
:template (String) —

Search by steering template type. Will match any resource whose template type matches the provided value.
:lifecycle_state (String) —

The state of a resource. (default to ACTIVE)
:sort_by (String) —

The field by which to sort steering policies. If unspecified, defaults to timeCreated. (default to timeCreated) Allowed values are: displayName, timeCreated, template
:sort_order (String) —

The order to sort the resources. (default to DESC)
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type Array<SteeringPolicySummary>

# File 'lib/oci/dns/dns_client.rb', line 2985

def list_steering_policies(compartment_id, opts = {})
  logger.debug 'Calling operation DnsClient#list_steering_policies.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_steering_policies." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::Dns::Models::SteeringPolicySummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Dns::Models::SteeringPolicySummary::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_by] && !%w[displayName timeCreated template].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, timeCreated, template.'
  end

  if opts[:sort_order] && !OCI::Dns::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Dns::Models::SORT_ORDER_ENUM.'
  end

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end

  path = '/steeringPolicies'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]
  query_params[:healthCheckMonitorId] = opts[:health_check_monitor_id] if opts[:health_check_monitor_id]
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:template] = opts[:template] if opts[:template]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#list_steering_policies') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Dns::Models::SteeringPolicySummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_steering_policy_attachments(compartment_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use list_steering_policy_attachments API.

Lists the steering policy attachments in the specified compartment.

Parameters:

compartment_id (String) —

The OCID of the compartment the resource belongs to.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:limit (Integer) —

The maximum number of items to return in a page of the collection. (default to 50)
:page (String) —

The value of the opc-next-page response header from the previous "List" call.
:id (String) —

The OCID of a resource.
:display_name (String) —

The displayName of a resource.
:steering_policy_id (String) —

Search by steering policy OCID. Will match any resource whose steering policy ID matches the provided value.
:zone_id (String) —

Search by zone OCID. Will match any resource whose zone ID matches the provided value.
:domain (String) —

Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.
:domain_contains (String) —

Search by domain. Will match any record whose domain (case-insensitive) contains the provided value.
:time_created_greater_than_or_equal_to (DateTime) —

An RFC 3339 timestamp that states all returned resources were created on or after the indicated time.
:time_created_less_than (DateTime) —

An RFC 3339 timestamp that states all returned resources were created before the indicated time.
:lifecycle_state (String) —

The state of a resource. (default to ACTIVE)
:sort_by (String) —

The field by which to sort steering policy attachments. If unspecified, defaults to timeCreated. (default to timeCreated) Allowed values are: displayName, timeCreated, domainName
:sort_order (String) —

The order to sort the resources. (default to DESC)
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type Array<SteeringPolicyAttachmentSummary>

# File 'lib/oci/dns/dns_client.rb', line 3103

def list_steering_policy_attachments(compartment_id, opts = {})
  logger.debug 'Calling operation DnsClient#list_steering_policy_attachments.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_steering_policy_attachments." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::Dns::Models::SteeringPolicyAttachmentSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Dns::Models::SteeringPolicyAttachmentSummary::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_by] && !%w[displayName timeCreated domainName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, timeCreated, domainName.'
  end

  if opts[:sort_order] && !OCI::Dns::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Dns::Models::SORT_ORDER_ENUM.'
  end

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end

  path = '/steeringPolicyAttachments'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:steeringPolicyId] = opts[:steering_policy_id] if opts[:steering_policy_id]
  query_params[:zoneId] = opts[:zone_id] if opts[:zone_id]
  query_params[:domain] = opts[:domain] if opts[:domain]
  query_params[:domainContains] = opts[:domain_contains] if opts[:domain_contains]
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#list_steering_policy_attachments') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Dns::Models::SteeringPolicyAttachmentSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_tsig_keys(compartment_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use list_tsig_keys API.

Gets a list of all TSIG keys in the specified compartment.

Parameters:

compartment_id (String) —

The OCID of the compartment the resource belongs to.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:limit (Integer) —

The maximum number of items to return in a page of the collection. (default to 50)
:page (String) —

The value of the opc-next-page response header from the previous "List" call.
:id (String) —

The OCID of a resource.
:name (String) —

The name of a resource.
:lifecycle_state (String) —

The state of a resource.
:sort_by (String) —

The field by which to sort TSIG keys. If unspecified, defaults to timeCreated. (default to timeCreated) Allowed values are: name, timeCreated
:sort_order (String) —

The order to sort the resources. (default to DESC)
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type Array<TsigKeySummary>

# File 'lib/oci/dns/dns_client.rb', line 3204

def list_tsig_keys(compartment_id, opts = {})
  logger.debug 'Calling operation DnsClient#list_tsig_keys.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_tsig_keys." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::Dns::Models::TsigKeySummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Dns::Models::TsigKeySummary::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_by] && !%w[name timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of name, timeCreated.'
  end

  if opts[:sort_order] && !OCI::Dns::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Dns::Models::SORT_ORDER_ENUM.'
  end

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end

  path = '/tsigKeys'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#list_tsig_keys') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Dns::Models::TsigKeySummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_views(compartment_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use list_views API.

Gets a list of all views within a compartment.

The collection can be filtered by display name, id, or lifecycle state. It can be sorted on creation time or displayName both in ASC or DESC order. Note that when no lifecycleState query parameter is provided, the collection does not include views in the DELETED lifecycleState to be consistent with other operations of the API.

Parameters:

compartment_id (String) —

The OCID of the compartment the resource belongs to.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:display_name (String) —

The displayName of a resource.
:id (String) —

The OCID of a resource.
:page (String) —

The value of the opc-next-page response header from the previous "List" call.
:limit (Integer) —

The maximum number of items to return in a page of the collection. (default to 50)
:sort_order (String) —

The order to sort the resources. (default to DESC)
:sort_by (String) —

The field by which to sort views. (default to timeCreated) Allowed values are: displayName, timeCreated
:lifecycle_state (String) —

The state of a resource.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type Array<ViewSummary>

# File 'lib/oci/dns/dns_client.rb', line 3304

def list_views(compartment_id, opts = {})
  logger.debug 'Calling operation DnsClient#list_views.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_views." if compartment_id.nil?

  if opts[:sort_order] && !OCI::Dns::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Dns::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[displayName timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, timeCreated.'
  end

  if opts[:lifecycle_state] && !OCI::Dns::Models::ViewSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Dns::Models::ViewSummary::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end

  path = '/views'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#list_views') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Dns::Models::ViewSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_zone_transfer_servers(compartment_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use list_zone_transfer_servers API.

Gets a list of IP addresses of OCI nameservers for inbound and outbound transfer of zones in the specified compartment (which must be the root compartment of a tenancy) that transfer zone data with external master or downstream nameservers.

Parameters:

compartment_id (String) —

The OCID of the compartment the resource belongs to.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.
:page (String) —

The value of the opc-next-page response header from the previous "List" call.

Returns:

(Response) —

A Response object with data of type Array<ZoneTransferServer>

# File 'lib/oci/dns/dns_client.rb', line 3392

def list_zone_transfer_servers(compartment_id, opts = {})
  logger.debug 'Calling operation DnsClient#list_zone_transfer_servers.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_zone_transfer_servers." if compartment_id.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end

  path = '/zoneTransferServers'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:scope] = opts[:scope] if opts[:scope]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#list_zone_transfer_servers') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Dns::Models::ZoneTransferServer>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_zones(compartment_id, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use list_zones API.

Gets a list of all zones in the specified compartment.

The collection can be filtered by name, time created, scope, associated view, and zone type. Filtering by view is only supported for private zones.

Parameters:

compartment_id (String) —

The OCID of the compartment the resource belongs to.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:limit (Integer) —

The maximum number of items to return in a page of the collection. (default to 50)
:page (String) —

The value of the opc-next-page response header from the previous "List" call.
:name (String) —

A case-sensitive filter for zone names. Will match any zone with a name that equals the provided value.
:name_contains (String) —

Search by zone name. Will match any zone whose name (case-insensitive) contains the provided value.
:zone_type (String) —

Search by zone type, PRIMARY or SECONDARY. Will match any zone whose type equals the provided value.

Allowed values are: PRIMARY, SECONDARY
:time_created_greater_than_or_equal_to (DateTime) —

An RFC 3339 timestamp that states all returned resources were created on or after the indicated time.
:time_created_less_than (DateTime) —

An RFC 3339 timestamp that states all returned resources were created before the indicated time.
:lifecycle_state (String) —

The state of a resource. (default to ACTIVE) Allowed values are: ACTIVE, CREATING, DELETED, DELETING, FAILED, UPDATING
:sort_by (String) —

The field by which to sort zones. (default to timeCreated) Allowed values are: name, zoneType, timeCreated
:sort_order (String) —

The order to sort the resources. (default to DESC)
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.
:view_id (String) —

The OCID of the view the resource is associated with.
:tsig_key_id (String) —

Search for zones that are associated with a TSIG key.

Returns:

(Response) —

A Response object with data of type Array<ZoneSummary>

# File 'lib/oci/dns/dns_client.rb', line 3490

def list_zones(compartment_id, opts = {})
  logger.debug 'Calling operation DnsClient#list_zones.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_zones." if compartment_id.nil?

  if opts[:zone_type] && !%w[PRIMARY SECONDARY].include?(opts[:zone_type])
    raise 'Invalid value for "zone_type", must be one of PRIMARY, SECONDARY.'
  end

  if opts[:lifecycle_state] && !%w[ACTIVE CREATING DELETED DELETING FAILED UPDATING].include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of ACTIVE, CREATING, DELETED, DELETING, FAILED, UPDATING.'
  end

  if opts[:sort_by] && !%w[name zoneType timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of name, zoneType, timeCreated.'
  end

  if opts[:sort_order] && !OCI::Dns::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Dns::Models::SORT_ORDER_ENUM.'
  end

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end

  path = '/zones'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:nameContains] = opts[:name_contains] if opts[:name_contains]
  query_params[:zoneType] = opts[:zone_type] if opts[:zone_type]
  query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
  query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:scope] = opts[:scope] if opts[:scope]
  query_params[:viewId] = opts[:view_id] if opts[:view_id]
  query_params[:tsigKeyId] = opts[:tsig_key_id] if opts[:tsig_key_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#list_zones') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Dns::Models::ZoneSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ `Logger`

Returns The logger for this client. May be nil.

Returns:

(Logger) —

The logger for this client. May be nil.



95
96
97

# File 'lib/oci/dns/dns_client.rb', line 95

def logger
  @api_client.config.logger
end

#patch_domain_records(zone_name_or_id, domain, patch_domain_records_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use patch_domain_records API.

Updates records in the specified zone at a domain.

You can update one record or all records for the specified zone depending on the changes provided in the request body. You can also add or remove records using this function. When the zone name is provided as a path parameter and PRIVATE is used for the scope query parameter then the viewId query parameter is required.

Parameters:

zone_name_or_id (String) —

The name or OCID of the target zone.
domain (String) —

The target fully-qualified domain name (FQDN) within the target zone.
patch_domain_records_details (OCI::Dns::Models::PatchDomainRecordsDetails) —

Operations describing how to modify the collection of records.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

The If-Match header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is *, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.
:if_unmodified_since (String) —

The If-Unmodified-Since header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.
:view_id (String) —

The OCID of the view the zone is associated with. Required when accessing a private zone by name.
:compartment_id (String) —

The OCID of the compartment the zone belongs to.

This parameter is deprecated and should be omitted.

Returns:

(Response) —

A Response object with data of type RecordCollection

# File 'lib/oci/dns/dns_client.rb', line 3607

def patch_domain_records(zone_name_or_id, domain, patch_domain_records_details, opts = {})
  logger.debug 'Calling operation DnsClient#patch_domain_records.' if logger

  raise "Missing the required parameter 'zone_name_or_id' when calling patch_domain_records." if zone_name_or_id.nil?
  raise "Missing the required parameter 'domain' when calling patch_domain_records." if domain.nil?
  raise "Missing the required parameter 'patch_domain_records_details' when calling patch_domain_records." if patch_domain_records_details.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'zone_name_or_id' must not be blank" if OCI::Internal::Util.blank_string?(zone_name_or_id)
  raise "Parameter value for 'domain' must not be blank" if OCI::Internal::Util.blank_string?(domain)

  path = '/zones/{zoneNameOrId}/records/{domain}'.sub('{zoneNameOrId}', zone_name_or_id.to_s).sub('{domain}', domain.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]
  query_params[:viewId] = opts[:view_id] if opts[:view_id]
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'if-unmodified-since'] = opts[:if_unmodified_since] if opts[:if_unmodified_since]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(patch_domain_records_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#patch_domain_records') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dns::Models::RecordCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_rr_set(zone_name_or_id, domain, rtype, patch_rr_set_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use patch_rr_set API.

Updates records in the specified RRSet.

When the zone name is provided as a path parameter and PRIVATE is used for the scope query parameter then the viewId query parameter is required.

Parameters:

zone_name_or_id (String) —

The name or OCID of the target zone.
domain (String) —

The target fully-qualified domain name (FQDN) within the target zone.
rtype (String) —

The type of the target RRSet within the target zone.
patch_rr_set_details (OCI::Dns::Models::PatchRRSetDetails) —

Operations describing how to modify the collection of records.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

The If-Match header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is *, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.
:if_unmodified_since (String) —

The If-Unmodified-Since header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.
:view_id (String) —

The OCID of the view the zone is associated with. Required when accessing a private zone by name.
:compartment_id (String) —

The OCID of the compartment the zone belongs to.

This parameter is deprecated and should be omitted.

Returns:

(Response) —

A Response object with data of type RecordCollection

# File 'lib/oci/dns/dns_client.rb', line 3702

def patch_rr_set(zone_name_or_id, domain, rtype, patch_rr_set_details, opts = {})
  logger.debug 'Calling operation DnsClient#patch_rr_set.' if logger

  raise "Missing the required parameter 'zone_name_or_id' when calling patch_rr_set." if zone_name_or_id.nil?
  raise "Missing the required parameter 'domain' when calling patch_rr_set." if domain.nil?
  raise "Missing the required parameter 'rtype' when calling patch_rr_set." if rtype.nil?
  raise "Missing the required parameter 'patch_rr_set_details' when calling patch_rr_set." if patch_rr_set_details.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'zone_name_or_id' must not be blank" if OCI::Internal::Util.blank_string?(zone_name_or_id)
  raise "Parameter value for 'domain' must not be blank" if OCI::Internal::Util.blank_string?(domain)
  raise "Parameter value for 'rtype' must not be blank" if OCI::Internal::Util.blank_string?(rtype)

  path = '/zones/{zoneNameOrId}/records/{domain}/{rtype}'.sub('{zoneNameOrId}', zone_name_or_id.to_s).sub('{domain}', domain.to_s).sub('{rtype}', rtype.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]
  query_params[:viewId] = opts[:view_id] if opts[:view_id]
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'if-unmodified-since'] = opts[:if_unmodified_since] if opts[:if_unmodified_since]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(patch_rr_set_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#patch_rr_set') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dns::Models::RecordCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_zone_records(zone_name_or_id, patch_zone_records_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use patch_zone_records API.

Updates a collection of records in the specified zone.

You can update one record or all records for the specified zone depending on the changes provided in the request body. You can also add or remove records using this function. When the zone name is provided as a path parameter and PRIVATE is used for the scope query parameter then the viewId query parameter is required.

Parameters:

zone_name_or_id (String) —

The name or OCID of the target zone.
patch_zone_records_details (OCI::Dns::Models::PatchZoneRecordsDetails) —

The operations describing how to modify the collection of records.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

The If-Match header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is *, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.
:if_unmodified_since (String) —

The If-Unmodified-Since header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.
:view_id (String) —

The OCID of the view the zone is associated with. Required when accessing a private zone by name.
:compartment_id (String) —

The OCID of the compartment the zone belongs to.

This parameter is deprecated and should be omitted.

Returns:

(Response) —

A Response object with data of type RecordCollection

# File 'lib/oci/dns/dns_client.rb', line 3800

def patch_zone_records(zone_name_or_id, patch_zone_records_details, opts = {})
  logger.debug 'Calling operation DnsClient#patch_zone_records.' if logger

  raise "Missing the required parameter 'zone_name_or_id' when calling patch_zone_records." if zone_name_or_id.nil?
  raise "Missing the required parameter 'patch_zone_records_details' when calling patch_zone_records." if patch_zone_records_details.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'zone_name_or_id' must not be blank" if OCI::Internal::Util.blank_string?(zone_name_or_id)

  path = '/zones/{zoneNameOrId}/records'.sub('{zoneNameOrId}', zone_name_or_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]
  query_params[:viewId] = opts[:view_id] if opts[:view_id]
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'if-unmodified-since'] = opts[:if_unmodified_since] if opts[:if_unmodified_since]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(patch_zone_records_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#patch_zone_records') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dns::Models::RecordCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_domain_records(zone_name_or_id, domain, update_domain_records_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use update_domain_records API.

Replaces records in the specified zone at a domain with the records specified in the request body.

If a specified record does not exist, it will be created. If the record exists, then it will be updated to represent the record in the body of the request. If a record in the zone does not exist in the request body, the record will be removed from the zone. When the zone name is provided as a path parameter and PRIVATE is used for the scope query parameter then the viewId query parameter is required.

Parameters:

zone_name_or_id (String) —

The name or OCID of the target zone.
domain (String) —

The target fully-qualified domain name (FQDN) within the target zone.
update_domain_records_details (OCI::Dns::Models::UpdateDomainRecordsDetails) —

A full list of records for the domain.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

The If-Match header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is *, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.
:if_unmodified_since (String) —

The If-Unmodified-Since header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.
:view_id (String) —

The OCID of the view the zone is associated with. Required when accessing a private zone by name.
:compartment_id (String) —

The OCID of the compartment the zone belongs to.

This parameter is deprecated and should be omitted.

Returns:

(Response) —

A Response object with data of type RecordCollection

# File 'lib/oci/dns/dns_client.rb', line 3894

def update_domain_records(zone_name_or_id, domain, update_domain_records_details, opts = {})
  logger.debug 'Calling operation DnsClient#update_domain_records.' if logger

  raise "Missing the required parameter 'zone_name_or_id' when calling update_domain_records." if zone_name_or_id.nil?
  raise "Missing the required parameter 'domain' when calling update_domain_records." if domain.nil?
  raise "Missing the required parameter 'update_domain_records_details' when calling update_domain_records." if update_domain_records_details.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'zone_name_or_id' must not be blank" if OCI::Internal::Util.blank_string?(zone_name_or_id)
  raise "Parameter value for 'domain' must not be blank" if OCI::Internal::Util.blank_string?(domain)

  path = '/zones/{zoneNameOrId}/records/{domain}'.sub('{zoneNameOrId}', zone_name_or_id.to_s).sub('{domain}', domain.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]
  query_params[:viewId] = opts[:view_id] if opts[:view_id]
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'if-unmodified-since'] = opts[:if_unmodified_since] if opts[:if_unmodified_since]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_domain_records_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#update_domain_records') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dns::Models::RecordCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_resolver(resolver_id, update_resolver_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use update_resolver API.

Updates the specified resolver with your new information.

Parameters:

resolver_id (String) —

The OCID of the target resolver.
update_resolver_details (OCI::Dns::Models::UpdateResolverDetails) —

New data for the resolver.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

The If-Match header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is *, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.
:if_unmodified_since (String) —

The If-Unmodified-Since header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type Resolver

# File 'lib/oci/dns/dns_client.rb', line 3979

def update_resolver(resolver_id, update_resolver_details, opts = {})
  logger.debug 'Calling operation DnsClient#update_resolver.' if logger

  raise "Missing the required parameter 'resolver_id' when calling update_resolver." if resolver_id.nil?
  raise "Missing the required parameter 'update_resolver_details' when calling update_resolver." if update_resolver_details.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'resolver_id' must not be blank" if OCI::Internal::Util.blank_string?(resolver_id)

  path = '/resolvers/{resolverId}'.sub('{resolverId}', resolver_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'if-unmodified-since'] = opts[:if_unmodified_since] if opts[:if_unmodified_since]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_resolver_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#update_resolver') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dns::Models::Resolver'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_resolver_endpoint(resolver_id, resolver_endpoint_name, update_resolver_endpoint_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use update_resolver_endpoint API.

Updates the specified resolver endpoint with your new information.

Parameters:

resolver_id (String) —

The OCID of the target resolver.
resolver_endpoint_name (String) —

The name of the target resolver endpoint.
update_resolver_endpoint_details (OCI::Dns::Models::UpdateResolverEndpointDetails) —

New data for the resolver endpoint.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

The If-Match header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is *, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.
:if_unmodified_since (String) —

The If-Unmodified-Since header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type ResolverEndpoint

# File 'lib/oci/dns/dns_client.rb', line 4061

def update_resolver_endpoint(resolver_id, resolver_endpoint_name, update_resolver_endpoint_details, opts = {})
  logger.debug 'Calling operation DnsClient#update_resolver_endpoint.' if logger

  raise "Missing the required parameter 'resolver_id' when calling update_resolver_endpoint." if resolver_id.nil?
  raise "Missing the required parameter 'resolver_endpoint_name' when calling update_resolver_endpoint." if resolver_endpoint_name.nil?
  raise "Missing the required parameter 'update_resolver_endpoint_details' when calling update_resolver_endpoint." if update_resolver_endpoint_details.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'resolver_id' must not be blank" if OCI::Internal::Util.blank_string?(resolver_id)
  raise "Parameter value for 'resolver_endpoint_name' must not be blank" if OCI::Internal::Util.blank_string?(resolver_endpoint_name)

  path = '/resolvers/{resolverId}/endpoints/{resolverEndpointName}'.sub('{resolverId}', resolver_id.to_s).sub('{resolverEndpointName}', resolver_endpoint_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'if-unmodified-since'] = opts[:if_unmodified_since] if opts[:if_unmodified_since]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_resolver_endpoint_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#update_resolver_endpoint') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dns::Models::ResolverEndpoint'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_rr_set(zone_name_or_id, domain, rtype, update_rr_set_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use update_rr_set API.

Replaces records in the specified RRSet.

When the zone name is provided as a path parameter and PRIVATE is used for the scope query parameter then the viewId query parameter is required.

Parameters:

zone_name_or_id (String) —

The name or OCID of the target zone.
domain (String) —

The target fully-qualified domain name (FQDN) within the target zone.
rtype (String) —

The type of the target RRSet within the target zone.
update_rr_set_details (OCI::Dns::Models::UpdateRRSetDetails) —

A full list of records for the RRSet.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

The If-Match header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is *, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.
:if_unmodified_since (String) —

The If-Unmodified-Since header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.
:view_id (String) —

The OCID of the view the zone is associated with. Required when accessing a private zone by name.
:compartment_id (String) —

The OCID of the compartment the zone belongs to.

This parameter is deprecated and should be omitted.

Returns:

(Response) —

A Response object with data of type RecordCollection

# File 'lib/oci/dns/dns_client.rb', line 4154

def update_rr_set(zone_name_or_id, domain, rtype, update_rr_set_details, opts = {})
  logger.debug 'Calling operation DnsClient#update_rr_set.' if logger

  raise "Missing the required parameter 'zone_name_or_id' when calling update_rr_set." if zone_name_or_id.nil?
  raise "Missing the required parameter 'domain' when calling update_rr_set." if domain.nil?
  raise "Missing the required parameter 'rtype' when calling update_rr_set." if rtype.nil?
  raise "Missing the required parameter 'update_rr_set_details' when calling update_rr_set." if update_rr_set_details.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'zone_name_or_id' must not be blank" if OCI::Internal::Util.blank_string?(zone_name_or_id)
  raise "Parameter value for 'domain' must not be blank" if OCI::Internal::Util.blank_string?(domain)
  raise "Parameter value for 'rtype' must not be blank" if OCI::Internal::Util.blank_string?(rtype)

  path = '/zones/{zoneNameOrId}/records/{domain}/{rtype}'.sub('{zoneNameOrId}', zone_name_or_id.to_s).sub('{domain}', domain.to_s).sub('{rtype}', rtype.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]
  query_params[:viewId] = opts[:view_id] if opts[:view_id]
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'if-unmodified-since'] = opts[:if_unmodified_since] if opts[:if_unmodified_since]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_rr_set_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#update_rr_set') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dns::Models::RecordCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_steering_policy(steering_policy_id, update_steering_policy_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use update_steering_policy API.

Updates the configuration of the specified steering policy.

Parameters:

steering_policy_id (String) —

The OCID of the target steering policy.
update_steering_policy_details (OCI::Dns::Models::UpdateSteeringPolicyDetails) —

New data for the steering policy.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

The If-Match header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is *, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.
:if_unmodified_since (String) —

The If-Unmodified-Since header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type SteeringPolicy

# File 'lib/oci/dns/dns_client.rb', line 4241

def update_steering_policy(steering_policy_id, update_steering_policy_details, opts = {})
  logger.debug 'Calling operation DnsClient#update_steering_policy.' if logger

  raise "Missing the required parameter 'steering_policy_id' when calling update_steering_policy." if steering_policy_id.nil?
  raise "Missing the required parameter 'update_steering_policy_details' when calling update_steering_policy." if update_steering_policy_details.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'steering_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(steering_policy_id)

  path = '/steeringPolicies/{steeringPolicyId}'.sub('{steeringPolicyId}', steering_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'if-unmodified-since'] = opts[:if_unmodified_since] if opts[:if_unmodified_since]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_steering_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#update_steering_policy') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dns::Models::SteeringPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_steering_policy_attachment(steering_policy_attachment_id, update_steering_policy_attachment_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use update_steering_policy_attachment API.

Updates the specified steering policy attachment with your new information.

Parameters:

steering_policy_attachment_id (String) —

The OCID of the target steering policy attachment.
update_steering_policy_attachment_details (OCI::Dns::Models::UpdateSteeringPolicyAttachmentDetails) —

New data for the steering policy attachment.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

The If-Match header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is *, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.
:if_unmodified_since (String) —

The If-Unmodified-Since header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type SteeringPolicyAttachment

# File 'lib/oci/dns/dns_client.rb', line 4322

def update_steering_policy_attachment(steering_policy_attachment_id, update_steering_policy_attachment_details, opts = {})
  logger.debug 'Calling operation DnsClient#update_steering_policy_attachment.' if logger

  raise "Missing the required parameter 'steering_policy_attachment_id' when calling update_steering_policy_attachment." if steering_policy_attachment_id.nil?
  raise "Missing the required parameter 'update_steering_policy_attachment_details' when calling update_steering_policy_attachment." if update_steering_policy_attachment_details.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'steering_policy_attachment_id' must not be blank" if OCI::Internal::Util.blank_string?(steering_policy_attachment_id)

  path = '/steeringPolicyAttachments/{steeringPolicyAttachmentId}'.sub('{steeringPolicyAttachmentId}', steering_policy_attachment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'if-unmodified-since'] = opts[:if_unmodified_since] if opts[:if_unmodified_since]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_steering_policy_attachment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#update_steering_policy_attachment') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dns::Models::SteeringPolicyAttachment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_tsig_key(tsig_key_id, update_tsig_key_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use update_tsig_key API.

Updates the specified TSIG key.

Parameters:

tsig_key_id (String) —

The OCID of the target TSIG key.
update_tsig_key_details (OCI::Dns::Models::UpdateTsigKeyDetails) —

New data for the TSIG key.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

The If-Match header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is *, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.
:if_unmodified_since (String) —

The If-Unmodified-Since header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type TsigKey

# File 'lib/oci/dns/dns_client.rb', line 4403

def update_tsig_key(tsig_key_id, update_tsig_key_details, opts = {})
  logger.debug 'Calling operation DnsClient#update_tsig_key.' if logger

  raise "Missing the required parameter 'tsig_key_id' when calling update_tsig_key." if tsig_key_id.nil?
  raise "Missing the required parameter 'update_tsig_key_details' when calling update_tsig_key." if update_tsig_key_details.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'tsig_key_id' must not be blank" if OCI::Internal::Util.blank_string?(tsig_key_id)

  path = '/tsigKeys/{tsigKeyId}'.sub('{tsigKeyId}', tsig_key_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'if-unmodified-since'] = opts[:if_unmodified_since] if opts[:if_unmodified_since]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_tsig_key_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#update_tsig_key') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dns::Models::TsigKey'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_view(view_id, update_view_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use update_view API.

Updates the specified view with your new information.

Parameters:

view_id (String) —

The OCID of the target view.
update_view_details (OCI::Dns::Models::UpdateViewDetails) —

New data for the view.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

The If-Match header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is *, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.
:if_unmodified_since (String) —

The If-Unmodified-Since header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.

Returns:

(Response) —

A Response object with data of type View

# File 'lib/oci/dns/dns_client.rb', line 4484

def update_view(view_id, update_view_details, opts = {})
  logger.debug 'Calling operation DnsClient#update_view.' if logger

  raise "Missing the required parameter 'view_id' when calling update_view." if view_id.nil?
  raise "Missing the required parameter 'update_view_details' when calling update_view." if update_view_details.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'view_id' must not be blank" if OCI::Internal::Util.blank_string?(view_id)

  path = '/views/{viewId}'.sub('{viewId}', view_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'if-unmodified-since'] = opts[:if_unmodified_since] if opts[:if_unmodified_since]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_view_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#update_view') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dns::Models::View'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_zone(zone_name_or_id, update_zone_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use update_zone API.

Updates the zone with the specified information.

Global secondary zones may have their external masters updated. For more information about secondary zones, see Manage DNS Service Zone. When the zone name is provided as a path parameter and PRIVATE is used for the scope query parameter then the viewId query parameter is required.

Parameters:

zone_name_or_id (String) —

The name or OCID of the target zone.
update_zone_details (OCI::Dns::Models::UpdateZoneDetails) —

New data for the zone.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

The If-Match header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is *, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.
:if_unmodified_since (String) —

The If-Unmodified-Since header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.
:view_id (String) —

The OCID of the view the zone is associated with. Required when accessing a private zone by name.
:compartment_id (String) —

The OCID of the compartment the zone belongs to.

This parameter is deprecated and should be omitted.

Returns:

(Response) —

A Response object with data of type Zone

# File 'lib/oci/dns/dns_client.rb', line 4575

def update_zone(zone_name_or_id, update_zone_details, opts = {})
  logger.debug 'Calling operation DnsClient#update_zone.' if logger

  raise "Missing the required parameter 'zone_name_or_id' when calling update_zone." if zone_name_or_id.nil?
  raise "Missing the required parameter 'update_zone_details' when calling update_zone." if update_zone_details.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'zone_name_or_id' must not be blank" if OCI::Internal::Util.blank_string?(zone_name_or_id)

  path = '/zones/{zoneNameOrId}'.sub('{zoneNameOrId}', zone_name_or_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]
  query_params[:viewId] = opts[:view_id] if opts[:view_id]
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'if-unmodified-since'] = opts[:if_unmodified_since] if opts[:if_unmodified_since]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_zone_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#update_zone') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dns::Models::Zone'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_zone_records(zone_name_or_id, update_zone_records_details, opts = {}) ⇒ `Response`

Note:

Click here to see an example of how to use update_zone_records API.

Replaces records in the specified zone with the records specified in the request body.

If a specified record does not exist, it will be created. If the record exists, then it will be updated to represent the record in the body of the request. If a record in the zone does not exist in the request body, the record will be removed from the zone. When the zone name is provided as a path parameter and PRIVATE is used for the scope query parameter then the viewId query parameter is required.

Parameters:

zone_name_or_id (String) —

The name or OCID of the target zone.
update_zone_records_details (OCI::Dns::Models::UpdateZoneRecordsDetails) —

A full list of records for the zone.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:retry_config (OCI::Retry::RetryConfig) —

The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry
:if_match (String) —

The If-Match header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is *, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.
:if_unmodified_since (String) —

The If-Unmodified-Since header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation.
:opc_request_id (String) —

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
:scope (String) —

Specifies to operate only on resources that have a matching DNS scope.
:view_id (String) —

The OCID of the view the zone is associated with. Required when accessing a private zone by name.
:compartment_id (String) —

The OCID of the compartment the zone belongs to.

This parameter is deprecated and should be omitted.

Returns:

(Response) —

A Response object with data of type RecordCollection

# File 'lib/oci/dns/dns_client.rb', line 4669

def update_zone_records(zone_name_or_id, update_zone_records_details, opts = {})
  logger.debug 'Calling operation DnsClient#update_zone_records.' if logger

  raise "Missing the required parameter 'zone_name_or_id' when calling update_zone_records." if zone_name_or_id.nil?
  raise "Missing the required parameter 'update_zone_records_details' when calling update_zone_records." if update_zone_records_details.nil?

  if opts[:scope] && !OCI::Dns::Models::SCOPE_ENUM.include?(opts[:scope])
    raise 'Invalid value for "scope", must be one of the values in OCI::Dns::Models::SCOPE_ENUM.'
  end
  raise "Parameter value for 'zone_name_or_id' must not be blank" if OCI::Internal::Util.blank_string?(zone_name_or_id)

  path = '/zones/{zoneNameOrId}/records'.sub('{zoneNameOrId}', zone_name_or_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = opts[:scope] if opts[:scope]
  query_params[:viewId] = opts[:view_id] if opts[:view_id]
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'if-unmodified-since'] = opts[:if_unmodified_since] if opts[:if_unmodified_since]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_zone_records_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DnsClient#update_zone_records') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dns::Models::RecordCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

Overview

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ DnsClient

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

#endpoint ⇒ String (readonly)

#region ⇒ String

#retry_config ⇒ OCI::Retry::RetryConfig (readonly)

Instance Method Details

#change_resolver_compartment(resolver_id, change_resolver_compartment_details, opts = {}) ⇒ Response

#change_steering_policy_compartment(steering_policy_id, change_steering_policy_compartment_details, opts = {}) ⇒ Response

#change_tsig_key_compartment(tsig_key_id, change_tsig_key_compartment_details, opts = {}) ⇒ Response

#change_view_compartment(view_id, change_view_compartment_details, opts = {}) ⇒ Response

#change_zone_compartment(zone_id, change_zone_compartment_details, opts = {}) ⇒ Response

#create_resolver_endpoint(resolver_id, create_resolver_endpoint_details, opts = {}) ⇒ Response

#create_steering_policy(create_steering_policy_details, opts = {}) ⇒ Response

#create_steering_policy_attachment(create_steering_policy_attachment_details, opts = {}) ⇒ Response

#create_tsig_key(create_tsig_key_details, opts = {}) ⇒ Response

#create_view(create_view_details, opts = {}) ⇒ Response

#create_zone(create_zone_details, opts = {}) ⇒ Response

#create_zone_from_zone_file(compartment_id, create_zone_from_zone_file_details, opts = {}) ⇒ Response

#delete_domain_records(zone_name_or_id, domain, opts = {}) ⇒ Response

#delete_resolver_endpoint(resolver_id, resolver_endpoint_name, opts = {}) ⇒ Response

#delete_rr_set(zone_name_or_id, domain, rtype, opts = {}) ⇒ Response

#delete_steering_policy(steering_policy_id, opts = {}) ⇒ Response

#delete_steering_policy_attachment(steering_policy_attachment_id, opts = {}) ⇒ Response

#delete_tsig_key(tsig_key_id, opts = {}) ⇒ Response

#delete_view(view_id, opts = {}) ⇒ Response

#delete_zone(zone_name_or_id, opts = {}) ⇒ Response

#get_domain_records(zone_name_or_id, domain, opts = {}) ⇒ Response

#get_resolver(resolver_id, opts = {}) ⇒ Response

#get_resolver_endpoint(resolver_id, resolver_endpoint_name, opts = {}) ⇒ Response

#get_rr_set(zone_name_or_id, domain, rtype, opts = {}) ⇒ Response

#get_steering_policy(steering_policy_id, opts = {}) ⇒ Response

#get_steering_policy_attachment(steering_policy_attachment_id, opts = {}) ⇒ Response

#get_tsig_key(tsig_key_id, opts = {}) ⇒ Response

#get_view(view_id, opts = {}) ⇒ Response

#get_zone(zone_name_or_id, opts = {}) ⇒ Response

#get_zone_content(zone_name_or_id, opts = {}, &block) ⇒ Response

#get_zone_records(zone_name_or_id, opts = {}) ⇒ Response

#list_resolver_endpoints(resolver_id, opts = {}) ⇒ Response

#list_resolvers(compartment_id, opts = {}) ⇒ Response

#list_steering_policies(compartment_id, opts = {}) ⇒ Response

#list_steering_policy_attachments(compartment_id, opts = {}) ⇒ Response

#list_tsig_keys(compartment_id, opts = {}) ⇒ Response

#list_views(compartment_id, opts = {}) ⇒ Response

#list_zone_transfer_servers(compartment_id, opts = {}) ⇒ Response

#list_zones(compartment_id, opts = {}) ⇒ Response

#logger ⇒ Logger

#patch_domain_records(zone_name_or_id, domain, patch_domain_records_details, opts = {}) ⇒ Response

#patch_rr_set(zone_name_or_id, domain, rtype, patch_rr_set_details, opts = {}) ⇒ Response

#patch_zone_records(zone_name_or_id, patch_zone_records_details, opts = {}) ⇒ Response

#update_domain_records(zone_name_or_id, domain, update_domain_records_details, opts = {}) ⇒ Response

#update_resolver(resolver_id, update_resolver_details, opts = {}) ⇒ Response

#update_resolver_endpoint(resolver_id, resolver_endpoint_name, update_resolver_endpoint_details, opts = {}) ⇒ Response

#update_rr_set(zone_name_or_id, domain, rtype, update_rr_set_details, opts = {}) ⇒ Response

#update_steering_policy(steering_policy_id, update_steering_policy_details, opts = {}) ⇒ Response

#update_steering_policy_attachment(steering_policy_attachment_id, update_steering_policy_attachment_details, opts = {}) ⇒ Response

#update_tsig_key(tsig_key_id, update_tsig_key_details, opts = {}) ⇒ Response

#update_view(view_id, update_view_details, opts = {}) ⇒ Response

#update_zone(zone_name_or_id, update_zone_details, opts = {}) ⇒ Response

#update_zone_records(zone_name_or_id, update_zone_records_details, opts = {}) ⇒ Response

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ `DnsClient`

#api_client ⇒ `OCI::ApiClient` (readonly)

#endpoint ⇒ `String` (readonly)

#region ⇒ `String`

#retry_config ⇒ `OCI::Retry::RetryConfig` (readonly)

#change_resolver_compartment(resolver_id, change_resolver_compartment_details, opts = {}) ⇒ `Response`

#change_steering_policy_compartment(steering_policy_id, change_steering_policy_compartment_details, opts = {}) ⇒ `Response`

#change_tsig_key_compartment(tsig_key_id, change_tsig_key_compartment_details, opts = {}) ⇒ `Response`

#change_view_compartment(view_id, change_view_compartment_details, opts = {}) ⇒ `Response`

#change_zone_compartment(zone_id, change_zone_compartment_details, opts = {}) ⇒ `Response`

#create_resolver_endpoint(resolver_id, create_resolver_endpoint_details, opts = {}) ⇒ `Response`

#create_steering_policy(create_steering_policy_details, opts = {}) ⇒ `Response`

#create_steering_policy_attachment(create_steering_policy_attachment_details, opts = {}) ⇒ `Response`

#create_tsig_key(create_tsig_key_details, opts = {}) ⇒ `Response`

#create_view(create_view_details, opts = {}) ⇒ `Response`

#create_zone(create_zone_details, opts = {}) ⇒ `Response`

#create_zone_from_zone_file(compartment_id, create_zone_from_zone_file_details, opts = {}) ⇒ `Response`

#delete_domain_records(zone_name_or_id, domain, opts = {}) ⇒ `Response`

#delete_resolver_endpoint(resolver_id, resolver_endpoint_name, opts = {}) ⇒ `Response`

#delete_rr_set(zone_name_or_id, domain, rtype, opts = {}) ⇒ `Response`

#delete_steering_policy(steering_policy_id, opts = {}) ⇒ `Response`

#delete_steering_policy_attachment(steering_policy_attachment_id, opts = {}) ⇒ `Response`

#delete_tsig_key(tsig_key_id, opts = {}) ⇒ `Response`

#delete_view(view_id, opts = {}) ⇒ `Response`

#delete_zone(zone_name_or_id, opts = {}) ⇒ `Response`

#get_domain_records(zone_name_or_id, domain, opts = {}) ⇒ `Response`

#get_resolver(resolver_id, opts = {}) ⇒ `Response`

#get_resolver_endpoint(resolver_id, resolver_endpoint_name, opts = {}) ⇒ `Response`

#get_rr_set(zone_name_or_id, domain, rtype, opts = {}) ⇒ `Response`

#get_steering_policy(steering_policy_id, opts = {}) ⇒ `Response`

#get_steering_policy_attachment(steering_policy_attachment_id, opts = {}) ⇒ `Response`

#get_tsig_key(tsig_key_id, opts = {}) ⇒ `Response`

#get_view(view_id, opts = {}) ⇒ `Response`

#get_zone(zone_name_or_id, opts = {}) ⇒ `Response`

#get_zone_content(zone_name_or_id, opts = {}, &block) ⇒ `Response`

#get_zone_records(zone_name_or_id, opts = {}) ⇒ `Response`

#list_resolver_endpoints(resolver_id, opts = {}) ⇒ `Response`

#list_resolvers(compartment_id, opts = {}) ⇒ `Response`

#list_steering_policies(compartment_id, opts = {}) ⇒ `Response`

#list_steering_policy_attachments(compartment_id, opts = {}) ⇒ `Response`

#list_tsig_keys(compartment_id, opts = {}) ⇒ `Response`

#list_views(compartment_id, opts = {}) ⇒ `Response`

#list_zone_transfer_servers(compartment_id, opts = {}) ⇒ `Response`

#list_zones(compartment_id, opts = {}) ⇒ `Response`

#logger ⇒ `Logger`

#patch_domain_records(zone_name_or_id, domain, patch_domain_records_details, opts = {}) ⇒ `Response`

#patch_rr_set(zone_name_or_id, domain, rtype, patch_rr_set_details, opts = {}) ⇒ `Response`

#patch_zone_records(zone_name_or_id, patch_zone_records_details, opts = {}) ⇒ `Response`

#update_domain_records(zone_name_or_id, domain, update_domain_records_details, opts = {}) ⇒ `Response`

#update_resolver(resolver_id, update_resolver_details, opts = {}) ⇒ `Response`

#update_resolver_endpoint(resolver_id, resolver_endpoint_name, update_resolver_endpoint_details, opts = {}) ⇒ `Response`

#update_rr_set(zone_name_or_id, domain, rtype, update_rr_set_details, opts = {}) ⇒ `Response`

#update_steering_policy(steering_policy_id, update_steering_policy_details, opts = {}) ⇒ `Response`

#update_steering_policy_attachment(steering_policy_attachment_id, update_steering_policy_attachment_details, opts = {}) ⇒ `Response`

#update_tsig_key(tsig_key_id, update_tsig_key_details, opts = {}) ⇒ `Response`

#update_view(view_id, update_view_details, opts = {}) ⇒ `Response`

#update_zone(zone_name_or_id, update_zone_details, opts = {}) ⇒ `Response`

#update_zone_records(zone_name_or_id, update_zone_records_details, opts = {}) ⇒ `Response`