Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 5cbe5baf3fad3d67e05b9387e8d81de7ce99aeb9 / . / docs / dyn / compute_v1.firewalls.html
blob: d4671ae086d798a02ba10680129d3ef167d963cf [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>
79<p class="firstline">Deletes the specified firewall resource.</p>
80<p class="toc_element">
81 <code><a href="#get">get(project, firewall)</a></code></p>
82<p class="firstline">Returns the specified firewall resource.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(project, body)</a></code></p>
85<p class="firstline">Creates a firewall resource in the specified project using the data included in the request.</p>
86<p class="toc_element">
87 <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
88<p class="firstline">Retrieves the list of firewall resources available to the specified project.</p>
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>
94<p class="firstline">Updates the specified firewall resource with the data included in the request. This method supports patch semantics.</p>
95<p class="toc_element">
96 <code><a href="#update">update(project, firewall, body)</a></code></p>
97<p class="firstline">Updates the specified firewall resource with the data included in the request.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="delete">delete(project, firewall)</code>
101 <pre>Deletes the specified firewall resource.
102
103Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]104 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]105 firewall: string, Name of the firewall resource to delete. (required)
106
107Returns:
108 An object of the form:
109
110 { # An operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]111 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
112 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
113 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]114 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]115 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
116 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
117 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
118 "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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
119 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]120 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]121 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
122 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
123 "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]124 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]125 "message": "A String", # [Output Only] Optional human-readable details for this warning.
126 "code": "A String", # [Output Only] The warning type identifier for this warning.
127 "data": [ # [Output Only] Metadata for this warning in key: value format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]128 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]129 "value": "A String", # [Output Only] A warning data value corresponding to the key.
130 "key": "A String", # [Output Only] A key for the warning data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]131 },
132 ],
133 },
134 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]135 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
136 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
137 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
138 "name": "A String", # [Output Only] Name of the resource.
139 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
140 "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]141 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]142 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]143 "message": "A String", # [Output Only] An optional, human-readable error message.
144 "code": "A String", # [Output Only] The error type identifier for this error.
145 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]146 },
147 ],
148 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]149 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]150 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]151 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]152 }</pre>
153</div>
154
155<div class="method">
156 <code class="details" id="get">get(project, firewall)</code>
157 <pre>Returns the specified firewall resource.
158
159Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]160 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]161 firewall: string, Name of the firewall resource to return. (required)
162
163Returns:
164 An object of the form:
165
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]166 { # A Firewall resource.
167 "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]168 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]169 "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set.
170 #
171 # If both properties are set, an inbound connection is allowed if the range or the tag of the source matches the sourceRanges OR matches the sourceTags property; the connection does not need to match both properties.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]172 "A String",
173 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]174 "sourceRanges": [ # The IP address blocks that this rule applies to, expressed in CIDR format. One or both of sourceRanges and sourceTags may be set.
175 #
176 # If both properties are set, an inbound connection is allowed if the range or the tag of the source matches the sourceRanges OR matches the sourceTags property; the connection does not need to match both properties.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]177 "A String",
178 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]179 "network": "A String", # URL of the network resource for this firewall rule. This field is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
180 # global/networks/default
181 # 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:
182 # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
183 # - projects/myproject/global/networks/my-network
184 # - global/networks/default
185 "targetTags": [ # A list of instance tags indicating sets of instances located on network which 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]186 "A String",
187 ],
188 "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
189 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]190 "IPProtocol": "A String", # The IP protocol that is allowed for this rule. The protocol type is required when creating a firewall. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
191 "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]192 #
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]193 # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]194 "A String",
195 ],
196 },
197 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]198 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339text format.
199 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
200 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
201 "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]202 }</pre>
203</div>
204
205<div class="method">
206 <code class="details" id="insert">insert(project, body)</code>
207 <pre>Creates a firewall resource in the specified project using the data included in the request.
208
209Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]210 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]211 body: object, The request body. (required)
212 The object takes the form of:
213
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]214{ # A Firewall resource.
215 "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]216 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]217 "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set.
218 #
219 # If both properties are set, an inbound connection is allowed if the range or the tag of the source matches the sourceRanges OR matches the sourceTags property; the connection does not need to match both properties.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]220 "A String",
221 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]222 "sourceRanges": [ # The IP address blocks that this rule applies to, expressed in CIDR format. One or both of sourceRanges and sourceTags may be set.
223 #
224 # If both properties are set, an inbound connection is allowed if the range or the tag of the source matches the sourceRanges OR matches the sourceTags property; the connection does not need to match both properties.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]225 "A String",
226 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]227 "network": "A String", # URL of the network resource for this firewall rule. This field is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
228 # global/networks/default
229 # 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:
230 # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
231 # - projects/myproject/global/networks/my-network
232 # - global/networks/default
233 "targetTags": [ # A list of instance tags indicating sets of instances located on network which 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]234 "A String",
235 ],
236 "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
237 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]238 "IPProtocol": "A String", # The IP protocol that is allowed for this rule. The protocol type is required when creating a firewall. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
239 "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]240 #
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]241 # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]242 "A String",
243 ],
244 },
245 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]246 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339text format.
247 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
248 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
249 "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]250 }
251
252
253Returns:
254 An object of the form:
255
256 { # An operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]257 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
258 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
259 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]260 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]261 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
262 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
263 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
264 "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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
265 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]266 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]267 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
268 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
269 "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]270 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]271 "message": "A String", # [Output Only] Optional human-readable details for this warning.
272 "code": "A String", # [Output Only] The warning type identifier for this warning.
273 "data": [ # [Output Only] Metadata for this warning in key: value format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]274 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]275 "value": "A String", # [Output Only] A warning data value corresponding to the key.
276 "key": "A String", # [Output Only] A key for the warning data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]277 },
278 ],
279 },
280 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]281 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
282 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
283 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
284 "name": "A String", # [Output Only] Name of the resource.
285 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
286 "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]287 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]288 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]289 "message": "A String", # [Output Only] An optional, human-readable error message.
290 "code": "A String", # [Output Only] The error type identifier for this error.
291 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]292 },
293 ],
294 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]295 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]296 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]297 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]298 }</pre>
299</div>
300
301<div class="method">
302 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
303 <pre>Retrieves the list of firewall resources available to the specified project.
304
305Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]306 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]307 maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
308 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
309 filter: string, Optional. Filter expression for filtering listed resources.
310
311Returns:
312 An object of the form:
313
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]314 { # Contains a list of Firewall resources.
315 "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
316 "items": [ # [Output Only] A list of Firewall resources.
317 { # A Firewall resource.
318 "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]319 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]320 "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set.
321 #
322 # If both properties are set, an inbound connection is allowed if the range or the tag of the source matches the sourceRanges OR matches the sourceTags property; the connection does not need to match both properties.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]323 "A String",
324 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]325 "sourceRanges": [ # The IP address blocks that this rule applies to, expressed in CIDR format. One or both of sourceRanges and sourceTags may be set.
326 #
327 # If both properties are set, an inbound connection is allowed if the range or the tag of the source matches the sourceRanges OR matches the sourceTags property; the connection does not need to match both properties.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]328 "A String",
329 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]330 "network": "A String", # URL of the network resource for this firewall rule. This field is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
331 # global/networks/default
332 # 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:
333 # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
334 # - projects/myproject/global/networks/my-network
335 # - global/networks/default
336 "targetTags": [ # A list of instance tags indicating sets of instances located on network which 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]337 "A String",
338 ],
339 "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
340 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]341 "IPProtocol": "A String", # The IP protocol that is allowed for this rule. The protocol type is required when creating a firewall. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
342 "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]343 #
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]344 # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]345 "A String",
346 ],
347 },
348 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]349 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339text format.
350 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
351 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
352 "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]353 },
354 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]355 "kind": "compute#firewallList", # [Output Only] Type of resource. Always compute#firewallList for lists of firewalls.
356 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
357 "selfLink": "A String", # [Output Only] Server defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]358 }</pre>
359</div>
360
361<div class="method">
362 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
363 <pre>Retrieves the next page of results.
364
365Args:
366 previous_request: The request for the previous page. (required)
367 previous_response: The response from the request for the previous page. (required)
368
369Returns:
370 A request object that you can call 'execute()' on to request the next
371 page. Returns None if there are no more items in the collection.
372 </pre>
373</div>
374
375<div class="method">
376 <code class="details" id="patch">patch(project, firewall, body)</code>
377 <pre>Updates the specified firewall resource with the data included in the request. This method supports patch semantics.
378
379Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]380 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]381 firewall: string, Name of the firewall resource to update. (required)
382 body: object, The request body. (required)
383 The object takes the form of:
384
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]385{ # A Firewall resource.
386 "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]387 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]388 "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set.
389 #
390 # If both properties are set, an inbound connection is allowed if the range or the tag of the source matches the sourceRanges OR matches the sourceTags property; the connection does not need to match both properties.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]391 "A String",
392 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]393 "sourceRanges": [ # The IP address blocks that this rule applies to, expressed in CIDR format. One or both of sourceRanges and sourceTags may be set.
394 #
395 # If both properties are set, an inbound connection is allowed if the range or the tag of the source matches the sourceRanges OR matches the sourceTags property; the connection does not need to match both properties.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]396 "A String",
397 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]398 "network": "A String", # URL of the network resource for this firewall rule. This field is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
399 # global/networks/default
400 # 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:
401 # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
402 # - projects/myproject/global/networks/my-network
403 # - global/networks/default
404 "targetTags": [ # A list of instance tags indicating sets of instances located on network which 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]405 "A String",
406 ],
407 "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
408 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]409 "IPProtocol": "A String", # The IP protocol that is allowed for this rule. The protocol type is required when creating a firewall. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
410 "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]411 #
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]412 # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]413 "A String",
414 ],
415 },
416 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]417 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339text format.
418 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
419 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
420 "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]421 }
422
423
424Returns:
425 An object of the form:
426
427 { # An operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]428 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
429 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
430 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]431 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]432 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
433 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
434 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
435 "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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
436 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]437 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]438 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
439 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
440 "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]441 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]442 "message": "A String", # [Output Only] Optional human-readable details for this warning.
443 "code": "A String", # [Output Only] The warning type identifier for this warning.
444 "data": [ # [Output Only] Metadata for this warning in key: value format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]445 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]446 "value": "A String", # [Output Only] A warning data value corresponding to the key.
447 "key": "A String", # [Output Only] A key for the warning data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]448 },
449 ],
450 },
451 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]452 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
453 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
454 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
455 "name": "A String", # [Output Only] Name of the resource.
456 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
457 "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]458 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]459 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]460 "message": "A String", # [Output Only] An optional, human-readable error message.
461 "code": "A String", # [Output Only] The error type identifier for this error.
462 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]463 },
464 ],
465 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]466 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]467 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]468 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]469 }</pre>
470</div>
471
472<div class="method">
473 <code class="details" id="update">update(project, firewall, body)</code>
474 <pre>Updates the specified firewall resource with the data included in the request.
475
476Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]477 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]478 firewall: string, Name of the firewall resource to update. (required)
479 body: object, The request body. (required)
480 The object takes the form of:
481
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]482{ # A Firewall resource.
483 "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]484 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]485 "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set.
486 #
487 # If both properties are set, an inbound connection is allowed if the range or the tag of the source matches the sourceRanges OR matches the sourceTags property; the connection does not need to match both properties.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]488 "A String",
489 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]490 "sourceRanges": [ # The IP address blocks that this rule applies to, expressed in CIDR format. One or both of sourceRanges and sourceTags may be set.
491 #
492 # If both properties are set, an inbound connection is allowed if the range or the tag of the source matches the sourceRanges OR matches the sourceTags property; the connection does not need to match both properties.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]493 "A String",
494 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]495 "network": "A String", # URL of the network resource for this firewall rule. This field is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
496 # global/networks/default
497 # 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:
498 # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
499 # - projects/myproject/global/networks/my-network
500 # - global/networks/default
501 "targetTags": [ # A list of instance tags indicating sets of instances located on network which 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]502 "A String",
503 ],
504 "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
505 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]506 "IPProtocol": "A String", # The IP protocol that is allowed for this rule. The protocol type is required when creating a firewall. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
507 "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]508 #
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]509 # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]510 "A String",
511 ],
512 },
513 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]514 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339text format.
515 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
516 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
517 "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]518 }
519
520
521Returns:
522 An object of the form:
523
524 { # An operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]525 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
526 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
527 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]528 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]529 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
530 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
531 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
532 "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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
533 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]534 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]535 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
536 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
537 "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]538 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]539 "message": "A String", # [Output Only] Optional human-readable details for this warning.
540 "code": "A String", # [Output Only] The warning type identifier for this warning.
541 "data": [ # [Output Only] Metadata for this warning in key: value format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]542 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]543 "value": "A String", # [Output Only] A warning data value corresponding to the key.
544 "key": "A String", # [Output Only] A key for the warning data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]545 },
546 ],
547 },
548 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]549 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
550 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
551 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
552 "name": "A String", # [Output Only] Name of the resource.
553 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
554 "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]555 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]556 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]557 "message": "A String", # [Output Only] An optional, human-readable error message.
558 "code": "A String", # [Output Only] The error type identifier for this error.
559 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]560 },
561 ],
562 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]563 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]564 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]565 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]566 }</pre>
567</div>
568
569</body></html>