Cloud DNS API . changes

Instance Methods

create(project, managedZone, body=None, clientOperationId=None, x__xgafv=None)

Atomically update the ResourceRecordSet collection.

get(project, managedZone, changeId, clientOperationId=None, x__xgafv=None)

Fetch the representation of an existing Change.

list(project, managedZone, pageToken=None, sortBy=None, maxResults=None, sortOrder=None, x__xgafv=None)

Enumerate Changes to a ResourceRecordSet collection.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

create(project, managedZone, body=None, clientOperationId=None, x__xgafv=None)
Atomically update the ResourceRecordSet collection.

Args:
  project: string, Identifies the project addressed by this request. (required)
  managedZone: string, Identifies the managed zone addressed by this request. Can be the managed
zone name or id. (required)
  body: object, The request body.
    The object takes the form of:

{ # A Change represents a set of ResourceRecordSet additions and deletions
    # applied atomically to a ManagedZone. ResourceRecordSets within a
    # ManagedZone are modified by creating a new Change element in the Changes
    # collection. In turn the Changes collection also records the past
    # modifications to the ResourceRecordSets in a ManagedZone. The current
    # state of the ManagedZone is the sum effect of applying all Change
    # elements in the Changes collection in sequence.
  "id": "A String", # Unique identifier for the resource; defined by the server (output only).
  "additions": [ # Which ResourceRecordSets to add?
    { # A unit of data that will be returned by the DNS servers.
      "name": "A String", # For example, www.example.com.
      "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
        "A String",
      ],
      "type": "A String", # The identifier of a supported record type. See the list of
          # <a href="/dns/docs/overview#supported_dns_record_types">Supported
          # DNS record types</a>.
      "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
      "kind": "dns#resourceRecordSet",
      "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see
          # <a href="/dns/records/json-record">examples</a>.
        "A String",
      ],
    },
  ],
  "status": "A String", # Status of the operation (output only). A status of "done" means that the
      # request to update the authoritative servers has been sent, but the
      # servers might not be updated yet.
  "deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.
    { # A unit of data that will be returned by the DNS servers.
      "name": "A String", # For example, www.example.com.
      "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
        "A String",
      ],
      "type": "A String", # The identifier of a supported record type. See the list of
          # <a href="/dns/docs/overview#supported_dns_record_types">Supported
          # DNS record types</a>.
      "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
      "kind": "dns#resourceRecordSet",
      "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see
          # <a href="/dns/records/json-record">examples</a>.
        "A String",
      ],
    },
  ],
  "isServing": True or False, # If the DNS queries for the zone will be served.
  "kind": "dns#change",
  "startTime": "A String", # The time that this operation was started by the server (output only). This
      # is in RFC3339 text format.
}

  clientOperationId: string, For mutating operation requests only. An optional identifier
specified by the client. Must be unique for operation resources in the
Operations collection.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Change represents a set of ResourceRecordSet additions and deletions
      # applied atomically to a ManagedZone. ResourceRecordSets within a
      # ManagedZone are modified by creating a new Change element in the Changes
      # collection. In turn the Changes collection also records the past
      # modifications to the ResourceRecordSets in a ManagedZone. The current
      # state of the ManagedZone is the sum effect of applying all Change
      # elements in the Changes collection in sequence.
    "id": "A String", # Unique identifier for the resource; defined by the server (output only).
    "additions": [ # Which ResourceRecordSets to add?
      { # A unit of data that will be returned by the DNS servers.
        "name": "A String", # For example, www.example.com.
        "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
          "A String",
        ],
        "type": "A String", # The identifier of a supported record type. See the list of
            # <a href="/dns/docs/overview#supported_dns_record_types">Supported
            # DNS record types</a>.
        "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
        "kind": "dns#resourceRecordSet",
        "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see
            # <a href="/dns/records/json-record">examples</a>.
          "A String",
        ],
      },
    ],
    "status": "A String", # Status of the operation (output only). A status of "done" means that the
        # request to update the authoritative servers has been sent, but the
        # servers might not be updated yet.
    "deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.
      { # A unit of data that will be returned by the DNS servers.
        "name": "A String", # For example, www.example.com.
        "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
          "A String",
        ],
        "type": "A String", # The identifier of a supported record type. See the list of
            # <a href="/dns/docs/overview#supported_dns_record_types">Supported
            # DNS record types</a>.
        "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
        "kind": "dns#resourceRecordSet",
        "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see
            # <a href="/dns/records/json-record">examples</a>.
          "A String",
        ],
      },
    ],
    "isServing": True or False, # If the DNS queries for the zone will be served.
    "kind": "dns#change",
    "startTime": "A String", # The time that this operation was started by the server (output only). This
        # is in RFC3339 text format.
  }
get(project, managedZone, changeId, clientOperationId=None, x__xgafv=None)
Fetch the representation of an existing Change.

Args:
  project: string, Identifies the project addressed by this request. (required)
  managedZone: string, Identifies the managed zone addressed by this request. Can be the managed
zone name or id. (required)
  changeId: string, The identifier of the requested change, from a previous
ResourceRecordSetsChangeResponse. (required)
  clientOperationId: string, For mutating operation requests only. An optional identifier
