1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.globalForwardingRules.html">globalForwardingRules</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#delete">delete(project, forwardingRule, requestId=None)</a></code></p> 79<p class="firstline">Deletes the specified GlobalForwardingRule resource.</p> 80<p class="toc_element"> 81 <code><a href="#get">get(project, forwardingRule)</a></code></p> 82<p class="firstline">Returns the specified GlobalForwardingRule resource. Get a list of available forwarding rules by making a list() request.</p> 83<p class="toc_element"> 84 <code><a href="#insert">insert(project, body, requestId=None)</a></code></p> 85<p class="firstline">Creates a GlobalForwardingRule resource in the specified project using the data included in the request.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 88<p class="firstline">Retrieves a list of GlobalForwardingRule resources available to the specified project.</p> 89<p class="toc_element"> 90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 91<p class="firstline">Retrieves the next page of results.</p> 92<p class="toc_element"> 93 <code><a href="#patch">patch(project, forwardingRule, body, requestId=None)</a></code></p> 94<p class="firstline">Updates the specified forwarding rule with the data included in the request. This method supports patch semantics. Currently it only allow to patch network_tier field.</p> 95<p class="toc_element"> 96 <code><a href="#setLabels">setLabels(project, resource, body)</a></code></p> 97<p class="firstline">Sets the labels on the specified resource. To learn more about labels, read the Labeling or Tagging Resources documentation.</p> 98<p class="toc_element"> 99 <code><a href="#setTarget">setTarget(project, forwardingRule, body, requestId=None)</a></code></p> 100<p class="firstline">Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target.</p> 101<p class="toc_element"> 102 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p> 103<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 104<h3>Method Details</h3> 105<div class="method"> 106 <code class="details" id="delete">delete(project, forwardingRule, requestId=None)</code> 107 <pre>Deletes the specified GlobalForwardingRule resource. 108 109Args: 110 project: string, Project ID for this request. (required) 111 forwardingRule: string, Name of the ForwardingRule resource to delete. (required) 112 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 113 114Returns: 115 An object of the form: 116 117 { # An Operation resource, used to manage asynchronous API requests. 118 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 119 "clientOperationId": "A String", # [Output Only] Reserved for future use. 120 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 121 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 122 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 123 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 124 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 125 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 126 "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. 127 "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. 128 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 129 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 130 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 131 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 132 { 133 "message": "A String", # [Output Only] A human-readable description of the warning code. 134 "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. 135 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 136 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 137 { 138 "value": "A String", # [Output Only] A warning data value corresponding to the key. 139 "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). 140 }, 141 ], 142 }, 143 ], 144 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 145 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 146 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 147 "name": "A String", # [Output Only] Name of the resource. 148 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 149 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 150 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 151 { 152 "message": "A String", # [Output Only] An optional, human-readable error message. 153 "code": "A String", # [Output Only] The error type identifier for this error. 154 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 155 }, 156 ], 157 }, 158 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 159 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 160 "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. 161 }</pre> 162</div> 163 164<div class="method"> 165 <code class="details" id="get">get(project, forwardingRule)</code> 166 <pre>Returns the specified GlobalForwardingRule resource. Get a list of available forwarding rules by making a list() request. 167 168Args: 169 project: string, Project ID for this request. (required) 170 forwardingRule: string, Name of the ForwardingRule resource to return. (required) 171 172Returns: 173 An object of the form: 174 175 { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, ports] tuple. 176 "labels": { # Labels to apply to this resource. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. 177 "a_key": "A String", 178 }, 179 "ipVersion": "A String", # The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. This can only be specified for a global forwarding rule. 180 "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) 181 "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. 182 # 183 # When the load balancing scheme is INTERNAL, only TCP and UDP are valid. 184 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 185 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 186 "network": "A String", # This field is not used for external load balancing. 187 # 188 # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. 189 "portRange": "A String", # This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. 190 # 191 # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges. 192 # 193 # Some types of forwarding target have constraints on the acceptable ports: 194 # - TargetHttpProxy: 80, 8080 195 # - TargetHttpsProxy: 443 196 # - TargetSslProxy: 443 197 # - TargetVpnGateway: 500, 4500 198 # - 199 "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. 200 "serviceName": "A String", # [Output Only] The internal fully qualified service name for this Forwarding Rule. 201 # 202 # This field is only used for internal load balancing. 203 "backendService": "A String", # This field is not used for external load balancing. 204 # 205 # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic. 206 "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of. 207 # 208 # For global forwarding rules, the address must be a global IP. For regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IPv4 address from the same scope (global or regional) will be assigned. A regional forwarding rule supports IPv4 only. A global forwarding rule supports either IPv4 or IPv6. 209 # 210 # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule. 211 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 212 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. 213 # 214 # To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. 215 "serviceLabel": "A String", # An optional prefix to the service name for this Forwarding Rule. If specified, will be the first label of the fully qualified service name. 216 # 217 # The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label 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. 218 # 219 # This field is only used for internal load balancing. 220 "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. 221 "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. 222 # 223 # This field is not used for internal load balancing. 224 "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. 225 "networkTier": "A String", # This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , SELECT. If this field is not specified, it is assumed to be PREMIUM. 226 "subnetwork": "A String", # This field is not used for external load balancing. 227 # 228 # For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule. 229 # 230 # If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified. 231 "ports": [ # This field is used along with the backend_service field for internal load balancing. 232 # 233 # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. 234 # 235 # You may specify a maximum of up to 5 ports. 236 "A String", 237 ], 238 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 239 }</pre> 240</div> 241 242<div class="method"> 243 <code class="details" id="insert">insert(project, body, requestId=None)</code> 244 <pre>Creates a GlobalForwardingRule resource in the specified project using the data included in the request. 245 246Args: 247 project: string, Project ID for this request. (required) 248 body: object, The request body. (required) 249 The object takes the form of: 250 251{ # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, ports] tuple. 252 "labels": { # Labels to apply to this resource. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. 253 "a_key": "A String", 254 }, 255 "ipVersion": "A String", # The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. This can only be specified for a global forwarding rule. 256 "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) 257 "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. 258 # 259 # When the load balancing scheme is INTERNAL, only TCP and UDP are valid. 260 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 261 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 262 "network": "A String", # This field is not used for external load balancing. 263 # 264 # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. 265 "portRange": "A String", # This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. 266 # 267 # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges. 268 # 269 # Some types of forwarding target have constraints on the acceptable ports: 270 # - TargetHttpProxy: 80, 8080 271 # - TargetHttpsProxy: 443 272 # - TargetSslProxy: 443 273 # - TargetVpnGateway: 500, 4500 274 # - 275 "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. 276 "serviceName": "A String", # [Output Only] The internal fully qualified service name for this Forwarding Rule. 277 # 278 # This field is only used for internal load balancing. 279 "backendService": "A String", # This field is not used for external load balancing. 280 # 281 # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic. 282 "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of. 283 # 284 # For global forwarding rules, the address must be a global IP. For regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IPv4 address from the same scope (global or regional) will be assigned. A regional forwarding rule supports IPv4 only. A global forwarding rule supports either IPv4 or IPv6. 285 # 286 # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule. 287 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 288 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. 289 # 290 # To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. 291 "serviceLabel": "A String", # An optional prefix to the service name for this Forwarding Rule. If specified, will be the first label of the fully qualified service name. 292 # 293 # The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label 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. 294 # 295 # This field is only used for internal load balancing. 296 "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. 297 "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. 298 # 299 # This field is not used for internal load balancing. 300 "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. 301 "networkTier": "A String", # This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , SELECT. If this field is not specified, it is assumed to be PREMIUM. 302 "subnetwork": "A String", # This field is not used for external load balancing. 303 # 304 # For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule. 305 # 306 # If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified. 307 "ports": [ # This field is used along with the backend_service field for internal load balancing. 308 # 309 # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. 310 # 311 # You may specify a maximum of up to 5 ports. 312 "A String", 313 ], 314 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 315 } 316 317 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 318 319Returns: 320 An object of the form: 321 322 { # An Operation resource, used to manage asynchronous API requests. 323 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 324 "clientOperationId": "A String", # [Output Only] Reserved for future use. 325 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 326 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 327 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 328 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 329 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 330 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 331 "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. 332 "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. 333 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 334 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 335 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 336 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 337 { 338 "message": "A String", # [Output Only] A human-readable description of the warning code. 339 "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. 340 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 341 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 342 { 343 "value": "A String", # [Output Only] A warning data value corresponding to the key. 344 "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). 345 }, 346 ], 347 }, 348 ], 349 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 350 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 351 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 352 "name": "A String", # [Output Only] Name of the resource. 353 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 354 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 355 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 356 { 357 "message": "A String", # [Output Only] An optional, human-readable error message. 358 "code": "A String", # [Output Only] The error type identifier for this error. 359 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 360 }, 361 ], 362 }, 363 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 364 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 365 "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. 366 }</pre> 367</div> 368 369<div class="method"> 370 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 371 <pre>Retrieves a list of GlobalForwardingRule resources available to the specified project. 372 373Args: 374 project: string, Project ID for this request. (required) 375 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 376 377You 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. 378 379Currently, only sorting by name or creationTimestamp desc is supported. 380 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) 381 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. 382 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. 383 384The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. 385 386For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 387 388You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. 389 390To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. 391 392Returns: 393 An object of the form: 394 395 { # Contains a list of ForwardingRule resources. 396 "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. 397 "items": [ # A list of ForwardingRule resources. 398 { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, ports] tuple. 399 "labels": { # Labels to apply to this resource. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. 400 "a_key": "A String", 401 }, 402 "ipVersion": "A String", # The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. This can only be specified for a global forwarding rule. 403 "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) 404 "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. 405 # 406 # When the load balancing scheme is INTERNAL, only TCP and UDP are valid. 407 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 408 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 409 "network": "A String", # This field is not used for external load balancing. 410 # 411 # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. 412 "portRange": "A String", # This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. 413 # 414 # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges. 415 # 416 # Some types of forwarding target have constraints on the acceptable ports: 417 # - TargetHttpProxy: 80, 8080 418 # - TargetHttpsProxy: 443 419 # - TargetSslProxy: 443 420 # - TargetVpnGateway: 500, 4500 421 # - 422 "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. 423 "serviceName": "A String", # [Output Only] The internal fully qualified service name for this Forwarding Rule. 424 # 425 # This field is only used for internal load balancing. 426 "backendService": "A String", # This field is not used for external load balancing. 427 # 428 # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic. 429 "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of. 430 # 431 # For global forwarding rules, the address must be a global IP. For regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IPv4 address from the same scope (global or regional) will be assigned. A regional forwarding rule supports IPv4 only. A global forwarding rule supports either IPv4 or IPv6. 432 # 433 # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule. 434 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 435 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. 436 # 437 # To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. 438 "serviceLabel": "A String", # An optional prefix to the service name for this Forwarding Rule. If specified, will be the first label of the fully qualified service name. 439 # 440 # The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label 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. 441 # 442 # This field is only used for internal load balancing. 443 "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. 444 "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. 445 # 446 # This field is not used for internal load balancing. 447 "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. 448 "networkTier": "A String", # This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , SELECT. If this field is not specified, it is assumed to be PREMIUM. 449 "subnetwork": "A String", # This field is not used for external load balancing. 450 # 451 # For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule. 452 # 453 # If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified. 454 "ports": [ # This field is used along with the backend_service field for internal load balancing. 455 # 456 # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. 457 # 458 # You may specify a maximum of up to 5 ports. 459 "A String", 460 ], 461 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 462 }, 463 ], 464 "kind": "compute#forwardingRuleList", # Type of resource. 465 "id": "A String", # [Output Only] Unique identifier for the resource. Set by the server. 466 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 467 }</pre> 468</div> 469 470<div class="method"> 471 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 472 <pre>Retrieves the next page of results. 473 474Args: 475 previous_request: The request for the previous page. (required) 476 previous_response: The response from the request for the previous page. (required) 477 478Returns: 479 A request object that you can call 'execute()' on to request the next 480 page. Returns None if there are no more items in the collection. 481 </pre> 482</div> 483 484<div class="method"> 485 <code class="details" id="patch">patch(project, forwardingRule, body, requestId=None)</code> 486 <pre>Updates the specified forwarding rule with the data included in the request. This method supports patch semantics. Currently it only allow to patch network_tier field. 487 488Args: 489 project: string, Project ID for this request. (required) 490 forwardingRule: string, Name of the ForwardingRule resource to patch. (required) 491 body: object, The request body. (required) 492 The object takes the form of: 493 494{ # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, ports] tuple. 495 "labels": { # Labels to apply to this resource. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. 496 "a_key": "A String", 497 }, 498 "ipVersion": "A String", # The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. This can only be specified for a global forwarding rule. 499 "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) 500 "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. 501 # 502 # When the load balancing scheme is INTERNAL, only TCP and UDP are valid. 503 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 504 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 505 "network": "A String", # This field is not used for external load balancing. 506 # 507 # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. 508 "portRange": "A String", # This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. 509 # 510 # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges. 511 # 512 # Some types of forwarding target have constraints on the acceptable ports: 513 # - TargetHttpProxy: 80, 8080 514 # - TargetHttpsProxy: 443 515 # - TargetSslProxy: 443 516 # - TargetVpnGateway: 500, 4500 517 # - 518 "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. 519 "serviceName": "A String", # [Output Only] The internal fully qualified service name for this Forwarding Rule. 520 # 521 # This field is only used for internal load balancing. 522 "backendService": "A String", # This field is not used for external load balancing. 523 # 524 # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic. 525 "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of. 526 # 527 # For global forwarding rules, the address must be a global IP. For regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IPv4 address from the same scope (global or regional) will be assigned. A regional forwarding rule supports IPv4 only. A global forwarding rule supports either IPv4 or IPv6. 528 # 529 # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule. 530 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 531 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. 532 # 533 # To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. 534 "serviceLabel": "A String", # An optional prefix to the service name for this Forwarding Rule. If specified, will be the first label of the fully qualified service name. 535 # 536 # The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label 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. 537 # 538 # This field is only used for internal load balancing. 539 "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. 540 "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. 541 # 542 # This field is not used for internal load balancing. 543 "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. 544 "networkTier": "A String", # This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , SELECT. If this field is not specified, it is assumed to be PREMIUM. 545 "subnetwork": "A String", # This field is not used for external load balancing. 546 # 547 # For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule. 548 # 549 # If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified. 550 "ports": [ # This field is used along with the backend_service field for internal load balancing. 551 # 552 # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. 553 # 554 # You may specify a maximum of up to 5 ports. 555 "A String", 556 ], 557 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 558 } 559 560 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 561 562Returns: 563 An object of the form: 564 565 { # An Operation resource, used to manage asynchronous API requests. 566 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 567 "clientOperationId": "A String", # [Output Only] Reserved for future use. 568 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 569 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 570 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 571 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 572 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 573 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 574 "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. 575 "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. 576 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 577 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 578 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 579 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 580 { 581 "message": "A String", # [Output Only] A human-readable description of the warning code. 582 "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. 583 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 584 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 585 { 586 "value": "A String", # [Output Only] A warning data value corresponding to the key. 587 "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). 588 }, 589 ], 590 }, 591 ], 592 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 593 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 594 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 595 "name": "A String", # [Output Only] Name of the resource. 596 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 597 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 598 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 599 { 600 "message": "A String", # [Output Only] An optional, human-readable error message. 601 "code": "A String", # [Output Only] The error type identifier for this error. 602 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 603 }, 604 ], 605 }, 606 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 607 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 608 "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. 609 }</pre> 610</div> 611 612<div class="method"> 613 <code class="details" id="setLabels">setLabels(project, resource, body)</code> 614 <pre>Sets the labels on the specified resource. To learn more about labels, read the Labeling or Tagging Resources documentation. 615 616Args: 617 project: string, Project ID for this request. (required) 618 resource: string, Name of the resource for this request. (required) 619 body: object, The request body. (required) 620 The object takes the form of: 621 622{ 623 "labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a get() request to the resource to get the latest fingerprint. 624 "labels": { # A list of labels to apply for this resource. Each label key & value must 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. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": ""). 625 "a_key": "A String", 626 }, 627 } 628 629 630Returns: 631 An object of the form: 632 633 { # An Operation resource, used to manage asynchronous API requests. 634 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 635 "clientOperationId": "A String", # [Output Only] Reserved for future use. 636 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 637 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 638 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 639 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 640 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 641 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 642 "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. 643 "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. 644 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 645 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 646 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 647 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 648 { 649 "message": "A String", # [Output Only] A human-readable description of the warning code. 650 "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. 651 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 652 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 653 { 654 "value": "A String", # [Output Only] A warning data value corresponding to the key. 655 "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). 656 }, 657 ], 658 }, 659 ], 660 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 661 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 662 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 663 "name": "A String", # [Output Only] Name of the resource. 664 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 665 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 666 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 667 { 668 "message": "A String", # [Output Only] An optional, human-readable error message. 669 "code": "A String", # [Output Only] The error type identifier for this error. 670 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 671 }, 672 ], 673 }, 674 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 675 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 676 "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. 677 }</pre> 678</div> 679 680<div class="method"> 681 <code class="details" id="setTarget">setTarget(project, forwardingRule, body, requestId=None)</code> 682 <pre>Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target. 683 684Args: 685 project: string, Project ID for this request. (required) 686 forwardingRule: string, Name of the ForwardingRule resource in which target is to be set. (required) 687 body: object, The request body. (required) 688 The object takes the form of: 689 690{ 691 "target": "A String", 692 } 693 694 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 695 696Returns: 697 An object of the form: 698 699 { # An Operation resource, used to manage asynchronous API requests. 700 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 701 "clientOperationId": "A String", # [Output Only] Reserved for future use. 702 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 703 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 704 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 705 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 706 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 707 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 708 "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. 709 "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. 710 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 711 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 712 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 713 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 714 { 715 "message": "A String", # [Output Only] A human-readable description of the warning code. 716 "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. 717 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 718 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 719 { 720 "value": "A String", # [Output Only] A warning data value corresponding to the key. 721 "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). 722 }, 723 ], 724 }, 725 ], 726 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 727 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 728 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 729 "name": "A String", # [Output Only] Name of the resource. 730 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 731 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 732 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 733 { 734 "message": "A String", # [Output Only] An optional, human-readable error message. 735 "code": "A String", # [Output Only] The error type identifier for this error. 736 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 737 }, 738 ], 739 }, 740 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 741 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 742 "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. 743 }</pre> 744</div> 745 746<div class="method"> 747 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code> 748 <pre>Returns permissions that a caller has on the specified resource. 749 750Args: 751 project: string, Project ID for this request. (required) 752 resource: string, Name of the resource for this request. (required) 753 body: object, The request body. (required) 754 The object takes the form of: 755 756{ 757 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 758 "A String", 759 ], 760 } 761 762 763Returns: 764 An object of the form: 765 766 { 767 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 768 "A String", 769 ], 770 }</pre> 771</div> 772 773</body></html>