Class: Google::Cloud::NetworkServices::V1::HttpRoute

Inherits:

Object

• Object
• Google::Cloud::NetworkServices::V1::HttpRoute

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/networkservices/v1/http_route.rb

Overview

HttpRoute is the resource defining how HTTP traffic should be routed by a Mesh or Gateway resource.

Defined Under Namespace

Classes: CorsPolicy, Destination, FaultInjectionPolicy, HeaderMatch, HeaderModifier, LabelsEntry, QueryParameterMatch, Redirect, RequestMirrorPolicy, RetryPolicy, RouteAction, RouteMatch, RouteRule, URLRewrite

Instance Attribute Summary

• #create_time ⇒ ::Google::Protobuf::Timestamp readonly

  Output only.

• #description ⇒ ::String

  Optional.

• #gateways ⇒ ::Array<::String>

  Optional.

• #hostnames ⇒ ::Array<::String>

  Required.

• #labels ⇒ ::Google::Protobuf::Map{::String => ::String}

  Optional.

• #meshes ⇒ ::Array<::String>

  Optional.

• #name ⇒ ::String

  Required.

• #rules ⇒ ::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::RouteRule>

  Required.

• #self_link ⇒ ::String readonly

  Output only.

• #update_time ⇒ ::Google::Protobuf::Timestamp readonly

  Output only.

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The timestamp when the resource was created.

Returns:

• (::Google::Protobuf::Timestamp) —

  Output only. The timestamp when the resource was created.

# File 'proto_docs/google/cloud/networkservices/v1/http_route.rb', line 94

class HttpRoute
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to select a route rule based on HTTP request headers.
  # @!attribute [rw] exact_match
  #   @return [::String]
  #     The value of the header should match exactly the content of
  #     exact_match.
  # @!attribute [rw] regex_match
  #   @return [::String]
  #     The value of the header must match the regular expression specified in
  #     regex_match. For regular expression grammar, please see:
  #     https://github.com/google/re2/wiki/Syntax
  # @!attribute [rw] prefix_match
  #   @return [::String]
  #     The value of the header must start with the contents of prefix_match.
  # @!attribute [rw] present_match
  #   @return [::Boolean]
  #     A header with header_name must exist. The match takes place whether or
  #     not the header has a value.
  # @!attribute [rw] suffix_match
  #   @return [::String]
  #     The value of the header must end with the contents of suffix_match.
  # @!attribute [rw] range_match
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderMatch::IntegerRange]
  #     If specified, the rule will match if the request header value is within
  #     the range.
  # @!attribute [rw] header
  #   @return [::String]
  #     The name of the HTTP header to match against.
  # @!attribute [rw] invert_match
  #   @return [::Boolean]
  #     If specified, the match result will be inverted before checking. Default
  #     value is set to false.
  class HeaderMatch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents an integer value range.
    # @!attribute [rw] start
    #   @return [::Integer]
    #     Start of the range (inclusive)
    # @!attribute [rw] end
    #   @return [::Integer]
    #     End of the range (exclusive)
    class IntegerRange
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Specifications to match a query parameter in the request.
  # @!attribute [rw] exact_match
  #   @return [::String]
  #     The value of the query parameter must exactly match the contents of
  #     exact_match.
  #
  #     Only one of exact_match, regex_match, or present_match must be set.
  # @!attribute [rw] regex_match
  #   @return [::String]
  #     The value of the query parameter must match the regular expression
  #     specified by regex_match. For regular expression grammar, please see
  #     https://github.com/google/re2/wiki/Syntax
  #
  #     Only one of exact_match, regex_match, or present_match must be set.
  # @!attribute [rw] present_match
  #   @return [::Boolean]
  #     Specifies that the QueryParameterMatcher matches if request contains
  #     query parameter, irrespective of whether the parameter has a value or
  #     not.
  #
  #     Only one of exact_match, regex_match, or present_match must be set.
  # @!attribute [rw] query_parameter
  #   @return [::String]
  #     The name of the query parameter to match.
  class QueryParameterMatch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # RouteMatch defines specifications used to match requests. If multiple match
  # types are set, this RouteMatch will match if ALL type of matches are
  # matched.
  # @!attribute [rw] full_path_match
  #   @return [::String]
  #     The HTTP request path value should exactly match this value.
  #
  #     Only one of full_path_match, prefix_match, or regex_match should be
  #     used.
  # @!attribute [rw] prefix_match
  #   @return [::String]
  #     The HTTP request path value must begin with specified prefix_match.
  #     prefix_match must begin with a /.
  #
  #     Only one of full_path_match, prefix_match, or regex_match should be
  #     used.
  # @!attribute [rw] regex_match
  #   @return [::String]
  #     The HTTP request path value must satisfy the regular expression
  #     specified by regex_match after removing any query parameters and anchor
  #     supplied with the original URL. For regular expression grammar, please
  #     see https://github.com/google/re2/wiki/Syntax
  #
  #     Only one of full_path_match, prefix_match, or regex_match should be
  #     used.
  # @!attribute [rw] ignore_case
  #   @return [::Boolean]
  #     Specifies if prefix_match and full_path_match matches are case sensitive.
  #     The default value is false.
  # @!attribute [rw] headers
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderMatch>]
  #     Specifies a list of HTTP request headers to match against. ALL of the
  #     supplied headers must be matched.
  # @!attribute [rw] query_parameters
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::QueryParameterMatch>]
  #     Specifies a list of query parameters to match against. ALL of the query
  #     parameters must be matched.
  class RouteMatch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifications of a destination to which the request should be routed to.
  # @!attribute [rw] service_name
  #   @return [::String]
  #     The URL of a BackendService to route traffic to.
  # @!attribute [rw] weight
  #   @return [::Integer]
  #     Specifies the proportion of requests forwarded to the backend referenced
  #     by the serviceName field. This is computed as:
  #     - weight/Sum(weights in this destination list).
  #     For non-zero values, there may be some epsilon from the exact proportion
  #     defined here depending on the precision an implementation supports.
  #
  #     If only one serviceName is specified and it has a weight greater than 0,
  #     100% of the traffic is forwarded to that backend.
  #
  #     If weights are specified for any one service name, they need to be
  #     specified for all of them.
  #
  #     If weights are unspecified for all services, then, traffic is distributed
  #     in equal proportions to all of them.
  class Destination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specification for redirecting traffic.
  # @!attribute [rw] host_redirect
  #   @return [::String]
  #     The host that will be used in the redirect response instead of the one
  #     that was supplied in the request.
  # @!attribute [rw] path_redirect
  #   @return [::String]
  #     The path that will be used in the redirect response instead of the one
  #     that was supplied in the request.
  #     path_redirect can not be supplied together with prefix_redirect. Supply
  #     one alone or neither. If neither is supplied, the path of the original
  #     request will be used for the redirect.
  # @!attribute [rw] prefix_rewrite
  #   @return [::String]
  #     Indicates that during redirection, the matched prefix (or path) should be
  #     swapped with this value. This option allows URLs be dynamically created
  #     based on the request.
  # @!attribute [rw] response_code
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::Redirect::ResponseCode]
  #     The HTTP Status code to use for the redirect.
  # @!attribute [rw] https_redirect
  #   @return [::Boolean]
  #     If set to true, the URL scheme in the redirected request is set to https.
  #     If set to false, the URL scheme of the redirected request will remain the
  #     same as that of the request.
  #
  #     The default is set to false.
  # @!attribute [rw] strip_query
  #   @return [::Boolean]
  #     if set to true, any accompanying query portion of the original URL is
  #     removed prior to redirecting the request. If set to false, the query
  #     portion of the original URL is retained.
  #
  #     The default is set to false.
  # @!attribute [rw] port_redirect
  #   @return [::Integer]
  #     The port that will be used in the redirected request instead of the one
  #     that was supplied in the request.
  class Redirect
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Supported HTTP response code.
    module ResponseCode
      # Default value
      RESPONSE_CODE_UNSPECIFIED = 0

      # Corresponds to 301.
      MOVED_PERMANENTLY_DEFAULT = 1

      # Corresponds to 302.
      FOUND = 2

      # Corresponds to 303.
      SEE_OTHER = 3

      # Corresponds to 307. In this case, the request method will be retained.
      TEMPORARY_REDIRECT = 4

      # Corresponds to 308. In this case, the request method will be retained.
      PERMANENT_REDIRECT = 5
    end
  end

  # The specification for fault injection introduced into traffic to test the
  # resiliency of clients to destination service failure. As part of fault
  # injection, when clients send requests to a destination, delays can be
  # introduced by client proxy on a percentage of requests before sending those
  # requests to the destination service. Similarly requests can be aborted by
  # client proxy for a percentage of requests.
  # @!attribute [rw] delay
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::FaultInjectionPolicy::Delay]
  #     The specification for injecting delay to client requests.
  # @!attribute [rw] abort
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::FaultInjectionPolicy::Abort]
  #     The specification for aborting to client requests.
  class FaultInjectionPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specification of how client requests are delayed as part of fault
    # injection before being sent to a destination.
    # @!attribute [rw] fixed_delay
    #   @return [::Google::Protobuf::Duration]
    #     Specify a fixed delay before forwarding the request.
    # @!attribute [rw] percentage
    #   @return [::Integer]
    #     The percentage of traffic on which delay will be injected.
    #
    #     The value must be between [0, 100]
    class Delay
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specification of how client requests are aborted as part of fault
    # injection before being sent to a destination.
    # @!attribute [rw] http_status
    #   @return [::Integer]
    #     The HTTP status code used to abort the request.
    #
    #     The value must be between 200 and 599 inclusive.
    # @!attribute [rw] percentage
    #   @return [::Integer]
    #     The percentage of traffic which will be aborted.
    #
    #     The value must be between [0, 100]
    class Abort
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The specification for modifying HTTP header in HTTP request and HTTP
  # response.
  # @!attribute [rw] set
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Completely overwrite/replace the headers with given map where key is the
  #     name of the header, value is the value of the header.
  # @!attribute [rw] add
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Add the headers with given map where key is the name of the header, value
  #     is the value of the header.
  # @!attribute [rw] remove
  #   @return [::Array<::String>]
  #     Remove headers (matching by header names) specified in the list.
  class HeaderModifier
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class SetEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class AddEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The specification for modifying the URL of the request, prior to forwarding
  # the request to the destination.
  # @!attribute [rw] path_prefix_rewrite
  #   @return [::String]
  #     Prior to forwarding the request to the selected destination, the matching
  #     portion of the requests path is replaced by this value.
  # @!attribute [rw] host_rewrite
  #   @return [::String]
  #     Prior to forwarding the request to the selected destination, the requests
  #     host header is replaced by this value.
  class URLRewrite
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specifications for retries.
  # @!attribute [rw] retry_conditions
  #   @return [::Array<::String>]
  #     Specifies one or more conditions when this retry policy applies. Valid
  #     values are:
  #       5xx: Proxy will attempt a retry if the destination service responds
  #         with any 5xx response code, of if the destination service does not
  #         respond at all, example: disconnect, reset, read timeout, connection
  #         failure and refused streams.
  #
  #       gateway-error: Similar to 5xx, but only applies to response codes 502,
  #         503, 504.
  #
  #       reset: Proxy will attempt a retry if the destination service does not
  #         respond at all (disconnect/reset/read timeout)
  #
  #       connect-failure: Proxy will retry on failures connecting to destination
  #         for example due to connection timeouts.
  #
  #       retriable-4xx: Proxy will retry fro retriable 4xx response codes.
  #         Currently the only retriable error supported is 409.
  #
  #       refused-stream: Proxy will retry if the destination resets the stream
  #         with a REFUSED_STREAM error code. This reset type indicates that it
  #         is safe to retry.
  # @!attribute [rw] num_retries
  #   @return [::Integer]
  #     Specifies the allowed number of retries. This number must be > 0. If not
  #     specified, default to 1.
  # @!attribute [rw] per_try_timeout
  #   @return [::Google::Protobuf::Duration]
  #     Specifies a non-zero timeout per retry attempt.
  class RetryPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the policy on how requests are shadowed to a separate mirrored
  # destination service. The proxy does not wait for responses from the
  # shadow service. Prior to sending traffic to the shadow service, the
  # host/authority header is suffixed with -shadow.
  # @!attribute [rw] destination
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::Destination]
  #     The destination the requests will be mirrored to. The weight of the
  #     destination will be ignored.
  class RequestMirrorPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Specification for allowing client side cross-origin requests.
  # @!attribute [rw] allow_origins
  #   @return [::Array<::String>]
  #     Specifies the list of origins that will be allowed to do CORS requests.
  #     An origin is allowed if it matches either an item in allow_origins or
  #     an item in allow_origin_regexes.
  # @!attribute [rw] allow_origin_regexes
  #   @return [::Array<::String>]
  #     Specifies the regular expression patterns that match allowed origins. For
  #     regular expression grammar, please see
  #     https://github.com/google/re2/wiki/Syntax.
  # @!attribute [rw] allow_methods
  #   @return [::Array<::String>]
  #     Specifies the content for Access-Control-Allow-Methods header.
  # @!attribute [rw] allow_headers
  #   @return [::Array<::String>]
  #     Specifies the content for Access-Control-Allow-Headers header.
  # @!attribute [rw] expose_headers
  #   @return [::Array<::String>]
  #     Specifies the content for Access-Control-Expose-Headers header.
  # @!attribute [rw] max_age
  #   @return [::String]
  #     Specifies how long result of a preflight request can be cached in
  #     seconds. This translates to the Access-Control-Max-Age header.
  # @!attribute [rw] allow_credentials
  #   @return [::Boolean]
  #     In response to a preflight request, setting this to true indicates that
  #     the actual request can include user credentials. This translates to the
  #     Access-Control-Allow-Credentials header.
  #
  #     Default value is false.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     If true, the CORS policy is disabled. The default value is false, which
  #     indicates that the CORS policy is in effect.
  class CorsPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specifications for routing traffic and applying associated policies.
  # @!attribute [rw] destinations
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::Destination>]
  #     The destination to which traffic should be forwarded.
  # @!attribute [rw] redirect
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::Redirect]
  #     If set, the request is directed as configured by this field.
  # @!attribute [rw] fault_injection_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::FaultInjectionPolicy]
  #     The specification for fault injection introduced into traffic to test the
  #     resiliency of clients to backend service failure. As part of fault
  #     injection, when clients send requests to a backend service, delays can be
  #     introduced  on a percentage of requests before sending those requests to
  #     the backend service. Similarly requests from clients can be aborted for a
  #     percentage of requests.
  #
  #     timeout and retry_policy will be ignored by clients that are configured
  #     with a fault_injection_policy
  # @!attribute [rw] request_header_modifier
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderModifier]
  #     The specification for modifying the headers of a matching request prior
  #     to delivery of the request to the destination. If HeaderModifiers are set
  #     on both the Destination and the RouteAction, they will be merged.
  #     Conflicts between the two will not be resolved on the configuration.
  # @!attribute [rw] response_header_modifier
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderModifier]
  #     The specification for modifying the headers of a response prior to
  #     sending the response back to the client. If HeaderModifiers are set
  #     on both the Destination and the RouteAction, they will be merged.
  #     Conflicts between the two will not be resolved on the configuration.
  # @!attribute [rw] url_rewrite
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::URLRewrite]
  #     The specification for rewrite URL before forwarding requests to the
  #     destination.
  # @!attribute [rw] timeout
  #   @return [::Google::Protobuf::Duration]
  #     Specifies the timeout for selected route. Timeout is computed from the
  #     time the request has been fully processed (i.e. end of stream) up until
  #     the response has been completely processed. Timeout includes all retries.
  # @!attribute [rw] retry_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::RetryPolicy]
  #     Specifies the retry policy associated with this route.
  # @!attribute [rw] request_mirror_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::RequestMirrorPolicy]
  #     Specifies the policy on how requests intended for the routes destination
  #     are shadowed to a separate mirrored destination. Proxy will not wait for
  #     the shadow destination to respond before returning the response. Prior to
  #     sending traffic to the shadow service, the host/authority header is
  #     suffixed with -shadow.
  # @!attribute [rw] cors_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::CorsPolicy]
  #     The specification for allowing client side cross-origin requests.
  class RouteAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies how to match traffic and how to route traffic when traffic is
  # matched.
  # @!attribute [rw] matches
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::RouteMatch>]
  #     A list of matches define conditions used for matching the rule against
  #     incoming HTTP requests. Each match is independent, i.e. this rule will be
  #     matched if ANY one of the matches is satisfied.
  #
  #     If no matches field is specified, this rule will unconditionally match
  #     traffic.
  #
  #     If a default rule is desired to be configured, add a rule with no matches
  #     specified to the end of the rules list.
  # @!attribute [rw] action
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::RouteAction]
  #     The detailed rule defining how to route matched traffic.
  class RouteRule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#description ⇒ ::String

Returns Optional. A free-text description of the resource. Max length 1024 characters.

Returns:

• (::String) —

  Optional. A free-text description of the resource. Max length 1024 characters.

# File 'proto_docs/google/cloud/networkservices/v1/http_route.rb', line 94

class HttpRoute
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to select a route rule based on HTTP request headers.
  # @!attribute [rw] exact_match
  #   @return [::String]
  #     The value of the header should match exactly the content of
  #     exact_match.
  # @!attribute [rw] regex_match
  #   @return [::String]
  #     The value of the header must match the regular expression specified in
  #     regex_match. For regular expression grammar, please see:
  #     https://github.com/google/re2/wiki/Syntax
  # @!attribute [rw] prefix_match
  #   @return [::String]
  #     The value of the header must start with the contents of prefix_match.
  # @!attribute [rw] present_match
  #   @return [::Boolean]
  #     A header with header_name must exist. The match takes place whether or
  #     not the header has a value.
  # @!attribute [rw] suffix_match
  #   @return [::String]
  #     The value of the header must end with the contents of suffix_match.
  # @!attribute [rw] range_match
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderMatch::IntegerRange]
  #     If specified, the rule will match if the request header value is within
  #     the range.
  # @!attribute [rw] header
  #   @return [::String]
  #     The name of the HTTP header to match against.
  # @!attribute [rw] invert_match
  #   @return [::Boolean]
  #     If specified, the match result will be inverted before checking. Default
  #     value is set to false.
  class HeaderMatch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents an integer value range.
    # @!attribute [rw] start
    #   @return [::Integer]
    #     Start of the range (inclusive)
    # @!attribute [rw] end
    #   @return [::Integer]
    #     End of the range (exclusive)
    class IntegerRange
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Specifications to match a query parameter in the request.
  # @!attribute [rw] exact_match
  #   @return [::String]
  #     The value of the query parameter must exactly match the contents of
  #     exact_match.
  #
  #     Only one of exact_match, regex_match, or present_match must be set.
  # @!attribute [rw] regex_match
  #   @return [::String]
  #     The value of the query parameter must match the regular expression
  #     specified by regex_match. For regular expression grammar, please see
  #     https://github.com/google/re2/wiki/Syntax
  #
  #     Only one of exact_match, regex_match, or present_match must be set.
  # @!attribute [rw] present_match
  #   @return [::Boolean]
  #     Specifies that the QueryParameterMatcher matches if request contains
  #     query parameter, irrespective of whether the parameter has a value or
  #     not.
  #
  #     Only one of exact_match, regex_match, or present_match must be set.
  # @!attribute [rw] query_parameter
  #   @return [::String]
  #     The name of the query parameter to match.
  class QueryParameterMatch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # RouteMatch defines specifications used to match requests. If multiple match
  # types are set, this RouteMatch will match if ALL type of matches are
  # matched.
  # @!attribute [rw] full_path_match
  #   @return [::String]
  #     The HTTP request path value should exactly match this value.
  #
  #     Only one of full_path_match, prefix_match, or regex_match should be
  #     used.
  # @!attribute [rw] prefix_match
  #   @return [::String]
  #     The HTTP request path value must begin with specified prefix_match.
  #     prefix_match must begin with a /.
  #
  #     Only one of full_path_match, prefix_match, or regex_match should be
  #     used.
  # @!attribute [rw] regex_match
  #   @return [::String]
  #     The HTTP request path value must satisfy the regular expression
  #     specified by regex_match after removing any query parameters and anchor
  #     supplied with the original URL. For regular expression grammar, please
  #     see https://github.com/google/re2/wiki/Syntax
  #
  #     Only one of full_path_match, prefix_match, or regex_match should be
  #     used.
  # @!attribute [rw] ignore_case
  #   @return [::Boolean]
  #     Specifies if prefix_match and full_path_match matches are case sensitive.
  #     The default value is false.
  # @!attribute [rw] headers
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderMatch>]
  #     Specifies a list of HTTP request headers to match against. ALL of the
  #     supplied headers must be matched.
  # @!attribute [rw] query_parameters
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::QueryParameterMatch>]
  #     Specifies a list of query parameters to match against. ALL of the query
  #     parameters must be matched.
  class RouteMatch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifications of a destination to which the request should be routed to.
  # @!attribute [rw] service_name
  #   @return [::String]
  #     The URL of a BackendService to route traffic to.
  # @!attribute [rw] weight
  #   @return [::Integer]
  #     Specifies the proportion of requests forwarded to the backend referenced
  #     by the serviceName field. This is computed as:
  #     - weight/Sum(weights in this destination list).
  #     For non-zero values, there may be some epsilon from the exact proportion
  #     defined here depending on the precision an implementation supports.
  #
  #     If only one serviceName is specified and it has a weight greater than 0,
  #     100% of the traffic is forwarded to that backend.
  #
  #     If weights are specified for any one service name, they need to be
  #     specified for all of them.
  #
  #     If weights are unspecified for all services, then, traffic is distributed
  #     in equal proportions to all of them.
  class Destination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specification for redirecting traffic.
  # @!attribute [rw] host_redirect
  #   @return [::String]
  #     The host that will be used in the redirect response instead of the one
  #     that was supplied in the request.
  # @!attribute [rw] path_redirect
  #   @return [::String]
  #     The path that will be used in the redirect response instead of the one
  #     that was supplied in the request.
  #     path_redirect can not be supplied together with prefix_redirect. Supply
  #     one alone or neither. If neither is supplied, the path of the original
  #     request will be used for the redirect.
  # @!attribute [rw] prefix_rewrite
  #   @return [::String]
  #     Indicates that during redirection, the matched prefix (or path) should be
  #     swapped with this value. This option allows URLs be dynamically created
  #     based on the request.
  # @!attribute [rw] response_code
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::Redirect::ResponseCode]
  #     The HTTP Status code to use for the redirect.
  # @!attribute [rw] https_redirect
  #   @return [::Boolean]
  #     If set to true, the URL scheme in the redirected request is set to https.
  #     If set to false, the URL scheme of the redirected request will remain the
  #     same as that of the request.
  #
  #     The default is set to false.
  # @!attribute [rw] strip_query
  #   @return [::Boolean]
  #     if set to true, any accompanying query portion of the original URL is
  #     removed prior to redirecting the request. If set to false, the query
  #     portion of the original URL is retained.
  #
  #     The default is set to false.
  # @!attribute [rw] port_redirect
  #   @return [::Integer]
  #     The port that will be used in the redirected request instead of the one
  #     that was supplied in the request.
  class Redirect
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Supported HTTP response code.
    module ResponseCode
      # Default value
      RESPONSE_CODE_UNSPECIFIED = 0

      # Corresponds to 301.
      MOVED_PERMANENTLY_DEFAULT = 1

      # Corresponds to 302.
      FOUND = 2

      # Corresponds to 303.
      SEE_OTHER = 3

      # Corresponds to 307. In this case, the request method will be retained.
      TEMPORARY_REDIRECT = 4

      # Corresponds to 308. In this case, the request method will be retained.
      PERMANENT_REDIRECT = 5
    end
  end

  # The specification for fault injection introduced into traffic to test the
  # resiliency of clients to destination service failure. As part of fault
  # injection, when clients send requests to a destination, delays can be
  # introduced by client proxy on a percentage of requests before sending those
  # requests to the destination service. Similarly requests can be aborted by
  # client proxy for a percentage of requests.
  # @!attribute [rw] delay
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::FaultInjectionPolicy::Delay]
  #     The specification for injecting delay to client requests.
  # @!attribute [rw] abort
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::FaultInjectionPolicy::Abort]
  #     The specification for aborting to client requests.
  class FaultInjectionPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specification of how client requests are delayed as part of fault
    # injection before being sent to a destination.
    # @!attribute [rw] fixed_delay
    #   @return [::Google::Protobuf::Duration]
    #     Specify a fixed delay before forwarding the request.
    # @!attribute [rw] percentage
    #   @return [::Integer]
    #     The percentage of traffic on which delay will be injected.
    #
    #     The value must be between [0, 100]
    class Delay
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specification of how client requests are aborted as part of fault
    # injection before being sent to a destination.
    # @!attribute [rw] http_status
    #   @return [::Integer]
    #     The HTTP status code used to abort the request.
    #
    #     The value must be between 200 and 599 inclusive.
    # @!attribute [rw] percentage
    #   @return [::Integer]
    #     The percentage of traffic which will be aborted.
    #
    #     The value must be between [0, 100]
    class Abort
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The specification for modifying HTTP header in HTTP request and HTTP
  # response.
  # @!attribute [rw] set
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Completely overwrite/replace the headers with given map where key is the
  #     name of the header, value is the value of the header.
  # @!attribute [rw] add
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Add the headers with given map where key is the name of the header, value
  #     is the value of the header.
  # @!attribute [rw] remove
  #   @return [::Array<::String>]
  #     Remove headers (matching by header names) specified in the list.
  class HeaderModifier
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class SetEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class AddEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The specification for modifying the URL of the request, prior to forwarding
  # the request to the destination.
  # @!attribute [rw] path_prefix_rewrite
  #   @return [::String]
  #     Prior to forwarding the request to the selected destination, the matching
  #     portion of the requests path is replaced by this value.
  # @!attribute [rw] host_rewrite
  #   @return [::String]
  #     Prior to forwarding the request to the selected destination, the requests
  #     host header is replaced by this value.
  class URLRewrite
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specifications for retries.
  # @!attribute [rw] retry_conditions
  #   @return [::Array<::String>]
  #     Specifies one or more conditions when this retry policy applies. Valid
  #     values are:
  #       5xx: Proxy will attempt a retry if the destination service responds
  #         with any 5xx response code, of if the destination service does not
  #         respond at all, example: disconnect, reset, read timeout, connection
  #         failure and refused streams.
  #
  #       gateway-error: Similar to 5xx, but only applies to response codes 502,
  #         503, 504.
  #
  #       reset: Proxy will attempt a retry if the destination service does not
  #         respond at all (disconnect/reset/read timeout)
  #
  #       connect-failure: Proxy will retry on failures connecting to destination
  #         for example due to connection timeouts.
  #
  #       retriable-4xx: Proxy will retry fro retriable 4xx response codes.
  #         Currently the only retriable error supported is 409.
  #
  #       refused-stream: Proxy will retry if the destination resets the stream
  #         with a REFUSED_STREAM error code. This reset type indicates that it
  #         is safe to retry.
  # @!attribute [rw] num_retries
  #   @return [::Integer]
  #     Specifies the allowed number of retries. This number must be > 0. If not
  #     specified, default to 1.
  # @!attribute [rw] per_try_timeout
  #   @return [::Google::Protobuf::Duration]
  #     Specifies a non-zero timeout per retry attempt.
  class RetryPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the policy on how requests are shadowed to a separate mirrored
  # destination service. The proxy does not wait for responses from the
  # shadow service. Prior to sending traffic to the shadow service, the
  # host/authority header is suffixed with -shadow.
  # @!attribute [rw] destination
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::Destination]
  #     The destination the requests will be mirrored to. The weight of the
  #     destination will be ignored.
  class RequestMirrorPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Specification for allowing client side cross-origin requests.
  # @!attribute [rw] allow_origins
  #   @return [::Array<::String>]
  #     Specifies the list of origins that will be allowed to do CORS requests.
  #     An origin is allowed if it matches either an item in allow_origins or
  #     an item in allow_origin_regexes.
  # @!attribute [rw] allow_origin_regexes
  #   @return [::Array<::String>]
  #     Specifies the regular expression patterns that match allowed origins. For
  #     regular expression grammar, please see
  #     https://github.com/google/re2/wiki/Syntax.
  # @!attribute [rw] allow_methods
  #   @return [::Array<::String>]
  #     Specifies the content for Access-Control-Allow-Methods header.
  # @!attribute [rw] allow_headers
  #   @return [::Array<::String>]
  #     Specifies the content for Access-Control-Allow-Headers header.
  # @!attribute [rw] expose_headers
  #   @return [::Array<::String>]
  #     Specifies the content for Access-Control-Expose-Headers header.
  # @!attribute [rw] max_age
  #   @return [::String]
  #     Specifies how long result of a preflight request can be cached in
  #     seconds. This translates to the Access-Control-Max-Age header.
  # @!attribute [rw] allow_credentials
  #   @return [::Boolean]
  #     In response to a preflight request, setting this to true indicates that
  #     the actual request can include user credentials. This translates to the
  #     Access-Control-Allow-Credentials header.
  #
  #     Default value is false.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     If true, the CORS policy is disabled. The default value is false, which
  #     indicates that the CORS policy is in effect.
  class CorsPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specifications for routing traffic and applying associated policies.
  # @!attribute [rw] destinations
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::Destination>]
  #     The destination to which traffic should be forwarded.
  # @!attribute [rw] redirect
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::Redirect]
  #     If set, the request is directed as configured by this field.
  # @!attribute [rw] fault_injection_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::FaultInjectionPolicy]
  #     The specification for fault injection introduced into traffic to test the
  #     resiliency of clients to backend service failure. As part of fault
  #     injection, when clients send requests to a backend service, delays can be
  #     introduced  on a percentage of requests before sending those requests to
  #     the backend service. Similarly requests from clients can be aborted for a
  #     percentage of requests.
  #
  #     timeout and retry_policy will be ignored by clients that are configured
  #     with a fault_injection_policy
  # @!attribute [rw] request_header_modifier
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderModifier]
  #     The specification for modifying the headers of a matching request prior
  #     to delivery of the request to the destination. If HeaderModifiers are set
  #     on both the Destination and the RouteAction, they will be merged.
  #     Conflicts between the two will not be resolved on the configuration.
  # @!attribute [rw] response_header_modifier
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderModifier]
  #     The specification for modifying the headers of a response prior to
  #     sending the response back to the client. If HeaderModifiers are set
  #     on both the Destination and the RouteAction, they will be merged.
  #     Conflicts between the two will not be resolved on the configuration.
  # @!attribute [rw] url_rewrite
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::URLRewrite]
  #     The specification for rewrite URL before forwarding requests to the
  #     destination.
  # @!attribute [rw] timeout
  #   @return [::Google::Protobuf::Duration]
  #     Specifies the timeout for selected route. Timeout is computed from the
  #     time the request has been fully processed (i.e. end of stream) up until
  #     the response has been completely processed. Timeout includes all retries.
  # @!attribute [rw] retry_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::RetryPolicy]
  #     Specifies the retry policy associated with this route.
  # @!attribute [rw] request_mirror_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::RequestMirrorPolicy]
  #     Specifies the policy on how requests intended for the routes destination
  #     are shadowed to a separate mirrored destination. Proxy will not wait for
  #     the shadow destination to respond before returning the response. Prior to
  #     sending traffic to the shadow service, the host/authority header is
  #     suffixed with -shadow.
  # @!attribute [rw] cors_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::CorsPolicy]
  #     The specification for allowing client side cross-origin requests.
  class RouteAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies how to match traffic and how to route traffic when traffic is
  # matched.
  # @!attribute [rw] matches
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::RouteMatch>]
  #     A list of matches define conditions used for matching the rule against
  #     incoming HTTP requests. Each match is independent, i.e. this rule will be
  #     matched if ANY one of the matches is satisfied.
  #
  #     If no matches field is specified, this rule will unconditionally match
  #     traffic.
  #
  #     If a default rule is desired to be configured, add a rule with no matches
  #     specified to the end of the rules list.
  # @!attribute [rw] action
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::RouteAction]
  #     The detailed rule defining how to route matched traffic.
  class RouteRule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#gateways ⇒ ::Array<::String>

Returns Optional. Gateways defines a list of gateways this HttpRoute is attached to, as one of the routing rules to route the requests served by the gateway.

Each gateway reference should match the pattern: projects/*/locations/global/gateways/<gateway_name>.

Returns:

• (::Array<::String>) —

  Optional. Gateways defines a list of gateways this HttpRoute is attached to, as one of the routing rules to route the requests served by the gateway.

  Each gateway reference should match the pattern: projects/*/locations/global/gateways/<gateway_name>

# File 'proto_docs/google/cloud/networkservices/v1/http_route.rb', line 94

class HttpRoute
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to select a route rule based on HTTP request headers.
  # @!attribute [rw] exact_match
  #   @return [::String]
  #     The value of the header should match exactly the content of
  #     exact_match.
  # @!attribute [rw] regex_match
  #   @return [::String]
  #     The value of the header must match the regular expression specified in
  #     regex_match. For regular expression grammar, please see:
  #     https://github.com/google/re2/wiki/Syntax
  # @!attribute [rw] prefix_match
  #   @return [::String]
  #     The value of the header must start with the contents of prefix_match.
  # @!attribute [rw] present_match
  #   @return [::Boolean]
  #     A header with header_name must exist. The match takes place whether or
  #     not the header has a value.
  # @!attribute [rw] suffix_match
  #   @return [::String]
  #     The value of the header must end with the contents of suffix_match.
  # @!attribute [rw] range_match
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderMatch::IntegerRange]
  #     If specified, the rule will match if the request header value is within
  #     the range.
  # @!attribute [rw] header
  #   @return [::String]
  #     The name of the HTTP header to match against.
  # @!attribute [rw] invert_match
  #   @return [::Boolean]
  #     If specified, the match result will be inverted before checking. Default
  #     value is set to false.
  class HeaderMatch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents an integer value range.
    # @!attribute [rw] start
    #   @return [::Integer]
    #     Start of the range (inclusive)
    # @!attribute [rw] end
    #   @return [::Integer]
    #     End of the range (exclusive)
    class IntegerRange
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Specifications to match a query parameter in the request.
  # @!attribute [rw] exact_match
  #   @return [::String]
  #     The value of the query parameter must exactly match the contents of
  #     exact_match.
  #
  #     Only one of exact_match, regex_match, or present_match must be set.
  # @!attribute [rw] regex_match
  #   @return [::String]
  #     The value of the query parameter must match the regular expression
  #     specified by regex_match. For regular expression grammar, please see
  #     https://github.com/google/re2/wiki/Syntax
  #
  #     Only one of exact_match, regex_match, or present_match must be set.
  # @!attribute [rw] present_match
  #   @return [::Boolean]
  #     Specifies that the QueryParameterMatcher matches if request contains
  #     query parameter, irrespective of whether the parameter has a value or
  #     not.
  #
  #     Only one of exact_match, regex_match, or present_match must be set.
  # @!attribute [rw] query_parameter
  #   @return [::String]
  #     The name of the query parameter to match.
  class QueryParameterMatch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # RouteMatch defines specifications used to match requests. If multiple match
  # types are set, this RouteMatch will match if ALL type of matches are
  # matched.
  # @!attribute [rw] full_path_match
  #   @return [::String]
  #     The HTTP request path value should exactly match this value.
  #
  #     Only one of full_path_match, prefix_match, or regex_match should be
  #     used.
  # @!attribute [rw] prefix_match
  #   @return [::String]
  #     The HTTP request path value must begin with specified prefix_match.
  #     prefix_match must begin with a /.
  #
  #     Only one of full_path_match, prefix_match, or regex_match should be
  #     used.
  # @!attribute [rw] regex_match
  #   @return [::String]
  #     The HTTP request path value must satisfy the regular expression
  #     specified by regex_match after removing any query parameters and anchor
  #     supplied with the original URL. For regular expression grammar, please
  #     see https://github.com/google/re2/wiki/Syntax
  #
  #     Only one of full_path_match, prefix_match, or regex_match should be
  #     used.
  # @!attribute [rw] ignore_case
  #   @return [::Boolean]
  #     Specifies if prefix_match and full_path_match matches are case sensitive.
  #     The default value is false.
  # @!attribute [rw] headers
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderMatch>]
  #     Specifies a list of HTTP request headers to match against. ALL of the
  #     supplied headers must be matched.
  # @!attribute [rw] query_parameters
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::QueryParameterMatch>]
  #     Specifies a list of query parameters to match against. ALL of the query
  #     parameters must be matched.
  class RouteMatch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifications of a destination to which the request should be routed to.
  # @!attribute [rw] service_name
  #   @return [::String]
  #     The URL of a BackendService to route traffic to.
  # @!attribute [rw] weight
  #   @return [::Integer]
  #     Specifies the proportion of requests forwarded to the backend referenced
  #     by the serviceName field. This is computed as:
  #     - weight/Sum(weights in this destination list).
  #     For non-zero values, there may be some epsilon from the exact proportion
  #     defined here depending on the precision an implementation supports.
  #
  #     If only one serviceName is specified and it has a weight greater than 0,
  #     100% of the traffic is forwarded to that backend.
  #
  #     If weights are specified for any one service name, they need to be
  #     specified for all of them.
  #
  #     If weights are unspecified for all services, then, traffic is distributed
  #     in equal proportions to all of them.
  class Destination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specification for redirecting traffic.
  # @!attribute [rw] host_redirect
  #   @return [::String]
  #     The host that will be used in the redirect response instead of the one
  #     that was supplied in the request.
  # @!attribute [rw] path_redirect
  #   @return [::String]
  #     The path that will be used in the redirect response instead of the one
  #     that was supplied in the request.
  #     path_redirect can not be supplied together with prefix_redirect. Supply
  #     one alone or neither. If neither is supplied, the path of the original
  #     request will be used for the redirect.
  # @!attribute [rw] prefix_rewrite
  #   @return [::String]
  #     Indicates that during redirection, the matched prefix (or path) should be
  #     swapped with this value. This option allows URLs be dynamically created
  #     based on the request.
  # @!attribute [rw] response_code
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::Redirect::ResponseCode]
  #     The HTTP Status code to use for the redirect.
  # @!attribute [rw] https_redirect
  #   @return [::Boolean]
  #     If set to true, the URL scheme in the redirected request is set to https.
  #     If set to false, the URL scheme of the redirected request will remain the
  #     same as that of the request.
  #
  #     The default is set to false.
  # @!attribute [rw] strip_query
  #   @return [::Boolean]
  #     if set to true, any accompanying query portion of the original URL is
  #     removed prior to redirecting the request. If set to false, the query
  #     portion of the original URL is retained.
  #
  #     The default is set to false.
  # @!attribute [rw] port_redirect
  #   @return [::Integer]
  #     The port that will be used in the redirected request instead of the one
  #     that was supplied in the request.
  class Redirect
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Supported HTTP response code.
    module ResponseCode
      # Default value
      RESPONSE_CODE_UNSPECIFIED = 0

      # Corresponds to 301.
      MOVED_PERMANENTLY_DEFAULT = 1

      # Corresponds to 302.
      FOUND = 2

      # Corresponds to 303.
      SEE_OTHER = 3

      # Corresponds to 307. In this case, the request method will be retained.
      TEMPORARY_REDIRECT = 4

      # Corresponds to 308. In this case, the request method will be retained.
      PERMANENT_REDIRECT = 5
    end
  end

  # The specification for fault injection introduced into traffic to test the
  # resiliency of clients to destination service failure. As part of fault
  # injection, when clients send requests to a destination, delays can be
  # introduced by client proxy on a percentage of requests before sending those
  # requests to the destination service. Similarly requests can be aborted by
  # client proxy for a percentage of requests.
  # @!attribute [rw] delay
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::FaultInjectionPolicy::Delay]
  #     The specification for injecting delay to client requests.
  # @!attribute [rw] abort
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::FaultInjectionPolicy::Abort]
  #     The specification for aborting to client requests.
  class FaultInjectionPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specification of how client requests are delayed as part of fault
    # injection before being sent to a destination.
    # @!attribute [rw] fixed_delay
    #   @return [::Google::Protobuf::Duration]
    #     Specify a fixed delay before forwarding the request.
    # @!attribute [rw] percentage
    #   @return [::Integer]
    #     The percentage of traffic on which delay will be injected.
    #
    #     The value must be between [0, 100]
    class Delay
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specification of how client requests are aborted as part of fault
    # injection before being sent to a destination.
    # @!attribute [rw] http_status
    #   @return [::Integer]
    #     The HTTP status code used to abort the request.
    #
    #     The value must be between 200 and 599 inclusive.
    # @!attribute [rw] percentage
    #   @return [::Integer]
    #     The percentage of traffic which will be aborted.
    #
    #     The value must be between [0, 100]
    class Abort
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The specification for modifying HTTP header in HTTP request and HTTP
  # response.
  # @!attribute [rw] set
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Completely overwrite/replace the headers with given map where key is the
  #     name of the header, value is the value of the header.
  # @!attribute [rw] add
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Add the headers with given map where key is the name of the header, value
  #     is the value of the header.
  # @!attribute [rw] remove
  #   @return [::Array<::String>]
  #     Remove headers (matching by header names) specified in the list.
  class HeaderModifier
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class SetEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class AddEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The specification for modifying the URL of the request, prior to forwarding
  # the request to the destination.
  # @!attribute [rw] path_prefix_rewrite
  #   @return [::String]
  #     Prior to forwarding the request to the selected destination, the matching
  #     portion of the requests path is replaced by this value.
  # @!attribute [rw] host_rewrite
  #   @return [::String]
  #     Prior to forwarding the request to the selected destination, the requests
  #     host header is replaced by this value.
  class URLRewrite
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specifications for retries.
  # @!attribute [rw] retry_conditions
  #   @return [::Array<::String>]
  #     Specifies one or more conditions when this retry policy applies. Valid
  #     values are:
  #       5xx: Proxy will attempt a retry if the destination service responds
  #         with any 5xx response code, of if the destination service does not
  #         respond at all, example: disconnect, reset, read timeout, connection
  #         failure and refused streams.
  #
  #       gateway-error: Similar to 5xx, but only applies to response codes 502,
  #         503, 504.
  #
  #       reset: Proxy will attempt a retry if the destination service does not
  #         respond at all (disconnect/reset/read timeout)
  #
  #       connect-failure: Proxy will retry on failures connecting to destination
  #         for example due to connection timeouts.
  #
  #       retriable-4xx: Proxy will retry fro retriable 4xx response codes.
  #         Currently the only retriable error supported is 409.
  #
  #       refused-stream: Proxy will retry if the destination resets the stream
  #         with a REFUSED_STREAM error code. This reset type indicates that it
  #         is safe to retry.
  # @!attribute [rw] num_retries
  #   @return [::Integer]
  #     Specifies the allowed number of retries. This number must be > 0. If not
  #     specified, default to 1.
  # @!attribute [rw] per_try_timeout
  #   @return [::Google::Protobuf::Duration]
  #     Specifies a non-zero timeout per retry attempt.
  class RetryPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the policy on how requests are shadowed to a separate mirrored
  # destination service. The proxy does not wait for responses from the
  # shadow service. Prior to sending traffic to the shadow service, the
  # host/authority header is suffixed with -shadow.
  # @!attribute [rw] destination
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::Destination]
  #     The destination the requests will be mirrored to. The weight of the
  #     destination will be ignored.
  class RequestMirrorPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Specification for allowing client side cross-origin requests.
  # @!attribute [rw] allow_origins
  #   @return [::Array<::String>]
  #     Specifies the list of origins that will be allowed to do CORS requests.
  #     An origin is allowed if it matches either an item in allow_origins or
  #     an item in allow_origin_regexes.
  # @!attribute [rw] allow_origin_regexes
  #   @return [::Array<::String>]
  #     Specifies the regular expression patterns that match allowed origins. For
  #     regular expression grammar, please see
  #     https://github.com/google/re2/wiki/Syntax.
  # @!attribute [rw] allow_methods
  #   @return [::Array<::String>]
  #     Specifies the content for Access-Control-Allow-Methods header.
  # @!attribute [rw] allow_headers
  #   @return [::Array<::String>]
  #     Specifies the content for Access-Control-Allow-Headers header.
  # @!attribute [rw] expose_headers
  #   @return [::Array<::String>]
  #     Specifies the content for Access-Control-Expose-Headers header.
  # @!attribute [rw] max_age
  #   @return [::String]
  #     Specifies how long result of a preflight request can be cached in
  #     seconds. This translates to the Access-Control-Max-Age header.
  # @!attribute [rw] allow_credentials
  #   @return [::Boolean]
  #     In response to a preflight request, setting this to true indicates that
  #     the actual request can include user credentials. This translates to the
  #     Access-Control-Allow-Credentials header.
  #
  #     Default value is false.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     If true, the CORS policy is disabled. The default value is false, which
  #     indicates that the CORS policy is in effect.
  class CorsPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specifications for routing traffic and applying associated policies.
  # @!attribute [rw] destinations
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::Destination>]
  #     The destination to which traffic should be forwarded.
  # @!attribute [rw] redirect
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::Redirect]
  #     If set, the request is directed as configured by this field.
  # @!attribute [rw] fault_injection_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::FaultInjectionPolicy]
  #     The specification for fault injection introduced into traffic to test the
  #     resiliency of clients to backend service failure. As part of fault
  #     injection, when clients send requests to a backend service, delays can be
  #     introduced  on a percentage of requests before sending those requests to
  #     the backend service. Similarly requests from clients can be aborted for a
  #     percentage of requests.
  #
  #     timeout and retry_policy will be ignored by clients that are configured
  #     with a fault_injection_policy
  # @!attribute [rw] request_header_modifier
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderModifier]
  #     The specification for modifying the headers of a matching request prior
  #     to delivery of the request to the destination. If HeaderModifiers are set
  #     on both the Destination and the RouteAction, they will be merged.
  #     Conflicts between the two will not be resolved on the configuration.
  # @!attribute [rw] response_header_modifier
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderModifier]
  #     The specification for modifying the headers of a response prior to
  #     sending the response back to the client. If HeaderModifiers are set
  #     on both the Destination and the RouteAction, they will be merged.
  #     Conflicts between the two will not be resolved on the configuration.
  # @!attribute [rw] url_rewrite
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::URLRewrite]
  #     The specification for rewrite URL before forwarding requests to the
  #     destination.
  # @!attribute [rw] timeout
  #   @return [::Google::Protobuf::Duration]
  #     Specifies the timeout for selected route. Timeout is computed from the
  #     time the request has been fully processed (i.e. end of stream) up until
  #     the response has been completely processed. Timeout includes all retries.
  # @!attribute [rw] retry_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::RetryPolicy]
  #     Specifies the retry policy associated with this route.
  # @!attribute [rw] request_mirror_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::RequestMirrorPolicy]
  #     Specifies the policy on how requests intended for the routes destination
  #     are shadowed to a separate mirrored destination. Proxy will not wait for
  #     the shadow destination to respond before returning the response. Prior to
  #     sending traffic to the shadow service, the host/authority header is
  #     suffixed with -shadow.
  # @!attribute [rw] cors_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::CorsPolicy]
  #     The specification for allowing client side cross-origin requests.
  class RouteAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies how to match traffic and how to route traffic when traffic is
  # matched.
  # @!attribute [rw] matches
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::RouteMatch>]
  #     A list of matches define conditions used for matching the rule against
  #     incoming HTTP requests. Each match is independent, i.e. this rule will be
  #     matched if ANY one of the matches is satisfied.
  #
  #     If no matches field is specified, this rule will unconditionally match
  #     traffic.
  #
  #     If a default rule is desired to be configured, add a rule with no matches
  #     specified to the end of the rules list.
  # @!attribute [rw] action
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::RouteAction]
  #     The detailed rule defining how to route matched traffic.
  class RouteRule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#hostnames ⇒ ::Array<::String>

Returns Required. Hostnames define a set of hosts that should match against the HTTP host header to select a HttpRoute to process the request. Hostname is the fully qualified domain name of a network host, as defined by RFC 1123 with the exception that:

• IPs are not allowed.
• A hostname may be prefixed with a wildcard label (*.). The wildcard label must appear by itself as the first label.

Hostname can be "precise" which is a domain name without the terminating dot of a network host (e.g. foo.example.com) or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. *.example.com).

Note that as per RFC1035 and RFC1123, a label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed.

The routes associated with a Mesh or Gateways must have unique hostnames. If you attempt to attach multiple routes with conflicting hostnames, the configuration will be rejected.

For example, while it is acceptable for routes for the hostnames *.foo.bar.com and *.bar.com to be associated with the same Mesh (or Gateways under the same scope), it is not possible to associate two routes both with *.bar.com or both with bar.com.

Returns:

• (::Array<::String>) —

  Required. Hostnames define a set of hosts that should match against the HTTP host header to select a HttpRoute to process the request. Hostname is the fully qualified domain name of a network host, as defined by RFC 1123 with the exception that:

  • IPs are not allowed.
  • A hostname may be prefixed with a wildcard label (*.). The wildcard label must appear by itself as the first label.

  Hostname can be "precise" which is a domain name without the terminating dot of a network host (e.g. foo.example.com) or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. *.example.com).

  Note that as per RFC1035 and RFC1123, a label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed.

  The routes associated with a Mesh or Gateways must have unique hostnames. If you attempt to attach multiple routes with conflicting hostnames, the configuration will be rejected.

  For example, while it is acceptable for routes for the hostnames *.foo.bar.com and *.bar.com to be associated with the same Mesh (or Gateways under the same scope), it is not possible to associate two routes both with *.bar.com or both with bar.com.

# File 'proto_docs/google/cloud/networkservices/v1/http_route.rb', line 94

class HttpRoute
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to select a route rule based on HTTP request headers.
  # @!attribute [rw] exact_match
  #   @return [::String]
  #     The value of the header should match exactly the content of
  #     exact_match.
  # @!attribute [rw] regex_match
  #   @return [::String]
  #     The value of the header must match the regular expression specified in
  #     regex_match. For regular expression grammar, please see:
  #     https://github.com/google/re2/wiki/Syntax
  # @!attribute [rw] prefix_match
  #   @return [::String]
  #     The value of the header must start with the contents of prefix_match.
  # @!attribute [rw] present_match
  #   @return [::Boolean]
  #     A header with header_name must exist. The match takes place whether or
  #     not the header has a value.
  # @!attribute [rw] suffix_match
  #   @return [::String]
  #     The value of the header must end with the contents of suffix_match.
  # @!attribute [rw] range_match
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderMatch::IntegerRange]
  #     If specified, the rule will match if the request header value is within
  #     the range.
  # @!attribute [rw] header
  #   @return [::String]
  #     The name of the HTTP header to match against.
  # @!attribute [rw] invert_match
  #   @return [::Boolean]
  #     If specified, the match result will be inverted before checking. Default
  #     value is set to false.
  class HeaderMatch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents an integer value range.
    # @!attribute [rw] start
    #   @return [::Integer]
    #     Start of the range (inclusive)
    # @!attribute [rw] end
    #   @return [::Integer]
    #     End of the range (exclusive)
    class IntegerRange
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Specifications to match a query parameter in the request.
  # @!attribute [rw] exact_match
  #   @return [::String]
  #     The value of the query parameter must exactly match the contents of
  #     exact_match.
  #
  #     Only one of exact_match, regex_match, or present_match must be set.
  # @!attribute [rw] regex_match
  #   @return [::String]
  #     The value of the query parameter must match the regular expression
  #     specified by regex_match. For regular expression grammar, please see
  #     https://github.com/google/re2/wiki/Syntax
  #
  #     Only one of exact_match, regex_match, or present_match must be set.
  # @!attribute [rw] present_match
  #   @return [::Boolean]
  #     Specifies that the QueryParameterMatcher matches if request contains
  #     query parameter, irrespective of whether the parameter has a value or
  #     not.
  #
  #     Only one of exact_match, regex_match, or present_match must be set.
  # @!attribute [rw] query_parameter
  #   @return [::String]
  #     The name of the query parameter to match.
  class QueryParameterMatch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # RouteMatch defines specifications used to match requests. If multiple match
  # types are set, this RouteMatch will match if ALL type of matches are
  # matched.
  # @!attribute [rw] full_path_match
  #   @return [::String]
  #     The HTTP request path value should exactly match this value.
  #
  #     Only one of full_path_match, prefix_match, or regex_match should be
  #     used.
  # @!attribute [rw] prefix_match
  #   @return [::String]
  #     The HTTP request path value must begin with specified prefix_match.
  #     prefix_match must begin with a /.
  #
  #     Only one of full_path_match, prefix_match, or regex_match should be
  #     used.
  # @!attribute [rw] regex_match
  #   @return [::String]
  #     The HTTP request path value must satisfy the regular expression
  #     specified by regex_match after removing any query parameters and anchor
  #     supplied with the original URL. For regular expression grammar, please
  #     see https://github.com/google/re2/wiki/Syntax
  #
  #     Only one of full_path_match, prefix_match, or regex_match should be
  #     used.
  # @!attribute [rw] ignore_case
  #   @return [::Boolean]
  #     Specifies if prefix_match and full_path_match matches are case sensitive.
  #     The default value is false.
  # @!attribute [rw] headers
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderMatch>]
  #     Specifies a list of HTTP request headers to match against. ALL of the
  #     supplied headers must be matched.
  # @!attribute [rw] query_parameters
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::QueryParameterMatch>]
  #     Specifies a list of query parameters to match against. ALL of the query
  #     parameters must be matched.
  class RouteMatch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifications of a destination to which the request should be routed to.
  # @!attribute [rw] service_name
  #   @return [::String]
  #     The URL of a BackendService to route traffic to.
  # @!attribute [rw] weight
  #   @return [::Integer]
  #     Specifies the proportion of requests forwarded to the backend referenced
  #     by the serviceName field. This is computed as:
  #     - weight/Sum(weights in this destination list).
  #     For non-zero values, there may be some epsilon from the exact proportion
  #     defined here depending on the precision an implementation supports.
  #
  #     If only one serviceName is specified and it has a weight greater than 0,
  #     100% of the traffic is forwarded to that backend.
  #
  #     If weights are specified for any one service name, they need to be
  #     specified for all of them.
  #
  #     If weights are unspecified for all services, then, traffic is distributed
  #     in equal proportions to all of them.
  class Destination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specification for redirecting traffic.
  # @!attribute [rw] host_redirect
  #   @return [::String]
  #     The host that will be used in the redirect response instead of the one
  #     that was supplied in the request.
  # @!attribute [rw] path_redirect
  #   @return [::String]
  #     The path that will be used in the redirect response instead of the one
  #     that was supplied in the request.
  #     path_redirect can not be supplied together with prefix_redirect. Supply
  #     one alone or neither. If neither is supplied, the path of the original
  #     request will be used for the redirect.
  # @!attribute [rw] prefix_rewrite
  #   @return [::String]
  #     Indicates that during redirection, the matched prefix (or path) should be
  #     swapped with this value. This option allows URLs be dynamically created
  #     based on the request.
  # @!attribute [rw] response_code
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::Redirect::ResponseCode]
  #     The HTTP Status code to use for the redirect.
  # @!attribute [rw] https_redirect
  #   @return [::Boolean]
  #     If set to true, the URL scheme in the redirected request is set to https.
  #     If set to false, the URL scheme of the redirected request will remain the
  #     same as that of the request.
  #
  #     The default is set to false.
  # @!attribute [rw] strip_query
  #   @return [::Boolean]
  #     if set to true, any accompanying query portion of the original URL is
  #     removed prior to redirecting the request. If set to false, the query
  #     portion of the original URL is retained.
  #
  #     The default is set to false.
  # @!attribute [rw] port_redirect
  #   @return [::Integer]
  #     The port that will be used in the redirected request instead of the one
  #     that was supplied in the request.
  class Redirect
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Supported HTTP response code.
    module ResponseCode
      # Default value
      RESPONSE_CODE_UNSPECIFIED = 0

      # Corresponds to 301.
      MOVED_PERMANENTLY_DEFAULT = 1

      # Corresponds to 302.
      FOUND = 2

      # Corresponds to 303.
      SEE_OTHER = 3

      # Corresponds to 307. In this case, the request method will be retained.
      TEMPORARY_REDIRECT = 4

      # Corresponds to 308. In this case, the request method will be retained.
      PERMANENT_REDIRECT = 5
    end
  end

  # The specification for fault injection introduced into traffic to test the
  # resiliency of clients to destination service failure. As part of fault
  # injection, when clients send requests to a destination, delays can be
  # introduced by client proxy on a percentage of requests before sending those
  # requests to the destination service. Similarly requests can be aborted by
  # client proxy for a percentage of requests.
  # @!attribute [rw] delay
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::FaultInjectionPolicy::Delay]
  #     The specification for injecting delay to client requests.
  # @!attribute [rw] abort
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::FaultInjectionPolicy::Abort]
  #     The specification for aborting to client requests.
  class FaultInjectionPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specification of how client requests are delayed as part of fault
    # injection before being sent to a destination.
    # @!attribute [rw] fixed_delay
    #   @return [::Google::Protobuf::Duration]
    #     Specify a fixed delay before forwarding the request.
    # @!attribute [rw] percentage
    #   @return [::Integer]
    #     The percentage of traffic on which delay will be injected.
    #
    #     The value must be between [0, 100]
    class Delay
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specification of how client requests are aborted as part of fault
    # injection before being sent to a destination.
    # @!attribute [rw] http_status
    #   @return [::Integer]
    #     The HTTP status code used to abort the request.
    #
    #     The value must be between 200 and 599 inclusive.
    # @!attribute [rw] percentage
    #   @return [::Integer]
    #     The percentage of traffic which will be aborted.
    #
    #     The value must be between [0, 100]
    class Abort
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The specification for modifying HTTP header in HTTP request and HTTP
  # response.
  # @!attribute [rw] set
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Completely overwrite/replace the headers with given map where key is the
  #     name of the header, value is the value of the header.
  # @!attribute [rw] add
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Add the headers with given map where key is the name of the header, value
  #     is the value of the header.
  # @!attribute [rw] remove
  #   @return [::Array<::String>]
  #     Remove headers (matching by header names) specified in the list.
  class HeaderModifier
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class SetEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class AddEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The specification for modifying the URL of the request, prior to forwarding
  # the request to the destination.
  # @!attribute [rw] path_prefix_rewrite
  #   @return [::String]
  #     Prior to forwarding the request to the selected destination, the matching
  #     portion of the requests path is replaced by this value.
  # @!attribute [rw] host_rewrite
  #   @return [::String]
  #     Prior to forwarding the request to the selected destination, the requests
  #     host header is replaced by this value.
  class URLRewrite
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specifications for retries.
  # @!attribute [rw] retry_conditions
  #   @return [::Array<::String>]
  #     Specifies one or more conditions when this retry policy applies. Valid
  #     values are:
  #       5xx: Proxy will attempt a retry if the destination service responds
  #         with any 5xx response code, of if the destination service does not
  #         respond at all, example: disconnect, reset, read timeout, connection
  #         failure and refused streams.
  #
  #       gateway-error: Similar to 5xx, but only applies to response codes 502,
  #         503, 504.
  #
  #       reset: Proxy will attempt a retry if the destination service does not
  #         respond at all (disconnect/reset/read timeout)
  #
  #       connect-failure: Proxy will retry on failures connecting to destination
  #         for example due to connection timeouts.
  #
  #       retriable-4xx: Proxy will retry fro retriable 4xx response codes.
  #         Currently the only retriable error supported is 409.
  #
  #       refused-stream: Proxy will retry if the destination resets the stream
  #         with a REFUSED_STREAM error code. This reset type indicates that it
  #         is safe to retry.
  # @!attribute [rw] num_retries
  #   @return [::Integer]
  #     Specifies the allowed number of retries. This number must be > 0. If not
  #     specified, default to 1.
  # @!attribute [rw] per_try_timeout
  #   @return [::Google::Protobuf::Duration]
  #     Specifies a non-zero timeout per retry attempt.
  class RetryPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the policy on how requests are shadowed to a separate mirrored
  # destination service. The proxy does not wait for responses from the
  # shadow service. Prior to sending traffic to the shadow service, the
  # host/authority header is suffixed with -shadow.
  # @!attribute [rw] destination
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::Destination]
  #     The destination the requests will be mirrored to. The weight of the
  #     destination will be ignored.
  class RequestMirrorPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Specification for allowing client side cross-origin requests.
  # @!attribute [rw] allow_origins
  #   @return [::Array<::String>]
  #     Specifies the list of origins that will be allowed to do CORS requests.
  #     An origin is allowed if it matches either an item in allow_origins or
  #     an item in allow_origin_regexes.
  # @!attribute [rw] allow_origin_regexes
  #   @return [::Array<::String>]
  #     Specifies the regular expression patterns that match allowed origins. For
  #     regular expression grammar, please see
  #     https://github.com/google/re2/wiki/Syntax.
  # @!attribute [rw] allow_methods
  #   @return [::Array<::String>]
  #     Specifies the content for Access-Control-Allow-Methods header.
  # @!attribute [rw] allow_headers
  #   @return [::Array<::String>]
  #     Specifies the content for Access-Control-Allow-Headers header.
  # @!attribute [rw] expose_headers
  #   @return [::Array<::String>]
  #     Specifies the content for Access-Control-Expose-Headers header.
  # @!attribute [rw] max_age
  #   @return [::String]
  #     Specifies how long result of a preflight request can be cached in
  #     seconds. This translates to the Access-Control-Max-Age header.
  # @!attribute [rw] allow_credentials
  #   @return [::Boolean]
  #     In response to a preflight request, setting this to true indicates that
  #     the actual request can include user credentials. This translates to the
  #     Access-Control-Allow-Credentials header.
  #
  #     Default value is false.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     If true, the CORS policy is disabled. The default value is false, which
  #     indicates that the CORS policy is in effect.
  class CorsPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specifications for routing traffic and applying associated policies.
  # @!attribute [rw] destinations
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::Destination>]
  #     The destination to which traffic should be forwarded.
  # @!attribute [rw] redirect
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::Redirect]
  #     If set, the request is directed as configured by this field.
  # @!attribute [rw] fault_injection_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::FaultInjectionPolicy]
  #     The specification for fault injection introduced into traffic to test the
  #     resiliency of clients to backend service failure. As part of fault
  #     injection, when clients send requests to a backend service, delays can be
  #     introduced  on a percentage of requests before sending those requests to
  #     the backend service. Similarly requests from clients can be aborted for a
  #     percentage of requests.
  #
  #     timeout and retry_policy will be ignored by clients that are configured
  #     with a fault_injection_policy
  # @!attribute [rw] request_header_modifier
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderModifier]
  #     The specification for modifying the headers of a matching request prior
  #     to delivery of the request to the destination. If HeaderModifiers are set
  #     on both the Destination and the RouteAction, they will be merged.
  #     Conflicts between the two will not be resolved on the configuration.
  # @!attribute [rw] response_header_modifier
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderModifier]
  #     The specification for modifying the headers of a response prior to
  #     sending the response back to the client. If HeaderModifiers are set
  #     on both the Destination and the RouteAction, they will be merged.
  #     Conflicts between the two will not be resolved on the configuration.
  # @!attribute [rw] url_rewrite
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::URLRewrite]
  #     The specification for rewrite URL before forwarding requests to the
  #     destination.
  # @!attribute [rw] timeout
  #   @return [::Google::Protobuf::Duration]
  #     Specifies the timeout for selected route. Timeout is computed from the
  #     time the request has been fully processed (i.e. end of stream) up until
  #     the response has been completely processed. Timeout includes all retries.
  # @!attribute [rw] retry_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::RetryPolicy]
  #     Specifies the retry policy associated with this route.
  # @!attribute [rw] request_mirror_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::RequestMirrorPolicy]
  #     Specifies the policy on how requests intended for the routes destination
  #     are shadowed to a separate mirrored destination. Proxy will not wait for
  #     the shadow destination to respond before returning the response. Prior to
  #     sending traffic to the shadow service, the host/authority header is
  #     suffixed with -shadow.
  # @!attribute [rw] cors_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::CorsPolicy]
  #     The specification for allowing client side cross-origin requests.
  class RouteAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies how to match traffic and how to route traffic when traffic is
  # matched.
  # @!attribute [rw] matches
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::RouteMatch>]
  #     A list of matches define conditions used for matching the rule against
  #     incoming HTTP requests. Each match is independent, i.e. this rule will be
  #     matched if ANY one of the matches is satisfied.
  #
  #     If no matches field is specified, this rule will unconditionally match
  #     traffic.
  #
  #     If a default rule is desired to be configured, add a rule with no matches
  #     specified to the end of the rules list.
  # @!attribute [rw] action
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::RouteAction]
  #     The detailed rule defining how to route matched traffic.
  class RouteRule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. Set of label tags associated with the HttpRoute resource.

