@Generated(value="OracleSDKGenerator", comments="API Version: 20180115") public interface DnsAsync extends AutoCloseable
API for the DNS service. Use this API to manage DNS zones, records, and other DNS resources. For more information, see Overview of the DNS Service.
close
void refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the serice.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
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.
region
- The region of the service.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
.
regionId
- The public region ID.void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint
templateFuture<ChangeResolverCompartmentResponse> changeResolverCompartment(ChangeResolverCompartmentRequest request, AsyncHandler<ChangeResolverCompartmentRequest,ChangeResolverCompartmentResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ChangeSteeringPolicyCompartmentResponse> changeSteeringPolicyCompartment(ChangeSteeringPolicyCompartmentRequest request, AsyncHandler<ChangeSteeringPolicyCompartmentRequest,ChangeSteeringPolicyCompartmentResponse> handler)
Moves a steering policy into a different compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ChangeTsigKeyCompartmentResponse> changeTsigKeyCompartment(ChangeTsigKeyCompartmentRequest request, AsyncHandler<ChangeTsigKeyCompartmentRequest,ChangeTsigKeyCompartmentResponse> handler)
Moves a TSIG key into a different compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ChangeViewCompartmentResponse> changeViewCompartment(ChangeViewCompartmentRequest request, AsyncHandler<ChangeViewCompartmentRequest,ChangeViewCompartmentResponse> handler)
Moves a view into a different compartment.
To change the compartment of a protected view, change the compartment of its corresponding resolver.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ChangeZoneCompartmentResponse> changeZoneCompartment(ChangeZoneCompartmentRequest request, AsyncHandler<ChangeZoneCompartmentRequest,ChangeZoneCompartmentResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateResolverEndpointResponse> createResolverEndpoint(CreateResolverEndpointRequest request, AsyncHandler<CreateResolverEndpointRequest,CreateResolverEndpointResponse> handler)
Creates a new resolver endpoint in the same compartment as the resolver.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateSteeringPolicyResponse> createSteeringPolicy(CreateSteeringPolicyRequest request, AsyncHandler<CreateSteeringPolicyRequest,CreateSteeringPolicyResponse> handler)
Creates a new steering policy in the specified compartment. For more information on creating policies with templates, see Traffic Management API Guide.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateSteeringPolicyAttachmentResponse> createSteeringPolicyAttachment(CreateSteeringPolicyAttachmentRequest request, AsyncHandler<CreateSteeringPolicyAttachmentRequest,CreateSteeringPolicyAttachmentResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateTsigKeyResponse> createTsigKey(CreateTsigKeyRequest request, AsyncHandler<CreateTsigKeyRequest,CreateTsigKeyResponse> handler)
Creates a new TSIG key in the specified compartment. There is no opc-retry-token
header
since TSIG key names must be globally unique.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateViewResponse> createView(CreateViewRequest request, AsyncHandler<CreateViewRequest,CreateViewResponse> handler)
Creates a new view in the specified compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateZoneResponse> createZone(CreateZoneRequest request, AsyncHandler<CreateZoneRequest,CreateZoneResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateZoneFromZoneFileResponse> createZoneFromZoneFile(CreateZoneFromZoneFileRequest request, AsyncHandler<CreateZoneFromZoneFileRequest,CreateZoneFromZoneFileResponse> handler)
Creates a new zone from a zone file in the specified compartment. Not supported for private zones.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteDomainRecordsResponse> deleteDomainRecords(DeleteDomainRecordsRequest request, AsyncHandler<DeleteDomainRecordsRequest,DeleteDomainRecordsResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteRRSetResponse> deleteRRSet(DeleteRRSetRequest request, AsyncHandler<DeleteRRSetRequest,DeleteRRSetResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteResolverEndpointResponse> deleteResolverEndpoint(DeleteResolverEndpointRequest request, AsyncHandler<DeleteResolverEndpointRequest,DeleteResolverEndpointResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteSteeringPolicyResponse> deleteSteeringPolicy(DeleteSteeringPolicyRequest request, AsyncHandler<DeleteSteeringPolicyRequest,DeleteSteeringPolicyResponse> handler)
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`.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteSteeringPolicyAttachmentResponse> deleteSteeringPolicyAttachment(DeleteSteeringPolicyAttachmentRequest request, AsyncHandler<DeleteSteeringPolicyAttachmentRequest,DeleteSteeringPolicyAttachmentResponse> handler)
Deletes the specified steering policy attachment. A 204
response indicates that the delete
has been successful.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteTsigKeyResponse> deleteTsigKey(DeleteTsigKeyRequest request, AsyncHandler<DeleteTsigKeyRequest,DeleteTsigKeyResponse> handler)
Deletes the specified TSIG key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteViewResponse> deleteView(DeleteViewRequest request, AsyncHandler<DeleteViewRequest,DeleteViewResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteZoneResponse> deleteZone(DeleteZoneRequest request, AsyncHandler<DeleteZoneRequest,DeleteZoneResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetDomainRecordsResponse> getDomainRecords(GetDomainRecordsRequest request, AsyncHandler<GetDomainRecordsRequest,GetDomainRecordsResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetRRSetResponse> getRRSet(GetRRSetRequest request, AsyncHandler<GetRRSetRequest,GetRRSetResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetResolverResponse> getResolver(GetResolverRequest request, AsyncHandler<GetResolverRequest,GetResolverResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetResolverEndpointResponse> getResolverEndpoint(GetResolverEndpointRequest request, AsyncHandler<GetResolverEndpointRequest,GetResolverEndpointResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetSteeringPolicyResponse> getSteeringPolicy(GetSteeringPolicyRequest request, AsyncHandler<GetSteeringPolicyRequest,GetSteeringPolicyResponse> handler)
Gets information about the specified steering policy.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetSteeringPolicyAttachmentResponse> getSteeringPolicyAttachment(GetSteeringPolicyAttachmentRequest request, AsyncHandler<GetSteeringPolicyAttachmentRequest,GetSteeringPolicyAttachmentResponse> handler)
Gets information about the specified steering policy attachment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetTsigKeyResponse> getTsigKey(GetTsigKeyRequest request, AsyncHandler<GetTsigKeyRequest,GetTsigKeyResponse> handler)
Gets information about the specified TSIG key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetViewResponse> getView(GetViewRequest request, AsyncHandler<GetViewRequest,GetViewResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetZoneResponse> getZone(GetZoneRequest request, AsyncHandler<GetZoneRequest,GetZoneResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetZoneContentResponse> getZoneContent(GetZoneContentRequest request, AsyncHandler<GetZoneContentRequest,GetZoneContentResponse> handler)
Gets the requested zone’s zone file.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetZoneRecordsResponse> getZoneRecords(GetZoneRecordsRequest request, AsyncHandler<GetZoneRecordsRequest,GetZoneRecordsResponse> handler)
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](https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4). 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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListResolverEndpointsResponse> listResolverEndpoints(ListResolverEndpointsRequest request, AsyncHandler<ListResolverEndpointsRequest,ListResolverEndpointsResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListResolversResponse> listResolvers(ListResolversRequest request, AsyncHandler<ListResolversRequest,ListResolversResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListSteeringPoliciesResponse> listSteeringPolicies(ListSteeringPoliciesRequest request, AsyncHandler<ListSteeringPoliciesRequest,ListSteeringPoliciesResponse> handler)
Gets a list of all steering policies in the specified compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListSteeringPolicyAttachmentsResponse> listSteeringPolicyAttachments(ListSteeringPolicyAttachmentsRequest request, AsyncHandler<ListSteeringPolicyAttachmentsRequest,ListSteeringPolicyAttachmentsResponse> handler)
Lists the steering policy attachments in the specified compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListTsigKeysResponse> listTsigKeys(ListTsigKeysRequest request, AsyncHandler<ListTsigKeysRequest,ListTsigKeysResponse> handler)
Gets a list of all TSIG keys in the specified compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListViewsResponse> listViews(ListViewsRequest request, AsyncHandler<ListViewsRequest,ListViewsResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListZoneTransferServersResponse> listZoneTransferServers(ListZoneTransferServersRequest request, AsyncHandler<ListZoneTransferServersRequest,ListZoneTransferServersResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListZonesResponse> listZones(ListZonesRequest request, AsyncHandler<ListZonesRequest,ListZonesResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<PatchDomainRecordsResponse> patchDomainRecords(PatchDomainRecordsRequest request, AsyncHandler<PatchDomainRecordsRequest,PatchDomainRecordsResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<PatchRRSetResponse> patchRRSet(PatchRRSetRequest request, AsyncHandler<PatchRRSetRequest,PatchRRSetResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<PatchZoneRecordsResponse> patchZoneRecords(PatchZoneRecordsRequest request, AsyncHandler<PatchZoneRecordsRequest,PatchZoneRecordsResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateDomainRecordsResponse> updateDomainRecords(UpdateDomainRecordsRequest request, AsyncHandler<UpdateDomainRecordsRequest,UpdateDomainRecordsResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateRRSetResponse> updateRRSet(UpdateRRSetRequest request, AsyncHandler<UpdateRRSetRequest,UpdateRRSetResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateResolverResponse> updateResolver(UpdateResolverRequest request, AsyncHandler<UpdateResolverRequest,UpdateResolverResponse> handler)
Updates the specified resolver with your new information.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateResolverEndpointResponse> updateResolverEndpoint(UpdateResolverEndpointRequest request, AsyncHandler<UpdateResolverEndpointRequest,UpdateResolverEndpointResponse> handler)
Updates the specified resolver endpoint with your new information.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateSteeringPolicyResponse> updateSteeringPolicy(UpdateSteeringPolicyRequest request, AsyncHandler<UpdateSteeringPolicyRequest,UpdateSteeringPolicyResponse> handler)
Updates the configuration of the specified steering policy.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateSteeringPolicyAttachmentResponse> updateSteeringPolicyAttachment(UpdateSteeringPolicyAttachmentRequest request, AsyncHandler<UpdateSteeringPolicyAttachmentRequest,UpdateSteeringPolicyAttachmentResponse> handler)
Updates the specified steering policy attachment with your new information.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateTsigKeyResponse> updateTsigKey(UpdateTsigKeyRequest request, AsyncHandler<UpdateTsigKeyRequest,UpdateTsigKeyResponse> handler)
Updates the specified TSIG key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateViewResponse> updateView(UpdateViewRequest request, AsyncHandler<UpdateViewRequest,UpdateViewResponse> handler)
Updates the specified view with your new information.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateZoneResponse> updateZone(UpdateZoneRequest request, AsyncHandler<UpdateZoneRequest,UpdateZoneResponse> handler)
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](https://docs.cloud.oracle.com/iaas/Content/DNS/Tasks/managingdnszones.htm). 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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateZoneRecordsResponse> updateZoneRecords(UpdateZoneRecordsRequest request, AsyncHandler<UpdateZoneRecordsRequest,UpdateZoneRecordsResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Copyright © 2016–2024. All rights reserved.