REST Resource: projects.locations.lbRouteExtensions

Resource: LbRouteExtension

LbRouteExtension is a resource that lets you control where traffic is routed to for a given request.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "forwardingRules": [
    string
  ],
  "extensionChains": [
    {
      object (ExtensionChain)
    }
  ],
  "loadBalancingScheme": enum (LoadBalancingScheme),
  "metadata": {
    object
  }
}
Fields
name

string

Required. Identifier. Name of the LbRouteExtension resource in the following format: projects/{project}/locations/{location}/lbRouteExtensions/{lbRouteExtension}.
createTime

string (Timestamp format)

Output only. The timestamp when the resource was created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. The timestamp when the resource was updated.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
description

string

Optional. A human-readable description of the resource.
labels

map (key: string, value: string)

Optional. Set of labels associated with the LbRouteExtension resource.

The format must comply with the requirements for labels for Google Cloud resources.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
forwardingRules[]

string

Required. A list of references to the forwarding rules to which this service extension is attached. At least one forwarding rule is required. Only one LbRouteExtension resource can be associated with a forwarding rule.
extensionChains[]

object (ExtensionChain)

Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource.
loadBalancingScheme

enum (LoadBalancingScheme)

Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: INTERNAL_MANAGED, EXTERNAL_MANAGED. For more information, refer to Backend services overview.
metadata

object (Struct format)

Optional. The metadata provided here is included as part of the metadata_context (of type google.protobuf.Struct) in the ProcessingRequest message sent to the extension server.

The metadata applies to all extensions in all extensions chains in this resource.

The metadata is available under the key com.google.lb_route_extension.<resourceName>.

The following variables are supported in the metadata:

{forwarding_rule_id} - substituted with the forwarding rule's fully qualified resource name.

This field must not be set if at least one of the extension chains contains plugin extensions. Setting it results in a validation error.

You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend.

Methods

create

 Creates a new LbRouteExtension resource in a given project and location.

delete

 Deletes the specified LbRouteExtension resource.

get

 Gets details of the specified LbRouteExtension resource.

list

 Lists LbRouteExtension resources in a given project and location.

patch

 Updates the parameters of the specified LbRouteExtension resource.