alb.v1.ingressExtension

"IngressExtension is the schema for the IngressExtension API"

Index

fn new(name)
obj metadata
obj spec

Fields

fn new

new(name)

new returns an instance of IngressExtension

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

fn metadata.withSelfLink

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"Spec is the IngressExtension specification."

fn spec.withBackendSettings

withBackendSettings(backendSettings)

"BackendSettings defines a set of configuration options for Ingress service backends"

fn spec.withBackendSettingsMixin

withBackendSettingsMixin(backendSettings)

"BackendSettings defines a set of configuration options for Ingress service backends"

Note: This function appends passed data to existing values

fn spec.withRules

withRules(rules)

"Rules define the rules per host"

fn spec.withRulesMixin

withRulesMixin(rules)

"Rules define the rules per host"

Note: This function appends passed data to existing values

obj spec.backendSettings

"BackendSettings defines a set of configuration options for Ingress service backends"

fn spec.backendSettings.withPorts

withPorts(ports)

"Ports can be used to indicate if the backend service is listening on HTTP or HTTPS"

fn spec.backendSettings.withPortsMixin

withPortsMixin(ports)

"Ports can be used to indicate if the backend service is listening on HTTP or HTTPS"

Note: This function appends passed data to existing values

fn spec.backendSettings.withService

withService(service)

"Service is the name of a backend service that this configuration applies to"

fn spec.backendSettings.withTrustedRootCertificate

withTrustedRootCertificate(trustedRootCertificate)

"TrustedRootCertificate can be used to supply a certificate for the gateway to trust when communicating to the\nbackend on a port specified as https"

obj spec.backendSettings.loadBalancingPolicySpec

"LoadBalancing defines the load balancing policy for the backend service"

fn spec.backendSettings.loadBalancingPolicySpec.withTargetRefs

withTargetRefs(targetRefs)

"TargetRefs identifies a list of API objects to apply policy to."

fn spec.backendSettings.loadBalancingPolicySpec.withTargetRefsMixin

withTargetRefsMixin(targetRefs)

"TargetRefs identifies a list of API objects to apply policy to."

Note: This function appends passed data to existing values

obj spec.backendSettings.loadBalancingPolicySpec.circuitBreaker

"CircuitBreaker defines the schema for configuring Circuit Breaking"

fn spec.backendSettings.loadBalancingPolicySpec.circuitBreaker.withMaxConnections

withMaxConnections(maxConnections)

"The maximum number of connections that will be made to the backend service.\nDefault is 1000000000 (disabled)."

fn spec.backendSettings.loadBalancingPolicySpec.circuitBreaker.withMaxPendingRequests

withMaxPendingRequests(maxPendingRequests)

"Maximum number of pending requests that will be made to the backend service.\nDefault is 1000000000 (disabled)."

fn spec.backendSettings.loadBalancingPolicySpec.circuitBreaker.withMaxRequests

withMaxRequests(maxRequests)

"Maximum number of parallel requests that will be made to the backend service.\nDefault is 1000000000 (disabled)."

fn spec.backendSettings.loadBalancingPolicySpec.circuitBreaker.withMaxRetries

withMaxRetries(maxRetries)

"The maximum number of parallel retries allowed to the backend service.\nDefault is 1000000000 (disabled)."

obj spec.backendSettings.loadBalancingPolicySpec.loadBalancing

"LoadBalancing defines the schema for configuring Load Balancing options"

fn spec.backendSettings.loadBalancingPolicySpec.loadBalancing.withStrategy

withStrategy(strategy)

"Strategy defines the policy to use when load balancing traffic to the backend service.\nDefault is round-robin."

obj spec.backendSettings.loadBalancingPolicySpec.loadBalancing.loadAware

"LoadAware defines the schema for Load Aware Routing specification"

fn spec.backendSettings.loadBalancingPolicySpec.loadBalancing.loadAware.withBlackoutPeriod

withBlackoutPeriod(blackoutPeriod)

