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_beta.html">Compute Engine API</a> . <a href="compute_beta.globalForwardingRules.html">globalForwardingRules</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#delete">delete(project, forwardingRule)</a></code></p> 79<p class="firstline">Deletes the specified GlobalForwardingRule resource.</p> 80<p class="toc_element"> 81 <code><a href="#get">get(project, forwardingRule)</a></code></p> 82<p class="firstline">Returns the specified GlobalForwardingRule resource. Get a list of available forwarding rules by making a list() request.</p> 83<p class="toc_element"> 84 <code><a href="#insert">insert(project, body)</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="#setTarget">setTarget(project, forwardingRule, body)</a></code></p> 94<p class="firstline">Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target.</p> 95<p class="toc_element"> 96 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p> 97<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="delete">delete(project, forwardingRule)</code> 101 <pre>Deletes the specified GlobalForwardingRule resource. 102 103Args: 104 project: string, Project ID for this request. (required) 105 forwardingRule: string, Name of the ForwardingRule resource to delete. (required) 106 107Returns: 108 An object of the form: 109 110 { # An Operation resource, used to manage asynchronous API requests. 111 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 112 "clientOperationId": "A String", # [Output Only] Reserved for future use. 113 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 114 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 115 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 116 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 117 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 118 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 119 "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. 120 "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. 121 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 122 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 123 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 124 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 125 { 126 "message": "A String", # [Output Only] A human-readable description of the warning code. 127 "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. 128 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 129 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 130 { 131 "value": "A String", # [Output Only] A warning data value corresponding to the key. 132 "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). 133 }, 134 ], 135 }, 136 ], 137 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 138 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 139 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 140 "name": "A String", # [Output Only] Name of the resource. 141 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 142 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 143 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 144 { 145 "message": "A String", # [Output Only] An optional, human-readable error message. 146 "code": "A String", # [Output Only] The error type identifier for this error. 147 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 148 }, 149 ], 150 }, 151 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 152 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 153 "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. 154 }</pre> 155</div> 156 157<div class="method"> 158 <code class="details" id="get">get(project, forwardingRule)</code> 159 <pre>Returns the specified GlobalForwardingRule resource. Get a list of available forwarding rules by making a list() request. 160 161Args: 162 project: string, Project ID for this request. (required) 163 forwardingRule: string, Name of the ForwardingRule resource to return. (required) 164 165Returns: 166 An object of the form: 167 168 { # 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. 169 "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. 170 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 171 "serviceName": "A String", # [Output Only] The internal fully qualified service name for this Forwarding Rule. 172 # 173 # This field is only used for internal load balancing. 174 "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. 175 # 176 # 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. 177 # 178 # This field is only used for internal load balancing. 179 "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of. 180 # 181 # For global forwarding rules, the address must be a global IP. For regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IPv4 address from the same scope (global or regional) will be assigned. A regional forwarding rule supports IPv4 only. A global forwarding rule supports either IPv4 or IPv6. 182 # 183 # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule. 184 "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. 185 "ports": [ # This field is used along with the backend_service field for internal load balancing. 186 # 187 # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. 188 # 189 # You may specify a maximum of up to 5 ports. 190 "A String", 191 ], 192 "ipVersion": "A String", # The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. This can only be specified for a global forwarding rule. 193 "network": "A String", # This field is not used for external load balancing. 194 # 195 # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. 196 "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) 197 "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. 198 # 199 # This field is not used for internal load balancing. 200 "portRange": "A String", # This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. 201 # 202 # 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. 203 # 204 # Some types of forwarding target have constraints on the acceptable ports: 205 # - TargetHttpProxy: 80, 8080 206 # - TargetHttpsProxy: 443 207 # - TargetSslProxy: 443 208 # - TargetVpnGateway: 500, 4500 209 # - 210 "backendService": "A String", # This field is not used for external load balancing. 211 # 212 # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic. 213 "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. 214 # 215 # When the load balancing scheme is INTERNAL, only TCP and UDP are valid. 216 "subnetwork": "A String", # This field is not used for external load balancing. 217 # 218 # For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule. 219 # 220 # 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. 221 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 222 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 223 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 224 "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. 225 }</pre> 226</div> 227 228<div class="method"> 229 <code class="details" id="insert">insert(project, body)</code> 230 <pre>Creates a GlobalForwardingRule resource in the specified project using the data included in the request. 231 232Args: 233 project: string, Project ID for this request. (required) 234 body: object, The request body. (required) 235 The object takes the form of: 236 237{ # 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. 238 "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. 239 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 240 "serviceName": "A String", # [Output Only] The internal fully qualified service name for this Forwarding Rule. 241 # 242 # This field is only used for internal load balancing. 243 "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. 244 # 245 # 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. 246 # 247 # This field is only used for internal load balancing. 248 "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of. 249 # 250 # For global forwarding rules, the address must be a global IP. For regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IPv4 address from the same scope (global or regional) will be assigned. A regional forwarding rule supports IPv4 only. A global forwarding rule supports either IPv4 or IPv6. 251 # 252 # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule. 253 "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. 254 "ports": [ # This field is used along with the backend_service field for internal load balancing. 255 # 256 # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. 257 # 258 # You may specify a maximum of up to 5 ports. 259 "A String", 260 ], 261 "ipVersion": "A String", # The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. This can only be specified for a global forwarding rule. 262 "network": "A String", # This field is not used for external load balancing. 263 # 264 # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. 265 "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) 266 "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. 267 # 268 # This field is not used for internal load balancing. 269 "portRange": "A String", # This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. 270 # 271 # 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. 272 # 273 # Some types of forwarding target have constraints on the acceptable ports: 274 # - TargetHttpProxy: 80, 8080 275 # - TargetHttpsProxy: 443 276 # - TargetSslProxy: 443 277 # - TargetVpnGateway: 500, 4500 278 # - 279 "backendService": "A String", # This field is not used for external load balancing. 280 # 281 # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic. 282 "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. 283 # 284 # When the load balancing scheme is INTERNAL, only TCP and UDP are valid. 285 "subnetwork": "A String", # This field is not used for external 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 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 291 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 292 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 293 "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. 294 } 295 296 297Returns: 298 An object of the form: 299 300 { # An Operation resource, used to manage asynchronous API requests. 301 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 302 "clientOperationId": "A String", # [Output Only] Reserved for future use. 303 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 304 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 305 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 306 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 307 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 308 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 309 "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. 310 "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. 311 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 312 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 313 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 314 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 315 { 316 "message": "A String", # [Output Only] A human-readable description of the warning code. 317 "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. 318 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 319 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 320 { 321 "value": "A String", # [Output Only] A warning data value corresponding to the key. 322 "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). 323 }, 324 ], 325 }, 326 ], 327 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 328 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 329 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 330 "name": "A String", # [Output Only] Name of the resource. 331 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 332 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 333 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 334 { 335 "message": "A String", # [Output Only] An optional, human-readable error message. 336 "code": "A String", # [Output Only] The error type identifier for this error. 337 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 338 }, 339 ], 340 }, 341 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 342 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 343 "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. 344 }</pre> 345</div> 346 347<div class="method"> 348 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 349 <pre>Retrieves a list of GlobalForwardingRule resources available to the specified project. 350 351Args: 352 project: string, Project ID for this request. (required) 353 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 354 355You 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. 356 357Currently, only sorting by name or creationTimestamp desc is supported. 358 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) 359 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. 360 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. 361 362The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. 363 364For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 365 366You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. 367 368To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. 369 370Returns: 371 An object of the form: 372 373 { # Contains a list of ForwardingRule resources. 374 "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. 375 "items": [ # A list of ForwardingRule resources. 376 { # 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. 377 "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. 378 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 379 "serviceName": "A String", # [Output Only] The internal fully qualified service name for this Forwarding Rule. 380 # 381 # This field is only used for internal load balancing. 382 "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. 383 # 384 # 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. 385 # 386 # This field is only used for internal load balancing. 387 "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of. 388 # 389 # For global forwarding rules, the address must be a global IP. For regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IPv4 address from the same scope (global or regional) will be assigned. A regional forwarding rule supports IPv4 only. A global forwarding rule supports either IPv4 or IPv6. 390 # 391 # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule. 392 "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. 393 "ports": [ # This field is used along with the backend_service field for internal load balancing. 394 # 395 # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. 396 # 397 # You may specify a maximum of up to 5 ports. 398 "A String", 399 ], 400 "ipVersion": "A String", # The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. This can only be specified for a global forwarding rule. 401 "network": "A String", # This field is not used for external load balancing. 402 # 403 # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. 404 "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) 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. 406 # 407 # This field is not used for internal load balancing. 408 "portRange": "A String", # This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. 409 # 410 # 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. 411 # 412 # Some types of forwarding target have constraints on the acceptable ports: 413 # - TargetHttpProxy: 80, 8080 414 # - TargetHttpsProxy: 443 415 # - TargetSslProxy: 443 416 # - TargetVpnGateway: 500, 4500 417 # - 418 "backendService": "A String", # This field is not used for external load balancing. 419 # 420 # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic. 421 "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. 422 # 423 # When the load balancing scheme is INTERNAL, only TCP and UDP are valid. 424 "subnetwork": "A String", # This field is not used for external load balancing. 425 # 426 # For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule. 427 # 428 # 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. 429 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 430 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 431 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 432 "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. 433 }, 434 ], 435 "kind": "compute#forwardingRuleList", # Type of resource. 436 "id": "A String", # [Output Only] Unique identifier for the resource. Set by the server. 437 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 438 }</pre> 439</div> 440 441<div class="method"> 442 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 443 <pre>Retrieves the next page of results. 444 445Args: 446 previous_request: The request for the previous page. (required) 447 previous_response: The response from the request for the previous page. (required) 448 449Returns: 450 A request object that you can call 'execute()' on to request the next 451 page. Returns None if there are no more items in the collection. 452 </pre> 453</div> 454 455<div class="method"> 456 <code class="details" id="setTarget">setTarget(project, forwardingRule, body)</code> 457 <pre>Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target. 458 459Args: 460 project: string, Project ID for this request. (required) 461 forwardingRule: string, Name of the ForwardingRule resource in which target is to be set. (required) 462 body: object, The request body. (required) 463 The object takes the form of: 464 465{ 466 "target": "A String", 467 } 468 469 470Returns: 471 An object of the form: 472 473 { # An Operation resource, used to manage asynchronous API requests. 474 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 475 "clientOperationId": "A String", # [Output Only] Reserved for future use. 476 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 477 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 478 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 479 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 480 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 481 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 482 "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. 483 "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. 484 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 485 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 486 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 487 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 488 { 489 "message": "A String", # [Output Only] A human-readable description of the warning code. 490 "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. 491 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 492 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 493 { 494 "value": "A String", # [Output Only] A warning data value corresponding to the key. 495 "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). 496 }, 497 ], 498 }, 499 ], 500 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 501 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 502 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 503 "name": "A String", # [Output Only] Name of the resource. 504 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 505 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 506 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 507 { 508 "message": "A String", # [Output Only] An optional, human-readable error message. 509 "code": "A String", # [Output Only] The error type identifier for this error. 510 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 511 }, 512 ], 513 }, 514 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 515 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 516 "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. 517 }</pre> 518</div> 519 520<div class="method"> 521 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code> 522 <pre>Returns permissions that a caller has on the specified resource. 523 524Args: 525 project: string, Project ID for this request. (required) 526 resource: string, Name of the resource for this request. (required) 527 body: object, The request body. (required) 528 The object takes the form of: 529 530{ 531 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 532 "A String", 533 ], 534 } 535 536 537Returns: 538 An object of the form: 539 540 { 541 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 542 "A String", 543 ], 544 }</pre> 545</div> 546 547</body></html>