docs: update generated docs (#981)
diff --git a/docs/dyn/dns_v1.policies.html b/docs/dyn/dns_v1.policies.html
index 7df9679..46c3f7a 100644
--- a/docs/dyn/dns_v1.policies.html
+++ b/docs/dyn/dns_v1.policies.html
@@ -72,188 +72,292 @@
</style>
-<h1><a href="dns_v1.html">Google Cloud DNS API</a> . <a href="dns_v1.policies.html">policies</a></h1>
+<h1><a href="dns_v1.html">Cloud DNS API</a> . <a href="dns_v1.policies.html">policies</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#create">create(project, body=None, clientOperationId=None)</a></code></p>
-<p class="firstline"></p>
+ <code><a href="#create">create(project, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Create a new Policy</p>
<p class="toc_element">
- <code><a href="#delete">delete(project, policy, clientOperationId=None)</a></code></p>
-<p class="firstline"></p>
+ <code><a href="#delete">delete(project, policy, clientOperationId=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Delete a previously created Policy. Will fail if the policy is still being</p>
<p class="toc_element">
- <code><a href="#get">get(project, policy, clientOperationId=None)</a></code></p>
-<p class="firstline"></p>
+ <code><a href="#get">get(project, policy, clientOperationId=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Fetch the representation of an existing Policy.</p>
<p class="toc_element">
- <code><a href="#list">list(project, maxResults=None, pageToken=None)</a></code></p>
-<p class="firstline"></p>
+ <code><a href="#list">list(project, pageToken=None, maxResults=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Enumerate all Policies associated with a project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#patch">patch(project, policy, body=None, clientOperationId=None)</a></code></p>
-<p class="firstline"></p>
+ <code><a href="#patch">patch(project, policy, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Apply a partial update to an existing Policy.</p>
<p class="toc_element">
- <code><a href="#update">update(project, policy, body=None, clientOperationId=None)</a></code></p>
-<p class="firstline"></p>
+ <code><a href="#update">update(project, policy, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Update an existing Policy.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(project, body=None, clientOperationId=None)</code>
- <pre>
+ <code class="details" id="create">create(project, body=None, clientOperationId=None, x__xgafv=None)</code>
+ <pre>Create a new Policy
Args:
- project: string, A parameter (required)
+ project: string, Identifies the project addressed by this request. (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": [
+{ # A policy is a collection of DNS rules applied to one or more Virtual Private
+ # Cloud resources.
+ "kind": "dns#policy",
+ "name": "A String", # User assigned name for this policy.
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+ "networks": [ # List of network names specifying networks to which this policy is applied.
+ {
+ "kind": "dns#policyNetwork",
+ "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.
+ # This should be formatted like
+ # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
+ },
+ ],
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource
+ # for the user's convenience. Has no effect on the policy's function.
+ "enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy.
+ # Defaults to no logging if not set.
+ "enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or
+ # applications over VPN connections. When enabled, a virtual IP address will
+ # be allocated from each of the sub-networks that are bound to this policy.
+ "alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When
+ # specified, all DNS queries are forwarded to a name server that you
+ # choose. Names such as .internal are not available when an alternative
+ # name server is specified.
+ "kind": "dns#policyAlternativeNameServerConfig",
+ "targetNameServers": [ # Sets an alternative name server for the associated networks. When
+ # specified, all DNS queries are forwarded to a name server that you
+ # choose. Names such as .internal are not available when an alternative
+ # name server is specified.
{
- "forwardingPath": "A String",
- "ipv4Address": "A String",
- "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfigTargetNameServer".
+ "forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT,
+ # Cloud DNS will make forwarding decision based on address ranges,
+ # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the
+ # Internet. When set to PRIVATE, Cloud DNS will always send queries
+ # through VPC for this target
+ "kind": "dns#policyAlternativeNameServerConfigTargetNameServer",
+ "ipv4Address": "A String", # IPv4 address to forward to.
},
],
},
- "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
+ 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:
- {
- "alternativeNameServerConfig": {
- "kind": "dns#policyAlternativeNameServerConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfig".
- "targetNameServers": [
+ { # A policy is a collection of DNS rules applied to one or more Virtual Private
+ # Cloud resources.
+ "kind": "dns#policy",
+ "name": "A String", # User assigned name for this policy.
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+ "networks": [ # List of network names specifying networks to which this policy is applied.
+ {
+ "kind": "dns#policyNetwork",
+ "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.
+ # This should be formatted like
+ # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
+ },
+ ],
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource
+ # for the user's convenience. Has no effect on the policy's function.
+ "enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy.
+ # Defaults to no logging if not set.
+ "enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or
+ # applications over VPN connections. When enabled, a virtual IP address will
+ # be allocated from each of the sub-networks that are bound to this policy.
+ "alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When
+ # specified, all DNS queries are forwarded to a name server that you
+ # choose. Names such as .internal are not available when an alternative
+ # name server is specified.
+ "kind": "dns#policyAlternativeNameServerConfig",
+ "targetNameServers": [ # Sets an alternative name server for the associated networks. When
+ # specified, all DNS queries are forwarded to a name server that you
+ # choose. Names such as .internal are not available when an alternative
+ # name server is specified.
{
- "forwardingPath": "A String",
- "ipv4Address": "A String",
- "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfigTargetNameServer".
+ "forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT,
+ # Cloud DNS will make forwarding decision based on address ranges,
+ # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the
+ # Internet. When set to PRIVATE, Cloud DNS will always send queries
+ # through VPC for this target
+ "kind": "dns#policyAlternativeNameServerConfigTargetNameServer",
+ "ipv4Address": "A String", # IPv4 address to forward to.
},
],
},
- "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",
- },
- ],
}</pre>
</div>
<div class="method">
- <code class="details" id="delete">delete(project, policy, clientOperationId=None)</code>
- <pre>
+ <code class="details" id="delete">delete(project, policy, clientOperationId=None, x__xgafv=None)</code>
+ <pre>Delete a previously created Policy. Will fail if the policy is still being
+referenced by a network.
Args:
- project: string, A parameter (required)
- policy: string, A parameter (required)
- clientOperationId: string, A parameter
+ project: string, Identifies the project addressed by this request. (required)
+ policy: string, User given friendly name of the policy addressed by this request. (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
</pre>
</div>
<div class="method">
- <code class="details" id="get">get(project, policy, clientOperationId=None)</code>
- <pre>
+ <code class="details" id="get">get(project, policy, clientOperationId=None, x__xgafv=None)</code>
+ <pre>Fetch the representation of an existing Policy.
Args:
- project: string, A parameter (required)
- policy: string, A parameter (required)
- clientOperationId: string, A parameter
+ project: string, Identifies the project addressed by this request. (required)
+ policy: string, User given friendly name of the policy addressed by this request. (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:
- {
- "alternativeNameServerConfig": {
- "kind": "dns#policyAlternativeNameServerConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfig".
- "targetNameServers": [
+ { # A policy is a collection of DNS rules applied to one or more Virtual Private
+ # Cloud resources.
+ "kind": "dns#policy",
+ "name": "A String", # User assigned name for this policy.
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+ "networks": [ # List of network names specifying networks to which this policy is applied.
+ {
+ "kind": "dns#policyNetwork",
+ "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.
+ # This should be formatted like
+ # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
+ },
+ ],
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource
+ # for the user's convenience. Has no effect on the policy's function.
+ "enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy.
+ # Defaults to no logging if not set.
+ "enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or
+ # applications over VPN connections. When enabled, a virtual IP address will
+ # be allocated from each of the sub-networks that are bound to this policy.
+ "alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When
+ # specified, all DNS queries are forwarded to a name server that you
+ # choose. Names such as .internal are not available when an alternative
+ # name server is specified.
+ "kind": "dns#policyAlternativeNameServerConfig",
+ "targetNameServers": [ # Sets an alternative name server for the associated networks. When
+ # specified, all DNS queries are forwarded to a name server that you
+ # choose. Names such as .internal are not available when an alternative
+ # name server is specified.
{
- "forwardingPath": "A String",
- "ipv4Address": "A String",
- "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfigTargetNameServer".
+ "forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT,
+ # Cloud DNS will make forwarding decision based on address ranges,
+ # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the
+ # Internet. When set to PRIVATE, Cloud DNS will always send queries
+ # through VPC for this target
+ "kind": "dns#policyAlternativeNameServerConfigTargetNameServer",
+ "ipv4Address": "A String", # IPv4 address to forward to.
},
],
},
- "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",
- },
- ],
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, maxResults=None, pageToken=None)</code>
- <pre>
+ <code class="details" id="list">list(project, pageToken=None, maxResults=None, x__xgafv=None)</code>
+ <pre>Enumerate all Policies associated with a project.
Args:
- project: string, A parameter (required)
- maxResults: integer, A parameter
- pageToken: string, A parameter
+ project: string, Identifies the project addressed by this request. (required)
+ pageToken: string, Optional. A tag returned by a previous list request that was truncated.
+Use this parameter to continue a previous list request.
+ maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the
+server will decide how many results to return.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
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": [
+ "policies": [ # The policy resources.
+ { # A policy is a collection of DNS rules applied to one or more Virtual Private
+ # Cloud resources.
+ "kind": "dns#policy",
+ "name": "A String", # User assigned name for this policy.
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+ "networks": [ # List of network names specifying networks to which this policy is applied.
+ {
+ "kind": "dns#policyNetwork",
+ "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.
+ # This should be formatted like
+ # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
+ },
+ ],
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource
+ # for the user's convenience. Has no effect on the policy's function.
+ "enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy.
+ # Defaults to no logging if not set.
+ "enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or
+ # applications over VPN connections. When enabled, a virtual IP address will
+ # be allocated from each of the sub-networks that are bound to this policy.
+ "alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When
+ # specified, all DNS queries are forwarded to a name server that you
+ # choose. Names such as .internal are not available when an alternative
+ # name server is specified.
+ "kind": "dns#policyAlternativeNameServerConfig",
+ "targetNameServers": [ # Sets an alternative name server for the associated networks. When
+ # specified, all DNS queries are forwarded to a name server that you
+ # choose. Names such as .internal are not available when an alternative
+ # name server is specified.
{
- "forwardingPath": "A String",
- "ipv4Address": "A String",
- "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfigTargetNameServer".
+ "forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT,
+ # Cloud DNS will make forwarding decision based on address ranges,
+ # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the
+ # Internet. When set to PRIVATE, Cloud DNS will always send queries
+ # through VPC for this target
+ "kind": "dns#policyAlternativeNameServerConfigTargetNameServer",
+ "ipv4Address": "A String", # IPv4 address to forward to.
},
],
},
- "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",
- },
- ],
},
],
+ "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 page 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 consistent snapshot of a collection larger than the
+ # maximum page size.
+ "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).
+ },
}</pre>
</div>
@@ -272,143 +376,227 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(project, policy, body=None, clientOperationId=None)</code>
- <pre>
+ <code class="details" id="patch">patch(project, policy, body=None, clientOperationId=None, x__xgafv=None)</code>
+ <pre>Apply a partial update to an existing Policy.
Args:
- project: string, A parameter (required)
- policy: string, A parameter (required)
+ project: string, Identifies the project addressed by this request. (required)
+ policy: string, User given friendly name of the policy addressed by this request. (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": [
+{ # A policy is a collection of DNS rules applied to one or more Virtual Private
+ # Cloud resources.
+ "kind": "dns#policy",
+ "name": "A String", # User assigned name for this policy.
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+ "networks": [ # List of network names specifying networks to which this policy is applied.
+ {
+ "kind": "dns#policyNetwork",
+ "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.
+ # This should be formatted like
+ # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
+ },
+ ],
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource
+ # for the user's convenience. Has no effect on the policy's function.
+ "enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy.
+ # Defaults to no logging if not set.
+ "enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or
+ # applications over VPN connections. When enabled, a virtual IP address will
+ # be allocated from each of the sub-networks that are bound to this policy.
+ "alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When
+ # specified, all DNS queries are forwarded to a name server that you
+ # choose. Names such as .internal are not available when an alternative
+ # name server is specified.
+ "kind": "dns#policyAlternativeNameServerConfig",
+ "targetNameServers": [ # Sets an alternative name server for the associated networks. When
+ # specified, all DNS queries are forwarded to a name server that you
+ # choose. Names such as .internal are not available when an alternative
+ # name server is specified.
{
- "forwardingPath": "A String",
- "ipv4Address": "A String",
- "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfigTargetNameServer".
+ "forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT,
+ # Cloud DNS will make forwarding decision based on address ranges,
+ # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the
+ # Internet. When set to PRIVATE, Cloud DNS will always send queries
+ # through VPC for this target
+ "kind": "dns#policyAlternativeNameServerConfigTargetNameServer",
+ "ipv4Address": "A String", # IPv4 address to forward to.
},
],
},
- "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
+ 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:
{
- "header": {
- "operationId": "A String",
+ "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).
},
- "policy": {
- "alternativeNameServerConfig": {
- "kind": "dns#policyAlternativeNameServerConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfig".
- "targetNameServers": [
+ "policy": { # A policy is a collection of DNS rules applied to one or more Virtual Private
+ # Cloud resources.
+ "kind": "dns#policy",
+ "name": "A String", # User assigned name for this policy.
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+ "networks": [ # List of network names specifying networks to which this policy is applied.
+ {
+ "kind": "dns#policyNetwork",
+ "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.
+ # This should be formatted like
+ # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
+ },
+ ],
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource
+ # for the user's convenience. Has no effect on the policy's function.
+ "enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy.
+ # Defaults to no logging if not set.
+ "enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or
+ # applications over VPN connections. When enabled, a virtual IP address will
+ # be allocated from each of the sub-networks that are bound to this policy.
+ "alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When
+ # specified, all DNS queries are forwarded to a name server that you
+ # choose. Names such as .internal are not available when an alternative
+ # name server is specified.
+ "kind": "dns#policyAlternativeNameServerConfig",
+ "targetNameServers": [ # Sets an alternative name server for the associated networks. When
+ # specified, all DNS queries are forwarded to a name server that you
+ # choose. Names such as .internal are not available when an alternative
+ # name server is specified.
{
- "forwardingPath": "A String",
- "ipv4Address": "A String",
- "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfigTargetNameServer".
+ "forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT,
+ # Cloud DNS will make forwarding decision based on address ranges,
+ # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the
+ # Internet. When set to PRIVATE, Cloud DNS will always send queries
+ # through VPC for this target
+ "kind": "dns#policyAlternativeNameServerConfigTargetNameServer",
+ "ipv4Address": "A String", # IPv4 address to forward to.
},
],
},
- "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",
- },
- ],
},
}</pre>
</div>
<div class="method">
- <code class="details" id="update">update(project, policy, body=None, clientOperationId=None)</code>
- <pre>
+ <code class="details" id="update">update(project, policy, body=None, clientOperationId=None, x__xgafv=None)</code>
+ <pre>Update an existing Policy.
Args:
- project: string, A parameter (required)
- policy: string, A parameter (required)
+ project: string, Identifies the project addressed by this request. (required)
+ policy: string, User given friendly name of the policy addressed by this request. (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": [
+{ # A policy is a collection of DNS rules applied to one or more Virtual Private
+ # Cloud resources.
+ "kind": "dns#policy",
+ "name": "A String", # User assigned name for this policy.
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+ "networks": [ # List of network names specifying networks to which this policy is applied.
+ {
+ "kind": "dns#policyNetwork",
+ "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.
+ # This should be formatted like
+ # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
+ },
+ ],
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource
+ # for the user's convenience. Has no effect on the policy's function.
+ "enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy.
+ # Defaults to no logging if not set.
+ "enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or
+ # applications over VPN connections. When enabled, a virtual IP address will
+ # be allocated from each of the sub-networks that are bound to this policy.
+ "alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When
+ # specified, all DNS queries are forwarded to a name server that you
+ # choose. Names such as .internal are not available when an alternative
+ # name server is specified.
+ "kind": "dns#policyAlternativeNameServerConfig",
+ "targetNameServers": [ # Sets an alternative name server for the associated networks. When
+ # specified, all DNS queries are forwarded to a name server that you
+ # choose. Names such as .internal are not available when an alternative
+ # name server is specified.
{
- "forwardingPath": "A String",
- "ipv4Address": "A String",
- "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfigTargetNameServer".
+ "forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT,
+ # Cloud DNS will make forwarding decision based on address ranges,
+ # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the
+ # Internet. When set to PRIVATE, Cloud DNS will always send queries
+ # through VPC for this target
+ "kind": "dns#policyAlternativeNameServerConfigTargetNameServer",
+ "ipv4Address": "A String", # IPv4 address to forward to.
},
],
},
- "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
+ 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:
{
- "header": {
- "operationId": "A String",
+ "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).
},
- "policy": {
- "alternativeNameServerConfig": {
- "kind": "dns#policyAlternativeNameServerConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfig".
- "targetNameServers": [
+ "policy": { # A policy is a collection of DNS rules applied to one or more Virtual Private
+ # Cloud resources.
+ "kind": "dns#policy",
+ "name": "A String", # User assigned name for this policy.
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+ "networks": [ # List of network names specifying networks to which this policy is applied.
+ {
+ "kind": "dns#policyNetwork",
+ "networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.
+ # This should be formatted like
+ # https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
+ },
+ ],
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource
+ # for the user's convenience. Has no effect on the policy's function.
+ "enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy.
+ # Defaults to no logging if not set.
+ "enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or
+ # applications over VPN connections. When enabled, a virtual IP address will
+ # be allocated from each of the sub-networks that are bound to this policy.
+ "alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When
+ # specified, all DNS queries are forwarded to a name server that you
+ # choose. Names such as .internal are not available when an alternative
+ # name server is specified.
+ "kind": "dns#policyAlternativeNameServerConfig",
+ "targetNameServers": [ # Sets an alternative name server for the associated networks. When
+ # specified, all DNS queries are forwarded to a name server that you
+ # choose. Names such as .internal are not available when an alternative
+ # name server is specified.
{
- "forwardingPath": "A String",
- "ipv4Address": "A String",
- "kind": "dns#policyAlternativeNameServerConfigTargetNameServer", # Identifies what kind of resource this is. Value: the fixed string "dns#policyAlternativeNameServerConfigTargetNameServer".
+ "forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT,
+ # Cloud DNS will make forwarding decision based on address ranges,
+ # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the
+ # Internet. When set to PRIVATE, Cloud DNS will always send queries
+ # through VPC for this target
+ "kind": "dns#policyAlternativeNameServerConfigTargetNameServer",
+ "ipv4Address": "A String", # IPv4 address to forward to.
},
],
},
- "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",
- },
- ],
},
}</pre>
</div>