"An endpoint must report load metrics continuously for at least this long before the endpoint\nmetrics will be used to influence load balancing decisions. Takes effect both immediately after\nwe establish a connection to an endpoint and after metricExpirationPeriod has elapsed.\nDefault is 10 seconds."

fn spec.backendSettings.loadBalancingPolicySpec.loadBalancing.loadAware.withErrorUtilizationPenalty

withErrorUtilizationPenalty(errorUtilizationPenalty)

"The multiplier used to adjust endpoint weights with the error rated calculated based\non the reported rps_fractional and eps load metrics. Must not be a negative value.\nDefault is 1.0."

fn spec.backendSettings.loadBalancingPolicySpec.loadBalancing.loadAware.withMetricExpirationPeriod

withMetricExpirationPeriod(metricExpirationPeriod)

"If the endpoint does not report load metrics for this duration, metrics will stop\nbeing used to influence load balancing decisions. Default is 3 minutes."

fn spec.backendSettings.loadBalancingPolicySpec.loadBalancing.loadAware.withNamedMetrics

withNamedMetrics(namedMetrics)

"A list of custom metrics reported by endpoints to be used for reporting utilization\nand influencing load balancing decisions. Utilization will be computed by taking the\nmax of the values of metrics specified in this list."

fn spec.backendSettings.loadBalancingPolicySpec.loadBalancing.loadAware.withNamedMetricsMixin

withNamedMetricsMixin(namedMetrics)

"A list of custom metrics reported by endpoints to be used for reporting utilization\nand influencing load balancing decisions. Utilization will be computed by taking the\nmax of the values of metrics specified in this list."

Note: This function appends passed data to existing values

obj spec.backendSettings.loadBalancingPolicySpec.loadBalancing.slowStart

"SlowStart defines the schema for Slow Start specification"

fn spec.backendSettings.loadBalancingPolicySpec.loadBalancing.slowStart.withAggression

withAggression(aggression)

"The speed of traffic increase over the slow start window, must be greater than 0.0.\nDefaults to 1.0 if unspecified."

fn spec.backendSettings.loadBalancingPolicySpec.loadBalancing.slowStart.withStartWeightPercent

withStartWeightPercent(startWeightPercent)

"The minimum or starting percentage of traffic to send to new endpoints.\nDefaults to 10% if unspecified."

fn spec.backendSettings.loadBalancingPolicySpec.loadBalancing.slowStart.withWindow

withWindow(window)

"The duration of the slow start window."

obj spec.backendSettings.loadBalancingPolicySpec.targetRefs

"TargetRefs identifies a list of API objects to apply policy to."

fn spec.backendSettings.loadBalancingPolicySpec.targetRefs.withPorts

withPorts(ports)

"Ports specifies the list of ports on the target where the policy is applied."

fn spec.backendSettings.loadBalancingPolicySpec.targetRefs.withPortsMixin

withPortsMixin(ports)

"Ports specifies the list of ports on the target where the policy is applied."

Note: This function appends passed data to existing values

obj spec.backendSettings.loadBalancingPolicySpec.targetRefs.ports

"Ports specifies the list of ports on the target where the policy is applied."

fn spec.backendSettings.loadBalancingPolicySpec.targetRefs.ports.withPort

withPort(port)

"Port is the port to use for connection to the backend"

obj spec.backendSettings.loadBalancingPolicySpec.targetRefs.targetRef

"TargetRef identifies an API object to apply policy to."

fn spec.backendSettings.loadBalancingPolicySpec.targetRefs.targetRef.withGroup

withGroup(group)

"Group is the group of the target resource."

fn spec.backendSettings.loadBalancingPolicySpec.targetRefs.targetRef.withKind

withKind(kind)

"Kind is kind of the target resource."

fn spec.backendSettings.loadBalancingPolicySpec.targetRefs.targetRef.withName

withName(name)

"Name is the name of the target resource."

fn spec.backendSettings.loadBalancingPolicySpec.targetRefs.targetRef.withNamespace

withNamespace(namespace)

"Namespace is the namespace of the referent. When unspecified, the local\nnamespace is inferred. Even when policy targets a resource in a different\nnamespace, it MUST only apply to traffic originating from the same\nnamespace as the policy."

