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. Gets 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 and uses the JSON merge patch format and processing rules. Currently, you can only patch the 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 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, 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. 113 114For 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. 115 116The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 117 118Returns: 119 An object of the form: 120 121 { # Represents an Operation resource. 122 # 123 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 124 # 125 # Operations can be global, regional or zonal. 126 # - For global operations, use the globalOperations resource. 127 # - For regional operations, use the regionOperations resource. 128 # - For zonal operations, use the zonalOperations resource. 129 # 130 # 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 ==) 131 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 132 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 133 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 134 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 135 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 136 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 137 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 138 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 139 "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. 140 "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. 141 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 142 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 143 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 144 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 145 { 146 "message": "A String", # [Output Only] A human-readable description of the warning code. 147 "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. 148 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 149 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 150 { 151 "value": "A String", # [Output Only] A warning data value corresponding to the key. 152 "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). 153 }, 154 ], 155 }, 156 ], 157 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 158 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 159 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 160 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 161 "name": "A String", # [Output Only] Name of the resource. 162 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 163 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 164 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 165 { 166 "message": "A String", # [Output Only] An optional, human-readable error message. 167 "code": "A String", # [Output Only] The error type identifier for this error. 168 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 169 }, 170 ], 171 }, 172 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 173 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 174 "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. 175 }</pre> 176</div> 177 178<div class="method"> 179 <code class="details" id="get">get(project, forwardingRule)</code> 180 <pre>Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request. 181 182Args: 183 project: string, Project ID for this request. (required) 184 forwardingRule: string, Name of the ForwardingRule resource to return. (required) 185 186Returns: 187 An object of the form: 188 189 { # 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. (== resource_for beta.forwardingRules ==) (== resource_for v1.forwardingRules ==) (== resource_for beta.globalForwardingRules ==) (== resource_for v1.globalForwardingRules ==) (== resource_for beta.regionForwardingRules ==) (== resource_for v1.regionForwardingRules ==) 190 "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. 191 "a_key": "A String", 192 }, 193 "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 an external global forwarding rule. 194 "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL. The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of INTERNAL_SELF_MANAGED means that this will be used for Internal Global HTTP(S) LB. The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) 195 "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. 196 # 197 # When the load balancing scheme is INTERNAL, only TCP and UDP are valid. When the load balancing scheme is INTERNAL_SELF_MANAGED, only TCPis valid. 198 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 199 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 200 "network": "A String", # This field is not used for external load balancing. 201 # 202 # For INTERNAL and INTERNAL_SELF_MANAGED 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. 203 "portRange": "A String", # This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. 204 # 205 # 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. 206 # 207 # Some types of forwarding target have constraints on the acceptable ports: 208 # - TargetHttpProxy: 80, 8080 209 # - TargetHttpsProxy: 443 210 # - TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 211 # - TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 212 # - TargetVpnGateway: 500, 4500 213 "serviceName": "A String", # [Output Only] The internal fully qualified service name for this Forwarding Rule. 214 # 215 # This field is only used for internal load balancing. 216 "backendService": "A String", # This field is only used for INTERNAL load balancing. 217 # 218 # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic. 219 "metadataFilters": [ # Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. 220 # For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. 221 # metadataFilters specified here can be overridden by those specified in the UrlMap that this ForwardingRule references. 222 # metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. 223 { # Opaque filter criteria used by loadbalancers to restrict routing configuration to a limited set of loadbalancing proxies. Proxies and sidecars involved in loadbalancing would typically present metadata to the loadbalancers which need to match criteria specified here. If a match takes place, the relevant routing configuration is made available to those proxies. 224 # For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. 225 # An example for using metadataFilters would be: if loadbalancing involves Envoys, they will only receive routing configuration when values in metadataFilters match values supplied in <a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/core/base.proto#envoy-api-msg-core-node" Node metadata of their XDS requests to loadbalancers. 226 "filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. 227 # Supported values are: 228 # - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata. 229 # - MATCH_ALL: All filterLabels must have matching labels in the provided metadata. 230 "filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria 231 # This list must not be empty and can have at the most 64 entries. 232 { # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer. 233 "name": "A String", # Name of metadata label. 234 # The name can have a maximum length of 1024 characters and must be at least 1 character long. 235 "value": "A String", # The value of the label must match the specified value. 236 # value can have a maximum length of 1024 characters. 237 }, 238 ], 239 }, 240 ], 241 "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of. 242 # 243 # Addresses are restricted based on the forwarding rule's load balancing scheme (EXTERNAL or INTERNAL) and scope (global or regional). 244 # 245 # When the load balancing scheme is EXTERNAL, for global forwarding rules, the address must be a global IP, and for regional forwarding rules, the address must live in the same region as the forwarding rule. If this field is empty, 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. 246 # 247 # When the load balancing scheme is INTERNAL_SELF_MANAGED, this must be a URL reference to an existing Address resource ( internal regional static IP address), with a purpose of GCE_END_POINT and address_type of INTERNAL. 248 # 249 # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnet configured for the forwarding rule. By default, if this field is empty, an ephemeral internal IP address will be automatically allocated from the IP range of the subnet or network configured for this forwarding rule. 250 # 251 # An address can be specified either by a literal IP address or a URL reference to an existing Address resource. The following examples are all valid: 252 # - 100.1.2.3 253 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address 254 # - projects/project/regions/region/addresses/address 255 # - regions/region/addresses/address 256 # - global/addresses/address 257 # - address 258 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 259 "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, otherwise the request will fail with error 412 conditionNotMet. 260 # 261 # To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. 262 "allPorts": True or False, # This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. This field cannot be used with port or portRange fields. 263 # 264 # When the load balancing scheme is INTERNAL and protocol is TCP/UDP, specify this field to allow packets addressed to any ports will be forwarded to the backends configured with this forwarding rule. 265 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 266 "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. 267 # 268 # To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. 269 "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. 270 # 271 # 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. 272 # 273 # This field is only used for internal load balancing. 274 "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. 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 "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 277 "allowGlobalAccess": True or False, # This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If the field is set to TRUE, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer. 278 "networkTier": "A String", # This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD. 279 # 280 # For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. 281 # 282 # If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address. 283 "isMirroringCollector": True or False, # Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL. 284 "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. For INTERNAL_SELF_MANAGED load balancing, only HTTP and HTTPS targets are valid. 285 "subnetwork": "A String", # This field is only used for INTERNAL load balancing. 286 # 287 # For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule. 288 # 289 # 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. 290 "ports": [ # This field is used along with the backend_service field for internal load balancing. 291 # 292 # When the load balancing scheme is INTERNAL, a list of ports can be configured, for example, ['80'], ['8000','9000'] etc. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. 293 # 294 # You may specify a maximum of up to 5 ports. 295 "A String", 296 ], 297 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 298 }</pre> 299</div> 300 301<div class="method"> 302 <code class="details" id="insert">insert(project, body, requestId=None)</code> 303 <pre>Creates a GlobalForwardingRule resource in the specified project using the data included in the request. 304 305Args: 306 project: string, Project ID for this request. (required) 307 body: object, The request body. (required) 308 The object takes the form of: 309 310{ # 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. (== resource_for beta.forwardingRules ==) (== resource_for v1.forwardingRules ==) (== resource_for beta.globalForwardingRules ==) (== resource_for v1.globalForwardingRules ==) (== resource_for beta.regionForwardingRules ==) (== resource_for v1.regionForwardingRules ==) 311 "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. 312 "a_key": "A String", 313 }, 314 "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 an external global forwarding rule. 315 "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL. The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of INTERNAL_SELF_MANAGED means that this will be used for Internal Global HTTP(S) LB. The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) 316 "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. 317 # 318 # When the load balancing scheme is INTERNAL, only TCP and UDP are valid. When the load balancing scheme is INTERNAL_SELF_MANAGED, only TCPis valid. 319 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 320 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 321 "network": "A String", # This field is not used for external load balancing. 322 # 323 # For INTERNAL and INTERNAL_SELF_MANAGED 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. 324 "portRange": "A String", # This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. 325 # 326 # 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. 327 # 328 # Some types of forwarding target have constraints on the acceptable ports: 329 # - TargetHttpProxy: 80, 8080 330 # - TargetHttpsProxy: 443 331 # - TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 332 # - TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 333 # - TargetVpnGateway: 500, 4500 334 "serviceName": "A String", # [Output Only] The internal fully qualified service name for this Forwarding Rule. 335 # 336 # This field is only used for internal load balancing. 337 "backendService": "A String", # This field is only used for INTERNAL load balancing. 338 # 339 # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic. 340 "metadataFilters": [ # Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. 341 # For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. 342 # metadataFilters specified here can be overridden by those specified in the UrlMap that this ForwardingRule references. 343 # metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. 344 { # Opaque filter criteria used by loadbalancers to restrict routing configuration to a limited set of loadbalancing proxies. Proxies and sidecars involved in loadbalancing would typically present metadata to the loadbalancers which need to match criteria specified here. If a match takes place, the relevant routing configuration is made available to those proxies. 345 # For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. 346 # An example for using metadataFilters would be: if loadbalancing involves Envoys, they will only receive routing configuration when values in metadataFilters match values supplied in <a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/core/base.proto#envoy-api-msg-core-node" Node metadata of their XDS requests to loadbalancers. 347 "filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. 348 # Supported values are: 349 # - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata. 350 # - MATCH_ALL: All filterLabels must have matching labels in the provided metadata. 351 "filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria 352 # This list must not be empty and can have at the most 64 entries. 353 { # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer. 354 "name": "A String", # Name of metadata label. 355 # The name can have a maximum length of 1024 characters and must be at least 1 character long. 356 "value": "A String", # The value of the label must match the specified value. 357 # value can have a maximum length of 1024 characters. 358 }, 359 ], 360 }, 361 ], 362 "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of. 363 # 364 # Addresses are restricted based on the forwarding rule's load balancing scheme (EXTERNAL or INTERNAL) and scope (global or regional). 365 # 366 # When the load balancing scheme is EXTERNAL, for global forwarding rules, the address must be a global IP, and for regional forwarding rules, the address must live in the same region as the forwarding rule. If this field is empty, 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. 367 # 368 # When the load balancing scheme is INTERNAL_SELF_MANAGED, this must be a URL reference to an existing Address resource ( internal regional static IP address), with a purpose of GCE_END_POINT and address_type of INTERNAL. 369 # 370 # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnet configured for the forwarding rule. By default, if this field is empty, an ephemeral internal IP address will be automatically allocated from the IP range of the subnet or network configured for this forwarding rule. 371 # 372 # An address can be specified either by a literal IP address or a URL reference to an existing Address resource. The following examples are all valid: 373 # - 100.1.2.3 374 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address 375 # - projects/project/regions/region/addresses/address 376 # - regions/region/addresses/address 377 # - global/addresses/address 378 # - address 379 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 380 "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, otherwise the request will fail with error 412 conditionNotMet. 381 # 382 # To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. 383 "allPorts": True or False, # This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. This field cannot be used with port or portRange fields. 384 # 385 # When the load balancing scheme is INTERNAL and protocol is TCP/UDP, specify this field to allow packets addressed to any ports will be forwarded to the backends configured with this forwarding rule. 386 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 387 "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. 388 # 389 # To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. 390 "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. 391 # 392 # 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. 393 # 394 # This field is only used for internal load balancing. 395 "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. 396 "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. 397 "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 398 "allowGlobalAccess": True or False, # This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If the field is set to TRUE, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer. 399 "networkTier": "A String", # This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD. 400 # 401 # For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. 402 # 403 # If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address. 404 "isMirroringCollector": True or False, # Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL. 405 "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. For INTERNAL_SELF_MANAGED load balancing, only HTTP and HTTPS targets are valid. 406 "subnetwork": "A String", # This field is only used for INTERNAL load balancing. 407 # 408 # For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule. 409 # 410 # 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. 411 "ports": [ # This field is used along with the backend_service field for internal load balancing. 412 # 413 # When the load balancing scheme is INTERNAL, a list of ports can be configured, for example, ['80'], ['8000','9000'] etc. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. 414 # 415 # You may specify a maximum of up to 5 ports. 416 "A String", 417 ], 418 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 419 } 420 421 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. 422 423For 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. 424 425The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 426 427Returns: 428 An object of the form: 429 430 { # Represents an Operation resource. 431 # 432 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 433 # 434 # Operations can be global, regional or zonal. 435 # - For global operations, use the globalOperations resource. 436 # - For regional operations, use the regionOperations resource. 437 # - For zonal operations, use the zonalOperations resource. 438 # 439 # 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 ==) 440 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 441 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 442 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 443 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 444 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 445 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 446 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 447 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 448 "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. 449 "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. 450 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 451 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 452 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 453 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 454 { 455 "message": "A String", # [Output Only] A human-readable description of the warning code. 456 "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. 457 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 458 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 459 { 460 "value": "A String", # [Output Only] A warning data value corresponding to the key. 461 "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). 462 }, 463 ], 464 }, 465 ], 466 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 467 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 468 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 469 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 470 "name": "A String", # [Output Only] Name of the resource. 471 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 472 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 473 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 474 { 475 "message": "A String", # [Output Only] An optional, human-readable error message. 476 "code": "A String", # [Output Only] The error type identifier for this error. 477 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 478 }, 479 ], 480 }, 481 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 482 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 483 "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. 484 }</pre> 485</div> 486 487<div class="method"> 488 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 489 <pre>Retrieves a list of GlobalForwardingRule resources available to the specified project. 490 491Args: 492 project: string, Project ID for this request. (required) 493 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 494 495You 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. 496 497Currently, only sorting by name or creationTimestamp desc is supported. 498 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) 499 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. 500 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 <. 501 502For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. 503 504You 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. 505 506To 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). 507 508Returns: 509 An object of the form: 510 511 { # Contains a list of ForwardingRule resources. 512 "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. 513 "kind": "compute#forwardingRuleList", # Type of resource. 514 "items": [ # A list of ForwardingRule resources. 515 { # 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. (== resource_for beta.forwardingRules ==) (== resource_for v1.forwardingRules ==) (== resource_for beta.globalForwardingRules ==) (== resource_for v1.globalForwardingRules ==) (== resource_for beta.regionForwardingRules ==) (== resource_for v1.regionForwardingRules ==) 516 "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. 517 "a_key": "A String", 518 }, 519 "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 an external global forwarding rule. 520 "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL. The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of INTERNAL_SELF_MANAGED means that this will be used for Internal Global HTTP(S) LB. The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) 521 "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. 522 # 523 # When the load balancing scheme is INTERNAL, only TCP and UDP are valid. When the load balancing scheme is INTERNAL_SELF_MANAGED, only TCPis valid. 524 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 525 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 526 "network": "A String", # This field is not used for external load balancing. 527 # 528 # For INTERNAL and INTERNAL_SELF_MANAGED 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. 529 "portRange": "A String", # This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. 530 # 531 # 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. 532 # 533 # Some types of forwarding target have constraints on the acceptable ports: 534 # - TargetHttpProxy: 80, 8080 535 # - TargetHttpsProxy: 443 536 # - TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 537 # - TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 538 # - TargetVpnGateway: 500, 4500 539 "serviceName": "A String", # [Output Only] The internal fully qualified service name for this Forwarding Rule. 540 # 541 # This field is only used for internal load balancing. 542 "backendService": "A String", # This field is only used for INTERNAL load balancing. 543 # 544 # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic. 545 "metadataFilters": [ # Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. 546 # For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. 547 # metadataFilters specified here can be overridden by those specified in the UrlMap that this ForwardingRule references. 548 # metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. 549 { # Opaque filter criteria used by loadbalancers to restrict routing configuration to a limited set of loadbalancing proxies. Proxies and sidecars involved in loadbalancing would typically present metadata to the loadbalancers which need to match criteria specified here. If a match takes place, the relevant routing configuration is made available to those proxies. 550 # For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. 551 # An example for using metadataFilters would be: if loadbalancing involves Envoys, they will only receive routing configuration when values in metadataFilters match values supplied in <a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/core/base.proto#envoy-api-msg-core-node" Node metadata of their XDS requests to loadbalancers. 552 "filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. 553 # Supported values are: 554 # - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata. 555 # - MATCH_ALL: All filterLabels must have matching labels in the provided metadata. 556 "filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria 557 # This list must not be empty and can have at the most 64 entries. 558 { # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer. 559 "name": "A String", # Name of metadata label. 560 # The name can have a maximum length of 1024 characters and must be at least 1 character long. 561 "value": "A String", # The value of the label must match the specified value. 562 # value can have a maximum length of 1024 characters. 563 }, 564 ], 565 }, 566 ], 567 "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of. 568 # 569 # Addresses are restricted based on the forwarding rule's load balancing scheme (EXTERNAL or INTERNAL) and scope (global or regional). 570 # 571 # When the load balancing scheme is EXTERNAL, for global forwarding rules, the address must be a global IP, and for regional forwarding rules, the address must live in the same region as the forwarding rule. If this field is empty, 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. 572 # 573 # When the load balancing scheme is INTERNAL_SELF_MANAGED, this must be a URL reference to an existing Address resource ( internal regional static IP address), with a purpose of GCE_END_POINT and address_type of INTERNAL. 574 # 575 # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnet configured for the forwarding rule. By default, if this field is empty, an ephemeral internal IP address will be automatically allocated from the IP range of the subnet or network configured for this forwarding rule. 576 # 577 # An address can be specified either by a literal IP address or a URL reference to an existing Address resource. The following examples are all valid: 578 # - 100.1.2.3 579 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address 580 # - projects/project/regions/region/addresses/address 581 # - regions/region/addresses/address 582 # - global/addresses/address 583 # - address 584 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 585 "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, otherwise the request will fail with error 412 conditionNotMet. 586 # 587 # To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. 588 "allPorts": True or False, # This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. This field cannot be used with port or portRange fields. 589 # 590 # When the load balancing scheme is INTERNAL and protocol is TCP/UDP, specify this field to allow packets addressed to any ports will be forwarded to the backends configured with this forwarding rule. 591 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 592 "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. 593 # 594 # To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. 595 "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. 596 # 597 # 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. 598 # 599 # This field is only used for internal load balancing. 600 "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. 601 "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. 602 "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 603 "allowGlobalAccess": True or False, # This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If the field is set to TRUE, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer. 604 "networkTier": "A String", # This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD. 605 # 606 # For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. 607 # 608 # If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address. 609 "isMirroringCollector": True or False, # Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL. 610 "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. For INTERNAL_SELF_MANAGED load balancing, only HTTP and HTTPS targets are valid. 611 "subnetwork": "A String", # This field is only used for INTERNAL load balancing. 612 # 613 # For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule. 614 # 615 # 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. 616 "ports": [ # This field is used along with the backend_service field for internal load balancing. 617 # 618 # When the load balancing scheme is INTERNAL, a list of ports can be configured, for example, ['80'], ['8000','9000'] etc. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. 619 # 620 # You may specify a maximum of up to 5 ports. 621 "A String", 622 ], 623 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 624 }, 625 ], 626 "warning": { # [Output Only] Informational warning message. 627 "message": "A String", # [Output Only] A human-readable description of the warning code. 628 "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. 629 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 630 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 631 { 632 "value": "A String", # [Output Only] A warning data value corresponding to the key. 633 "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). 634 }, 635 ], 636 }, 637 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 638 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 639 }</pre> 640</div> 641 642<div class="method"> 643 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 644 <pre>Retrieves the next page of results. 645 646Args: 647 previous_request: The request for the previous page. (required) 648 previous_response: The response from the request for the previous page. (required) 649 650Returns: 651 A request object that you can call 'execute()' on to request the next 652 page. Returns None if there are no more items in the collection. 653 </pre> 654</div> 655 656<div class="method"> 657 <code class="details" id="patch">patch(project, forwardingRule, body, requestId=None)</code> 658 <pre>Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field. 659 660Args: 661 project: string, Project ID for this request. (required) 662 forwardingRule: string, Name of the ForwardingRule resource to patch. (required) 663 body: object, The request body. (required) 664 The object takes the form of: 665 666{ # 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. (== resource_for beta.forwardingRules ==) (== resource_for v1.forwardingRules ==) (== resource_for beta.globalForwardingRules ==) (== resource_for v1.globalForwardingRules ==) (== resource_for beta.regionForwardingRules ==) (== resource_for v1.regionForwardingRules ==) 667 "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. 668 "a_key": "A String", 669 }, 670 "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 an external global forwarding rule. 671 "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL. The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of INTERNAL_SELF_MANAGED means that this will be used for Internal Global HTTP(S) LB. The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) 672 "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. 673 # 674 # When the load balancing scheme is INTERNAL, only TCP and UDP are valid. When the load balancing scheme is INTERNAL_SELF_MANAGED, only TCPis valid. 675 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 676 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 677 "network": "A String", # This field is not used for external load balancing. 678 # 679 # For INTERNAL and INTERNAL_SELF_MANAGED 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. 680 "portRange": "A String", # This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. 681 # 682 # 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. 683 # 684 # Some types of forwarding target have constraints on the acceptable ports: 685 # - TargetHttpProxy: 80, 8080 686 # - TargetHttpsProxy: 443 687 # - TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 688 # - TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 689 # - TargetVpnGateway: 500, 4500 690 "serviceName": "A String", # [Output Only] The internal fully qualified service name for this Forwarding Rule. 691 # 692 # This field is only used for internal load balancing. 693 "backendService": "A String", # This field is only used for INTERNAL load balancing. 694 # 695 # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic. 696 "metadataFilters": [ # Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. 697 # For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. 698 # metadataFilters specified here can be overridden by those specified in the UrlMap that this ForwardingRule references. 699 # metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. 700 { # Opaque filter criteria used by loadbalancers to restrict routing configuration to a limited set of loadbalancing proxies. Proxies and sidecars involved in loadbalancing would typically present metadata to the loadbalancers which need to match criteria specified here. If a match takes place, the relevant routing configuration is made available to those proxies. 701 # For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. 702 # An example for using metadataFilters would be: if loadbalancing involves Envoys, they will only receive routing configuration when values in metadataFilters match values supplied in <a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/core/base.proto#envoy-api-msg-core-node" Node metadata of their XDS requests to loadbalancers. 703 "filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. 704 # Supported values are: 705 # - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata. 706 # - MATCH_ALL: All filterLabels must have matching labels in the provided metadata. 707 "filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria 708 # This list must not be empty and can have at the most 64 entries. 709 { # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer. 710 "name": "A String", # Name of metadata label. 711 # The name can have a maximum length of 1024 characters and must be at least 1 character long. 712 "value": "A String", # The value of the label must match the specified value. 713 # value can have a maximum length of 1024 characters. 714 }, 715 ], 716 }, 717 ], 718 "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of. 719 # 720 # Addresses are restricted based on the forwarding rule's load balancing scheme (EXTERNAL or INTERNAL) and scope (global or regional). 721 # 722 # When the load balancing scheme is EXTERNAL, for global forwarding rules, the address must be a global IP, and for regional forwarding rules, the address must live in the same region as the forwarding rule. If this field is empty, 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. 723 # 724 # When the load balancing scheme is INTERNAL_SELF_MANAGED, this must be a URL reference to an existing Address resource ( internal regional static IP address), with a purpose of GCE_END_POINT and address_type of INTERNAL. 725 # 726 # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnet configured for the forwarding rule. By default, if this field is empty, an ephemeral internal IP address will be automatically allocated from the IP range of the subnet or network configured for this forwarding rule. 727 # 728 # An address can be specified either by a literal IP address or a URL reference to an existing Address resource. The following examples are all valid: 729 # - 100.1.2.3 730 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address 731 # - projects/project/regions/region/addresses/address 732 # - regions/region/addresses/address 733 # - global/addresses/address 734 # - address 735 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 736 "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, otherwise the request will fail with error 412 conditionNotMet. 737 # 738 # To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. 739 "allPorts": True or False, # This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. This field cannot be used with port or portRange fields. 740 # 741 # When the load balancing scheme is INTERNAL and protocol is TCP/UDP, specify this field to allow packets addressed to any ports will be forwarded to the backends configured with this forwarding rule. 742 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 743 "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. 744 # 745 # To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. 746 "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. 747 # 748 # 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. 749 # 750 # This field is only used for internal load balancing. 751 "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. 752 "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. 753 "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 754 "allowGlobalAccess": True or False, # This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If the field is set to TRUE, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer. 755 "networkTier": "A String", # This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD. 756 # 757 # For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. 758 # 759 # If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address. 760 "isMirroringCollector": True or False, # Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL. 761 "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. For INTERNAL_SELF_MANAGED load balancing, only HTTP and HTTPS targets are valid. 762 "subnetwork": "A String", # This field is only used for INTERNAL load balancing. 763 # 764 # For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule. 765 # 766 # 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. 767 "ports": [ # This field is used along with the backend_service field for internal load balancing. 768 # 769 # When the load balancing scheme is INTERNAL, a list of ports can be configured, for example, ['80'], ['8000','9000'] etc. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. 770 # 771 # You may specify a maximum of up to 5 ports. 772 "A String", 773 ], 774 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 775 } 776 777 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. 778 779For 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. 780 781The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 782 783Returns: 784 An object of the form: 785 786 { # Represents an Operation resource. 787 # 788 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 789 # 790 # Operations can be global, regional or zonal. 791 # - For global operations, use the globalOperations resource. 792 # - For regional operations, use the regionOperations resource. 793 # - For zonal operations, use the zonalOperations resource. 794 # 795 # 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 ==) 796 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 797 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 798 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 799 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 800 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 801 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 802 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 803 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 804 "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. 805 "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. 806 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 807 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 808 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 809 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 810 { 811 "message": "A String", # [Output Only] A human-readable description of the warning code. 812 "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. 813 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 814 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 815 { 816 "value": "A String", # [Output Only] A warning data value corresponding to the key. 817 "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). 818 }, 819 ], 820 }, 821 ], 822 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 823 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 824 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 825 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 826 "name": "A String", # [Output Only] Name of the resource. 827 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 828 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 829 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 830 { 831 "message": "A String", # [Output Only] An optional, human-readable error message. 832 "code": "A String", # [Output Only] The error type identifier for this error. 833 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 834 }, 835 ], 836 }, 837 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 838 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 839 "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. 840 }</pre> 841</div> 842 843<div class="method"> 844 <code class="details" id="setLabels">setLabels(project, resource, body)</code> 845 <pre>Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation. 846 847Args: 848 project: string, Project ID for this request. (required) 849 resource: string, Name or id of the resource for this request. (required) 850 body: object, The request body. (required) 851 The object takes the form of: 852 853{ 854 "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, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint. 855 "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": ""). 856 "a_key": "A String", 857 }, 858 } 859 860 861Returns: 862 An object of the form: 863 864 { # Represents an Operation resource. 865 # 866 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 867 # 868 # Operations can be global, regional or zonal. 869 # - For global operations, use the globalOperations resource. 870 # - For regional operations, use the regionOperations resource. 871 # - For zonal operations, use the zonalOperations resource. 872 # 873 # 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 ==) 874 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 875 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 876 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 877 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 878 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 879 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 880 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 881 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 882 "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. 883 "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. 884 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 885 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 886 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 887 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 888 { 889 "message": "A String", # [Output Only] A human-readable description of the warning code. 890 "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. 891 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 892 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 893 { 894 "value": "A String", # [Output Only] A warning data value corresponding to the key. 895 "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). 896 }, 897 ], 898 }, 899 ], 900 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 901 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 902 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 903 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 904 "name": "A String", # [Output Only] Name of the resource. 905 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 906 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 907 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 908 { 909 "message": "A String", # [Output Only] An optional, human-readable error message. 910 "code": "A String", # [Output Only] The error type identifier for this error. 911 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 912 }, 913 ], 914 }, 915 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 916 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 917 "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. 918 }</pre> 919</div> 920 921<div class="method"> 922 <code class="details" id="setTarget">setTarget(project, forwardingRule, body, requestId=None)</code> 923 <pre>Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target. 924 925Args: 926 project: string, Project ID for this request. (required) 927 forwardingRule: string, Name of the ForwardingRule resource in which target is to be set. (required) 928 body: object, The request body. (required) 929 The object takes the form of: 930 931{ 932 "target": "A String", 933 } 934 935 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. 936 937For 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. 938 939The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 940 941Returns: 942 An object of the form: 943 944 { # Represents an Operation resource. 945 # 946 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 947 # 948 # Operations can be global, regional or zonal. 949 # - For global operations, use the globalOperations resource. 950 # - For regional operations, use the regionOperations resource. 951 # - For zonal operations, use the zonalOperations resource. 952 # 953 # 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 ==) 954 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 955 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 956 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 957 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 958 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 959 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 960 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 961 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 962 "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. 963 "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. 964 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 965 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 966 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 967 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 968 { 969 "message": "A String", # [Output Only] A human-readable description of the warning code. 970 "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. 971 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 972 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 973 { 974 "value": "A String", # [Output Only] A warning data value corresponding to the key. 975 "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). 976 }, 977 ], 978 }, 979 ], 980 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 981 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 982 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 983 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 984 "name": "A String", # [Output Only] Name of the resource. 985 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 986 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 987 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 988 { 989 "message": "A String", # [Output Only] An optional, human-readable error message. 990 "code": "A String", # [Output Only] The error type identifier for this error. 991 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 992 }, 993 ], 994 }, 995 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 996 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 997 "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. 998 }</pre> 999</div> 1000 1001<div class="method"> 1002 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code> 1003 <pre>Returns permissions that a caller has on the specified resource. 1004 1005Args: 1006 project: string, Project ID for this request. (required) 1007 resource: string, Name or id of the resource for this request. (required) 1008 body: object, The request body. (required) 1009 The object takes the form of: 1010 1011{ 1012 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 1013 "A String", 1014 ], 1015 } 1016 1017 1018Returns: 1019 An object of the form: 1020 1021 { 1022 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 1023 "A String", 1024 ], 1025 }</pre> 1026</div> 1027 1028</body></html>