Class Client (0.34.0)

Client(
    project=None, credentials=None, _http=None, client_info=None, client_options=None
)

Client to bundle configuration needed for API requests.

Parameters
Name	Description
`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`	`google.auth.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`	`requests.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`	`google.api_core.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`	`google.api_core.client_options.ClientOptions or dict` (Optional) Client options used to set user options on the client. API Endpoint should be set through client_options.

Methods

list_zones(max_results=None, page_token=None)

List zones for the project associated with this client.

Parameters
Name	Description
`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.

Returns
Type	Description
`google.api_core.page_iterator.Iterator`	Iterator of ManagedZone belonging to this project.

quotas()

Return DNS quotas for the project associated with this client.

Returns
Type	Description
`mapping`	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)

Construct a zone bound to this client.

Parameters
Name	Description
`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'.

Returns
Type	Description
`ManagedZone`	a new `ManagedZone` instance.