Package io.fabric8.kubernetes.api.model.gatewayapi.v1

Class HTTPRequestRedirectFilter

java.lang.Object

io.fabric8.kubernetes.api.model.gatewayapi.v1.HTTPRequestRedirectFilter

All Implemented Interfaces:

io.fabric8.kubernetes.api.builder.Editable<HTTPRequestRedirectFilterBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable

@Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class HTTPRequestRedirectFilter
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<HTTPRequestRedirectFilterBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource

HTTPRequestRedirect defines a filter that redirects a request. This filter MUST NOT be used on the same Route rule as a HTTPURLRewrite filter.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
HTTPRequestRedirectFilter()	No args constructor for use in serialization
HTTPRequestRedirectFilter(String hostname, HTTPPathModifier path, Integer port, String scheme, Integer statusCode)

Method Summary

Modifier and Type	Method	Description
HTTPRequestRedirectFilterBuilder	edit()
Map<String,Object>	getAdditionalProperties()
String	getHostname()	Hostname is the hostname to be used in the value of the `Location` header in the response.
HTTPPathModifier	getPath()	HTTPRequestRedirect defines a filter that redirects a request.
Integer	getPort()	Port is the port to be used in the value of the `Location` header in the response.
String	getScheme()	Scheme is the scheme to be used in the value of the `Location` header in the response.
Integer	getStatusCode()	StatusCode is the HTTP status code to be used in response.
void	setAdditionalProperties(Map<String,Object> additionalProperties)
void	setAdditionalProperty(String name, Object value)
void	setHostname(String hostname)	Hostname is the hostname to be used in the value of the `Location` header in the response.
void	setPath(HTTPPathModifier path)	HTTPRequestRedirect defines a filter that redirects a request.
void	setPort(Integer port)	Port is the port to be used in the value of the `Location` header in the response.
void	setScheme(String scheme)	Scheme is the scheme to be used in the value of the `Location` header in the response.
void	setStatusCode(Integer statusCode)	StatusCode is the HTTP status code to be used in response.
HTTPRequestRedirectFilterBuilder	toBuilder()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HTTPRequestRedirectFilter

public HTTPRequestRedirectFilter()

No args constructor for use in serialization

HTTPRequestRedirectFilter

public HTTPRequestRedirectFilter(String hostname,
                                 HTTPPathModifier path,
                                 Integer port,
                                 String scheme,
                                 Integer statusCode)

Method Detail

getHostname

public String getHostname()

Hostname is the hostname to be used in the value of the `Location` header in the response. When empty, the hostname in the `Host` header of the request is used.

Support: Core

setHostname

public void setHostname(String hostname)

Hostname is the hostname to be used in the value of the `Location` header in the response. When empty, the hostname in the `Host` header of the request is used.

Support: Core

getPath

public HTTPPathModifier getPath()

HTTPRequestRedirect defines a filter that redirects a request. This filter MUST NOT be used on the same Route rule as a HTTPURLRewrite filter.

setPath

public void setPath(HTTPPathModifier path)

HTTPRequestRedirect defines a filter that redirects a request. This filter MUST NOT be used on the same Route rule as a HTTPURLRewrite filter.

getPort

public Integer getPort()

Port is the port to be used in the value of the `Location` header in the response.

If no port is specified, the redirect port MUST be derived using the following rules:

* If redirect scheme is not-empty, the redirect port MUST be the well-known

port associated with the redirect scheme. Specifically "http" to port 80

and "https" to port 443. If the redirect scheme does not have a

well-known port, the listener port of the Gateway SHOULD be used.

* If redirect scheme is empty, the redirect port MUST be the Gateway

Listener port.

Implementations SHOULD NOT add the port number in the 'Location' header in the following cases:

* A Location header that will use HTTP (whether that is determined via

the Listener protocol or the Scheme field) _and_ use port 80.

* A Location header that will use HTTPS (whether that is determined via

the Listener protocol or the Scheme field) _and_ use port 443.

Support: Extended

setPort

public void setPort(Integer port)

Port is the port to be used in the value of the `Location` header in the response.

If no port is specified, the redirect port MUST be derived using the following rules:

* If redirect scheme is not-empty, the redirect port MUST be the well-known

port associated with the redirect scheme. Specifically "http" to port 80

and "https" to port 443. If the redirect scheme does not have a

well-known port, the listener port of the Gateway SHOULD be used.

* If redirect scheme is empty, the redirect port MUST be the Gateway

Listener port.

Implementations SHOULD NOT add the port number in the 'Location' header in the following cases:

* A Location header that will use HTTP (whether that is determined via

the Listener protocol or the Scheme field) _and_ use port 80.

* A Location header that will use HTTPS (whether that is determined via

the Listener protocol or the Scheme field) _and_ use port 443.

Support: Extended

getScheme

public String getScheme()

Scheme is the scheme to be used in the value of the `Location` header in the response. When empty, the scheme of the request is used.

Scheme redirects can affect the port of the redirect, for more information, refer to the documentation for the port field of this filter.

Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash.

Unknown values here must result in the implementation setting the Accepted Condition for the Route to `status: False`, with a Reason of `UnsupportedValue`.

Support: Extended

setScheme

public void setScheme(String scheme)

Scheme is the scheme to be used in the value of the `Location` header in the response. When empty, the scheme of the request is used.

Scheme redirects can affect the port of the redirect, for more information, refer to the documentation for the port field of this filter.

Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash.

Unknown values here must result in the implementation setting the Accepted Condition for the Route to `status: False`, with a Reason of `UnsupportedValue`.

Support: Extended

getStatusCode

public Integer getStatusCode()

StatusCode is the HTTP status code to be used in response.

Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash.

Unknown values here must result in the implementation setting the Accepted Condition for the Route to `status: False`, with a Reason of `UnsupportedValue`.

Support: Core

setStatusCode

public void setStatusCode(Integer statusCode)

StatusCode is the HTTP status code to be used in response.

Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash.

Unknown values here must result in the implementation setting the Accepted Condition for the Route to `status: False`, with a Reason of `UnsupportedValue`.

Support: Core

edit

public HTTPRequestRedirectFilterBuilder edit()

Specified by:

edit in interface io.fabric8.kubernetes.api.builder.Editable<HTTPRequestRedirectFilterBuilder>

toBuilder

public HTTPRequestRedirectFilterBuilder toBuilder()

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
                                  Object value)

setAdditionalProperties

public void setAdditionalProperties(Map<String,Object> additionalProperties)