fn spec.backendSettings.loadBalancingPolicySpec.targetRefs.targetRef.withSectionNames

withSectionNames(sectionNames)

"SectionNames is the name of the section within the target resource. When\nunspecified, this targetRef targets the entire resource. In the following\nresources, SectionNames is interpreted as the following:\n\n Gateway: Listener Name\n Service: Port Name\n\nIf a SectionNames is specified, but doesn't exist on the targeted object,\nthe Policy fails to attach, and the policy implementation will record\na ResolvedRefs or similar Condition in the Policy's status."

fn spec.backendSettings.loadBalancingPolicySpec.targetRefs.targetRef.withSectionNamesMixin

withSectionNamesMixin(sectionNames)

"SectionNames is the name of the section within the target resource. When\nunspecified, this targetRef targets the entire resource. In the following\nresources, SectionNames is interpreted as the following:\n\n Gateway: Listener Name\n Service: Port Name\n\nIf a SectionNames is specified, but doesn't exist on the targeted object,\nthe Policy fails to attach, and the policy implementation will record\na ResolvedRefs or similar Condition in the Policy's status."

Note: This function appends passed data to existing values

obj spec.backendSettings.ports

"Ports can be used to indicate if the backend service is listening on HTTP or HTTPS"

fn spec.backendSettings.ports.withName

withName(name)

"Name must refer to a name on a port on the backend service"

fn spec.backendSettings.ports.withPort

withPort(port)

"Port indicates the port on the backend service"

fn spec.backendSettings.ports.withProtocol

withProtocol(protocol)

"Protocol should be one of \"HTTP\", \"HTTPS\

obj spec.backendSettings.sessionAffinity

"SessionAffinity allows client requests to be consistently given to the same backend"

fn spec.backendSettings.sessionAffinity.withAffinityType

withAffinityType(affinityType)

"AffinityType defines the affinity type for the Service"

fn spec.backendSettings.sessionAffinity.withCookieDuration

withCookieDuration(cookieDuration)

fn spec.backendSettings.sessionAffinity.withCookieName

withCookieName(cookieName)

obj spec.backendSettings.timeouts

"Timeouts define a set of timeout parameters to be applied to an Ingress"

fn spec.backendSettings.timeouts.withRequestTimeout

withRequestTimeout(requestTimeout)

"RequestTimeout defines the timeout used by the load balancer when forwarding requests to a backend service"

obj spec.rules

"Rules define the rules per host"

fn spec.rules.withAdditionalHostnames

withAdditionalHostnames(additionalHostnames)

"AdditionalHostnames specifies more hostnames to listen on"

fn spec.rules.withAdditionalHostnamesMixin

withAdditionalHostnamesMixin(additionalHostnames)

"AdditionalHostnames specifies more hostnames to listen on"

Note: This function appends passed data to existing values

fn spec.rules.withHost

withHost(host)

"Host is used to match against Ingress rules with the same hostname in order to identify which rules affect these settings"

fn spec.rules.withRewrites

withRewrites(rewrites)

"Rewrites defines the rewrites for the rule"

fn spec.rules.withRewritesMixin

withRewritesMixin(rewrites)

"Rewrites defines the rewrites for the rule"

Note: This function appends passed data to existing values

obj spec.rules.requestRedirect

"RequestRedirect defines the redirect behavior for the rule"

fn spec.rules.requestRedirect.withHostname

withHostname(hostname)

"Hostname is the hostname to be used in the value of the Location\nheader in the response.\nWhen empty, the hostname in the Host header of the request is used."

fn spec.rules.requestRedirect.withPort

withPort(port)

"Port is the port to be used in the value of the Location\nheader in the response.\n\nIf no port is specified, the redirect port MUST be derived using the\nfollowing rules:\n\n If redirect scheme is not-empty, the redirect port MUST be the well-known\n port associated with the redirect scheme. Specifically \"http\" to port 80\n and \"https\" to port 443. If the redirect scheme doesn't have a\n well-known port, the listener port of the Gateway SHOULD be used.\n If redirect scheme is empty, the redirect port MUST be the Gateway\n Listener port.\n\nImplementations SHOULD NOT add the port number in the 'Location'\nheader in the following cases:\n\n A Location header that uses HTTP (whether that is determined via\n the Listener protocol or the Scheme field) and use port 80.\n A Location header that uses HTTPS (whether that is determined via\n the Listener protocol or the Scheme field) and use port 443."

