Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / bf7066efaaa091e67f39440232ab73d38e51b5b1 / . / docs / dyn / compute_v1.firewalls.html
blob: e3f17d8b18c9824dca46c3edef1d3297399fa879 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.firewalls.html">firewalls</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(project, firewall)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]79<p class="firstline">Deletes the specified firewall.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]80<p class="toc_element">
81 <code><a href="#get">get(project, firewall)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]82<p class="firstline">Returns the specified firewall.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]83<p class="toc_element">
84 <code><a href="#insert">insert(project, body)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]85<p class="firstline">Creates a firewall rule in the specified project using the data included in the request.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]86<p class="toc_element">
87 <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]88<p class="firstline">Retrieves the list of firewall rules available to the specified project.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93 <code><a href="#patch">patch(project, firewall, body)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]94<p class="firstline">Updates the specified firewall rule with the data included in the request. This method supports patch semantics.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]95<p class="toc_element">
96 <code><a href="#update">update(project, firewall, body)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]97<p class="firstline">Updates the specified firewall rule with the data included in the request.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="delete">delete(project, firewall)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]101 <pre>Deletes the specified firewall.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]102
103Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]104 project: string, Project ID for this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]105 firewall: string, Name of the firewall rule to delete. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]106
107Returns:
108 An object of the form:
109
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]110 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]111 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
112 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]113 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]114 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
115 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
116 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
117 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]118 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]119 "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.
120 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]121 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]122 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
123 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]124 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]125 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]126 "message": "A String", # [Output Only] A human-readable description of the warning code.
127 "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.
128 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
129 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]130 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]131 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]132 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]133 },
134 ],
135 },
136 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]137 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]138 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
139 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]140 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]141 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]142 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]143 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]144 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]145 "message": "A String", # [Output Only] An optional, human-readable error message.
146 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]147 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]148 },
149 ],
150 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]151 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]152 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]153 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]154 }</pre>
155</div>
156
157<div class="method">
158 <code class="details" id="get">get(project, firewall)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]159 <pre>Returns the specified firewall.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]160
161Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]162 project: string, Project ID for this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]163 firewall: string, Name of the firewall rule to return. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]164
165Returns:
166 An object of the form:
167
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]168 { # Represents a Firewall resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]169 "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]170 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]171 "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set.
172 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]173 # If both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]174 #
175 # Source tags cannot be used to allow access to an instance's external IP address. Because tags are associated with an instance, not an IP address, source tags can only be used to control traffic traveling from an instance inside the same network as the firewall.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]176 "A String",
177 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]178 "sourceRanges": [ # The IP address blocks that this rule applies to, expressed in CIDR format. One or both of sourceRanges and sourceTags may be set.
179 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]180 # If both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]181 "A String",
182 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]183 "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:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]184 # global/networks/default
185 # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
186 # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
187 # - projects/myproject/global/networks/my-network
188 # - global/networks/default
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]189 "targetTags": [ # A list of instance tags indicating sets of instances located in the network that may make network connections as specified in allowed[]. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]190 "A String",
191 ],
192 "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
193 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]194 "IPProtocol": "A String", # The IP protocol that is allowed for this rule. 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, sctp), or the IP protocol number.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]195 "ports": [ # An optional list of ports which are allowed. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, connections through any port are allowed
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]196 #
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]197 # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]198 "A String",
199 ],
200 },
201 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]202 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]203 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]204 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]205 "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])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]206 }</pre>
207</div>
208
209<div class="method">
210 <code class="details" id="insert">insert(project, body)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]211 <pre>Creates a firewall rule in the specified project using the data included in the request.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]212
213Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]214 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]215 body: object, The request body. (required)
216 The object takes the form of:
217
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]218{ # Represents a Firewall resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]219 "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]220 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]221 "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set.
222 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]223 # If both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]224 #
225 # Source tags cannot be used to allow access to an instance's external IP address. Because tags are associated with an instance, not an IP address, source tags can only be used to control traffic traveling from an instance inside the same network as the firewall.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]226 "A String",
227 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]228 "sourceRanges": [ # The IP address blocks that this rule applies to, expressed in CIDR format. One or both of sourceRanges and sourceTags may be set.
229 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]230 # If both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]231 "A String",
232 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]233 "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:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]234 # global/networks/default
235 # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
236 # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
237 # - projects/myproject/global/networks/my-network
238 # - global/networks/default
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]239 "targetTags": [ # A list of instance tags indicating sets of instances located in the network that may make network connections as specified in allowed[]. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]240 "A String",
241 ],
242 "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
243 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]244 "IPProtocol": "A String", # The IP protocol that is allowed for this rule. 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, sctp), or the IP protocol number.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]245 "ports": [ # An optional list of ports which are allowed. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, connections through any port are allowed
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]246 #
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]247 # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]248 "A String",
249 ],
250 },
251 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]252 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]253 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]254 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]255 "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])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]256 }
257
258
259Returns:
260 An object of the form:
261
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]262 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]263 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
264 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]265 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]266 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
267 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
268 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
269 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]270 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]271 "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.
272 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]273 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]274 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
275 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]276 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]277 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]278 "message": "A String", # [Output Only] A human-readable description of the warning code.
279 "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.
280 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
281 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]282 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]283 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]284 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]285 },
286 ],
287 },
288 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]289 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]290 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
291 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]292 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]293 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]294 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]295 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]296 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]297 "message": "A String", # [Output Only] An optional, human-readable error message.
298 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]299 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]300 },
301 ],
302 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]303 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]304 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]305 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]306 }</pre>
307</div>
308
309<div class="method">
310 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]311 <pre>Retrieves the list of firewall rules available to the specified project.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]312
313Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]314 project: string, Project ID for this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]315 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.
316 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.
317 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]318
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]319The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]320
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]321For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]322
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]323Compute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]324
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]325The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]326
327Returns:
328 An object of the form:
329
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]330 { # Contains a list of firewalls.
331 "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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]332 "items": [ # [Output Only] A list of Firewall resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]333 { # Represents a Firewall resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]334 "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]335 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]336 "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set.
337 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]338 # If both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]339 #
340 # Source tags cannot be used to allow access to an instance's external IP address. Because tags are associated with an instance, not an IP address, source tags can only be used to control traffic traveling from an instance inside the same network as the firewall.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]341 "A String",
342 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]343 "sourceRanges": [ # The IP address blocks that this rule applies to, expressed in CIDR format. One or both of sourceRanges and sourceTags may be set.
344 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]345 # If both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]346 "A String",
347 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]348 "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:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]349 # global/networks/default
350 # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
351 # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
352 # - projects/myproject/global/networks/my-network
353 # - global/networks/default
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]354 "targetTags": [ # A list of instance tags indicating sets of instances located in the network that may make network connections as specified in allowed[]. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]355 "A String",
356 ],
357 "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
358 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]359 "IPProtocol": "A String", # The IP protocol that is allowed for this rule. 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, sctp), or the IP protocol number.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]360 "ports": [ # An optional list of ports which are allowed. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, connections through any port are allowed
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]361 #
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]362 # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]363 "A String",
364 ],
365 },
366 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]367 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]368 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]369 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]370 "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])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]371 },
372 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]373 "kind": "compute#firewallList", # [Output Only] Type of resource. Always compute#firewallList for lists of firewalls.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]374 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]375 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]376 }</pre>
377</div>
378
379<div class="method">
380 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
381 <pre>Retrieves the next page of results.
382
383Args:
384 previous_request: The request for the previous page. (required)
385 previous_response: The response from the request for the previous page. (required)
386
387Returns:
388 A request object that you can call 'execute()' on to request the next
389 page. Returns None if there are no more items in the collection.
390 </pre>
391</div>
392
393<div class="method">
394 <code class="details" id="patch">patch(project, firewall, body)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]395 <pre>Updates the specified firewall rule with the data included in the request. This method supports patch semantics.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]396
397Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]398 project: string, Project ID for this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]399 firewall: string, Name of the firewall rule to update. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]400 body: object, The request body. (required)
401 The object takes the form of:
402
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]403{ # Represents a Firewall resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]404 "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]405 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]406 "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set.
407 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]408 # If both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]409 #
410 # Source tags cannot be used to allow access to an instance's external IP address. Because tags are associated with an instance, not an IP address, source tags can only be used to control traffic traveling from an instance inside the same network as the firewall.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]411 "A String",
412 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]413 "sourceRanges": [ # The IP address blocks that this rule applies to, expressed in CIDR format. One or both of sourceRanges and sourceTags may be set.
414 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]415 # If both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]416 "A String",
417 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]418 "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:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]419 # global/networks/default
420 # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
421 # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
422 # - projects/myproject/global/networks/my-network
423 # - global/networks/default
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]424 "targetTags": [ # A list of instance tags indicating sets of instances located in the network that may make network connections as specified in allowed[]. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]425 "A String",
426 ],
427 "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
428 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]429 "IPProtocol": "A String", # The IP protocol that is allowed for this rule. 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, sctp), or the IP protocol number.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]430 "ports": [ # An optional list of ports which are allowed. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, connections through any port are allowed
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]431 #
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]432 # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]433 "A String",
434 ],
435 },
436 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]437 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]438 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]439 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]440 "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])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]441 }
442
443
444Returns:
445 An object of the form:
446
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]447 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]448 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
449 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]450 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]451 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
452 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
453 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
454 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]455 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]456 "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.
457 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]458 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]459 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
460 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]461 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]462 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]463 "message": "A String", # [Output Only] A human-readable description of the warning code.
464 "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.
465 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
466 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]467 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]468 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]469 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]470 },
471 ],
472 },
473 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]474 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]475 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
476 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]477 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]478 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]479 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]480 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]481 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]482 "message": "A String", # [Output Only] An optional, human-readable error message.
483 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]484 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]485 },
486 ],
487 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]488 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]489 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]490 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]491 }</pre>
492</div>
493
494<div class="method">
495 <code class="details" id="update">update(project, firewall, body)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]496 <pre>Updates the specified firewall rule with the data included in the request.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]497
498Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]499 project: string, Project ID for this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]500 firewall: string, Name of the firewall rule to update. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]501 body: object, The request body. (required)
502 The object takes the form of:
503
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]504{ # Represents a Firewall resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]505 "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]506 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]507 "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set.
508 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]509 # If both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]510 #
511 # Source tags cannot be used to allow access to an instance's external IP address. Because tags are associated with an instance, not an IP address, source tags can only be used to control traffic traveling from an instance inside the same network as the firewall.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]512 "A String",
513 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]514 "sourceRanges": [ # The IP address blocks that this rule applies to, expressed in CIDR format. One or both of sourceRanges and sourceTags may be set.
515 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]516 # If both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]517 "A String",
518 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]519 "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:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]520 # global/networks/default
521 # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
522 # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
523 # - projects/myproject/global/networks/my-network
524 # - global/networks/default
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]525 "targetTags": [ # A list of instance tags indicating sets of instances located in the network that may make network connections as specified in allowed[]. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]526 "A String",
527 ],
528 "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
529 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]530 "IPProtocol": "A String", # The IP protocol that is allowed for this rule. 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, sctp), or the IP protocol number.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]531 "ports": [ # An optional list of ports which are allowed. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, connections through any port are allowed
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]532 #
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]533 # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]534 "A String",
535 ],
536 },
537 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]538 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]539 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]540 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]541 "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])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]542 }
543
544
545Returns:
546 An object of the form:
547
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]548 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]549 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
550 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]551 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]552 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
553 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
554 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
555 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]556 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]557 "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.
558 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]559 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]560 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
561 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]562 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]563 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]564 "message": "A String", # [Output Only] A human-readable description of the warning code.
565 "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.
566 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
567 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]568 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]569 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]570 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]571 },
572 ],
573 },
574 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]575 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]576 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
577 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]578 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]579 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]580 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]581 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]582 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]583 "message": "A String", # [Output Only] An optional, human-readable error message.
584 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]585 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]586 },
587 ],
588 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]589 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]590 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]591 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]592 }</pre>
593</div>
594
595</body></html>