DNS Client#

Client for interacting with the Google Cloud DNS API.

class google.cloud.dns.client.Client(project=None, credentials=None, http=None)[source]#

Bases: google.cloud.client.ClientWithProject

Client to bundle configuration needed for API requests.

Parameters:
  • project (str) – the project which the client acts on behalf of. Will be passed when creating a zone. If not passed, falls back to the default inferred from the environment.
  • credentials (Credentials) – (Optional) The OAuth2 Credentials to use for this client. If not passed (and if no http object is passed), falls back to the default inferred from the environment.
  • http (Http) – (Optional) HTTP object to make requests. Can be any object that defines request() with the same interface as request(). If not passed, an http object is created that is bound to the credentials for the current object.
SCOPE = ('https://www.googleapis.com/auth/ndev.clouddns.readwrite',)#

The scopes required for authenticating as a Cloud DNS consumer.

list_zones(max_results=None, page_token=None)[source]#

List zones for the project associated with this client.

See: https://cloud.google.com/dns/api/v1/managedZones/list

Parameters:
  • max_results (int) – maximum number of zones to return, If not passed, defaults to a value set by the API.
  • page_token (str) – opaque marker for the next “page” of zones. If not passed, the API will return the first page of zones.
Return type:

Iterator

Returns:

Iterator of ManagedZone belonging to this project.

quotas()[source]#

Return DNS quotas for the project associated with this client.

See: https://cloud.google.com/dns/api/v1/projects/get

Return type:mapping
Returns:keys for the mapping correspond to those of the quota sub-mapping of the project resource.
zone(name, dns_name=None, description=None)[source]#

Construct a zone bound to this client.

Parameters:
  • name (str) – Name of the zone.
  • dns_name (str) – (Optional) DNS name of the zone. If not passed, then calls to zone.create() will fail.
  • description (str) – (Optional) the description for the zone. If not passed, defaults to the value of ‘dns_name’.
Return type:

google.cloud.dns.zone.ManagedZone

Returns:

a new ManagedZone instance.