fn spec.rules.requestRedirect.withScheme

withScheme(scheme)

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

fn spec.rules.requestRedirect.withStatusCode

withStatusCode(statusCode)

"StatusCode is the HTTP status code to be used in response.\n\nValues may be added to this enum, implementations\nmust ensure that unknown values won't cause a crash."

obj spec.rules.requestRedirect.path

"Path defines parameters used to modify the path of the incoming request.\nThe modified path is then used to construct the Location header. When\nempty, the request path is used as-is."

fn spec.rules.requestRedirect.path.withReplaceFullPath

withReplaceFullPath(replaceFullPath)

"ReplaceFullPath specifies the value with which to replace the full path\nof a request during a rewrite or redirect."

fn spec.rules.requestRedirect.path.withReplacePrefixMatch

withReplacePrefixMatch(replacePrefixMatch)

"ReplacePrefixMatch specifies the value with which to replace the prefix\nmatch of a request during a rewrite or redirect. For example, a request\nto \"/foo/bar\" with a prefix match of \"/foo\" and a ReplacePrefixMatch\nof \"/xyz\" would be modified to \"/xyz/bar\".\n\nThis matches the behavior of the PathPrefix match type. This\nmatches full path elements. A path element refers to the list of labels\nin the path split by the / separator. When specified, a trailing / is\nignored. For example, the paths /abc, /abc/, and /abc/def would all\nmatch the prefix /abc, but the path /abcd wouldn't.\n\nReplacePrefixMatch is only compatible with a PathPrefix HTTPRouteMatch.\nUsing any other HTTPRouteMatch type on the same HTTPRouteRule results in\nthe implementation setting the Accepted Condition for the Route to status: False.\n\nRequest Path | Prefix Match | Replace Prefix | Modified Path\n|------------|--------------|----------------|----------\n/foo/bar | /foo | /xyz | /xyz/bar\n/foo/bar | /foo | /xyz/ | /xyz/bar\n/foo/bar | /foo/ | /xyz | /xyz/bar\n/foo/bar | /foo/ | /xyz/ | /xyz/bar\n/foo | /foo | /xyz | /xyz\n/foo/ | /foo | /xyz | /xyz/\n/foo/bar | /foo | | /bar\n/foo/ | /foo | | /\n/foo | /foo | | /\n/foo/ | /foo | / | /\n/foo | /foo | / | /"

fn spec.rules.requestRedirect.path.withType

withType(type)

"Type defines the type of path modifier. More types may be\nadded in a future release of the API.\n\nValues may be added to this enum, implementations\nmust ensure unknown values won't cause a crash.\n\nUnknown values here must result in the implementation setting the\nAccepted Condition for the rule to be false"

obj spec.rules.rewrites

"Rewrites defines the rewrites for the rule"

fn spec.rules.rewrites.withType

withType(type)

"Type identifies the type of rewrite"

obj spec.rules.rewrites.requestHeaderModifier

"RequestHeaderModifier defines a schema that modifies request headers."

fn spec.rules.rewrites.requestHeaderModifier.withAdd

withAdd(add)

"Add adds the given header(s) (name, value) to the request\nbefore the action. It appends to any existing values associated\nwith the header name.\n\nInput:\n GET /foo HTTP/1.1\n my-header: foo\n\nConfig:\n add:\n - name: \"my-header\"\n value: \"bar,baz\"\n\nOutput:\n GET /foo HTTP/1.1\n my-header: foo,bar,baz"

fn spec.rules.rewrites.requestHeaderModifier.withAddMixin

withAddMixin(add)

