com.oracle.bmc.dns

Interface Dns

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

DnsClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180115")
public interface Dns
extends AutoCloseable

Method Summary

Modifier and Type	Method and Description
ChangeSteeringPolicyCompartmentResponse	changeSteeringPolicyCompartment(ChangeSteeringPolicyCompartmentRequest request) Moves a steering policy into a different compartment.
ChangeTsigKeyCompartmentResponse	changeTsigKeyCompartment(ChangeTsigKeyCompartmentRequest request) Moves a TSIG key into a different compartment.
ChangeZoneCompartmentResponse	changeZoneCompartment(ChangeZoneCompartmentRequest request) Moves a zone into a different compartment.
CreateSteeringPolicyResponse	createSteeringPolicy(CreateSteeringPolicyRequest request) Creates a new steering policy in the specified compartment.
CreateSteeringPolicyAttachmentResponse	createSteeringPolicyAttachment(CreateSteeringPolicyAttachmentRequest request) Creates a new attachment between a steering policy and a domain, giving the policy permission to answer queries for the specified domain.
CreateTsigKeyResponse	createTsigKey(CreateTsigKeyRequest request) Creates a new TSIG key in the specified compartment.
CreateZoneResponse	createZone(CreateZoneRequest request) Creates a new zone in the specified compartment.
DeleteDomainRecordsResponse	deleteDomainRecords(DeleteDomainRecordsRequest request) Deletes all records at the specified zone and domain.
DeleteRRSetResponse	deleteRRSet(DeleteRRSetRequest request) Deletes all records in the specified RRSet.
DeleteSteeringPolicyResponse	deleteSteeringPolicy(DeleteSteeringPolicyRequest request) Deletes the specified steering policy.
DeleteSteeringPolicyAttachmentResponse	deleteSteeringPolicyAttachment(DeleteSteeringPolicyAttachmentRequest request) Deletes the specified steering policy attachment.
DeleteTsigKeyResponse	deleteTsigKey(DeleteTsigKeyRequest request) Deletes the specified TSIG key.
DeleteZoneResponse	deleteZone(DeleteZoneRequest request) Deletes the specified zone and all its steering policy attachments.
GetDomainRecordsResponse	getDomainRecords(GetDomainRecordsRequest request) Gets a list of all records at the specified zone and domain.
DnsPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetRRSetResponse	getRRSet(GetRRSetRequest request) Gets a list of all records in the specified RRSet.
GetSteeringPolicyResponse	getSteeringPolicy(GetSteeringPolicyRequest request) Gets information about the specified steering policy.
GetSteeringPolicyAttachmentResponse	getSteeringPolicyAttachment(GetSteeringPolicyAttachmentRequest request) Gets information about the specified steering policy attachment.
GetTsigKeyResponse	getTsigKey(GetTsigKeyRequest request) Gets information about the specified TSIG key.
DnsWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
GetZoneResponse	getZone(GetZoneRequest request) Gets information about the specified zone, including its creation date, zone type, and serial.
GetZoneRecordsResponse	getZoneRecords(GetZoneRecordsRequest request) Gets all records in the specified zone.
ListSteeringPoliciesResponse	listSteeringPolicies(ListSteeringPoliciesRequest request) Gets a list of all steering policies in the specified compartment.
ListSteeringPolicyAttachmentsResponse	listSteeringPolicyAttachments(ListSteeringPolicyAttachmentsRequest request) Lists the steering policy attachments in the specified compartment.
ListTsigKeysResponse	listTsigKeys(ListTsigKeysRequest request) Gets a list of all TSIG keys in the specified compartment.
ListZonesResponse	listZones(ListZonesRequest request) Gets a list of all zones in the specified compartment.
PatchDomainRecordsResponse	patchDomainRecords(PatchDomainRecordsRequest request) Updates records in the specified zone at a domain.
PatchRRSetResponse	patchRRSet(PatchRRSetRequest request) Updates records in the specified RRSet.
PatchZoneRecordsResponse	patchZoneRecords(PatchZoneRecordsRequest request) Updates a collection of records in the specified zone.
void	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
UpdateDomainRecordsResponse	updateDomainRecords(UpdateDomainRecordsRequest request) Replaces records in the specified zone at a domain with the records specified in the request body.
UpdateRRSetResponse	updateRRSet(UpdateRRSetRequest request) Replaces records in the specified RRSet.
UpdateSteeringPolicyResponse	updateSteeringPolicy(UpdateSteeringPolicyRequest request) Updates the configuration of the specified steering policy.
UpdateSteeringPolicyAttachmentResponse	updateSteeringPolicyAttachment(UpdateSteeringPolicyAttachmentRequest request) Updates the specified steering policy attachment with your new information.
UpdateTsigKeyResponse	updateTsigKey(UpdateTsigKeyRequest request) Updates the specified TSIG key.
UpdateZoneResponse	updateZone(UpdateZoneRequest request) Updates the specified secondary zone with your new external master server information.
UpdateZoneRecordsResponse	updateZoneRecords(UpdateZoneRecordsRequest request) Replaces records in the specified zone with the records specified in the request body.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the service.

setRegion

void setRegion(Region region)

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

Parameters:

region - The region of the service.

setRegion

void setRegion(String regionId)

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Parameters:

regionId - The public region ID.

changeSteeringPolicyCompartment

ChangeSteeringPolicyCompartmentResponse changeSteeringPolicyCompartment(ChangeSteeringPolicyCompartmentRequest request)