Returns:

• (::Google::Protobuf::Map{::String => ::String}) —

  Optional. Set of label tags associated with the HttpRoute resource.

# File 'proto_docs/google/cloud/networkservices/v1/http_route.rb', line 94

class HttpRoute
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to select a route rule based on HTTP request headers.
  # @!attribute [rw] exact_match
  #   @return [::String]
  #     The value of the header should match exactly the content of
  #     exact_match.
  # @!attribute [rw] regex_match
  #   @return [::String]
  #     The value of the header must match the regular expression specified in
  #     regex_match. For regular expression grammar, please see:
  #     https://github.com/google/re2/wiki/Syntax
  # @!attribute [rw] prefix_match
  #   @return [::String]
  #     The value of the header must start with the contents of prefix_match.
  # @!attribute [rw] present_match
  #   @return [::Boolean]
  #     A header with header_name must exist. The match takes place whether or
  #     not the header has a value.
  # @!attribute [rw] suffix_match
  #   @return [::String]
  #     The value of the header must end with the contents of suffix_match.
  # @!attribute [rw] range_match
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderMatch::IntegerRange]
  #     If specified, the rule will match if the request header value is within
  #     the range.
  # @!attribute [rw] header
  #   @return [::String]
  #     The name of the HTTP header to match against.
  # @!attribute [rw] invert_match
  #   @return [::Boolean]
  #     If specified, the match result will be inverted before checking. Default
  #     value is set to false.
  class HeaderMatch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents an integer value range.
    # @!attribute [rw] start
    #   @return [::Integer]
    #     Start of the range (inclusive)
    # @!attribute [rw] end
    #   @return [::Integer]
    #     End of the range (exclusive)
    class IntegerRange
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Specifications to match a query parameter in the request.
  # @!attribute [rw] exact_match
  #   @return [::String]
  #     The value of the query parameter must exactly match the contents of
  #     exact_match.
  #
  #     Only one of exact_match, regex_match, or present_match must be set.
  # @!attribute [rw] regex_match
  #   @return [::String]
  #     The value of the query parameter must match the regular expression
  #     specified by regex_match. For regular expression grammar, please see
  #     https://github.com/google/re2/wiki/Syntax
  #
  #     Only one of exact_match, regex_match, or present_match must be set.
  # @!attribute [rw] present_match
  #   @return [::Boolean]
  #     Specifies that the QueryParameterMatcher matches if request contains
  #     query parameter, irrespective of whether the parameter has a value or
  #     not.
  #
  #     Only one of exact_match, regex_match, or present_match must be set.
  # @!attribute [rw] query_parameter
  #   @return [::String]
  #     The name of the query parameter to match.
  class QueryParameterMatch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # RouteMatch defines specifications used to match requests. If multiple match
  # types are set, this RouteMatch will match if ALL type of matches are
  # matched.
  # @!attribute [rw] full_path_match
  #   @return [::String]
  #     The HTTP request path value should exactly match this value.
  #
  #     Only one of full_path_match, prefix_match, or regex_match should be
  #     used.
  # @!attribute [rw] prefix_match
  #   @return [::String]
  #     The HTTP request path value must begin with specified prefix_match.
  #     prefix_match must begin with a /.
  #
  #     Only one of full_path_match, prefix_match, or regex_match should be
  #     used.
  # @!attribute [rw] regex_match
  #   @return [::String]
  #     The HTTP request path value must satisfy the regular expression
  #     specified by regex_match after removing any query parameters and anchor
  #     supplied with the original URL. For regular expression grammar, please
  #     see https://github.com/google/re2/wiki/Syntax
  #
  #     Only one of full_path_match, prefix_match, or regex_match should be
  #     used.
  # @!attribute [rw] ignore_case
  #   @return [::Boolean]
  #     Specifies if prefix_match and full_path_match matches are case sensitive.
  #     The default value is false.
  # @!attribute [rw] headers
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderMatch>]
  #     Specifies a list of HTTP request headers to match against. ALL of the
  #     supplied headers must be matched.
  # @!attribute [rw] query_parameters
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::QueryParameterMatch>]
  #     Specifies a list of query parameters to match against. ALL of the query
  #     parameters must be matched.
  class RouteMatch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifications of a destination to which the request should be routed to.
  # @!attribute [rw] service_name
  #   @return [::String]
  #     The URL of a BackendService to route traffic to.
  # @!attribute [rw] weight
  #   @return [::Integer]
  #     Specifies the proportion of requests forwarded to the backend referenced
  #     by the serviceName field. This is computed as:
  #     - weight/Sum(weights in this destination list).
  #     For non-zero values, there may be some epsilon from the exact proportion
  #     defined here depending on the precision an implementation supports.
  #
  #     If only one serviceName is specified and it has a weight greater than 0,
  #     100% of the traffic is forwarded to that backend.
  #
  #     If weights are specified for any one service name, they need to be
  #     specified for all of them.
  #
  #     If weights are unspecified for all services, then, traffic is distributed
  #     in equal proportions to all of them.
  class Destination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specification for redirecting traffic.
  # @!attribute [rw] host_redirect
  #   @return [::String]
  #     The host that will be used in the redirect response instead of the one
  #     that was supplied in the request.
  # @!attribute [rw] path_redirect
  #   @return [::String]
  #     The path that will be used in the redirect response instead of the one
  #     that was supplied in the request.
  #     path_redirect can not be supplied together with prefix_redirect. Supply
  #     one alone or neither. If neither is supplied, the path of the original
  #     request will be used for the redirect.
  # @!attribute [rw] prefix_rewrite
  #   @return [::String]
  #     Indicates that during redirection, the matched prefix (or path) should be
  #     swapped with this value. This option allows URLs be dynamically created
  #     based on the request.
  # @!attribute [rw] response_code
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::Redirect::ResponseCode]
  #     The HTTP Status code to use for the redirect.
  # @!attribute [rw] https_redirect
  #   @return [::Boolean]
  #     If set to true, the URL scheme in the redirected request is set to https.
  #     If set to false, the URL scheme of the redirected request will remain the
  #     same as that of the request.
  #
  #     The default is set to false.
  # @!attribute [rw] strip_query
  #   @return [::Boolean]
  #     if set to true, any accompanying query portion of the original URL is
  #     removed prior to redirecting the request. If set to false, the query
  #     portion of the original URL is retained.
  #
  #     The default is set to false.
  # @!attribute [rw] port_redirect
  #   @return [::Integer]
  #     The port that will be used in the redirected request instead of the one
  #     that was supplied in the request.
  class Redirect
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Supported HTTP response code.
    module ResponseCode
      # Default value
      RESPONSE_CODE_UNSPECIFIED = 0

      # Corresponds to 301.
      MOVED_PERMANENTLY_DEFAULT = 1

      # Corresponds to 302.
      FOUND = 2

      # Corresponds to 303.
      SEE_OTHER = 3

      # Corresponds to 307. In this case, the request method will be retained.
      TEMPORARY_REDIRECT = 4

      # Corresponds to 308. In this case, the request method will be retained.
      PERMANENT_REDIRECT = 5
    end
  end

  # The specification for fault injection introduced into traffic to test the
  # resiliency of clients to destination service failure. As part of fault
  # injection, when clients send requests to a destination, delays can be
  # introduced by client proxy on a percentage of requests before sending those
  # requests to the destination service. Similarly requests can be aborted by
  # client proxy for a percentage of requests.
  # @!attribute [rw] delay
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::FaultInjectionPolicy::Delay]
  #     The specification for injecting delay to client requests.
  # @!attribute [rw] abort
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::FaultInjectionPolicy::Abort]
  #     The specification for aborting to client requests.
  class FaultInjectionPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specification of how client requests are delayed as part of fault
    # injection before being sent to a destination.
    # @!attribute [rw] fixed_delay
    #   @return [::Google::Protobuf::Duration]
    #     Specify a fixed delay before forwarding the request.
    # @!attribute [rw] percentage
    #   @return [::Integer]
    #     The percentage of traffic on which delay will be injected.
    #
    #     The value must be between [0, 100]
    class Delay
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specification of how client requests are aborted as part of fault
    # injection before being sent to a destination.
    # @!attribute [rw] http_status
    #   @return [::Integer]
    #     The HTTP status code used to abort the request.
    #
    #     The value must be between 200 and 599 inclusive.
    # @!attribute [rw] percentage
    #   @return [::Integer]
    #     The percentage of traffic which will be aborted.
    #
    #     The value must be between [0, 100]
    class Abort
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The specification for modifying HTTP header in HTTP request and HTTP
  # response.
  # @!attribute [rw] set
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Completely overwrite/replace the headers with given map where key is the
  #     name of the header, value is the value of the header.
  # @!attribute [rw] add
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Add the headers with given map where key is the name of the header, value
  #     is the value of the header.
  # @!attribute [rw] remove
  #   @return [::Array<::String>]
  #     Remove headers (matching by header names) specified in the list.
  class HeaderModifier
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class SetEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class AddEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The specification for modifying the URL of the request, prior to forwarding
  # the request to the destination.
  # @!attribute [rw] path_prefix_rewrite
  #   @return [::String]
  #     Prior to forwarding the request to the selected destination, the matching
  #     portion of the requests path is replaced by this value.
  # @!attribute [rw] host_rewrite
  #   @return [::String]
  #     Prior to forwarding the request to the selected destination, the requests
  #     host header is replaced by this value.
  class URLRewrite
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specifications for retries.
  # @!attribute [rw] retry_conditions
  #   @return [::Array<::String>]
  #     Specifies one or more conditions when this retry policy applies. Valid
  #     values are:
  #       5xx: Proxy will attempt a retry if the destination service responds
  #         with any 5xx response code, of if the destination service does not
  #         respond at all, example: disconnect, reset, read timeout, connection
  #         failure and refused streams.
  #
  #       gateway-error: Similar to 5xx, but only applies to response codes 502,
  #         503, 504.
  #
  #       reset: Proxy will attempt a retry if the destination service does not
  #         respond at all (disconnect/reset/read timeout)
  #
  #       connect-failure: Proxy will retry on failures connecting to destination
  #         for example due to connection timeouts.
  #
  #       retriable-4xx: Proxy will retry fro retriable 4xx response codes.
  #         Currently the only retriable error supported is 409.
  #
  #       refused-stream: Proxy will retry if the destination resets the stream
  #         with a REFUSED_STREAM error code. This reset type indicates that it
  #         is safe to retry.
  # @!attribute [rw] num_retries
  #   @return [::Integer]
  #     Specifies the allowed number of retries. This number must be > 0. If not
  #     specified, default to 1.
  # @!attribute [rw] per_try_timeout
  #   @return [::Google::Protobuf::Duration]
  #     Specifies a non-zero timeout per retry attempt.
  class RetryPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the policy on how requests are shadowed to a separate mirrored
  # destination service. The proxy does not wait for responses from the
  # shadow service. Prior to sending traffic to the shadow service, the
  # host/authority header is suffixed with -shadow.
  # @!attribute [rw] destination
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::Destination]
  #     The destination the requests will be mirrored to. The weight of the
  #     destination will be ignored.
  class RequestMirrorPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Specification for allowing client side cross-origin requests.
  # @!attribute [rw] allow_origins
  #   @return [::Array<::String>]
  #     Specifies the list of origins that will be allowed to do CORS requests.
  #     An origin is allowed if it matches either an item in allow_origins or
  #     an item in allow_origin_regexes.
  # @!attribute [rw] allow_origin_regexes
  #   @return [::Array<::String>]
  #     Specifies the regular expression patterns that match allowed origins. For
  #     regular expression grammar, please see
  #     https://github.com/google/re2/wiki/Syntax.
  # @!attribute [rw] allow_methods
  #   @return [::Array<::String>]
  #     Specifies the content for Access-Control-Allow-Methods header.
  # @!attribute [rw] allow_headers
  #   @return [::Array<::String>]
  #     Specifies the content for Access-Control-Allow-Headers header.
  # @!attribute [rw] expose_headers
  #   @return [::Array<::String>]
  #     Specifies the content for Access-Control-Expose-Headers header.
  # @!attribute [rw] max_age
  #   @return [::String]
  #     Specifies how long result of a preflight request can be cached in
  #     seconds. This translates to the Access-Control-Max-Age header.
  # @!attribute [rw] allow_credentials
  #   @return [::Boolean]
  #     In response to a preflight request, setting this to true indicates that
  #     the actual request can include user credentials. This translates to the
  #     Access-Control-Allow-Credentials header.
  #
  #     Default value is false.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     If true, the CORS policy is disabled. The default value is false, which
  #     indicates that the CORS policy is in effect.
  class CorsPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specifications for routing traffic and applying associated policies.
  # @!attribute [rw] destinations
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::Destination>]
  #     The destination to which traffic should be forwarded.
  # @!attribute [rw] redirect
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::Redirect]
  #     If set, the request is directed as configured by this field.
  # @!attribute [rw] fault_injection_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::FaultInjectionPolicy]
  #     The specification for fault injection introduced into traffic to test the
  #     resiliency of clients to backend service failure. As part of fault
  #     injection, when clients send requests to a backend service, delays can be
  #     introduced  on a percentage of requests before sending those requests to
  #     the backend service. Similarly requests from clients can be aborted for a
  #     percentage of requests.
  #
  #     timeout and retry_policy will be ignored by clients that are configured
  #     with a fault_injection_policy
  # @!attribute [rw] request_header_modifier
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderModifier]
  #     The specification for modifying the headers of a matching request prior
  #     to delivery of the request to the destination. If HeaderModifiers are set
  #     on both the Destination and the RouteAction, they will be merged.
  #     Conflicts between the two will not be resolved on the configuration.
  # @!attribute [rw] response_header_modifier
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderModifier]
  #     The specification for modifying the headers of a response prior to
  #     sending the response back to the client. If HeaderModifiers are set
  #     on both the Destination and the RouteAction, they will be merged.
  #     Conflicts between the two will not be resolved on the configuration.
  # @!attribute [rw] url_rewrite
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::URLRewrite]
  #     The specification for rewrite URL before forwarding requests to the
  #     destination.
  # @!attribute [rw] timeout
  #   @return [::Google::Protobuf::Duration]
  #     Specifies the timeout for selected route. Timeout is computed from the
  #     time the request has been fully processed (i.e. end of stream) up until
  #     the response has been completely processed. Timeout includes all retries.
  # @!attribute [rw] retry_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::RetryPolicy]
  #     Specifies the retry policy associated with this route.
  # @!attribute [rw] request_mirror_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::RequestMirrorPolicy]
  #     Specifies the policy on how requests intended for the routes destination
  #     are shadowed to a separate mirrored destination. Proxy will not wait for
  #     the shadow destination to respond before returning the response. Prior to
  #     sending traffic to the shadow service, the host/authority header is
  #     suffixed with -shadow.
  # @!attribute [rw] cors_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::CorsPolicy]
  #     The specification for allowing client side cross-origin requests.
  class RouteAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies how to match traffic and how to route traffic when traffic is
  # matched.
  # @!attribute [rw] matches
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::RouteMatch>]
  #     A list of matches define conditions used for matching the rule against
  #     incoming HTTP requests. Each match is independent, i.e. this rule will be
  #     matched if ANY one of the matches is satisfied.
  #
  #     If no matches field is specified, this rule will unconditionally match
  #     traffic.
  #
  #     If a default rule is desired to be configured, add a rule with no matches
  #     specified to the end of the rules list.
  # @!attribute [rw] action
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::RouteAction]
  #     The detailed rule defining how to route matched traffic.
  class RouteRule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#meshes ⇒ ::Array<::String>

