Blame - docs/dyn/compute_v1.firewalls.html - platform/external/python/google-api-python-client

blob: 4c48fb6bd91fd6d994acd57e47a17478479061a6 [file] [log] [blame]

John Asmuth	614db98	2014-04-24 15:46:26 -0400	[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
				75	<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.firewalls.html">firewalls</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	78	<code><a href="#delete">delete(project, firewall, requestId=None)</a></code></p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	79	<p class="firstline">Deletes the specified firewall.</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	80	<p class="toc_element">
				81	<code><a href="#get">get(project, firewall)</a></code></p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	82	<p class="firstline">Returns the specified firewall.</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	83	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	84	<code><a href="#insert">insert(project, body=None, requestId=None)</a></code></p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	85	<p class="firstline">Creates a firewall rule in the specified project using the data included in the request.</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	86	<p class="toc_element">
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame]	87	<code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	88	<p class="firstline">Retrieves the list of firewall rules available to the specified project.</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	89	<p class="toc_element">
				90	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				91	<p class="firstline">Retrieves the next page of results.</p>
				92	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	93	<code><a href="#patch">patch(project, firewall, body=None, requestId=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	94	<p class="firstline">Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	95	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	96	<code><a href="#update">update(project, firewall, body=None, requestId=None)</a></code></p>
				97	<p class="firstline">Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead.</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	98	<h3>Method Details</h3>
				99	<div class="method">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	100	<code class="details" id="delete">delete(project, firewall, requestId=None)</code>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	101	<pre>Deletes the specified firewall.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	102
				103	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	104	project: string, Project ID for this request. (required)
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	105	firewall: string, Name of the firewall rule to delete. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	106	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				107
				108	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				109
				110	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	111
				112	Returns:
				113	An object of the form:
				114
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	115	{ # Represents an Operation resource.
				116	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	117	# Google Compute Engine has three Operation resources:
				118	#
				119	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				120	#
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	121	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				122	#
				123	# Operations can be global, regional or zonal.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	124	# - For global operations, use the `globalOperations` resource.
				125	# - For regional operations, use the `regionOperations` resource.
				126	# - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	127	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	128	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	129	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	130	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	131	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	132	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	133	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	134	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	135	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				136	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	137	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	138	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	139	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	140	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	141	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	142	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	143	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	144	"message": "A String", # [Output Only] A human-readable description of the warning code.
				145	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				146	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				147	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	148	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	149	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	150	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	151	},
				152	],
				153	},
				154	],
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	155	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	156	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	157	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				158	"name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	159	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	160	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	161	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	162	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	163	"message": "A String", # [Output Only] An optional, human-readable error message.
				164	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	165	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	166	},
				167	],
				168	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	169	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	170	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	171	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	172	}</pre>
				173	</div>
				174
				175	<div class="method">
				176	<code class="details" id="get">get(project, firewall)</code>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	177	<pre>Returns the specified firewall.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	178
				179	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	180	project: string, Project ID for this request. (required)
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	181	firewall: string, Name of the firewall rule to return. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	182
				183	Returns:
				184	An object of the form:
				185
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	186	{ # Represents a Firewall Rule resource.
				187	#
				188	# Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.
				189	"priority": 42, # Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`.
				190	"direction": "A String", # Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `INGRESS` traffic, you cannot specify the destinationRanges field, and for `EGRESS` traffic, you cannot specify the sourceRanges or sourceTags fields.
				191	"sourceRanges": [ # If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Only IPv4 is supported.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	192	"A String",
				193	],
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	194	"sourceServiceAccounts": [ # If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	195	"A String",
				196	],
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	197	"description": "A String", # An optional description of this resource. Provide this field when you create the resource.
				198	"destinationRanges": [ # If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported.
				199	"A String",
				200	],
				201	"sourceTags": [ # If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	202	"A String",
				203	],
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	204	"allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	205	{
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	206	"IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.
				207	"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
				208	#
				209	# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
				210	"A String",
				211	],
				212	},
				213	],
				214	"kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules.
				215	"logConfig": { # The available logging options for a firewall rule. # This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver.
				216	"enable": True or False, # This field denotes whether to enable logging for a particular firewall rule.
				217	},
				218	"disabled": True or False, # Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.
				219	"network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
				220	# global/networks/default
				221	# If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
				222	# - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
				223	# - projects/myproject/global/networks/my-network
				224	# - global/networks/default
				225	"targetServiceAccounts": [ # A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.
				226	"A String",
				227	],
				228	"targetTags": [ # A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
				229	"A String",
				230	],
				231	"denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.
				232	{
				233	"IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.
				234	"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	235	#
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	236	# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	237	"A String",
				238	],
				239	},
				240	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	241	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	242	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	243	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	244	"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	245	}</pre>
				246	</div>
				247
				248	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	249	<code class="details" id="insert">insert(project, body=None, requestId=None)</code>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	250	<pre>Creates a firewall rule in the specified project using the data included in the request.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	251
				252	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	253	project: string, Project ID for this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	254	body: object, The request body.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	255	The object takes the form of:
				256
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	257	{ # Represents a Firewall Rule resource.
				258	#
				259	# Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.
				260	"priority": 42, # Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`.
				261	"direction": "A String", # Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `INGRESS` traffic, you cannot specify the destinationRanges field, and for `EGRESS` traffic, you cannot specify the sourceRanges or sourceTags fields.
				262	"sourceRanges": [ # If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Only IPv4 is supported.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	263	"A String",
				264	],
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	265	"sourceServiceAccounts": [ # If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	266	"A String",
				267	],
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	268	"description": "A String", # An optional description of this resource. Provide this field when you create the resource.
				269	"destinationRanges": [ # If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported.
				270	"A String",
				271	],
				272	"sourceTags": [ # If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	273	"A String",
				274	],
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	275	"allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	276	{
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	277	"IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.
				278	"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
				279	#
				280	# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
				281	"A String",
				282	],
				283	},
				284	],
				285	"kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules.
				286	"logConfig": { # The available logging options for a firewall rule. # This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver.
				287	"enable": True or False, # This field denotes whether to enable logging for a particular firewall rule.
				288	},
				289	"disabled": True or False, # Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.
				290	"network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
				291	# global/networks/default
				292	# If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
				293	# - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
				294	# - projects/myproject/global/networks/my-network
				295	# - global/networks/default
				296	"targetServiceAccounts": [ # A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.
				297	"A String",
				298	],
				299	"targetTags": [ # A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
				300	"A String",
				301	],
				302	"denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.
				303	{
				304	"IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.
				305	"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	306	#
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	307	# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	308	"A String",
				309	],
				310	},
				311	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	312	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	313	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	314	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	315	"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	316	}
				317
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	318	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				319
				320	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				321
				322	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	323
				324	Returns:
				325	An object of the form:
				326
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	327	{ # Represents an Operation resource.
				328	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	329	# Google Compute Engine has three Operation resources:
				330	#
				331	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				332	#
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	333	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				334	#
				335	# Operations can be global, regional or zonal.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	336	# - For global operations, use the `globalOperations` resource.
				337	# - For regional operations, use the `regionOperations` resource.
				338	# - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	339	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	340	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	341	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	342	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	343	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	344	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	345	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	346	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	347	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				348	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	349	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	350	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	351	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	352	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	353	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	354	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	355	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	356	"message": "A String", # [Output Only] A human-readable description of the warning code.
				357	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				358	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				359	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	360	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	361	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	362	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	363	},
				364	],
				365	},
				366	],
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	367	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	368	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	369	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				370	"name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	371	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	372	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	373	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	374	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	375	"message": "A String", # [Output Only] An optional, human-readable error message.
				376	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	377	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	378	},
				379	],
				380	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	381	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	382	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	383	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	384	}</pre>
				385	</div>
				386
				387	<div class="method">
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame]	388	<code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	389	<pre>Retrieves the list of firewall rules available to the specified project.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	390
				391	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	392	project: string, Project ID for this request. (required)
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame]	393	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				394
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	395	You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame]	396
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	397	Currently, only sorting by `name` or `creationTimestamp desc` is supported.
				398	maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
				399	pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
				400	filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	401
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	402	For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	403
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	404	You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	405
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	406	To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	407
				408	Returns:
				409	An object of the form:
				410
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	411	{ # Contains a list of firewalls.
				412	"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	413	"kind": "compute#firewallList", # [Output Only] Type of resource. Always compute#firewallList for lists of firewalls.
				414	"items": [ # A list of Firewall resources.
				415	{ # Represents a Firewall Rule resource.
				416	#
				417	# Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.
				418	"priority": 42, # Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`.
				419	"direction": "A String", # Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `INGRESS` traffic, you cannot specify the destinationRanges field, and for `EGRESS` traffic, you cannot specify the sourceRanges or sourceTags fields.
				420	"sourceRanges": [ # If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Only IPv4 is supported.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	421	"A String",
				422	],
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	423	"sourceServiceAccounts": [ # If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	424	"A String",
				425	],
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	426	"description": "A String", # An optional description of this resource. Provide this field when you create the resource.
				427	"destinationRanges": [ # If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported.
				428	"A String",
				429	],
				430	"sourceTags": [ # If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	431	"A String",
				432	],
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	433	"allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	434	{
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	435	"IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.
				436	"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
				437	#
				438	# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
				439	"A String",
				440	],
				441	},
				442	],
				443	"kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules.
				444	"logConfig": { # The available logging options for a firewall rule. # This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver.
				445	"enable": True or False, # This field denotes whether to enable logging for a particular firewall rule.
				446	},
				447	"disabled": True or False, # Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.
				448	"network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
				449	# global/networks/default
				450	# If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
				451	# - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
				452	# - projects/myproject/global/networks/my-network
				453	# - global/networks/default
				454	"targetServiceAccounts": [ # A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.
				455	"A String",
				456	],
				457	"targetTags": [ # A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
				458	"A String",
				459	],
				460	"denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.
				461	{
				462	"IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.
				463	"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	464	#
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	465	# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	466	"A String",
				467	],
				468	},
				469	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	470	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	471	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	472	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	473	"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	474	},
				475	],
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	476	"warning": { # [Output Only] Informational warning message.
				477	"message": "A String", # [Output Only] A human-readable description of the warning code.
				478	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				479	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				480	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				481	{
				482	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				483	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				484	},
				485	],
				486	},
				487	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	488	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	489	}</pre>
				490	</div>
				491
				492	<div class="method">
				493	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				494	<pre>Retrieves the next page of results.
				495
				496	Args:
				497	previous_request: The request for the previous page. (required)
				498	previous_response: The response from the request for the previous page. (required)
				499
				500	Returns:
				501	A request object that you can call 'execute()' on to request the next
				502	page. Returns None if there are no more items in the collection.
				503	</pre>
				504	</div>
				505
				506	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	507	<code class="details" id="patch">patch(project, firewall, body=None, requestId=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	508	<pre>Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	509
				510	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	511	project: string, Project ID for this request. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	512	firewall: string, Name of the firewall rule to patch. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	513	body: object, The request body.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	514	The object takes the form of:
				515
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	516	{ # Represents a Firewall Rule resource.
				517	#
				518	# Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.
				519	"priority": 42, # Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`.
				520	"direction": "A String", # Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `INGRESS` traffic, you cannot specify the destinationRanges field, and for `EGRESS` traffic, you cannot specify the sourceRanges or sourceTags fields.
				521	"sourceRanges": [ # If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Only IPv4 is supported.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	522	"A String",
				523	],
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	524	"sourceServiceAccounts": [ # If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	525	"A String",
				526	],
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	527	"description": "A String", # An optional description of this resource. Provide this field when you create the resource.
				528	"destinationRanges": [ # If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported.
				529	"A String",
				530	],
				531	"sourceTags": [ # If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	532	"A String",
				533	],
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	534	"allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	535	{
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	536	"IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.
				537	"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
				538	#
				539	# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
				540	"A String",
				541	],
				542	},
				543	],
				544	"kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules.
				545	"logConfig": { # The available logging options for a firewall rule. # This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver.
				546	"enable": True or False, # This field denotes whether to enable logging for a particular firewall rule.
				547	},
				548	"disabled": True or False, # Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.
				549	"network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
				550	# global/networks/default
				551	# If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
				552	# - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
				553	# - projects/myproject/global/networks/my-network
				554	# - global/networks/default
				555	"targetServiceAccounts": [ # A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.
				556	"A String",
				557	],
				558	"targetTags": [ # A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
				559	"A String",
				560	],
				561	"denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.
				562	{
				563	"IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.
				564	"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	565	#
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	566	# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	567	"A String",
				568	],
				569	},
				570	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	571	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	572	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	573	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	574	"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	575	}
				576
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	577	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				578
				579	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				580
				581	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	582
				583	Returns:
				584	An object of the form:
				585
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	586	{ # Represents an Operation resource.
				587	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	588	# Google Compute Engine has three Operation resources:
				589	#
				590	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				591	#
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	592	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				593	#
				594	# Operations can be global, regional or zonal.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	595	# - For global operations, use the `globalOperations` resource.
				596	# - For regional operations, use the `regionOperations` resource.
				597	# - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	598	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	599	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	600	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	601	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	602	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	603	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	604	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	605	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	606	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				607	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	608	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	609	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	610	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	611	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	612	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	613	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	614	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	615	"message": "A String", # [Output Only] A human-readable description of the warning code.
				616	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				617	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				618	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	619	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	620	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	621	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	622	},
				623	],
				624	},
				625	],
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	626	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	627	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	628	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				629	"name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	630	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	631	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	632	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	633	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	634	"message": "A String", # [Output Only] An optional, human-readable error message.
				635	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	636	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	637	},
				638	],
				639	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	640	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	641	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	642	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	643	}</pre>
				644	</div>
				645
				646	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	647	<code class="details" id="update">update(project, firewall, body=None, requestId=None)</code>
				648	<pre>Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	649
				650	Args:
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	651	project: string, Project ID for this request. (required)
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	652	firewall: string, Name of the firewall rule to update. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	653	body: object, The request body.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	654	The object takes the form of:
				655
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	656	{ # Represents a Firewall Rule resource.
				657	#
				658	# Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.
				659	"priority": 42, # Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`.
				660	"direction": "A String", # Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `INGRESS` traffic, you cannot specify the destinationRanges field, and for `EGRESS` traffic, you cannot specify the sourceRanges or sourceTags fields.
				661	"sourceRanges": [ # If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Only IPv4 is supported.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	662	"A String",
				663	],
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	664	"sourceServiceAccounts": [ # If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	665	"A String",
				666	],
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	667	"description": "A String", # An optional description of this resource. Provide this field when you create the resource.
				668	"destinationRanges": [ # If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported.
				669	"A String",
				670	],
				671	"sourceTags": [ # If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	672	"A String",
				673	],
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	674	"allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	675	{
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	676	"IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.
				677	"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
				678	#
				679	# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
				680	"A String",
				681	],
				682	},
				683	],
				684	"kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules.
				685	"logConfig": { # The available logging options for a firewall rule. # This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver.
				686	"enable": True or False, # This field denotes whether to enable logging for a particular firewall rule.
				687	},
				688	"disabled": True or False, # Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.
				689	"network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
				690	# global/networks/default
				691	# If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
				692	# - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
				693	# - projects/myproject/global/networks/my-network
				694	# - global/networks/default
				695	"targetServiceAccounts": [ # A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.
				696	"A String",
				697	],
				698	"targetTags": [ # A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
				699	"A String",
				700	],
				701	"denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.
				702	{
				703	"IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.
				704	"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	705	#
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	706	# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	707	"A String",
				708	],
				709	},
				710	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	711	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	712	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	713	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	714	"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	715	}
				716
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	717	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				718
				719	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				720
				721	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	722
				723	Returns:
				724	An object of the form:
				725
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	726	{ # Represents an Operation resource.
				727	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	728	# Google Compute Engine has three Operation resources:
				729	#
				730	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				731	#
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	732	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				733	#
				734	# Operations can be global, regional or zonal.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	735	# - For global operations, use the `globalOperations` resource.
				736	# - For regional operations, use the `regionOperations` resource.
				737	# - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	738	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	739	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	740	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	741	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	742	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	743	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	744	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	745	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	746	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				747	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	748	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	749	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	750	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	751	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	752	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	753	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	754	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	755	"message": "A String", # [Output Only] A human-readable description of the warning code.
				756	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				757	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				758	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	759	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	760	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	761	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	762	},
				763	],
				764	},
				765	],
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	766	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	767	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	768	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				769	"name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	770	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	771	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	772	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	773	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	774	"message": "A String", # [Output Only] An optional, human-readable error message.
				775	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	776	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	777	},
				778	],
				779	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	780	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	781	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	782	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	783	}</pre>
				784	</div>
				785
				786	</body></html>