Class RecordService

constructor

• new RecordService(sdk: SDKInterface): RecordService

  Parameters

  • sdk: SDKInterface

  Returns RecordService

$type

create

• create(
      request: CreateRecordRequest,
  ): Request<CreateRecordRequest, Operation<GetOperationRequest>>

  Creates a DNS record

  Parameters

  • request: CreateRecordRequest

  Returns Request<CreateRecordRequest, Operation<GetOperationRequest>>

• create(
      request: CreateRecordRequest,
      metadata: Metadata,
  ): Request<CreateRecordRequest, Operation<GetOperationRequest>>

  Parameters

  • request: CreateRecordRequest
  • metadata: Metadata

  Returns Request<CreateRecordRequest, Operation<GetOperationRequest>>

• create(
      request: CreateRecordRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreateRecordRequest, Operation<GetOperationRequest>>

  Parameters

  • request: CreateRecordRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateRecordRequest, Operation<GetOperationRequest>>

• create(
      request: CreateRecordRequest,
  ): Request<CreateRecordRequest, Operation<GetOperationRequest>>

  Creates a DNS record

  Parameters

  • request: CreateRecordRequest

  Returns Request<CreateRecordRequest, Operation<GetOperationRequest>>

• create(
      request: CreateRecordRequest,
      metadata: Metadata,
  ): Request<CreateRecordRequest, Operation<GetOperationRequest>>

  Creates a DNS record

  Parameters

  • request: CreateRecordRequest
  • metadata: Metadata

  Returns Request<CreateRecordRequest, Operation<GetOperationRequest>>

• create(
      request: CreateRecordRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreateRecordRequest, Operation<GetOperationRequest>>

  Creates a DNS record

  Parameters

  • request: CreateRecordRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateRecordRequest, Operation<GetOperationRequest>>

delete

• delete(
      request: DeleteRecordRequest,
  ): Request<DeleteRecordRequest, Operation<GetOperationRequest>>

  Deletes the DNS record with the specified ID

  Parameters

  • request: DeleteRecordRequest

  Returns Request<DeleteRecordRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteRecordRequest,
      metadata: Metadata,
  ): Request<DeleteRecordRequest, Operation<GetOperationRequest>>

  Parameters

  • request: DeleteRecordRequest
  • metadata: Metadata

  Returns Request<DeleteRecordRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteRecordRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<DeleteRecordRequest, Operation<GetOperationRequest>>

  Parameters

  • request: DeleteRecordRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<DeleteRecordRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteRecordRequest,
  ): Request<DeleteRecordRequest, Operation<GetOperationRequest>>

  Deletes the DNS record with the specified ID

  Parameters

  • request: DeleteRecordRequest

  Returns Request<DeleteRecordRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteRecordRequest,
      metadata: Metadata,
  ): Request<DeleteRecordRequest, Operation<GetOperationRequest>>

  Deletes the DNS record with the specified ID

  Parameters

  • request: DeleteRecordRequest
  • metadata: Metadata

  Returns Request<DeleteRecordRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteRecordRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<DeleteRecordRequest, Operation<GetOperationRequest>>

  Deletes the DNS record with the specified ID

  Parameters

  • request: DeleteRecordRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<DeleteRecordRequest, Operation<GetOperationRequest>>

get

• get(request: GetRecordRequest): Request<GetRecordRequest, Record>

  Gets the DNS record with the specified ID

  Parameters

  • request: GetRecordRequest

  Returns Request<GetRecordRequest, Record>

• get(
      request: GetRecordRequest,
      metadata: Metadata,
  ): Request<GetRecordRequest, Record>

  Parameters

  • request: GetRecordRequest
  • metadata: Metadata

  Returns Request<GetRecordRequest, Record>

• get(
      request: GetRecordRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetRecordRequest, Record>

  Parameters

  • request: GetRecordRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetRecordRequest, Record>

• get(request: GetRecordRequest): Request<GetRecordRequest, Record>

  Gets the DNS record with the specified ID

  Parameters

  • request: GetRecordRequest

  Returns Request<GetRecordRequest, Record>

• get(
      request: GetRecordRequest,
      metadata: Metadata,
  ): Request<GetRecordRequest, Record>

  Gets the DNS record with the specified ID

  Parameters

  • request: GetRecordRequest
  • metadata: Metadata

  Returns Request<GetRecordRequest, Record>

• get(
      request: GetRecordRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetRecordRequest, Record>

  Gets the DNS record with the specified ID

  Parameters

  • request: GetRecordRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetRecordRequest, Record>

getByName

• getByName(request: GetByNameRequest): Request<GetByNameRequest, Record>

  Gets the DNS record by its parent DNS zone (metadata.parent_id) and metadata.name

  Parameters

  • request: GetByNameRequest

  Returns Request<GetByNameRequest, Record>

• getByName(
      request: GetByNameRequest,
      metadata: Metadata,
  ): Request<GetByNameRequest, Record>

  Parameters

  • request: GetByNameRequest
  • metadata: Metadata

  Returns Request<GetByNameRequest, Record>

• getByName(
      request: GetByNameRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetByNameRequest, Record>

  Parameters

  • request: GetByNameRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetByNameRequest, Record>

• getByName(request: GetByNameRequest): Request<GetByNameRequest, Record>

  Gets the DNS record by its parent DNS zone (metadata.parent_id) and metadata.name

  Parameters

  • request: GetByNameRequest

  Returns Request<GetByNameRequest, Record>

• getByName(
      request: GetByNameRequest,
      metadata: Metadata,
  ): Request<GetByNameRequest, Record>

  Gets the DNS record by its parent DNS zone (metadata.parent_id) and metadata.name

  Parameters

  • request: GetByNameRequest
  • metadata: Metadata

  Returns Request<GetByNameRequest, Record>

• getByName(
      request: GetByNameRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetByNameRequest, Record>

  Gets the DNS record by its parent DNS zone (metadata.parent_id) and metadata.name

  Parameters

  • request: GetByNameRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetByNameRequest, Record>

getOperationService

• getOperationService(): OperationService

  Returns OperationService

list

• list(
      request: ListRecordsRequest,
  ): Request<ListRecordsRequest, ListRecordsResponse>

  Lists DNS records in the specified DNS zone

  Parameters

  • request: ListRecordsRequest

  Returns Request<ListRecordsRequest, ListRecordsResponse>

• list(
      request: ListRecordsRequest,
      metadata: Metadata,
  ): Request<ListRecordsRequest, ListRecordsResponse>

  Parameters

  • request: ListRecordsRequest
  • metadata: Metadata

  Returns Request<ListRecordsRequest, ListRecordsResponse>

• list(
      request: ListRecordsRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListRecordsRequest, ListRecordsResponse>

  Parameters

  • request: ListRecordsRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListRecordsRequest, ListRecordsResponse>

• list(
      request: ListRecordsRequest,
  ): Request<ListRecordsRequest, ListRecordsResponse>

  Lists DNS records in the specified DNS zone

  Parameters

  • request: ListRecordsRequest

  Returns Request<ListRecordsRequest, ListRecordsResponse>

• list(
      request: ListRecordsRequest,
      metadata: Metadata,
  ): Request<ListRecordsRequest, ListRecordsResponse>

  Lists DNS records in the specified DNS zone

  Parameters

  • request: ListRecordsRequest
  • metadata: Metadata

  Returns Request<ListRecordsRequest, ListRecordsResponse>

• list(
      request: ListRecordsRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListRecordsRequest, ListRecordsResponse>

  Lists DNS records in the specified DNS zone

  Parameters

  • request: ListRecordsRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListRecordsRequest, ListRecordsResponse>

update

• update(
      request: UpdateRecordRequest,
  ): Request<UpdateRecordRequest, Operation<GetOperationRequest>>

  Updates the DNS record with the specified ID

  Parameters

  • request: UpdateRecordRequest

  Returns Request<UpdateRecordRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateRecordRequest,
      metadata: Metadata,
  ): Request<UpdateRecordRequest, Operation<GetOperationRequest>>

  Parameters

  • request: UpdateRecordRequest
  • metadata: Metadata

  Returns Request<UpdateRecordRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateRecordRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<UpdateRecordRequest, Operation<GetOperationRequest>>

  Parameters

  • request: UpdateRecordRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UpdateRecordRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateRecordRequest,
  ): Request<UpdateRecordRequest, Operation<GetOperationRequest>>

  Updates the DNS record with the specified ID

  Parameters

  • request: UpdateRecordRequest

  Returns Request<UpdateRecordRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateRecordRequest,
      metadata: Metadata,
  ): Request<UpdateRecordRequest, Operation<GetOperationRequest>>

  Updates the DNS record with the specified ID

  Parameters

  • request: UpdateRecordRequest
  • metadata: Metadata

  Returns Request<UpdateRecordRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateRecordRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<UpdateRecordRequest, Operation<GetOperationRequest>>

  Updates the DNS record with the specified ID

  Parameters

  • request: UpdateRecordRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UpdateRecordRequest, Operation<GetOperationRequest>>