Blame - docs/dyn/dns_v1beta2.policies.html - platform/external/python/google-api-python-client

blob: c880d6b2aaacb6b50cff19658a61bc4d18d0414f [file] [log] [blame]

Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	75	<h1><a href="dns_v1beta2.html">Cloud DNS API</a> . <a href="dns_v1beta2.policies.html">policies</a></h1>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	81	<code><a href="#create">create(project, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	82	<p class="firstline">Creates a new Policy.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	83	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	84	<code><a href="#delete">delete(project, policy, clientOperationId=None, x__xgafv=None)</a></code></p>
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	85	<p class="firstline">Deletes a previously created Policy. Fails if the policy is still being referenced by a network.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	86	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	87	<code><a href="#get">get(project, policy, clientOperationId=None, x__xgafv=None)</a></code></p>
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	88	<p class="firstline">Fetches the representation of an existing Policy.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	89	<p class="toc_element">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	90	<code><a href="#list">list(project, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	91	<p class="firstline">Enumerates all Policies associated with a project.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	92	<p class="toc_element">
				93	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				94	<p class="firstline">Retrieves the next page of results.</p>
				95	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	96	<code><a href="#patch">patch(project, policy, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	97	<p class="firstline">Applies a partial update to an existing Policy.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	98	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	99	<code><a href="#update">update(project, policy, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	100	<p class="firstline">Updates an existing Policy.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	101	<h3>Method Details</h3>
				102	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	103	<code class="details" id="close">close()</code>
				104	<pre>Close httplib2 connections.</pre>
				105	</div>
				106
				107	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	108	<code class="details" id="create">create(project, body=None, clientOperationId=None, x__xgafv=None)</code>
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	109	<pre>Creates a new Policy.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	110
				111	Args:
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	112	project: string, Identifies the project addressed by this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	113	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	114	The object takes the form of:
				115
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	116	{ # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	117	"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.
				118	"kind": "dns#policyAlternativeNameServerConfig",
				119	"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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	120	{
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	121	"forwardingPath": "A String", # Forwarding path for this TargetNameServer. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	122	"ipv4Address": "A String", # IPv4 address to forward to.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	123	"ipv6Address": "A String", # IPv6 address to forward to. Does not accept both fields (ipv4 & ipv6) being populated.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	124	"kind": "dns#policyAlternativeNameServerConfigTargetNameServer",
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	125	},
				126	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	127	},
				128	"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.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	129	"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 is allocated from each of the subnetworks that are bound to this policy.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	130	"enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
				131	"id": "A String", # Unique identifier for the resource; defined by the server (output only).
				132	"kind": "dns#policy",
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	133	"name": "A String", # User-assigned name for this policy.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	134	"networks": [ # List of network names specifying networks to which this policy is applied.
				135	{
				136	"kind": "dns#policyNetwork",
				137	"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}
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	138	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	139	],
				140	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	141
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	142	clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	143	x__xgafv: string, V1 error format.
				144	Allowed values
				145	1 - v1 error format
				146	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	147
				148	Returns:
				149	An object of the form:
				150
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	151	{ # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	152	"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.
				153	"kind": "dns#policyAlternativeNameServerConfig",
				154	"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.
				155	{
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	156	"forwardingPath": "A String", # Forwarding path for this TargetNameServer. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	157	"ipv4Address": "A String", # IPv4 address to forward to.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	158	"ipv6Address": "A String", # IPv6 address to forward to. Does not accept both fields (ipv4 & ipv6) being populated.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	159	"kind": "dns#policyAlternativeNameServerConfigTargetNameServer",
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	160	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	161	],
				162	},
				163	"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.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	164	"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 is allocated from each of the subnetworks that are bound to this policy.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	165	"enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
				166	"id": "A String", # Unique identifier for the resource; defined by the server (output only).
				167	"kind": "dns#policy",
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	168	"name": "A String", # User-assigned name for this policy.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	169	"networks": [ # List of network names specifying networks to which this policy is applied.
				170	{
				171	"kind": "dns#policyNetwork",
				172	"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}
				173	},
				174	],
				175	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	176	</div>
				177
				178	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	179	<code class="details" id="delete">delete(project, policy, clientOperationId=None, x__xgafv=None)</code>
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	180	<pre>Deletes a previously created Policy. Fails if the policy is still being referenced by a network.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	181
				182	Args:
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	183	project: string, Identifies the project addressed by this request. (required)
				184	policy: string, User given friendly name of the policy addressed by this request. (required)
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	185	clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	186	x__xgafv: string, V1 error format.
				187	Allowed values
				188	1 - v1 error format
				189	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	190	</pre>
				191	</div>
				192
				193	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	194	<code class="details" id="get">get(project, policy, clientOperationId=None, x__xgafv=None)</code>
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	195	<pre>Fetches the representation of an existing Policy.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	196
				197	Args:
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	198	project: string, Identifies the project addressed by this request. (required)
				199	policy: string, User given friendly name of the policy addressed by this request. (required)
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	200	clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	201	x__xgafv: string, V1 error format.
				202	Allowed values
				203	1 - v1 error format
				204	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	205
				206	Returns:
				207	An object of the form:
				208
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	209	{ # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	210	"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.
				211	"kind": "dns#policyAlternativeNameServerConfig",
				212	"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.
				213	{
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	214	"forwardingPath": "A String", # Forwarding path for this TargetNameServer. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	215	"ipv4Address": "A String", # IPv4 address to forward to.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	216	"ipv6Address": "A String", # IPv6 address to forward to. Does not accept both fields (ipv4 & ipv6) being populated.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	217	"kind": "dns#policyAlternativeNameServerConfigTargetNameServer",
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	218	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	219	],
				220	},
				221	"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.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	222	"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 is allocated from each of the subnetworks that are bound to this policy.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	223	"enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
				224	"id": "A String", # Unique identifier for the resource; defined by the server (output only).
				225	"kind": "dns#policy",
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	226	"name": "A String", # User-assigned name for this policy.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	227	"networks": [ # List of network names specifying networks to which this policy is applied.
				228	{
				229	"kind": "dns#policyNetwork",
				230	"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}
				231	},
				232	],
				233	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	234	</div>
				235
				236	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	237	<code class="details" id="list">list(project, maxResults=None, pageToken=None, x__xgafv=None)</code>
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	238	<pre>Enumerates all Policies associated with a project.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	239
				240	Args:
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	241	project: string, Identifies the project addressed by this request. (required)
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	242	maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	243	pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	244	x__xgafv: string, V1 error format.
				245	Allowed values
				246	1 - v1 error format
				247	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	248
				249	Returns:
				250	An object of the form:
				251
				252	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	253	"header": { # Elements common to every response.
				254	"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).
				255	},
				256	"kind": "dns#policiesListResponse", # Type of resource.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	257	"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. This lets you 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 are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	258	"policies": [ # The policy resources.
				259	{ # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
				260	"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.
				261	"kind": "dns#policyAlternativeNameServerConfig",
				262	"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.
				263	{
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	264	"forwardingPath": "A String", # Forwarding path for this TargetNameServer. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	265	"ipv4Address": "A String", # IPv4 address to forward to.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	266	"ipv6Address": "A String", # IPv6 address to forward to. Does not accept both fields (ipv4 & ipv6) being populated.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	267	"kind": "dns#policyAlternativeNameServerConfigTargetNameServer",
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	268	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	269	],
				270	},
				271	"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.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	272	"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 is allocated from each of the subnetworks that are bound to this policy.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	273	"enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
				274	"id": "A String", # Unique identifier for the resource; defined by the server (output only).
				275	"kind": "dns#policy",
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	276	"name": "A String", # User-assigned name for this policy.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	277	"networks": [ # List of network names specifying networks to which this policy is applied.
				278	{
				279	"kind": "dns#policyNetwork",
				280	"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}
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	281	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	282	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	283	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	284	],
				285	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	286	</div>
				287
				288	<div class="method">
				289	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				290	<pre>Retrieves the next page of results.
				291
				292	Args:
				293	previous_request: The request for the previous page. (required)
				294	previous_response: The response from the request for the previous page. (required)
				295
				296	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	297	A request object that you can call 'execute()' on to request the next
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	298	page. Returns None if there are no more items in the collection.
				299	</pre>
				300	</div>
				301
				302	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	303	<code class="details" id="patch">patch(project, policy, body=None, clientOperationId=None, x__xgafv=None)</code>
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	304	<pre>Applies a partial update to an existing Policy.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	305
				306	Args:
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	307	project: string, Identifies the project addressed by this request. (required)
				308	policy: string, User given friendly name of the policy addressed by this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	309	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	310	The object takes the form of:
				311
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	312	{ # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	313	"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.
				314	"kind": "dns#policyAlternativeNameServerConfig",
				315	"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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	316	{
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	317	"forwardingPath": "A String", # Forwarding path for this TargetNameServer. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	318	"ipv4Address": "A String", # IPv4 address to forward to.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	319	"ipv6Address": "A String", # IPv6 address to forward to. Does not accept both fields (ipv4 & ipv6) being populated.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	320	"kind": "dns#policyAlternativeNameServerConfigTargetNameServer",
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	321	},
				322	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	323	},
				324	"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.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	325	"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 is allocated from each of the subnetworks that are bound to this policy.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	326	"enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
				327	"id": "A String", # Unique identifier for the resource; defined by the server (output only).
				328	"kind": "dns#policy",
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	329	"name": "A String", # User-assigned name for this policy.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	330	"networks": [ # List of network names specifying networks to which this policy is applied.
				331	{
				332	"kind": "dns#policyNetwork",
				333	"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}
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	334	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	335	],
				336	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	337
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	338	clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	339	x__xgafv: string, V1 error format.
				340	Allowed values
				341	1 - v1 error format
				342	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	343
				344	Returns:
				345	An object of the form:
				346
				347	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	348	"header": { # Elements common to every response.
				349	"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).
				350	},
				351	"policy": { # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
				352	"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.
				353	"kind": "dns#policyAlternativeNameServerConfig",
				354	"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.
				355	{
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	356	"forwardingPath": "A String", # Forwarding path for this TargetNameServer. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	357	"ipv4Address": "A String", # IPv4 address to forward to.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	358	"ipv6Address": "A String", # IPv6 address to forward to. Does not accept both fields (ipv4 & ipv6) being populated.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	359	"kind": "dns#policyAlternativeNameServerConfigTargetNameServer",
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	360	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	361	],
				362	},
				363	"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.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	364	"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 is allocated from each of the subnetworks that are bound to this policy.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	365	"enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
				366	"id": "A String", # Unique identifier for the resource; defined by the server (output only).
				367	"kind": "dns#policy",
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	368	"name": "A String", # User-assigned name for this policy.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	369	"networks": [ # List of network names specifying networks to which this policy is applied.
				370	{
				371	"kind": "dns#policyNetwork",
				372	"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}
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	373	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	374	],
				375	},
				376	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	377	</div>
				378
				379	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	380	<code class="details" id="update">update(project, policy, body=None, clientOperationId=None, x__xgafv=None)</code>
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	381	<pre>Updates an existing Policy.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	382
				383	Args:
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	384	project: string, Identifies the project addressed by this request. (required)
				385	policy: string, User given friendly name of the policy addressed by this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	386	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	387	The object takes the form of:
				388
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	389	{ # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	390	"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.
				391	"kind": "dns#policyAlternativeNameServerConfig",
				392	"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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	393	{
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	394	"forwardingPath": "A String", # Forwarding path for this TargetNameServer. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	395	"ipv4Address": "A String", # IPv4 address to forward to.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	396	"ipv6Address": "A String", # IPv6 address to forward to. Does not accept both fields (ipv4 & ipv6) being populated.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	397	"kind": "dns#policyAlternativeNameServerConfigTargetNameServer",
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	398	},
				399	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	400	},
				401	"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.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	402	"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 is allocated from each of the subnetworks that are bound to this policy.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	403	"enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
				404	"id": "A String", # Unique identifier for the resource; defined by the server (output only).
				405	"kind": "dns#policy",
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	406	"name": "A String", # User-assigned name for this policy.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	407	"networks": [ # List of network names specifying networks to which this policy is applied.
				408	{
				409	"kind": "dns#policyNetwork",
				410	"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}
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	411	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	412	],
				413	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	414
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	415	clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	416	x__xgafv: string, V1 error format.
				417	Allowed values
				418	1 - v1 error format
				419	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	420
				421	Returns:
				422	An object of the form:
				423
				424	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	425	"header": { # Elements common to every response.
				426	"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).
				427	},
				428	"policy": { # A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
				429	"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.
				430	"kind": "dns#policyAlternativeNameServerConfig",
				431	"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.
				432	{
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	433	"forwardingPath": "A String", # Forwarding path for this TargetNameServer. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	434	"ipv4Address": "A String", # IPv4 address to forward to.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	435	"ipv6Address": "A String", # IPv6 address to forward to. Does not accept both fields (ipv4 & ipv6) being populated.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	436	"kind": "dns#policyAlternativeNameServerConfigTargetNameServer",
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	437	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	438	],
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	439	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	440	"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.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	441	"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 is allocated from each of the subnetworks that are bound to this policy.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	442	"enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
				443	"id": "A String", # Unique identifier for the resource; defined by the server (output only).
				444	"kind": "dns#policy",
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	445	"name": "A String", # User-assigned name for this policy.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	446	"networks": [ # List of network names specifying networks to which this policy is applied.
				447	{
				448	"kind": "dns#policyNetwork",
				449	"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}
				450	},
				451	],
				452	},
				453	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	454	</div>
				455
				456	</body></html>