GoogleApi.NetworkServices.V1.Model.HttpRouteRedirect (google_api_network_services v0.11.0)

View Source

The specification for redirecting traffic.

Attributes

  • hostRedirect (type: String.t, default: nil) - The host that will be used in the redirect response instead of the one that was supplied in the request.
  • httpsRedirect (type: boolean(), default: nil) - 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.
  • pathRedirect (type: String.t, default: nil) - 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.
  • portRedirect (type: integer(), default: nil) - The port that will be used in the redirected request instead of the one that was supplied in the request.
  • prefixRewrite (type: String.t, default: nil) - 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.
  • responseCode (type: String.t, default: nil) - The HTTP Status code to use for the redirect.
  • stripQuery (type: boolean(), default: nil) - 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.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.NetworkServices.V1.Model.HttpRouteRedirect{
  hostRedirect: String.t() | nil,
  httpsRedirect: boolean() | nil,
  pathRedirect: String.t() | nil,
  portRedirect: integer() | nil,
  prefixRewrite: String.t() | nil,
  responseCode: String.t() | nil,
  stripQuery: boolean() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.