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

blob: e9284c712b8eee361aa94ca10209440a6e64d485 [file] [log] [blame]

Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
				75	<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.firewalls.html">firewalls</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	81	<code><a href="#delete">delete(project, firewall, requestId=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	82	<p class="firstline">Deletes the specified firewall.</p>
				83	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	84	<code><a href="#get">get(project, firewall, x__xgafv=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	85	<p class="firstline">Returns the specified firewall.</p>
				86	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	87	<code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	88	<p class="firstline">Creates a firewall rule in the specified project using the data included in the request.</p>
				89	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	90	<code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	91	<p class="firstline">Retrieves the list of firewall rules available to the specified project.</p>
				92	<p class="toc_element">
				93	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				94	<p class="firstline">Retrieves the next page of results.</p>
				95	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	96	<code><a href="#patch">patch(project, firewall, body=None, requestId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	97	<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>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	98	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	99	<code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	100	<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
				101	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	102	<code><a href="#update">update(project, firewall, body=None, requestId=None, x__xgafv=None)</a></code></p>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	103	<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>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	104	<h3>Method Details</h3>
				105	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	106	<code class="details" id="close">close()</code>
				107	<pre>Close httplib2 connections.</pre>
				108	</div>
				109
				110	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	111	<code class="details" id="delete">delete(project, firewall, requestId=None, x__xgafv=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	112	<pre>Deletes the specified firewall.
				113
				114	Args:
				115	project: string, Project ID for this request. (required)
				116	firewall: string, Name of the firewall rule to delete. (required)
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	117	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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
				118	x__xgafv: string, V1 error format.
				119	Allowed values
				120	1 - v1 error format
				121	2 - v2 error format
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	122
				123	Returns:
				124	An object of the form:
				125
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	126	{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	127	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				128	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				129	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				130	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				131	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				132	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	133	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	134	"code": "A String", # [Output Only] The error type identifier for this error.
				135	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				136	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	137	},
				138	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	139	},
				140	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				141	"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.
				142	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				143	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				144	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bot	8595441	2021-12-06 23:26:37 -0800	[diff] [blame^]	145	"metadata": { # [Output Only] Service-specific metadata attached to this operation.
				146	"a_key": "", # Properties of the object. Contains field @type with type URL.
				147	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	148	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	149	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	150	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				151	"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.
				152	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				153	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				154	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				155	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				156	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				157	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				158	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				159	"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.
				160	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				161	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				162	{
				163	"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.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	164	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	165	{
				166	"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).
				167	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				168	},
				169	],
				170	"message": "A String", # [Output Only] A human-readable description of the warning code.
				171	},
				172	],
				173	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				174	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	175	</div>
				176
				177	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	178	<code class="details" id="get">get(project, firewall, x__xgafv=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	179	<pre>Returns the specified firewall.
				180
				181	Args:
				182	project: string, Project ID for this request. (required)
				183	firewall: string, Name of the firewall rule to return. (required)
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	184	x__xgafv: string, V1 error format.
				185	Allowed values
				186	1 - v1 error format
				187	2 - v2 error format
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	188
				189	Returns:
				190	An object of the form:
				191
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	192	{ # Represents a Firewall Rule resource. Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	193	"allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
				194	{
				195	"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.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	196	"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. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	197	"A String",
				198	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	199	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	200	],
				201	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				202	"denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.
				203	{
				204	"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.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	205	"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. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	206	"A String",
				207	],
				208	},
				209	],
				210	"description": "A String", # An optional description of this resource. Provide this field when you create the resource.
yoshi-code-bot	96afc04	2021-08-24 00:22:31 -0700	[diff] [blame]	211	"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. Both IPv4 and IPv6 are supported.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	212	"A String",
				213	],
				214	"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.
				215	"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.
				216	"enableLogging": True or False, # Deprecated in favor of enable in LogConfig. This field denotes whether to enable logging for a particular firewall rule. If logging is enabled, logs will be exported t Cloud Logging.
				217	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				218	"kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules.
				219	"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 Cloud Logging.
				220	"enable": True or False, # This field denotes whether to enable logging for a particular firewall rule.
				221	"metadata": "A String", # This field can only be specified for a particular firewall rule if logging is enabled for that rule. This field denotes whether to include or exclude metadata for firewall logs.
				222	},
yoshi-code-bot	8595441	2021-12-06 23:26:37 -0800	[diff] [blame^]	223	"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.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	224	"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: global/networks/default 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: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	225	"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`.
				226	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				227	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
