Globals

Abstract types

ChangeExistsCallback(err, exists)

Parameters

Name	Type	Optional	Description
err	Error		Request error, if any. Value can be null.
exists	boolean		Whether the Change exists.

Name

Type

Optional

Description

err

Error

Request error, if any.

Value can be null.

exists

boolean

Whether the Change exists.

ChangeExistsResponse array

Property

Name	Type	Optional	Description
0	boolean		Whether the Change exists.

ClientConfig object

Properties

Name Type Optional Description

projectId

string

Yes

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

string

Yes

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.

string

Yes

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

credentials

object

Yes

Credentials object.

Values in credentials have the following properties:

Name	Type	Optional	Description
client_email	string	Yes
private_key	string	Yes

autoRetry

boolean

Yes

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

Defaults to true.

maxRetries

number

Yes

Maximum number of automatic retries attempted before returning the error.

Defaults to 3.

promise

Constructor

Yes

Custom promise module to use instead of native Promises.

CreateZoneCallback(err, zone, apiResponse)

Parameters

Name	Type	Description
err	Error	Request error, if any. Value can be null.
zone	Zone	The new Zone.
apiResponse	object	The full API response.

Name

Type

Optional

Description

err

Error

Request error, if any.

Value can be null.

zone

Zone

The new Zone.

apiResponse

object

The full API response.

CreateZoneRequest object

Config to set for the zone.

Properties

Name	Type	Optional	Description
dnsName	string		DNS name for the zone. E.g. "example.com."
description	string	Yes	Description text for the zone.

CreateZoneResponse array

Properties

Name	Type	Optional	Description
0	Zone		The new Zone.
1	object		The full API response.

GetChangeCallback(err, change, apiResponse)

Parameters

Name	Type	Description
err	Error	Request error, if any. Value can be null.
change	Change	The Change.
apiResponse	object	The full API response.

Name

Type

Optional

Description

err

Error

Request error, if any.

Value can be null.

change

Change

The Change.

apiResponse

object

The full API response.

GetChangeMetadataCallback(err, metadata, apiResponse)

Parameters

Name	Type	Description
err	Error	Request error, if any. Value can be null.
metadata	object	The Change metadata.
apiResponse	object	The full API response.

Name

Type

Optional

Description

err

Error

Request error, if any.

Value can be null.

metadata

object

The Change metadata.

apiResponse

object

The full API response.

GetChangeMetadataResponse array

Properties

Name	Type	Optional	Description
0	object		The Change metadata.
1	object		The full API response.

GetChangeResponse array

Properties

Name	Type	Optional	Description
0	Change		The Change.
1	object		The full API response.

GetRecordsCallback(err, records, apiResponse)

Parameters

Name	Type	Description
err	Error	Request error, if any. Value can be null.
records	Array of Record	Array of Record instances.
apiResponse	object	The full API response.

Name

Type

Optional

Description

err

Error

Request error, if any.

Value can be null.

records

Array of Record

Array of Record instances.

apiResponse

object

The full API response.

GetRecordsRequest object

Query object for listing records.

Properties

Name	Type	Optional	Description
autoPaginate	boolean	Yes	Have pagination handled automatically. Defaults to `true`.
maxApiCalls	number	Yes	Maximum number of API calls to make.
maxResults	number	Yes	Maximum number of items plus prefixes to return.
name	string	Yes	Restricts the list to return only records with this fully qualified domain name.
pageToken	string	Yes	A previously-returned page token representing part of the larger set of results to view.
type	string	Yes	Restricts the list to return only records of this type. If present, the "name" parameter must also be present.

GetRecordsResponse array

Properties

Name	Type	Optional	Description
0	Array of Record		Array of Record instances.
1	object		The full API response.

GetZoneCallback(err, zone, apiResponse)

Parameters

Name	Type	Description
err	Error	Request error, if any. Value can be null.
zone	Zone	The Zone.
apiResponse	object	The full API response.

Name

Type

Optional

Description

err

Error

Request error, if any.

Value can be null.

zone

Zone

The Zone.

apiResponse

object

The full API response.

GetZoneMetadataCallback(err, metadata, apiResponse)

Parameters

Name	Type	Description
err	Error	Request error, if any. Value can be null.
metadata	object	The Zone metadata.
apiResponse	object	The full API response.

Name

Type

Optional

Description

err

Error

Request error, if any.

Value can be null.

metadata

object

The Zone metadata.

apiResponse

object

The full API response.

GetZoneMetadataResponse array

Properties

Name	Type	Optional	Description
0	object		The Zone metadata.
1	object		The full API response.

GetZoneResponse array

Properties

Name	Type	Optional	Description
0	Zone		The Zone.
1	object		The full API response.

GetZonesCallback(err, zones, apiResponse)

Parameters

Name	Type	Description
err	Error	Request error, if any. Value can be null.
zones	Array of Zone	Array of Zone instances.
apiResponse	object	The full API response.

Name

Type

Optional

Description

err

Error

Request error, if any.

Value can be null.

zones

Array of Zone

Array of Zone instances.

apiResponse

object

The full API response.

GetZonesRequest object

Query object for listing zones.

Properties

Name	Type	Optional	Description
autoPaginate	boolean	Yes	Have pagination handled automatically. Defaults to `true`.
maxApiCalls	number	Yes	Maximum number of API calls to make.
maxResults	number	Yes	Maximum number of items plus prefixes to return.
pageToken	string	Yes	A previously-returned page token representing part of the larger set of results to view.

GetZonesResponse array

Properties

Name	Type	Optional	Description
0	Array of Zone		Array of Zone instances.
1	object		The full API response.

ZoneExistsCallback(err, exists)

Parameters

Name	Type	Optional	Description
err	Error		Request error, if any. Value can be null.
exists	boolean		Whether the Zone exists.

Name

Type

Optional

Description

err

Error

Request error, if any.

Value can be null.

exists

boolean

Whether the Zone exists.

ZoneExistsResponse array

Property

Name	Type	Optional	Description
0	boolean		Whether the Zone exists.