As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

DNS Client

Client for interacting with the Google Cloud DNS API.

class google.cloud.dns.client.Client(project=None, credentials=None, _http=None, client_info=None, client_options=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 (Session) – (Optional) HTTP object to make requests. Can be any object that defines request() with the same interface as requests.Session.request(). If not passed, an _http object is created that is bound to the credentials for the current object. This parameter should be considered private, and could change in the future.

  • client_info (ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own library or partner tool.

  • client_options (ClientOptions or dict) – (Optional) Client options used to set user options on the client. API Endpoint should be set through client_options.

SCOPE: Optional[Tuple[str, ...]] = ('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) – Optional. If present, return the next batch of zones, using the value, which must correspond to the nextPageToken value returned in the previous response. Deprecated: use the pages property of the returned iterator instead of manually passing the token.

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. kind is stripped from the results.

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.