"Add adds the given header(s) (name, value) to the request\nbefore the action. It appends to any existing values associated\nwith the header name.\n\nInput:\n GET /foo HTTP/1.1\n my-header: foo\n\nConfig:\n add:\n - name: \"my-header\"\n value: \"bar,baz\"\n\nOutput:\n GET /foo HTTP/1.1\n my-header: foo,bar,baz"

Note: This function appends passed data to existing values

fn spec.rules.rewrites.requestHeaderModifier.withRemove

withRemove(remove)

"Remove the given header(s) from the HTTP request before the action. The\nvalue of Remove is a list of HTTP header names. Header names\nare case-insensitive (see\nhttps://datatracker.ietf.org/doc/html/rfc2616#section-4.2).\n\nInput:\n GET /foo HTTP/1.1\n my-header1: foo\n my-header2: bar\n my-header3: baz\n\nConfig:\n remove: [\"my-header1\", \"my-header3\"]\n\nOutput:\n GET /foo HTTP/1.1\n my-header2: bar"

fn spec.rules.rewrites.requestHeaderModifier.withRemoveMixin

withRemoveMixin(remove)

"Remove the given header(s) from the HTTP request before the action. The\nvalue of Remove is a list of HTTP header names. Header names\nare case-insensitive (see\nhttps://datatracker.ietf.org/doc/html/rfc2616#section-4.2).\n\nInput:\n GET /foo HTTP/1.1\n my-header1: foo\n my-header2: bar\n my-header3: baz\n\nConfig:\n remove: [\"my-header1\", \"my-header3\"]\n\nOutput:\n GET /foo HTTP/1.1\n my-header2: bar"

Note: This function appends passed data to existing values

fn spec.rules.rewrites.requestHeaderModifier.withSet

withSet(set)

"Set overwrites the request with the given header (name, value)\nbefore the action.\n\nInput:\n GET /foo HTTP/1.1\n my-header: foo\n\nConfig:\n set:\n - name: \"my-header\"\n value: \"bar\"\n\nOutput:\n GET /foo HTTP/1.1\n my-header: bar"

fn spec.rules.rewrites.requestHeaderModifier.withSetMixin

withSetMixin(set)

"Set overwrites the request with the given header (name, value)\nbefore the action.\n\nInput:\n GET /foo HTTP/1.1\n my-header: foo\n\nConfig:\n set:\n - name: \"my-header\"\n value: \"bar\"\n\nOutput:\n GET /foo HTTP/1.1\n my-header: bar"

Note: This function appends passed data to existing values

obj spec.rules.rewrites.requestHeaderModifier.add

"Add adds the given header(s) (name, value) to the request\nbefore the action. It appends to any existing values associated\nwith the header name.\n\nInput:\n GET /foo HTTP/1.1\n my-header: foo\n\nConfig:\n add:\n - name: \"my-header\"\n value: \"bar,baz\"\n\nOutput:\n GET /foo HTTP/1.1\n my-header: foo,bar,baz"

fn spec.rules.rewrites.requestHeaderModifier.add.withName

withName(name)

"Name is the name of the HTTP Header to be matched. Name matching MUST be\ncase insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).\n\nIf multiple entries specify equivalent header names, the first entry with\nan equivalent name MUST be considered for a match. Subsequent entries\nwith an equivalent header name MUST be ignored. Due to the\ncase-insensitivity of header names, \"foo\" and \"Foo\" are considered\nequivalent."

fn spec.rules.rewrites.requestHeaderModifier.add.withValue

withValue(value)

"Value is the value of HTTP Header to be matched."

obj spec.rules.rewrites.requestHeaderModifier.set

"Set overwrites the request with the given header (name, value)\nbefore the action.\n\nInput:\n GET /foo HTTP/1.1\n my-header: foo\n\nConfig:\n set:\n - name: \"my-header\"\n value: \"bar\"\n\nOutput:\n GET /foo HTTP/1.1\n my-header: bar"

fn spec.rules.rewrites.requestHeaderModifier.set.withName

withName(name)

