Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DnsClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • DnsClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new DnsClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): DnsClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

_waiters: DnsWaiter

targetService

targetService: string = "Dns"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://dns.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • 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"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

changeResolverCompartment

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeResolverCompartment API.

    Parameters

    Returns Promise<ChangeResolverCompartmentResponse>

    ChangeResolverCompartmentResponse

changeSteeringPolicyCompartment

  • Moves a steering policy into a different compartment.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeSteeringPolicyCompartment API.

    Parameters

    Returns Promise<ChangeSteeringPolicyCompartmentResponse>

    ChangeSteeringPolicyCompartmentResponse

changeTsigKeyCompartment

  • Moves a TSIG key into a different compartment.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeTsigKeyCompartment API.

    Parameters

    Returns Promise<ChangeTsigKeyCompartmentResponse>

    ChangeTsigKeyCompartmentResponse

changeViewCompartment

  • Moves a view into a different compartment.

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeViewCompartment API.

    Parameters

    Returns Promise<ChangeViewCompartmentResponse>

    ChangeViewCompartmentResponse

changeZoneCompartment

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeZoneCompartment API.

    Parameters

    Returns Promise<ChangeZoneCompartmentResponse>

    ChangeZoneCompartmentResponse

close

  • close(): void

createResolverEndpoint

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateResolverEndpoint API.

    Parameters

    Returns Promise<CreateResolverEndpointResponse>

    CreateResolverEndpointResponse

createSteeringPolicy

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateSteeringPolicy API.

    Parameters

    Returns Promise<CreateSteeringPolicyResponse>

    CreateSteeringPolicyResponse

createSteeringPolicyAttachment

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateSteeringPolicyAttachment API.

    Parameters

    Returns Promise<CreateSteeringPolicyAttachmentResponse>

    CreateSteeringPolicyAttachmentResponse

createTsigKey

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateTsigKey API.

    Parameters

    Returns Promise<CreateTsigKeyResponse>

    CreateTsigKeyResponse

createView

  • Creates a new view in the specified compartment.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateView API.

    Parameters

    Returns Promise<CreateViewResponse>

    CreateViewResponse

createWaiters

  • Creates a new DnsWaiter for resources for this service.

    Parameters

    • workRequestClient: WorkRequestClient

      The work request service client used to query for work request status

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns DnsWaiter

    The service waiters.

createZone

  • 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.

    This operation does not retry by default if the user has not defined a retry configuration.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateZone API.

    Parameters

    Returns Promise<CreateZoneResponse>

    CreateZoneResponse

createZoneFromZoneFile

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

    This operation does not retry by default if the user has not defined a retry configuration.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateZoneFromZoneFile API.

    Parameters

    Returns Promise<CreateZoneFromZoneFileResponse>

    CreateZoneFromZoneFileResponse

deleteDomainRecords

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteDomainRecords API.

    Parameters

    Returns Promise<DeleteDomainRecordsResponse>

    DeleteDomainRecordsResponse

deleteRRSet

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteRRSet API.

    Parameters

    Returns Promise<DeleteRRSetResponse>

    DeleteRRSetResponse

deleteResolverEndpoint

  • 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.

    This operation does not retry by default if the user has not defined a retry configuration.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteResolverEndpoint API.

    Parameters

    Returns Promise<DeleteResolverEndpointResponse>

    DeleteResolverEndpointResponse

