project STRING Required

Project ID for this request

region STRING Required

Name of the region scoping this request

requestId STRING

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)

IPAddress STRING

The IP address that this forwarding rule is serving on behalf of.

Addresses are restricted based on the forwarding rule's load balancing scheme (EXTERNAL or INTERNAL) and scope (global or regional).

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.

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.

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.

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:

• 100.1.2.3
• https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address
• projects/project/regions/region/addresses/address
• regions/region/addresses/address
• global/addresses/address
• address

IPProtocol ENUMERATION

The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.

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

allPorts BOOLEAN

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.

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

backendService STRING

This field is only used for INTERNAL load balancing.

For internal load balancing, this field identifies the BackendService resource to receive the matched traffic

creationTimestamp STRING

[Output Only] Creation timestamp in RFC3339 text format

description STRING

An optional description of this resource. Provide this property when you create the resource

id INTEGER

[Output Only] The unique identifier for the resource. This identifier is defined by the server

ipVersion ENUMERATION

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

kind STRING

[Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources

loadBalancingScheme ENUMERATION

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)

name 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

network STRING

This field is not used for external load balancing.

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

networkTier ENUMERATION

This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD.

For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM.

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

portRange STRING

This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance.

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.

Some types of forwarding target have constraints on the acceptable ports:

• TargetHttpProxy: 80, 8080
• TargetHttpsProxy: 443
• TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222
• TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222
• TargetVpnGateway: 500, 4500

ports[] STRING

region 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

selfLink STRING

[Output Only] Server-defined URL for the resource

serviceLabel 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.

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.

This field is only used for internal load balancing

serviceName STRING

[Output Only] The internal fully qualified service name for this Forwarding Rule.

This field is only used for internal load balancing

subnetwork STRING

This field is only used for INTERNAL load balancing.

For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule.

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

target 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

clientOperationId STRING

[Output Only] The value of requestId if you provided it in the request. Not present otherwise

creationTimestamp STRING

[Deprecated] This field is deprecated

description STRING

[Output Only] A textual description of the operation, which is set when the operation is created

endTime STRING

[Output Only] The time that this operation was completed. This value is in RFC3339 text format

error OBJECT

[Output Only] If errors are generated during processing of the operation, this field will be populated

error.errors[] OBJECT

error.errors[].code STRING

[Output Only] The error type identifier for this error

error.errors[].location STRING

[Output Only] Indicates the field in the request that caused the error. This property is optional

error.errors[].message STRING

[Output Only] An optional, human-readable error message

httpErrorMessage STRING

[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND

httpErrorStatusCode INTEGER

[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

id INTEGER

[Output Only] The unique identifier for the resource. This identifier is defined by the server

insertTime STRING

[Output Only] The time that this operation was requested. This value is in RFC3339 text format

kind STRING

[Output Only] Type of the resource. Always compute#operation for Operation resources

name STRING

[Output Only] Name of the resource

operationType STRING

[Output Only] The type of operation, such as insert, update, or delete, and so on

progress INTEGER

[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

region STRING

[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations

selfLink STRING

[Output Only] Server-defined URL for the resource

startTime STRING

[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format

status ENUMERATION

[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE

statusMessage STRING

[Output Only] An optional textual description of the current status of the operation

targetId INTEGER

[Output Only] The unique target ID, which identifies a specific incarnation of the target resource

targetLink 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

user STRING

[Output Only] User who requested the operation, for example: [email protected]

warnings[] OBJECT

warnings[].code ENUMERATION

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response

warnings[].data[] OBJECT

warnings[].data[].key 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)

warnings[].data[].value STRING

[Output Only] A warning data value corresponding to the key

warnings[].message STRING

[Output Only] A human-readable description of the warning code

zone STRING

[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations