1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.regionNetworkFirewallPolicies.html">regionNetworkFirewallPolicies</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#addAssociation">addAssociation(project, region, firewallPolicy, body=None, replaceExistingAssociation=None, requestId=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Inserts an association for the specified network firewall policy.</p> 80<p class="toc_element"> 81 <code><a href="#addRule">addRule(project, region, firewallPolicy, body=None, maxPriority=None, minPriority=None, requestId=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Inserts a rule into a network firewall policy.</p> 83<p class="toc_element"> 84 <code><a href="#cloneRules">cloneRules(project, region, firewallPolicy, requestId=None, sourceFirewallPolicy=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Copies rules to the specified network firewall policy.</p> 86<p class="toc_element"> 87 <code><a href="#close">close()</a></code></p> 88<p class="firstline">Close httplib2 connections.</p> 89<p class="toc_element"> 90 <code><a href="#delete">delete(project, region, firewallPolicy, requestId=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Deletes the specified network firewall policy.</p> 92<p class="toc_element"> 93 <code><a href="#get">get(project, region, firewallPolicy, x__xgafv=None)</a></code></p> 94<p class="firstline">Returns the specified network firewall policy.</p> 95<p class="toc_element"> 96 <code><a href="#getAssociation">getAssociation(project, region, firewallPolicy, name=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Gets an association with the specified name.</p> 98<p class="toc_element"> 99 <code><a href="#getEffectiveFirewalls">getEffectiveFirewalls(project, region, network, x__xgafv=None)</a></code></p> 100<p class="firstline">Returns the effective firewalls on a given network.</p> 101<p class="toc_element"> 102 <code><a href="#getIamPolicy">getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p> 104<p class="toc_element"> 105 <code><a href="#getRule">getRule(project, region, firewallPolicy, priority=None, x__xgafv=None)</a></code></p> 106<p class="firstline">Gets a rule of the specified priority.</p> 107<p class="toc_element"> 108 <code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p> 109<p class="firstline">Creates a new network firewall policy in the specified project and region.</p> 110<p class="toc_element"> 111 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 112<p class="firstline">Lists all the network firewall policies that have been configured for the specified project in the given region.</p> 113<p class="toc_element"> 114 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 115<p class="firstline">Retrieves the next page of results.</p> 116<p class="toc_element"> 117 <code><a href="#patch">patch(project, region, firewallPolicy, body=None, requestId=None, x__xgafv=None)</a></code></p> 118<p class="firstline">Patches the specified network firewall policy.</p> 119<p class="toc_element"> 120 <code><a href="#patchRule">patchRule(project, region, firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None)</a></code></p> 121<p class="firstline">Patches a rule of the specified priority.</p> 122<p class="toc_element"> 123 <code><a href="#removeAssociation">removeAssociation(project, region, firewallPolicy, name=None, requestId=None, x__xgafv=None)</a></code></p> 124<p class="firstline">Removes an association for the specified network firewall policy.</p> 125<p class="toc_element"> 126 <code><a href="#removeRule">removeRule(project, region, firewallPolicy, priority=None, requestId=None, x__xgafv=None)</a></code></p> 127<p class="firstline">Deletes a rule of the specified priority.</p> 128<p class="toc_element"> 129 <code><a href="#setIamPolicy">setIamPolicy(project, region, resource, body=None, x__xgafv=None)</a></code></p> 130<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p> 131<p class="toc_element"> 132 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</a></code></p> 133<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 134<h3>Method Details</h3> 135<div class="method"> 136 <code class="details" id="addAssociation">addAssociation(project, region, firewallPolicy, body=None, replaceExistingAssociation=None, requestId=None, x__xgafv=None)</code> 137 <pre>Inserts an association for the specified network firewall policy. 138 139Args: 140 project: string, Project ID for this request. (required) 141 region: string, Name of the region scoping this request. (required) 142 firewallPolicy: string, Name of the firewall policy to update. (required) 143 body: object, The request body. 144 The object takes the form of: 145 146{ 147 "attachmentTarget": "A String", # The target that the firewall policy is attached to. 148 "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association. 149 "firewallPolicyId": "A String", # [Output Only] The firewall policy ID of the association. 150 "name": "A String", # The name for an association. 151 "shortName": "A String", # [Output Only] The short name of the firewall policy of the association. 152} 153 154 replaceExistingAssociation: boolean, Indicates whether or not to replace it if an association already exists. This is false by default, in which case an error will be returned if an association already exists. 155 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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 156 x__xgafv: string, V1 error format. 157 Allowed values 158 1 - v1 error format 159 2 - v2 error format 160 161Returns: 162 An object of the form: 163 164 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 165 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 166 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 167 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 168 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 169 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 170 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 171 { 172 "code": "A String", # [Output Only] The error type identifier for this error. 173 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 174 "message": "A String", # [Output Only] An optional, human-readable error message. 175 }, 176 ], 177 }, 178 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 179 "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. 180 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 181 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 182 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 183 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 184 "a_key": "", # Properties of the object. Contains field @type with type URL. 185 }, 186 "name": "A String", # [Output Only] Name of the operation. 187 "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. 188 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 189 "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. 190 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 191 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 192 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 193 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 194 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 195 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 196 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 197 "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. 198 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 199 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 200 { 201 "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. 202 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 203 { 204 "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). 205 "value": "A String", # [Output Only] A warning data value corresponding to the key. 206 }, 207 ], 208 "message": "A String", # [Output Only] A human-readable description of the warning code. 209 }, 210 ], 211 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 212}</pre> 213</div> 214 215<div class="method"> 216 <code class="details" id="addRule">addRule(project, region, firewallPolicy, body=None, maxPriority=None, minPriority=None, requestId=None, x__xgafv=None)</code> 217 <pre>Inserts a rule into a network firewall policy. 218 219Args: 220 project: string, Project ID for this request. (required) 221 region: string, Name of the region scoping this request. (required) 222 firewallPolicy: string, Name of the firewall policy to update. (required) 223 body: object, The request body. 224 The object takes the form of: 225 226{ # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). 227 "action": "A String", # The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502. 228 "description": "A String", # An optional description for this resource. 229 "direction": "A String", # The direction in which this rule applies. 230 "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. 231 "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. 232 "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules 233 "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. 234 "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. 235 "A String", 236 ], 237 "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 1000. 238 "A String", 239 ], 240 "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. 241 "A String", 242 ], 243 "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. 244 "A String", 245 ], 246 "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. 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 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. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. 250 "A String", 251 ], 252 }, 253 ], 254 "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. 255 "A String", 256 ], 257 "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 1000. 258 "A String", 259 ], 260 "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. 261 "A String", 262 ], 263 "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. 264 "A String", 265 ], 266 "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. 267 { 268 "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. 269 "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. 270 }, 271 ], 272 }, 273 "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. 274 "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. 275 "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. 276 "A String", 277 ], 278 "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. 279 { 280 "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. 281 "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. 282 }, 283 ], 284 "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. 285 "A String", 286 ], 287} 288 289 maxPriority: integer, When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority. 290 minPriority: integer, When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority. 291 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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 292 x__xgafv: string, V1 error format. 293 Allowed values 294 1 - v1 error format 295 2 - v2 error format 296 297Returns: 298 An object of the form: 299 300 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 301 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 302 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 303 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 304 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 305 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 306 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 307 { 308 "code": "A String", # [Output Only] The error type identifier for this error. 309 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 310 "message": "A String", # [Output Only] An optional, human-readable error message. 311 }, 312 ], 313 }, 314 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 315 "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. 316 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 317 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 318 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 319 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 320 "a_key": "", # Properties of the object. Contains field @type with type URL. 321 }, 322 "name": "A String", # [Output Only] Name of the operation. 323 "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. 324 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 325 "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. 326 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 327 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 328 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 329 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 330 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 331 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 332 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 333 "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. 334 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 335 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 336 { 337 "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. 338 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 339 { 340 "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). 341 "value": "A String", # [Output Only] A warning data value corresponding to the key. 342 }, 343 ], 344 "message": "A String", # [Output Only] A human-readable description of the warning code. 345 }, 346 ], 347 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 348}</pre> 349</div> 350 351<div class="method"> 352 <code class="details" id="cloneRules">cloneRules(project, region, firewallPolicy, requestId=None, sourceFirewallPolicy=None, x__xgafv=None)</code> 353 <pre>Copies rules to the specified network firewall policy. 354 355Args: 356 project: string, Project ID for this request. (required) 357 region: string, Name of the region scoping this request. (required) 358 firewallPolicy: string, Name of the firewall policy to update. (required) 359 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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 360 sourceFirewallPolicy: string, The firewall policy from which to copy rules. 361 x__xgafv: string, V1 error format. 362 Allowed values 363 1 - v1 error format 364 2 - v2 error format 365 366Returns: 367 An object of the form: 368 369 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 370 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 371 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 372 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 373 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 374 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 375 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 376 { 377 "code": "A String", # [Output Only] The error type identifier for this error. 378 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 379 "message": "A String", # [Output Only] An optional, human-readable error message. 380 }, 381 ], 382 }, 383 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 384 "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. 385 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 386 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 387 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 388 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 389 "a_key": "", # Properties of the object. Contains field @type with type URL. 390 }, 391 "name": "A String", # [Output Only] Name of the operation. 392 "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. 393 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 394 "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. 395 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 396 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 397 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 398 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 399 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 400 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 401 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 402 "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. 403 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 404 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 405 { 406 "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. 407 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 408 { 409 "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). 410 "value": "A String", # [Output Only] A warning data value corresponding to the key. 411 }, 412 ], 413 "message": "A String", # [Output Only] A human-readable description of the warning code. 414 }, 415 ], 416 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 417}</pre> 418</div> 419 420<div class="method"> 421 <code class="details" id="close">close()</code> 422 <pre>Close httplib2 connections.</pre> 423</div> 424 425<div class="method"> 426 <code class="details" id="delete">delete(project, region, firewallPolicy, requestId=None, x__xgafv=None)</code> 427 <pre>Deletes the specified network firewall policy. 428 429Args: 430 project: string, Project ID for this request. (required) 431 region: string, Name of the region scoping this request. (required) 432 firewallPolicy: string, Name of the firewall policy to delete. (required) 433 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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 434 x__xgafv: string, V1 error format. 435 Allowed values 436 1 - v1 error format 437 2 - v2 error format 438 439Returns: 440 An object of the form: 441 442 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 443 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 444 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 445 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 446 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 447 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 448 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 449 { 450 "code": "A String", # [Output Only] The error type identifier for this error. 451 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 452 "message": "A String", # [Output Only] An optional, human-readable error message. 453 }, 454 ], 455 }, 456 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 457 "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. 458 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 459 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 460 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 461 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 462 "a_key": "", # Properties of the object. Contains field @type with type URL. 463 }, 464 "name": "A String", # [Output Only] Name of the operation. 465 "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. 466 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 467 "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. 468 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 469 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 470 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 471 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 472 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 473 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 474 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 475 "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. 476 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 477 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 478 { 479 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 480 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 481 { 482 "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). 483 "value": "A String", # [Output Only] A warning data value corresponding to the key. 484 }, 485 ], 486 "message": "A String", # [Output Only] A human-readable description of the warning code. 487 }, 488 ], 489 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 490}</pre> 491</div> 492 493<div class="method"> 494 <code class="details" id="get">get(project, region, firewallPolicy, x__xgafv=None)</code> 495 <pre>Returns the specified network firewall policy. 496 497Args: 498 project: string, Project ID for this request. (required) 499 region: string, Name of the region scoping this request. (required) 500 firewallPolicy: string, Name of the firewall policy to get. (required) 501 x__xgafv: string, V1 error format. 502 Allowed values 503 1 - v1 error format 504 2 - v2 error format 505 506Returns: 507 An object of the form: 508 509 { # Represents a Firewall Policy resource. 510 "associations": [ # A list of associations that belong to this firewall policy. 511 { 512 "attachmentTarget": "A String", # The target that the firewall policy is attached to. 513 "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association. 514 "firewallPolicyId": "A String", # [Output Only] The firewall policy ID of the association. 515 "name": "A String", # The name for an association. 516 "shortName": "A String", # [Output Only] The short name of the firewall policy of the association. 517 }, 518 ], 519 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 520 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 521 "displayName": "A String", # Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 522 "fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy. 523 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 524 "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies 525 "name": "A String", # [Output Only] Name of the resource. It is a numeric ID allocated by GCP which uniquely identifies the Firewall Policy. 526 "parent": "A String", # [Output Only] The parent of the firewall policy. 527 "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 528 "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. 529 "rules": [ # A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added. 530 { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). 531 "action": "A String", # The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502. 532 "description": "A String", # An optional description for this resource. 533 "direction": "A String", # The direction in which this rule applies. 534 "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. 535 "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. 536 "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules 537 "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. 538 "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. 539 "A String", 540 ], 541 "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 1000. 542 "A String", 543 ], 544 "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. 545 "A String", 546 ], 547 "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. 548 "A String", 549 ], 550 "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. 551 { 552 "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. 553 "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. 554 "A String", 555 ], 556 }, 557 ], 558 "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. 559 "A String", 560 ], 561 "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 1000. 562 "A String", 563 ], 564 "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. 565 "A String", 566 ], 567 "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. 568 "A String", 569 ], 570 "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. 571 { 572 "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. 573 "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. 574 }, 575 ], 576 }, 577 "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. 578 "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. 579 "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. 580 "A String", 581 ], 582 "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. 583 { 584 "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. 585 "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. 586 }, 587 ], 588 "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. 589 "A String", 590 ], 591 }, 592 ], 593 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 594 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 595 "shortName": "A String", # User-provided name of the Organization firewall plicy. The name should be unique in the organization in which the firewall policy is created. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 596}</pre> 597</div> 598 599<div class="method"> 600 <code class="details" id="getAssociation">getAssociation(project, region, firewallPolicy, name=None, x__xgafv=None)</code> 601 <pre>Gets an association with the specified name. 602 603Args: 604 project: string, Project ID for this request. (required) 605 region: string, Name of the region scoping this request. (required) 606 firewallPolicy: string, Name of the firewall policy to which the queried association belongs. (required) 607 name: string, The name of the association to get from the firewall policy. 608 x__xgafv: string, V1 error format. 609 Allowed values 610 1 - v1 error format 611 2 - v2 error format 612 613Returns: 614 An object of the form: 615 616 { 617 "attachmentTarget": "A String", # The target that the firewall policy is attached to. 618 "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association. 619 "firewallPolicyId": "A String", # [Output Only] The firewall policy ID of the association. 620 "name": "A String", # The name for an association. 621 "shortName": "A String", # [Output Only] The short name of the firewall policy of the association. 622}</pre> 623</div> 624 625<div class="method"> 626 <code class="details" id="getEffectiveFirewalls">getEffectiveFirewalls(project, region, network, x__xgafv=None)</code> 627 <pre>Returns the effective firewalls on a given network. 628 629Args: 630 project: string, Project ID for this request. (required) 631 region: string, Name of the region scoping this request. (required) 632 network: string, Network reference (required) 633 x__xgafv: string, V1 error format. 634 Allowed values 635 1 - v1 error format 636 2 - v2 error format 637 638Returns: 639 An object of the form: 640 641 { 642 "firewallPolicys": [ # Effective firewalls from firewall policy. 643 { 644 "displayName": "A String", # [Output Only] The display name of the firewall policy. 645 "name": "A String", # [Output Only] The name of the firewall policy. 646 "rules": [ # The rules that apply to the network. 647 { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). 648 "action": "A String", # The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502. 649 "description": "A String", # An optional description for this resource. 650 "direction": "A String", # The direction in which this rule applies. 651 "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. 652 "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. 653 "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules 654 "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. 655 "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. 656 "A String", 657 ], 658 "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 1000. 659 "A String", 660 ], 661 "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. 662 "A String", 663 ], 664 "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. 665 "A String", 666 ], 667 "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. 668 { 669 "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. 670 "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. 671 "A String", 672 ], 673 }, 674 ], 675 "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. 676 "A String", 677 ], 678 "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 1000. 679 "A String", 680 ], 681 "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. 682 "A String", 683 ], 684 "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. 685 "A String", 686 ], 687 "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. 688 { 689 "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. 690 "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. 691 }, 692 ], 693 }, 694 "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. 695 "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. 696 "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. 697 "A String", 698 ], 699 "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. 700 { 701 "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. 702 "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. 703 }, 704 ], 705 "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. 706 "A String", 707 ], 708 }, 709 ], 710 "type": "A String", # [Output Only] The type of the firewall policy. 711 }, 712 ], 713 "firewalls": [ # Effective firewalls on the network. 714 { # Represents a Firewall Rule resource. Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules. 715 "allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection. 716 { 717 "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. 718 "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. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. 719 "A String", 720 ], 721 }, 722 ], 723 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 724 "denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection. 725 { 726 "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. 727 "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. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. 728 "A String", 729 ], 730 }, 731 ], 732 "description": "A String", # An optional description of this resource. Provide this field when you create the resource. 733 "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. Both IPv4 and IPv6 are supported. 734 "A String", 735 ], 736 "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. 737 "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. 738 "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. 739 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 740 "kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules. 741 "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. 742 "enable": True or False, # This field denotes whether to enable logging for a particular firewall rule. 743 "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. 744 }, 745 "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. 746 "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: global/networks/default 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: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default 747 "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`. 748 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 749 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 750 "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. Both IPv4 and IPv6 are supported. 751 "A String", 752 ], 753 "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. 754 "A String", 755 ], 756 "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. 757 "A String", 758 ], 759 "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. 760 "A String", 761 ], 762 "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. 763 "A String", 764 ], 765 }, 766 ], 767}</pre> 768</div> 769 770<div class="method"> 771 <code class="details" id="getIamPolicy">getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code> 772 <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists. 773 774Args: 775 project: string, Project ID for this request. (required) 776 region: string, The name of the region for this request. (required) 777 resource: string, Name or id of the resource for this request. (required) 778 optionsRequestedPolicyVersion: integer, Requested IAM Policy version. 779 x__xgafv: string, V1 error format. 780 Allowed values 781 1 - v1 error format 782 2 - v2 error format 783 784Returns: 785 An object of the form: 786 787 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). 788 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 789 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 790 "auditLogConfigs": [ # The configuration for logging of each type of permission. 791 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 792 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 793 "A String", 794 ], 795 "ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use. 796 "logType": "A String", # The log type that this config enables. 797 }, 798 ], 799 "exemptedMembers": [ # This is deprecated and has no effect. Do not use. 800 "A String", 801 ], 802 "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. 803 }, 804 ], 805 "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 806 { # Associates `members`, or principals, with a `role`. 807 "bindingId": "A String", # This is deprecated and has no effect. Do not use. 808 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 809 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 810 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 811 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 812 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 813 }, 814 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 815 "A String", 816 ], 817 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 818 }, 819 ], 820 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. 821 "rules": [ # This is deprecated and has no effect. Do not use. 822 { # This is deprecated and has no effect. Do not use. 823 "action": "A String", # This is deprecated and has no effect. Do not use. 824 "conditions": [ # This is deprecated and has no effect. Do not use. 825 { # This is deprecated and has no effect. Do not use. 826 "iam": "A String", # This is deprecated and has no effect. Do not use. 827 "op": "A String", # This is deprecated and has no effect. Do not use. 828 "svc": "A String", # This is deprecated and has no effect. Do not use. 829 "sys": "A String", # This is deprecated and has no effect. Do not use. 830 "values": [ # This is deprecated and has no effect. Do not use. 831 "A String", 832 ], 833 }, 834 ], 835 "description": "A String", # This is deprecated and has no effect. Do not use. 836 "ins": [ # This is deprecated and has no effect. Do not use. 837 "A String", 838 ], 839 "logConfigs": [ # This is deprecated and has no effect. Do not use. 840 { # This is deprecated and has no effect. Do not use. 841 "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 842 "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 843 "permissionType": "A String", # This is deprecated and has no effect. Do not use. 844 }, 845 "logName": "A String", # This is deprecated and has no effect. Do not use. 846 }, 847 "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 848 "customFields": [ # This is deprecated and has no effect. Do not use. 849 { # This is deprecated and has no effect. Do not use. 850 "name": "A String", # This is deprecated and has no effect. Do not use. 851 "value": "A String", # This is deprecated and has no effect. Do not use. 852 }, 853 ], 854 "field": "A String", # This is deprecated and has no effect. Do not use. 855 "metric": "A String", # This is deprecated and has no effect. Do not use. 856 }, 857 "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 858 "logMode": "A String", # This is deprecated and has no effect. Do not use. 859 }, 860 }, 861 ], 862 "notIns": [ # This is deprecated and has no effect. Do not use. 863 "A String", 864 ], 865 "permissions": [ # This is deprecated and has no effect. Do not use. 866 "A String", 867 ], 868 }, 869 ], 870 "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 871}</pre> 872</div> 873 874<div class="method"> 875 <code class="details" id="getRule">getRule(project, region, firewallPolicy, priority=None, x__xgafv=None)</code> 876 <pre>Gets a rule of the specified priority. 877 878Args: 879 project: string, Project ID for this request. (required) 880 region: string, Name of the region scoping this request. (required) 881 firewallPolicy: string, Name of the firewall policy to which the queried rule belongs. (required) 882 priority: integer, The priority of the rule to get from the firewall policy. 883 x__xgafv: string, V1 error format. 884 Allowed values 885 1 - v1 error format 886 2 - v2 error format 887 888Returns: 889 An object of the form: 890 891 { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). 892 "action": "A String", # The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502. 893 "description": "A String", # An optional description for this resource. 894 "direction": "A String", # The direction in which this rule applies. 895 "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. 896 "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. 897 "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules 898 "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. 899 "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. 900 "A String", 901 ], 902 "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 1000. 903 "A String", 904 ], 905 "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. 906 "A String", 907 ], 908 "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. 909 "A String", 910 ], 911 "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. 912 { 913 "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. 914 "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. 915 "A String", 916 ], 917 }, 918 ], 919 "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. 920 "A String", 921 ], 922 "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 1000. 923 "A String", 924 ], 925 "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. 926 "A String", 927 ], 928 "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. 929 "A String", 930 ], 931 "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. 932 { 933 "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. 934 "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. 935 }, 936 ], 937 }, 938 "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. 939 "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. 940 "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. 941 "A String", 942 ], 943 "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. 944 { 945 "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. 946 "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. 947 }, 948 ], 949 "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. 950 "A String", 951 ], 952}</pre> 953</div> 954 955<div class="method"> 956 <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code> 957 <pre>Creates a new network firewall policy in the specified project and region. 958 959Args: 960 project: string, Project ID for this request. (required) 961 region: string, Name of the region scoping this request. (required) 962 body: object, The request body. 963 The object takes the form of: 964 965{ # Represents a Firewall Policy resource. 966 "associations": [ # A list of associations that belong to this firewall policy. 967 { 968 "attachmentTarget": "A String", # The target that the firewall policy is attached to. 969 "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association. 970 "firewallPolicyId": "A String", # [Output Only] The firewall policy ID of the association. 971 "name": "A String", # The name for an association. 972 "shortName": "A String", # [Output Only] The short name of the firewall policy of the association. 973 }, 974 ], 975 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 976 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 977 "displayName": "A String", # Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 978 "fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy. 979 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 980 "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies 981 "name": "A String", # [Output Only] Name of the resource. It is a numeric ID allocated by GCP which uniquely identifies the Firewall Policy. 982 "parent": "A String", # [Output Only] The parent of the firewall policy. 983 "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 984 "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. 985 "rules": [ # A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added. 986 { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). 987 "action": "A String", # The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502. 988 "description": "A String", # An optional description for this resource. 989 "direction": "A String", # The direction in which this rule applies. 990 "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. 991 "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. 992 "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules 993 "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. 994 "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. 995 "A String", 996 ], 997 "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 1000. 998 "A String", 999 ], 1000 "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. 1001 "A String", 1002 ], 1003 "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. 1004 "A String", 1005 ], 1006 "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. 1007 { 1008 "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. 1009 "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. 1010 "A String", 1011 ], 1012 }, 1013 ], 1014 "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. 1015 "A String", 1016 ], 1017 "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 1000. 1018 "A String", 1019 ], 1020 "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. 1021 "A String", 1022 ], 1023 "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. 1024 "A String", 1025 ], 1026 "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. 1027 { 1028 "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. 1029 "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. 1030 }, 1031 ], 1032 }, 1033 "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. 1034 "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. 1035 "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. 1036 "A String", 1037 ], 1038 "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. 1039 { 1040 "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. 1041 "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. 1042 }, 1043 ], 1044 "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. 1045 "A String", 1046 ], 1047 }, 1048 ], 1049 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1050 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 1051 "shortName": "A String", # User-provided name of the Organization firewall plicy. The name should be unique in the organization in which the firewall policy is created. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 1052} 1053 1054 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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 1055 x__xgafv: string, V1 error format. 1056 Allowed values 1057 1 - v1 error format 1058 2 - v2 error format 1059 1060Returns: 1061 An object of the form: 1062 1063 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 1064 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1065 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1066 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1067 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1068 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1069 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1070 { 1071 "code": "A String", # [Output Only] The error type identifier for this error. 1072 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1073 "message": "A String", # [Output Only] An optional, human-readable error message. 1074 }, 1075 ], 1076 }, 1077 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1078 "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. 1079 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1080 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1081 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1082 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 1083 "a_key": "", # Properties of the object. Contains field @type with type URL. 1084 }, 1085 "name": "A String", # [Output Only] Name of the operation. 1086 "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. 1087 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1088 "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. 1089 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1090 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1091 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 1092 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1093 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1094 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1095 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1096 "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. 1097 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1098 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1099 { 1100 "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. 1101 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1102 { 1103 "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). 1104 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1105 }, 1106 ], 1107 "message": "A String", # [Output Only] A human-readable description of the warning code. 1108 }, 1109 ], 1110 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1111}</pre> 1112</div> 1113 1114<div class="method"> 1115 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 1116 <pre>Lists all the network firewall policies that have been configured for the specified project in the given region. 1117 1118Args: 1119 project: string, Project ID for this request. (required) 1120 region: string, Name of the region scoping this request. (required) 1121 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` 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. 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) ``` 1122 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`) 1123 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported. 1124 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. 1125 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 1126 x__xgafv: string, V1 error format. 1127 Allowed values 1128 1 - v1 error format 1129 2 - v2 error format 1130 1131Returns: 1132 An object of the form: 1133 1134 { 1135 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 1136 "items": [ # A list of FirewallPolicy resources. 1137 { # Represents a Firewall Policy resource. 1138 "associations": [ # A list of associations that belong to this firewall policy. 1139 { 1140 "attachmentTarget": "A String", # The target that the firewall policy is attached to. 1141 "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association. 1142 "firewallPolicyId": "A String", # [Output Only] The firewall policy ID of the association. 1143 "name": "A String", # The name for an association. 1144 "shortName": "A String", # [Output Only] The short name of the firewall policy of the association. 1145 }, 1146 ], 1147 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 1148 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 1149 "displayName": "A String", # Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 1150 "fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy. 1151 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1152 "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies 1153 "name": "A String", # [Output Only] Name of the resource. It is a numeric ID allocated by GCP which uniquely identifies the Firewall Policy. 1154 "parent": "A String", # [Output Only] The parent of the firewall policy. 1155 "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 1156 "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. 1157 "rules": [ # A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added. 1158 { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). 1159 "action": "A String", # The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502. 1160 "description": "A String", # An optional description for this resource. 1161 "direction": "A String", # The direction in which this rule applies. 1162 "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. 1163 "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. 1164 "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules 1165 "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. 1166 "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. 1167 "A String", 1168 ], 1169 "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 1000. 1170 "A String", 1171 ], 1172 "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. 1173 "A String", 1174 ], 1175 "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. 1176 "A String", 1177 ], 1178 "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. 1179 { 1180 "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. 1181 "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. 1182 "A String", 1183 ], 1184 }, 1185 ], 1186 "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. 1187 "A String", 1188 ], 1189 "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 1000. 1190 "A String", 1191 ], 1192 "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. 1193 "A String", 1194 ], 1195 "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. 1196 "A String", 1197 ], 1198 "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. 1199 { 1200 "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. 1201 "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. 1202 }, 1203 ], 1204 }, 1205 "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. 1206 "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. 1207 "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. 1208 "A String", 1209 ], 1210 "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. 1211 { 1212 "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. 1213 "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. 1214 }, 1215 ], 1216 "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. 1217 "A String", 1218 ], 1219 }, 1220 ], 1221 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1222 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 1223 "shortName": "A String", # User-provided name of the Organization firewall plicy. The name should be unique in the organization in which the firewall policy is created. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 1224 }, 1225 ], 1226 "kind": "compute#firewallPolicyList", # [Output Only] Type of resource. Always compute#firewallPolicyList for listsof FirewallPolicies 1227 "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. 1228 "warning": { # [Output Only] Informational warning message. 1229 "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. 1230 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1231 { 1232 "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). 1233 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1234 }, 1235 ], 1236 "message": "A String", # [Output Only] A human-readable description of the warning code. 1237 }, 1238}</pre> 1239</div> 1240 1241<div class="method"> 1242 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 1243 <pre>Retrieves the next page of results. 1244 1245Args: 1246 previous_request: The request for the previous page. (required) 1247 previous_response: The response from the request for the previous page. (required) 1248 1249Returns: 1250 A request object that you can call 'execute()' on to request the next 1251 page. Returns None if there are no more items in the collection. 1252 </pre> 1253</div> 1254 1255<div class="method"> 1256 <code class="details" id="patch">patch(project, region, firewallPolicy, body=None, requestId=None, x__xgafv=None)</code> 1257 <pre>Patches the specified network firewall policy. 1258 1259Args: 1260 project: string, Project ID for this request. (required) 1261 region: string, Name of the region scoping this request. (required) 1262 firewallPolicy: string, Name of the firewall policy to update. (required) 1263 body: object, The request body. 1264 The object takes the form of: 1265 1266{ # Represents a Firewall Policy resource. 1267 "associations": [ # A list of associations that belong to this firewall policy. 1268 { 1269 "attachmentTarget": "A String", # The target that the firewall policy is attached to. 1270 "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association. 1271 "firewallPolicyId": "A String", # [Output Only] The firewall policy ID of the association. 1272 "name": "A String", # The name for an association. 1273 "shortName": "A String", # [Output Only] The short name of the firewall policy of the association. 1274 }, 1275 ], 1276 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 1277 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 1278 "displayName": "A String", # Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 1279 "fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy. 1280 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1281 "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies 1282 "name": "A String", # [Output Only] Name of the resource. It is a numeric ID allocated by GCP which uniquely identifies the Firewall Policy. 1283 "parent": "A String", # [Output Only] The parent of the firewall policy. 1284 "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 1285 "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. 1286 "rules": [ # A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added. 1287 { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). 1288 "action": "A String", # The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502. 1289 "description": "A String", # An optional description for this resource. 1290 "direction": "A String", # The direction in which this rule applies. 1291 "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. 1292 "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. 1293 "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules 1294 "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. 1295 "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. 1296 "A String", 1297 ], 1298 "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 1000. 1299 "A String", 1300 ], 1301 "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. 1302 "A String", 1303 ], 1304 "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. 1305 "A String", 1306 ], 1307 "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. 1308 { 1309 "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. 1310 "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. 1311 "A String", 1312 ], 1313 }, 1314 ], 1315 "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. 1316 "A String", 1317 ], 1318 "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 1000. 1319 "A String", 1320 ], 1321 "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. 1322 "A String", 1323 ], 1324 "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. 1325 "A String", 1326 ], 1327 "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. 1328 { 1329 "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. 1330 "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. 1331 }, 1332 ], 1333 }, 1334 "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. 1335 "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. 1336 "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. 1337 "A String", 1338 ], 1339 "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. 1340 { 1341 "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. 1342 "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. 1343 }, 1344 ], 1345 "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. 1346 "A String", 1347 ], 1348 }, 1349 ], 1350 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1351 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 1352 "shortName": "A String", # User-provided name of the Organization firewall plicy. The name should be unique in the organization in which the firewall policy is created. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 1353} 1354 1355 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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 1356 x__xgafv: string, V1 error format. 1357 Allowed values 1358 1 - v1 error format 1359 2 - v2 error format 1360 1361Returns: 1362 An object of the form: 1363 1364 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 1365 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1366 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1367 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1368 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1369 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1370 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1371 { 1372 "code": "A String", # [Output Only] The error type identifier for this error. 1373 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1374 "message": "A String", # [Output Only] An optional, human-readable error message. 1375 }, 1376 ], 1377 }, 1378 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1379 "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. 1380 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1381 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1382 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1383 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 1384 "a_key": "", # Properties of the object. Contains field @type with type URL. 1385 }, 1386 "name": "A String", # [Output Only] Name of the operation. 1387 "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. 1388 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1389 "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. 1390 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1391 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1392 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 1393 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1394 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1395 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1396 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1397 "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. 1398 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1399 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1400 { 1401 "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. 1402 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1403 { 1404 "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). 1405 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1406 }, 1407 ], 1408 "message": "A String", # [Output Only] A human-readable description of the warning code. 1409 }, 1410 ], 1411 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1412}</pre> 1413</div> 1414 1415<div class="method"> 1416 <code class="details" id="patchRule">patchRule(project, region, firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None)</code> 1417 <pre>Patches a rule of the specified priority. 1418 1419Args: 1420 project: string, Project ID for this request. (required) 1421 region: string, Name of the region scoping this request. (required) 1422 firewallPolicy: string, Name of the firewall policy to update. (required) 1423 body: object, The request body. 1424 The object takes the form of: 1425 1426{ # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). 1427 "action": "A String", # The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502. 1428 "description": "A String", # An optional description for this resource. 1429 "direction": "A String", # The direction in which this rule applies. 1430 "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. 1431 "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. 1432 "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules 1433 "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. 1434 "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. 1435 "A String", 1436 ], 1437 "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 1000. 1438 "A String", 1439 ], 1440 "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. 1441 "A String", 1442 ], 1443 "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. 1444 "A String", 1445 ], 1446 "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. 1447 { 1448 "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. 1449 "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. 1450 "A String", 1451 ], 1452 }, 1453 ], 1454 "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. 1455 "A String", 1456 ], 1457 "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 1000. 1458 "A String", 1459 ], 1460 "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. 1461 "A String", 1462 ], 1463 "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. 1464 "A String", 1465 ], 1466 "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. 1467 { 1468 "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. 1469 "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. 1470 }, 1471 ], 1472 }, 1473 "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. 1474 "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. 1475 "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. 1476 "A String", 1477 ], 1478 "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. 1479 { 1480 "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. 1481 "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. 1482 }, 1483 ], 1484 "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. 1485 "A String", 1486 ], 1487} 1488 1489 priority: integer, The priority of the rule to patch. 1490 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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 1491 x__xgafv: string, V1 error format. 1492 Allowed values 1493 1 - v1 error format 1494 2 - v2 error format 1495 1496Returns: 1497 An object of the form: 1498 1499 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 1500 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1501 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1502 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1503 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1504 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1505 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1506 { 1507 "code": "A String", # [Output Only] The error type identifier for this error. 1508 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1509 "message": "A String", # [Output Only] An optional, human-readable error message. 1510 }, 1511 ], 1512 }, 1513 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1514 "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. 1515 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1516 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1517 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1518 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 1519 "a_key": "", # Properties of the object. Contains field @type with type URL. 1520 }, 1521 "name": "A String", # [Output Only] Name of the operation. 1522 "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. 1523 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1524 "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. 1525 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1526 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1527 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 1528 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1529 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1530 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1531 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1532 "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. 1533 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1534 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1535 { 1536 "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. 1537 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1538 { 1539 "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). 1540 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1541 }, 1542 ], 1543 "message": "A String", # [Output Only] A human-readable description of the warning code. 1544 }, 1545 ], 1546 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1547}</pre> 1548</div> 1549 1550<div class="method"> 1551 <code class="details" id="removeAssociation">removeAssociation(project, region, firewallPolicy, name=None, requestId=None, x__xgafv=None)</code> 1552 <pre>Removes an association for the specified network firewall policy. 1553 1554Args: 1555 project: string, Project ID for this request. (required) 1556 region: string, Name of the region scoping this request. (required) 1557 firewallPolicy: string, Name of the firewall policy to update. (required) 1558 name: string, Name for the association that will be removed. 1559 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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 1560 x__xgafv: string, V1 error format. 1561 Allowed values 1562 1 - v1 error format 1563 2 - v2 error format 1564 1565Returns: 1566 An object of the form: 1567 1568 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 1569 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1570 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1571 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1572 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1573 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1574 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1575 { 1576 "code": "A String", # [Output Only] The error type identifier for this error. 1577 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1578 "message": "A String", # [Output Only] An optional, human-readable error message. 1579 }, 1580 ], 1581 }, 1582 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1583 "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. 1584 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1585 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1586 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1587 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 1588 "a_key": "", # Properties of the object. Contains field @type with type URL. 1589 }, 1590 "name": "A String", # [Output Only] Name of the operation. 1591 "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. 1592 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1593 "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. 1594 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1595 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1596 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 1597 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1598 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1599 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1600 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1601 "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. 1602 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1603 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1604 { 1605 "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. 1606 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1607 { 1608 "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). 1609 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1610 }, 1611 ], 1612 "message": "A String", # [Output Only] A human-readable description of the warning code. 1613 }, 1614 ], 1615 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1616}</pre> 1617</div> 1618 1619<div class="method"> 1620 <code class="details" id="removeRule">removeRule(project, region, firewallPolicy, priority=None, requestId=None, x__xgafv=None)</code> 1621 <pre>Deletes a rule of the specified priority. 1622 1623Args: 1624 project: string, Project ID for this request. (required) 1625 region: string, Name of the region scoping this request. (required) 1626 firewallPolicy: string, Name of the firewall policy to update. (required) 1627 priority: integer, The priority of the rule to remove from the firewall policy. 1628 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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 1629 x__xgafv: string, V1 error format. 1630 Allowed values 1631 1 - v1 error format 1632 2 - v2 error format 1633 1634Returns: 1635 An object of the form: 1636 1637 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 1638 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1639 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1640 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1641 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1642 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1643 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1644 { 1645 "code": "A String", # [Output Only] The error type identifier for this error. 1646 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1647 "message": "A String", # [Output Only] An optional, human-readable error message. 1648 }, 1649 ], 1650 }, 1651 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1652 "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. 1653 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1654 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1655 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1656 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 1657 "a_key": "", # Properties of the object. Contains field @type with type URL. 1658 }, 1659 "name": "A String", # [Output Only] Name of the operation. 1660 "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. 1661 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1662 "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. 1663 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1664 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1665 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 1666 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1667 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1668 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1669 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1670 "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. 1671 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1672 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1673 { 1674 "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. 1675 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1676 { 1677 "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). 1678 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1679 }, 1680 ], 1681 "message": "A String", # [Output Only] A human-readable description of the warning code. 1682 }, 1683 ], 1684 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1685}</pre> 1686</div> 1687 1688<div class="method"> 1689 <code class="details" id="setIamPolicy">setIamPolicy(project, region, resource, body=None, x__xgafv=None)</code> 1690 <pre>Sets the access control policy on the specified resource. Replaces any existing policy. 1691 1692Args: 1693 project: string, Project ID for this request. (required) 1694 region: string, The name of the region for this request. (required) 1695 resource: string, Name or id of the resource for this request. (required) 1696 body: object, The request body. 1697 The object takes the form of: 1698 1699{ 1700 "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. 1701 { # Associates `members`, or principals, with a `role`. 1702 "bindingId": "A String", # This is deprecated and has no effect. Do not use. 1703 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 1704 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 1705 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 1706 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 1707 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 1708 }, 1709 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 1710 "A String", 1711 ], 1712 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 1713 }, 1714 ], 1715 "etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. 1716 "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. 1717 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 1718 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 1719 "auditLogConfigs": [ # The configuration for logging of each type of permission. 1720 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 1721 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 1722 "A String", 1723 ], 1724 "ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use. 1725 "logType": "A String", # The log type that this config enables. 1726 }, 1727 ], 1728 "exemptedMembers": [ # This is deprecated and has no effect. Do not use. 1729 "A String", 1730 ], 1731 "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. 1732 }, 1733 ], 1734 "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 1735 { # Associates `members`, or principals, with a `role`. 1736 "bindingId": "A String", # This is deprecated and has no effect. Do not use. 1737 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 1738 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 1739 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 1740 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 1741 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 1742 }, 1743 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 1744 "A String", 1745 ], 1746 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 1747 }, 1748 ], 1749 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. 1750 "rules": [ # This is deprecated and has no effect. Do not use. 1751 { # This is deprecated and has no effect. Do not use. 1752 "action": "A String", # This is deprecated and has no effect. Do not use. 1753 "conditions": [ # This is deprecated and has no effect. Do not use. 1754 { # This is deprecated and has no effect. Do not use. 1755 "iam": "A String", # This is deprecated and has no effect. Do not use. 1756 "op": "A String", # This is deprecated and has no effect. Do not use. 1757 "svc": "A String", # This is deprecated and has no effect. Do not use. 1758 "sys": "A String", # This is deprecated and has no effect. Do not use. 1759 "values": [ # This is deprecated and has no effect. Do not use. 1760 "A String", 1761 ], 1762 }, 1763 ], 1764 "description": "A String", # This is deprecated and has no effect. Do not use. 1765 "ins": [ # This is deprecated and has no effect. Do not use. 1766 "A String", 1767 ], 1768 "logConfigs": [ # This is deprecated and has no effect. Do not use. 1769 { # This is deprecated and has no effect. Do not use. 1770 "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 1771 "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 1772 "permissionType": "A String", # This is deprecated and has no effect. Do not use. 1773 }, 1774 "logName": "A String", # This is deprecated and has no effect. Do not use. 1775 }, 1776 "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 1777 "customFields": [ # This is deprecated and has no effect. Do not use. 1778 { # This is deprecated and has no effect. Do not use. 1779 "name": "A String", # This is deprecated and has no effect. Do not use. 1780 "value": "A String", # This is deprecated and has no effect. Do not use. 1781 }, 1782 ], 1783 "field": "A String", # This is deprecated and has no effect. Do not use. 1784 "metric": "A String", # This is deprecated and has no effect. Do not use. 1785 }, 1786 "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 1787 "logMode": "A String", # This is deprecated and has no effect. Do not use. 1788 }, 1789 }, 1790 ], 1791 "notIns": [ # This is deprecated and has no effect. Do not use. 1792 "A String", 1793 ], 1794 "permissions": [ # This is deprecated and has no effect. Do not use. 1795 "A String", 1796 ], 1797 }, 1798 ], 1799 "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 1800 }, 1801} 1802 1803 x__xgafv: string, V1 error format. 1804 Allowed values 1805 1 - v1 error format 1806 2 - v2 error format 1807 1808Returns: 1809 An object of the form: 1810 1811 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). 1812 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 1813 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 1814 "auditLogConfigs": [ # The configuration for logging of each type of permission. 1815 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 1816 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 1817 "A String", 1818 ], 1819 "ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use. 1820 "logType": "A String", # The log type that this config enables. 1821 }, 1822 ], 1823 "exemptedMembers": [ # This is deprecated and has no effect. Do not use. 1824 "A String", 1825 ], 1826 "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. 1827 }, 1828 ], 1829 "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 1830 { # Associates `members`, or principals, with a `role`. 1831 "bindingId": "A String", # This is deprecated and has no effect. Do not use. 1832 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 1833 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 1834 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 1835 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 1836 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 1837 }, 1838 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 1839 "A String", 1840 ], 1841 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 1842 }, 1843 ], 1844 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. 1845 "rules": [ # This is deprecated and has no effect. Do not use. 1846 { # This is deprecated and has no effect. Do not use. 1847 "action": "A String", # This is deprecated and has no effect. Do not use. 1848 "conditions": [ # This is deprecated and has no effect. Do not use. 1849 { # This is deprecated and has no effect. Do not use. 1850 "iam": "A String", # This is deprecated and has no effect. Do not use. 1851 "op": "A String", # This is deprecated and has no effect. Do not use. 1852 "svc": "A String", # This is deprecated and has no effect. Do not use. 1853 "sys": "A String", # This is deprecated and has no effect. Do not use. 1854 "values": [ # This is deprecated and has no effect. Do not use. 1855 "A String", 1856 ], 1857 }, 1858 ], 1859 "description": "A String", # This is deprecated and has no effect. Do not use. 1860 "ins": [ # This is deprecated and has no effect. Do not use. 1861 "A String", 1862 ], 1863 "logConfigs": [ # This is deprecated and has no effect. Do not use. 1864 { # This is deprecated and has no effect. Do not use. 1865 "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 1866 "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 1867 "permissionType": "A String", # This is deprecated and has no effect. Do not use. 1868 }, 1869 "logName": "A String", # This is deprecated and has no effect. Do not use. 1870 }, 1871 "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 1872 "customFields": [ # This is deprecated and has no effect. Do not use. 1873 { # This is deprecated and has no effect. Do not use. 1874 "name": "A String", # This is deprecated and has no effect. Do not use. 1875 "value": "A String", # This is deprecated and has no effect. Do not use. 1876 }, 1877 ], 1878 "field": "A String", # This is deprecated and has no effect. Do not use. 1879 "metric": "A String", # This is deprecated and has no effect. Do not use. 1880 }, 1881 "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 1882 "logMode": "A String", # This is deprecated and has no effect. Do not use. 1883 }, 1884 }, 1885 ], 1886 "notIns": [ # This is deprecated and has no effect. Do not use. 1887 "A String", 1888 ], 1889 "permissions": [ # This is deprecated and has no effect. Do not use. 1890 "A String", 1891 ], 1892 }, 1893 ], 1894 "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 1895}</pre> 1896</div> 1897 1898<div class="method"> 1899 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code> 1900 <pre>Returns permissions that a caller has on the specified resource. 1901 1902Args: 1903 project: string, Project ID for this request. (required) 1904 region: string, The name of the region for this request. (required) 1905 resource: string, Name or id of the resource for this request. (required) 1906 body: object, The request body. 1907 The object takes the form of: 1908 1909{ 1910 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 1911 "A String", 1912 ], 1913} 1914 1915 x__xgafv: string, V1 error format. 1916 Allowed values 1917 1 - v1 error format 1918 2 - v2 error format 1919 1920Returns: 1921 An object of the form: 1922 1923 { 1924 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 1925 "A String", 1926 ], 1927}</pre> 1928</div> 1929 1930</body></html>