yoshi-code-bot	96afc04	2021-08-24 00:22:31 -0700	[diff] [blame]	228	"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. Both IPv4 and IPv6 are supported.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	229	"A String",
				230	],
				231	"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.
				232	"A String",
				233	],
				234	"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.
				235	"A String",
				236	],
				237	"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.
				238	"A String",
				239	],
				240	"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.
				241	"A String",
				242	],
				243	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	244	</div>
				245
				246	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	247	<code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	248	<pre>Creates a firewall rule in the specified project using the data included in the request.
				249
				250	Args:
				251	project: string, Project ID for this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	252	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	253	The object takes the form of:
				254
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	255	{ # Represents a Firewall Rule resource. Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	256	"allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
				257	{
				258	"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.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	259	"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. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	260	"A String",
				261	],
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	262	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	263	],
				264	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				265	"denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.
				266	{
				267	"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.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	268	"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. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	269	"A String",
				270	],
				271	},
				272	],
				273	"description": "A String", # An optional description of this resource. Provide this field when you create the resource.
yoshi-code-bot	96afc04	2021-08-24 00:22:31 -0700	[diff] [blame]	274	"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. Both IPv4 and IPv6 are supported.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	275	"A String",
				276	],
				277	"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.
				278	"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.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	279	"enableLogging": True or False, # Deprecated in favor of enable in LogConfig. This field denotes whether to enable logging for a particular firewall rule. If logging is enabled, logs will be exported t Cloud Logging.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	280	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				281	"kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	282	"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 Cloud Logging.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	283	"enable": True or False, # This field denotes whether to enable logging for a particular firewall rule.
				284	"metadata": "A String", # This field can only be specified for a particular firewall rule if logging is enabled for that rule. This field denotes whether to include or exclude metadata for firewall logs.
				285	},
yoshi-code-bot	8595441	2021-12-06 23:26:37 -0800	[diff] [blame^]	286	"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.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	287	"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: global/networks/default 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: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	288	"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`.
				289	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				290	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
yoshi-code-bot	96afc04	2021-08-24 00:22:31 -0700	[diff] [blame]	291	"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. Both IPv4 and IPv6 are supported.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	292	"A String",
				293	],
				294	"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.
				295	"A String",
				296	],
				297	"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.
				298	"A String",
				299	],
				300	"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.
				301	"A String",
				302	],
				303	"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.
				304	"A String",
				305	],
				306	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	307
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	308	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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
				309	x__xgafv: string, V1 error format.
				310	Allowed values
				311	1 - v1 error format
				312	2 - v2 error format
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	313
				314	Returns:
				315	An object of the form:
				316
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	317	{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	318	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				319	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				320	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				321	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				322	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				323	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	324	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	325	"code": "A String", # [Output Only] The error type identifier for this error.
				326	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				327	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	328	},
				329	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	330	},
				331	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				332	"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.
				333	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				334	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				335	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bot	8595441	2021-12-06 23:26:37 -0800	[diff] [blame^]	336	"metadata": { # [Output Only] Service-specific metadata attached to this operation.
				337	"a_key": "", # Properties of the object. Contains field @type with type URL.
				338	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	339	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	340	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	341	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				342	"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.
				343	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				344	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				345	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				346	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				347	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				348	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				349	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				350	"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.
				351	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				352	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				353	{
				354	"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.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	355	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	356	{
				357	"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).
				358	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				359	},
				360	],
				361	"message": "A String", # [Output Only] A human-readable description of the warning code.
				362	},
				363	],
				364	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				365	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	366	</div>
				367
				368	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	369	<code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	370	<pre>Retrieves the list of firewall rules available to the specified project.
				371
				372	Args:
				373	project: string, Project ID for this request. (required)
yoshi-code-bot	8595441	2021-12-06 23:26:37 -0800	[diff] [blame^]	374	filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` 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. 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) ```
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	375	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`)
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	376	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	377	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.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	378	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	379	x__xgafv: string, V1 error format.
				380	Allowed values
				381	1 - v1 error format
				382	2 - v2 error format
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	383
				384	Returns:
				385	An object of the form:
				386
				387	{ # Contains a list of firewalls.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	388	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				389	"items": [ # A list of Firewall resources.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	390	{ # Represents a Firewall Rule resource. Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	391	"allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	392	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	393	"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.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	394	"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. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	395	"A String",
				396	],
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	397	},
				398	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	399	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				400	"denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.
				401	{
				402	"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.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	403	"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. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	404	"A String",
				405	],
				406	},
				407	],
				408	"description": "A String", # An optional description of this resource. Provide this field when you create the resource.
yoshi-code-bot	96afc04	2021-08-24 00:22:31 -0700	[diff] [blame]	409	"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. Both IPv4 and IPv6 are supported.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	410	"A String",
				411	],
				412	"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.
				413	"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.
				414	"enableLogging": True or False, # Deprecated in favor of enable in LogConfig. This field denotes whether to enable logging for a particular firewall rule. If logging is enabled, logs will be exported t Cloud Logging.
				415	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				416	"kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules.
				417	"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 Cloud Logging.
				418	"enable": True or False, # This field denotes whether to enable logging for a particular firewall rule.
				419	"metadata": "A String", # This field can only be specified for a particular firewall rule if logging is enabled for that rule. This field denotes whether to include or exclude metadata for firewall logs.
				420	},
yoshi-code-bot	8595441	2021-12-06 23:26:37 -0800	[diff] [blame^]	421	"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.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	422	"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: global/networks/default 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: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	423	"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`.
				424	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				425	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