specified by the client. Must be unique for operation resources in the
Operations collection.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Change represents a set of ResourceRecordSet additions and deletions
      # applied atomically to a ManagedZone. ResourceRecordSets within a
      # ManagedZone are modified by creating a new Change element in the Changes
      # collection. In turn the Changes collection also records the past
      # modifications to the ResourceRecordSets in a ManagedZone. The current
      # state of the ManagedZone is the sum effect of applying all Change
      # elements in the Changes collection in sequence.
    "id": "A String", # Unique identifier for the resource; defined by the server (output only).
    "additions": [ # Which ResourceRecordSets to add?
      { # A unit of data that will be returned by the DNS servers.
        "name": "A String", # For example, www.example.com.
        "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
          "A String",
        ],
        "type": "A String", # The identifier of a supported record type. See the list of
            # <a href="/dns/docs/overview#supported_dns_record_types">Supported
            # DNS record types</a>.
        "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
        "kind": "dns#resourceRecordSet",
        "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see
            # <a href="/dns/records/json-record">examples</a>.
          "A String",
        ],
      },
    ],
    "status": "A String", # Status of the operation (output only). A status of "done" means that the
        # request to update the authoritative servers has been sent, but the
        # servers might not be updated yet.
    "deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.
      { # A unit of data that will be returned by the DNS servers.
        "name": "A String", # For example, www.example.com.
        "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
          "A String",
        ],
        "type": "A String", # The identifier of a supported record type. See the list of
            # <a href="/dns/docs/overview#supported_dns_record_types">Supported
            # DNS record types</a>.
        "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
        "kind": "dns#resourceRecordSet",
        "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see
            # <a href="/dns/records/json-record">examples</a>.
          "A String",
        ],
      },
    ],
    "isServing": True or False, # If the DNS queries for the zone will be served.
    "kind": "dns#change",
    "startTime": "A String", # The time that this operation was started by the server (output only). This
        # is in RFC3339 text format.
  }
list(project, managedZone, pageToken=None, sortBy=None, maxResults=None, sortOrder=None, x__xgafv=None)
Enumerate Changes to a ResourceRecordSet collection.

Args:
  project: string, Identifies the project addressed by this request. (required)
  managedZone: string, Identifies the managed zone addressed by this request. Can be the managed
zone name or id. (required)
  pageToken: string, Optional. A tag returned by a previous list request that was truncated.
Use this parameter to continue a previous list request.
  sortBy: string, Sorting criterion. The only supported value is change sequence.
  maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the
server will decide how many results to return.
  sortOrder: string, Sorting order direction: 'ascending' or 'descending'.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response to a request to enumerate Changes to a ResourceRecordSets
      # collection.
    "header": { # Elements common to every response.
      "operationId": "A String", # For mutating operation requests that completed successfully.
          # This is the client_operation_id if the client specified it,
          # otherwise it is generated by the server (output only).
    },
    "nextPageToken": "A String", # The presence of this field indicates that there exist more results
        # following your last page of results in pagination order. To fetch them,
        # make another list request using this value as your pagination token.
        #
        # In this way you can retrieve the complete contents of even very large
        # collections one page at a time. However, if the contents of the collection
        # change between the first and last paginated list request, the set of all
        # elements returned will be an inconsistent view of the collection. There is
        # no way to retrieve a "snapshot" of collections larger than the maximum
        # page size.
    "kind": "dns#changesListResponse", # Type of resource.
    "changes": [ # The requested changes.
      { # A Change represents a set of ResourceRecordSet additions and deletions
          # applied atomically to a ManagedZone. ResourceRecordSets within a
          # ManagedZone are modified by creating a new Change element in the Changes
          # collection. In turn the Changes collection also records the past
          # modifications to the ResourceRecordSets in a ManagedZone. The current
          # state of the ManagedZone is the sum effect of applying all Change
          # elements in the Changes collection in sequence.
        "id": "A String", # Unique identifier for the resource; defined by the server (output only).
        "additions": [ # Which ResourceRecordSets to add?
          { # A unit of data that will be returned by the DNS servers.
            "name": "A String", # For example, www.example.com.
            "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
              "A String",
            ],
            "type": "A String", # The identifier of a supported record type. See the list of
                # <a href="/dns/docs/overview#supported_dns_record_types">Supported
                # DNS record types</a>.
            "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
            "kind": "dns#resourceRecordSet",
            "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see
                # <a href="/dns/records/json-record">examples</a>.
              "A String",
            ],
          },
        ],
        "status": "A String", # Status of the operation (output only). A status of "done" means that the
            # request to update the authoritative servers has been sent, but the
            # servers might not be updated yet.
        "deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.
          { # A unit of data that will be returned by the DNS servers.
            "name": "A String", # For example, www.example.com.
            "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
              "A String",
            ],
            "type": "A String", # The identifier of a supported record type. See the list of
                # <a href="/dns/docs/overview#supported_dns_record_types">Supported
                # DNS record types</a>.
            "ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
            "kind": "dns#resourceRecordSet",
            "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see
                # <a href="/dns/records/json-record">examples</a>.
              "A String",
            ],
          },
        ],
        "isServing": True or False, # If the DNS queries for the zone will be served.
        "kind": "dns#change",
        "startTime": "A String", # The time that this operation was started by the server (output only). This
            # is in RFC3339 text format.
      },
    ],
  }
list_next(previous_request, previous_response)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.