Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0669410c6b2c48884ae31671b9d710a9ff6346c6 / . / docs / dyn / compute_v1.firewalls.html
blob: 5cea5d4f73a4c1aeb6020f863638bae0eaf6963e [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
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]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 monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[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 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]171 # If both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]176 # If both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]185 "targetTags": [ # A list of instance tags indicating sets of instances located in the network that may make network connections as specified in allowed[]. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]198 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]199 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]200 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]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 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]219 # If both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]224 # If both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]233 "targetTags": [ # A list of instance tags indicating sets of instances located in the network that may make network connections as specified in allowed[]. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]246 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]247 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]248 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]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
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]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 monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[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)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]307 maxResults: integer, Maximum count of results to be returned.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]308 pageToken: string, Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.
309 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.
310
311The 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 (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.
312
313For example, filter=name ne example-instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]314
315Returns:
316 An object of the form:
317
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]318 { # Contains a list of Firewall resources.
319 "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
320 "items": [ # [Output Only] A list of Firewall resources.
321 { # A Firewall resource.
322 "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]323 "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]324 "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set.
325 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]326 # If both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]327 "A String",
328 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]329 "sourceRanges": [ # The IP address blocks that this rule applies to, expressed in CIDR format. One or both of sourceRanges and sourceTags may be set.
330 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]331 # If both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]332 "A String",
333 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]334 "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:
335 # global/networks/default
336 # 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:
337 # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
338 # - projects/myproject/global/networks/my-network
339 # - global/networks/default
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]340 "targetTags": [ # A list of instance tags indicating sets of instances located in the network that may make network connections as specified in allowed[]. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]341 "A String",
342 ],
343 "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
344 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]345 "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.
346 "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]347 #
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]348 # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]349 "A String",
350 ],
351 },
352 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]353 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]354 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]355 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]356 "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]357 },
358 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]359 "kind": "compute#firewallList", # [Output Only] Type of resource. Always compute#firewallList for lists of firewalls.
360 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]361 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]362 }</pre>
363</div>
364
365<div class="method">
366 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
367 <pre>Retrieves the next page of results.
368
369Args:
370 previous_request: The request for the previous page. (required)
371 previous_response: The response from the request for the previous page. (required)
372
373Returns:
374 A request object that you can call 'execute()' on to request the next
375 page. Returns None if there are no more items in the collection.
376 </pre>
377</div>
378
379<div class="method">
380 <code class="details" id="patch">patch(project, firewall, body)</code>
381 <pre>Updates the specified firewall resource with the data included in the request. This method supports patch semantics.
382
383Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]384 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]385 firewall: string, Name of the firewall resource to update. (required)
386 body: object, The request body. (required)
387 The object takes the form of:
388
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]389{ # A Firewall resource.
390 "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]391 "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]392 "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set.
393 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]394 # If both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]395 "A String",
396 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]397 "sourceRanges": [ # The IP address blocks that this rule applies to, expressed in CIDR format. One or both of sourceRanges and sourceTags may be set.
398 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]399 # If both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]400 "A String",
401 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]402 "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:
403 # global/networks/default
404 # 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:
405 # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
406 # - projects/myproject/global/networks/my-network
407 # - global/networks/default
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]408 "targetTags": [ # A list of instance tags indicating sets of instances located in the network that may make network connections as specified in allowed[]. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]409 "A String",
410 ],
411 "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
412 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]413 "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.
414 "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]415 #
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]416 # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]417 "A String",
418 ],
419 },
420 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]421 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]422 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]423 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]424 "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]425 }
426
427
428Returns:
429 An object of the form:
430
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]431 { # An Operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]432 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]433 "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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]434 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]435 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]436 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
437 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
438 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]439 "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 monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]440 "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]441 "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]442 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
443 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
444 "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]445 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]446 "message": "A String", # [Output Only] Optional human-readable details for this warning.
447 "code": "A String", # [Output Only] The warning type identifier for this warning.
448 "data": [ # [Output Only] Metadata for this warning in key: value format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]449 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]450 "value": "A String", # [Output Only] A warning data value corresponding to the key.
451 "key": "A String", # [Output Only] A key for the warning data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]452 },
453 ],
454 },
455 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]456 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
457 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
458 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
459 "name": "A String", # [Output Only] Name of the resource.
460 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
461 "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]462 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]463 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]464 "message": "A String", # [Output Only] An optional, human-readable error message.
465 "code": "A String", # [Output Only] The error type identifier for this error.
466 "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]467 },
468 ],
469 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]470 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]471 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]472 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]473 }</pre>
474</div>
475
476<div class="method">
477 <code class="details" id="update">update(project, firewall, body)</code>
478 <pre>Updates the specified firewall resource with the data included in the request.
479
480Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]481 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]482 firewall: string, Name of the firewall resource to update. (required)
483 body: object, The request body. (required)
484 The object takes the form of:
485
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]486{ # A Firewall resource.
487 "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]488 "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]489 "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set.
490 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]491 # If both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]492 "A String",
493 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]494 "sourceRanges": [ # The IP address blocks that this rule applies to, expressed in CIDR format. One or both of sourceRanges and sourceTags may be set.
495 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]496 # If both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]497 "A String",
498 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]499 "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:
500 # global/networks/default
501 # 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:
502 # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
503 # - projects/myproject/global/networks/my-network
504 # - global/networks/default
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]505 "targetTags": [ # A list of instance tags indicating sets of instances located in the network that may make network connections as specified in allowed[]. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]506 "A String",
507 ],
508 "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
509 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]510 "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.
511 "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]512 #
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]513 # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]514 "A String",
515 ],
516 },
517 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]518 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]519 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]520 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]521 "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]522 }
523
524
525Returns:
526 An object of the form:
527
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]528 { # An Operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]529 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]530 "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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]531 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]532 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]533 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
534 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
535 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]536 "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 monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]537 "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]538 "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]539 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
540 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
541 "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]542 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]543 "message": "A String", # [Output Only] Optional human-readable details for this warning.
544 "code": "A String", # [Output Only] The warning type identifier for this warning.
545 "data": [ # [Output Only] Metadata for this warning in key: value format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]546 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]547 "value": "A String", # [Output Only] A warning data value corresponding to the key.
548 "key": "A String", # [Output Only] A key for the warning data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]549 },
550 ],
551 },
552 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]553 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
554 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
555 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
556 "name": "A String", # [Output Only] Name of the resource.
557 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
558 "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]559 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]560 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]561 "message": "A String", # [Output Only] An optional, human-readable error message.
562 "code": "A String", # [Output Only] The error type identifier for this error.
563 "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]564 },
565 ],
566 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]567 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]568 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]569 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]570 }</pre>
571</div>
572
573</body></html>