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

2014-04-24 15:46:26 -0400

[diff] [blame]

95

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

96

<code><a href="#update">update(project, firewall, body=None, requestId=None)</a></code></p>

97

<p class="firstline">Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead.</p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

98

<h3>Method Details</h3>

99

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

100

<code class="details" id="delete">delete(project, firewall, requestId=None)</code>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

101

<pre>Deletes the specified firewall.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

102

103

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

104

project: string, Project ID for this request. (required)

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

105

firewall: string, Name of the firewall rule to delete. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

106

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

107

108

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

109

110

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

111

112

Returns:

113

An object of the form:

114

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

115

{ # Represents an Operation resource.

116

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

117

# Google Compute Engine has three Operation resources:

118

#

119

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

120

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

121

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

122

#

123

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

124

# - For global operations, use the `globalOperations` resource.

125

# - For regional operations, use the `regionOperations` resource.

126

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

127

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

128

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

129

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

130

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

131

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

132

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

133

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

134

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

135

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

136

"code": "A String", # [Output Only] The error type identifier for this error.

137

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

138

"message": "A String", # [Output Only] An optional, human-readable error message.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

139

},

140

],

141

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

142

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

143

"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.

144

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

145

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

146

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

147

"name": "A String", # [Output Only] Name of the operation.

148

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

149

"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.

150

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

151

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

152

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

153

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

154

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

155

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

156

"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.

157

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

158

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

159

{

160

"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.

161

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

162

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

163

{

164

"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).

165

"value": "A String", # [Output Only] A warning data value corresponding to the key.

166

},

167

],

168

"message": "A String", # [Output Only] A human-readable description of the warning code.

169

},

170

],

171

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(project, firewall)</code>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

177

<pre>Returns the specified firewall.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

178

179

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

180

project: string, Project ID for this request. (required)

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

181

firewall: string, Name of the firewall rule to return. (required)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

182

183

Returns:

184

An object of the form:

185

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

186

{ # Represents a Firewall Rule resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

187

#

188

# Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.

189

"allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

190

{

191

"IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.

192

"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.

193

#

194

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

195

"A String",

196

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

197

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

198

],

199

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

200

"denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

201

{

202

"IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.

203

"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.

204

#

205

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

"A String",

],

},

],

"description": "A String", # An optional description of this resource. Provide this field when you create the resource.

211

"destinationRanges": [ # If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported.

212

"A String",

213

],

214

"direction": "A String", # Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `INGRESS` traffic, you cannot specify the destinationRanges field, and for `EGRESS` traffic, you cannot specify the sourceRanges or sourceTags fields.

215

"disabled": True or False, # Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.

216

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

217

"kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules.

218

"logConfig": { # The available logging options for a firewall rule. # This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver.

219

"enable": True or False, # This field denotes whether to enable logging for a particular firewall rule.

220

},

221

"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

222

"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:

223

# global/networks/default

224

# If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

225

# - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network

226

# - projects/myproject/global/networks/my-network

227

# - global/networks/default

228

"priority": 42, # Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`.

229

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

230

"sourceRanges": [ # If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Only IPv4 is supported.

231

"A String",

232

],

233

"sourceServiceAccounts": [ # If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.

234

"A String",

235

],

236

"sourceTags": [ # If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.

237

"A String",

238

],

239

"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.

240

"A String",

241

],

242

"targetTags": [ # A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.

243

"A String",

244

],

245

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

249

<code class="details" id="insert">insert(project, body=None, requestId=None)</code>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

250

<pre>Creates a firewall rule in the specified project using the data included in the request.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

251

252

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

253

project: string, Project ID for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

254

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

255

The object takes the form of:

256

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

257

{ # Represents a Firewall Rule resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

258

#

259

# Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.

260

"allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

261

{

262

"IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.

263

"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.

264

#

265

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

266

"A String",

267

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

268

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

269

],

270

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

271

"denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

272

{

273

"IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.

274

"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.

275

#

276

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

"A String",

],

},

],

"description": "A String", # An optional description of this resource. Provide this field when you create the resource.

282

"destinationRanges": [ # If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported.

283

"A String",

284

],

285

"direction": "A String", # Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `INGRESS` traffic, you cannot specify the destinationRanges field, and for `EGRESS` traffic, you cannot specify the sourceRanges or sourceTags fields.

286

"disabled": True or False, # Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.

287

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

288

"kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules.

289

"logConfig": { # The available logging options for a firewall rule. # This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver.

290

"enable": True or False, # This field denotes whether to enable logging for a particular firewall rule.

291

},

292

"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

293

"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:

294

# global/networks/default

295

# If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

296

# - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network

297

# - projects/myproject/global/networks/my-network

298

# - global/networks/default

299

"priority": 42, # Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`.

300

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

301

