Google Cloud DNS API . policies

Instance Methods

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

delete(project, policy, clientOperationId=None)

get(project, policy, clientOperationId=None)

list(project, maxResults=None, pageToken=None)

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, policy, body=None, clientOperationId=None)

update(project, policy, body=None, clientOperationId=None)

Method Details

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

Args:
  project: string, A parameter (required)
  body: object, The request body.
    The object takes the form of:

{
    "alternativeNameServerConfig": {
      "kind": "dns#policyAlternativeNameServerConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfig".
      "targetNameServers": [
        {
          "forwardingPath": "A String",
          "ipv4Address": "A String",
          "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfigTargetNameServer".
        },
      ],
    },
    "description": "A String",
    "enableInboundForwarding": True or False,
    "enableLogging": True or False,
    "id": "A String",
    "kind": "dns#policy", # Identifies what kind of resource this is. Value: the fixed string "dns#policy".
    "name": "A String",
    "networks": [
      {
        "kind": "dns#policyNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#policyNetwork".
        "networkUrl": "A String",
      },
    ],
  }

  clientOperationId: string, A parameter

Returns:
  An object of the form:

    {
      "alternativeNameServerConfig": {
        "kind": "dns#policyAlternativeNameServerConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfig".
        "targetNameServers": [
          {
            "forwardingPath": "A String",
            "ipv4Address": "A String",
            "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfigTargetNameServer".
          },
        ],
      },
      "description": "A String",
      "enableInboundForwarding": True or False,
      "enableLogging": True or False,
      "id": "A String",
      "kind": "dns#policy", # Identifies what kind of resource this is. Value: the fixed string "dns#policy".
      "name": "A String",
      "networks": [
        {
          "kind": "dns#policyNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#policyNetwork".
          "networkUrl": "A String",
        },
      ],
    }
delete(project, policy, clientOperationId=None)

Args:
  project: string, A parameter (required)
  policy: string, A parameter (required)
  clientOperationId: string, A parameter
get(project, policy, clientOperationId=None)

Args:
  project: string, A parameter (required)
  policy: string, A parameter (required)
  clientOperationId: string, A parameter

Returns:
  An object of the form:

    {
      "alternativeNameServerConfig": {
        "kind": "dns#policyAlternativeNameServerConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfig".
        "targetNameServers": [
          {
            "forwardingPath": "A String",
            "ipv4Address": "A String",
            "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfigTargetNameServer".
          },
        ],
      },
      "description": "A String",
      "enableInboundForwarding": True or False,
      "enableLogging": True or False,
      "id": "A String",
      "kind": "dns#policy", # Identifies what kind of resource this is. Value: the fixed string "dns#policy".
      "name": "A String",
      "networks": [
        {
          "kind": "dns#policyNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#policyNetwork".
          "networkUrl": "A String",
        },
      ],
    }
list(project, maxResults=None, pageToken=None)

Args:
  project: string, A parameter (required)
  maxResults: integer, A parameter
  pageToken: string, A parameter

Returns:
  An object of the form:

    {
    "header": {
      "operationId": "A String",
    },
    "kind": "dns#policiesListResponse", # Type of resource.
    "nextPageToken": "A String",
    "policies": [
      {
          "alternativeNameServerConfig": {
            "kind": "dns#policyAlternativeNameServerConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfig".
            "targetNameServers": [
              {
                "forwardingPath": "A String",
                "ipv4Address": "A String",
                "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfigTargetNameServer".
              },
            ],
          },
          "description": "A String",
          "enableInboundForwarding": True or False,
          "enableLogging": True or False,
          "id": "A String",
          "kind": "dns#policy", # Identifies what kind of resource this is. Value: the fixed string "dns#policy".
          "name": "A String",
          "networks": [
            {
              "kind": "dns#policyNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#policyNetwork".
              "networkUrl": "A String",
            },
          ],
        },
    ],
  }
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.
    
patch(project, policy, body=None, clientOperationId=None)

Args:
  project: string, A parameter (required)
  policy: string, A parameter (required)
  body: object, The request body.
    The object takes the form of:

{
    "alternativeNameServerConfig": {
      "kind": "dns#policyAlternativeNameServerConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfig".
      "targetNameServers": [
        {
          "forwardingPath": "A String",
          "ipv4Address": "A String",
          "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfigTargetNameServer".
        },
      ],
    },
    "description": "A String",
    "enableInboundForwarding": True or False,
    "enableLogging": True or False,
    "id": "A String",
    "kind": "dns#policy", # Identifies what kind of resource this is. Value: the fixed string "dns#policy".
    "name": "A String",
    "networks": [
      {
        "kind": "dns#policyNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#policyNetwork".
        "networkUrl": "A String",
      },
    ],
  }

  clientOperationId: string, A parameter

Returns:
  An object of the form:

    {
    "header": {
      "operationId": "A String",
    },
    "policy": {
        "alternativeNameServerConfig": {
          "kind": "dns#policyAlternativeNameServerConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfig".
          "targetNameServers": [
            {
              "forwardingPath": "A String",
              "ipv4Address": "A String",
              "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfigTargetNameServer".
            },
          ],
        },
        "description": "A String",
        "enableInboundForwarding": True or False,
        "enableLogging": True or False,
        "id": "A String",
        "kind": "dns#policy", # Identifies what kind of resource this is. Value: the fixed string "dns#policy".
        "name": "A String",
        "networks": [
          {
            "kind": "dns#policyNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#policyNetwork".
            "networkUrl": "A String",
          },
        ],
      },
  }
update(project, policy, body=None, clientOperationId=None)

Args:
  project: string, A parameter (required)
  policy: string, A parameter (required)
  body: object, The request body.
    The object takes the form of:

{
    "alternativeNameServerConfig": {
      "kind": "dns#policyAlternativeNameServerConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfig".
      "targetNameServers": [
        {
          "forwardingPath": "A String",
          "ipv4Address": "A String",
          "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfigTargetNameServer".
        },
      ],
    },
    "description": "A String",
    "enableInboundForwarding": True or False,
    "enableLogging": True or False,
    "id": "A String",
    "kind": "dns#policy", # Identifies what kind of resource this is. Value: the fixed string "dns#policy".
    "name": "A String",
    "networks": [
      {
        "kind": "dns#policyNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#policyNetwork".
        "networkUrl": "A String",
      },
    ],
  }

  clientOperationId: string, A parameter

Returns:
  An object of the form:

    {
    "header": {
      "operationId": "A String",
    },
    "policy": {
        "alternativeNameServerConfig": {
          "kind": "dns#policyAlternativeNameServerConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfig".
          "targetNameServers": [
            {
              "forwardingPath": "A String",
              "ipv4Address": "A String",
              "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfigTargetNameServer".
            },
          ],
        },
        "description": "A String",
        "enableInboundForwarding": True or False,
        "enableLogging": True or False,
        "id": "A String",
        "kind": "dns#policy", # Identifies what kind of resource this is. Value: the fixed string "dns#policy".
        "name": "A String",
        "networks": [
          {
            "kind": "dns#policyNetwork", # Identifies what kind of resource this is. Value: the fixed string "dns#policyNetwork".
            "networkUrl": "A String",
          },
        ],
      },
  }