Moves a steering policy into a different compartment.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

changeTsigKeyCompartment

ChangeTsigKeyCompartmentResponse changeTsigKeyCompartment(ChangeTsigKeyCompartmentRequest request)

Moves a TSIG key into a different compartment.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

changeZoneCompartment

ChangeZoneCompartmentResponse changeZoneCompartment(ChangeZoneCompartmentRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

createSteeringPolicy

CreateSteeringPolicyResponse createSteeringPolicy(CreateSteeringPolicyRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

createSteeringPolicyAttachment

CreateSteeringPolicyAttachmentResponse createSteeringPolicyAttachment(CreateSteeringPolicyAttachmentRequest request)

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:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

createTsigKey

CreateTsigKeyResponse createTsigKey(CreateTsigKeyRequest request)

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:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

createZone

CreateZoneResponse createZone(CreateZoneRequest request)

Creates a new zone in the specified compartment. The compartmentId query parameter is required if the Content-Type header for the request is text/dns.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

deleteDomainRecords

DeleteDomainRecordsResponse deleteDomainRecords(DeleteDomainRecordsRequest request)

Deletes all records at the specified zone and domain.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

deleteRRSet

DeleteRRSetResponse deleteRRSet(DeleteRRSetRequest request)

Deletes all records in the specified RRSet.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

deleteSteeringPolicy

DeleteSteeringPolicyResponse deleteSteeringPolicy(DeleteSteeringPolicyRequest request)

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:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

deleteSteeringPolicyAttachment

DeleteSteeringPolicyAttachmentResponse deleteSteeringPolicyAttachment(DeleteSteeringPolicyAttachmentRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

deleteTsigKey

DeleteTsigKeyResponse deleteTsigKey(DeleteTsigKeyRequest request)

Deletes the specified TSIG key.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

deleteZone

DeleteZoneResponse deleteZone(DeleteZoneRequest request)

Deletes the specified zone and all its steering policy attachments. A 204 response indicates that zone has been successfully deleted.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

getDomainRecords

GetDomainRecordsResponse getDomainRecords(GetDomainRecordsRequest request)

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.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

getRRSet

GetRRSetResponse getRRSet(GetRRSetRequest request)

Gets a list of all records in the specified RRSet. The results are sorted by recordHash by default.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

getSteeringPolicy

GetSteeringPolicyResponse getSteeringPolicy(GetSteeringPolicyRequest request)

Gets information about the specified steering policy.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

getSteeringPolicyAttachment

GetSteeringPolicyAttachmentResponse getSteeringPolicyAttachment(GetSteeringPolicyAttachmentRequest request)

Gets information about the specified steering policy attachment.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

getTsigKey

GetTsigKeyResponse getTsigKey(GetTsigKeyRequest request)

Gets information about the specified TSIG key.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

getZone

GetZoneResponse getZone(GetZoneRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

getZoneRecords

GetZoneRecordsResponse getZoneRecords(GetZoneRecordsRequest request)

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.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

listSteeringPolicies

ListSteeringPoliciesResponse listSteeringPolicies(ListSteeringPoliciesRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

listSteeringPolicyAttachments

ListSteeringPolicyAttachmentsResponse listSteeringPolicyAttachments(ListSteeringPolicyAttachmentsRequest request)

Lists the steering policy attachments in the specified compartment.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

listTsigKeys

ListTsigKeysResponse listTsigKeys(ListTsigKeysRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

listZones

ListZonesResponse listZones(ListZonesRequest request)

Gets a list of all zones in the specified compartment. The collection can be filtered by name, time created, and zone type.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

patchDomainRecords

PatchDomainRecordsResponse patchDomainRecords(PatchDomainRecordsRequest request)

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.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

patchRRSet

PatchRRSetResponse patchRRSet(PatchRRSetRequest request)

Updates records in the specified RRSet.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

patchZoneRecords

PatchZoneRecordsResponse patchZoneRecords(PatchZoneRecordsRequest request)

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.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

updateDomainRecords

UpdateDomainRecordsResponse updateDomainRecords(UpdateDomainRecordsRequest request)

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.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

updateRRSet

UpdateRRSetResponse updateRRSet(UpdateRRSetRequest request)

Replaces records in the specified RRSet.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

updateSteeringPolicy

UpdateSteeringPolicyResponse updateSteeringPolicy(UpdateSteeringPolicyRequest request)

Updates the configuration of the specified steering policy.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

updateSteeringPolicyAttachment

UpdateSteeringPolicyAttachmentResponse updateSteeringPolicyAttachment(UpdateSteeringPolicyAttachmentRequest request)

Updates the specified steering policy attachment with your new information.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

updateTsigKey

UpdateTsigKeyResponse updateTsigKey(UpdateTsigKeyRequest request)

Updates the specified TSIG key.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

updateZone

UpdateZoneResponse updateZone(UpdateZoneRequest request)

Updates the specified secondary zone with your new external master server information. For more information about secondary zone, see Manage DNS Service Zone.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

updateZoneRecords

UpdateZoneRecordsResponse updateZoneRecords(UpdateZoneRecordsRequest request)

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.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

getWaiters

DnsWaiters getWaiters()

Gets the pre-configured waiters available for resources for this service.

Returns:

The service waiters.

getPaginators

DnsPaginators getPaginators()

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Returns:

The service paginators.