"sourceRanges": [ # If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Only IPv4 is supported.

302

"A String",

303

],

304

"sourceServiceAccounts": [ # If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.

305

"A String",

306

],

307

"sourceTags": [ # If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.

308

"A String",

309

],

310

"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.

311

"A String",

312

],

313

"targetTags": [ # A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.

314

"A String",

315

],

316

}

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

317

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

318

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

319

320

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

321

322

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

323

324

Returns:

325

An object of the form:

326

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

327

{ # Represents an Operation resource.

328

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

329

# Google Compute Engine has three Operation resources:

330

#

331

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

332

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

333

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

334

#

335

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

336

# - For global operations, use the `globalOperations` resource.

337

# - For regional operations, use the `regionOperations` resource.

338

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

339

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

340

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

341

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

342

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

343

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

344

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

345

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

346

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

347

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

348

"code": "A String", # [Output Only] The error type identifier for this error.

349

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

350

"message": "A String", # [Output Only] An optional, human-readable error message.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

351

},

352

],

353

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

354

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

355

"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.

356

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

357

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

358

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

359

"name": "A String", # [Output Only] Name of the operation.

360

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

361

"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.

362

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

363

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

364

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

365

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

366

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

367

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

368

"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.

369

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

370

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

371

{

372

"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.

373

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

374

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

375

{

376

"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).

377

"value": "A String", # [Output Only] A warning data value corresponding to the key.

378

},

379

],

380

"message": "A String", # [Output Only] A human-readable description of the warning code.

381

},

382

],

383

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

388

<code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None)</code>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

389

<pre>Retrieves the list of firewall rules available to the specified project.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

390

391

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

392

project: string, Project ID for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

393

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

Takashi Matsuo

0669410

2015-09-11 13:55:40 -0700

[diff] [blame]

394

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

395

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Takashi Matsuo

0669410

2015-09-11 13:55:40 -0700

[diff] [blame]

396

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

397

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

398

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

399

To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

400

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`)

401

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

402

403

You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

404

405

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

406

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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

407

408

Returns:

409

An object of the form:

410

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

411

{ # Contains a list of firewalls.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

412

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

413

"items": [ # A list of Firewall resources.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

414

{ # Represents a Firewall Rule resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

415

#

416

# Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.

417

"allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

418

{

419

"IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.

420

"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.

421

#

422

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

423

"A String",

424

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

425

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

426

],

427

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

428

"denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

429

{

430

"IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.

431

"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.

432

#

433

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

"A String",

],

},

],

"description": "A String", # An optional description of this resource. Provide this field when you create the resource.

439

"destinationRanges": [ # If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported.

440

"A String",

441

],

442

"direction": "A String", # Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `INGRESS` traffic, you cannot specify the destinationRanges field, and for `EGRESS` traffic, you cannot specify the sourceRanges or sourceTags fields.

443

"disabled": True or False, # Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.

444

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

445

"kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules.

446

"logConfig": { # The available logging options for a firewall rule. # This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver.

447

"enable": True or False, # This field denotes whether to enable logging for a particular firewall rule.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

448

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

449

"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

450

"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:

451

# global/networks/default

452

# If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

453

# - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network

454

# - projects/myproject/global/networks/my-network

455

# - global/networks/default

456

"priority": 42, # Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`.

457

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

458

"sourceRanges": [ # If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Only IPv4 is supported.

459

"A String",

460

],

461

"sourceServiceAccounts": [ # If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.

462

"A String",

463

],

464

"sourceTags": [ # If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.

465

"A String",

466

],

467

"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.

468

"A String",

469

],

470

"targetTags": [ # A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.

471

"A String",

472

],

473

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

474

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

475

"kind": "compute#firewallList", # [Output Only] Type of resource. Always compute#firewallList for lists of firewalls.

476

"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.

477

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

478

"warning": { # [Output Only] Informational warning message.

479

"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.

480

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

481

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

482

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

483

"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).

484

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

485

},

486

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

487

"message": "A String", # [Output Only] A human-readable description of the warning code.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

488

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

494

<pre>Retrieves the next page of results.

495

496

Args:

497

previous_request: The request for the previous page. (required)

498

previous_response: The response from the request for the previous page. (required)

499

500

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

501

A request object that you can call 'execute()' on to request the next

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

502

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

507

<code class="details" id="patch">patch(project, firewall, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

508

<pre>Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

509

510

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

511

project: string, Project ID for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

512

firewall: string, Name of the firewall rule to patch. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

513

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

514

The object takes the form of:

515

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

516

{ # Represents a Firewall Rule resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

517

#

518

# Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.

519

"allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

520

{

521

"IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.

522

"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.

523

#

524

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

525

"A String",

526

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

527

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

528

],

529

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

530

"denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

531

{

532

"IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.

533

"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.

534

#

535

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

"A String",

],

},

],

