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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.firewalls.html">firewalls</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#delete">delete(project, firewall, requestId=None)</a></code></p>
79<p class="firstline">Deletes the specified firewall.</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.</p>
83<p class="toc_element">
84  <code><a href="#insert">insert(project, body, requestId=None)</a></code></p>
85<p class="firstline">Creates a firewall rule in the specified project using the data included in the request.</p>
86<p class="toc_element">
87  <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
88<p class="firstline">Retrieves the list of firewall rules 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, requestId=None)</a></code></p>
94<p class="firstline">Updates the specified firewall rule with the data included in the request. This method supports patch semantics.</p>
95<p class="toc_element">
96  <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
97<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
98<p class="toc_element">
99  <code><a href="#update">update(project, firewall, body, requestId=None)</a></code></p>
100<p class="firstline">Updates the specified firewall rule with the data included in the request. Using PUT method, can only update following fields of firewall rule: allowed, description, sourceRanges, sourceTags, targetTags.</p>
101<h3>Method Details</h3>
102<div class="method">
103    <code class="details" id="delete">delete(project, firewall, requestId=None)</code>
104  <pre>Deletes the specified firewall.
105
106Args:
107  project: string, Project ID for this request. (required)
108  firewall: string, Name of the firewall rule to delete. (required)
109  requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
110
111Returns:
112  An object of the form:
113
114    { # An Operation resource, used to manage asynchronous API requests.
115    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
116    "clientOperationId": "A String", # [Output Only] Reserved for future use.
117    "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
118    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
119    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
120    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
121    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
122    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
123    "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.
124    "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.
125    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
126    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
127    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
128    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
129      {
130        "message": "A String", # [Output Only] A human-readable description of the warning code.
131        "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.
132        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
133            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
134          {
135            "value": "A String", # [Output Only] A warning data value corresponding to the key.
136            "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).
137          },
138        ],
139      },
140    ],
141    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
142    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
143    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
144    "name": "A String", # [Output Only] Name of the resource.
145    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
146    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
147      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
148        {
149          "message": "A String", # [Output Only] An optional, human-readable error message.
150          "code": "A String", # [Output Only] The error type identifier for this error.
151          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
152        },
153      ],
154    },
155    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
156    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
157    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
158  }</pre>
159</div>
160
161<div class="method">
162    <code class="details" id="get">get(project, firewall)</code>
163  <pre>Returns the specified firewall.
164
165Args:
166  project: string, Project ID for this request. (required)
167  firewall: string, Name of the firewall rule to return. (required)
168
169Returns:
170  An object of the form:
171
172    { # Represents a Firewall resource.
173      "direction": "A String", # Direction of traffic to which this firewall applies; default is INGRESS. Note: For INGRESS traffic, it is NOT supported to specify destinationRanges; For EGRESS traffic, it is NOT supported to specify sourceRanges OR sourceTags.
174      "sourceServiceAccounts": [ # If source service accounts are specified, the firewall will apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both properties for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.
175        "A String",
176      ],
177      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
178      "destinationRanges": [ # If destination ranges are specified, the firewall will apply only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported.
179        "A String",
180      ],
181      "sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
182        "A String",
183      ],
184      "allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
185        {
186          "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
187          "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
188              #
189              # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
190            "A String",
191          ],
192        },
193      ],
194      "kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules.
195      "sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. Only IPv4 is supported.
196        "A String",
197      ],
198      "priority": 42, # Priority for this rule. This is an integer between 0 and 65535, both inclusive. When not specified, the value assumed is 1000. Relative priorities determine precedence of conflicting rules. Lower value of priority implies higher precedence (eg, a rule with priority 0 has higher precedence than a rule with priority 1). DENY rules take precedence over ALLOW rules having equal priority.
199      "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:
200          # global/networks/default
201          # 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:
202          # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
203          # - projects/myproject/global/networks/my-network
204          # - global/networks/default
205      "targetServiceAccounts": [ # A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.
206        "A String",
207      ],
208      "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.
209        "A String",
210      ],
211      "denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
212        {
213          "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
214          "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
215              #
216              # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
217            "A String",
218          ],
219        },
220      ],
221      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
222      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
223      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
224      "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.
225    }</pre>
226</div>
227
228<div class="method">
229    <code class="details" id="insert">insert(project, body, requestId=None)</code>
230  <pre>Creates a firewall rule in the specified project using the data included in the request.
231
232Args:
233  project: string, Project ID for this request. (required)
234  body: object, The request body. (required)
235    The object takes the form of:
236
237{ # Represents a Firewall resource.
238    "direction": "A String", # Direction of traffic to which this firewall applies; default is INGRESS. Note: For INGRESS traffic, it is NOT supported to specify destinationRanges; For EGRESS traffic, it is NOT supported to specify sourceRanges OR sourceTags.
239    "sourceServiceAccounts": [ # If source service accounts are specified, the firewall will apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both properties for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.
240      "A String",
241    ],
242    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
243    "destinationRanges": [ # If destination ranges are specified, the firewall will apply only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported.
244      "A String",
245    ],
246    "sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
247      "A String",
248    ],
249    "allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
250      {
251        "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
252        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
253            #
254            # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
255          "A String",
256        ],
257      },
258    ],
259    "kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules.
260    "sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. Only IPv4 is supported.
261      "A String",
262    ],
263    "priority": 42, # Priority for this rule. This is an integer between 0 and 65535, both inclusive. When not specified, the value assumed is 1000. Relative priorities determine precedence of conflicting rules. Lower value of priority implies higher precedence (eg, a rule with priority 0 has higher precedence than a rule with priority 1). DENY rules take precedence over ALLOW rules having equal priority.
264    "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:
265        # global/networks/default
266        # 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:
267        # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
268        # - projects/myproject/global/networks/my-network
269        # - global/networks/default
270    "targetServiceAccounts": [ # A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.
271      "A String",
272    ],
273    "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.
274      "A String",
275    ],
276    "denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
277      {
278        "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
279        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
280            #
281            # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
282          "A String",
283        ],
284      },
285    ],
286    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
287    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
288    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
289    "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.
290  }
291
292  requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
293
294Returns:
295  An object of the form:
296
297    { # An Operation resource, used to manage asynchronous API requests.
298    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
299    "clientOperationId": "A String", # [Output Only] Reserved for future use.
300    "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
301    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
302    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
303    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
304    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
305    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
306    "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.
307    "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.
308    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
309    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
310    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
311    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
312      {
313        "message": "A String", # [Output Only] A human-readable description of the warning code.
314        "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.
315        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
316            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
317          {
318            "value": "A String", # [Output Only] A warning data value corresponding to the key.
319            "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).
320          },
321        ],
322      },
323    ],
324    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
325    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
326    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
327    "name": "A String", # [Output Only] Name of the resource.
328    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
329    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
330      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
331        {
332          "message": "A String", # [Output Only] An optional, human-readable error message.
333          "code": "A String", # [Output Only] The error type identifier for this error.
334          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
335        },
336      ],
337    },
338    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
339    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
340    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
341  }</pre>
342</div>
343
344<div class="method">
345    <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
346  <pre>Retrieves the list of firewall rules available to the specified project.
347
348Args:
349  project: string, Project ID for this request. (required)
350  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
351
352You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
353
354Currently, only sorting by name or creationTimestamp desc is supported.
355  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
356  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.
357  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.
358
359The 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.
360
361For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
362
363You can 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.
364
365To filter on multiple expressions, provide 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.
366
367Returns:
368  An object of the form:
369
370    { # Contains a list of firewalls.
371    "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.
372    "items": [ # [Output Only] A list of Firewall resources.
373      { # Represents a Firewall resource.
374          "direction": "A String", # Direction of traffic to which this firewall applies; default is INGRESS. Note: For INGRESS traffic, it is NOT supported to specify destinationRanges; For EGRESS traffic, it is NOT supported to specify sourceRanges OR sourceTags.
375          "sourceServiceAccounts": [ # If source service accounts are specified, the firewall will apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both properties for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.
376            "A String",
377          ],
378          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
379          "destinationRanges": [ # If destination ranges are specified, the firewall will apply only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported.
380            "A String",
381          ],
382          "sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
383            "A String",
384          ],
385          "allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
386            {
387              "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
388              "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
389                  #
390                  # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
391                "A String",
392              ],
393            },
394          ],
395          "kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules.
396          "sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. Only IPv4 is supported.
397            "A String",
398          ],
399          "priority": 42, # Priority for this rule. This is an integer between 0 and 65535, both inclusive. When not specified, the value assumed is 1000. Relative priorities determine precedence of conflicting rules. Lower value of priority implies higher precedence (eg, a rule with priority 0 has higher precedence than a rule with priority 1). DENY rules take precedence over ALLOW rules having equal priority.
400          "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:
401              # global/networks/default
402              # 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:
403              # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
404              # - projects/myproject/global/networks/my-network
405              # - global/networks/default
406          "targetServiceAccounts": [ # A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.
407            "A String",
408          ],
409          "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.
410            "A String",
411          ],
412          "denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
413            {
414              "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
415              "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
416                  #
417                  # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
418                "A String",
419              ],
420            },
421          ],
422          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
423          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
424          "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
425          "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.
426        },
427    ],
428    "kind": "compute#firewallList", # [Output Only] Type of resource. Always compute#firewallList for lists of firewalls.
429    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
430    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
431  }</pre>
432</div>
433
434<div class="method">
435    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
436  <pre>Retrieves the next page of results.
437
438Args:
439  previous_request: The request for the previous page. (required)
440  previous_response: The response from the request for the previous page. (required)
441
442Returns:
443  A request object that you can call 'execute()' on to request the next
444  page. Returns None if there are no more items in the collection.
445    </pre>
446</div>
447
448<div class="method">
449    <code class="details" id="patch">patch(project, firewall, body, requestId=None)</code>
450  <pre>Updates the specified firewall rule with the data included in the request. This method supports patch semantics.
451
452Args:
453  project: string, Project ID for this request. (required)
454  firewall: string, Name of the firewall rule to patch. (required)
455  body: object, The request body. (required)
456    The object takes the form of:
457
458{ # Represents a Firewall resource.
459    "direction": "A String", # Direction of traffic to which this firewall applies; default is INGRESS. Note: For INGRESS traffic, it is NOT supported to specify destinationRanges; For EGRESS traffic, it is NOT supported to specify sourceRanges OR sourceTags.
460    "sourceServiceAccounts": [ # If source service accounts are specified, the firewall will apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both properties for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.
461      "A String",
462    ],
463    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
464    "destinationRanges": [ # If destination ranges are specified, the firewall will apply only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported.
465      "A String",
466    ],
467    "sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
468      "A String",
469    ],
470    "allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
471      {
472        "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
473        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
474            #
475            # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
476          "A String",
477        ],
478      },
479    ],
480    "kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules.
481    "sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. Only IPv4 is supported.
482      "A String",
483    ],
484    "priority": 42, # Priority for this rule. This is an integer between 0 and 65535, both inclusive. When not specified, the value assumed is 1000. Relative priorities determine precedence of conflicting rules. Lower value of priority implies higher precedence (eg, a rule with priority 0 has higher precedence than a rule with priority 1). DENY rules take precedence over ALLOW rules having equal priority.
485    "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:
486        # global/networks/default
487        # 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:
488        # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
489        # - projects/myproject/global/networks/my-network
490        # - global/networks/default
491    "targetServiceAccounts": [ # A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.
492      "A String",
493    ],
494    "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.
495      "A String",
496    ],
497    "denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
498      {
499        "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
500        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
501            #
502            # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
503          "A String",
504        ],
505      },
506    ],
507    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
508    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
509    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
510    "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.
511  }
512
513  requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
514
515Returns:
516  An object of the form:
517
518    { # An Operation resource, used to manage asynchronous API requests.
519    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
520    "clientOperationId": "A String", # [Output Only] Reserved for future use.
521    "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
522    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
523    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
524    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
525    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
526    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
527    "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.
528    "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.
529    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
530    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
531    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
532    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
533      {
534        "message": "A String", # [Output Only] A human-readable description of the warning code.
535        "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.
536        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
537            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
538          {
539            "value": "A String", # [Output Only] A warning data value corresponding to the key.
540            "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).
541          },
542        ],
543      },
544    ],
545    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
546    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
547    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
548    "name": "A String", # [Output Only] Name of the resource.
549    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
550    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
551      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
552        {
553          "message": "A String", # [Output Only] An optional, human-readable error message.
554          "code": "A String", # [Output Only] The error type identifier for this error.
555          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
556        },
557      ],
558    },
559    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
560    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
561    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
562  }</pre>
563</div>
564
565<div class="method">
566    <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
567  <pre>Returns permissions that a caller has on the specified resource.
568
569Args:
570  project: string, Project ID for this request. (required)
571  resource: string, Name of the resource for this request. (required)
572  body: object, The request body. (required)
573    The object takes the form of:
574
575{
576    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
577      "A String",
578    ],
579  }
580
581
582Returns:
583  An object of the form:
584
585    {
586    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
587      "A String",
588    ],
589  }</pre>
590</div>
591
592<div class="method">
593    <code class="details" id="update">update(project, firewall, body, requestId=None)</code>
594  <pre>Updates the specified firewall rule with the data included in the request. Using PUT method, can only update following fields of firewall rule: allowed, description, sourceRanges, sourceTags, targetTags.
595
596Args:
597  project: string, Project ID for this request. (required)
598  firewall: string, Name of the firewall rule to update. (required)
599  body: object, The request body. (required)
600    The object takes the form of:
601
602{ # Represents a Firewall resource.
603    "direction": "A String", # Direction of traffic to which this firewall applies; default is INGRESS. Note: For INGRESS traffic, it is NOT supported to specify destinationRanges; For EGRESS traffic, it is NOT supported to specify sourceRanges OR sourceTags.
604    "sourceServiceAccounts": [ # If source service accounts are specified, the firewall will apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both properties for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.
605      "A String",
606    ],
607    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
608    "destinationRanges": [ # If destination ranges are specified, the firewall will apply only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported.
609      "A String",
610    ],
611    "sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
612      "A String",
613    ],
614    "allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
615      {
616        "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
617        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
618            #
619            # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
620          "A String",
621        ],
622      },
623    ],
624    "kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules.
625    "sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. Only IPv4 is supported.
626      "A String",
627    ],
628    "priority": 42, # Priority for this rule. This is an integer between 0 and 65535, both inclusive. When not specified, the value assumed is 1000. Relative priorities determine precedence of conflicting rules. Lower value of priority implies higher precedence (eg, a rule with priority 0 has higher precedence than a rule with priority 1). DENY rules take precedence over ALLOW rules having equal priority.
629    "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:
630        # global/networks/default
631        # 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:
632        # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
633        # - projects/myproject/global/networks/my-network
634        # - global/networks/default
635    "targetServiceAccounts": [ # A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.
636      "A String",
637    ],
638    "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.
639      "A String",
640    ],
641    "denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
642      {
643        "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
644        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
645            #
646            # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
647          "A String",
648        ],
649      },
650    ],
651    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
652    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
653    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
654    "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.
655  }
656
657  requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
658
659Returns:
660  An object of the form:
661
662    { # An Operation resource, used to manage asynchronous API requests.
663    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
664    "clientOperationId": "A String", # [Output Only] Reserved for future use.
665    "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
666    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
667    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
668    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
669    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
670    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
671    "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.
672    "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.
673    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
674    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
675    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
676    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
677      {
678        "message": "A String", # [Output Only] A human-readable description of the warning code.
679        "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.
680        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
681            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
682          {
683            "value": "A String", # [Output Only] A warning data value corresponding to the key.
684            "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).
685          },
686        ],
687      },
688    ],
689    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
690    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
691    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
692    "name": "A String", # [Output Only] Name of the resource.
693    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
694    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
695      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
696        {
697          "message": "A String", # [Output Only] An optional, human-readable error message.
698          "code": "A String", # [Output Only] The error type identifier for this error.
699          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
700        },
701      ],
702    },
703    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
704    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
705    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
706  }</pre>
707</div>
708
709</body></html>