Returns Optional. Meshes defines a list of meshes this HttpRoute is attached to, as one of the routing rules to route the requests served by the mesh.

Each mesh reference should match the pattern: projects/*/locations/global/meshes/<mesh_name>

The attached Mesh should be of a type SIDECAR.

Returns:

• (::Array<::String>) —

  Optional. Meshes defines a list of meshes this HttpRoute is attached to, as one of the routing rules to route the requests served by the mesh.

  Each mesh reference should match the pattern: projects/*/locations/global/meshes/<mesh_name>

  The attached Mesh should be of a type SIDECAR

# File 'proto_docs/google/cloud/networkservices/v1/http_route.rb', line 94

class HttpRoute
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to select a route rule based on HTTP request headers.
  # @!attribute [rw] exact_match
  #   @return [::String]
  #     The value of the header should match exactly the content of
  #     exact_match.
  # @!attribute [rw] regex_match
  #   @return [::String]
  #     The value of the header must match the regular expression specified in
  #     regex_match. For regular expression grammar, please see:
  #     https://github.com/google/re2/wiki/Syntax
  # @!attribute [rw] prefix_match
  #   @return [::String]
  #     The value of the header must start with the contents of prefix_match.
  # @!attribute [rw] present_match
  #   @return [::Boolean]
  #     A header with header_name must exist. The match takes place whether or
  #     not the header has a value.
  # @!attribute [rw] suffix_match
  #   @return [::String]
  #     The value of the header must end with the contents of suffix_match.
  # @!attribute [rw] range_match
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderMatch::IntegerRange]
  #     If specified, the rule will match if the request header value is within
  #     the range.
  # @!attribute [rw] header
  #   @return [::String]
  #     The name of the HTTP header to match against.
  # @!attribute [rw] invert_match
  #   @return [::Boolean]
  #     If specified, the match result will be inverted before checking. Default
  #     value is set to false.
  class HeaderMatch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents an integer value range.
    # @!attribute [rw] start
    #   @return [::Integer]
    #     Start of the range (inclusive)
    # @!attribute [rw] end
    #   @return [::Integer]
    #     End of the range (exclusive)
    class IntegerRange
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Specifications to match a query parameter in the request.
  # @!attribute [rw] exact_match
  #   @return [::String]
  #     The value of the query parameter must exactly match the contents of
  #     exact_match.
  #
  #     Only one of exact_match, regex_match, or present_match must be set.
  # @!attribute [rw] regex_match
  #   @return [::String]
  #     The value of the query parameter must match the regular expression
  #     specified by regex_match. For regular expression grammar, please see
  #     https://github.com/google/re2/wiki/Syntax
  #
  #     Only one of exact_match, regex_match, or present_match must be set.
  # @!attribute [rw] present_match
  #   @return [::Boolean]
  #     Specifies that the QueryParameterMatcher matches if request contains
  #     query parameter, irrespective of whether the parameter has a value or
  #     not.
  #
  #     Only one of exact_match, regex_match, or present_match must be set.
  # @!attribute [rw] query_parameter
  #   @return [::String]
  #     The name of the query parameter to match.
  class QueryParameterMatch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # RouteMatch defines specifications used to match requests. If multiple match
  # types are set, this RouteMatch will match if ALL type of matches are
  # matched.
  # @!attribute [rw] full_path_match
  #   @return [::String]
  #     The HTTP request path value should exactly match this value.
  #
  #     Only one of full_path_match, prefix_match, or regex_match should be
  #     used.
  # @!attribute [rw] prefix_match
  #   @return [::String]
  #     The HTTP request path value must begin with specified prefix_match.
  #     prefix_match must begin with a /.
  #
  #     Only one of full_path_match, prefix_match, or regex_match should be
  #     used.
  # @!attribute [rw] regex_match
  #   @return [::String]
  #     The HTTP request path value must satisfy the regular expression
  #     specified by regex_match after removing any query parameters and anchor
  #     supplied with the original URL. For regular expression grammar, please
  #     see https://github.com/google/re2/wiki/Syntax
  #
  #     Only one of full_path_match, prefix_match, or regex_match should be
  #     used.
  # @!attribute [rw] ignore_case
  #   @return [::Boolean]
  #     Specifies if prefix_match and full_path_match matches are case sensitive.
  #     The default value is false.
  # @!attribute [rw] headers
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderMatch>]
  #     Specifies a list of HTTP request headers to match against. ALL of the
  #     supplied headers must be matched.
  # @!attribute [rw] query_parameters
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::QueryParameterMatch>]
  #     Specifies a list of query parameters to match against. ALL of the query
  #     parameters must be matched.
  class RouteMatch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifications of a destination to which the request should be routed to.
  # @!attribute [rw] service_name
  #   @return [::String]
  #     The URL of a BackendService to route traffic to.
  # @!attribute [rw] weight
  #   @return [::Integer]
  #     Specifies the proportion of requests forwarded to the backend referenced
  #     by the serviceName field. This is computed as:
  #     - weight/Sum(weights in this destination list).
  #     For non-zero values, there may be some epsilon from the exact proportion
  #     defined here depending on the precision an implementation supports.
  #
  #     If only one serviceName is specified and it has a weight greater than 0,
  #     100% of the traffic is forwarded to that backend.
  #
  #     If weights are specified for any one service name, they need to be
  #     specified for all of them.
  #
  #     If weights are unspecified for all services, then, traffic is distributed
  #     in equal proportions to all of them.
  class Destination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specification for redirecting traffic.
  # @!attribute [rw] host_redirect
  #   @return [::String]
  #     The host that will be used in the redirect response instead of the one
  #     that was supplied in the request.
  # @!attribute [rw] path_redirect
  #   @return [::String]
  #     The path that will be used in the redirect response instead of the one
  #     that was supplied in the request.
  #     path_redirect can not be supplied together with prefix_redirect. Supply
  #     one alone or neither. If neither is supplied, the path of the original
  #     request will be used for the redirect.
  # @!attribute [rw] prefix_rewrite
  #   @return [::String]
  #     Indicates that during redirection, the matched prefix (or path) should be
  #     swapped with this value. This option allows URLs be dynamically created
  #     based on the request.
  # @!attribute [rw] response_code
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::Redirect::ResponseCode]
  #     The HTTP Status code to use for the redirect.
  # @!attribute [rw] https_redirect
  #   @return [::Boolean]
  #     If set to true, the URL scheme in the redirected request is set to https.
  #     If set to false, the URL scheme of the redirected request will remain the
  #     same as that of the request.
  #
  #     The default is set to false.
  # @!attribute [rw] strip_query
  #   @return [::Boolean]
  #     if set to true, any accompanying query portion of the original URL is
  #     removed prior to redirecting the request. If set to false, the query
  #     portion of the original URL is retained.
  #
  #     The default is set to false.
  # @!attribute [rw] port_redirect
  #   @return [::Integer]
  #     The port that will be used in the redirected request instead of the one
  #     that was supplied in the request.
  class Redirect
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Supported HTTP response code.
    module ResponseCode
      # Default value
      RESPONSE_CODE_UNSPECIFIED = 0

      # Corresponds to 301.
      MOVED_PERMANENTLY_DEFAULT = 1

      # Corresponds to 302.
      FOUND = 2

      # Corresponds to 303.
      SEE_OTHER = 3

      # Corresponds to 307. In this case, the request method will be retained.
      TEMPORARY_REDIRECT = 4

      # Corresponds to 308. In this case, the request method will be retained.
      PERMANENT_REDIRECT = 5
    end
  end

  # The specification for fault injection introduced into traffic to test the
  # resiliency of clients to destination service failure. As part of fault
  # injection, when clients send requests to a destination, delays can be
  # introduced by client proxy on a percentage of requests before sending those
  # requests to the destination service. Similarly requests can be aborted by
  # client proxy for a percentage of requests.
  # @!attribute [rw] delay
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::FaultInjectionPolicy::Delay]
  #     The specification for injecting delay to client requests.
  # @!attribute [rw] abort
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::FaultInjectionPolicy::Abort]
  #     The specification for aborting to client requests.
  class FaultInjectionPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specification of how client requests are delayed as part of fault
    # injection before being sent to a destination.
    # @!attribute [rw] fixed_delay
    #   @return [::Google::Protobuf::Duration]
    #     Specify a fixed delay before forwarding the request.
    # @!attribute [rw] percentage
    #   @return [::Integer]
    #     The percentage of traffic on which delay will be injected.
    #
    #     The value must be between [0, 100]
    class Delay
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specification of how client requests are aborted as part of fault
    # injection before being sent to a destination.
    # @!attribute [rw] http_status
    #   @return [::Integer]
    #     The HTTP status code used to abort the request.
    #
    #     The value must be between 200 and 599 inclusive.
    # @!attribute [rw] percentage
    #   @return [::Integer]
    #     The percentage of traffic which will be aborted.
    #
    #     The value must be between [0, 100]
    class Abort
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The specification for modifying HTTP header in HTTP request and HTTP
  # response.
  # @!attribute [rw] set
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Completely overwrite/replace the headers with given map where key is the
  #     name of the header, value is the value of the header.
  # @!attribute [rw] add
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Add the headers with given map where key is the name of the header, value
  #     is the value of the header.
  # @!attribute [rw] remove
  #   @return [::Array<::String>]
  #     Remove headers (matching by header names) specified in the list.
  class HeaderModifier
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class SetEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class AddEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The specification for modifying the URL of the request, prior to forwarding
  # the request to the destination.
  # @!attribute [rw] path_prefix_rewrite
  #   @return [::String]
  #     Prior to forwarding the request to the selected destination, the matching
  #     portion of the requests path is replaced by this value.
  # @!attribute [rw] host_rewrite
  #   @return [::String]
  #     Prior to forwarding the request to the selected destination, the requests
  #     host header is replaced by this value.
  class URLRewrite
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specifications for retries.
  # @!attribute [rw] retry_conditions
  #   @return [::Array<::String>]
  #     Specifies one or more conditions when this retry policy applies. Valid
  #     values are:
  #       5xx: Proxy will attempt a retry if the destination service responds
  #         with any 5xx response code, of if the destination service does not
  #         respond at all, example: disconnect, reset, read timeout, connection
  #         failure and refused streams.
  #
  #       gateway-error: Similar to 5xx, but only applies to response codes 502,
  #         503, 504.
  #
  #       reset: Proxy will attempt a retry if the destination service does not
  #         respond at all (disconnect/reset/read timeout)
  #
  #       connect-failure: Proxy will retry on failures connecting to destination
  #         for example due to connection timeouts.
  #
  #       retriable-4xx: Proxy will retry fro retriable 4xx response codes.
  #         Currently the only retriable error supported is 409.
  #
  #       refused-stream: Proxy will retry if the destination resets the stream
  #         with a REFUSED_STREAM error code. This reset type indicates that it
  #         is safe to retry.
  # @!attribute [rw] num_retries
  #   @return [::Integer]
  #     Specifies the allowed number of retries. This number must be > 0. If not
  #     specified, default to 1.
  # @!attribute [rw] per_try_timeout
  #   @return [::Google::Protobuf::Duration]
  #     Specifies a non-zero timeout per retry attempt.
  class RetryPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the policy on how requests are shadowed to a separate mirrored
  # destination service. The proxy does not wait for responses from the
  # shadow service. Prior to sending traffic to the shadow service, the
  # host/authority header is suffixed with -shadow.
  # @!attribute [rw] destination
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::Destination]
  #     The destination the requests will be mirrored to. The weight of the
  #     destination will be ignored.
  class RequestMirrorPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Specification for allowing client side cross-origin requests.
  # @!attribute [rw] allow_origins
  #   @return [::Array<::String>]
  #     Specifies the list of origins that will be allowed to do CORS requests.
  #     An origin is allowed if it matches either an item in allow_origins or
  #     an item in allow_origin_regexes.
  # @!attribute [rw] allow_origin_regexes
  #   @return [::Array<::String>]
  #     Specifies the regular expression patterns that match allowed origins. For
  #     regular expression grammar, please see
  #     https://github.com/google/re2/wiki/Syntax.
  # @!attribute [rw] allow_methods
  #   @return [::Array<::String>]
  #     Specifies the content for Access-Control-Allow-Methods header.
  # @!attribute [rw] allow_headers
  #   @return [::Array<::String>]
  #     Specifies the content for Access-Control-Allow-Headers header.
  # @!attribute [rw] expose_headers
  #   @return [::Array<::String>]
  #     Specifies the content for Access-Control-Expose-Headers header.
  # @!attribute [rw] max_age
  #   @return [::String]
  #     Specifies how long result of a preflight request can be cached in
  #     seconds. This translates to the Access-Control-Max-Age header.
  # @!attribute [rw] allow_credentials
  #   @return [::Boolean]
  #     In response to a preflight request, setting this to true indicates that
  #     the actual request can include user credentials. This translates to the
  #     Access-Control-Allow-Credentials header.
  #
  #     Default value is false.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     If true, the CORS policy is disabled. The default value is false, which
  #     indicates that the CORS policy is in effect.
  class CorsPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specifications for routing traffic and applying associated policies.
  # @!attribute [rw] destinations
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::Destination>]
  #     The destination to which traffic should be forwarded.
  # @!attribute [rw] redirect
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::Redirect]
  #     If set, the request is directed as configured by this field.
  # @!attribute [rw] fault_injection_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::FaultInjectionPolicy]
  #     The specification for fault injection introduced into traffic to test the
  #     resiliency of clients to backend service failure. As part of fault
  #     injection, when clients send requests to a backend service, delays can be
  #     introduced  on a percentage of requests before sending those requests to
  #     the backend service. Similarly requests from clients can be aborted for a
  #     percentage of requests.
  #
  #     timeout and retry_policy will be ignored by clients that are configured
  #     with a fault_injection_policy
  # @!attribute [rw] request_header_modifier
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderModifier]
  #     The specification for modifying the headers of a matching request prior
  #     to delivery of the request to the destination. If HeaderModifiers are set
  #     on both the Destination and the RouteAction, they will be merged.
  #     Conflicts between the two will not be resolved on the configuration.
  # @!attribute [rw] response_header_modifier
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderModifier]
  #     The specification for modifying the headers of a response prior to
  #     sending the response back to the client. If HeaderModifiers are set
  #     on both the Destination and the RouteAction, they will be merged.
  #     Conflicts between the two will not be resolved on the configuration.
  # @!attribute [rw] url_rewrite
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::URLRewrite]
  #     The specification for rewrite URL before forwarding requests to the
  #     destination.
  # @!attribute [rw] timeout
  #   @return [::Google::Protobuf::Duration]
  #     Specifies the timeout for selected route. Timeout is computed from the
  #     time the request has been fully processed (i.e. end of stream) up until
  #     the response has been completely processed. Timeout includes all retries.
  # @!attribute [rw] retry_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::RetryPolicy]
  #     Specifies the retry policy associated with this route.
  # @!attribute [rw] request_mirror_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::RequestMirrorPolicy]
  #     Specifies the policy on how requests intended for the routes destination
  #     are shadowed to a separate mirrored destination. Proxy will not wait for
  #     the shadow destination to respond before returning the response. Prior to
  #     sending traffic to the shadow service, the host/authority header is
  #     suffixed with -shadow.
  # @!attribute [rw] cors_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::CorsPolicy]
  #     The specification for allowing client side cross-origin requests.
  class RouteAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies how to match traffic and how to route traffic when traffic is
  # matched.
  # @!attribute [rw] matches
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::RouteMatch>]
  #     A list of matches define conditions used for matching the rule against
  #     incoming HTTP requests. Each match is independent, i.e. this rule will be
  #     matched if ANY one of the matches is satisfied.
  #
  #     If no matches field is specified, this rule will unconditionally match
  #     traffic.
  #
  #     If a default rule is desired to be configured, add a rule with no matches
  #     specified to the end of the rules list.
  # @!attribute [rw] action
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::RouteAction]
  #     The detailed rule defining how to route matched traffic.
  class RouteRule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns Required. Name of the HttpRoute resource. It matches pattern projects/*/locations/global/httpRoutes/http_route_name>.

Returns:

• (::String) —

  Required. Name of the HttpRoute resource. It matches pattern projects/*/locations/global/httpRoutes/http_route_name>.

# File 'proto_docs/google/cloud/networkservices/v1/http_route.rb', line 94

