Network Services V1 API - Class Google::Cloud::NetworkServices::V1::LbRouteExtension (v2.3.0)

Reference documentation and code samples for the Network Services V1 API class Google::Cloud::NetworkServices::V1::LbRouteExtension.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::String) — Optional. A human-readable description of the resource.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. A human-readable description of the resource.
Returns
  • (::String) — Optional. A human-readable description of the resource.

#extension_chains

def extension_chains() -> ::Array<::Google::Cloud::NetworkServices::V1::ExtensionChain>
Returns
  • (::Array<::Google::Cloud::NetworkServices::V1::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.

#extension_chains=

def extension_chains=(value) -> ::Array<::Google::Cloud::NetworkServices::V1::ExtensionChain>
Parameter
  • value (::Array<::Google::Cloud::NetworkServices::V1::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.
Returns
  • (::Array<::Google::Cloud::NetworkServices::V1::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.

#forwarding_rules

def forwarding_rules() -> ::Array<::String>
Returns
  • (::Array<::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.

#forwarding_rules=

def forwarding_rules=(value) -> ::Array<::String>
Parameter
  • value (::Array<::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.
Returns
  • (::Array<::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.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Set of labels associated with the LbRouteExtension resource.

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

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. Set of labels associated with the LbRouteExtension resource.

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

Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Set of labels associated with the LbRouteExtension resource.

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

#load_balancing_scheme

def load_balancing_scheme() -> ::Google::Cloud::NetworkServices::V1::LoadBalancingScheme
Returns

#load_balancing_scheme=

def load_balancing_scheme=(value) -> ::Google::Cloud::NetworkServices::V1::LoadBalancingScheme
Parameter
Returns

#metadata

def metadata() -> ::Google::Protobuf::Struct
Returns
  • (::Google::Protobuf::Struct) — 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.<resource_name>.

    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.

#metadata=

def metadata=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::Google::Protobuf::Struct) — 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.<resource_name>.

    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.

Returns
  • (::Google::Protobuf::Struct) — 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.<resource_name>.

    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.

#name

def name() -> ::String
Returns
  • (::String) — Required. Identifier. Name of the LbRouteExtension resource in the following format: projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Required. Identifier. Name of the LbRouteExtension resource in the following format: projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}.
Returns
  • (::String) — Required. Identifier. Name of the LbRouteExtension resource in the following format: projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns