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

2016-10-21 13:59:49 -0700

[diff] [blame]

98

Dan O'Meara

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

[diff] [blame]

99

<code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None)</a></code></p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

100

<p class="firstline">Returns permissions that a caller has on the specified resource.</p>

101

Dan O'Meara

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

[diff] [blame]

102

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

103

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

104

<h3>Method Details</h3>

105

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

106

<code class="details" id="close">close()</code>

107

<pre>Close httplib2 connections.</pre>

</div>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

111

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

112

<pre>Deletes the specified firewall.

113

114

Args:

115

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

116

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

Bu Sun Kim

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

[diff] [blame]

117

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.

118

119

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.

120

121

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

122

123

Returns:

124

An object of the form:

125

Bu Sun Kim

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

[diff] [blame]

126

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

127

#

128

# Google Compute Engine has three Operation resources:

129

#

130

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

131

#

132

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

133

#

134

# Operations can be global, regional or zonal.

135

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

136

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

137

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

138

#

139

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

140

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

141

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

142

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

143

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

144

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

145

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

Bu Sun Kim

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

[diff] [blame]

146

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

147

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

148

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

149

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

Bu Sun Kim

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

[diff] [blame]

150

},

151

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

152

},

153

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

154

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

155

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

156

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

157

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

158

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

159

#

160

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

161

#

162

# Example 1: Pack and unpack a message in C++.

163

#

164

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

165

#

166

# Example 2: Pack and unpack a message in Java.

167

#

168

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

169

#

170

# Example 3: Pack and unpack a message in Python.

171

#

172

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

173

#

174

# Example 4: Pack and unpack a message in Go

175

#

176

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

177

#

178

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

183

#

184

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

185

#

186

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

187

#

188

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

189

#

190

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

191

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

192

#

193

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

194

#

195

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

196

#

197

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

198

#

199

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

200

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

201

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

202

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

203

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

204

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

205

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

206

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

207

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

208

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

209

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

210

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

211

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

212

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

213

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

214

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

215

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

216

{

217

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

218

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

219

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

220

{

221

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

222

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

223

},

224

],

225

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

226

},

227

],

228

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

229

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

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

234

<pre>Returns the specified firewall.

235

236

Args:

237

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

238

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

239

240

Returns:

241

An object of the form:

242

Bu Sun Kim

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

[diff] [blame]

243

{ # Represents a Firewall Rule resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

244

#

245

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

246

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

247

{

248

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

249

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

250

#

251

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

252

"A String",

253

],

Bu Sun Kim

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

[diff] [blame]

254

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

255

],

256

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

257

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

258

{

259

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

260

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

261

#

262

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

268

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

269

"A String",

270

],

271

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

272

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

273

"enableLogging": True or False, # Deprecated in favor of enable in LogConfig. This field denotes whether to enable logging for a particular firewall rule. If logging is enabled, logs will be exported t Cloud Logging.

274

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

275

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

276

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

277

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

278

"metadata": "A String", # This field can only be specified for a particular firewall rule if logging is enabled for that rule. This field denotes whether to include or exclude metadata for firewall logs.

279

},

280

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

281

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

282

# global/networks/default

283

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

284

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

285

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

286

# - global/networks/default

287

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

288

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

289

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

290

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

291

"A String",

292

],

293

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

294

"A String",

295

],

296

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

297

"A String",

298

],

299

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

300

"A String",

301

],

302

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

303

"A String",

304

],

305

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

309

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

310

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

311

312

Args:

313

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

Dan O'Meara

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

[diff] [blame]

314

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

315

The object takes the form of:

316

Bu Sun Kim

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

[diff] [blame]

317

{ # Represents a Firewall Rule resource.

Bu Sun Kim

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

[diff] [blame]

318

#

319

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

320

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

321

{

322

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

323

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

324

#

325

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

326

"A String",

327

],

Bu Sun Kim

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

[diff] [blame]

328

},

Bu Sun Kim

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

[diff] [blame]

329

],

330

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

331

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

332

{

333

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

334

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

335

#

336

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

342

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

343

"A String",

344

],

345

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

346

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

347

"enableLogging": True or False, # Deprecated in favor of enable in LogConfig. This field denotes whether to enable logging for a particular firewall rule. If logging is enabled, logs will be exported t Cloud Logging.

Bu Sun Kim

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

[diff] [blame]

348

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

349

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

350

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

Bu Sun Kim

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

[diff] [blame]

351

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

352

"metadata": "A String", # This field can only be specified for a particular firewall rule if logging is enabled for that rule. This field denotes whether to include or exclude metadata for firewall logs.

353

},

354

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

355

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

356

# global/networks/default

357

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

358

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

359

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

360

# - global/networks/default

361

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

362

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

363

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

364

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

365

"A String",

366

],

367

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

368

"A String",

369

],

370

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

371

"A String",

372

],

373

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

374

"A String",

375

],

376

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

377

"A String",

378

],

379

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

380

Bu Sun Kim

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

[diff] [blame]

381

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.

382

383

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.

384

385

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

386

387

Returns:

388

An object of the form:

389

Bu Sun Kim

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

[diff] [blame]

390

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

391

#

392

# Google Compute Engine has three Operation resources:

393

#

394

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

395

#

396

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

397

#

398

# Operations can be global, regional or zonal.

399

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

400

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

401

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

402

#

403

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

404

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

405

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

406

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

407

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

408

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

409

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

Bu Sun Kim

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

[diff] [blame]

410

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

411

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

412

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

413

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

Bu Sun Kim

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

[diff] [blame]

414

},

415

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

416

},

417

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

418

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

419

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

420

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

421

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

422

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

423

#

424

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

425

#

426

# Example 1: Pack and unpack a message in C++.

427

#

428

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

429

#

430

# Example 2: Pack and unpack a message in Java.

431

#

432

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

433

#

434

# Example 3: Pack and unpack a message in Python.

435

#

436

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

437

#

438

# Example 4: Pack and unpack a message in Go

439

#

440

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

441

#

442

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

447

#

448

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

449

#

450

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

451

#

452

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

453

#

454

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

455

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

456

#

457

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

458

#

459

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

460

#

461

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

462

#

463

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

464

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

465

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

466

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

467

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

468

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

469

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

470

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

471

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

472

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

473

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

474

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

475

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

476

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

477

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

478

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

479

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

480

{

481

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

482

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

483

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

484

{

485

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

486

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

487

},

488

],

489

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

490

},

491

],

492

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

493

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

497

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

498

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

499

500

Args:

501

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

Dan O'Meara

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

[diff] [blame]

502

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

503

Dan O'Meara

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

[diff] [blame]

504

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

505

Dan O'Meara

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

[diff] [blame]

506

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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

507

Bu Sun Kim

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

[diff] [blame]

508

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

509

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

510

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

511

512

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.

513

514

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

515

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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

516

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

517

518

Returns:

519

An object of the form:

520

521

{ # Contains a list of firewalls.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

522

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

523

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

524

{ # Represents a Firewall Rule resource.

525

#

526

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

527

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

Bu Sun Kim

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

[diff] [blame]

528

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

529

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

530

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

531

#

532

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

533

"A String",

534

],

Bu Sun Kim

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

[diff] [blame]

535

},

536

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

537

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

538

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

539

{

540

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

541

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

542

#

543

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

549

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

550

"A String",

551

],

552

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

553

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

554

"enableLogging": True or False, # Deprecated in favor of enable in LogConfig. This field denotes whether to enable logging for a particular firewall rule. If logging is enabled, logs will be exported t Cloud Logging.

555

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

556

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

557

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

558

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

559

"metadata": "A String", # This field can only be specified for a particular firewall rule if logging is enabled for that rule. This field denotes whether to include or exclude metadata for firewall logs.

560

},

561

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

562

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

563

# global/networks/default

564

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

565

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

566

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

567

# - global/networks/default

568

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

569

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

570

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

571

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

572

"A String",

573

],

574

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

575

"A String",

576

],

577

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

578

"A String",

579

],

580

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

581

"A String",

582

],

583

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

584

"A String",

585

],

Bu Sun Kim

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

[diff] [blame]

586

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

587

],

588

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

589

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

590

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

591

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

592

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

593

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

594

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

595

{

596

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

597

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

598

},

599

],

600

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

601

},

602

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

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

607

<pre>Retrieves the next page of results.

608

609

Args:

610

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

611

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

612

613

Returns:

Bu Sun Kim

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

[diff] [blame]

614

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

615

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]

620

<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]

621

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

622

623

Args:

624

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

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

625

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

Dan O'Meara

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

[diff] [blame]

626

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

627

The object takes the form of:

628

Bu Sun Kim

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

[diff] [blame]

629

{ # Represents a Firewall Rule resource.

Bu Sun Kim

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

[diff] [blame]

630

#

631

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

632

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

633

{

634

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

635

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

636

#

637

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

638

"A String",

639

],

Bu Sun Kim

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

[diff] [blame]

640

},

Bu Sun Kim

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

[diff] [blame]

641

],

642

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

643

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

644

{

645

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

646

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

647

#

648

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

654

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

655

"A String",

656

],

657

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

658

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

659

"enableLogging": True or False, # Deprecated in favor of enable in LogConfig. This field denotes whether to enable logging for a particular firewall rule. If logging is enabled, logs will be exported t Cloud Logging.

Bu Sun Kim

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

[diff] [blame]

660

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

661

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

662

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

Bu Sun Kim

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

[diff] [blame]

663

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

664

"metadata": "A String", # This field can only be specified for a particular firewall rule if logging is enabled for that rule. This field denotes whether to include or exclude metadata for firewall logs.

665

},

666

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

667

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

668

# global/networks/default

669

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

670

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

671

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

672

# - global/networks/default

673

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

674

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

675

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

676

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

677

"A String",

