@Generated(value="OracleSDKGenerator", comments="API Version: 20180115") public class DnsClient extends Object implements Dns
Modifier and Type | Class and Description |
---|---|
static class |
DnsClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for Dns.
|
Constructor and Description |
---|
DnsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
DnsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
DnsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
DnsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
DnsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Creates a new service instance using the given authentication provider and client configuration.
|
DnsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
DnsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
DnsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
Modifier and Type | Method and Description |
---|---|
static DnsClient.Builder |
builder()
Create a builder for this client.
|
void |
close() |
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
public static final Service SERVICE
Service instance for Dns.
public DnsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public DnsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.public DnsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.public DnsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.public DnsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.public DnsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public DnsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public DnsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorpublic static DnsClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
Dns
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface Dns
endpoint
- The endpoint of the service.public void setRegion(Region region)
Dns
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.
public void setRegion(String regionId)
Dns
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
.
public void close()
close
in interface AutoCloseable
public CreateSteeringPolicyResponse createSteeringPolicy(CreateSteeringPolicyRequest request)
Dns
Creates a new steering policy in the specified compartment. For more information on creating policies with templates, see Traffic Management API Guide.
createSteeringPolicy
in interface Dns
request
- The request object containing the details to sendpublic CreateSteeringPolicyAttachmentResponse createSteeringPolicyAttachment(CreateSteeringPolicyAttachmentRequest request)
Dns
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.
createSteeringPolicyAttachment
in interface Dns
request
- The request object containing the details to sendpublic CreateZoneResponse createZone(CreateZoneRequest request)
Dns
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
.
createZone
in interface Dns
request
- The request object containing the details to sendpublic DeleteDomainRecordsResponse deleteDomainRecords(DeleteDomainRecordsRequest request)
Dns
Deletes all records at the specified zone and domain.
deleteDomainRecords
in interface Dns
request
- The request object containing the details to sendpublic DeleteRRSetResponse deleteRRSet(DeleteRRSetRequest request)
Dns
Deletes all records in the specified RRSet.
deleteRRSet
in interface Dns
request
- The request object containing the details to sendpublic DeleteSteeringPolicyResponse deleteSteeringPolicy(DeleteSteeringPolicyRequest request)
Dns
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
.
deleteSteeringPolicy
in interface Dns
request
- The request object containing the details to sendpublic DeleteSteeringPolicyAttachmentResponse deleteSteeringPolicyAttachment(DeleteSteeringPolicyAttachmentRequest request)
Dns
Deletes the specified steering policy attachment. A 204
response indicates that the delete has been successful.
deleteSteeringPolicyAttachment
in interface Dns
request
- The request object containing the details to sendpublic DeleteZoneResponse deleteZone(DeleteZoneRequest request)
Dns
Deletes the specified zone and all its steering policy attachments. A 204
response indicates that zone has been successfully deleted.
deleteZone
in interface Dns
request
- The request object containing the details to sendpublic GetDomainRecordsResponse getDomainRecords(GetDomainRecordsRequest request)
Dns
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.
getDomainRecords
in interface Dns
request
- The request object containing the details to sendpublic GetRRSetResponse getRRSet(GetRRSetRequest request)
Dns
Gets a list of all records in the specified RRSet. The results are sorted by recordHash
by default.
public GetSteeringPolicyResponse getSteeringPolicy(GetSteeringPolicyRequest request)
Dns
Gets information about the specified steering policy.
getSteeringPolicy
in interface Dns
request
- The request object containing the details to sendpublic GetSteeringPolicyAttachmentResponse getSteeringPolicyAttachment(GetSteeringPolicyAttachmentRequest request)
Dns
Gets information about the specified steering policy attachment.
getSteeringPolicyAttachment
in interface Dns
request
- The request object containing the details to sendpublic GetZoneResponse getZone(GetZoneRequest request)
Dns
Gets information about the specified zone, including its creation date, zone type, and serial.
public GetZoneRecordsResponse getZoneRecords(GetZoneRecordsRequest request)
Dns
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.
getZoneRecords
in interface Dns
request
- The request object containing the details to sendpublic ListSteeringPoliciesResponse listSteeringPolicies(ListSteeringPoliciesRequest request)
Dns
Gets a list of all steering policies in the specified compartment.
listSteeringPolicies
in interface Dns
request
- The request object containing the details to sendpublic ListSteeringPolicyAttachmentsResponse listSteeringPolicyAttachments(ListSteeringPolicyAttachmentsRequest request)
Dns
Lists the steering policy attachments in the specified compartment.
listSteeringPolicyAttachments
in interface Dns
request
- The request object containing the details to sendpublic ListZonesResponse listZones(ListZonesRequest request)
Dns
Gets a list of all zones in the specified compartment. The collection can be filtered by name, time created, and zone type.
public PatchDomainRecordsResponse patchDomainRecords(PatchDomainRecordsRequest request)
Dns
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.
patchDomainRecords
in interface Dns
request
- The request object containing the details to sendpublic PatchRRSetResponse patchRRSet(PatchRRSetRequest request)
Dns
Updates records in the specified RRSet.
patchRRSet
in interface Dns
request
- The request object containing the details to sendpublic PatchZoneRecordsResponse patchZoneRecords(PatchZoneRecordsRequest request)
Dns
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.
patchZoneRecords
in interface Dns
request
- The request object containing the details to sendpublic UpdateDomainRecordsResponse updateDomainRecords(UpdateDomainRecordsRequest request)
Dns
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.
updateDomainRecords
in interface Dns
request
- The request object containing the details to sendpublic UpdateRRSetResponse updateRRSet(UpdateRRSetRequest request)
Dns
Replaces records in the specified RRSet.
updateRRSet
in interface Dns
request
- The request object containing the details to sendpublic UpdateSteeringPolicyResponse updateSteeringPolicy(UpdateSteeringPolicyRequest request)
Dns
Updates the configuration of the specified steering policy.
updateSteeringPolicy
in interface Dns
request
- The request object containing the details to sendpublic UpdateSteeringPolicyAttachmentResponse updateSteeringPolicyAttachment(UpdateSteeringPolicyAttachmentRequest request)
Dns
Updates the specified steering policy attachment with your new information.
updateSteeringPolicyAttachment
in interface Dns
request
- The request object containing the details to sendpublic UpdateZoneResponse updateZone(UpdateZoneRequest request)
Dns
Updates the specified secondary zone with your new external master server information. For more information about secondary zone, see Manage DNS Service Zone.
updateZone
in interface Dns
request
- The request object containing the details to sendpublic UpdateZoneRecordsResponse updateZoneRecords(UpdateZoneRecordsRequest request)
Dns
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.
updateZoneRecords
in interface Dns
request
- The request object containing the details to sendpublic DnsWaiters getWaiters()
Dns
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface Dns
public DnsPaginators getPaginators()
Dns
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.
getPaginators
in interface Dns
Copyright © 2016–2019. All rights reserved.