Globals

Abstract types

ChangeExistsCallback

ChangeExistsCallback(err, exists)

Parameter

err

Error

Request error, if any.

Value may be null.

exists

boolean

Whether the Change exists.

ChangeExistsResponse

array

Property

Parameter

0

boolean

Whether the Change exists.

ClientConfig

object

Properties

Parameter

projectId

Optional

string

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

keyFilename

Optional

string

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option above is not necessary. NOTE: .pem and .p12 require you to specify the email option as well.

email

Optional

string

Account email address. Required when using a .pem or .p12 keyFilename.

credentials

Optional

object

Credentials object.

Values in credentials have the following properties:

Parameter

client_email

Optional

string

private_key

Optional

string

autoRetry

Optional

boolean

Automatically retry requests if the response is related to rate limits or certain intermittent server errors. We will exponentially backoff subsequent requests by default.

maxRetries

Optional

number

Maximum number of automatic retries attempted before returning the error.

promise

Optional

Constructor

Custom promise module to use instead of native Promises.

CreateChangeCallback

CreateChangeCallback(err, change, apiResponse)

Parameter

err

Error

Request error, if any.

Value may be null.

change

Change

A Change object.

Value may be null.

apiResponse

object

The full API response.

CreateChangeRequest

object

Config to set for the change.

Properties

Parameter

add

(Record or Array of Record)

Record objects to add to this zone.

delete

(Record or Array of Record)

Record objects to delete from this zone. Be aware that the resource records here must match exactly to be deleted.

CreateChangeResponse

array

Properties

Parameter

0

Change

A Change object.

1

object

The full API response.

CreateZoneCallback

CreateZoneCallback(err, zone, apiResponse)

Parameter

err

Error

Request error, if any.

Value may be null.

zone

Zone

The new Zone.

apiResponse

object

The full API response.

CreateZoneRequest

object

Config to set for the zone.

Properties

Parameter

dnsName

string

DNS name for the zone. E.g. "example.com."

description

Optional

string

Description text for the zone.

CreateZoneResponse

array

Properties

Parameter

0

Zone

The new Zone.

1

object

The full API response.

DeleteRecordCallback

DeleteRecordCallback(err, change, apiResponse)

Parameter

err

Error

Request error, if any.

Value may be null.

change

Change

A Change object.

Value may be null.

apiResponse

object

The full API response.

DeleteRecordResponse

array

Properties

Parameter

0

Change

A Change object.

1

object

The full API response.

DeleteZoneCallback

DeleteZoneCallback(err, apiResponse)

Parameter

err

Error

Request error, if any.

Value may be null.

apiResponse

object

The full API response.

DeleteZoneResponse

array

Property

Parameter

0

object

The full API response.

GetChangeCallback

GetChangeCallback(err, change, apiResponse)

Parameter

err

Error

Request error, if any.

Value may be null.

change

Change

The Change.

apiResponse

object

The full API response.

GetChangeMetadataCallback

GetChangeMetadataCallback(err, metadata, apiResponse)

Parameter

err

Error

Request error, if any.

Value may be null.

metadata

object

The Change metadata.

apiResponse

object

The full API response.

GetChangeMetadataResponse

array

Properties

Parameter

0

object

The Change metadata.

1

object

The full API response.

GetChangeResponse

array

Properties

Parameter

0

Change

The Change.

1

object

The full API response.

GetChangesCallback

GetChangesCallback(err, changes, apiResponse)

Parameter

err

Error

Request error, if any.

Value may be null.

changes

Array of Change

Array of Change instances.

apiResponse

object

The full API response.

GetChangesRequest

object

Query object for listing changes.

Properties

Parameter

autoPaginate

Optional

boolean

Have pagination handled automatically.

maxApiCalls

Optional

number

Maximum number of API calls to make.

maxResults

Optional

number

Maximum number of items plus prefixes to return.

pageToken

Optional

string

A previously-returned page token representing part of the larger set of results to view.

sort

Optional

string

Set to 'asc' for ascending, and 'desc' for descending or omit for no sorting.

GetChangesResponse

array

Properties

Parameter

0

Array of Change

Array of Change instances.

1

object

The full API response.

GetRecordsCallback

GetRecordsCallback(err, records, apiResponse)

Parameter

err

Error

Request error, if any.

Value may be null.

records

Array of Record

Array of Record instances.

apiResponse