yoshi-code-bot	96afc04	2021-08-24 00:22:31 -0700	[diff] [blame]	426	"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. Both IPv4 and IPv6 are supported.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	427	"A String",
				428	],
				429	"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.
				430	"A String",
				431	],
				432	"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.
				433	"A String",
				434	],
				435	"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.
				436	"A String",
				437	],
				438	"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.
				439	"A String",
				440	],
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	441	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	442	],
				443	"kind": "compute#firewallList", # [Output Only] Type of resource. Always compute#firewallList for lists of firewalls.
				444	"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.
				445	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				446	"warning": { # [Output Only] Informational warning message.
				447	"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.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	448	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	449	{
				450	"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).
				451	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				452	},
				453	],
				454	"message": "A String", # [Output Only] A human-readable description of the warning code.
				455	},
				456	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	457	</div>
				458
				459	<div class="method">
				460	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				461	<pre>Retrieves the next page of results.
				462
				463	Args:
				464	previous_request: The request for the previous page. (required)
				465	previous_response: The response from the request for the previous page. (required)
				466
				467	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	468	A request object that you can call 'execute()' on to request the next
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	469	page. Returns None if there are no more items in the collection.
				470	</pre>
				471	</div>
				472
				473	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	474	<code class="details" id="patch">patch(project, firewall, body=None, requestId=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	475	<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.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	476
				477	Args:
				478	project: string, Project ID for this request. (required)
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	479	firewall: string, Name of the firewall rule to patch. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	480	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	481	The object takes the form of:
				482
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	483	{ # Represents a Firewall Rule resource. Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	484	"allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
				485	{
				486	"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.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	487	"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. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	488	"A String",
				489	],
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	490	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	491	],
				492	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				493	"denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.
				494	{
				495	"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.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	496	"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. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	497	"A String",
				498	],
				499	},
				500	],
				501	"description": "A String", # An optional description of this resource. Provide this field when you create the resource.
yoshi-code-bot	96afc04	2021-08-24 00:22:31 -0700	[diff] [blame]	502	"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. Both IPv4 and IPv6 are supported.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	503	"A String",
				504	],
				505	"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.
				506	"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.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	507	"enableLogging": True or False, # Deprecated in favor of enable in LogConfig. This field denotes whether to enable logging for a particular firewall rule. If logging is enabled, logs will be exported t Cloud Logging.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	508	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				509	"kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	510	"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 Cloud Logging.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	511	"enable": True or False, # This field denotes whether to enable logging for a particular firewall rule.
				512	"metadata": "A String", # This field can only be specified for a particular firewall rule if logging is enabled for that rule. This field denotes whether to include or exclude metadata for firewall logs.
				513	},
yoshi-code-bot	8595441	2021-12-06 23:26:37 -0800	[diff] [blame^]	514	"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.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	515	"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: global/networks/default 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: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	516	"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`.
				517	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				518	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