class HttpRoute
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to select a route rule based on HTTP request headers.
  # @!attribute [rw] exact_match
  #   @return [::String]
  #     The value of the header should match exactly the content of
  #     exact_match.
  # @!attribute [rw] regex_match
  #   @return [::String]
  #     The value of the header must match the regular expression specified in
  #     regex_match. For regular expression grammar, please see:
  #     https://github.com/google/re2/wiki/Syntax
  # @!attribute [rw] prefix_match
  #   @return [::String]
  #     The value of the header must start with the contents of prefix_match.
  # @!attribute [rw] present_match
  #   @return [::Boolean]
  #     A header with header_name must exist. The match takes place whether or
  #     not the header has a value.
  # @!attribute [rw] suffix_match
  #   @return [::String]
  #     The value of the header must end with the contents of suffix_match.
  # @!attribute [rw] range_match
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderMatch::IntegerRange]
  #     If specified, the rule will match if the request header value is within
  #     the range.
  # @!attribute [rw] header
  #   @return [::String]
  #     The name of the HTTP header to match against.
  # @!attribute [rw] invert_match
  #   @return [::Boolean]
  #     If specified, the match result will be inverted before checking. Default
  #     value is set to false.
  class HeaderMatch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents an integer value range.
    # @!attribute [rw] start
    #   @return [::Integer]
    #     Start of the range (inclusive)
    # @!attribute [rw] end
    #   @return [::Integer]
    #     End of the range (exclusive)
    class IntegerRange
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Specifications to match a query parameter in the request.
  # @!attribute [rw] exact_match
  #   @return [::String]
  #     The value of the query parameter must exactly match the contents of
  #     exact_match.
  #
  #     Only one of exact_match, regex_match, or present_match must be set.
  # @!attribute [rw] regex_match
  #   @return [::String]
  #     The value of the query parameter must match the regular expression
  #     specified by regex_match. For regular expression grammar, please see
  #     https://github.com/google/re2/wiki/Syntax
  #
  #     Only one of exact_match, regex_match, or present_match must be set.
  # @!attribute [rw] present_match
  #   @return [::Boolean]
  #     Specifies that the QueryParameterMatcher matches if request contains
  #     query parameter, irrespective of whether the parameter has a value or
  #     not.
  #
  #     Only one of exact_match, regex_match, or present_match must be set.
  # @!attribute [rw] query_parameter
  #   @return [::String]
  #     The name of the query parameter to match.
  class QueryParameterMatch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # RouteMatch defines specifications used to match requests. If multiple match
  # types are set, this RouteMatch will match if ALL type of matches are
  # matched.
  # @!attribute [rw] full_path_match
  #   @return [::String]
  #     The HTTP request path value should exactly match this value.
  #
  #     Only one of full_path_match, prefix_match, or regex_match should be
  #     used.
  # @!attribute [rw] prefix_match
  #   @return [::String]
  #     The HTTP request path value must begin with specified prefix_match.
  #     prefix_match must begin with a /.
  #
  #     Only one of full_path_match, prefix_match, or regex_match should be
  #     used.
  # @!attribute [rw] regex_match
  #   @return [::String]
  #     The HTTP request path value must satisfy the regular expression
  #     specified by regex_match after removing any query parameters and anchor
  #     supplied with the original URL. For regular expression grammar, please
  #     see https://github.com/google/re2/wiki/Syntax
  #
  #     Only one of full_path_match, prefix_match, or regex_match should be
  #     used.
  # @!attribute [rw] ignore_case
  #   @return [::Boolean]
  #     Specifies if prefix_match and full_path_match matches are case sensitive.
  #     The default value is false.
  # @!attribute [rw] headers
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderMatch>]
  #     Specifies a list of HTTP request headers to match against. ALL of the
  #     supplied headers must be matched.
  # @!attribute [rw] query_parameters
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::QueryParameterMatch>]
  #     Specifies a list of query parameters to match against. ALL of the query
  #     parameters must be matched.
  class RouteMatch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifications of a destination to which the request should be routed to.
  # @!attribute [rw] service_name
  #   @return [::String]
  #     The URL of a BackendService to route traffic to.
  # @!attribute [rw] weight
  #   @return [::Integer]
  #     Specifies the proportion of requests forwarded to the backend referenced
  #     by the serviceName field. This is computed as:
  #     - weight/Sum(weights in this destination list).
  #     For non-zero values, there may be some epsilon from the exact proportion
  #     defined here depending on the precision an implementation supports.
  #
  #     If only one serviceName is specified and it has a weight greater than 0,
  #     100% of the traffic is forwarded to that backend.
  #
  #     If weights are specified for any one service name, they need to be
  #     specified for all of them.
  #
  #     If weights are unspecified for all services, then, traffic is distributed
  #     in equal proportions to all of them.
  class Destination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specification for redirecting traffic.
  # @!attribute [rw] host_redirect
  #   @return [::String]
  #     The host that will be used in the redirect response instead of the one
  #     that was supplied in the request.
  # @!attribute [rw] path_redirect
  #   @return [::String]
  #     The path that will be used in the redirect response instead of the one
  #     that was supplied in the request.
  #     path_redirect can not be supplied together with prefix_redirect. Supply
  #     one alone or neither. If neither is supplied, the path of the original
  #     request will be used for the redirect.
  # @!attribute [rw] prefix_rewrite
  #   @return [::String]
  #     Indicates that during redirection, the matched prefix (or path) should be
  #     swapped with this value. This option allows URLs be dynamically created
  #     based on the request.
  # @!attribute [rw] response_code
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::Redirect::ResponseCode]
  #     The HTTP Status code to use for the redirect.
  # @!attribute [rw] https_redirect
  #   @return [::Boolean]
  #     If set to true, the URL scheme in the redirected request is set to https.
  #     If set to false, the URL scheme of the redirected request will remain the
  #     same as that of the request.
  #
  #     The default is set to false.
  # @!attribute [rw] strip_query
  #   @return [::Boolean]
  #     if set to true, any accompanying query portion of the original URL is
  #     removed prior to redirecting the request. If set to false, the query
  #     portion of the original URL is retained.
  #
  #     The default is set to false.
  # @!attribute [rw] port_redirect
  #   @return [::Integer]
  #     The port that will be used in the redirected request instead of the one
  #     that was supplied in the request.
  class Redirect
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Supported HTTP response code.
    module ResponseCode
      # Default value
      RESPONSE_CODE_UNSPECIFIED = 0

      # Corresponds to 301.
      MOVED_PERMANENTLY_DEFAULT = 1

      # Corresponds to 302.
      FOUND = 2

      # Corresponds to 303.
      SEE_OTHER = 3

      # Corresponds to 307. In this case, the request method will be retained.
      TEMPORARY_REDIRECT = 4

      # Corresponds to 308. In this case, the request method will be retained.
      PERMANENT_REDIRECT = 5
    end
  end

  # The specification for fault injection introduced into traffic to test the
  # resiliency of clients to destination service failure. As part of fault
  # injection, when clients send requests to a destination, delays can be
  # introduced by client proxy on a percentage of requests before sending those
  # requests to the destination service. Similarly requests can be aborted by
  # client proxy for a percentage of requests.
  # @!attribute [rw] delay
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::FaultInjectionPolicy::Delay]
  #     The specification for injecting delay to client requests.
  # @!attribute [rw] abort
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::FaultInjectionPolicy::Abort]
  #     The specification for aborting to client requests.
  class FaultInjectionPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specification of how client requests are delayed as part of fault
    # injection before being sent to a destination.
    # @!attribute [rw] fixed_delay
    #   @return [::Google::Protobuf::Duration]
    #     Specify a fixed delay before forwarding the request.
    # @!attribute [rw] percentage
    #   @return [::Integer]
    #     The percentage of traffic on which delay will be injected.
    #
    #     The value must be between [0, 100]
    class Delay
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specification of how client requests are aborted as part of fault
    # injection before being sent to a destination.
    # @!attribute [rw] http_status
    #   @return [::Integer]
    #     The HTTP status code used to abort the request.
    #
    #     The value must be between 200 and 599 inclusive.
    # @!attribute [rw] percentage
    #   @return [::Integer]
    #     The percentage of traffic which will be aborted.
    #
    #     The value must be between [0, 100]
    class Abort
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The specification for modifying HTTP header in HTTP request and HTTP
  # response.
  # @!attribute [rw] set
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Completely overwrite/replace the headers with given map where key is the
  #     name of the header, value is the value of the header.
  # @!attribute [rw] add
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Add the headers with given map where key is the name of the header, value
  #     is the value of the header.
  # @!attribute [rw] remove
  #   @return [::Array<::String>]
  #     Remove headers (matching by header names) specified in the list.
  class HeaderModifier
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class SetEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class AddEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The specification for modifying the URL of the request, prior to forwarding
  # the request to the destination.
  # @!attribute [rw] path_prefix_rewrite
  #   @return [::String]
  #     Prior to forwarding the request to the selected destination, the matching
  #     portion of the requests path is replaced by this value.
  # @!attribute [rw] host_rewrite
  #   @return [::String]
  #     Prior to forwarding the request to the selected destination, the requests
  #     host header is replaced by this value.
  class URLRewrite
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specifications for retries.
  # @!attribute [rw] retry_conditions
  #   @return [::Array<::String>]
  #     Specifies one or more conditions when this retry policy applies. Valid
  #     values are:
  #       5xx: Proxy will attempt a retry if the destination service responds
  #         with any 5xx response code, of if the destination service does not
  #         respond at all, example: disconnect, reset, read timeout, connection
  #         failure and refused streams.
  #
  #       gateway-error: Similar to 5xx, but only applies to response codes 502,
  #         503, 504.
  #
  #       reset: Proxy will attempt a retry if the destination service does not
  #         respond at all (disconnect/reset/read timeout)
  #
  #       connect-failure: Proxy will retry on failures connecting to destination
  #         for example due to connection timeouts.
  #
  #       retriable-4xx: Proxy will retry fro retriable 4xx response codes.
  #         Currently the only retriable error supported is 409.
  #
  #       refused-stream: Proxy will retry if the destination resets the stream
  #         with a REFUSED_STREAM error code. This reset type indicates that it
  #         is safe to retry.
  # @!attribute [rw] num_retries
  #   @return [::Integer]
  #     Specifies the allowed number of retries. This number must be > 0. If not
  #     specified, default to 1.
  # @!attribute [rw] per_try_timeout
  #   @return [::Google::Protobuf::Duration]
  #     Specifies a non-zero timeout per retry attempt.
  class RetryPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the policy on how requests are shadowed to a separate mirrored
  # destination service. The proxy does not wait for responses from the
  # shadow service. Prior to sending traffic to the shadow service, the
  # host/authority header is suffixed with -shadow.
  # @!attribute [rw] destination
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::Destination]
  #     The destination the requests will be mirrored to. The weight of the
  #     destination will be ignored.
  class RequestMirrorPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Specification for allowing client side cross-origin requests.
  # @!attribute [rw] allow_origins
  #   @return [::Array<::String>]
  #     Specifies the list of origins that will be allowed to do CORS requests.
  #     An origin is allowed if it matches either an item in allow_origins or
  #     an item in allow_origin_regexes.
  # @!attribute [rw] allow_origin_regexes
  #   @return [::Array<::String>]
  #     Specifies the regular expression patterns that match allowed origins. For
  #     regular expression grammar, please see
  #     https://github.com/google/re2/wiki/Syntax.
  # @!attribute [rw] allow_methods
  #   @return [::Array<::String>]
  #     Specifies the content for Access-Control-Allow-Methods header.
  # @!attribute [rw] allow_headers
  #   @return [::Array<::String>]
  #     Specifies the content for Access-Control-Allow-Headers header.
  # @!attribute [rw] expose_headers
  #   @return [::Array<::String>]
  #     Specifies the content for Access-Control-Expose-Headers header.
  # @!attribute [rw] max_age
  #   @return [::String]
  #     Specifies how long result of a preflight request can be cached in
  #     seconds. This translates to the Access-Control-Max-Age header.
  # @!attribute [rw] allow_credentials
  #   @return [::Boolean]
  #     In response to a preflight request, setting this to true indicates that
  #     the actual request can include user credentials. This translates to the
  #     Access-Control-Allow-Credentials header.
  #
  #     Default value is false.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     If true, the CORS policy is disabled. The default value is false, which
  #     indicates that the CORS policy is in effect.
  class CorsPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specifications for routing traffic and applying associated policies.
  # @!attribute [rw] destinations
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::Destination>]
  #     The destination to which traffic should be forwarded.
  # @!attribute [rw] redirect
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::Redirect]
  #     If set, the request is directed as configured by this field.
  # @!attribute [rw] fault_injection_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::FaultInjectionPolicy]
  #     The specification for fault injection introduced into traffic to test the
  #     resiliency of clients to backend service failure. As part of fault
  #     injection, when clients send requests to a backend service, delays can be
  #     introduced  on a percentage of requests before sending those requests to
  #     the backend service. Similarly requests from clients can be aborted for a
  #     percentage of requests.
  #
  #     timeout and retry_policy will be ignored by clients that are configured
  #     with a fault_injection_policy
  # @!attribute [rw] request_header_modifier
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderModifier]
  #     The specification for modifying the headers of a matching request prior
  #     to delivery of the request to the destination. If HeaderModifiers are set
  #     on both the Destination and the RouteAction, they will be merged.
  #     Conflicts between the two will not be resolved on the configuration.
  # @!attribute [rw] response_header_modifier
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderModifier]
  #     The specification for modifying the headers of a response prior to
  #     sending the response back to the client. If HeaderModifiers are set
  #     on both the Destination and the RouteAction, they will be merged.
  #     Conflicts between the two will not be resolved on the configuration.
  # @!attribute [rw] url_rewrite
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::URLRewrite]
  #     The specification for rewrite URL before forwarding requests to the
  #     destination.
  # @!attribute [rw] timeout
  #   @return [::Google::Protobuf::Duration]
  #     Specifies the timeout for selected route. Timeout is computed from the
  #     time the request has been fully processed (i.e. end of stream) up until
  #     the response has been completely processed. Timeout includes all retries.
  # @!attribute [rw] retry_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::RetryPolicy]
  #     Specifies the retry policy associated with this route.
  # @!attribute [rw] request_mirror_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::RequestMirrorPolicy]
  #     Specifies the policy on how requests intended for the routes destination
  #     are shadowed to a separate mirrored destination. Proxy will not wait for
  #     the shadow destination to respond before returning the response. Prior to
  #     sending traffic to the shadow service, the host/authority header is
  #     suffixed with -shadow.
  # @!attribute [rw] cors_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::CorsPolicy]
  #     The specification for allowing client side cross-origin requests.
  class RouteAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies how to match traffic and how to route traffic when traffic is
  # matched.
  # @!attribute [rw] matches
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::RouteMatch>]
  #     A list of matches define conditions used for matching the rule against
  #     incoming HTTP requests. Each match is independent, i.e. this rule will be
  #     matched if ANY one of the matches is satisfied.
  #
  #     If no matches field is specified, this rule will unconditionally match
  #     traffic.
  #
  #     If a default rule is desired to be configured, add a rule with no matches
  #     specified to the end of the rules list.
  # @!attribute [rw] action
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::RouteAction]
  #     The detailed rule defining how to route matched traffic.
  class RouteRule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#rules ⇒ ::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::RouteRule>

Returns Required. Rules that define how traffic is routed and handled. Rules will be matched sequentially based on the RouteMatch specified for the rule.

Returns:

• (::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::RouteRule>) —

  Required. Rules that define how traffic is routed and handled. Rules will be matched sequentially based on the RouteMatch specified for the rule.

# File 'proto_docs/google/cloud/networkservices/v1/http_route.rb', line 94

class HttpRoute
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to select a route rule based on HTTP request headers.
  # @!attribute [rw] exact_match
  #   @return [::String]
  #     The value of the header should match exactly the content of
  #     exact_match.
  # @!attribute [rw] regex_match
  #   @return [::String]
  #     The value of the header must match the regular expression specified in
  #     regex_match. For regular expression grammar, please see:
  #     https://github.com/google/re2/wiki/Syntax
  # @!attribute [rw] prefix_match
  #   @return [::String]
  #     The value of the header must start with the contents of prefix_match.
  # @!attribute [rw] present_match
  #   @return [::Boolean]
  #     A header with header_name must exist. The match takes place whether or
  #     not the header has a value.
  # @!attribute [rw] suffix_match
  #   @return [::String]
  #     The value of the header must end with the contents of suffix_match.
  # @!attribute [rw] range_match
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderMatch::IntegerRange]
  #     If specified, the rule will match if the request header value is within
  #     the range.
  # @!attribute [rw] header
  #   @return [::String]
  #     The name of the HTTP header to match against.
  # @!attribute [rw] invert_match
  #   @return [::Boolean]
  #     If specified, the match result will be inverted before checking. Default
  #     value is set to false.
  class HeaderMatch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents an integer value range.
    # @!attribute [rw] start
    #   @return [::Integer]
    #     Start of the range (inclusive)
    # @!attribute [rw] end
    #   @return [::Integer]
    #     End of the range (exclusive)
    class IntegerRange
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Specifications to match a query parameter in the request.
  # @!attribute [rw] exact_match
  #   @return [::String]
  #     The value of the query parameter must exactly match the contents of
  #     exact_match.
  #
  #     Only one of exact_match, regex_match, or present_match must be set.
  # @!attribute [rw] regex_match
  #   @return [::String]
  #     The value of the query parameter must match the regular expression
  #     specified by regex_match. For regular expression grammar, please see
  #     https://github.com/google/re2/wiki/Syntax
  #
  #     Only one of exact_match, regex_match, or present_match must be set.
  # @!attribute [rw] present_match
  #   @return [::Boolean]
  #     Specifies that the QueryParameterMatcher matches if request contains
  #     query parameter, irrespective of whether the parameter has a value or
  #     not.
  #
  #     Only one of exact_match, regex_match, or present_match must be set.
  # @!attribute [rw] query_parameter
  #   @return [::String]
  #     The name of the query parameter to match.
  class QueryParameterMatch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # RouteMatch defines specifications used to match requests. If multiple match
  # types are set, this RouteMatch will match if ALL type of matches are
  # matched.
  # @!attribute [rw] full_path_match
  #   @return [::String]
  #     The HTTP request path value should exactly match this value.
  #
  #     Only one of full_path_match, prefix_match, or regex_match should be
  #     used.
  # @!attribute [rw] prefix_match
  #   @return [::String]
  #     The HTTP request path value must begin with specified prefix_match.
  #     prefix_match must begin with a /.
  #
  #     Only one of full_path_match, prefix_match, or regex_match should be
  #     used.
  # @!attribute [rw] regex_match
  #   @return [::String]
  #     The HTTP request path value must satisfy the regular expression
  #     specified by regex_match after removing any query parameters and anchor
  #     supplied with the original URL. For regular expression grammar, please
  #     see https://github.com/google/re2/wiki/Syntax
  #
  #     Only one of full_path_match, prefix_match, or regex_match should be
  #     used.
  # @!attribute [rw] ignore_case
  #   @return [::Boolean]
  #     Specifies if prefix_match and full_path_match matches are case sensitive.
  #     The default value is false.
  # @!attribute [rw] headers
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderMatch>]
  #     Specifies a list of HTTP request headers to match against. ALL of the
  #     supplied headers must be matched.
  # @!attribute [rw] query_parameters
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::QueryParameterMatch>]
  #     Specifies a list of query parameters to match against. ALL of the query
  #     parameters must be matched.
  class RouteMatch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifications of a destination to which the request should be routed to.
  # @!attribute [rw] service_name
  #   @return [::String]
  #     The URL of a BackendService to route traffic to.
  # @!attribute [rw] weight
  #   @return [::Integer]
  #     Specifies the proportion of requests forwarded to the backend referenced
  #     by the serviceName field. This is computed as:
  #     - weight/Sum(weights in this destination list).
  #     For non-zero values, there may be some epsilon from the exact proportion
  #     defined here depending on the precision an implementation supports.
  #
  #     If only one serviceName is specified and it has a weight greater than 0,
  #     100% of the traffic is forwarded to that backend.
  #
  #     If weights are specified for any one service name, they need to be
  #     specified for all of them.
  #
  #     If weights are unspecified for all services, then, traffic is distributed
  #     in equal proportions to all of them.
  class Destination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specification for redirecting traffic.
  # @!attribute [rw] host_redirect
  #   @return [::String]
  #     The host that will be used in the redirect response instead of the one
  #     that was supplied in the request.
  # @!attribute [rw] path_redirect
  #   @return [::String]
  #     The path that will be used in the redirect response instead of the one
  #     that was supplied in the request.
  #     path_redirect can not be supplied together with prefix_redirect. Supply
  #     one alone or neither. If neither is supplied, the path of the original
  #     request will be used for the redirect.
  # @!attribute [rw] prefix_rewrite
  #   @return [::String]
  #     Indicates that during redirection, the matched prefix (or path) should be
  #     swapped with this value. This option allows URLs be dynamically created
  #     based on the request.
  # @!attribute [rw] response_code
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::Redirect::ResponseCode]
  #     The HTTP Status code to use for the redirect.
  # @!attribute [rw] https_redirect
  #   @return [::Boolean]
  #     If set to true, the URL scheme in the redirected request is set to https.
  #     If set to false, the URL scheme of the redirected request will remain the
  #     same as that of the request.
  #
  #     The default is set to false.
  # @!attribute [rw] strip_query
  #   @return [::Boolean]
  #     if set to true, any accompanying query portion of the original URL is
  #     removed prior to redirecting the request. If set to false, the query
  #     portion of the original URL is retained.
  #
  #     The default is set to false.
  # @!attribute [rw] port_redirect
  #   @return [::Integer]
  #     The port that will be used in the redirected request instead of the one
  #     that was supplied in the request.
  class Redirect
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Supported HTTP response code.
    module ResponseCode
      # Default value
      RESPONSE_CODE_UNSPECIFIED = 0

      # Corresponds to 301.
      MOVED_PERMANENTLY_DEFAULT = 1

      # Corresponds to 302.
      FOUND = 2

      # Corresponds to 303.
      SEE_OTHER = 3

      # Corresponds to 307. In this case, the request method will be retained.
      TEMPORARY_REDIRECT = 4

      # Corresponds to 308. In this case, the request method will be retained.
      PERMANENT_REDIRECT = 5
    end
  end

  # The specification for fault injection introduced into traffic to test the
  # resiliency of clients to destination service failure. As part of fault
  # injection, when clients send requests to a destination, delays can be
  # introduced by client proxy on a percentage of requests before sending those
  # requests to the destination service. Similarly requests can be aborted by
  # client proxy for a percentage of requests.
  # @!attribute [rw] delay
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::FaultInjectionPolicy::Delay]
  #     The specification for injecting delay to client requests.
  # @!attribute [rw] abort
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::FaultInjectionPolicy::Abort]
  #     The specification for aborting to client requests.
  class FaultInjectionPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specification of how client requests are delayed as part of fault
    # injection before being sent to a destination.
    # @!attribute [rw] fixed_delay
    #   @return [::Google::Protobuf::Duration]
    #     Specify a fixed delay before forwarding the request.
    # @!attribute [rw] percentage
    #   @return [::Integer]
    #     The percentage of traffic on which delay will be injected.
    #
    #     The value must be between [0, 100]
    class Delay
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specification of how client requests are aborted as part of fault
    # injection before being sent to a destination.
    # @!attribute [rw] http_status
    #   @return [::Integer]
    #     The HTTP status code used to abort the request.
    #
    #     The value must be between 200 and 599 inclusive.
    # @!attribute [rw] percentage
    #   @return [::Integer]
    #     The percentage of traffic which will be aborted.
    #
    #     The value must be between [0, 100]
    class Abort
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The specification for modifying HTTP header in HTTP request and HTTP
  # response.
  # @!attribute [rw] set
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Completely overwrite/replace the headers with given map where key is the
  #     name of the header, value is the value of the header.
  # @!attribute [rw] add
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Add the headers with given map where key is the name of the header, value
  #     is the value of the header.
  # @!attribute [rw] remove
  #   @return [::Array<::String>]
  #     Remove headers (matching by header names) specified in the list.
  class HeaderModifier
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class SetEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class AddEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The specification for modifying the URL of the request, prior to forwarding
  # the request to the destination.
  # @!attribute [rw] path_prefix_rewrite
  #   @return [::String]
  #     Prior to forwarding the request to the selected destination, the matching
  #     portion of the requests path is replaced by this value.
  # @!attribute [rw] host_rewrite
  #   @return [::String]
  #     Prior to forwarding the request to the selected destination, the requests
  #     host header is replaced by this value.
  class URLRewrite
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specifications for retries.
  # @!attribute [rw] retry_conditions
  #   @return [::Array<::String>]
  #     Specifies one or more conditions when this retry policy applies. Valid
  #     values are:
  #       5xx: Proxy will attempt a retry if the destination service responds
  #         with any 5xx response code, of if the destination service does not
  #         respond at all, example: disconnect, reset, read timeout, connection
  #         failure and refused streams.
  #
  #       gateway-error: Similar to 5xx, but only applies to response codes 502,
  #         503, 504.
  #
  #       reset: Proxy will attempt a retry if the destination service does not
  #         respond at all (disconnect/reset/read timeout)
  #
  #       connect-failure: Proxy will retry on failures connecting to destination
  #         for example due to connection timeouts.
  #
  #       retriable-4xx: Proxy will retry fro retriable 4xx response codes.
  #         Currently the only retriable error supported is 409.
  #
  #       refused-stream: Proxy will retry if the destination resets the stream
  #         with a REFUSED_STREAM error code. This reset type indicates that it
  #         is safe to retry.
  # @!attribute [rw] num_retries
  #   @return [::Integer]
  #     Specifies the allowed number of retries. This number must be > 0. If not
  #     specified, default to 1.
  # @!attribute [rw] per_try_timeout
  #   @return [::Google::Protobuf::Duration]
  #     Specifies a non-zero timeout per retry attempt.
  class RetryPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the policy on how requests are shadowed to a separate mirrored
  # destination service. The proxy does not wait for responses from the
  # shadow service. Prior to sending traffic to the shadow service, the
  # host/authority header is suffixed with -shadow.
  # @!attribute [rw] destination
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::Destination]
  #     The destination the requests will be mirrored to. The weight of the
  #     destination will be ignored.
  class RequestMirrorPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Specification for allowing client side cross-origin requests.
  # @!attribute [rw] allow_origins
  #   @return [::Array<::String>]
  #     Specifies the list of origins that will be allowed to do CORS requests.
  #     An origin is allowed if it matches either an item in allow_origins or
  #     an item in allow_origin_regexes.
  # @!attribute [rw] allow_origin_regexes
  #   @return [::Array<::String>]
  #     Specifies the regular expression patterns that match allowed origins. For
  #     regular expression grammar, please see
  #     https://github.com/google/re2/wiki/Syntax.
  # @!attribute [rw] allow_methods
  #   @return [::Array<::String>]
  #     Specifies the content for Access-Control-Allow-Methods header.
  # @!attribute [rw] allow_headers
  #   @return [::Array<::String>]
  #     Specifies the content for Access-Control-Allow-Headers header.
  # @!attribute [rw] expose_headers
  #   @return [::Array<::String>]
  #     Specifies the content for Access-Control-Expose-Headers header.
  # @!attribute [rw] max_age
  #   @return [::String]
  #     Specifies how long result of a preflight request can be cached in
  #     seconds. This translates to the Access-Control-Max-Age header.
  # @!attribute [rw] allow_credentials
  #   @return [::Boolean]
  #     In response to a preflight request, setting this to true indicates that
  #     the actual request can include user credentials. This translates to the
  #     Access-Control-Allow-Credentials header.
  #
  #     Default value is false.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     If true, the CORS policy is disabled. The default value is false, which
  #     indicates that the CORS policy is in effect.
  class CorsPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specifications for routing traffic and applying associated policies.
  # @!attribute [rw] destinations
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::Destination>]
  #     The destination to which traffic should be forwarded.
  # @!attribute [rw] redirect
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::Redirect]
  #     If set, the request is directed as configured by this field.
  # @!attribute [rw] fault_injection_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::FaultInjectionPolicy]
  #     The specification for fault injection introduced into traffic to test the
  #     resiliency of clients to backend service failure. As part of fault
  #     injection, when clients send requests to a backend service, delays can be
  #     introduced  on a percentage of requests before sending those requests to
  #     the backend service. Similarly requests from clients can be aborted for a
  #     percentage of requests.
  #
  #     timeout and retry_policy will be ignored by clients that are configured
  #     with a fault_injection_policy
  # @!attribute [rw] request_header_modifier
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderModifier]
  #     The specification for modifying the headers of a matching request prior
  #     to delivery of the request to the destination. If HeaderModifiers are set
  #     on both the Destination and the RouteAction, they will be merged.
  #     Conflicts between the two will not be resolved on the configuration.
  # @!attribute [rw] response_header_modifier
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderModifier]
  #     The specification for modifying the headers of a response prior to
  #     sending the response back to the client. If HeaderModifiers are set
  #     on both the Destination and the RouteAction, they will be merged.
  #     Conflicts between the two will not be resolved on the configuration.
  # @!attribute [rw] url_rewrite
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::URLRewrite]
  #     The specification for rewrite URL before forwarding requests to the
  #     destination.
  # @!attribute [rw] timeout
  #   @return [::Google::Protobuf::Duration]
  #     Specifies the timeout for selected route. Timeout is computed from the
  #     time the request has been fully processed (i.e. end of stream) up until
  #     the response has been completely processed. Timeout includes all retries.
  # @!attribute [rw] retry_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::RetryPolicy]
  #     Specifies the retry policy associated with this route.
  # @!attribute [rw] request_mirror_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::RequestMirrorPolicy]
  #     Specifies the policy on how requests intended for the routes destination
  #     are shadowed to a separate mirrored destination. Proxy will not wait for
  #     the shadow destination to respond before returning the response. Prior to
  #     sending traffic to the shadow service, the host/authority header is
  #     suffixed with -shadow.
  # @!attribute [rw] cors_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::CorsPolicy]
  #     The specification for allowing client side cross-origin requests.
  class RouteAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies how to match traffic and how to route traffic when traffic is
  # matched.
  # @!attribute [rw] matches
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::RouteMatch>]
  #     A list of matches define conditions used for matching the rule against
  #     incoming HTTP requests. Each match is independent, i.e. this rule will be
  #     matched if ANY one of the matches is satisfied.
  #
  #     If no matches field is specified, this rule will unconditionally match
  #     traffic.
  #
  #     If a default rule is desired to be configured, add a rule with no matches
  #     specified to the end of the rules list.
  # @!attribute [rw] action
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::RouteAction]
  #     The detailed rule defining how to route matched traffic.
  class RouteRule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#self_link ⇒ ::String (readonly)

Returns Output only. Server-defined URL of this resource.

Returns:

• (::String) —

  Output only. Server-defined URL of this resource

# File 'proto_docs/google/cloud/networkservices/v1/http_route.rb', line 94

class HttpRoute
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to select a route rule based on HTTP request headers.
  # @!attribute [rw] exact_match
  #   @return [::String]
  #     The value of the header should match exactly the content of
  #     exact_match.
  # @!attribute [rw] regex_match
  #   @return [::String]
  #     The value of the header must match the regular expression specified in
  #     regex_match. For regular expression grammar, please see:
  #     https://github.com/google/re2/wiki/Syntax
  # @!attribute [rw] prefix_match
  #   @return [::String]
  #     The value of the header must start with the contents of prefix_match.
  # @!attribute [rw] present_match
  #   @return [::Boolean]
  #     A header with header_name must exist. The match takes place whether or
  #     not the header has a value.
  # @!attribute [rw] suffix_match
  #   @return [::String]
  #     The value of the header must end with the contents of suffix_match.
  # @!attribute [rw] range_match
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderMatch::IntegerRange]
  #     If specified, the rule will match if the request header value is within
  #     the range.
  # @!attribute [rw] header
  #   @return [::String]
  #     The name of the HTTP header to match against.
  # @!attribute [rw] invert_match
  #   @return [::Boolean]
  #     If specified, the match result will be inverted before checking. Default
  #     value is set to false.
  class HeaderMatch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents an integer value range.
    # @!attribute [rw] start
    #   @return [::Integer]
    #     Start of the range (inclusive)
    # @!attribute [rw] end
    #   @return [::Integer]
    #     End of the range (exclusive)
    class IntegerRange
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Specifications to match a query parameter in the request.
  # @!attribute [rw] exact_match
  #   @return [::String]
  #     The value of the query parameter must exactly match the contents of
  #     exact_match.
  #
  #     Only one of exact_match, regex_match, or present_match must be set.
  # @!attribute [rw] regex_match
  #   @return [::String]
  #     The value of the query parameter must match the regular expression
  #     specified by regex_match. For regular expression grammar, please see
  #     https://github.com/google/re2/wiki/Syntax
  #
  #     Only one of exact_match, regex_match, or present_match must be set.
  # @!attribute [rw] present_match
  #   @return [::Boolean]
  #     Specifies that the QueryParameterMatcher matches if request contains
  #     query parameter, irrespective of whether the parameter has a value or
  #     not.
  #
  #     Only one of exact_match, regex_match, or present_match must be set.
  # @!attribute [rw] query_parameter
  #   @return [::String]
  #     The name of the query parameter to match.
  class QueryParameterMatch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # RouteMatch defines specifications used to match requests. If multiple match
  # types are set, this RouteMatch will match if ALL type of matches are
  # matched.
  # @!attribute [rw] full_path_match
  #   @return [::String]
  #     The HTTP request path value should exactly match this value.
  #
  #     Only one of full_path_match, prefix_match, or regex_match should be
  #     used.
  # @!attribute [rw] prefix_match
  #   @return [::String]
  #     The HTTP request path value must begin with specified prefix_match.
  #     prefix_match must begin with a /.
  #
  #     Only one of full_path_match, prefix_match, or regex_match should be
  #     used.
  # @!attribute [rw] regex_match
  #   @return [::String]
  #     The HTTP request path value must satisfy the regular expression
  #     specified by regex_match after removing any query parameters and anchor
  #     supplied with the original URL. For regular expression grammar, please
  #     see https://github.com/google/re2/wiki/Syntax
  #
  #     Only one of full_path_match, prefix_match, or regex_match should be
  #     used.
  # @!attribute [rw] ignore_case
  #   @return [::Boolean]
  #     Specifies if prefix_match and full_path_match matches are case sensitive.
  #     The default value is false.
  # @!attribute [rw] headers
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderMatch>]
  #     Specifies a list of HTTP request headers to match against. ALL of the
  #     supplied headers must be matched.
  # @!attribute [rw] query_parameters
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::QueryParameterMatch>]
  #     Specifies a list of query parameters to match against. ALL of the query
  #     parameters must be matched.
  class RouteMatch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifications of a destination to which the request should be routed to.
  # @!attribute [rw] service_name
  #   @return [::String]
  #     The URL of a BackendService to route traffic to.
  # @!attribute [rw] weight
  #   @return [::Integer]
  #     Specifies the proportion of requests forwarded to the backend referenced
  #     by the serviceName field. This is computed as:
  #     - weight/Sum(weights in this destination list).
  #     For non-zero values, there may be some epsilon from the exact proportion
  #     defined here depending on the precision an implementation supports.
  #
  #     If only one serviceName is specified and it has a weight greater than 0,
  #     100% of the traffic is forwarded to that backend.
  #
  #     If weights are specified for any one service name, they need to be
  #     specified for all of them.
  #
  #     If weights are unspecified for all services, then, traffic is distributed
  #     in equal proportions to all of them.
  class Destination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specification for redirecting traffic.
  # @!attribute [rw] host_redirect
  #   @return [::String]
  #     The host that will be used in the redirect response instead of the one
  #     that was supplied in the request.
  # @!attribute [rw] path_redirect
  #   @return [::String]
  #     The path that will be used in the redirect response instead of the one
  #     that was supplied in the request.
  #     path_redirect can not be supplied together with prefix_redirect. Supply
  #     one alone or neither. If neither is supplied, the path of the original
  #     request will be used for the redirect.
  # @!attribute [rw] prefix_rewrite
  #   @return [::String]
  #     Indicates that during redirection, the matched prefix (or path) should be
  #     swapped with this value. This option allows URLs be dynamically created
  #     based on the request.
  # @!attribute [rw] response_code
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::Redirect::ResponseCode]
  #     The HTTP Status code to use for the redirect.
  # @!attribute [rw] https_redirect
  #   @return [::Boolean]
  #     If set to true, the URL scheme in the redirected request is set to https.
  #     If set to false, the URL scheme of the redirected request will remain the
  #     same as that of the request.
  #
  #     The default is set to false.
  # @!attribute [rw] strip_query
  #   @return [::Boolean]
  #     if set to true, any accompanying query portion of the original URL is
  #     removed prior to redirecting the request. If set to false, the query
  #     portion of the original URL is retained.
  #
  #     The default is set to false.
  # @!attribute [rw] port_redirect
  #   @return [::Integer]
  #     The port that will be used in the redirected request instead of the one
  #     that was supplied in the request.
  class Redirect
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Supported HTTP response code.
    module ResponseCode
      # Default value
      RESPONSE_CODE_UNSPECIFIED = 0

      # Corresponds to 301.
      MOVED_PERMANENTLY_DEFAULT = 1

      # Corresponds to 302.
      FOUND = 2

      # Corresponds to 303.
      SEE_OTHER = 3

      # Corresponds to 307. In this case, the request method will be retained.
      TEMPORARY_REDIRECT = 4

      # Corresponds to 308. In this case, the request method will be retained.
      PERMANENT_REDIRECT = 5
    end
  end

  # The specification for fault injection introduced into traffic to test the
  # resiliency of clients to destination service failure. As part of fault
  # injection, when clients send requests to a destination, delays can be
  # introduced by client proxy on a percentage of requests before sending those
  # requests to the destination service. Similarly requests can be aborted by
  # client proxy for a percentage of requests.
  # @!attribute [rw] delay
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::FaultInjectionPolicy::Delay]
  #     The specification for injecting delay to client requests.
  # @!attribute [rw] abort
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::FaultInjectionPolicy::Abort]
  #     The specification for aborting to client requests.
  class FaultInjectionPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specification of how client requests are delayed as part of fault
    # injection before being sent to a destination.
    # @!attribute [rw] fixed_delay
    #   @return [::Google::Protobuf::Duration]
    #     Specify a fixed delay before forwarding the request.
    # @!attribute [rw] percentage
    #   @return [::Integer]
    #     The percentage of traffic on which delay will be injected.
    #
    #     The value must be between [0, 100]
    class Delay
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specification of how client requests are aborted as part of fault
    # injection before being sent to a destination.
    # @!attribute [rw] http_status
    #   @return [::Integer]
    #     The HTTP status code used to abort the request.
    #
    #     The value must be between 200 and 599 inclusive.
    # @!attribute [rw] percentage
    #   @return [::Integer]
    #     The percentage of traffic which will be aborted.
    #
    #     The value must be between [0, 100]
    class Abort
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The specification for modifying HTTP header in HTTP request and HTTP
  # response.
  # @!attribute [rw] set
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Completely overwrite/replace the headers with given map where key is the
  #     name of the header, value is the value of the header.
  # @!attribute [rw] add
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Add the headers with given map where key is the name of the header, value
  #     is the value of the header.
  # @!attribute [rw] remove
  #   @return [::Array<::String>]
  #     Remove headers (matching by header names) specified in the list.
  class HeaderModifier
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class SetEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class AddEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The specification for modifying the URL of the request, prior to forwarding
  # the request to the destination.
  # @!attribute [rw] path_prefix_rewrite
  #   @return [::String]
  #     Prior to forwarding the request to the selected destination, the matching
  #     portion of the requests path is replaced by this value.
  # @!attribute [rw] host_rewrite
  #   @return [::String]
  #     Prior to forwarding the request to the selected destination, the requests
  #     host header is replaced by this value.
  class URLRewrite
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specifications for retries.
  # @!attribute [rw] retry_conditions
  #   @return [::Array<::String>]
  #     Specifies one or more conditions when this retry policy applies. Valid
  #     values are:
  #       5xx: Proxy will attempt a retry if the destination service responds
  #         with any 5xx response code, of if the destination service does not
  #         respond at all, example: disconnect, reset, read timeout, connection
  #         failure and refused streams.
  #
  #       gateway-error: Similar to 5xx, but only applies to response codes 502,
  #         503, 504.
  #
  #       reset: Proxy will attempt a retry if the destination service does not
  #         respond at all (disconnect/reset/read timeout)
  #
  #       connect-failure: Proxy will retry on failures connecting to destination
  #         for example due to connection timeouts.
  #
  #       retriable-4xx: Proxy will retry fro retriable 4xx response codes.
  #         Currently the only retriable error supported is 409.
  #
  #       refused-stream: Proxy will retry if the destination resets the stream
  #         with a REFUSED_STREAM error code. This reset type indicates that it
  #         is safe to retry.
  # @!attribute [rw] num_retries
  #   @return [::Integer]
  #     Specifies the allowed number of retries. This number must be > 0. If not
  #     specified, default to 1.
  # @!attribute [rw] per_try_timeout
  #   @return [::Google::Protobuf::Duration]
  #     Specifies a non-zero timeout per retry attempt.
  class RetryPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the policy on how requests are shadowed to a separate mirrored
  # destination service. The proxy does not wait for responses from the
  # shadow service. Prior to sending traffic to the shadow service, the
  # host/authority header is suffixed with -shadow.
  # @!attribute [rw] destination
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::Destination]
  #     The destination the requests will be mirrored to. The weight of the
  #     destination will be ignored.
  class RequestMirrorPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Specification for allowing client side cross-origin requests.
  # @!attribute [rw] allow_origins
  #   @return [::Array<::String>]
  #     Specifies the list of origins that will be allowed to do CORS requests.
  #     An origin is allowed if it matches either an item in allow_origins or
  #     an item in allow_origin_regexes.
  # @!attribute [rw] allow_origin_regexes
  #   @return [::Array<::String>]
  #     Specifies the regular expression patterns that match allowed origins. For
  #     regular expression grammar, please see
  #     https://github.com/google/re2/wiki/Syntax.
  # @!attribute [rw] allow_methods
  #   @return [::Array<::String>]
  #     Specifies the content for Access-Control-Allow-Methods header.
  # @!attribute [rw] allow_headers
  #   @return [::Array<::String>]
  #     Specifies the content for Access-Control-Allow-Headers header.
  # @!attribute [rw] expose_headers
  #   @return [::Array<::String>]
  #     Specifies the content for Access-Control-Expose-Headers header.
  # @!attribute [rw] max_age
  #   @return [::String]
  #     Specifies how long result of a preflight request can be cached in
  #     seconds. This translates to the Access-Control-Max-Age header.
  # @!attribute [rw] allow_credentials
  #   @return [::Boolean]
  #     In response to a preflight request, setting this to true indicates that
  #     the actual request can include user credentials. This translates to the
  #     Access-Control-Allow-Credentials header.
  #
  #     Default value is false.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     If true, the CORS policy is disabled. The default value is false, which
  #     indicates that the CORS policy is in effect.
  class CorsPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specifications for routing traffic and applying associated policies.
  # @!attribute [rw] destinations
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::Destination>]
  #     The destination to which traffic should be forwarded.
  # @!attribute [rw] redirect
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::Redirect]
  #     If set, the request is directed as configured by this field.
  # @!attribute [rw] fault_injection_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::FaultInjectionPolicy]
  #     The specification for fault injection introduced into traffic to test the
  #     resiliency of clients to backend service failure. As part of fault
  #     injection, when clients send requests to a backend service, delays can be
  #     introduced  on a percentage of requests before sending those requests to
  #     the backend service. Similarly requests from clients can be aborted for a
  #     percentage of requests.
  #
  #     timeout and retry_policy will be ignored by clients that are configured
  #     with a fault_injection_policy
  # @!attribute [rw] request_header_modifier
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderModifier]
  #     The specification for modifying the headers of a matching request prior
  #     to delivery of the request to the destination. If HeaderModifiers are set
  #     on both the Destination and the RouteAction, they will be merged.
  #     Conflicts between the two will not be resolved on the configuration.
  # @!attribute [rw] response_header_modifier
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderModifier]
  #     The specification for modifying the headers of a response prior to
  #     sending the response back to the client. If HeaderModifiers are set
  #     on both the Destination and the RouteAction, they will be merged.
  #     Conflicts between the two will not be resolved on the configuration.
  # @!attribute [rw] url_rewrite
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::URLRewrite]
  #     The specification for rewrite URL before forwarding requests to the
  #     destination.
  # @!attribute [rw] timeout
  #   @return [::Google::Protobuf::Duration]
  #     Specifies the timeout for selected route. Timeout is computed from the
  #     time the request has been fully processed (i.e. end of stream) up until
  #     the response has been completely processed. Timeout includes all retries.
  # @!attribute [rw] retry_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::RetryPolicy]
  #     Specifies the retry policy associated with this route.
  # @!attribute [rw] request_mirror_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::RequestMirrorPolicy]
  #     Specifies the policy on how requests intended for the routes destination
  #     are shadowed to a separate mirrored destination. Proxy will not wait for
  #     the shadow destination to respond before returning the response. Prior to
  #     sending traffic to the shadow service, the host/authority header is
  #     suffixed with -shadow.
  # @!attribute [rw] cors_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::CorsPolicy]
  #     The specification for allowing client side cross-origin requests.
  class RouteAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies how to match traffic and how to route traffic when traffic is
  # matched.
  # @!attribute [rw] matches
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::RouteMatch>]
  #     A list of matches define conditions used for matching the rule against
  #     incoming HTTP requests. Each match is independent, i.e. this rule will be
  #     matched if ANY one of the matches is satisfied.
  #
  #     If no matches field is specified, this rule will unconditionally match
  #     traffic.
  #
  #     If a default rule is desired to be configured, add a rule with no matches
  #     specified to the end of the rules list.
  # @!attribute [rw] action
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::RouteAction]
  #     The detailed rule defining how to route matched traffic.
  class RouteRule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The timestamp when the resource was updated.

Returns:

• (::Google::Protobuf::Timestamp) —

  Output only. The timestamp when the resource was updated.

# File 'proto_docs/google/cloud/networkservices/v1/http_route.rb', line 94

class HttpRoute
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to select a route rule based on HTTP request headers.
  # @!attribute [rw] exact_match
  #   @return [::String]
  #     The value of the header should match exactly the content of
  #     exact_match.
  # @!attribute [rw] regex_match
  #   @return [::String]
  #     The value of the header must match the regular expression specified in
  #     regex_match. For regular expression grammar, please see:
  #     https://github.com/google/re2/wiki/Syntax
  # @!attribute [rw] prefix_match
  #   @return [::String]
  #     The value of the header must start with the contents of prefix_match.
  # @!attribute [rw] present_match
  #   @return [::Boolean]
  #     A header with header_name must exist. The match takes place whether or
  #     not the header has a value.
  # @!attribute [rw] suffix_match
  #   @return [::String]
  #     The value of the header must end with the contents of suffix_match.
  # @!attribute [rw] range_match
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderMatch::IntegerRange]
  #     If specified, the rule will match if the request header value is within
  #     the range.
  # @!attribute [rw] header
  #   @return [::String]
  #     The name of the HTTP header to match against.
  # @!attribute [rw] invert_match
  #   @return [::Boolean]
  #     If specified, the match result will be inverted before checking. Default
  #     value is set to false.
  class HeaderMatch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents an integer value range.
    # @!attribute [rw] start
    #   @return [::Integer]
    #     Start of the range (inclusive)
    # @!attribute [rw] end
    #   @return [::Integer]
    #     End of the range (exclusive)
    class IntegerRange
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Specifications to match a query parameter in the request.
  # @!attribute [rw] exact_match
  #   @return [::String]
  #     The value of the query parameter must exactly match the contents of
  #     exact_match.
  #
  #     Only one of exact_match, regex_match, or present_match must be set.
  # @!attribute [rw] regex_match
  #   @return [::String]
  #     The value of the query parameter must match the regular expression
  #     specified by regex_match. For regular expression grammar, please see
  #     https://github.com/google/re2/wiki/Syntax
  #
  #     Only one of exact_match, regex_match, or present_match must be set.
  # @!attribute [rw] present_match
  #   @return [::Boolean]
  #     Specifies that the QueryParameterMatcher matches if request contains
  #     query parameter, irrespective of whether the parameter has a value or
  #     not.
  #
  #     Only one of exact_match, regex_match, or present_match must be set.
  # @!attribute [rw] query_parameter
  #   @return [::String]
  #     The name of the query parameter to match.
  class QueryParameterMatch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # RouteMatch defines specifications used to match requests. If multiple match
  # types are set, this RouteMatch will match if ALL type of matches are
  # matched.
  # @!attribute [rw] full_path_match
  #   @return [::String]
  #     The HTTP request path value should exactly match this value.
  #
  #     Only one of full_path_match, prefix_match, or regex_match should be
  #     used.
  # @!attribute [rw] prefix_match
  #   @return [::String]
  #     The HTTP request path value must begin with specified prefix_match.
  #     prefix_match must begin with a /.
  #
  #     Only one of full_path_match, prefix_match, or regex_match should be
  #     used.
  # @!attribute [rw] regex_match
  #   @return [::String]
  #     The HTTP request path value must satisfy the regular expression
  #     specified by regex_match after removing any query parameters and anchor
  #     supplied with the original URL. For regular expression grammar, please
  #     see https://github.com/google/re2/wiki/Syntax
  #
  #     Only one of full_path_match, prefix_match, or regex_match should be
  #     used.
  # @!attribute [rw] ignore_case
  #   @return [::Boolean]
  #     Specifies if prefix_match and full_path_match matches are case sensitive.
  #     The default value is false.
  # @!attribute [rw] headers
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderMatch>]
  #     Specifies a list of HTTP request headers to match against. ALL of the
  #     supplied headers must be matched.
  # @!attribute [rw] query_parameters
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::QueryParameterMatch>]
  #     Specifies a list of query parameters to match against. ALL of the query
  #     parameters must be matched.
  class RouteMatch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifications of a destination to which the request should be routed to.
  # @!attribute [rw] service_name
  #   @return [::String]
  #     The URL of a BackendService to route traffic to.
  # @!attribute [rw] weight
  #   @return [::Integer]
  #     Specifies the proportion of requests forwarded to the backend referenced
  #     by the serviceName field. This is computed as:
  #     - weight/Sum(weights in this destination list).
  #     For non-zero values, there may be some epsilon from the exact proportion
  #     defined here depending on the precision an implementation supports.
  #
  #     If only one serviceName is specified and it has a weight greater than 0,
  #     100% of the traffic is forwarded to that backend.
  #
  #     If weights are specified for any one service name, they need to be
  #     specified for all of them.
  #
  #     If weights are unspecified for all services, then, traffic is distributed
  #     in equal proportions to all of them.
  class Destination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specification for redirecting traffic.
  # @!attribute [rw] host_redirect
  #   @return [::String]
  #     The host that will be used in the redirect response instead of the one
  #     that was supplied in the request.
  # @!attribute [rw] path_redirect
  #   @return [::String]
  #     The path that will be used in the redirect response instead of the one
  #     that was supplied in the request.
  #     path_redirect can not be supplied together with prefix_redirect. Supply
  #     one alone or neither. If neither is supplied, the path of the original
  #     request will be used for the redirect.
  # @!attribute [rw] prefix_rewrite
  #   @return [::String]
  #     Indicates that during redirection, the matched prefix (or path) should be
  #     swapped with this value. This option allows URLs be dynamically created
  #     based on the request.
  # @!attribute [rw] response_code
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::Redirect::ResponseCode]
  #     The HTTP Status code to use for the redirect.
  # @!attribute [rw] https_redirect
  #   @return [::Boolean]
  #     If set to true, the URL scheme in the redirected request is set to https.
  #     If set to false, the URL scheme of the redirected request will remain the
  #     same as that of the request.
  #
  #     The default is set to false.
  # @!attribute [rw] strip_query
  #   @return [::Boolean]
  #     if set to true, any accompanying query portion of the original URL is
  #     removed prior to redirecting the request. If set to false, the query
  #     portion of the original URL is retained.
  #
  #     The default is set to false.
  # @!attribute [rw] port_redirect
  #   @return [::Integer]
  #     The port that will be used in the redirected request instead of the one
  #     that was supplied in the request.
  class Redirect
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Supported HTTP response code.
    module ResponseCode
      # Default value
      RESPONSE_CODE_UNSPECIFIED = 0

      # Corresponds to 301.
      MOVED_PERMANENTLY_DEFAULT = 1

      # Corresponds to 302.
      FOUND = 2

      # Corresponds to 303.
      SEE_OTHER = 3

      # Corresponds to 307. In this case, the request method will be retained.
      TEMPORARY_REDIRECT = 4

      # Corresponds to 308. In this case, the request method will be retained.
      PERMANENT_REDIRECT = 5
    end
  end

  # The specification for fault injection introduced into traffic to test the
  # resiliency of clients to destination service failure. As part of fault
  # injection, when clients send requests to a destination, delays can be
  # introduced by client proxy on a percentage of requests before sending those
  # requests to the destination service. Similarly requests can be aborted by
  # client proxy for a percentage of requests.
  # @!attribute [rw] delay
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::FaultInjectionPolicy::Delay]
  #     The specification for injecting delay to client requests.
  # @!attribute [rw] abort
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::FaultInjectionPolicy::Abort]
  #     The specification for aborting to client requests.
  class FaultInjectionPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specification of how client requests are delayed as part of fault
    # injection before being sent to a destination.
    # @!attribute [rw] fixed_delay
    #   @return [::Google::Protobuf::Duration]
    #     Specify a fixed delay before forwarding the request.
    # @!attribute [rw] percentage
    #   @return [::Integer]
    #     The percentage of traffic on which delay will be injected.
    #
    #     The value must be between [0, 100]
    class Delay
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specification of how client requests are aborted as part of fault
    # injection before being sent to a destination.
    # @!attribute [rw] http_status
    #   @return [::Integer]
    #     The HTTP status code used to abort the request.
    #
    #     The value must be between 200 and 599 inclusive.
    # @!attribute [rw] percentage
    #   @return [::Integer]
    #     The percentage of traffic which will be aborted.
    #
    #     The value must be between [0, 100]
    class Abort
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The specification for modifying HTTP header in HTTP request and HTTP
  # response.
  # @!attribute [rw] set
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Completely overwrite/replace the headers with given map where key is the
  #     name of the header, value is the value of the header.
  # @!attribute [rw] add
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Add the headers with given map where key is the name of the header, value
  #     is the value of the header.
  # @!attribute [rw] remove
  #   @return [::Array<::String>]
  #     Remove headers (matching by header names) specified in the list.
  class HeaderModifier
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class SetEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class AddEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The specification for modifying the URL of the request, prior to forwarding
  # the request to the destination.
  # @!attribute [rw] path_prefix_rewrite
  #   @return [::String]
  #     Prior to forwarding the request to the selected destination, the matching
  #     portion of the requests path is replaced by this value.
  # @!attribute [rw] host_rewrite
  #   @return [::String]
  #     Prior to forwarding the request to the selected destination, the requests
  #     host header is replaced by this value.
  class URLRewrite
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specifications for retries.
  # @!attribute [rw] retry_conditions
  #   @return [::Array<::String>]
  #     Specifies one or more conditions when this retry policy applies. Valid
  #     values are:
  #       5xx: Proxy will attempt a retry if the destination service responds
  #         with any 5xx response code, of if the destination service does not
  #         respond at all, example: disconnect, reset, read timeout, connection
  #         failure and refused streams.
  #
  #       gateway-error: Similar to 5xx, but only applies to response codes 502,
  #         503, 504.
  #
  #       reset: Proxy will attempt a retry if the destination service does not
  #         respond at all (disconnect/reset/read timeout)
  #
  #       connect-failure: Proxy will retry on failures connecting to destination
  #         for example due to connection timeouts.
  #
  #       retriable-4xx: Proxy will retry fro retriable 4xx response codes.
  #         Currently the only retriable error supported is 409.
  #
  #       refused-stream: Proxy will retry if the destination resets the stream
  #         with a REFUSED_STREAM error code. This reset type indicates that it
  #         is safe to retry.
  # @!attribute [rw] num_retries
  #   @return [::Integer]
  #     Specifies the allowed number of retries. This number must be > 0. If not
  #     specified, default to 1.
  # @!attribute [rw] per_try_timeout
  #   @return [::Google::Protobuf::Duration]
  #     Specifies a non-zero timeout per retry attempt.
  class RetryPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the policy on how requests are shadowed to a separate mirrored
  # destination service. The proxy does not wait for responses from the
  # shadow service. Prior to sending traffic to the shadow service, the
  # host/authority header is suffixed with -shadow.
  # @!attribute [rw] destination
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::Destination]
  #     The destination the requests will be mirrored to. The weight of the
  #     destination will be ignored.
  class RequestMirrorPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The Specification for allowing client side cross-origin requests.
  # @!attribute [rw] allow_origins
  #   @return [::Array<::String>]
  #     Specifies the list of origins that will be allowed to do CORS requests.
  #     An origin is allowed if it matches either an item in allow_origins or
  #     an item in allow_origin_regexes.
  # @!attribute [rw] allow_origin_regexes
  #   @return [::Array<::String>]
  #     Specifies the regular expression patterns that match allowed origins. For
  #     regular expression grammar, please see
  #     https://github.com/google/re2/wiki/Syntax.
  # @!attribute [rw] allow_methods
  #   @return [::Array<::String>]
  #     Specifies the content for Access-Control-Allow-Methods header.
  # @!attribute [rw] allow_headers
  #   @return [::Array<::String>]
  #     Specifies the content for Access-Control-Allow-Headers header.
  # @!attribute [rw] expose_headers
  #   @return [::Array<::String>]
  #     Specifies the content for Access-Control-Expose-Headers header.
  # @!attribute [rw] max_age
  #   @return [::String]
  #     Specifies how long result of a preflight request can be cached in
  #     seconds. This translates to the Access-Control-Max-Age header.
  # @!attribute [rw] allow_credentials
  #   @return [::Boolean]
  #     In response to a preflight request, setting this to true indicates that
  #     the actual request can include user credentials. This translates to the
  #     Access-Control-Allow-Credentials header.
  #
  #     Default value is false.
  # @!attribute [rw] disabled
  #   @return [::Boolean]
  #     If true, the CORS policy is disabled. The default value is false, which
  #     indicates that the CORS policy is in effect.
  class CorsPolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specifications for routing traffic and applying associated policies.
  # @!attribute [rw] destinations
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::Destination>]
  #     The destination to which traffic should be forwarded.
  # @!attribute [rw] redirect
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::Redirect]
  #     If set, the request is directed as configured by this field.
  # @!attribute [rw] fault_injection_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::FaultInjectionPolicy]
  #     The specification for fault injection introduced into traffic to test the
  #     resiliency of clients to backend service failure. As part of fault
  #     injection, when clients send requests to a backend service, delays can be
  #     introduced  on a percentage of requests before sending those requests to
  #     the backend service. Similarly requests from clients can be aborted for a
  #     percentage of requests.
  #
  #     timeout and retry_policy will be ignored by clients that are configured
  #     with a fault_injection_policy
  # @!attribute [rw] request_header_modifier
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderModifier]
  #     The specification for modifying the headers of a matching request prior
  #     to delivery of the request to the destination. If HeaderModifiers are set
  #     on both the Destination and the RouteAction, they will be merged.
  #     Conflicts between the two will not be resolved on the configuration.
  # @!attribute [rw] response_header_modifier
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::HeaderModifier]
  #     The specification for modifying the headers of a response prior to
  #     sending the response back to the client. If HeaderModifiers are set
  #     on both the Destination and the RouteAction, they will be merged.
  #     Conflicts between the two will not be resolved on the configuration.
  # @!attribute [rw] url_rewrite
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::URLRewrite]
  #     The specification for rewrite URL before forwarding requests to the
  #     destination.
  # @!attribute [rw] timeout
  #   @return [::Google::Protobuf::Duration]
  #     Specifies the timeout for selected route. Timeout is computed from the
  #     time the request has been fully processed (i.e. end of stream) up until
  #     the response has been completely processed. Timeout includes all retries.
  # @!attribute [rw] retry_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::RetryPolicy]
  #     Specifies the retry policy associated with this route.
  # @!attribute [rw] request_mirror_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::RequestMirrorPolicy]
  #     Specifies the policy on how requests intended for the routes destination
  #     are shadowed to a separate mirrored destination. Proxy will not wait for
  #     the shadow destination to respond before returning the response. Prior to
  #     sending traffic to the shadow service, the host/authority header is
  #     suffixed with -shadow.
  # @!attribute [rw] cors_policy
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::CorsPolicy]
  #     The specification for allowing client side cross-origin requests.
  class RouteAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies how to match traffic and how to route traffic when traffic is
  # matched.
  # @!attribute [rw] matches
  #   @return [::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::RouteMatch>]
  #     A list of matches define conditions used for matching the rule against
  #     incoming HTTP requests. Each match is independent, i.e. this rule will be
  #     matched if ANY one of the matches is satisfied.
  #
  #     If no matches field is specified, this rule will unconditionally match
  #     traffic.
  #
  #     If a default rule is desired to be configured, add a rule with no matches
  #     specified to the end of the rules list.
  # @!attribute [rw] action
  #   @return [::Google::Cloud::NetworkServices::V1::HttpRoute::RouteAction]
  #     The detailed rule defining how to route matched traffic.
  class RouteRule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end