object

The full API response.

GetRecordsRequest

object

Query object for listing records.

Properties

Parameter

autoPaginate

Optional

boolean

Have pagination handled automatically.

maxApiCalls

Optional

number

Maximum number of API calls to make.

maxResults

Optional

number

Maximum number of items plus prefixes to return.

name

Optional

string

Restricts the list to return only records with this fully qualified domain name.

pageToken

Optional

string

A previously-returned page token representing part of the larger set of results to view.

type

Optional

string

Restricts the list to return only records of this type. If present, the "name" parameter must also be present.

GetRecordsResponse

array

Properties

Parameter

0

Array of Record

Array of Record instances.

1

object

The full API response.

GetZoneCallback

GetZoneCallback(err, zone, apiResponse)

Parameter

err

Error

Request error, if any.

Value may be null.

zone

Zone

The Zone.

apiResponse

object

The full API response.

GetZoneMetadataCallback

GetZoneMetadataCallback(err, metadata, apiResponse)

Parameter

err

Error

Request error, if any.

Value may be null.

metadata

object

The Zone metadata.

apiResponse

object

The full API response.

GetZoneMetadataResponse

array

Properties

Parameter

0

object

The Zone metadata.

1

object

The full API response.

GetZoneResponse

array

Properties

Parameter

0

Zone

The Zone.

1

object

The full API response.

GetZonesCallback

GetZonesCallback(err, zones, apiResponse)

Parameter

err

Error

Request error, if any.

Value may be null.

zones

Array of Zone

Array of Zone instances.

apiResponse

object

The full API response.

GetZonesRequest

object

Query object for listing zones.

Properties

Parameter

autoPaginate

Optional

boolean

Have pagination handled automatically.

maxApiCalls

Optional

number

Maximum number of API calls to make.

maxResults

Optional

number

Maximum number of items plus prefixes to return.

pageToken

Optional

string

A previously-returned page token representing part of the larger set of results to view.

GetZonesResponse

array

Properties

Parameter

0

Array of Zone

Array of Zone instances.

1

object

The full API response.

ZoneAddRecordsCallback

ZoneAddRecordsCallback(err, change, apiResponse)

Parameter

err

Error

Request error, if any.

Value may be null.

change

Change

A Change object.

Value may be null.

apiResponse

object

The full API response.

ZoneAddRecordsResponse

array

Properties

Parameter

0

Change

A Change object.

1

object

The full API response.

ZoneDeleteRecordsCallback

ZoneDeleteRecordsCallback(err, change, apiResponse)

Parameter

err

Error

Request error, if any.

Value may be null.

change

Change

A Change object.

Value may be null.

apiResponse

object

The full API response.

ZoneDeleteRecordsResponse

array

Properties

Parameter

0

Change

A Change object.

1

object

The full API response.

ZoneEmptyCallback

ZoneEmptyCallback(err, change, apiResponse)

Parameter

err

Error

Request error, if any.

Value may be null.

change

Change

A Change object.

Value may be null.

apiResponse

object

The full API response.

ZoneEmptyResponse

array

Properties

Parameter

0

Change

A Change object.

1

object

The full API response.

ZoneExistsCallback

ZoneExistsCallback(err, exists)

Parameter

err

Error

Request error, if any.

Value may be null.

exists

boolean

Whether the Zone exists.

ZoneExistsResponse

array

Property

Parameter

0

boolean

Whether the Zone exists.

ZoneExportCallback

ZoneExportCallback(err, apiResponse)

Parameter

err

Error

Request error, if any.

Value may be null.

apiResponse

object

The full API response.

ZoneExportResponse

array

Property

Parameter

0

object

The full API response.

ZoneImportCallback

ZoneImportCallback(err, change, apiResponse)

Parameter

err

Error

Request error, if any.

Value may be null.

change

Change

A Change object.

Value may be null.

apiResponse

object

The full API response.

ZoneImportResponse

array

Properties

Parameter

0

Change

A Change object.

1

object

The full API response.

ZoneReplaceRecordsCallback

ZoneReplaceRecordsCallback(err, change, apiResponse)

Parameter

err

Error

Request error, if any.

Value may be null.

change

Change

A Change object.

Value may be null.

apiResponse

object

The full API response.

ZoneReplaceRecordsResponse

array

Properties

Parameter

0

Change

A Change object.

1

object

The full API response.