"Name is the name of the HTTP Header to be matched. Name matching MUST be\ncase insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).\n\nIf multiple entries specify equivalent header names, the first entry with\nan equivalent name MUST be considered for a match. Subsequent entries\nwith an equivalent header name MUST be ignored. Due to the\ncase-insensitivity of header names, \"foo\" and \"Foo\" are considered\nequivalent."

fn spec.rules.rewrites.requestHeaderModifier.set.withValue

withValue(value)

"Value is the value of HTTP Header to be matched."

obj spec.rules.rewrites.responseHeaderModifier

"RequestHeaderModifier defines a schema that modifies response headers."

fn spec.rules.rewrites.responseHeaderModifier.withAdd

withAdd(add)

"Add adds the given header(s) (name, value) to the request\nbefore the action. It appends to any existing values associated\nwith the header name.\n\nInput:\n GET /foo HTTP/1.1\n my-header: foo\n\nConfig:\n add:\n - name: \"my-header\"\n value: \"bar,baz\"\n\nOutput:\n GET /foo HTTP/1.1\n my-header: foo,bar,baz"

fn spec.rules.rewrites.responseHeaderModifier.withAddMixin

withAddMixin(add)

"Add adds the given header(s) (name, value) to the request\nbefore the action. It appends to any existing values associated\nwith the header name.\n\nInput:\n GET /foo HTTP/1.1\n my-header: foo\n\nConfig:\n add:\n - name: \"my-header\"\n value: \"bar,baz\"\n\nOutput:\n GET /foo HTTP/1.1\n my-header: foo,bar,baz"

Note: This function appends passed data to existing values

fn spec.rules.rewrites.responseHeaderModifier.withRemove

withRemove(remove)

"Remove the given header(s) from the HTTP request before the action. The\nvalue of Remove is a list of HTTP header names. Header names\nare case-insensitive (see\nhttps://datatracker.ietf.org/doc/html/rfc2616#section-4.2).\n\nInput:\n GET /foo HTTP/1.1\n my-header1: foo\n my-header2: bar\n my-header3: baz\n\nConfig:\n remove: [\"my-header1\", \"my-header3\"]\n\nOutput:\n GET /foo HTTP/1.1\n my-header2: bar"

fn spec.rules.rewrites.responseHeaderModifier.withRemoveMixin

withRemoveMixin(remove)

"Remove the given header(s) from the HTTP request before the action. The\nvalue of Remove is a list of HTTP header names. Header names\nare case-insensitive (see\nhttps://datatracker.ietf.org/doc/html/rfc2616#section-4.2).\n\nInput:\n GET /foo HTTP/1.1\n my-header1: foo\n my-header2: bar\n my-header3: baz\n\nConfig:\n remove: [\"my-header1\", \"my-header3\"]\n\nOutput:\n GET /foo HTTP/1.1\n my-header2: bar"

Note: This function appends passed data to existing values

fn spec.rules.rewrites.responseHeaderModifier.withSet

withSet(set)

"Set overwrites the request with the given header (name, value)\nbefore the action.\n\nInput:\n GET /foo HTTP/1.1\n my-header: foo\n\nConfig:\n set:\n - name: \"my-header\"\n value: \"bar\"\n\nOutput:\n GET /foo HTTP/1.1\n my-header: bar"

fn spec.rules.rewrites.responseHeaderModifier.withSetMixin

withSetMixin(set)

"Set overwrites the request with the given header (name, value)\nbefore the action.\n\nInput:\n GET /foo HTTP/1.1\n my-header: foo\n\nConfig:\n set:\n - name: \"my-header\"\n value: \"bar\"\n\nOutput:\n GET /foo HTTP/1.1\n my-header: bar"

Note: This function appends passed data to existing values

obj spec.rules.rewrites.responseHeaderModifier.add

"Add adds the given header(s) (name, value) to the request\nbefore the action. It appends to any existing values associated\nwith the header name.\n\nInput:\n GET /foo HTTP/1.1\n my-header: foo\n\nConfig:\n add:\n - name: \"my-header\"\n value: \"bar,baz\"\n\nOutput:\n GET /foo HTTP/1.1\n my-header: foo,bar,baz"

fn spec.rules.rewrites.responseHeaderModifier.add.withName