678

],

679

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

680

"A String",

681

],

682

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

683

"A String",

684

],

685

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

686

"A String",

687

],

688

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

689

"A String",

690

],

691

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

692

Bu Sun Kim

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

[diff] [blame]

693

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.

694

695

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.

696

697

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

698

699

Returns:

700

An object of the form:

701

Bu Sun Kim

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

[diff] [blame]

702

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

703

#

704

# Google Compute Engine has three Operation resources:

705

#

706

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

707

#

708

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

709

#

710

# Operations can be global, regional or zonal.

711

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

712

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

713

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

714

#

715

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

716

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

717

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

718

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

719

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

720

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

721

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

Bu Sun Kim

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

[diff] [blame]

722

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

723

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

724

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

725

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

Bu Sun Kim

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

[diff] [blame]

726

},

727

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

728

},

729

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

730

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

731

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

732

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

733

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

734

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

735

#

736

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

737

#

738

# Example 1: Pack and unpack a message in C++.

739

#

740

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

741

#

742

# Example 2: Pack and unpack a message in Java.

743

#

744

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

745

#

746

# Example 3: Pack and unpack a message in Python.

747

#

748

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

749

#

750

# Example 4: Pack and unpack a message in Go

751

#

752

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

753

#

754

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

759

#

760

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

761

#

762

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

763

#

764

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

765

#

766

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

767

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

768

#

769

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

770

#

771

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

772

#

773

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

774

#

775

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

776

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

777

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

778

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

779

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

780

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

781

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

782

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

783

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

784

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

785

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

786

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

787

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

788

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

789

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

790

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

791

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

792

{

793

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

794

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

795

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

796

{

797

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

798

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

799

},

800

],

801

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

802

},

803

],

804

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

805

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

809

<code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

810

<pre>Returns permissions that a caller has on the specified resource.

811

812

Args:

813

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

Bu Sun Kim

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

[diff] [blame]

814

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

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

[diff] [blame]

815

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

816

The object takes the form of:

817

818

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

819

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

820

"A String",

821

],

822

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

Returns:

An object of the form:

827

828

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

829

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

830

"A String",

831

],

832

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

836

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

837

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

838

839

Args:

840

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

841

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

Dan O'Meara

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

[diff] [blame]

842

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

843

The object takes the form of:

844

Bu Sun Kim

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

[diff] [blame]

845

{ # Represents a Firewall Rule resource.

Bu Sun Kim

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

[diff] [blame]

846

#

847

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

848

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

849

{

850

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

851

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

852

#

853

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

854

"A String",

855

],

Bu Sun Kim

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

[diff] [blame]

856

},

Bu Sun Kim

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

[diff] [blame]

857

],

858

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

859

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

860

{

861

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

862

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

863

#

864

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

870

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

871

"A String",

872

],

873

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

874

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

875

"enableLogging": True or False, # Deprecated in favor of enable in LogConfig. This field denotes whether to enable logging for a particular firewall rule. If logging is enabled, logs will be exported t Cloud Logging.

Bu Sun Kim

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

[diff] [blame]

876

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

877

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

878

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

Bu Sun Kim

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

[diff] [blame]

879

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

880

"metadata": "A String", # This field can only be specified for a particular firewall rule if logging is enabled for that rule. This field denotes whether to include or exclude metadata for firewall logs.

881

},

882

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

883

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

884

# global/networks/default

885

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

886

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

887

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

888

# - global/networks/default

889

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

890

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

891

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

892

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

893

"A String",

894

],

895

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

896

"A String",

897

],

898

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

899

"A String",

900

],

901

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

902

"A String",

903

],

904

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

905

"A String",

906

],

907

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

908

Bu Sun Kim

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

[diff] [blame]

909

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.

910

911

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.

912

913

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

914

915

Returns:

916

An object of the form:

917

Bu Sun Kim

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

[diff] [blame]

918

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

919

#

920

# Google Compute Engine has three Operation resources:

921

#

922

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

923

#

924

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

925

#

926

# Operations can be global, regional or zonal.

927

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

928

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

929

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

930

#

931

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

932

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

933

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

934

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

935

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

936

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

937

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

Bu Sun Kim

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

[diff] [blame]

938

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

939

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

940

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

941

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

Bu Sun Kim

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

[diff] [blame]

942

},

943

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

944

},

945

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

946

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

947

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

948

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

949

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

950

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

951

#

952

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

953

#

954

# Example 1: Pack and unpack a message in C++.

955

#

956

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

957

#

958

# Example 2: Pack and unpack a message in Java.

959

#

960

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

961

#

962

# Example 3: Pack and unpack a message in Python.

963

#

964

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

965

#

966

# Example 4: Pack and unpack a message in Go

967

#

968

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

969

#

970

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

975

#

976

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

977

#

978

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

979

#

980

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

981

#

982

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

983

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

984

#

985

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

986

#

987

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

988

#

989

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

990

#

991

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

992

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

993

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

994

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

995

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot