Class ManagedZone (0.30.2)

ManagedZone(name, dns_name=None, client=None, description=None)

ManagedZones are containers for DNS resource records.

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

Parameters
Name	Description
`name`	`str` the name of the zone
`dns_name`	`str` (Optional) the DNS name of the zone. If not passed, then calls to `create` will fail.
`client`	`Client` A client which holds credentials and project configuration for the zone (which requires a project).
`description`	`str` (Optional) the description for the zone. If not passed, defaults to the value of 'dns_name'.

Properties

created

Datetime at which the zone was created.

Returns
Type	Description
`datetime.datetime, or NoneType`	the creation time (None until set from the server).

description

Description of the zone.

Returns
Type	Description
`str, or NoneType`	The description as set by the user, or None (the default).

name_server_set

Named set of DNS name servers that all host the same ManagedZones.

Most users will leave this blank.

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

Returns
Type	Description
`str, or NoneType`	The name as set by the user, or None (the default).

name_servers

Datetime at which the zone was created.

Returns
Type	Description
`list of strings, or NoneType.`	the assigned name servers (None until set from the server).

path

URL path for the zone's APIs.

Returns
Type	Description
`str`	the path based on project and dataste name.

project

Project bound to the zone.

Returns
Type	Description
`str`	the project (derived from the client).

zone_id

ID for the zone resource.

Returns
Type	Description
`str, or NoneType`	the ID (None until set from the server).

Methods

changes

changes()

Construct a change set bound to this zone.

Returns
Type	Description
`Changes`	a new `Changes` instance

create

create(client=None)

API call: create the zone via a PUT request

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

Parameter
Name	Description
`client`	`Client` (Optional) the client to use. If not passed, falls back to the `client` stored on the current zone.

delete

delete(client=None)

API call: delete the zone via a DELETE request

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

Parameter
Name	Description
`client`	`Client` (Optional) the client to use. If not passed, falls back to the `client` stored on the current zone.

exists

exists(client=None)

API call: test for the existence of the zone via a GET request

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

Parameter
Name	Description
`client`	`Client` (Optional) the client to use. If not passed, falls back to the `client` stored on the current zone.

Returns
Type	Description
`bool`	Boolean indicating existence of the managed zone.

from_api_repr

from_api_repr(resource, client)

Factory: construct a zone given its API representation

Parameters
Name	Description
`resource`	`dict` zone resource representation returned from the API
`client`	`Client` Client which holds credentials and project configuration for the zone.

Returns
Type	Description
`ManagedZone`	Zone parsed from `resource`.

list_changes

list_changes(max_results=None, page_token=None, client=None)

List change sets for this zone.

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

Parameters
Name	Description
`max_results`	`int` Optional. The maximum number of change sets to return. Defaults to a sensible value set by the API.
`page_token`	`str` Optional. If present, return the next batch of change sets, 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.
`client`	`Client` (Optional) the client to use. If not passed, falls back to the `client` stored on the current zone.

Returns
Type	Description
`google.api_core.page_iterator.Iterator`	Iterator of `.changes.Changes` belonging to this zone.

list_resource_record_sets

list_resource_record_sets(max_results=None, page_token=None, client=None)

List resource record sets for this zone.