"description": "A String", # An optional description of this resource. Provide this field when you create the resource.

541

"destinationRanges": [ # If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported.

542

"A String",

543

],

544

"direction": "A String", # Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `INGRESS` traffic, you cannot specify the destinationRanges field, and for `EGRESS` traffic, you cannot specify the sourceRanges or sourceTags fields.

545

"disabled": True or False, # Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.

546

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

547

"kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules.

548

"logConfig": { # The available logging options for a firewall rule. # This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver.

549

"enable": True or False, # This field denotes whether to enable logging for a particular firewall rule.

550

},

551

"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

552

"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:

553

# global/networks/default

554

# If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

555

# - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network

556

# - projects/myproject/global/networks/my-network

557

# - global/networks/default

558

"priority": 42, # Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`.

559

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

560

"sourceRanges": [ # If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Only IPv4 is supported.

561

"A String",

562

],

563

"sourceServiceAccounts": [ # If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.

564

"A String",

565

],

566

"sourceTags": [ # If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.

567

"A String",

568

],

569

"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.

570

"A String",

571

],

572

"targetTags": [ # A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.

573

"A String",

574

],

575

}

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

576

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

577

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

578

579

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

580

581

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

582

583

Returns:

584

An object of the form:

585

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

586

{ # Represents an Operation resource.

587

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

588

# Google Compute Engine has three Operation resources:

589

#

590

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

591

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

592

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

593

#

594

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

595

# - For global operations, use the `globalOperations` resource.

596

# - For regional operations, use the `regionOperations` resource.

597

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

598

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

599

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

600

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

601

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

602

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

603

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

604

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

605

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

606

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

607

"code": "A String", # [Output Only] The error type identifier for this error.

608

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

609

"message": "A String", # [Output Only] An optional, human-readable error message.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

610

},

611

],

612

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

613

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

614

"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.

615

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

616

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

617

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

618

"name": "A String", # [Output Only] Name of the operation.

619

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

620

"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.

621

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

622

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

623

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

624

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

625

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

626

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

627

"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.

628

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

629

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

630

{

631

"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.

632

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

633

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

634

{

635

"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).

636

"value": "A String", # [Output Only] A warning data value corresponding to the key.

637

},

638

],

639

"message": "A String", # [Output Only] A human-readable description of the warning code.

640

},

641

],

642

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

647

<code class="details" id="update">update(project, firewall, body=None, requestId=None)</code>

648

<pre>Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

649

650

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

651

project: string, Project ID for this request. (required)

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

652

firewall: string, Name of the firewall rule to update. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

653

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

654

The object takes the form of:

655

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

656

{ # Represents a Firewall Rule resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

657

#

658

# Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.

659

"allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

660

{

661

"IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.

662

"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.

663

#

664

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

665

"A String",

666

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

667

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

668

],

669

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

670

"denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

671

{

672

"IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.

673

"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.

674

#

675

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

"A String",

],

},

],

"description": "A String", # An optional description of this resource. Provide this field when you create the resource.

681

"destinationRanges": [ # If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported.

682

"A String",

683

],

684

"direction": "A String", # Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `INGRESS` traffic, you cannot specify the destinationRanges field, and for `EGRESS` traffic, you cannot specify the sourceRanges or sourceTags fields.

685

"disabled": True or False, # Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.

686

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

687

"kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules.

688

"logConfig": { # The available logging options for a firewall rule. # This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver.

689

"enable": True or False, # This field denotes whether to enable logging for a particular firewall rule.

690

},

691

"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

692

"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:

693

# global/networks/default

694

# If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

695

# - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network

696

# - projects/myproject/global/networks/my-network

697

# - global/networks/default

698

"priority": 42, # Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`.

699

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

700

"sourceRanges": [ # If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Only IPv4 is supported.

701

"A String",

702

],

703

"sourceServiceAccounts": [ # If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.

704

"A String",

705

],

706

"sourceTags": [ # If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.

707

"A String",

708

],

709

"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.

710

"A String",

711

],

712

"targetTags": [ # A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.

713

"A String",

714

],

715

}

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

716

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

717

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

718

719

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

720

721

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

722

723

Returns:

724

An object of the form:

725

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

726

{ # Represents an Operation resource.

727

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

728

# Google Compute Engine has three Operation resources:

729

#

730

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

731

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

732

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

733

#

734

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

735

# - For global operations, use the `globalOperations` resource.

736

# - For regional operations, use the `regionOperations` resource.

737

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

738

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

739

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

740

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

741

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

742

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

743

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

744

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

745

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

746

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

747

"code": "A String", # [Output Only] The error type identifier for this error.

748

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

749

"message": "A String", # [Output Only] An optional, human-readable error message.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

750

},

751

],

752

},

Bu Sun Kim