Package org.cdk8s.plus25.k8s

Class HttpIngressPath.Builder

java.lang.Object

org.cdk8s.plus25.k8s.HttpIngressPath.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HttpIngressPath>

Enclosing interface:

HttpIngressPath

@Stability(Stable)
public static final class HttpIngressPath.Builder
extends Object
implements software.amazon.jsii.Builder<HttpIngressPath>

A builder for HttpIngressPath

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HttpIngressPath.Builder	backend(IngressBackend backend)	Sets the value of HttpIngressPath.getBackend()
HttpIngressPath	build()	Builds the configured instance.
HttpIngressPath.Builder	path(String path)	Sets the value of HttpIngressPath.getPath()
HttpIngressPath.Builder	pathType(String pathType)	Sets the value of HttpIngressPath.getPathType()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

backend

@Stability(Stable)
public HttpIngressPath.Builder backend(IngressBackend backend)

Sets the value of HttpIngressPath.getBackend()

Parameters:

backend - Backend defines the referenced service endpoint to which the traffic will be forwarded to. This parameter is required.

Returns:

this

pathType

@Stability(Stable)
public HttpIngressPath.Builder pathType(String pathType)

Sets the value of HttpIngressPath.getPathType()

Parameters:

pathType - PathType determines the interpretation of the Path matching. This parameter is required. PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by '/'. Matching is done on a path element by element basis. A path element refers is the list of labels in the path split by the '/' separator. A request is a match for path p if every p is an element-wise prefix of p of the request path. Note that if the last element of the path is a substring of the last element in request path, it is not a match (e.g. /foo/bar matches /foo/bar/baz, but does not match /foo/barbaz).

• ImplementationSpecific: Interpretation of the Path matching is up to the IngressClass. Implementations can treat this as a separate PathType or treat it identically to Prefix or Exact path types. Implementations are required to support all path types.

Returns:

this

path

@Stability(Stable)
public HttpIngressPath.Builder path(String path)

Sets the value of HttpIngressPath.getPath()

Parameters:

path - Path is matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a '/' and must be present when using PathType with value "Exact" or "Prefix".

Returns:

this

build

@Stability(Stable)
public HttpIngressPath build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<HttpIngressPath>

Returns:

a new instance of HttpIngressPath

Throws:

NullPointerException - if any required attribute was not provided