1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.securityPolicies.html">securityPolicies</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#addRule">addRule(project, securityPolicy, body)</a></code></p> 79<p class="firstline">Inserts a rule into a security policy.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(project, securityPolicy, requestId=None)</a></code></p> 82<p class="firstline">Deletes the specified policy.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(project, securityPolicy)</a></code></p> 85<p class="firstline">List all of the ordered rules present in a single specified policy.</p> 86<p class="toc_element"> 87 <code><a href="#getRule">getRule(project, securityPolicy, priority=None)</a></code></p> 88<p class="firstline">Gets a rule at the specified priority.</p> 89<p class="toc_element"> 90 <code><a href="#insert">insert(project, body, requestId=None)</a></code></p> 91<p class="firstline">Creates a new policy in the specified project using the data included in the request.</p> 92<p class="toc_element"> 93 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 94<p class="firstline">List all the policies that have been configured for the specified project.</p> 95<p class="toc_element"> 96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 97<p class="firstline">Retrieves the next page of results.</p> 98<p class="toc_element"> 99 <code><a href="#patch">patch(project, securityPolicy, body, requestId=None)</a></code></p> 100<p class="firstline">Patches the specified policy with the data included in the request.</p> 101<p class="toc_element"> 102 <code><a href="#patchRule">patchRule(project, securityPolicy, body, priority=None)</a></code></p> 103<p class="firstline">Patches a rule at the specified priority.</p> 104<p class="toc_element"> 105 <code><a href="#removeRule">removeRule(project, securityPolicy, priority=None)</a></code></p> 106<p class="firstline">Deletes a rule at the specified priority.</p> 107<h3>Method Details</h3> 108<div class="method"> 109 <code class="details" id="addRule">addRule(project, securityPolicy, body)</code> 110 <pre>Inserts a rule into a security policy. 111 112Args: 113 project: string, Project ID for this request. (required) 114 securityPolicy: string, Name of the security policy to update. (required) 115 body: object, The request body. (required) 116 The object takes the form of: 117 118{ # 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). 119 "kind": "compute#securityPolicyRule", # [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules 120 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 121 "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. 122 "action": "A String", # The Action to preform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502. 123 "preview": True or False, # If set to true, the specified action is not enforced. 124 "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. 125 "config": { # The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified. 126 "srcIpRanges": [ # CIDR IP address range. 127 "A String", 128 ], 129 }, 130 "versionedExpr": "A String", # Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config. 131 }, 132} 133 134 135Returns: 136 An object of the form: 137 138 { # Represents an Operation resource. 139 # 140 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 141 # 142 # Operations can be global, regional or zonal. 143 # - For global operations, use the globalOperations resource. 144 # - For regional operations, use the regionOperations resource. 145 # - For zonal operations, use the zonalOperations resource. 146 # 147 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 148 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 149 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 150 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 151 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 152 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 153 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 154 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 155 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 156 "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. 157 "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. 158 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 159 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 160 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 161 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 162 { 163 "message": "A String", # [Output Only] A human-readable description of the warning code. 164 "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. 165 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 166 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 167 { 168 "value": "A String", # [Output Only] A warning data value corresponding to the key. 169 "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). 170 }, 171 ], 172 }, 173 ], 174 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 175 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 176 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 177 "name": "A String", # [Output Only] Name of the resource. 178 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 179 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 180 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 181 { 182 "message": "A String", # [Output Only] An optional, human-readable error message. 183 "code": "A String", # [Output Only] The error type identifier for this error. 184 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 185 }, 186 ], 187 }, 188 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 189 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 190 "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. 191 }</pre> 192</div> 193 194<div class="method"> 195 <code class="details" id="delete">delete(project, securityPolicy, requestId=None)</code> 196 <pre>Deletes the specified policy. 197 198Args: 199 project: string, Project ID for this request. (required) 200 securityPolicy: string, Name of the security policy to delete. (required) 201 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. 202 203For 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. 204 205The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 206 207Returns: 208 An object of the form: 209 210 { # Represents an Operation resource. 211 # 212 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 213 # 214 # Operations can be global, regional or zonal. 215 # - For global operations, use the globalOperations resource. 216 # - For regional operations, use the regionOperations resource. 217 # - For zonal operations, use the zonalOperations resource. 218 # 219 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 220 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 221 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 222 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 223 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 224 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 225 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 226 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 227 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 228 "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. 229 "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. 230 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 231 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 232 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 233 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 234 { 235 "message": "A String", # [Output Only] A human-readable description of the warning code. 236 "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. 237 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 238 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 239 { 240 "value": "A String", # [Output Only] A warning data value corresponding to the key. 241 "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). 242 }, 243 ], 244 }, 245 ], 246 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 247 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 248 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 249 "name": "A String", # [Output Only] Name of the resource. 250 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 251 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 252 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 253 { 254 "message": "A String", # [Output Only] An optional, human-readable error message. 255 "code": "A String", # [Output Only] The error type identifier for this error. 256 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 257 }, 258 ], 259 }, 260 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 261 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 262 "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. 263 }</pre> 264</div> 265 266<div class="method"> 267 <code class="details" id="get">get(project, securityPolicy)</code> 268 <pre>List all of the ordered rules present in a single specified policy. 269 270Args: 271 project: string, Project ID for this request. (required) 272 securityPolicy: string, Name of the security policy to get. (required) 273 274Returns: 275 An object of the form: 276 277 { # A security policy is comprised of one or more rules. It can also be associated with one or more 'targets'. (== resource_for v1.securityPolicies ==) (== resource_for beta.securityPolicies ==) 278 "kind": "compute#securityPolicy", # [Output only] Type of the resource. Always compute#securityPolicyfor security policies 279 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 280 "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 security policy, a default rule with action "allow" will be added. 281 { # 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). 282 "kind": "compute#securityPolicyRule", # [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules 283 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 284 "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. 285 "action": "A String", # The Action to preform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502. 286 "preview": True or False, # If set to true, the specified action is not enforced. 287 "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. 288 "config": { # The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified. 289 "srcIpRanges": [ # CIDR IP address range. 290 "A String", 291 ], 292 }, 293 "versionedExpr": "A String", # Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config. 294 }, 295 }, 296 ], 297 "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. 298 # 299 # To see the latest fingerprint, make get() request to the security policy. 300 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 301 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 302 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 303 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 304 }</pre> 305</div> 306 307<div class="method"> 308 <code class="details" id="getRule">getRule(project, securityPolicy, priority=None)</code> 309 <pre>Gets a rule at the specified priority. 310 311Args: 312 project: string, Project ID for this request. (required) 313 securityPolicy: string, Name of the security policy to which the queried rule belongs. (required) 314 priority: integer, The priority of the rule to get from the security policy. 315 316Returns: 317 An object of the form: 318 319 { # 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). 320 "kind": "compute#securityPolicyRule", # [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules 321 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 322 "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. 323 "action": "A String", # The Action to preform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502. 324 "preview": True or False, # If set to true, the specified action is not enforced. 325 "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. 326 "config": { # The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified. 327 "srcIpRanges": [ # CIDR IP address range. 328 "A String", 329 ], 330 }, 331 "versionedExpr": "A String", # Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config. 332 }, 333 }</pre> 334</div> 335 336<div class="method"> 337 <code class="details" id="insert">insert(project, body, requestId=None)</code> 338 <pre>Creates a new policy in the specified project using the data included in the request. 339 340Args: 341 project: string, Project ID for this request. (required) 342 body: object, The request body. (required) 343 The object takes the form of: 344 345{ # A security policy is comprised of one or more rules. It can also be associated with one or more 'targets'. (== resource_for v1.securityPolicies ==) (== resource_for beta.securityPolicies ==) 346 "kind": "compute#securityPolicy", # [Output only] Type of the resource. Always compute#securityPolicyfor security policies 347 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 348 "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 security policy, a default rule with action "allow" will be added. 349 { # 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). 350 "kind": "compute#securityPolicyRule", # [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules 351 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 352 "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. 353 "action": "A String", # The Action to preform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502. 354 "preview": True or False, # If set to true, the specified action is not enforced. 355 "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. 356 "config": { # The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified. 357 "srcIpRanges": [ # CIDR IP address range. 358 "A String", 359 ], 360 }, 361 "versionedExpr": "A String", # Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config. 362 }, 363 }, 364 ], 365 "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. 366 # 367 # To see the latest fingerprint, make get() request to the security policy. 368 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 369 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 370 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 371 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 372} 373 374 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. 375 376For 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. 377 378The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 379 380Returns: 381 An object of the form: 382 383 { # Represents an Operation resource. 384 # 385 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 386 # 387 # Operations can be global, regional or zonal. 388 # - For global operations, use the globalOperations resource. 389 # - For regional operations, use the regionOperations resource. 390 # - For zonal operations, use the zonalOperations resource. 391 # 392 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 393 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 394 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 395 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 396 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 397 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 398 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 399 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 400 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 401 "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. 402 "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. 403 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 404 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 405 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 406 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 407 { 408 "message": "A String", # [Output Only] A human-readable description of the warning code. 409 "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. 410 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 411 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 412 { 413 "value": "A String", # [Output Only] A warning data value corresponding to the key. 414 "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). 415 }, 416 ], 417 }, 418 ], 419 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 420 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 421 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 422 "name": "A String", # [Output Only] Name of the resource. 423 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 424 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 425 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 426 { 427 "message": "A String", # [Output Only] An optional, human-readable error message. 428 "code": "A String", # [Output Only] The error type identifier for this error. 429 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 430 }, 431 ], 432 }, 433 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 434 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 435 "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. 436 }</pre> 437</div> 438 439<div class="method"> 440 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 441 <pre>List all the policies that have been configured for the specified project. 442 443Args: 444 project: string, Project ID for this request. (required) 445 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 446 447You 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. 448 449Currently, only sorting by name or creationTimestamp desc is supported. 450 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) 451 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. 452 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 <. 453 454For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. 455 456You 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. 457 458To 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). 459 460Returns: 461 An object of the form: 462 463 { 464 "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. 465 "items": [ # A list of SecurityPolicy resources. 466 { # A security policy is comprised of one or more rules. It can also be associated with one or more 'targets'. (== resource_for v1.securityPolicies ==) (== resource_for beta.securityPolicies ==) 467 "kind": "compute#securityPolicy", # [Output only] Type of the resource. Always compute#securityPolicyfor security policies 468 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 469 "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 security policy, a default rule with action "allow" will be added. 470 { # 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). 471 "kind": "compute#securityPolicyRule", # [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules 472 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 473 "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. 474 "action": "A String", # The Action to preform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502. 475 "preview": True or False, # If set to true, the specified action is not enforced. 476 "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. 477 "config": { # The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified. 478 "srcIpRanges": [ # CIDR IP address range. 479 "A String", 480 ], 481 }, 482 "versionedExpr": "A String", # Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config. 483 }, 484 }, 485 ], 486 "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. 487 # 488 # To see the latest fingerprint, make get() request to the security policy. 489 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 490 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 491 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 492 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 493 }, 494 ], 495 "kind": "compute#securityPolicyList", # [Output Only] Type of resource. Always compute#securityPolicyList for listsof securityPolicies 496 "warning": { # [Output Only] Informational warning message. 497 "message": "A String", # [Output Only] A human-readable description of the warning code. 498 "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. 499 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 500 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 501 { 502 "value": "A String", # [Output Only] A warning data value corresponding to the key. 503 "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). 504 }, 505 ], 506 }, 507 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 508 }</pre> 509</div> 510 511<div class="method"> 512 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 513 <pre>Retrieves the next page of results. 514 515Args: 516 previous_request: The request for the previous page. (required) 517 previous_response: The response from the request for the previous page. (required) 518 519Returns: 520 A request object that you can call 'execute()' on to request the next 521 page. Returns None if there are no more items in the collection. 522 </pre> 523</div> 524 525<div class="method"> 526 <code class="details" id="patch">patch(project, securityPolicy, body, requestId=None)</code> 527 <pre>Patches the specified policy with the data included in the request. 528 529Args: 530 project: string, Project ID for this request. (required) 531 securityPolicy: string, Name of the security policy to update. (required) 532 body: object, The request body. (required) 533 The object takes the form of: 534 535{ # A security policy is comprised of one or more rules. It can also be associated with one or more 'targets'. (== resource_for v1.securityPolicies ==) (== resource_for beta.securityPolicies ==) 536 "kind": "compute#securityPolicy", # [Output only] Type of the resource. Always compute#securityPolicyfor security policies 537 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 538 "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 security policy, a default rule with action "allow" will be added. 539 { # 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). 540 "kind": "compute#securityPolicyRule", # [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules 541 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 542 "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. 543 "action": "A String", # The Action to preform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502. 544 "preview": True or False, # If set to true, the specified action is not enforced. 545 "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. 546 "config": { # The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified. 547 "srcIpRanges": [ # CIDR IP address range. 548 "A String", 549 ], 550 }, 551 "versionedExpr": "A String", # Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config. 552 }, 553 }, 554 ], 555 "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. 556 # 557 # To see the latest fingerprint, make get() request to the security policy. 558 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 559 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 560 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 561 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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. 562} 563 564 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. 565 566For 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. 567 568The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 569 570Returns: 571 An object of the form: 572 573 { # Represents an Operation resource. 574 # 575 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 576 # 577 # Operations can be global, regional or zonal. 578 # - For global operations, use the globalOperations resource. 579 # - For regional operations, use the regionOperations resource. 580 # - For zonal operations, use the zonalOperations resource. 581 # 582 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 583 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 584 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 585 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 586 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 587 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 588 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 589 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 590 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 591 "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. 592 "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. 593 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 594 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 595 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 596 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 597 { 598 "message": "A String", # [Output Only] A human-readable description of the warning code. 599 "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. 600 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 601 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 602 { 603 "value": "A String", # [Output Only] A warning data value corresponding to the key. 604 "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). 605 }, 606 ], 607 }, 608 ], 609 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 610 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 611 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 612 "name": "A String", # [Output Only] Name of the resource. 613 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 614 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 615 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 616 { 617 "message": "A String", # [Output Only] An optional, human-readable error message. 618 "code": "A String", # [Output Only] The error type identifier for this error. 619 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 620 }, 621 ], 622 }, 623 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 624 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 625 "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. 626 }</pre> 627</div> 628 629<div class="method"> 630 <code class="details" id="patchRule">patchRule(project, securityPolicy, body, priority=None)</code> 631 <pre>Patches a rule at the specified priority. 632 633Args: 634 project: string, Project ID for this request. (required) 635 securityPolicy: string, Name of the security policy to update. (required) 636 body: object, The request body. (required) 637 The object takes the form of: 638 639{ # 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). 640 "kind": "compute#securityPolicyRule", # [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules 641 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 642 "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. 643 "action": "A String", # The Action to preform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502. 644 "preview": True or False, # If set to true, the specified action is not enforced. 645 "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. 646 "config": { # The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified. 647 "srcIpRanges": [ # CIDR IP address range. 648 "A String", 649 ], 650 }, 651 "versionedExpr": "A String", # Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config. 652 }, 653} 654 655 priority: integer, The priority of the rule to patch. 656 657Returns: 658 An object of the form: 659 660 { # Represents an Operation resource. 661 # 662 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 663 # 664 # Operations can be global, regional or zonal. 665 # - For global operations, use the globalOperations resource. 666 # - For regional operations, use the regionOperations resource. 667 # - For zonal operations, use the zonalOperations resource. 668 # 669 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 670 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 671 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 672 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 673 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 674 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 675 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 676 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 677 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 678 "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. 679 "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. 680 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 681 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 682 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 683 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 684 { 685 "message": "A String", # [Output Only] A human-readable description of the warning code. 686 "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. 687 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 688 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 689 { 690 "value": "A String", # [Output Only] A warning data value corresponding to the key. 691 "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). 692 }, 693 ], 694 }, 695 ], 696 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 697 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 698 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 699 "name": "A String", # [Output Only] Name of the resource. 700 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 701 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 702 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 703 { 704 "message": "A String", # [Output Only] An optional, human-readable error message. 705 "code": "A String", # [Output Only] The error type identifier for this error. 706 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 707 }, 708 ], 709 }, 710 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 711 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 712 "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. 713 }</pre> 714</div> 715 716<div class="method"> 717 <code class="details" id="removeRule">removeRule(project, securityPolicy, priority=None)</code> 718 <pre>Deletes a rule at the specified priority. 719 720Args: 721 project: string, Project ID for this request. (required) 722 securityPolicy: string, Name of the security policy to update. (required) 723 priority: integer, The priority of the rule to remove from the security policy. 724 725Returns: 726 An object of the form: 727 728 { # Represents an Operation resource. 729 # 730 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 731 # 732 # Operations can be global, regional or zonal. 733 # - For global operations, use the globalOperations resource. 734 # - For regional operations, use the regionOperations resource. 735 # - For zonal operations, use the zonalOperations resource. 736 # 737 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 738 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 739 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 740 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 741 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 742 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 743 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 744 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 745 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 746 "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. 747 "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. 748 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 749 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 750 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 751 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 752 { 753 "message": "A String", # [Output Only] A human-readable description of the warning code. 754 "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. 755 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 756 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 757 { 758 "value": "A String", # [Output Only] A warning data value corresponding to the key. 759 "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). 760 }, 761 ], 762 }, 763 ], 764 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 765 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 766 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 767 "name": "A String", # [Output Only] Name of the resource. 768 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 769 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 770 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 771 { 772 "message": "A String", # [Output Only] An optional, human-readable error message. 773 "code": "A String", # [Output Only] The error type identifier for this error. 774 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 775 }, 776 ], 777 }, 778 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 779 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 780 "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. 781 }</pre> 782</div> 783 784</body></html>