deleteSteeringPolicy

  • 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`.

    This operation does not retry by default if the user has not defined a retry configuration.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteSteeringPolicy API.

    Parameters

    Returns Promise<DeleteSteeringPolicyResponse>

    DeleteSteeringPolicyResponse

deleteSteeringPolicyAttachment

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

    This operation does not retry by default if the user has not defined a retry configuration.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteSteeringPolicyAttachment API.

    Parameters

    Returns Promise<DeleteSteeringPolicyAttachmentResponse>

    DeleteSteeringPolicyAttachmentResponse

deleteTsigKey

  • Deletes the specified TSIG key.

    This operation does not retry by default if the user has not defined a retry configuration.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteTsigKey API.

    Parameters

    Returns Promise<DeleteTsigKeyResponse>

    DeleteTsigKeyResponse

deleteView

  • 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.

    This operation does not retry by default if the user has not defined a retry configuration.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteView API.

    Parameters

    Returns Promise<DeleteViewResponse>

    DeleteViewResponse

deleteZone

  • 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.

    This operation does not retry by default if the user has not defined a retry configuration.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteZone API.

    Parameters

    Returns Promise<DeleteZoneResponse>

    DeleteZoneResponse

getAllDomainRecords

  • NOTE: This function is deprecated in favor of getDomainRecordsRecordIterator function. Creates a new async iterator which will iterate over the models.Record objects contained in responses from the getDomainRecords operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Record>

getAllDomainRecordsResponses

  • NOTE: This function is deprecated in favor of getDomainRecordsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the getDomainRecords operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<GetDomainRecordsResponse>

getAllRRSet

  • NOTE: This function is deprecated in favor of getRRSetRecordIterator function. Creates a new async iterator which will iterate over the models.Record objects contained in responses from the getRRSet operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: GetRRSetRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<Record>

getAllRRSetResponses

  • NOTE: This function is deprecated in favor of getRRSetResponseIterator function. Creates a new async iterator which will iterate over the responses received from the getRRSet operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: GetRRSetRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<GetRRSetResponse>

getAllZoneRecords

  • NOTE: This function is deprecated in favor of getZoneRecordsRecordIterator function. Creates a new async iterator which will iterate over the models.Record objects contained in responses from the getZoneRecords operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Record>

getAllZoneRecordsResponses

  • NOTE: This function is deprecated in favor of getZoneRecordsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the getZoneRecords operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<GetZoneRecordsResponse>

getDomainRecords

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDomainRecords API.

    Parameters

    Returns Promise<GetDomainRecordsResponse>

    GetDomainRecordsResponse

getDomainRecordsRecordIterator

  • Creates a new async iterator which will iterate over the models.Record objects contained in responses from the getDomainRecords operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Record>

getDomainRecordsResponseIterator

getRRSet

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetRRSet API.

    Parameters

    Returns Promise<GetRRSetResponse>

    GetRRSetResponse

getRRSetRecordIterator

  • Creates a new async iterator which will iterate over the models.Record objects contained in responses from the getRRSet operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: GetRRSetRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<Record>

getRRSetResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the getRRSet operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: GetRRSetRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<GetRRSetResponse>

getResolver

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetResolver API.

    Parameters

    Returns Promise<GetResolverResponse>

    GetResolverResponse

getResolverEndpoint

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetResolverEndpoint API.

    Parameters

    Returns Promise<GetResolverEndpointResponse>

    GetResolverEndpointResponse

getSteeringPolicy

  • Gets information about the specified steering policy.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetSteeringPolicy API.

    Parameters

    Returns Promise<GetSteeringPolicyResponse>

    GetSteeringPolicyResponse

getSteeringPolicyAttachment

  • Gets information about the specified steering policy attachment.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetSteeringPolicyAttachment API.

    Parameters

    Returns Promise<GetSteeringPolicyAttachmentResponse>

    GetSteeringPolicyAttachmentResponse

getTsigKey

  • Gets information about the specified TSIG key.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetTsigKey API.

    Parameters

    Returns Promise<GetTsigKeyResponse>

    GetTsigKeyResponse

getView

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetView API.

    Parameters

    Returns Promise<GetViewResponse>

    GetViewResponse

getWaiters

getZone

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetZone API.

    Parameters

    Returns Promise<GetZoneResponse>

    GetZoneResponse

getZoneContent

  • Gets the requested zone's zone file.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetZoneContent API.

    Parameters

    Returns Promise<GetZoneContentResponse>

    GetZoneContentResponse

getZoneRecords

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetZoneRecords API.

    Parameters

    Returns Promise<GetZoneRecordsResponse>

    GetZoneRecordsResponse

getZoneRecordsRecordIterator

  • Creates a new async iterator which will iterate over the models.Record objects contained in responses from the getZoneRecords operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Record>

getZoneRecordsResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the getZoneRecords operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<GetZoneRecordsResponse>

listAllResolverEndpoints

  • NOTE: This function is deprecated in favor of listResolverEndpointsRecordIterator function. Creates a new async iterator which will iterate over the models.ResolverEndpointSummary objects contained in responses from the listResolverEndpoints operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ResolverEndpointSummary>

listAllResolverEndpointsResponses

  • NOTE: This function is deprecated in favor of listResolverEndpointsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listResolverEndpoints operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListResolverEndpointsResponse>

listAllResolvers

  • NOTE: This function is deprecated in favor of listResolversRecordIterator function. Creates a new async iterator which will iterate over the models.ResolverSummary objects contained in responses from the listResolvers operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ResolverSummary>

listAllResolversResponses

  • NOTE: This function is deprecated in favor of listResolversResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listResolvers operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListResolversResponse>

listAllSteeringPolicies

  • NOTE: This function is deprecated in favor of listSteeringPoliciesRecordIterator function. Creates a new async iterator which will iterate over the models.SteeringPolicySummary objects contained in responses from the listSteeringPolicies operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<SteeringPolicySummary>

listAllSteeringPoliciesResponses

  • NOTE: This function is deprecated in favor of listSteeringPoliciesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listSteeringPolicies operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListSteeringPoliciesResponse>

listAllSteeringPolicyAttachments

  • NOTE: This function is deprecated in favor of listSteeringPolicyAttachmentsRecordIterator function. Creates a new async iterator which will iterate over the models.SteeringPolicyAttachmentSummary objects contained in responses from the listSteeringPolicyAttachments operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<SteeringPolicyAttachmentSummary>

listAllSteeringPolicyAttachmentsResponses

  • NOTE: This function is deprecated in favor of listSteeringPolicyAttachmentsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listSteeringPolicyAttachments operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListSteeringPolicyAttachmentsResponse>

listAllTsigKeys

  • NOTE: This function is deprecated in favor of listTsigKeysRecordIterator function. Creates a new async iterator which will iterate over the models.TsigKeySummary objects contained in responses from the listTsigKeys operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<TsigKeySummary>

listAllTsigKeysResponses

  • NOTE: This function is deprecated in favor of listTsigKeysResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listTsigKeys operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListTsigKeysResponse>

listAllViews

  • NOTE: This function is deprecated in favor of listViewsRecordIterator function. Creates a new async iterator which will iterate over the models.ViewSummary objects contained in responses from the listViews operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListViewsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ViewSummary>

listAllViewsResponses

  • NOTE: This function is deprecated in favor of listViewsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listViews operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListViewsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListViewsResponse>

listAllZoneTransferServers

  • NOTE: This function is deprecated in favor of listZoneTransferServersRecordIterator function. Creates a new async iterator which will iterate over the models.ZoneTransferServer objects contained in responses from the listZoneTransferServers operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ZoneTransferServer>

listAllZoneTransferServersResponses

  • NOTE: This function is deprecated in favor of listZoneTransferServersResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listZoneTransferServers operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListZoneTransferServersResponse>

listAllZones

  • NOTE: This function is deprecated in favor of listZonesRecordIterator function. Creates a new async iterator which will iterate over the models.ZoneSummary objects contained in responses from the listZones operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListZonesRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ZoneSummary>

listAllZonesResponses

  • NOTE: This function is deprecated in favor of listZonesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listZones operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListZonesRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListZonesResponse>

listResolverEndpoints

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListResolverEndpoints API.

    Parameters

    Returns Promise<ListResolverEndpointsResponse>

    ListResolverEndpointsResponse

listResolverEndpointsRecordIterator

  • Creates a new async iterator which will iterate over the models.ResolverEndpointSummary objects contained in responses from the listResolverEndpoints operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ResolverEndpointSummary>

listResolverEndpointsResponseIterator

listResolvers

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListResolvers API.

    Parameters

    Returns Promise<ListResolversResponse>

    ListResolversResponse

listResolversRecordIterator

  • Creates a new async iterator which will iterate over the models.ResolverSummary objects contained in responses from the listResolvers operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ResolverSummary>

listResolversResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listResolvers operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListResolversResponse>

listSteeringPolicies

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSteeringPolicies API.

    Parameters

    Returns Promise<ListSteeringPoliciesResponse>

    ListSteeringPoliciesResponse

listSteeringPoliciesRecordIterator

  • Creates a new async iterator which will iterate over the models.SteeringPolicySummary objects contained in responses from the listSteeringPolicies operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<SteeringPolicySummary>

listSteeringPoliciesResponseIterator

listSteeringPolicyAttachments

  • Lists the steering policy attachments in the specified compartment.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSteeringPolicyAttachments API.

    Parameters

    Returns Promise<ListSteeringPolicyAttachmentsResponse>

    ListSteeringPolicyAttachmentsResponse

listSteeringPolicyAttachmentsRecordIterator

listSteeringPolicyAttachmentsResponseIterator

listTsigKeys

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListTsigKeys API.

    Parameters

    Returns Promise<ListTsigKeysResponse>

    ListTsigKeysResponse

listTsigKeysRecordIterator

  • Creates a new async iterator which will iterate over the models.TsigKeySummary objects contained in responses from the listTsigKeys operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<TsigKeySummary>

listTsigKeysResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listTsigKeys operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListTsigKeysResponse>

listViews

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListViews API.

    Parameters

    Returns Promise<ListViewsResponse>

    ListViewsResponse

listViewsRecordIterator

  • Creates a new async iterator which will iterate over the models.ViewSummary objects contained in responses from the listViews operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListViewsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ViewSummary>

listViewsResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listViews operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListViewsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListViewsResponse>

listZoneTransferServers

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListZoneTransferServers API.

    Parameters

    Returns Promise<ListZoneTransferServersResponse>

    ListZoneTransferServersResponse

listZoneTransferServersRecordIterator

  • Creates a new async iterator which will iterate over the models.ZoneTransferServer objects contained in responses from the listZoneTransferServers operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ZoneTransferServer>

listZoneTransferServersResponseIterator

listZones

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListZones API.

    Parameters

    Returns Promise<ListZonesResponse>

    ListZonesResponse

listZonesRecordIterator

  • Creates a new async iterator which will iterate over the models.ZoneSummary objects contained in responses from the listZones operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListZonesRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ZoneSummary>

listZonesResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listZones operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListZonesRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListZonesResponse>

patchDomainRecords

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use PatchDomainRecords API.

    Parameters

    Returns Promise<PatchDomainRecordsResponse>

    PatchDomainRecordsResponse

patchRRSet

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use PatchRRSet API.

    Parameters

    Returns Promise<PatchRRSetResponse>

    PatchRRSetResponse

patchZoneRecords

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use PatchZoneRecords API.

    Parameters

    Returns Promise<PatchZoneRecordsResponse>

    PatchZoneRecordsResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateDomainRecords

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateDomainRecords API.

    Parameters

    Returns Promise<UpdateDomainRecordsResponse>

    UpdateDomainRecordsResponse

updateRRSet

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateRRSet API.

    Parameters

    Returns Promise<UpdateRRSetResponse>

    UpdateRRSetResponse

updateResolver

  • Updates the specified resolver with your new information.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateResolver API.

    Parameters

    Returns Promise<UpdateResolverResponse>

    UpdateResolverResponse

updateResolverEndpoint

  • Updates the specified resolver endpoint with your new information.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateResolverEndpoint API.

    Parameters

    Returns Promise<UpdateResolverEndpointResponse>

    UpdateResolverEndpointResponse

updateSteeringPolicy

  • Updates the configuration of the specified steering policy.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateSteeringPolicy API.

    Parameters

    Returns Promise<UpdateSteeringPolicyResponse>

    UpdateSteeringPolicyResponse

updateSteeringPolicyAttachment

  • Updates the specified steering policy attachment with your new information.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateSteeringPolicyAttachment API.

    Parameters

    Returns Promise<UpdateSteeringPolicyAttachmentResponse>

    UpdateSteeringPolicyAttachmentResponse

updateTsigKey

  • Updates the specified TSIG key.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateTsigKey API.

    Parameters

    Returns Promise<UpdateTsigKeyResponse>

    UpdateTsigKeyResponse

updateView

  • Updates the specified view with your new information.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateView API.

    Parameters

    Returns Promise<UpdateViewResponse>

    UpdateViewResponse

updateZone

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateZone API.

    Parameters

    Returns Promise<UpdateZoneResponse>

    UpdateZoneResponse

updateZoneRecords

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateZoneRecords API.

    Parameters

    Returns Promise<UpdateZoneRecordsResponse>

    UpdateZoneRecordsResponse