| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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.firewallPolicies.html">firewallPolicies</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 78 | <code><a href="#addAssociation">addAssociation(firewallPolicy, body=None, replaceExistingAssociation=None, requestId=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 79 | <p class="firstline">Inserts an association for the specified firewall policy.</p> |
| 80 | <p class="toc_element"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 81 | <code><a href="#addRule">addRule(firewallPolicy, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 82 | <p class="firstline">Inserts a rule into a firewall policy.</p> |
| 83 | <p class="toc_element"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 84 | <code><a href="#cloneRules">cloneRules(firewallPolicy, requestId=None, sourceFirewallPolicy=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 85 | <p class="firstline">Copies rules to the specified 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"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 90 | <code><a href="#delete">delete(firewallPolicy, requestId=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 91 | <p class="firstline">Deletes the specified policy.</p> |
| 92 | <p class="toc_element"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 93 | <code><a href="#get">get(firewallPolicy, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 94 | <p class="firstline">Returns the specified firewall policy.</p> |
| 95 | <p class="toc_element"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 96 | <code><a href="#getAssociation">getAssociation(firewallPolicy, name=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 97 | <p class="firstline">Gets an association with the specified name.</p> |
| 98 | <p class="toc_element"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 99 | <code><a href="#getIamPolicy">getIamPolicy(resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 100 | <p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p> |
| 101 | <p class="toc_element"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 102 | <code><a href="#getRule">getRule(firewallPolicy, priority=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 103 | <p class="firstline">Gets a rule of the specified priority.</p> |
| 104 | <p class="toc_element"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 105 | <code><a href="#insert">insert(body=None, parentId=None, requestId=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 106 | <p class="firstline">Creates a new policy in the specified project using the data included in the request.</p> |
| 107 | <p class="toc_element"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 108 | <code><a href="#list">list(filter=None, maxResults=None, orderBy=None, pageToken=None, parentId=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | 8759538 | 2021-06-05 00:38:05 -0700 | [diff] [blame] | 109 | <p class="firstline">Lists all the policies that have been configured for the specified folder or organization.</p> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 110 | <p class="toc_element"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 111 | <code><a href="#listAssociations">listAssociations(targetResource=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 112 | <p class="firstline">Lists associations of a specified target, i.e., organization or folder.</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"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 117 | <code><a href="#move">move(firewallPolicy, parentId=None, requestId=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 118 | <p class="firstline">Moves the specified firewall policy.</p> |
| 119 | <p class="toc_element"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 120 | <code><a href="#patch">patch(firewallPolicy, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 121 | <p class="firstline">Patches the specified policy with the data included in the request.</p> |
| 122 | <p class="toc_element"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 123 | <code><a href="#patchRule">patchRule(firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 124 | <p class="firstline">Patches a rule of the specified priority.</p> |
| 125 | <p class="toc_element"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 126 | <code><a href="#removeAssociation">removeAssociation(firewallPolicy, name=None, requestId=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 127 | <p class="firstline">Removes an association for the specified firewall policy.</p> |
| 128 | <p class="toc_element"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 129 | <code><a href="#removeRule">removeRule(firewallPolicy, priority=None, requestId=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 130 | <p class="firstline">Deletes a rule of the specified priority.</p> |
| 131 | <p class="toc_element"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 132 | <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 133 | <p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p> |
| 134 | <p class="toc_element"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 135 | <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 136 | <p class="firstline">Returns permissions that a caller has on the specified resource.</p> |
| 137 | <h3>Method Details</h3> |
| 138 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 139 | <code class="details" id="addAssociation">addAssociation(firewallPolicy, body=None, replaceExistingAssociation=None, requestId=None, x__xgafv=None)</code> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 140 | <pre>Inserts an association for the specified firewall policy. |
| 141 | |
| 142 | Args: |
| 143 | firewallPolicy: string, Name of the firewall policy to update. (required) |
| 144 | body: object, The request body. |
| 145 | The object takes the form of: |
| 146 | |
| 147 | { |
| 148 | "attachmentTarget": "A String", # The target that the firewall policy is attached to. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 149 | "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 150 | "firewallPolicyId": "A String", # [Output Only] The firewall policy ID of the association. |
| 151 | "name": "A String", # The name for an association. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 152 | "shortName": "A String", # [Output Only] The short name of the firewall policy of the association. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 153 | } |
| 154 | |
| 155 | replaceExistingAssociation: boolean, Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 156 | 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). |
| 157 | x__xgafv: string, V1 error format. |
| 158 | Allowed values |
| 159 | 1 - v1 error format |
| 160 | 2 - v2 error format |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 161 | |
| 162 | Returns: |
| 163 | An object of the form: |
| 164 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 165 | { # 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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 166 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 167 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 168 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 169 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 170 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 171 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| 172 | { |
| 173 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 174 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 175 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| 176 | }, |
| 177 | ], |
| 178 | }, |
| 179 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 180 | "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. |
| 181 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 182 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 183 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 184 | "name": "A String", # [Output Only] Name of the operation. |
| 185 | "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. |
| 186 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 187 | "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. |
| 188 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 189 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 190 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 191 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 192 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 193 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 194 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 195 | "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. |
| 196 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 197 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 198 | { |
| 199 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 200 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 201 | { |
| 202 | "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). |
| 203 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 204 | }, |
| 205 | ], |
| 206 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 207 | }, |
| 208 | ], |
| 209 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 210 | }</pre> |
| 211 | </div> |
| 212 | |
| 213 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 214 | <code class="details" id="addRule">addRule(firewallPolicy, body=None, requestId=None, x__xgafv=None)</code> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 215 | <pre>Inserts a rule into a firewall policy. |
| 216 | |
| 217 | Args: |
| 218 | firewallPolicy: string, Name of the firewall policy to update. (required) |
| 219 | body: object, The request body. |
| 220 | The object takes the form of: |
| 221 | |
| 222 | { # 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). |
| 223 | "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. |
| 224 | "description": "A String", # An optional description for this resource. |
| 225 | "direction": "A String", # The direction in which this rule applies. |
| 226 | "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. |
| 227 | "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. |
| 228 | "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules |
| 229 | "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. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame^] | 230 | "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. |
| 231 | "A String", |
| 232 | ], |
| yoshi-code-bot | 96afc04 | 2021-08-24 00:22:31 -0700 | [diff] [blame] | 233 | "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 234 | "A String", |
| 235 | ], |
| 236 | "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. |
| 237 | { |
| 238 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 239 | "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"]. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 240 | "A String", |
| 241 | ], |
| 242 | }, |
| 243 | ], |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame^] | 244 | "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. |
| 245 | "A String", |
| 246 | ], |
| yoshi-code-bot | 96afc04 | 2021-08-24 00:22:31 -0700 | [diff] [blame] | 247 | "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 248 | "A String", |
| 249 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 250 | "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. |
| 251 | { |
| 252 | "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. |
| 253 | "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. |
| 254 | }, |
| 255 | ], |
| 256 | }, |
| 257 | "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. |
| 258 | "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. |
| 259 | "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. |
| 260 | "A String", |
| 261 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 262 | "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. |
| 263 | { |
| 264 | "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. |
| 265 | "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. |
| 266 | }, |
| 267 | ], |
| 268 | "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. |
| 269 | "A String", |
| 270 | ], |
| 271 | } |
| 272 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 273 | 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). |
| 274 | x__xgafv: string, V1 error format. |
| 275 | Allowed values |
| 276 | 1 - v1 error format |
| 277 | 2 - v2 error format |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 278 | |
| 279 | Returns: |
| 280 | An object of the form: |
| 281 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 282 | { # 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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 283 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 284 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 285 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 286 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 287 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 288 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| 289 | { |
| 290 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 291 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 292 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| 293 | }, |
| 294 | ], |
| 295 | }, |
| 296 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 297 | "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. |
| 298 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 299 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 300 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 301 | "name": "A String", # [Output Only] Name of the operation. |
| 302 | "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. |
| 303 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 304 | "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. |
| 305 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 306 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 307 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 308 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 309 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 310 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 311 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 312 | "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. |
| 313 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 314 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 315 | { |
| 316 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 317 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 318 | { |
| 319 | "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). |
| 320 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 321 | }, |
| 322 | ], |
| 323 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 324 | }, |
| 325 | ], |
| 326 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 327 | }</pre> |
| 328 | </div> |
| 329 | |
| 330 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 331 | <code class="details" id="cloneRules">cloneRules(firewallPolicy, requestId=None, sourceFirewallPolicy=None, x__xgafv=None)</code> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 332 | <pre>Copies rules to the specified firewall policy. |
| 333 | |
| 334 | Args: |
| 335 | firewallPolicy: string, Name of the firewall policy to update. (required) |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 336 | 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). |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 337 | sourceFirewallPolicy: string, The firewall policy from which to copy rules. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 338 | x__xgafv: string, V1 error format. |
| 339 | Allowed values |
| 340 | 1 - v1 error format |
| 341 | 2 - v2 error format |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 342 | |
| 343 | Returns: |
| 344 | An object of the form: |
| 345 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 346 | { # 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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 347 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 348 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 349 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 350 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 351 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 352 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| 353 | { |
| 354 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 355 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 356 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| 357 | }, |
| 358 | ], |
| 359 | }, |
| 360 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 361 | "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. |
| 362 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 363 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 364 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 365 | "name": "A String", # [Output Only] Name of the operation. |
| 366 | "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. |
| 367 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 368 | "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. |
| 369 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 370 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 371 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 372 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 373 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 374 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 375 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 376 | "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. |
| 377 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 378 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 379 | { |
| 380 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 381 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 382 | { |
| 383 | "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). |
| 384 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 385 | }, |
| 386 | ], |
| 387 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 388 | }, |
| 389 | ], |
| 390 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 391 | }</pre> |
| 392 | </div> |
| 393 | |
| 394 | <div class="method"> |
| 395 | <code class="details" id="close">close()</code> |
| 396 | <pre>Close httplib2 connections.</pre> |
| 397 | </div> |
| 398 | |
| 399 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 400 | <code class="details" id="delete">delete(firewallPolicy, requestId=None, x__xgafv=None)</code> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 401 | <pre>Deletes the specified policy. |
| 402 | |
| 403 | Args: |
| 404 | firewallPolicy: string, Name of the firewall policy to delete. (required) |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 405 | 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). |
| 406 | x__xgafv: string, V1 error format. |
| 407 | Allowed values |
| 408 | 1 - v1 error format |
| 409 | 2 - v2 error format |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 410 | |
| 411 | Returns: |
| 412 | An object of the form: |
| 413 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 414 | { # 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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 415 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 416 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 417 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 418 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 419 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 420 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| 421 | { |
| 422 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 423 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 424 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| 425 | }, |
| 426 | ], |
| 427 | }, |
| 428 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 429 | "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. |
| 430 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 431 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 432 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 433 | "name": "A String", # [Output Only] Name of the operation. |
| 434 | "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. |
| 435 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 436 | "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. |
| 437 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 438 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 439 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 440 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 441 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 442 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 443 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 444 | "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. |
| 445 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 446 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 447 | { |
| 448 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 449 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 450 | { |
| 451 | "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). |
| 452 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 453 | }, |
| 454 | ], |
| 455 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 456 | }, |
| 457 | ], |
| 458 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 459 | }</pre> |
| 460 | </div> |
| 461 | |
| 462 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 463 | <code class="details" id="get">get(firewallPolicy, x__xgafv=None)</code> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 464 | <pre>Returns the specified firewall policy. |
| 465 | |
| 466 | Args: |
| 467 | firewallPolicy: string, Name of the firewall policy to get. (required) |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 468 | x__xgafv: string, V1 error format. |
| 469 | Allowed values |
| 470 | 1 - v1 error format |
| 471 | 2 - v2 error format |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 472 | |
| 473 | Returns: |
| 474 | An object of the form: |
| 475 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 476 | { # Represents a Firewall Policy resource. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 477 | "associations": [ # A list of associations that belong to this firewall policy. |
| 478 | { |
| 479 | "attachmentTarget": "A String", # The target that the firewall policy is attached to. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 480 | "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 481 | "firewallPolicyId": "A String", # [Output Only] The firewall policy ID of the association. |
| 482 | "name": "A String", # The name for an association. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 483 | "shortName": "A String", # [Output Only] The short name of the firewall policy of the association. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 484 | }, |
| 485 | ], |
| 486 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| 487 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame^] | 488 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 489 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 490 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 491 | "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies |
| 492 | "name": "A String", # [Output Only] Name of the resource. It is a numeric ID allocated by GCP which uniquely identifies the Firewall Policy. |
| 493 | "parent": "A String", # [Output Only] The parent of the firewall policy. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 494 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 495 | "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. |
| 496 | "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. |
| 497 | { # 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). |
| 498 | "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. |
| 499 | "description": "A String", # An optional description for this resource. |
| 500 | "direction": "A String", # The direction in which this rule applies. |
| 501 | "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. |
| 502 | "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. |
| 503 | "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules |
| 504 | "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. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame^] | 505 | "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. |
| 506 | "A String", |
| 507 | ], |
| yoshi-code-bot | 96afc04 | 2021-08-24 00:22:31 -0700 | [diff] [blame] | 508 | "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 509 | "A String", |
| 510 | ], |
| 511 | "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. |
| 512 | { |
| 513 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 514 | "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"]. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 515 | "A String", |
| 516 | ], |
| 517 | }, |
| 518 | ], |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame^] | 519 | "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. |
| 520 | "A String", |
| 521 | ], |
| yoshi-code-bot | 96afc04 | 2021-08-24 00:22:31 -0700 | [diff] [blame] | 522 | "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 523 | "A String", |
| 524 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 525 | "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. |
| 526 | { |
| 527 | "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. |
| 528 | "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. |
| 529 | }, |
| 530 | ], |
| 531 | }, |
| 532 | "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. |
| 533 | "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. |
| 534 | "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. |
| 535 | "A String", |
| 536 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 537 | "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. |
| 538 | { |
| 539 | "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. |
| 540 | "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. |
| 541 | }, |
| 542 | ], |
| 543 | "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. |
| 544 | "A String", |
| 545 | ], |
| 546 | }, |
| 547 | ], |
| 548 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 549 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| yoshi-code-bot | 0770807 | 2021-07-20 00:20:24 -0700 | [diff] [blame] | 550 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 551 | }</pre> |
| 552 | </div> |
| 553 | |
| 554 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 555 | <code class="details" id="getAssociation">getAssociation(firewallPolicy, name=None, x__xgafv=None)</code> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 556 | <pre>Gets an association with the specified name. |
| 557 | |
| 558 | Args: |
| 559 | firewallPolicy: string, Name of the firewall policy to which the queried rule belongs. (required) |
| 560 | name: string, The name of the association to get from the firewall policy. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 561 | x__xgafv: string, V1 error format. |
| 562 | Allowed values |
| 563 | 1 - v1 error format |
| 564 | 2 - v2 error format |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 565 | |
| 566 | Returns: |
| 567 | An object of the form: |
| 568 | |
| 569 | { |
| 570 | "attachmentTarget": "A String", # The target that the firewall policy is attached to. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 571 | "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 572 | "firewallPolicyId": "A String", # [Output Only] The firewall policy ID of the association. |
| 573 | "name": "A String", # The name for an association. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 574 | "shortName": "A String", # [Output Only] The short name of the firewall policy of the association. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 575 | }</pre> |
| 576 | </div> |
| 577 | |
| 578 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 579 | <code class="details" id="getIamPolicy">getIamPolicy(resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 580 | <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists. |
| 581 | |
| 582 | Args: |
| 583 | resource: string, Name or id of the resource for this request. (required) |
| 584 | optionsRequestedPolicyVersion: integer, Requested IAM Policy version. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 585 | x__xgafv: string, V1 error format. |
| 586 | Allowed values |
| 587 | 1 - v1 error format |
| 588 | 2 - v2 error format |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 589 | |
| 590 | Returns: |
| 591 | An object of the form: |
| 592 | |
| yoshi-code-bot | 8bb904c | 2021-08-31 00:28:27 -0700 | [diff] [blame] | 593 | { # 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` to a single `role`. Members 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:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "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:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com 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/). |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 594 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 595 | { # 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:jose@example.com" ] }, { "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:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 596 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 597 | { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. |
| 598 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 599 | "A String", |
| 600 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 601 | "ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 602 | "logType": "A String", # The log type that this config enables. |
| 603 | }, |
| 604 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 605 | "exemptedMembers": [ # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 606 | "A String", |
| 607 | ], |
| 608 | "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. |
| 609 | }, |
| 610 | ], |
| 611 | "bindings": [ # Associates a list of `members` to 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 member. |
| 612 | { # Associates `members` with a `role`. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 613 | "bindingId": "A String", # This is deprecated and has no effect. Do not use. |
| 614 | "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 members 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). |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 615 | "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. |
| 616 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 617 | "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. |
| 618 | "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. |
| 619 | }, |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 620 | "members": [ # Specifies the identities 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, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?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, `my-other-app@appspot.gserviceaccount.com?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, `admins@example.com?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`. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 621 | "A String", |
| 622 | ], |
| 623 | "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| 624 | }, |
| 625 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 626 | "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. |
| 627 | "iamOwned": True or False, # This is deprecated and has no effect. Do not use. |
| 628 | "rules": [ # This is deprecated and has no effect. Do not use. |
| 629 | { # This is deprecated and has no effect. Do not use. |
| 630 | "action": "A String", # This is deprecated and has no effect. Do not use. |
| 631 | "conditions": [ # This is deprecated and has no effect. Do not use. |
| 632 | { # This is deprecated and has no effect. Do not use. |
| 633 | "iam": "A String", # This is deprecated and has no effect. Do not use. |
| 634 | "op": "A String", # This is deprecated and has no effect. Do not use. |
| 635 | "svc": "A String", # This is deprecated and has no effect. Do not use. |
| 636 | "sys": "A String", # This is deprecated and has no effect. Do not use. |
| 637 | "values": [ # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 638 | "A String", |
| 639 | ], |
| 640 | }, |
| 641 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 642 | "description": "A String", # This is deprecated and has no effect. Do not use. |
| 643 | "ins": [ # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 644 | "A String", |
| 645 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 646 | "logConfigs": [ # This is deprecated and has no effect. Do not use. |
| 647 | { # This is deprecated and has no effect. Do not use. |
| 648 | "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. |
| 649 | "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. |
| 650 | "permissionType": "A String", # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 651 | }, |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 652 | "logName": "A String", # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 653 | }, |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 654 | "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. |
| 655 | "customFields": [ # This is deprecated and has no effect. Do not use. |
| 656 | { # This is deprecated and has no effect. Do not use. |
| 657 | "name": "A String", # This is deprecated and has no effect. Do not use. |
| 658 | "value": "A String", # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 659 | }, |
| 660 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 661 | "field": "A String", # This is deprecated and has no effect. Do not use. |
| 662 | "metric": "A String", # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 663 | }, |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 664 | "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. |
| 665 | "logMode": "A String", # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 666 | }, |
| 667 | }, |
| 668 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 669 | "notIns": [ # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 670 | "A String", |
| 671 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 672 | "permissions": [ # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 673 | "A String", |
| 674 | ], |
| 675 | }, |
| 676 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 677 | "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). |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 678 | }</pre> |
| 679 | </div> |
| 680 | |
| 681 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 682 | <code class="details" id="getRule">getRule(firewallPolicy, priority=None, x__xgafv=None)</code> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 683 | <pre>Gets a rule of the specified priority. |
| 684 | |
| 685 | Args: |
| 686 | firewallPolicy: string, Name of the firewall policy to which the queried rule belongs. (required) |
| 687 | priority: integer, The priority of the rule to get from the firewall policy. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 688 | x__xgafv: string, V1 error format. |
| 689 | Allowed values |
| 690 | 1 - v1 error format |
| 691 | 2 - v2 error format |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 692 | |
| 693 | Returns: |
| 694 | An object of the form: |
| 695 | |
| 696 | { # 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). |
| 697 | "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. |
| 698 | "description": "A String", # An optional description for this resource. |
| 699 | "direction": "A String", # The direction in which this rule applies. |
| 700 | "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. |
| 701 | "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. |
| 702 | "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules |
| 703 | "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. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame^] | 704 | "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. |
| 705 | "A String", |
| 706 | ], |
| yoshi-code-bot | 96afc04 | 2021-08-24 00:22:31 -0700 | [diff] [blame] | 707 | "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 708 | "A String", |
| 709 | ], |
| 710 | "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. |
| 711 | { |
| 712 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 713 | "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"]. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 714 | "A String", |
| 715 | ], |
| 716 | }, |
| 717 | ], |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame^] | 718 | "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. |
| 719 | "A String", |
| 720 | ], |
| yoshi-code-bot | 96afc04 | 2021-08-24 00:22:31 -0700 | [diff] [blame] | 721 | "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 722 | "A String", |
| 723 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 724 | "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. |
| 725 | { |
| 726 | "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. |
| 727 | "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. |
| 728 | }, |
| 729 | ], |
| 730 | }, |
| 731 | "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. |
| 732 | "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. |
| 733 | "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. |
| 734 | "A String", |
| 735 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 736 | "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. |
| 737 | { |
| 738 | "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. |
| 739 | "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. |
| 740 | }, |
| 741 | ], |
| 742 | "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. |
| 743 | "A String", |
| 744 | ], |
| 745 | }</pre> |
| 746 | </div> |
| 747 | |
| 748 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 749 | <code class="details" id="insert">insert(body=None, parentId=None, requestId=None, x__xgafv=None)</code> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 750 | <pre>Creates a new policy in the specified project using the data included in the request. |
| 751 | |
| 752 | Args: |
| 753 | body: object, The request body. |
| 754 | The object takes the form of: |
| 755 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 756 | { # Represents a Firewall Policy resource. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 757 | "associations": [ # A list of associations that belong to this firewall policy. |
| 758 | { |
| 759 | "attachmentTarget": "A String", # The target that the firewall policy is attached to. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 760 | "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 761 | "firewallPolicyId": "A String", # [Output Only] The firewall policy ID of the association. |
| 762 | "name": "A String", # The name for an association. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 763 | "shortName": "A String", # [Output Only] The short name of the firewall policy of the association. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 764 | }, |
| 765 | ], |
| 766 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| 767 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame^] | 768 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 769 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 770 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 771 | "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies |
| 772 | "name": "A String", # [Output Only] Name of the resource. It is a numeric ID allocated by GCP which uniquely identifies the Firewall Policy. |
| 773 | "parent": "A String", # [Output Only] The parent of the firewall policy. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 774 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 775 | "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. |
| 776 | "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. |
| 777 | { # 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). |
| 778 | "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. |
| 779 | "description": "A String", # An optional description for this resource. |
| 780 | "direction": "A String", # The direction in which this rule applies. |
| 781 | "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. |
| 782 | "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. |
| 783 | "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules |
| 784 | "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. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame^] | 785 | "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. |
| 786 | "A String", |
| 787 | ], |
| yoshi-code-bot | 96afc04 | 2021-08-24 00:22:31 -0700 | [diff] [blame] | 788 | "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 789 | "A String", |
| 790 | ], |
| 791 | "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. |
| 792 | { |
| 793 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 794 | "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"]. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 795 | "A String", |
| 796 | ], |
| 797 | }, |
| 798 | ], |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame^] | 799 | "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. |
| 800 | "A String", |
| 801 | ], |
| yoshi-code-bot | 96afc04 | 2021-08-24 00:22:31 -0700 | [diff] [blame] | 802 | "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 803 | "A String", |
| 804 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 805 | "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. |
| 806 | { |
| 807 | "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. |
| 808 | "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. |
| 809 | }, |
| 810 | ], |
| 811 | }, |
| 812 | "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. |
| 813 | "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. |
| 814 | "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. |
| 815 | "A String", |
| 816 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 817 | "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. |
| 818 | { |
| 819 | "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. |
| 820 | "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. |
| 821 | }, |
| 822 | ], |
| 823 | "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. |
| 824 | "A String", |
| 825 | ], |
| 826 | }, |
| 827 | ], |
| 828 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 829 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| yoshi-code-bot | 0770807 | 2021-07-20 00:20:24 -0700 | [diff] [blame] | 830 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 831 | } |
| 832 | |
| 833 | parentId: string, Parent ID for this request. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 834 | 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). |
| 835 | x__xgafv: string, V1 error format. |
| 836 | Allowed values |
| 837 | 1 - v1 error format |
| 838 | 2 - v2 error format |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 839 | |
| 840 | Returns: |
| 841 | An object of the form: |
| 842 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 843 | { # 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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 844 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 845 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 846 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 847 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 848 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 849 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| 850 | { |
| 851 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 852 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 853 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| 854 | }, |
| 855 | ], |
| 856 | }, |
| 857 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 858 | "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. |
| 859 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 860 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 861 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 862 | "name": "A String", # [Output Only] Name of the operation. |
| 863 | "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. |
| 864 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 865 | "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. |
| 866 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 867 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 868 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 869 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 870 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 871 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 872 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 873 | "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. |
| 874 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 875 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 876 | { |
| 877 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 878 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 879 | { |
| 880 | "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). |
| 881 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 882 | }, |
| 883 | ], |
| 884 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 885 | }, |
| 886 | ], |
| 887 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 888 | }</pre> |
| 889 | </div> |
| 890 | |
| 891 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 892 | <code class="details" id="list">list(filter=None, maxResults=None, orderBy=None, pageToken=None, parentId=None, returnPartialSuccess=None, x__xgafv=None)</code> |
| yoshi-code-bot | 8759538 | 2021-06-05 00:38:05 -0700 | [diff] [blame] | 893 | <pre>Lists all the policies that have been configured for the specified folder or organization. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 894 | |
| 895 | Args: |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 896 | filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. 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) ``` |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 897 | 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`) |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 898 | 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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 899 | 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. |
| 900 | parentId: string, Parent ID for this request. |
| 901 | returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 902 | x__xgafv: string, V1 error format. |
| 903 | Allowed values |
| 904 | 1 - v1 error format |
| 905 | 2 - v2 error format |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 906 | |
| 907 | Returns: |
| 908 | An object of the form: |
| 909 | |
| 910 | { |
| 911 | "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| 912 | "items": [ # A list of FirewallPolicy resources. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 913 | { # Represents a Firewall Policy resource. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 914 | "associations": [ # A list of associations that belong to this firewall policy. |
| 915 | { |
| 916 | "attachmentTarget": "A String", # The target that the firewall policy is attached to. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 917 | "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 918 | "firewallPolicyId": "A String", # [Output Only] The firewall policy ID of the association. |
| 919 | "name": "A String", # The name for an association. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 920 | "shortName": "A String", # [Output Only] The short name of the firewall policy of the association. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 921 | }, |
| 922 | ], |
| 923 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| 924 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame^] | 925 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 926 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 927 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 928 | "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies |
| 929 | "name": "A String", # [Output Only] Name of the resource. It is a numeric ID allocated by GCP which uniquely identifies the Firewall Policy. |
| 930 | "parent": "A String", # [Output Only] The parent of the firewall policy. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 931 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 932 | "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. |
| 933 | "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. |
| 934 | { # 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). |
| 935 | "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. |
| 936 | "description": "A String", # An optional description for this resource. |
| 937 | "direction": "A String", # The direction in which this rule applies. |
| 938 | "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. |
| 939 | "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. |
| 940 | "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules |
| 941 | "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. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame^] | 942 | "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. |
| 943 | "A String", |
| 944 | ], |
| yoshi-code-bot | 96afc04 | 2021-08-24 00:22:31 -0700 | [diff] [blame] | 945 | "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 946 | "A String", |
| 947 | ], |
| 948 | "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. |
| 949 | { |
| 950 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 951 | "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"]. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 952 | "A String", |
| 953 | ], |
| 954 | }, |
| 955 | ], |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame^] | 956 | "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. |
| 957 | "A String", |
| 958 | ], |
| yoshi-code-bot | 96afc04 | 2021-08-24 00:22:31 -0700 | [diff] [blame] | 959 | "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 960 | "A String", |
| 961 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 962 | "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. |
| 963 | { |
| 964 | "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. |
| 965 | "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. |
| 966 | }, |
| 967 | ], |
| 968 | }, |
| 969 | "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. |
| 970 | "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. |
| 971 | "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. |
| 972 | "A String", |
| 973 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 974 | "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. |
| 975 | { |
| 976 | "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. |
| 977 | "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. |
| 978 | }, |
| 979 | ], |
| 980 | "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. |
| 981 | "A String", |
| 982 | ], |
| 983 | }, |
| 984 | ], |
| 985 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 986 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| yoshi-code-bot | 0770807 | 2021-07-20 00:20:24 -0700 | [diff] [blame] | 987 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 988 | }, |
| 989 | ], |
| 990 | "kind": "compute#firewallPolicyList", # [Output Only] Type of resource. Always compute#firewallPolicyList for listsof FirewallPolicies |
| 991 | "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. |
| 992 | "warning": { # [Output Only] Informational warning message. |
| 993 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 994 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 995 | { |
| 996 | "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). |
| 997 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 998 | }, |
| 999 | ], |
| 1000 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 1001 | }, |
| 1002 | }</pre> |
| 1003 | </div> |
| 1004 | |
| 1005 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1006 | <code class="details" id="listAssociations">listAssociations(targetResource=None, x__xgafv=None)</code> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1007 | <pre>Lists associations of a specified target, i.e., organization or folder. |
| 1008 | |
| 1009 | Args: |
| 1010 | targetResource: string, The target resource to list associations. It is an organization, or a folder. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1011 | x__xgafv: string, V1 error format. |
| 1012 | Allowed values |
| 1013 | 1 - v1 error format |
| 1014 | 2 - v2 error format |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1015 | |
| 1016 | Returns: |
| 1017 | An object of the form: |
| 1018 | |
| 1019 | { |
| 1020 | "associations": [ # A list of associations. |
| 1021 | { |
| 1022 | "attachmentTarget": "A String", # The target that the firewall policy is attached to. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 1023 | "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1024 | "firewallPolicyId": "A String", # [Output Only] The firewall policy ID of the association. |
| 1025 | "name": "A String", # The name for an association. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 1026 | "shortName": "A String", # [Output Only] The short name of the firewall policy of the association. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1027 | }, |
| 1028 | ], |
| 1029 | "kind": "compute#firewallPoliciesListAssociationsResponse", # [Output Only] Type of firewallPolicy associations. Always compute#FirewallPoliciesListAssociations for lists of firewallPolicy associations. |
| 1030 | }</pre> |
| 1031 | </div> |
| 1032 | |
| 1033 | <div class="method"> |
| 1034 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 1035 | <pre>Retrieves the next page of results. |
| 1036 | |
| 1037 | Args: |
| 1038 | previous_request: The request for the previous page. (required) |
| 1039 | previous_response: The response from the request for the previous page. (required) |
| 1040 | |
| 1041 | Returns: |
| 1042 | A request object that you can call 'execute()' on to request the next |
| 1043 | page. Returns None if there are no more items in the collection. |
| 1044 | </pre> |
| 1045 | </div> |
| 1046 | |
| 1047 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1048 | <code class="details" id="move">move(firewallPolicy, parentId=None, requestId=None, x__xgafv=None)</code> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1049 | <pre>Moves the specified firewall policy. |
| 1050 | |
| 1051 | Args: |
| 1052 | firewallPolicy: string, Name of the firewall policy to update. (required) |
| 1053 | parentId: string, The new parent of the firewall policy. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 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 |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1059 | |
| 1060 | Returns: |
| 1061 | An object of the form: |
| 1062 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1082 | "name": "A String", # [Output Only] Name of the operation. |
| 1083 | "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. |
| 1084 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 1085 | "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. |
| 1086 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 1087 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 1088 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 1089 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 1090 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 1091 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 1092 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 1093 | "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. |
| 1094 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 1095 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 1096 | { |
| 1097 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1098 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1099 | { |
| 1100 | "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). |
| 1101 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 1102 | }, |
| 1103 | ], |
| 1104 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 1105 | }, |
| 1106 | ], |
| 1107 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 1108 | }</pre> |
| 1109 | </div> |
| 1110 | |
| 1111 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1112 | <code class="details" id="patch">patch(firewallPolicy, body=None, requestId=None, x__xgafv=None)</code> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1113 | <pre>Patches the specified policy with the data included in the request. |
| 1114 | |
| 1115 | Args: |
| 1116 | firewallPolicy: string, Name of the firewall policy to update. (required) |
| 1117 | body: object, The request body. |
| 1118 | The object takes the form of: |
| 1119 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1120 | { # Represents a Firewall Policy resource. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1121 | "associations": [ # A list of associations that belong to this firewall policy. |
| 1122 | { |
| 1123 | "attachmentTarget": "A String", # The target that the firewall policy is attached to. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 1124 | "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1125 | "firewallPolicyId": "A String", # [Output Only] The firewall policy ID of the association. |
| 1126 | "name": "A String", # The name for an association. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 1127 | "shortName": "A String", # [Output Only] The short name of the firewall policy of the association. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1128 | }, |
| 1129 | ], |
| 1130 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| 1131 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame^] | 1132 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1133 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1134 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 1135 | "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies |
| 1136 | "name": "A String", # [Output Only] Name of the resource. It is a numeric ID allocated by GCP which uniquely identifies the Firewall Policy. |
| 1137 | "parent": "A String", # [Output Only] The parent of the firewall policy. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 1138 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1139 | "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. |
| 1140 | "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. |
| 1141 | { # 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). |
| 1142 | "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. |
| 1143 | "description": "A String", # An optional description for this resource. |
| 1144 | "direction": "A String", # The direction in which this rule applies. |
| 1145 | "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. |
| 1146 | "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. |
| 1147 | "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules |
| 1148 | "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. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame^] | 1149 | "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. |
| 1150 | "A String", |
| 1151 | ], |
| yoshi-code-bot | 96afc04 | 2021-08-24 00:22:31 -0700 | [diff] [blame] | 1152 | "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1153 | "A String", |
| 1154 | ], |
| 1155 | "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. |
| 1156 | { |
| 1157 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1158 | "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"]. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1159 | "A String", |
| 1160 | ], |
| 1161 | }, |
| 1162 | ], |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame^] | 1163 | "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. |
| 1164 | "A String", |
| 1165 | ], |
| yoshi-code-bot | 96afc04 | 2021-08-24 00:22:31 -0700 | [diff] [blame] | 1166 | "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1167 | "A String", |
| 1168 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1169 | "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. |
| 1170 | { |
| 1171 | "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. |
| 1172 | "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. |
| 1173 | }, |
| 1174 | ], |
| 1175 | }, |
| 1176 | "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. |
| 1177 | "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. |
| 1178 | "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. |
| 1179 | "A String", |
| 1180 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1181 | "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. |
| 1182 | { |
| 1183 | "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. |
| 1184 | "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. |
| 1185 | }, |
| 1186 | ], |
| 1187 | "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. |
| 1188 | "A String", |
| 1189 | ], |
| 1190 | }, |
| 1191 | ], |
| 1192 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 1193 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| yoshi-code-bot | 0770807 | 2021-07-20 00:20:24 -0700 | [diff] [blame] | 1194 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1195 | } |
| 1196 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1197 | 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). |
| 1198 | x__xgafv: string, V1 error format. |
| 1199 | Allowed values |
| 1200 | 1 - v1 error format |
| 1201 | 2 - v2 error format |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1202 | |
| 1203 | Returns: |
| 1204 | An object of the form: |
| 1205 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1206 | { # 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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1207 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 1208 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 1209 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 1210 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 1211 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 1212 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| 1213 | { |
| 1214 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 1215 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 1216 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| 1217 | }, |
| 1218 | ], |
| 1219 | }, |
| 1220 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 1221 | "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. |
| 1222 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 1223 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 1224 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1225 | "name": "A String", # [Output Only] Name of the operation. |
| 1226 | "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. |
| 1227 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 1228 | "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. |
| 1229 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 1230 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 1231 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 1232 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 1233 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 1234 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 1235 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 1236 | "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. |
| 1237 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 1238 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 1239 | { |
| 1240 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1241 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1242 | { |
| 1243 | "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). |
| 1244 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 1245 | }, |
| 1246 | ], |
| 1247 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 1248 | }, |
| 1249 | ], |
| 1250 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 1251 | }</pre> |
| 1252 | </div> |
| 1253 | |
| 1254 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1255 | <code class="details" id="patchRule">patchRule(firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None)</code> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1256 | <pre>Patches a rule of the specified priority. |
| 1257 | |
| 1258 | Args: |
| 1259 | firewallPolicy: string, Name of the firewall policy to update. (required) |
| 1260 | body: object, The request body. |
| 1261 | The object takes the form of: |
| 1262 | |
| 1263 | { # 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). |
| 1264 | "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. |
| 1265 | "description": "A String", # An optional description for this resource. |
| 1266 | "direction": "A String", # The direction in which this rule applies. |
| 1267 | "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. |
| 1268 | "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. |
| 1269 | "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules |
| 1270 | "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. |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame^] | 1271 | "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. |
| 1272 | "A String", |
| 1273 | ], |
| yoshi-code-bot | 96afc04 | 2021-08-24 00:22:31 -0700 | [diff] [blame] | 1274 | "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1275 | "A String", |
| 1276 | ], |
| 1277 | "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. |
| 1278 | { |
| 1279 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1280 | "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"]. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1281 | "A String", |
| 1282 | ], |
| 1283 | }, |
| 1284 | ], |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame^] | 1285 | "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. |
| 1286 | "A String", |
| 1287 | ], |
| yoshi-code-bot | 96afc04 | 2021-08-24 00:22:31 -0700 | [diff] [blame] | 1288 | "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1289 | "A String", |
| 1290 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1291 | "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. |
| 1292 | { |
| 1293 | "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. |
| 1294 | "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. |
| 1295 | }, |
| 1296 | ], |
| 1297 | }, |
| 1298 | "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. |
| 1299 | "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. |
| 1300 | "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. |
| 1301 | "A String", |
| 1302 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1303 | "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. |
| 1304 | { |
| 1305 | "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. |
| 1306 | "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. |
| 1307 | }, |
| 1308 | ], |
| 1309 | "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. |
| 1310 | "A String", |
| 1311 | ], |
| 1312 | } |
| 1313 | |
| 1314 | priority: integer, The priority of the rule to patch. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1315 | 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). |
| 1316 | x__xgafv: string, V1 error format. |
| 1317 | Allowed values |
| 1318 | 1 - v1 error format |
| 1319 | 2 - v2 error format |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1320 | |
| 1321 | Returns: |
| 1322 | An object of the form: |
| 1323 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1324 | { # 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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1325 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 1326 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 1327 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 1328 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 1329 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 1330 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| 1331 | { |
| 1332 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 1333 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 1334 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| 1335 | }, |
| 1336 | ], |
| 1337 | }, |
| 1338 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 1339 | "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. |
| 1340 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 1341 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 1342 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1343 | "name": "A String", # [Output Only] Name of the operation. |
| 1344 | "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. |
| 1345 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 1346 | "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. |
| 1347 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 1348 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 1349 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 1350 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 1351 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 1352 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 1353 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 1354 | "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. |
| 1355 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 1356 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 1357 | { |
| 1358 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1359 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1360 | { |
| 1361 | "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). |
| 1362 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 1363 | }, |
| 1364 | ], |
| 1365 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 1366 | }, |
| 1367 | ], |
| 1368 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 1369 | }</pre> |
| 1370 | </div> |
| 1371 | |
| 1372 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1373 | <code class="details" id="removeAssociation">removeAssociation(firewallPolicy, name=None, requestId=None, x__xgafv=None)</code> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1374 | <pre>Removes an association for the specified firewall policy. |
| 1375 | |
| 1376 | Args: |
| 1377 | firewallPolicy: string, Name of the firewall policy to update. (required) |
| 1378 | name: string, Name for the attachment that will be removed. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1379 | 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). |
| 1380 | x__xgafv: string, V1 error format. |
| 1381 | Allowed values |
| 1382 | 1 - v1 error format |
| 1383 | 2 - v2 error format |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1384 | |
| 1385 | Returns: |
| 1386 | An object of the form: |
| 1387 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1388 | { # 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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1389 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 1390 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 1391 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 1392 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 1393 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 1394 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| 1395 | { |
| 1396 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 1397 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 1398 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| 1399 | }, |
| 1400 | ], |
| 1401 | }, |
| 1402 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 1403 | "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. |
| 1404 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 1405 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 1406 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1407 | "name": "A String", # [Output Only] Name of the operation. |
| 1408 | "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. |
| 1409 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 1410 | "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. |
| 1411 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 1412 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 1413 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 1414 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 1415 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 1416 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 1417 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 1418 | "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. |
| 1419 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 1420 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 1421 | { |
| 1422 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1423 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1424 | { |
| 1425 | "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). |
| 1426 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 1427 | }, |
| 1428 | ], |
| 1429 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 1430 | }, |
| 1431 | ], |
| 1432 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 1433 | }</pre> |
| 1434 | </div> |
| 1435 | |
| 1436 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1437 | <code class="details" id="removeRule">removeRule(firewallPolicy, priority=None, requestId=None, x__xgafv=None)</code> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1438 | <pre>Deletes a rule of the specified priority. |
| 1439 | |
| 1440 | Args: |
| 1441 | firewallPolicy: string, Name of the firewall policy to update. (required) |
| 1442 | priority: integer, The priority of the rule to remove from the firewall policy. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1443 | 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). |
| 1444 | x__xgafv: string, V1 error format. |
| 1445 | Allowed values |
| 1446 | 1 - v1 error format |
| 1447 | 2 - v2 error format |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1448 | |
| 1449 | Returns: |
| 1450 | An object of the form: |
| 1451 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1452 | { # 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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1453 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 1454 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 1455 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 1456 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 1457 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 1458 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| 1459 | { |
| 1460 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 1461 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 1462 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| 1463 | }, |
| 1464 | ], |
| 1465 | }, |
| 1466 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 1467 | "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. |
| 1468 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 1469 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 1470 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1471 | "name": "A String", # [Output Only] Name of the operation. |
| 1472 | "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. |
| 1473 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 1474 | "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. |
| 1475 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 1476 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 1477 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 1478 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 1479 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 1480 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 1481 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 1482 | "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. |
| 1483 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 1484 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 1485 | { |
| 1486 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1487 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1488 | { |
| 1489 | "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). |
| 1490 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 1491 | }, |
| 1492 | ], |
| 1493 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 1494 | }, |
| 1495 | ], |
| 1496 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 1497 | }</pre> |
| 1498 | </div> |
| 1499 | |
| 1500 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1501 | <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1502 | <pre>Sets the access control policy on the specified resource. Replaces any existing policy. |
| 1503 | |
| 1504 | Args: |
| 1505 | resource: string, Name or id of the resource for this request. (required) |
| 1506 | body: object, The request body. |
| 1507 | The object takes the form of: |
| 1508 | |
| 1509 | { |
| 1510 | "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. |
| 1511 | { # Associates `members` with a `role`. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1512 | "bindingId": "A String", # This is deprecated and has no effect. Do not use. |
| 1513 | "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 members 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). |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1514 | "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. |
| 1515 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 1516 | "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. |
| 1517 | "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. |
| 1518 | }, |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1519 | "members": [ # Specifies the identities 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, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?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, `my-other-app@appspot.gserviceaccount.com?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, `admins@example.com?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`. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1520 | "A String", |
| 1521 | ], |
| 1522 | "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| 1523 | }, |
| 1524 | ], |
| 1525 | "etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. |
| yoshi-code-bot | 8bb904c | 2021-08-31 00:28:27 -0700 | [diff] [blame] | 1526 | "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` to a single `role`. Members 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:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "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:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com 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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1527 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1528 | { # 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:jose@example.com" ] }, { "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:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1529 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1530 | { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. |
| 1531 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1532 | "A String", |
| 1533 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1534 | "ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1535 | "logType": "A String", # The log type that this config enables. |
| 1536 | }, |
| 1537 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1538 | "exemptedMembers": [ # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1539 | "A String", |
| 1540 | ], |
| 1541 | "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. |
| 1542 | }, |
| 1543 | ], |
| 1544 | "bindings": [ # Associates a list of `members` to 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 member. |
| 1545 | { # Associates `members` with a `role`. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1546 | "bindingId": "A String", # This is deprecated and has no effect. Do not use. |
| 1547 | "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 members 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). |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1548 | "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. |
| 1549 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 1550 | "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. |
| 1551 | "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. |
| 1552 | }, |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1553 | "members": [ # Specifies the identities 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, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?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, `my-other-app@appspot.gserviceaccount.com?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, `admins@example.com?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`. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1554 | "A String", |
| 1555 | ], |
| 1556 | "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| 1557 | }, |
| 1558 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1559 | "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. |
| 1560 | "iamOwned": True or False, # This is deprecated and has no effect. Do not use. |
| 1561 | "rules": [ # This is deprecated and has no effect. Do not use. |
| 1562 | { # This is deprecated and has no effect. Do not use. |
| 1563 | "action": "A String", # This is deprecated and has no effect. Do not use. |
| 1564 | "conditions": [ # This is deprecated and has no effect. Do not use. |
| 1565 | { # This is deprecated and has no effect. Do not use. |
| 1566 | "iam": "A String", # This is deprecated and has no effect. Do not use. |
| 1567 | "op": "A String", # This is deprecated and has no effect. Do not use. |
| 1568 | "svc": "A String", # This is deprecated and has no effect. Do not use. |
| 1569 | "sys": "A String", # This is deprecated and has no effect. Do not use. |
| 1570 | "values": [ # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1571 | "A String", |
| 1572 | ], |
| 1573 | }, |
| 1574 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1575 | "description": "A String", # This is deprecated and has no effect. Do not use. |
| 1576 | "ins": [ # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1577 | "A String", |
| 1578 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1579 | "logConfigs": [ # This is deprecated and has no effect. Do not use. |
| 1580 | { # This is deprecated and has no effect. Do not use. |
| 1581 | "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. |
| 1582 | "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. |
| 1583 | "permissionType": "A String", # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1584 | }, |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1585 | "logName": "A String", # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1586 | }, |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1587 | "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. |
| 1588 | "customFields": [ # This is deprecated and has no effect. Do not use. |
| 1589 | { # This is deprecated and has no effect. Do not use. |
| 1590 | "name": "A String", # This is deprecated and has no effect. Do not use. |
| 1591 | "value": "A String", # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1592 | }, |
| 1593 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1594 | "field": "A String", # This is deprecated and has no effect. Do not use. |
| 1595 | "metric": "A String", # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1596 | }, |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1597 | "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. |
| 1598 | "logMode": "A String", # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1599 | }, |
| 1600 | }, |
| 1601 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1602 | "notIns": [ # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1603 | "A String", |
| 1604 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1605 | "permissions": [ # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1606 | "A String", |
| 1607 | ], |
| 1608 | }, |
| 1609 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1610 | "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). |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1611 | }, |
| 1612 | } |
| 1613 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1614 | x__xgafv: string, V1 error format. |
| 1615 | Allowed values |
| 1616 | 1 - v1 error format |
| 1617 | 2 - v2 error format |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1618 | |
| 1619 | Returns: |
| 1620 | An object of the form: |
| 1621 | |
| yoshi-code-bot | 8bb904c | 2021-08-31 00:28:27 -0700 | [diff] [blame] | 1622 | { # 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` to a single `role`. Members 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:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "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:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com 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/). |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1623 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1624 | { # 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:jose@example.com" ] }, { "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:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1625 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1626 | { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. |
| 1627 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1628 | "A String", |
| 1629 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1630 | "ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1631 | "logType": "A String", # The log type that this config enables. |
| 1632 | }, |
| 1633 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1634 | "exemptedMembers": [ # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1635 | "A String", |
| 1636 | ], |
| 1637 | "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. |
| 1638 | }, |
| 1639 | ], |
| 1640 | "bindings": [ # Associates a list of `members` to 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 member. |
| 1641 | { # Associates `members` with a `role`. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1642 | "bindingId": "A String", # This is deprecated and has no effect. Do not use. |
| 1643 | "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 members 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). |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1644 | "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. |
| 1645 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 1646 | "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. |
| 1647 | "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. |
| 1648 | }, |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1649 | "members": [ # Specifies the identities 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, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?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, `my-other-app@appspot.gserviceaccount.com?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, `admins@example.com?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`. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1650 | "A String", |
| 1651 | ], |
| 1652 | "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| 1653 | }, |
| 1654 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1655 | "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. |
| 1656 | "iamOwned": True or False, # This is deprecated and has no effect. Do not use. |
| 1657 | "rules": [ # This is deprecated and has no effect. Do not use. |
| 1658 | { # This is deprecated and has no effect. Do not use. |
| 1659 | "action": "A String", # This is deprecated and has no effect. Do not use. |
| 1660 | "conditions": [ # This is deprecated and has no effect. Do not use. |
| 1661 | { # This is deprecated and has no effect. Do not use. |
| 1662 | "iam": "A String", # This is deprecated and has no effect. Do not use. |
| 1663 | "op": "A String", # This is deprecated and has no effect. Do not use. |
| 1664 | "svc": "A String", # This is deprecated and has no effect. Do not use. |
| 1665 | "sys": "A String", # This is deprecated and has no effect. Do not use. |
| 1666 | "values": [ # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1667 | "A String", |
| 1668 | ], |
| 1669 | }, |
| 1670 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1671 | "description": "A String", # This is deprecated and has no effect. Do not use. |
| 1672 | "ins": [ # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1673 | "A String", |
| 1674 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1675 | "logConfigs": [ # This is deprecated and has no effect. Do not use. |
| 1676 | { # This is deprecated and has no effect. Do not use. |
| 1677 | "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. |
| 1678 | "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. |
| 1679 | "permissionType": "A String", # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1680 | }, |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1681 | "logName": "A String", # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1682 | }, |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1683 | "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. |
| 1684 | "customFields": [ # This is deprecated and has no effect. Do not use. |
| 1685 | { # This is deprecated and has no effect. Do not use. |
| 1686 | "name": "A String", # This is deprecated and has no effect. Do not use. |
| 1687 | "value": "A String", # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1688 | }, |
| 1689 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1690 | "field": "A String", # This is deprecated and has no effect. Do not use. |
| 1691 | "metric": "A String", # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1692 | }, |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1693 | "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. |
| 1694 | "logMode": "A String", # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1695 | }, |
| 1696 | }, |
| 1697 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1698 | "notIns": [ # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1699 | "A String", |
| 1700 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1701 | "permissions": [ # This is deprecated and has no effect. Do not use. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1702 | "A String", |
| 1703 | ], |
| 1704 | }, |
| 1705 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1706 | "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). |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1707 | }</pre> |
| 1708 | </div> |
| 1709 | |
| 1710 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1711 | <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1712 | <pre>Returns permissions that a caller has on the specified resource. |
| 1713 | |
| 1714 | Args: |
| 1715 | resource: string, Name or id of the resource for this request. (required) |
| 1716 | body: object, The request body. |
| 1717 | The object takes the form of: |
| 1718 | |
| 1719 | { |
| 1720 | "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. |
| 1721 | "A String", |
| 1722 | ], |
| 1723 | } |
| 1724 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 1725 | x__xgafv: string, V1 error format. |
| 1726 | Allowed values |
| 1727 | 1 - v1 error format |
| 1728 | 2 - v2 error format |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1729 | |
| 1730 | Returns: |
| 1731 | An object of the form: |
| 1732 | |
| 1733 | { |
| 1734 | "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. |
| 1735 | "A String", |
| 1736 | ], |
| 1737 | }</pre> |
| 1738 | </div> |
| 1739 | |
| 1740 | </body></html> |