withName(name)

"Name is the name of the HTTP Header to be matched. Name matching MUST be\ncase insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).\n\nIf multiple entries specify equivalent header names, the first entry with\nan equivalent name MUST be considered for a match. Subsequent entries\nwith an equivalent header name MUST be ignored. Due to the\ncase-insensitivity of header names, \"foo\" and \"Foo\" are considered\nequivalent."

fn spec.rules.rewrites.responseHeaderModifier.add.withValue

withValue(value)

"Value is the value of HTTP Header to be matched."

obj spec.rules.rewrites.responseHeaderModifier.set

"Set overwrites the request with the given header (name, value)\nbefore the action.\n\nInput:\n GET /foo HTTP/1.1\n my-header: foo\n\nConfig:\n set:\n - name: \"my-header\"\n value: \"bar\"\n\nOutput:\n GET /foo HTTP/1.1\n my-header: bar"

fn spec.rules.rewrites.responseHeaderModifier.set.withName

withName(name)

"Name is the name of the HTTP Header to be matched. Name matching MUST be\ncase insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).\n\nIf multiple entries specify equivalent header names, the first entry with\nan equivalent name MUST be considered for a match. Subsequent entries\nwith an equivalent header name MUST be ignored. Due to the\ncase-insensitivity of header names, \"foo\" and \"Foo\" are considered\nequivalent."

fn spec.rules.rewrites.responseHeaderModifier.set.withValue

withValue(value)

"Value is the value of HTTP Header to be matched."

obj spec.rules.rewrites.urlRewrite

"URLRewrite defines a schema that modifies a request during forwarding."

fn spec.rules.rewrites.urlRewrite.withHostname

withHostname(hostname)

"Hostname is the value to be used to replace the Host header value during\nforwarding."

obj spec.rules.rewrites.urlRewrite.path

"Path defines a path rewrite."

fn spec.rules.rewrites.urlRewrite.path.withReplaceFullPath

withReplaceFullPath(replaceFullPath)

"ReplaceFullPath specifies the value with which to replace the full path\nof a request during a rewrite or redirect."

fn spec.rules.rewrites.urlRewrite.path.withReplacePrefixMatch

withReplacePrefixMatch(replacePrefixMatch)

"ReplacePrefixMatch specifies the value with which to replace the prefix\nmatch of a request during a rewrite or redirect. For example, a request\nto \"/foo/bar\" with a prefix match of \"/foo\" and a ReplacePrefixMatch\nof \"/xyz\" would be modified to \"/xyz/bar\".\n\nThis matches the behavior of the PathPrefix match type. This\nmatches full path elements. A path element refers to the list of labels\nin the path split by the / separator. When specified, a trailing / is\nignored. For example, the paths /abc, /abc/, and /abc/def would all\nmatch the prefix /abc, but the path /abcd wouldn't.\n\nReplacePrefixMatch is only compatible with a PathPrefix HTTPRouteMatch.\nUsing any other HTTPRouteMatch type on the same HTTPRouteRule results in\nthe implementation setting the Accepted Condition for the Route to status: False.\n\nRequest Path | Prefix Match | Replace Prefix | Modified Path\n|------------|--------------|----------------|----------\n/foo/bar | /foo | /xyz | /xyz/bar\n/foo/bar | /foo | /xyz/ | /xyz/bar\n/foo/bar | /foo/ | /xyz | /xyz/bar\n/foo/bar | /foo/ | /xyz/ | /xyz/bar\n/foo | /foo | /xyz | /xyz\n/foo/ | /foo | /xyz | /xyz/\n/foo/bar | /foo | | /bar\n/foo/ | /foo | | /\n/foo | /foo | | /\n/foo/ | /foo | / | /\n/foo | /foo | / | /"

fn spec.rules.rewrites.urlRewrite.path.withType

withType(type)

"Type defines the type of path modifier. More types may be\nadded in a future release of the API.\n\nValues may be added to this enum, implementations\nmust ensure unknown values won't cause a crash.\n\nUnknown values here must result in the implementation setting the\nAccepted Condition for the rule to be false"