Global

Type Definitions

ChangeExistsCallback(errnullable, exists)

Parameters:
Name Type Attributes Description
err Error <nullable>

Request error, if any.

exists boolean

Whether the Change exists.

ChangeExistsResponse :array

Properties:
Name Type Description
0 boolean

Whether the Change exists.

ClientConfig :object

Properties:
Name Type Attributes Default Description
projectId string <optional>

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 <optional>

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 string <optional>

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

credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
autoRetry boolean <optional>
true

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 number <optional>
3

Maximum number of automatic retries attempted before returning the error.

promise Constructor <optional>

Custom promise module to use instead of native Promises.

CreateZoneCallback(errnullable, zone, apiResponse)

Parameters:
Name Type Attributes Description
err Error <nullable>

Request error, if any.

zone Zone

The new Zone.

apiResponse object

The full API response.

CreateZoneRequest :object

Config to set for the zone.

Properties:
Name Type Attributes Description
dnsName string

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

description string <optional>

Description text for the zone.

CreateZoneResponse :array

Properties:
Name Type Description
0 Zone

The new Zone.

1 object

The full API response.

GetChangeCallback(errnullable, change, apiResponse)

Parameters:
Name Type Attributes Description
err Error <nullable>

Request error, if any.

change Change

The Change.

apiResponse object

The full API response.

GetChangeMetadataCallback(errnullable, metadata, apiResponse)

Parameters:
Name Type Attributes Description
err Error <nullable>

Request error, if any.

metadata object

The Change metadata.

apiResponse object

The full API response.

GetChangeMetadataResponse :array

Properties:
Name Type Description
0 object

The Change metadata.

1 object

The full API response.

GetChangeResponse :array

Properties:
Name Type Description
0 Change

The Change.

1 object

The full API response.

GetRecordsCallback(errnullable, records, apiResponse)

Parameters:
Name Type Attributes Description
err Error <nullable>

Request error, if any.

records Array.<Record>

Array of Record instances.

apiResponse object

The full API response.

GetRecordsRequest :object

Query object for listing records.

Properties:
Name Type Attributes Default Description
autoPaginate boolean <optional>
true

Have pagination handled automatically.

maxApiCalls number <optional>

Maximum number of API calls to make.

maxResults number <optional>

Maximum number of items plus prefixes to return.

name string <optional>

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

pageToken string <optional>

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

type string <optional>

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

GetRecordsResponse :array

Properties:
Name Type Description
0 Array.<Record>

Array of Record instances.

1 object

The full API response.

GetZoneCallback(errnullable, zone, apiResponse)

Parameters:
Name Type Attributes Description
err Error <nullable>

Request error, if any.

zone Zone

The Zone.

apiResponse object

The full API response.

GetZoneMetadataCallback(errnullable, metadata, apiResponse)

Parameters:
Name Type Attributes Description
err Error <nullable>

Request error, if any.

metadata object

The Zone metadata.

apiResponse object

The full API response.

GetZoneMetadataResponse :array

Properties:
Name Type Description
0 object

The Zone metadata.

1 object

The full API response.

GetZoneResponse :array

Properties:
Name Type Description
0 Zone

The Zone.

1 object

The full API response.

GetZonesCallback(errnullable, zones, apiResponse)

Parameters:
Name Type Attributes Description
err Error <nullable>

Request error, if any.

zones Array.<Zone>

Array of Zone instances.

apiResponse object

The full API response.

GetZonesRequest :object

Query object for listing zones.

Properties:
Name Type Attributes Default Description
autoPaginate boolean <optional>
true

Have pagination handled automatically.

maxApiCalls number <optional>

Maximum number of API calls to make.

maxResults number <optional>

Maximum number of items plus prefixes to return.

pageToken string <optional>

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

GetZonesResponse :array

Properties:
Name Type Description
0 Array.<Zone>

Array of Zone instances.

1 object

The full API response.

ZoneExistsCallback(errnullable, exists)

Parameters:
Name Type Attributes Description
err Error <nullable>

Request error, if any.

exists boolean

Whether the Zone exists.

ZoneExistsResponse :array

Properties:
Name Type Description
0 boolean

Whether the Zone exists.