@Generated(value="OracleSDKGenerator", comments="API Version: 20180115") public interface Dns 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.
This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.
Modifier and Type | Method and Description |
---|---|
ChangeResolverCompartmentResponse |
changeResolverCompartment(ChangeResolverCompartmentRequest request)
Moves a resolver into a different compartment along with its protected default view and any
endpoints.
|
ChangeSteeringPolicyCompartmentResponse |
changeSteeringPolicyCompartment(ChangeSteeringPolicyCompartmentRequest request)
Moves a steering policy into a different compartment.
|
ChangeTsigKeyCompartmentResponse |
changeTsigKeyCompartment(ChangeTsigKeyCompartmentRequest request)
Moves a TSIG key into a different compartment.
|
ChangeViewCompartmentResponse |
changeViewCompartment(ChangeViewCompartmentRequest request)
Moves a view into a different compartment.
|
ChangeZoneCompartmentResponse |
changeZoneCompartment(ChangeZoneCompartmentRequest request)
Moves a zone into a different compartment.
|
CreateResolverEndpointResponse |
createResolverEndpoint(CreateResolverEndpointRequest request)
Creates a new resolver endpoint in the same compartment as the resolver.
|
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.
|
CreateViewResponse |
createView(CreateViewRequest request)
Creates a new view in the specified compartment.
|
CreateZoneResponse |
createZone(CreateZoneRequest request)
Creates a new zone in the specified compartment.
|
CreateZoneFromZoneFileResponse |
createZoneFromZoneFile(CreateZoneFromZoneFileRequest request)
Creates a new zone from a zone file in the specified compartment.
|
DeleteDomainRecordsResponse |
deleteDomainRecords(DeleteDomainRecordsRequest request)
Deletes all records at the specified zone and domain.
|
DeleteResolverEndpointResponse |
deleteResolverEndpoint(DeleteResolverEndpointRequest request)
Deletes the specified resolver endpoint.
|
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.
|
DeleteViewResponse |
deleteView(DeleteViewRequest request)
Deletes the specified view.
|
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.
|
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
DnsPaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may
return multiple pages of data.
|
GetResolverResponse |
getResolver(GetResolverRequest request)
Gets information about a specific resolver.
|
GetResolverEndpointResponse |
getResolverEndpoint(GetResolverEndpointRequest request)
Gets information about a specific resolver endpoint.
|
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.
|
GetViewResponse |
getView(GetViewRequest request)
Gets information about a specific view.
|
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.
|
GetZoneContentResponse |
getZoneContent(GetZoneContentRequest request)
Gets the requested zone’s zone file.
|
GetZoneRecordsResponse |
getZoneRecords(GetZoneRecordsRequest request)
Gets all records in the specified zone.
|
ListResolverEndpointsResponse |
listResolverEndpoints(ListResolverEndpointsRequest request)
Gets a list of all endpoints within a resolver.
|
ListResolversResponse |
listResolvers(ListResolversRequest request)
Gets a list of all resolvers within a compartment.
|
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.
|
ListViewsResponse |
listViews(ListViewsRequest request)
Gets a list of all views within a compartment.
|
ListZonesResponse |
listZones(ListZonesRequest request)
Gets a list of all zones in the specified compartment.
|
ListZoneTransferServersResponse |
listZoneTransferServers(ListZoneTransferServersRequest request)
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.
|
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 |
refreshClient()
Rebuilds the client from scratch.
|
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.
|
UpdateResolverResponse |
updateResolver(UpdateResolverRequest request)
Updates the specified resolver with your new information.
|
UpdateResolverEndpointResponse |
updateResolverEndpoint(UpdateResolverEndpointRequest request)
Updates the specified resolver endpoint with your new information.
|
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.
|
UpdateViewResponse |
updateView(UpdateViewRequest request)
Updates the specified view with your new information.
|
UpdateZoneResponse |
updateZone(UpdateZoneRequest request)
Updates the zone with the specified information.
|
UpdateZoneRecordsResponse |
updateZoneRecords(UpdateZoneRecordsRequest request)
Replaces records in the specified zone with the records specified in the request body.
|
void |
useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not.
|
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 service.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
templateChangeResolverCompartmentResponse changeResolverCompartment(ChangeResolverCompartmentRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeResolverCompartment API.
ChangeSteeringPolicyCompartmentResponse changeSteeringPolicyCompartment(ChangeSteeringPolicyCompartmentRequest request)
Moves a steering policy into a different compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeSteeringPolicyCompartment API.
ChangeTsigKeyCompartmentResponse changeTsigKeyCompartment(ChangeTsigKeyCompartmentRequest request)
Moves a TSIG key into a different compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeTsigKeyCompartment API.
ChangeViewCompartmentResponse changeViewCompartment(ChangeViewCompartmentRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeViewCompartment API.
ChangeZoneCompartmentResponse changeZoneCompartment(ChangeZoneCompartmentRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeZoneCompartment API.
CreateResolverEndpointResponse createResolverEndpoint(CreateResolverEndpointRequest request)
Creates a new resolver endpoint in the same compartment as the resolver.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateResolverEndpoint API.
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateSteeringPolicy API.
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateSteeringPolicyAttachment API.
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateTsigKey API.
CreateViewResponse createView(CreateViewRequest request)
Creates a new view in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateView API.
CreateZoneResponse createZone(CreateZoneRequest request)
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 sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateZone API.
CreateZoneFromZoneFileResponse createZoneFromZoneFile(CreateZoneFromZoneFileRequest request)
Creates a new zone from a zone file in the specified compartment. Not supported for private zones.
Note: This operation consumes a stream.
If the stream supports InputStream.mark(int)
and InputStream.reset()
, when a retry is necessary, the stream is reset so it starts at
the beginning (or whatever the stream's position was at the time this operation is called}.
Note this means that if the caller has used InputStream.mark(int)
before,
then the mark will not be the same anymore after this operation, and a subsequent call to
InputStream.reset()
by the caller will reset the stream not to the caller's
mark, but to the position the stream was in when this operation was called.
If the stream is a FileInputStream
, and the stream's FileChannel
position can be changed (like for a regular file), the stream
will be wrapped in such a way that it does provide support for InputStream.mark(int)
and InputStream.reset()
. Then the same
procedure as above is followed. If the stream's FileChannel
position cannot be changed (like for a named pipe), then the stream's contents will be
buffered in memory, as described below.
If the stream does not support InputStream.mark(int)
and InputStream.reset()
, then the stream is wrapped in a BufferedInputStream
, which means the entire contents may be buffered in memory. Then
the same procedure as above is followed.
The contents of the stream, except when the stream is a FileInputStream
whose FileChannel
position can be changed, should be less than 2
GiB in size if retries are used. This is because streams 2 GiB in size or larger do no
guarantee that mark-and-reset can be performed. If the stream is larger, do not use built-in
retries and manage retries yourself.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateZoneFromZoneFile API.
DeleteDomainRecordsResponse deleteDomainRecords(DeleteDomainRecordsRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteDomainRecords API.
DeleteRRSetResponse deleteRRSet(DeleteRRSetRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteRRSet API.
DeleteResolverEndpointResponse deleteResolverEndpoint(DeleteResolverEndpointRequest request)
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 sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteResolverEndpoint API.
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`.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteSteeringPolicy API.
DeleteSteeringPolicyAttachmentResponse deleteSteeringPolicyAttachment(DeleteSteeringPolicyAttachmentRequest request)
Deletes the specified steering policy attachment. A 204
response indicates that the delete
has been successful.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteSteeringPolicyAttachment API.
DeleteTsigKeyResponse deleteTsigKey(DeleteTsigKeyRequest request)
Deletes the specified TSIG key.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteTsigKey API.
DeleteViewResponse deleteView(DeleteViewRequest request)
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 sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteView API.
DeleteZoneResponse deleteZone(DeleteZoneRequest request)
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 sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteZone API.
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. 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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetDomainRecords API.
GetRRSetResponse getRRSet(GetRRSetRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetRRSet API.
GetResolverResponse getResolver(GetResolverRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetResolver API.
GetResolverEndpointResponse getResolverEndpoint(GetResolverEndpointRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetResolverEndpoint API.
GetSteeringPolicyResponse getSteeringPolicy(GetSteeringPolicyRequest request)
Gets information about the specified steering policy.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetSteeringPolicy API.
GetSteeringPolicyAttachmentResponse getSteeringPolicyAttachment(GetSteeringPolicyAttachmentRequest request)
Gets information about the specified steering policy attachment.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetSteeringPolicyAttachment API.
GetTsigKeyResponse getTsigKey(GetTsigKeyRequest request)
Gets information about the specified TSIG key.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetTsigKey API.
GetViewResponse getView(GetViewRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetView API.
GetZoneResponse getZone(GetZoneRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetZone API.
GetZoneContentResponse getZoneContent(GetZoneContentRequest request)
Gets the requested zone’s zone file.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetZoneContent API.
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](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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetZoneRecords API.
ListResolverEndpointsResponse listResolverEndpoints(ListResolverEndpointsRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListResolverEndpoints API.
ListResolversResponse listResolvers(ListResolversRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListResolvers API.
ListSteeringPoliciesResponse listSteeringPolicies(ListSteeringPoliciesRequest request)
Gets a list of all steering policies in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListSteeringPolicies API.
ListSteeringPolicyAttachmentsResponse listSteeringPolicyAttachments(ListSteeringPolicyAttachmentsRequest request)
Lists the steering policy attachments in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListSteeringPolicyAttachments API.
ListTsigKeysResponse listTsigKeys(ListTsigKeysRequest request)
Gets a list of all TSIG keys in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListTsigKeys API.
ListViewsResponse listViews(ListViewsRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListViews API.
ListZoneTransferServersResponse listZoneTransferServers(ListZoneTransferServersRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListZoneTransferServers API.
ListZonesResponse listZones(ListZonesRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListZones API.
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. 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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use PatchDomainRecords API.
PatchRRSetResponse patchRRSet(PatchRRSetRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use PatchRRSet API.
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. 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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use PatchZoneRecords API.
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. 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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateDomainRecords API.
UpdateRRSetResponse updateRRSet(UpdateRRSetRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateRRSet API.
UpdateResolverResponse updateResolver(UpdateResolverRequest request)
Updates the specified resolver with your new information.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateResolver API.
UpdateResolverEndpointResponse updateResolverEndpoint(UpdateResolverEndpointRequest request)
Updates the specified resolver endpoint with your new information.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateResolverEndpoint API.
UpdateSteeringPolicyResponse updateSteeringPolicy(UpdateSteeringPolicyRequest request)
Updates the configuration of the specified steering policy.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateSteeringPolicy API.
UpdateSteeringPolicyAttachmentResponse updateSteeringPolicyAttachment(UpdateSteeringPolicyAttachmentRequest request)
Updates the specified steering policy attachment with your new information.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateSteeringPolicyAttachment API.
UpdateTsigKeyResponse updateTsigKey(UpdateTsigKeyRequest request)
Updates the specified TSIG key.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateTsigKey API.
UpdateViewResponse updateView(UpdateViewRequest request)
Updates the specified view with your new information.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateView API.
UpdateZoneResponse updateZone(UpdateZoneRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateZone API.
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. 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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateZoneRecords API.
DnsWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
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.
Copyright © 2016–2024. All rights reserved.