yoshi-code-bot	96afc04	2021-08-24 00:22:31 -0700	[diff] [blame]	519	"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. Both IPv4 and IPv6 are supported.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	520	"A String",
				521	],
				522	"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.
				523	"A String",
				524	],
				525	"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.
				526	"A String",
				527	],
				528	"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.
				529	"A String",
				530	],
				531	"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.
				532	"A String",
				533	],
				534	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	535
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	536	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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
				537	x__xgafv: string, V1 error format.
				538	Allowed values
				539	1 - v1 error format
				540	2 - v2 error format
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	541
				542	Returns:
				543	An object of the form:
				544
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	545	{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	546	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				547	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				548	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				549	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				550	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				551	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	552	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	553	"code": "A String", # [Output Only] The error type identifier for this error.
				554	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				555	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	556	},
				557	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	558	},
				559	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				560	"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.
				561	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				562	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				563	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bot	8595441	2021-12-06 23:26:37 -0800	[diff] [blame^]	564	"metadata": { # [Output Only] Service-specific metadata attached to this operation.
				565	"a_key": "", # Properties of the object. Contains field @type with type URL.
				566	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	567	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	568	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	569	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				570	"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.
				571	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				572	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				573	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				574	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				575	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				576	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				577	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				578	"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.
				579	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				580	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				581	{
				582	"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.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	583	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	584	{
				585	"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).
				586	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				587	},
				588	],
				589	"message": "A String", # [Output Only] A human-readable description of the warning code.
				590	},
				591	],
				592	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				593	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	594	</div>
				595
				596	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	597	<code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	598	<pre>Returns permissions that a caller has on the specified resource.
				599
				600	Args:
				601	project: string, Project ID for this request. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	602	resource: string, Name or id of the resource for this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	603	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	604	The object takes the form of:
				605
				606	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	607	"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '' or 'storage.') are not allowed.
				608	"A String",
				609	],
				610	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	611
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	612	x__xgafv: string, V1 error format.
				613	Allowed values
				614	1 - v1 error format
				615	2 - v2 error format
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	616
				617	Returns:
				618	An object of the form:
				619
				620	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	621	"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
				622	"A String",
				623	],
				624	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	625	</div>
				626
				627	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	628	<code class="details" id="update">update(project, firewall, body=None, requestId=None, x__xgafv=None)</code>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	629	<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.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	630
				631	Args:
				632	project: string, Project ID for this request. (required)
				633	firewall: string, Name of the firewall rule to update. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	634	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	635	The object takes the form of:
				636
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	637	{ # Represents a Firewall Rule resource. Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	638	"allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
				639	{
				640	"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.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	641	"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. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	642	"A String",
				643	],
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	644	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	645	],
				646	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				647	"denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.
				648	{
				649	"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.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	650	"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. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	651	"A String",
				652	],
				653	},
				654	],
				655	"description": "A String", # An optional description of this resource. Provide this field when you create the resource.
yoshi-code-bot	96afc04	2021-08-24 00:22:31 -0700	[diff] [blame]	656	"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. Both IPv4 and IPv6 are supported.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	657	"A String",
				658	],
				659	"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.
				660	"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.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	661	"enableLogging": True or False, # Deprecated in favor of enable in LogConfig. This field denotes whether to enable logging for a particular firewall rule. If logging is enabled, logs will be exported t Cloud Logging.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	662	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				663	"kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	664	"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 Cloud Logging.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	665	"enable": True or False, # This field denotes whether to enable logging for a particular firewall rule.
				666	"metadata": "A String", # This field can only be specified for a particular firewall rule if logging is enabled for that rule. This field denotes whether to include or exclude metadata for firewall logs.
				667	},
yoshi-code-bot	8595441	2021-12-06 23:26:37 -0800	[diff] [blame^]	668	"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.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	669	"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: global/networks/default 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: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	670	"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`.
				671	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				672	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
yoshi-code-bot	96afc04	2021-08-24 00:22:31 -0700	[diff] [blame]	673	"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. Both IPv4 and IPv6 are supported.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	674	"A String",
				675	],
				676	"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.
				677	"A String",
				678	],
				679	"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.
				680	"A String",
				681	],
				682	"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.
				683	"A String",
				684	],
				685	"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.
				686	"A String",
				687	],
				688	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	689
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	690	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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
				691	x__xgafv: string, V1 error format.
				692	Allowed values
				693	1 - v1 error format
				694	2 - v2 error format
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	695
				696	Returns:
				697	An object of the form:
				698
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	699	{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	700	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				701	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				702	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				703	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				704	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				705	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	706	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	707	"code": "A String", # [Output Only] The error type identifier for this error.
				708	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				709	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	710	},
				711	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	712	},
				713	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				714	"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.
				715	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				716	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				717	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bot	8595441	2021-12-06 23:26:37 -0800	[diff] [blame^]	718	"metadata": { # [Output Only] Service-specific metadata attached to this operation.
				719	"a_key": "", # Properties of the object. Contains field @type with type URL.
				720	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	721	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	722	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	723	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				724	"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.
				725	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				726	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				727	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				728	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				729	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				730	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				731	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				732	"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.
				733	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				734	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				735	{
				736	"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.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	737	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	738	{
				739	"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).
				740	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				741	},
				742	],
				743	"message": "A String", # [Output Only] A human-readable description of the warning code.
				744	},
				745	],
				746	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				747	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	748	</div>
				749
				750	</body></html>