compute.v1beta1.computeURLMap

Index

fn new(name)
obj metadata
obj spec

Fields

fn new

new(name)

new returns an instance of ComputeURLMap

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

fn spec.withDescription

withDescription(description)

"An optional description of this resource. Provide this property when\nyou create the resource."

fn spec.withHostRule

withHostRule(hostRule)

"The list of HostRules to use against the URL."

fn spec.withHostRuleMixin

withHostRuleMixin(hostRule)

"The list of HostRules to use against the URL."

Note: This function appends passed data to existing values

fn spec.withLocation

withLocation(location)

"Location represents the geographical location of the ComputeURLMap. Specify a region name or \"global\" for global resources. Reference: GCP definition of regions/zones (https://cloud.google.com/compute/docs/regions-zones/)"

fn spec.withPathMatcher

withPathMatcher(pathMatcher)

"The list of named PathMatchers to use against the URL."

fn spec.withPathMatcherMixin

withPathMatcherMixin(pathMatcher)

"The list of named PathMatchers to use against the URL."

Note: This function appends passed data to existing values

fn spec.withResourceID

withResourceID(resourceID)

"Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of metadata.name is used as the default."

fn spec.withTest

withTest(test)

"The list of expected URL mappings. Requests to update this UrlMap will\nsucceed only if all of the test cases pass."

fn spec.withTestMixin

withTestMixin(test)

"The list of expected URL mappings. Requests to update this UrlMap will\nsucceed only if all of the test cases pass."

Note: This function appends passed data to existing values

obj spec.defaultRouteAction

"defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices.\nOnly one of defaultRouteAction or defaultUrlRedirect must be set.\nURL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within defaultRouteAction.\ndefaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true."

fn spec.defaultRouteAction.withWeightedBackendServices

withWeightedBackendServices(weightedBackendServices)

"A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number.\nAfter a backend service is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction."

fn spec.defaultRouteAction.withWeightedBackendServicesMixin

withWeightedBackendServicesMixin(weightedBackendServices)

"A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number.\nAfter a backend service is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction."

Note: This function appends passed data to existing values

obj spec.defaultRouteAction.corsPolicy

"The specification for allowing client side cross-origin requests. Please see\nW3C Recommendation for Cross Origin Resource Sharing."

fn spec.defaultRouteAction.corsPolicy.withAllowCredentials

withAllowCredentials(allowCredentials)

"In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header.\nDefault is false."

fn spec.defaultRouteAction.corsPolicy.withAllowHeaders

withAllowHeaders(allowHeaders)

"Specifies the content for the Access-Control-Allow-Headers header."

fn spec.defaultRouteAction.corsPolicy.withAllowHeadersMixin

withAllowHeadersMixin(allowHeaders)

"Specifies the content for the Access-Control-Allow-Headers header."

Note: This function appends passed data to existing values

fn spec.defaultRouteAction.corsPolicy.withAllowMethods

withAllowMethods(allowMethods)

"Specifies the content for the Access-Control-Allow-Methods header."

fn spec.defaultRouteAction.corsPolicy.withAllowMethodsMixin

withAllowMethodsMixin(allowMethods)

"Specifies the content for the Access-Control-Allow-Methods header."

Note: This function appends passed data to existing values

fn spec.defaultRouteAction.corsPolicy.withAllowOriginRegexes

withAllowOriginRegexes(allowOriginRegexes)

"Specifies the regualar expression patterns that match allowed origins. For regular expression grammar\nplease see en.cppreference.com/w/cpp/regex/ecmascript\nAn origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes."

fn spec.defaultRouteAction.corsPolicy.withAllowOriginRegexesMixin

withAllowOriginRegexesMixin(allowOriginRegexes)

"Specifies the regualar expression patterns that match allowed origins. For regular expression grammar\nplease see en.cppreference.com/w/cpp/regex/ecmascript\nAn origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes."

Note: This function appends passed data to existing values

fn spec.defaultRouteAction.corsPolicy.withAllowOrigins

withAllowOrigins(allowOrigins)

"Specifies the list of origins that will be allowed to do CORS requests.\nAn origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes."

fn spec.defaultRouteAction.corsPolicy.withAllowOriginsMixin

withAllowOriginsMixin(allowOrigins)

"Specifies the list of origins that will be allowed to do CORS requests.\nAn origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes."

Note: This function appends passed data to existing values

fn spec.defaultRouteAction.corsPolicy.withDisabled

withDisabled(disabled)

"If true, the setting specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect."

fn spec.defaultRouteAction.corsPolicy.withExposeHeaders

withExposeHeaders(exposeHeaders)

"Specifies the content for the Access-Control-Expose-Headers header."

fn spec.defaultRouteAction.corsPolicy.withExposeHeadersMixin

withExposeHeadersMixin(exposeHeaders)

"Specifies the content for the Access-Control-Expose-Headers header."

Note: This function appends passed data to existing values

fn spec.defaultRouteAction.corsPolicy.withMaxAge

withMaxAge(maxAge)

"Specifies how long results of a preflight request can be cached in seconds.\nThis translates to the Access-Control-Max-Age header."

obj spec.defaultRouteAction.faultInjectionPolicy

"The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure.\nAs part of fault injection, when clients send requests to a backend service, delays can be introduced by a load balancer on a percentage of requests before sending those requests to the backend service.\nSimilarly requests from clients can be aborted by the load balancer for a percentage of requests.\ntimeout and retryPolicy is ignored by clients that are configured with a faultInjectionPolicy if: 1. The traffic is generated by fault injection AND 2. The fault injection is not a delay fault injection.\nFault injection is not supported with the global external HTTP(S) load balancer (classic). To see which load balancers support fault injection, see Load balancing: Routing and traffic management features."

obj spec.defaultRouteAction.faultInjectionPolicy.abort

"The specification for how client requests are aborted as part of fault injection."

fn spec.defaultRouteAction.faultInjectionPolicy.abort.withHttpStatus

withHttpStatus(httpStatus)

"The HTTP status code used to abort the request.\nThe value must be between 200 and 599 inclusive."

fn spec.defaultRouteAction.faultInjectionPolicy.abort.withPercentage

withPercentage(percentage)

"The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.\nThe value must be between 0.0 and 100.0 inclusive."

obj spec.defaultRouteAction.faultInjectionPolicy.delay

"The specification for how client requests are delayed as part of fault injection, before being sent to a backend service."

fn spec.defaultRouteAction.faultInjectionPolicy.delay.withPercentage

withPercentage(percentage)

"The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.\nThe value must be between 0.0 and 100.0 inclusive."

obj spec.defaultRouteAction.faultInjectionPolicy.delay.fixedDelay

"Specifies the value of the fixed delay interval."

fn spec.defaultRouteAction.faultInjectionPolicy.delay.fixedDelay.withNanos

withNanos(nanos)

"Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are\nrepresented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive."

fn spec.defaultRouteAction.faultInjectionPolicy.delay.fixedDelay.withSeconds

withSeconds(seconds)

"Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.\nNote: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years."

obj spec.defaultRouteAction.requestMirrorPolicy

"Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service.\nThe load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow.\nNot supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true."

obj spec.defaultRouteAction.requestMirrorPolicy.backendServiceRef

"The backend service resource being mirrored to.\nThe backend service configured for a mirroring policy must reference\nbackends that are of the same type as the original backend service\nmatched in the URL map.\nServerless NEG backends are not currently supported as a mirrored\nbackend service."

fn spec.defaultRouteAction.requestMirrorPolicy.backendServiceRef.withExternal

withExternal(external)

"Allowed value: The selfLink field of a ComputeBackendService resource."

fn spec.defaultRouteAction.requestMirrorPolicy.backendServiceRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.defaultRouteAction.requestMirrorPolicy.backendServiceRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.defaultRouteAction.retryPolicy

"Specifies the retry policy associated with this route."

fn spec.defaultRouteAction.retryPolicy.withNumRetries

withNumRetries(numRetries)

"Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1."

fn spec.defaultRouteAction.retryPolicy.withRetryConditions

withRetryConditions(retryConditions)

"Specifies one or more conditions when this retry policy applies.\nValid values are listed below. Only the following codes are supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true: cancelled, deadline-exceeded, internal, resource-exhausted, unavailable.\n - 5xx : retry is attempted if the instance or endpoint responds with any 5xx response code, or if the instance or endpoint does not respond at all. For example, disconnects, reset, read timeout, connection failure, and refused streams.\n - gateway-error : Similar to 5xx, but only applies to response codes 502, 503 or 504.\n - connect-failure : a retry is attempted on failures connecting to the instance or endpoint. For example, connection timeouts.\n - retriable-4xx : a retry is attempted if the instance or endpoint responds with a 4xx response code. The only error that you can retry is error code 409.\n - refused-stream : a retry is attempted if the instance or endpoint resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.\n - cancelled : a retry is attempted if the gRPC status code in the response header is set to cancelled.\n - deadline-exceeded : a retry is attempted if the gRPC status code in the response header is set to deadline-exceeded.\n - internal : a retry is attempted if the gRPC status code in the response header is set to internal.\n - resource-exhausted : a retry is attempted if the gRPC status code in the response header is set to resource-exhausted.\n - unavailable : a retry is attempted if the gRPC status code in the response header is set to unavailable."

fn spec.defaultRouteAction.retryPolicy.withRetryConditionsMixin

withRetryConditionsMixin(retryConditions)

"Specifies one or more conditions when this retry policy applies.\nValid values are listed below. Only the following codes are supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true: cancelled, deadline-exceeded, internal, resource-exhausted, unavailable.\n - 5xx : retry is attempted if the instance or endpoint responds with any 5xx response code, or if the instance or endpoint does not respond at all. For example, disconnects, reset, read timeout, connection failure, and refused streams.\n - gateway-error : Similar to 5xx, but only applies to response codes 502, 503 or 504.\n - connect-failure : a retry is attempted on failures connecting to the instance or endpoint. For example, connection timeouts.\n - retriable-4xx : a retry is attempted if the instance or endpoint responds with a 4xx response code. The only error that you can retry is error code 409.\n - refused-stream : a retry is attempted if the instance or endpoint resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.\n - cancelled : a retry is attempted if the gRPC status code in the response header is set to cancelled.\n - deadline-exceeded : a retry is attempted if the gRPC status code in the response header is set to deadline-exceeded.\n - internal : a retry is attempted if the gRPC status code in the response header is set to internal.\n - resource-exhausted : a retry is attempted if the gRPC status code in the response header is set to resource-exhausted.\n - unavailable : a retry is attempted if the gRPC status code in the response header is set to unavailable."

Note: This function appends passed data to existing values

obj spec.defaultRouteAction.retryPolicy.perTryTimeout

"Specifies a non-zero timeout per retry attempt.\n\nIf not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set,\nwill use the largest timeout among all backend services associated with the route."

fn spec.defaultRouteAction.retryPolicy.perTryTimeout.withNanos

withNanos(nanos)

"Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are\nrepresented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive."

fn spec.defaultRouteAction.retryPolicy.perTryTimeout.withSeconds

withSeconds(seconds)

"Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.\nNote: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years."

obj spec.defaultRouteAction.timeout

"Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (known as end-of-stream) up until the response has been processed. Timeout includes all retries.\nIf not specified, this field uses the largest timeout among all backend services associated with the route.\nNot supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true."

fn spec.defaultRouteAction.timeout.withNanos

withNanos(nanos)

"Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive."

fn spec.defaultRouteAction.timeout.withSeconds

withSeconds(seconds)

"Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years."

obj spec.defaultRouteAction.urlRewrite

"The spec to modify the URL of the request, before forwarding the request to the matched service.\nurlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.\nNot supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true."

fn spec.defaultRouteAction.urlRewrite.withHostRewrite

withHostRewrite(hostRewrite)

"Before forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.\nThe value must be from 1 to 255 characters."

fn spec.defaultRouteAction.urlRewrite.withPathPrefixRewrite

withPathPrefixRewrite(pathPrefixRewrite)

"Before forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.\nThe value must be from 1 to 1024 characters."

obj spec.defaultRouteAction.weightedBackendServices

"A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number.\nAfter a backend service is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction."

fn spec.defaultRouteAction.weightedBackendServices.withWeight

withWeight(weight)

"Specifies the fraction of traffic sent to a backend service, computed as weight / (sum of all weightedBackendService weights in routeAction) .\nThe selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backend service, subsequent requests are sent to the same backend service as determined by the backend service's session affinity policy.\nThe value must be from 0 to 1000."

obj spec.defaultRouteAction.weightedBackendServices.backendServiceRef

"The default backend service resource.\nBefore forwarding the request to backendService, the loadbalancer\napplies any relevant headerActions specified as part of this\nbackendServiceWeight."

fn spec.defaultRouteAction.weightedBackendServices.backendServiceRef.withExternal

withExternal(external)

"Allowed value: The selfLink field of a ComputeBackendService resource."

fn spec.defaultRouteAction.weightedBackendServices.backendServiceRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.defaultRouteAction.weightedBackendServices.backendServiceRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.defaultRouteAction.weightedBackendServices.headerAction

"Specifies changes to request and response headers that need to take effect for the selected backendService.\nheaderAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.\nheaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL.\nNot supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true."

fn spec.defaultRouteAction.weightedBackendServices.headerAction.withRequestHeadersToAdd

withRequestHeadersToAdd(requestHeadersToAdd)

"Headers to add to a matching request before forwarding the request to the backendService."

fn spec.defaultRouteAction.weightedBackendServices.headerAction.withRequestHeadersToAddMixin

withRequestHeadersToAddMixin(requestHeadersToAdd)

"Headers to add to a matching request before forwarding the request to the backendService."

Note: This function appends passed data to existing values

fn spec.defaultRouteAction.weightedBackendServices.headerAction.withRequestHeadersToRemove

withRequestHeadersToRemove(requestHeadersToRemove)

"A list of header names for headers that need to be removed from the request before forwarding the request to the backendService."

fn spec.defaultRouteAction.weightedBackendServices.headerAction.withRequestHeadersToRemoveMixin

withRequestHeadersToRemoveMixin(requestHeadersToRemove)

"A list of header names for headers that need to be removed from the request before forwarding the request to the backendService."

Note: This function appends passed data to existing values

fn spec.defaultRouteAction.weightedBackendServices.headerAction.withResponseHeadersToAdd

withResponseHeadersToAdd(responseHeadersToAdd)

"Headers to add the response before sending the response back to the client."

fn spec.defaultRouteAction.weightedBackendServices.headerAction.withResponseHeadersToAddMixin

withResponseHeadersToAddMixin(responseHeadersToAdd)

"Headers to add the response before sending the response back to the client."

Note: This function appends passed data to existing values

fn spec.defaultRouteAction.weightedBackendServices.headerAction.withResponseHeadersToRemove

withResponseHeadersToRemove(responseHeadersToRemove)

"A list of header names for headers that need to be removed from the response before sending the response back to the client."

fn spec.defaultRouteAction.weightedBackendServices.headerAction.withResponseHeadersToRemoveMixin

withResponseHeadersToRemoveMixin(responseHeadersToRemove)

"A list of header names for headers that need to be removed from the response before sending the response back to the client."

Note: This function appends passed data to existing values

obj spec.defaultRouteAction.weightedBackendServices.headerAction.requestHeadersToAdd

"Headers to add to a matching request before forwarding the request to the backendService."

fn spec.defaultRouteAction.weightedBackendServices.headerAction.requestHeadersToAdd.withHeaderName

withHeaderName(headerName)

"The name of the header."

fn spec.defaultRouteAction.weightedBackendServices.headerAction.requestHeadersToAdd.withHeaderValue

withHeaderValue(headerValue)

"The value of the header to add."

fn spec.defaultRouteAction.weightedBackendServices.headerAction.requestHeadersToAdd.withReplace

withReplace(replace)

"If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.\nThe default value is false."

obj spec.defaultRouteAction.weightedBackendServices.headerAction.responseHeadersToAdd

"Headers to add the response before sending the response back to the client."

fn spec.defaultRouteAction.weightedBackendServices.headerAction.responseHeadersToAdd.withHeaderName

withHeaderName(headerName)

"The name of the header."

fn spec.defaultRouteAction.weightedBackendServices.headerAction.responseHeadersToAdd.withHeaderValue

withHeaderValue(headerValue)

"The value of the header to add."

fn spec.defaultRouteAction.weightedBackendServices.headerAction.responseHeadersToAdd.withReplace

withReplace(replace)

"If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.\nThe default value is false."

obj spec.defaultService

"The defaultService resource to which traffic is directed if none of\nthe hostRules match.\nFor the Global URL Map, it should be a reference to the backend\nservice or backend bucket.\nFor the Regional URL Map, it should be a reference to the backend\nservice.\nIf defaultRouteAction is additionally specified, advanced routing\nactions like URL Rewrites, etc. take effect prior to sending the\nrequest to the backend. However, if defaultService is specified,\ndefaultRouteAction cannot contain any weightedBackendServices.\nConversely, if routeAction specifies any weightedBackendServices,\nservice must not be specified. Only one of defaultService,\ndefaultUrlRedirect or defaultRouteAction.weightedBackendService\nmust be set."

obj spec.defaultService.backendBucketRef

fn spec.defaultService.backendBucketRef.withExternal

withExternal(external)

"Allowed value: The selfLink field of a ComputeBackendBucket resource."

fn spec.defaultService.backendBucketRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.defaultService.backendBucketRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.defaultService.backendServiceRef

fn spec.defaultService.backendServiceRef.withExternal

withExternal(external)

"Allowed value: The selfLink field of a ComputeBackendService resource."

fn spec.defaultService.backendServiceRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.defaultService.backendServiceRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.defaultUrlRedirect

"When none of the specified hostRules match, the request is redirected to a URL specified\nby defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or\ndefaultRouteAction must not be set."

fn spec.defaultUrlRedirect.withHostRedirect

withHostRedirect(hostRedirect)

"The host that will be used in the redirect response instead of the one that was\nsupplied in the request. The value must be between 1 and 255 characters."

fn spec.defaultUrlRedirect.withHttpsRedirect

withHttpsRedirect(httpsRedirect)

"If set to true, the URL scheme in the redirected request is set to https. If set to\nfalse, the URL scheme of the redirected request will remain the same as that of the\nrequest. This must only be set for UrlMaps used in TargetHttpProxys. Setting this\ntrue for TargetHttpsProxy is not permitted. The default is set to false."

fn spec.defaultUrlRedirect.withPathRedirect

withPathRedirect(pathRedirect)

"The path that will be used in the redirect response instead of the one that was\nsupplied in the request. pathRedirect cannot be supplied together with\nprefixRedirect. Supply one alone or neither. If neither is supplied, the path of the\noriginal request will be used for the redirect. The value must be between 1 and 1024\ncharacters."

fn spec.defaultUrlRedirect.withPrefixRedirect

withPrefixRedirect(prefixRedirect)

"The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch,\nretaining the remaining portion of the URL before redirecting the request.\nprefixRedirect cannot be supplied together with pathRedirect. Supply one alone or\nneither. If neither is supplied, the path of the original request will be used for\nthe redirect. The value must be between 1 and 1024 characters."

fn spec.defaultUrlRedirect.withRedirectResponseCode

withRedirectResponseCode(redirectResponseCode)

"The HTTP Status code to use for this RedirectAction. Supported values are:\n\n MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.\n\n FOUND, which corresponds to 302.\n\n SEE_OTHER which corresponds to 303.\n\n TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method\nwill be retained.\n\n* PERMANENT_REDIRECT, which corresponds to 308. In this case,\nthe request method will be retained. Possible values: [\"FOUND\", \"MOVED_PERMANENTLY_DEFAULT\", \"PERMANENT_REDIRECT\", \"SEE_OTHER\", \"TEMPORARY_REDIRECT\"]."

fn spec.defaultUrlRedirect.withStripQuery

withStripQuery(stripQuery)

"If set to true, any accompanying query portion of the original URL is removed prior\nto redirecting the request. If set to false, the query portion of the original URL is\nretained.\n This field is required to ensure an empty block is not set. The normal default value is false."

obj spec.headerAction

"Specifies changes to request and response headers that need to take effect for\nthe selected backendService. The headerAction specified here take effect after\nheaderAction specified under pathMatcher."

fn spec.headerAction.withRequestHeadersToAdd

withRequestHeadersToAdd(requestHeadersToAdd)

"Headers to add to a matching request prior to forwarding the request to the\nbackendService."

fn spec.headerAction.withRequestHeadersToAddMixin

withRequestHeadersToAddMixin(requestHeadersToAdd)

"Headers to add to a matching request prior to forwarding the request to the\nbackendService."

Note: This function appends passed data to existing values

fn spec.headerAction.withRequestHeadersToRemove

withRequestHeadersToRemove(requestHeadersToRemove)

"A list of header names for headers that need to be removed from the request\nprior to forwarding the request to the backendService."

fn spec.headerAction.withRequestHeadersToRemoveMixin

withRequestHeadersToRemoveMixin(requestHeadersToRemove)

"A list of header names for headers that need to be removed from the request\nprior to forwarding the request to the backendService."

Note: This function appends passed data to existing values

fn spec.headerAction.withResponseHeadersToAdd

withResponseHeadersToAdd(responseHeadersToAdd)

"Headers to add the response prior to sending the response back to the client."

fn spec.headerAction.withResponseHeadersToAddMixin

withResponseHeadersToAddMixin(responseHeadersToAdd)

"Headers to add the response prior to sending the response back to the client."

Note: This function appends passed data to existing values

fn spec.headerAction.withResponseHeadersToRemove

withResponseHeadersToRemove(responseHeadersToRemove)

"A list of header names for headers that need to be removed from the response\nprior to sending the response back to the client."

fn spec.headerAction.withResponseHeadersToRemoveMixin

withResponseHeadersToRemoveMixin(responseHeadersToRemove)

"A list of header names for headers that need to be removed from the response\nprior to sending the response back to the client."

Note: This function appends passed data to existing values

obj spec.headerAction.requestHeadersToAdd

"Headers to add to a matching request prior to forwarding the request to the\nbackendService."

fn spec.headerAction.requestHeadersToAdd.withHeaderName

withHeaderName(headerName)

"The name of the header."

fn spec.headerAction.requestHeadersToAdd.withHeaderValue

withHeaderValue(headerValue)

"The value of the header to add."

fn spec.headerAction.requestHeadersToAdd.withReplace

withReplace(replace)

"If false, headerValue is appended to any values that already exist for the\nheader. If true, headerValue is set for the header, discarding any values that\nwere set for that header."

obj spec.headerAction.responseHeadersToAdd

"Headers to add the response prior to sending the response back to the client."

fn spec.headerAction.responseHeadersToAdd.withHeaderName

withHeaderName(headerName)

"The name of the header."

fn spec.headerAction.responseHeadersToAdd.withHeaderValue

withHeaderValue(headerValue)

"The value of the header to add."

fn spec.headerAction.responseHeadersToAdd.withReplace

withReplace(replace)

"If false, headerValue is appended to any values that already exist for the\nheader. If true, headerValue is set for the header, discarding any values that\nwere set for that header."

obj spec.hostRule

"The list of HostRules to use against the URL."

fn spec.hostRule.withDescription

withDescription(description)

"An optional description of this HostRule. Provide this property\nwhen you create the resource."

fn spec.hostRule.withHosts

withHosts(hosts)

"The list of host patterns to match. They must be valid\nhostnames, except * will match any string of ([a-z0-9-.]*). In\nthat case, * must be the first character and must be followed in\nthe pattern by either - or .."

fn spec.hostRule.withHostsMixin

withHostsMixin(hosts)

"The list of host patterns to match. They must be valid\nhostnames, except * will match any string of ([a-z0-9-.]*). In\nthat case, * must be the first character and must be followed in\nthe pattern by either - or .."

Note: This function appends passed data to existing values

fn spec.hostRule.withPathMatcher

withPathMatcher(pathMatcher)

"The name of the PathMatcher to use to match the path portion of\nthe URL if the hostRule matches the URL's host portion."

obj spec.pathMatcher

"The list of named PathMatchers to use against the URL."

fn spec.pathMatcher.withDescription

withDescription(description)

"An optional description of this resource."

fn spec.pathMatcher.withName

withName(name)

"The name to which this PathMatcher is referred by the HostRule."

fn spec.pathMatcher.withPathRule

withPathRule(pathRule)

"The list of path rules. Use this list instead of routeRules when routing based\non simple path matching is all that's required. The order by which path rules\nare specified does not matter. Matches are always done on the longest-path-first\nbasis. For example: a pathRule with a path /a/b/c/ will match before /a/b/\nirrespective of the order in which those paths appear in this list. Within a\ngiven pathMatcher, only one of pathRules or routeRules must be set."

fn spec.pathMatcher.withPathRuleMixin

withPathRuleMixin(pathRule)

"The list of path rules. Use this list instead of routeRules when routing based\non simple path matching is all that's required. The order by which path rules\nare specified does not matter. Matches are always done on the longest-path-first\nbasis. For example: a pathRule with a path /a/b/c/ will match before /a/b/\nirrespective of the order in which those paths appear in this list. Within a\ngiven pathMatcher, only one of pathRules or routeRules must be set."

Note: This function appends passed data to existing values

fn spec.pathMatcher.withRouteRules

withRouteRules(routeRules)

"The list of ordered HTTP route rules. Use this list instead of pathRules when\nadvanced route matching and routing actions are desired. The order of specifying\nrouteRules matters: the first rule that matches will cause its specified routing\naction to take effect. Within a given pathMatcher, only one of pathRules or\nrouteRules must be set. routeRules are not supported in UrlMaps intended for\nExternal load balancers."

fn spec.pathMatcher.withRouteRulesMixin

withRouteRulesMixin(routeRules)

"The list of ordered HTTP route rules. Use this list instead of pathRules when\nadvanced route matching and routing actions are desired. The order of specifying\nrouteRules matters: the first rule that matches will cause its specified routing\naction to take effect. Within a given pathMatcher, only one of pathRules or\nrouteRules must be set. routeRules are not supported in UrlMaps intended for\nExternal load balancers."

Note: This function appends passed data to existing values

obj spec.pathMatcher.defaultRouteAction

"defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs\nadvanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request\nto the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set.\nConversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices.\n\nOnly one of defaultRouteAction or defaultUrlRedirect must be set."

fn spec.pathMatcher.defaultRouteAction.withWeightedBackendServices

withWeightedBackendServices(weightedBackendServices)

"A list of weighted backend services to send traffic to when a route match occurs.\nThe weights determine the fraction of traffic that flows to their corresponding backend service.\nIf all traffic needs to go to a single backend service, there must be one weightedBackendService\nwith weight set to a non 0 number.\n\nOnce a backendService is identified and before forwarding the request to the backend service,\nadvanced routing actions like Url rewrites and header transformations are applied depending on\nadditional settings specified in this HttpRouteAction."

fn spec.pathMatcher.defaultRouteAction.withWeightedBackendServicesMixin

withWeightedBackendServicesMixin(weightedBackendServices)

"A list of weighted backend services to send traffic to when a route match occurs.\nThe weights determine the fraction of traffic that flows to their corresponding backend service.\nIf all traffic needs to go to a single backend service, there must be one weightedBackendService\nwith weight set to a non 0 number.\n\nOnce a backendService is identified and before forwarding the request to the backend service,\nadvanced routing actions like Url rewrites and header transformations are applied depending on\nadditional settings specified in this HttpRouteAction."

Note: This function appends passed data to existing values

obj spec.pathMatcher.defaultRouteAction.corsPolicy

"The specification for allowing client side cross-origin requests. Please see\nW3C Recommendation for Cross Origin Resource Sharing."

fn spec.pathMatcher.defaultRouteAction.corsPolicy.withAllowCredentials

withAllowCredentials(allowCredentials)

"In response to a preflight request, setting this to true indicates that the actual request can include user credentials.\nThis translates to the Access-Control-Allow-Credentials header."

fn spec.pathMatcher.defaultRouteAction.corsPolicy.withAllowHeaders

withAllowHeaders(allowHeaders)

"Specifies the content for the Access-Control-Allow-Headers header."

fn spec.pathMatcher.defaultRouteAction.corsPolicy.withAllowHeadersMixin

withAllowHeadersMixin(allowHeaders)

"Specifies the content for the Access-Control-Allow-Headers header."

Note: This function appends passed data to existing values

fn spec.pathMatcher.defaultRouteAction.corsPolicy.withAllowMethods

withAllowMethods(allowMethods)

"Specifies the content for the Access-Control-Allow-Methods header."

fn spec.pathMatcher.defaultRouteAction.corsPolicy.withAllowMethodsMixin

withAllowMethodsMixin(allowMethods)

"Specifies the content for the Access-Control-Allow-Methods header."

Note: This function appends passed data to existing values

fn spec.pathMatcher.defaultRouteAction.corsPolicy.withAllowOriginRegexes

withAllowOriginRegexes(allowOriginRegexes)

"Specifies the regular expression patterns that match allowed origins. For regular expression grammar\nplease see en.cppreference.com/w/cpp/regex/ecmascript\nAn origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes."

fn spec.pathMatcher.defaultRouteAction.corsPolicy.withAllowOriginRegexesMixin

withAllowOriginRegexesMixin(allowOriginRegexes)

"Specifies the regular expression patterns that match allowed origins. For regular expression grammar\nplease see en.cppreference.com/w/cpp/regex/ecmascript\nAn origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes."

Note: This function appends passed data to existing values

fn spec.pathMatcher.defaultRouteAction.corsPolicy.withAllowOrigins

withAllowOrigins(allowOrigins)

"Specifies the list of origins that will be allowed to do CORS requests.\nAn origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes."

fn spec.pathMatcher.defaultRouteAction.corsPolicy.withAllowOriginsMixin

withAllowOriginsMixin(allowOrigins)

"Specifies the list of origins that will be allowed to do CORS requests.\nAn origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes."

Note: This function appends passed data to existing values

fn spec.pathMatcher.defaultRouteAction.corsPolicy.withDisabled

withDisabled(disabled)

"If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect."

fn spec.pathMatcher.defaultRouteAction.corsPolicy.withExposeHeaders

withExposeHeaders(exposeHeaders)

"Specifies the content for the Access-Control-Expose-Headers header."

fn spec.pathMatcher.defaultRouteAction.corsPolicy.withExposeHeadersMixin

withExposeHeadersMixin(exposeHeaders)

"Specifies the content for the Access-Control-Expose-Headers header."

Note: This function appends passed data to existing values

fn spec.pathMatcher.defaultRouteAction.corsPolicy.withMaxAge

withMaxAge(maxAge)

"Specifies how long results of a preflight request can be cached in seconds.\nThis translates to the Access-Control-Max-Age header."

obj spec.pathMatcher.defaultRouteAction.faultInjectionPolicy

"The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure.\nAs part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a\npercentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted\nby the Loadbalancer for a percentage of requests.\n\ntimeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy."

obj spec.pathMatcher.defaultRouteAction.faultInjectionPolicy.abort

"The specification for how client requests are aborted as part of fault injection."

fn spec.pathMatcher.defaultRouteAction.faultInjectionPolicy.abort.withHttpStatus

withHttpStatus(httpStatus)

"The HTTP status code used to abort the request.\nThe value must be between 200 and 599 inclusive."

fn spec.pathMatcher.defaultRouteAction.faultInjectionPolicy.abort.withPercentage

withPercentage(percentage)

"The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.\nThe value must be between 0.0 and 100.0 inclusive."

obj spec.pathMatcher.defaultRouteAction.faultInjectionPolicy.delay

"The specification for how client requests are delayed as part of fault injection, before being sent to a backend service."

fn spec.pathMatcher.defaultRouteAction.faultInjectionPolicy.delay.withPercentage

withPercentage(percentage)

"The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.\nThe value must be between 0.0 and 100.0 inclusive."

obj spec.pathMatcher.defaultRouteAction.faultInjectionPolicy.delay.fixedDelay

"Specifies the value of the fixed delay interval."

fn spec.pathMatcher.defaultRouteAction.faultInjectionPolicy.delay.fixedDelay.withNanos

withNanos(nanos)

"Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are\nrepresented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive."

fn spec.pathMatcher.defaultRouteAction.faultInjectionPolicy.delay.fixedDelay.withSeconds

withSeconds(seconds)

"Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.\nNote: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years."

obj spec.pathMatcher.defaultRouteAction.requestMirrorPolicy

"Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service.\nLoadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service,\nthe host / authority header is suffixed with -shadow."

obj spec.pathMatcher.defaultRouteAction.requestMirrorPolicy.backendServiceRef

"Required. The backend service resource being mirrored to."

fn spec.pathMatcher.defaultRouteAction.requestMirrorPolicy.backendServiceRef.withExternal

withExternal(external)

"Allowed value: The selfLink field of a ComputeBackendService resource."

fn spec.pathMatcher.defaultRouteAction.requestMirrorPolicy.backendServiceRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.pathMatcher.defaultRouteAction.requestMirrorPolicy.backendServiceRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.pathMatcher.defaultRouteAction.retryPolicy

"Specifies the retry policy associated with this route."

fn spec.pathMatcher.defaultRouteAction.retryPolicy.withNumRetries

withNumRetries(numRetries)

"Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1."

fn spec.pathMatcher.defaultRouteAction.retryPolicy.withRetryConditions

withRetryConditions(retryConditions)

"Specfies one or more conditions when this retry rule applies. Valid values are:\n\n 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code,\n or if the backend service does not respond at all, example: disconnects, reset, read timeout,\n connection failure, and refused streams.\n gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.\n connect-failure: Loadbalancer will retry on failures connecting to backend services,\n for example due to connection timeouts.\n retriable-4xx: Loadbalancer will retry for retriable 4xx response codes.\n Currently the only retriable error supported is 409.\n refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code.\n This reset type indicates that it is safe to retry.\n cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled\n deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded\n resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted\n unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable."

fn spec.pathMatcher.defaultRouteAction.retryPolicy.withRetryConditionsMixin

withRetryConditionsMixin(retryConditions)

"Specfies one or more conditions when this retry rule applies. Valid values are:\n\n 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code,\n or if the backend service does not respond at all, example: disconnects, reset, read timeout,\n connection failure, and refused streams.\n gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.\n connect-failure: Loadbalancer will retry on failures connecting to backend services,\n for example due to connection timeouts.\n retriable-4xx: Loadbalancer will retry for retriable 4xx response codes.\n Currently the only retriable error supported is 409.\n refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code.\n This reset type indicates that it is safe to retry.\n cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled\n deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded\n resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted\n unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable."

Note: This function appends passed data to existing values

obj spec.pathMatcher.defaultRouteAction.retryPolicy.perTryTimeout

"Specifies a non-zero timeout per retry attempt.\n\nIf not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set,\nwill use the largest timeout among all backend services associated with the route."

fn spec.pathMatcher.defaultRouteAction.retryPolicy.perTryTimeout.withNanos

withNanos(nanos)

"Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are\nrepresented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive."

fn spec.pathMatcher.defaultRouteAction.retryPolicy.perTryTimeout.withSeconds

withSeconds(seconds)

"Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.\nNote: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years."

obj spec.pathMatcher.defaultRouteAction.timeout

"Specifies the timeout for the selected route. Timeout is computed from the time the request has been\nfully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries.\n\nIf not specified, will use the largest timeout among all backend services associated with the route."

fn spec.pathMatcher.defaultRouteAction.timeout.withNanos

withNanos(nanos)

"Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented\nwith a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive."

fn spec.pathMatcher.defaultRouteAction.timeout.withSeconds

withSeconds(seconds)

"Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.\nNote: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years."

obj spec.pathMatcher.defaultRouteAction.urlRewrite

"The spec to modify the URL of the request, prior to forwarding the request to the matched service."

fn spec.pathMatcher.defaultRouteAction.urlRewrite.withHostRewrite

withHostRewrite(hostRewrite)

"Prior to forwarding the request to the selected service, the request's host header is replaced\nwith contents of hostRewrite.\n\nThe value must be between 1 and 255 characters."

fn spec.pathMatcher.defaultRouteAction.urlRewrite.withPathPrefixRewrite

withPathPrefixRewrite(pathPrefixRewrite)

"Prior to forwarding the request to the selected backend service, the matching portion of the\nrequest's path is replaced by pathPrefixRewrite.\n\nThe value must be between 1 and 1024 characters."

obj spec.pathMatcher.defaultRouteAction.weightedBackendServices

"A list of weighted backend services to send traffic to when a route match occurs.\nThe weights determine the fraction of traffic that flows to their corresponding backend service.\nIf all traffic needs to go to a single backend service, there must be one weightedBackendService\nwith weight set to a non 0 number.\n\nOnce a backendService is identified and before forwarding the request to the backend service,\nadvanced routing actions like Url rewrites and header transformations are applied depending on\nadditional settings specified in this HttpRouteAction."

fn spec.pathMatcher.defaultRouteAction.weightedBackendServices.withWeight

withWeight(weight)

"Specifies the fraction of traffic sent to backendService, computed as\nweight / (sum of all weightedBackendService weights in routeAction) .\n\nThe selection of a backend service is determined only for new traffic. Once a user's request\nhas been directed to a backendService, subsequent requests will be sent to the same backendService\nas determined by the BackendService's session affinity policy.\n\nThe value must be between 0 and 1000."

obj spec.pathMatcher.defaultRouteAction.weightedBackendServices.backendServiceRef

"The default backend service resource.\nBefore forwarding the request to backendService, the loadbalancer\napplies any relevant headerActions specified as part of this\nbackendServiceWeight."

fn spec.pathMatcher.defaultRouteAction.weightedBackendServices.backendServiceRef.withExternal

withExternal(external)

"Allowed value: The selfLink field of a ComputeBackendService resource."

fn spec.pathMatcher.defaultRouteAction.weightedBackendServices.backendServiceRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.pathMatcher.defaultRouteAction.weightedBackendServices.backendServiceRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.pathMatcher.defaultRouteAction.weightedBackendServices.headerAction

"Specifies changes to request and response headers that need to take effect for\nthe selected backendService.\n\nheaderAction specified here take effect before headerAction in the enclosing\nHttpRouteRule, PathMatcher and UrlMap."

fn spec.pathMatcher.defaultRouteAction.weightedBackendServices.headerAction.withRequestHeadersToAdd

withRequestHeadersToAdd(requestHeadersToAdd)

"Headers to add to a matching request prior to forwarding the request to the backendService."

fn spec.pathMatcher.defaultRouteAction.weightedBackendServices.headerAction.withRequestHeadersToAddMixin

withRequestHeadersToAddMixin(requestHeadersToAdd)

"Headers to add to a matching request prior to forwarding the request to the backendService."

Note: This function appends passed data to existing values

fn spec.pathMatcher.defaultRouteAction.weightedBackendServices.headerAction.withRequestHeadersToRemove

withRequestHeadersToRemove(requestHeadersToRemove)

"A list of header names for headers that need to be removed from the request prior to\nforwarding the request to the backendService."

fn spec.pathMatcher.defaultRouteAction.weightedBackendServices.headerAction.withRequestHeadersToRemoveMixin

withRequestHeadersToRemoveMixin(requestHeadersToRemove)

"A list of header names for headers that need to be removed from the request prior to\nforwarding the request to the backendService."

Note: This function appends passed data to existing values

fn spec.pathMatcher.defaultRouteAction.weightedBackendServices.headerAction.withResponseHeadersToAdd

withResponseHeadersToAdd(responseHeadersToAdd)

"Headers to add the response prior to sending the response back to the client."

fn spec.pathMatcher.defaultRouteAction.weightedBackendServices.headerAction.withResponseHeadersToAddMixin

withResponseHeadersToAddMixin(responseHeadersToAdd)

"Headers to add the response prior to sending the response back to the client."

Note: This function appends passed data to existing values

fn spec.pathMatcher.defaultRouteAction.weightedBackendServices.headerAction.withResponseHeadersToRemove

withResponseHeadersToRemove(responseHeadersToRemove)

"A list of header names for headers that need to be removed from the response prior to sending the\nresponse back to the client."

fn spec.pathMatcher.defaultRouteAction.weightedBackendServices.headerAction.withResponseHeadersToRemoveMixin

withResponseHeadersToRemoveMixin(responseHeadersToRemove)

"A list of header names for headers that need to be removed from the response prior to sending the\nresponse back to the client."

Note: This function appends passed data to existing values

obj spec.pathMatcher.defaultRouteAction.weightedBackendServices.headerAction.requestHeadersToAdd

"Headers to add to a matching request prior to forwarding the request to the backendService."

fn spec.pathMatcher.defaultRouteAction.weightedBackendServices.headerAction.requestHeadersToAdd.withHeaderName

withHeaderName(headerName)

"The name of the header to add."

fn spec.pathMatcher.defaultRouteAction.weightedBackendServices.headerAction.requestHeadersToAdd.withHeaderValue

withHeaderValue(headerValue)

"The value of the header to add."

fn spec.pathMatcher.defaultRouteAction.weightedBackendServices.headerAction.requestHeadersToAdd.withReplace

withReplace(replace)

"If false, headerValue is appended to any values that already exist for the header.\nIf true, headerValue is set for the header, discarding any values that were set for that header."

obj spec.pathMatcher.defaultRouteAction.weightedBackendServices.headerAction.responseHeadersToAdd

"Headers to add the response prior to sending the response back to the client."

fn spec.pathMatcher.defaultRouteAction.weightedBackendServices.headerAction.responseHeadersToAdd.withHeaderName

withHeaderName(headerName)

"The name of the header to add."

fn spec.pathMatcher.defaultRouteAction.weightedBackendServices.headerAction.responseHeadersToAdd.withHeaderValue

withHeaderValue(headerValue)

"The value of the header to add."

fn spec.pathMatcher.defaultRouteAction.weightedBackendServices.headerAction.responseHeadersToAdd.withReplace

withReplace(replace)

"If false, headerValue is appended to any values that already exist for the header.\nIf true, headerValue is set for the header, discarding any values that were set for that header."

obj spec.pathMatcher.defaultService

"The default service to use if none of the pathRules defined by this\nPathMatcher is matched by the URL's path portion.\nFor the Global URL Map, it should be a reference to the backend\nservice or backend bucket.\nFor the Regional URL Map, it should be a reference to the backend\nservice."

obj spec.pathMatcher.defaultService.backendBucketRef

fn spec.pathMatcher.defaultService.backendBucketRef.withExternal

withExternal(external)

"Allowed value: The selfLink field of a ComputeBackendBucket resource."

fn spec.pathMatcher.defaultService.backendBucketRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.pathMatcher.defaultService.backendBucketRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.pathMatcher.defaultService.backendServiceRef

fn spec.pathMatcher.defaultService.backendServiceRef.withExternal

withExternal(external)

"Allowed value: The selfLink field of a ComputeBackendService resource."

fn spec.pathMatcher.defaultService.backendServiceRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.pathMatcher.defaultService.backendServiceRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.pathMatcher.defaultUrlRedirect

"When none of the specified hostRules match, the request is redirected to a URL specified\nby defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or\ndefaultRouteAction must not be set."

fn spec.pathMatcher.defaultUrlRedirect.withHostRedirect

withHostRedirect(hostRedirect)

"The host that will be used in the redirect response instead of the one that was\nsupplied in the request. The value must be between 1 and 255 characters."

fn spec.pathMatcher.defaultUrlRedirect.withHttpsRedirect

withHttpsRedirect(httpsRedirect)

"If set to true, the URL scheme in the redirected request is set to https. If set to\nfalse, the URL scheme of the redirected request will remain the same as that of the\nrequest. This must only be set for UrlMaps used in TargetHttpProxys. Setting this\ntrue for TargetHttpsProxy is not permitted. The default is set to false."

fn spec.pathMatcher.defaultUrlRedirect.withPathRedirect

withPathRedirect(pathRedirect)

"The path that will be used in the redirect response instead of the one that was\nsupplied in the request. pathRedirect cannot be supplied together with\nprefixRedirect. Supply one alone or neither. If neither is supplied, the path of the\noriginal request will be used for the redirect. The value must be between 1 and 1024\ncharacters."

fn spec.pathMatcher.defaultUrlRedirect.withPrefixRedirect

withPrefixRedirect(prefixRedirect)

"The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch,\nretaining the remaining portion of the URL before redirecting the request.\nprefixRedirect cannot be supplied together with pathRedirect. Supply one alone or\nneither. If neither is supplied, the path of the original request will be used for\nthe redirect. The value must be between 1 and 1024 characters."

fn spec.pathMatcher.defaultUrlRedirect.withRedirectResponseCode

withRedirectResponseCode(redirectResponseCode)

"The HTTP Status code to use for this RedirectAction. Supported values are:\n\n MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.\n\n FOUND, which corresponds to 302.\n\n SEE_OTHER which corresponds to 303.\n\n TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method\nwill be retained.\n\n* PERMANENT_REDIRECT, which corresponds to 308. In this case,\nthe request method will be retained. Possible values: [\"FOUND\", \"MOVED_PERMANENTLY_DEFAULT\", \"PERMANENT_REDIRECT\", \"SEE_OTHER\", \"TEMPORARY_REDIRECT\"]."

fn spec.pathMatcher.defaultUrlRedirect.withStripQuery

withStripQuery(stripQuery)

"If set to true, any accompanying query portion of the original URL is removed prior\nto redirecting the request. If set to false, the query portion of the original URL is\nretained.\n This field is required to ensure an empty block is not set. The normal default value is false."

obj spec.pathMatcher.headerAction

"Specifies changes to request and response headers that need to take effect for\nthe selected backendService. HeaderAction specified here are applied after the\nmatching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap."

fn spec.pathMatcher.headerAction.withRequestHeadersToAdd

withRequestHeadersToAdd(requestHeadersToAdd)

"Headers to add to a matching request prior to forwarding the request to the\nbackendService."

fn spec.pathMatcher.headerAction.withRequestHeadersToAddMixin

withRequestHeadersToAddMixin(requestHeadersToAdd)

"Headers to add to a matching request prior to forwarding the request to the\nbackendService."

Note: This function appends passed data to existing values

fn spec.pathMatcher.headerAction.withRequestHeadersToRemove

withRequestHeadersToRemove(requestHeadersToRemove)

"A list of header names for headers that need to be removed from the request\nprior to forwarding the request to the backendService."

fn spec.pathMatcher.headerAction.withRequestHeadersToRemoveMixin

withRequestHeadersToRemoveMixin(requestHeadersToRemove)

"A list of header names for headers that need to be removed from the request\nprior to forwarding the request to the backendService."

Note: This function appends passed data to existing values

fn spec.pathMatcher.headerAction.withResponseHeadersToAdd

withResponseHeadersToAdd(responseHeadersToAdd)

"Headers to add the response prior to sending the response back to the client."

fn spec.pathMatcher.headerAction.withResponseHeadersToAddMixin

withResponseHeadersToAddMixin(responseHeadersToAdd)

"Headers to add the response prior to sending the response back to the client."

Note: This function appends passed data to existing values

fn spec.pathMatcher.headerAction.withResponseHeadersToRemove

withResponseHeadersToRemove(responseHeadersToRemove)

"A list of header names for headers that need to be removed from the response\nprior to sending the response back to the client."

fn spec.pathMatcher.headerAction.withResponseHeadersToRemoveMixin

withResponseHeadersToRemoveMixin(responseHeadersToRemove)

"A list of header names for headers that need to be removed from the response\nprior to sending the response back to the client."

Note: This function appends passed data to existing values

obj spec.pathMatcher.headerAction.requestHeadersToAdd

"Headers to add to a matching request prior to forwarding the request to the\nbackendService."

fn spec.pathMatcher.headerAction.requestHeadersToAdd.withHeaderName

withHeaderName(headerName)

"The name of the header."

fn spec.pathMatcher.headerAction.requestHeadersToAdd.withHeaderValue

withHeaderValue(headerValue)

"The value of the header to add."

fn spec.pathMatcher.headerAction.requestHeadersToAdd.withReplace

withReplace(replace)

"If false, headerValue is appended to any values that already exist for the\nheader. If true, headerValue is set for the header, discarding any values that\nwere set for that header."

obj spec.pathMatcher.headerAction.responseHeadersToAdd

"Headers to add the response prior to sending the response back to the client."

fn spec.pathMatcher.headerAction.responseHeadersToAdd.withHeaderName

withHeaderName(headerName)

"The name of the header."

fn spec.pathMatcher.headerAction.responseHeadersToAdd.withHeaderValue

withHeaderValue(headerValue)

"The value of the header to add."

fn spec.pathMatcher.headerAction.responseHeadersToAdd.withReplace

withReplace(replace)

"If false, headerValue is appended to any values that already exist for the\nheader. If true, headerValue is set for the header, discarding any values that\nwere set for that header."

obj spec.pathMatcher.pathRule

"The list of path rules. Use this list instead of routeRules when routing based\non simple path matching is all that's required. The order by which path rules\nare specified does not matter. Matches are always done on the longest-path-first\nbasis. For example: a pathRule with a path /a/b/c/ will match before /a/b/\nirrespective of the order in which those paths appear in this list. Within a\ngiven pathMatcher, only one of pathRules or routeRules must be set."

fn spec.pathMatcher.pathRule.withPaths

withPaths(paths)

"The list of path patterns to match. Each must start with / and the only place a\n\* is allowed is at the end following a /. The string fed to the path matcher\ndoes not include any text after the first ? or #, and those chars are not\nallowed here."

fn spec.pathMatcher.pathRule.withPathsMixin

withPathsMixin(paths)

"The list of path patterns to match. Each must start with / and the only place a\n\* is allowed is at the end following a /. The string fed to the path matcher\ndoes not include any text after the first ? or #, and those chars are not\nallowed here."

Note: This function appends passed data to existing values

obj spec.pathMatcher.pathRule.routeAction

"In response to a matching path, the load balancer performs advanced routing\nactions like URL rewrites, header transformations, etc. prior to forwarding the\nrequest to the selected backend. If routeAction specifies any\nweightedBackendServices, service must not be set. Conversely if service is set,\nrouteAction cannot contain any weightedBackendServices. Only one of routeAction\nor urlRedirect must be set."

fn spec.pathMatcher.pathRule.routeAction.withWeightedBackendServices

withWeightedBackendServices(weightedBackendServices)

"A list of weighted backend services to send traffic to when a route match\noccurs. The weights determine the fraction of traffic that flows to their\ncorresponding backend service. If all traffic needs to go to a single backend\nservice, there must be one weightedBackendService with weight set to a non 0\nnumber. Once a backendService is identified and before forwarding the request to\nthe backend service, advanced routing actions like Url rewrites and header\ntransformations are applied depending on additional settings specified in this\nHttpRouteAction."

fn spec.pathMatcher.pathRule.routeAction.withWeightedBackendServicesMixin

withWeightedBackendServicesMixin(weightedBackendServices)

"A list of weighted backend services to send traffic to when a route match\noccurs. The weights determine the fraction of traffic that flows to their\ncorresponding backend service. If all traffic needs to go to a single backend\nservice, there must be one weightedBackendService with weight set to a non 0\nnumber. Once a backendService is identified and before forwarding the request to\nthe backend service, advanced routing actions like Url rewrites and header\ntransformations are applied depending on additional settings specified in this\nHttpRouteAction."

Note: This function appends passed data to existing values

obj spec.pathMatcher.pathRule.routeAction.corsPolicy

"The specification for allowing client side cross-origin requests. Please see W3C\nRecommendation for Cross Origin Resource Sharing."

fn spec.pathMatcher.pathRule.routeAction.corsPolicy.withAllowCredentials

withAllowCredentials(allowCredentials)

"In response to a preflight request, setting this to true indicates that the\nactual request can include user credentials. This translates to the Access-\nControl-Allow-Credentials header. Defaults to false."

fn spec.pathMatcher.pathRule.routeAction.corsPolicy.withAllowHeaders

withAllowHeaders(allowHeaders)

"Specifies the content for the Access-Control-Allow-Headers header."

fn spec.pathMatcher.pathRule.routeAction.corsPolicy.withAllowHeadersMixin

withAllowHeadersMixin(allowHeaders)

"Specifies the content for the Access-Control-Allow-Headers header."

Note: This function appends passed data to existing values

fn spec.pathMatcher.pathRule.routeAction.corsPolicy.withAllowMethods

withAllowMethods(allowMethods)

"Specifies the content for the Access-Control-Allow-Methods header."

fn spec.pathMatcher.pathRule.routeAction.corsPolicy.withAllowMethodsMixin

withAllowMethodsMixin(allowMethods)

"Specifies the content for the Access-Control-Allow-Methods header."

Note: This function appends passed data to existing values

fn spec.pathMatcher.pathRule.routeAction.corsPolicy.withAllowOriginRegexes

withAllowOriginRegexes(allowOriginRegexes)

"Specifies the regular expression patterns that match allowed origins. For\nregular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript\nAn origin is allowed if it matches either allow_origins or allow_origin_regex."

fn spec.pathMatcher.pathRule.routeAction.corsPolicy.withAllowOriginRegexesMixin

withAllowOriginRegexesMixin(allowOriginRegexes)

"Specifies the regular expression patterns that match allowed origins. For\nregular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript\nAn origin is allowed if it matches either allow_origins or allow_origin_regex."

Note: This function appends passed data to existing values

fn spec.pathMatcher.pathRule.routeAction.corsPolicy.withAllowOrigins

withAllowOrigins(allowOrigins)

"Specifies the list of origins that will be allowed to do CORS requests. An\norigin is allowed if it matches either allow_origins or allow_origin_regex."

fn spec.pathMatcher.pathRule.routeAction.corsPolicy.withAllowOriginsMixin

withAllowOriginsMixin(allowOrigins)

"Specifies the list of origins that will be allowed to do CORS requests. An\norigin is allowed if it matches either allow_origins or allow_origin_regex."

Note: This function appends passed data to existing values

fn spec.pathMatcher.pathRule.routeAction.corsPolicy.withDisabled

withDisabled(disabled)

"If true, specifies the CORS policy is disabled."

fn spec.pathMatcher.pathRule.routeAction.corsPolicy.withExposeHeaders

withExposeHeaders(exposeHeaders)

"Specifies the content for the Access-Control-Expose-Headers header."

fn spec.pathMatcher.pathRule.routeAction.corsPolicy.withExposeHeadersMixin

withExposeHeadersMixin(exposeHeaders)

"Specifies the content for the Access-Control-Expose-Headers header."

Note: This function appends passed data to existing values

fn spec.pathMatcher.pathRule.routeAction.corsPolicy.withMaxAge

withMaxAge(maxAge)

"Specifies how long the results of a preflight request can be cached. This\ntranslates to the content for the Access-Control-Max-Age header."

obj spec.pathMatcher.pathRule.routeAction.faultInjectionPolicy

"The specification for fault injection introduced into traffic to test the\nresiliency of clients to backend service failure. As part of fault injection,\nwhen clients send requests to a backend service, delays can be introduced by\nLoadbalancer on a percentage of requests before sending those request to the\nbackend service. Similarly requests from clients can be aborted by the\nLoadbalancer for a percentage of requests. timeout and retry_policy will be\nignored by clients that are configured with a fault_injection_policy."

obj spec.pathMatcher.pathRule.routeAction.faultInjectionPolicy.abort

"The specification for how client requests are aborted as part of fault\ninjection."

fn spec.pathMatcher.pathRule.routeAction.faultInjectionPolicy.abort.withHttpStatus

withHttpStatus(httpStatus)

"The HTTP status code used to abort the request. The value must be between 200\nand 599 inclusive."

fn spec.pathMatcher.pathRule.routeAction.faultInjectionPolicy.abort.withPercentage

withPercentage(percentage)

"The percentage of traffic (connections/operations/requests) which will be\naborted as part of fault injection. The value must be between 0.0 and 100.0\ninclusive."

obj spec.pathMatcher.pathRule.routeAction.faultInjectionPolicy.delay

"The specification for how client requests are delayed as part of fault\ninjection, before being sent to a backend service."

fn spec.pathMatcher.pathRule.routeAction.faultInjectionPolicy.delay.withPercentage

withPercentage(percentage)

"The percentage of traffic (connections/operations/requests) on which delay will\nbe introduced as part of fault injection. The value must be between 0.0 and\n100.0 inclusive."

obj spec.pathMatcher.pathRule.routeAction.faultInjectionPolicy.delay.fixedDelay

"Specifies the value of the fixed delay interval."

fn spec.pathMatcher.pathRule.routeAction.faultInjectionPolicy.delay.fixedDelay.withNanos

withNanos(nanos)

"Span of time that's a fraction of a second at nanosecond resolution. Durations\nless than one second are represented with a 0 'seconds' field and a positive\n'nanos' field. Must be from 0 to 999,999,999 inclusive."

fn spec.pathMatcher.pathRule.routeAction.faultInjectionPolicy.delay.fixedDelay.withSeconds

withSeconds(seconds)

"Span of time at a resolution of a second. Must be from 0 to 315,576,000,000\ninclusive."

obj spec.pathMatcher.pathRule.routeAction.requestMirrorPolicy

"Specifies the policy on how requests intended for the route's backends are\nshadowed to a separate mirrored backend service. Loadbalancer does not wait for\nresponses from the shadow service. Prior to sending traffic to the shadow\nservice, the host / authority header is suffixed with -shadow."

obj spec.pathMatcher.pathRule.routeAction.requestMirrorPolicy.backendServiceRef

"Required. The backend service resource being mirrored to."

fn spec.pathMatcher.pathRule.routeAction.requestMirrorPolicy.backendServiceRef.withExternal

withExternal(external)

"Allowed value: The selfLink field of a ComputeBackendService resource."

fn spec.pathMatcher.pathRule.routeAction.requestMirrorPolicy.backendServiceRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.pathMatcher.pathRule.routeAction.requestMirrorPolicy.backendServiceRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.pathMatcher.pathRule.routeAction.retryPolicy

"Specifies the retry policy associated with this route."

fn spec.pathMatcher.pathRule.routeAction.retryPolicy.withNumRetries

withNumRetries(numRetries)

"Specifies the allowed number retries. This number must be > 0."

fn spec.pathMatcher.pathRule.routeAction.retryPolicy.withRetryConditions

withRetryConditions(retryConditions)

"Specifies one or more conditions when this retry rule applies. Valid values are:\n\n- 5xx: Loadbalancer will attempt a retry if the backend service responds with\nany 5xx response code, or if the backend service does not respond at all,\nexample: disconnects, reset, read timeout, connection failure, and refused\nstreams.\n- gateway-error: Similar to 5xx, but only applies to response codes\n502, 503 or 504.\n- connect-failure: Loadbalancer will retry on failures\nconnecting to backend services, for example due to connection timeouts.\n- retriable-4xx: Loadbalancer will retry for retriable 4xx response codes.\nCurrently the only retriable error supported is 409.\n- refused-stream: Loadbalancer will retry if the backend service resets the stream with a\nREFUSED_STREAM error code. This reset type indicates that it is safe to retry.\n- cancelled: Loadbalancer will retry if the gRPC status code in the response\nheader is set to cancelled\n- deadline-exceeded: Loadbalancer will retry if the\ngRPC status code in the response header is set to deadline-exceeded\n- resource-exhausted: Loadbalancer will retry if the gRPC status code in the response\nheader is set to resource-exhausted\n- unavailable: Loadbalancer will retry if\nthe gRPC status code in the response header is set to unavailable."

fn spec.pathMatcher.pathRule.routeAction.retryPolicy.withRetryConditionsMixin

withRetryConditionsMixin(retryConditions)

"Specifies one or more conditions when this retry rule applies. Valid values are:\n\n- 5xx: Loadbalancer will attempt a retry if the backend service responds with\nany 5xx response code, or if the backend service does not respond at all,\nexample: disconnects, reset, read timeout, connection failure, and refused\nstreams.\n- gateway-error: Similar to 5xx, but only applies to response codes\n502, 503 or 504.\n- connect-failure: Loadbalancer will retry on failures\nconnecting to backend services, for example due to connection timeouts.\n- retriable-4xx: Loadbalancer will retry for retriable 4xx response codes.\nCurrently the only retriable error supported is 409.\n- refused-stream: Loadbalancer will retry if the backend service resets the stream with a\nREFUSED_STREAM error code. This reset type indicates that it is safe to retry.\n- cancelled: Loadbalancer will retry if the gRPC status code in the response\nheader is set to cancelled\n- deadline-exceeded: Loadbalancer will retry if the\ngRPC status code in the response header is set to deadline-exceeded\n- resource-exhausted: Loadbalancer will retry if the gRPC status code in the response\nheader is set to resource-exhausted\n- unavailable: Loadbalancer will retry if\nthe gRPC status code in the response header is set to unavailable."

Note: This function appends passed data to existing values

obj spec.pathMatcher.pathRule.routeAction.retryPolicy.perTryTimeout

"Specifies a non-zero timeout per retry attempt."

fn spec.pathMatcher.pathRule.routeAction.retryPolicy.perTryTimeout.withNanos

withNanos(nanos)

"Span of time that's a fraction of a second at nanosecond resolution. Durations\nless than one second are represented with a 0 'seconds' field and a positive\n'nanos' field. Must be from 0 to 999,999,999 inclusive."

fn spec.pathMatcher.pathRule.routeAction.retryPolicy.perTryTimeout.withSeconds

withSeconds(seconds)

"Span of time at a resolution of a second. Must be from 0 to 315,576,000,000\ninclusive."

obj spec.pathMatcher.pathRule.routeAction.timeout

"Specifies the timeout for the selected route. Timeout is computed from the time\nthe request is has been fully processed (i.e. end-of-stream) up until the\nresponse has been completely processed. Timeout includes all retries. If not\nspecified, the default value is 15 seconds."

fn spec.pathMatcher.pathRule.routeAction.timeout.withNanos

withNanos(nanos)

"Span of time that's a fraction of a second at nanosecond resolution. Durations\nless than one second are represented with a 0 'seconds' field and a positive\n'nanos' field. Must be from 0 to 999,999,999 inclusive."

fn spec.pathMatcher.pathRule.routeAction.timeout.withSeconds

withSeconds(seconds)

"Span of time at a resolution of a second. Must be from 0 to 315,576,000,000\ninclusive."

obj spec.pathMatcher.pathRule.routeAction.urlRewrite

"The spec to modify the URL of the request, prior to forwarding the request to\nthe matched service."

fn spec.pathMatcher.pathRule.routeAction.urlRewrite.withHostRewrite

withHostRewrite(hostRewrite)

"Prior to forwarding the request to the selected service, the request's host\nheader is replaced with contents of hostRewrite. The value must be between 1 and\n255 characters."

fn spec.pathMatcher.pathRule.routeAction.urlRewrite.withPathPrefixRewrite

withPathPrefixRewrite(pathPrefixRewrite)

"Prior to forwarding the request to the selected backend service, the matching\nportion of the request's path is replaced by pathPrefixRewrite. The value must\nbe between 1 and 1024 characters."

obj spec.pathMatcher.pathRule.routeAction.weightedBackendServices

"A list of weighted backend services to send traffic to when a route match\noccurs. The weights determine the fraction of traffic that flows to their\ncorresponding backend service. If all traffic needs to go to a single backend\nservice, there must be one weightedBackendService with weight set to a non 0\nnumber. Once a backendService is identified and before forwarding the request to\nthe backend service, advanced routing actions like Url rewrites and header\ntransformations are applied depending on additional settings specified in this\nHttpRouteAction."

fn spec.pathMatcher.pathRule.routeAction.weightedBackendServices.withWeight

withWeight(weight)

"Specifies the fraction of traffic sent to backendService, computed as weight /\n(sum of all weightedBackendService weights in routeAction) . The selection of a\nbackend service is determined only for new traffic. Once a user's request has\nbeen directed to a backendService, subsequent requests will be sent to the same\nbackendService as determined by the BackendService's session affinity policy.\nThe value must be between 0 and 1000."

obj spec.pathMatcher.pathRule.routeAction.weightedBackendServices.backendServiceRef

"Required. The default backend service resource. Before forwarding\nthe request to backendService, the loadbalancer applies any relevant\nheaderActions specified as part of this backendServiceWeight."

fn spec.pathMatcher.pathRule.routeAction.weightedBackendServices.backendServiceRef.withExternal

withExternal(external)

"Allowed value: The selfLink field of a ComputeBackendService resource."

fn spec.pathMatcher.pathRule.routeAction.weightedBackendServices.backendServiceRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.pathMatcher.pathRule.routeAction.weightedBackendServices.backendServiceRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction

"Specifies changes to request and response headers that need to take effect for\nthe selected backendService. headerAction specified here take effect before\nheaderAction in the enclosing HttpRouteRule, PathMatcher and UrlMap."

fn spec.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.withRequestHeadersToAdd

withRequestHeadersToAdd(requestHeadersToAdd)

"Headers to add to a matching request prior to forwarding the request to the\nbackendService."

fn spec.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.withRequestHeadersToAddMixin

withRequestHeadersToAddMixin(requestHeadersToAdd)

"Headers to add to a matching request prior to forwarding the request to the\nbackendService."

Note: This function appends passed data to existing values

fn spec.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.withRequestHeadersToRemove

withRequestHeadersToRemove(requestHeadersToRemove)

"A list of header names for headers that need to be removed from the request\nprior to forwarding the request to the backendService."

fn spec.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.withRequestHeadersToRemoveMixin

withRequestHeadersToRemoveMixin(requestHeadersToRemove)

"A list of header names for headers that need to be removed from the request\nprior to forwarding the request to the backendService."

Note: This function appends passed data to existing values

fn spec.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.withResponseHeadersToAdd

withResponseHeadersToAdd(responseHeadersToAdd)

"Headers to add the response prior to sending the response back to the client."

fn spec.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.withResponseHeadersToAddMixin

withResponseHeadersToAddMixin(responseHeadersToAdd)

"Headers to add the response prior to sending the response back to the client."

Note: This function appends passed data to existing values

fn spec.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.withResponseHeadersToRemove

withResponseHeadersToRemove(responseHeadersToRemove)

"A list of header names for headers that need to be removed from the response\nprior to sending the response back to the client."

fn spec.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.withResponseHeadersToRemoveMixin

withResponseHeadersToRemoveMixin(responseHeadersToRemove)

"A list of header names for headers that need to be removed from the response\nprior to sending the response back to the client."

Note: This function appends passed data to existing values

obj spec.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.requestHeadersToAdd

"Headers to add to a matching request prior to forwarding the request to the\nbackendService."

fn spec.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.requestHeadersToAdd.withHeaderName

withHeaderName(headerName)

"The name of the header."

fn spec.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.requestHeadersToAdd.withHeaderValue

withHeaderValue(headerValue)

"The value of the header to add."

fn spec.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.requestHeadersToAdd.withReplace

withReplace(replace)

"If false, headerValue is appended to any values that already exist for the\nheader. If true, headerValue is set for the header, discarding any values that\nwere set for that header."

obj spec.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.responseHeadersToAdd

"Headers to add the response prior to sending the response back to the client."

fn spec.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.responseHeadersToAdd.withHeaderName

withHeaderName(headerName)

"The name of the header."

fn spec.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.responseHeadersToAdd.withHeaderValue

withHeaderValue(headerValue)

"The value of the header to add."

fn spec.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.responseHeadersToAdd.withReplace

withReplace(replace)

"If false, headerValue is appended to any values that already exist for the\nheader. If true, headerValue is set for the header, discarding any values that\nwere set for that header."

obj spec.pathMatcher.pathRule.service

"The backend service to which traffic is directed if this rule is\nmatched.\nFor the Global URL Map, it should be a reference to the backend\nservice or backend bucket.\nFor the Regional URL Map, it should be a reference to the backend\nservice.\nIf routeAction is additionally specified, advanced routing actions\nlike URL Rewrites, etc. take effect prior to sending the request to\nthe backend. However, if service is specified, routeAction cannot\ncontain any weightedBackendServices. Conversely, if routeAction\nspecifies any weightedBackendServices, service must not be\nspecified. Only one of urlRedirect, service or\nrouteAction.weightedBackendService must be set."

obj spec.pathMatcher.pathRule.service.backendBucketRef

fn spec.pathMatcher.pathRule.service.backendBucketRef.withExternal

withExternal(external)

"Allowed value: The selfLink field of a ComputeBackendBucket resource."

fn spec.pathMatcher.pathRule.service.backendBucketRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.pathMatcher.pathRule.service.backendBucketRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.pathMatcher.pathRule.service.backendServiceRef

fn spec.pathMatcher.pathRule.service.backendServiceRef.withExternal

withExternal(external)

"Allowed value: The selfLink field of a ComputeBackendService resource."

fn spec.pathMatcher.pathRule.service.backendServiceRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.pathMatcher.pathRule.service.backendServiceRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.pathMatcher.pathRule.urlRedirect

"When a path pattern is matched, the request is redirected to a URL specified\nby urlRedirect. If urlRedirect is specified, service or routeAction must not\nbe set."

fn spec.pathMatcher.pathRule.urlRedirect.withHostRedirect

withHostRedirect(hostRedirect)

"The host that will be used in the redirect response instead of the one\nthat was supplied in the request. The value must be between 1 and 255\ncharacters."

fn spec.pathMatcher.pathRule.urlRedirect.withHttpsRedirect

withHttpsRedirect(httpsRedirect)

"If set to true, the URL scheme in the redirected request is set to https.\nIf set to false, the URL scheme of the redirected request will remain the\nsame as that of the request. This must only be set for UrlMaps used in\nTargetHttpProxys. Setting this true for TargetHttpsProxy is not\npermitted. The default is set to false."

fn spec.pathMatcher.pathRule.urlRedirect.withPathRedirect

withPathRedirect(pathRedirect)

"The path that will be used in the redirect response instead of the one\nthat was supplied in the request. pathRedirect cannot be supplied\ntogether with prefixRedirect. Supply one alone or neither. If neither is\nsupplied, the path of the original request will be used for the redirect.\nThe value must be between 1 and 1024 characters."

fn spec.pathMatcher.pathRule.urlRedirect.withPrefixRedirect

withPrefixRedirect(prefixRedirect)

"The prefix that replaces the prefixMatch specified in the\nHttpRouteRuleMatch, retaining the remaining portion of the URL before\nredirecting the request. prefixRedirect cannot be supplied together with\npathRedirect. Supply one alone or neither. If neither is supplied, the\npath of the original request will be used for the redirect. The value\nmust be between 1 and 1024 characters."

fn spec.pathMatcher.pathRule.urlRedirect.withRedirectResponseCode

withRedirectResponseCode(redirectResponseCode)

"The HTTP Status code to use for this RedirectAction. Supported values are:\n\n MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.\n\n FOUND, which corresponds to 302.\n\n SEE_OTHER which corresponds to 303.\n\n TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method\nwill be retained.\n\n* PERMANENT_REDIRECT, which corresponds to 308. In this case,\nthe request method will be retained. Possible values: [\"FOUND\", \"MOVED_PERMANENTLY_DEFAULT\", \"PERMANENT_REDIRECT\", \"SEE_OTHER\", \"TEMPORARY_REDIRECT\"]."

fn spec.pathMatcher.pathRule.urlRedirect.withStripQuery

withStripQuery(stripQuery)

"If set to true, any accompanying query portion of the original URL is removed\nprior to redirecting the request. If set to false, the query portion of the\noriginal URL is retained.\n This field is required to ensure an empty block is not set. The normal default value is false."

obj spec.pathMatcher.routeRules

"The list of ordered HTTP route rules. Use this list instead of pathRules when\nadvanced route matching and routing actions are desired. The order of specifying\nrouteRules matters: the first rule that matches will cause its specified routing\naction to take effect. Within a given pathMatcher, only one of pathRules or\nrouteRules must be set. routeRules are not supported in UrlMaps intended for\nExternal load balancers."

fn spec.pathMatcher.routeRules.withMatchRules

withMatchRules(matchRules)

"The rules for determining a match."

fn spec.pathMatcher.routeRules.withMatchRulesMixin

withMatchRulesMixin(matchRules)

"The rules for determining a match."

Note: This function appends passed data to existing values

fn spec.pathMatcher.routeRules.withPriority

withPriority(priority)

"For routeRules within a given pathMatcher, priority determines the order\nin which load balancer will interpret routeRules. RouteRules are evaluated\nin order of priority, from the lowest to highest number. The priority of\na rule decreases as its number increases (1, 2, 3, N+1). The first rule\nthat matches the request is applied.\n\nYou cannot configure two or more routeRules with the same priority.\nPriority for each rule must be set to a number between 0 and\n2147483647 inclusive.\n\nPriority numbers can have gaps, which enable you to add or remove rules\nin the future without affecting the rest of the rules. For example,\n1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which\nyou could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the\nfuture without any impact on existing rules."

fn spec.pathMatcher.routeRules.withService

withService(service)

"The region backend service resource to which traffic is\ndirected if this rule is matched. If routeAction is additionally specified,\nadvanced routing actions like URL Rewrites, etc. take effect prior to sending\nthe request to the backend. However, if service is specified, routeAction cannot\ncontain any weightedBackendService s. Conversely, if routeAction specifies any\nweightedBackendServices, service must not be specified. Only one of urlRedirect,\nservice or routeAction.weightedBackendService must be set."

obj spec.pathMatcher.routeRules.headerAction

"Specifies changes to request and response headers that need to take effect for\nthe selected backendService. The headerAction specified here are applied before\nthe matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].r\nouteAction.weightedBackendService.backendServiceWeightAction[].headerAction."

fn spec.pathMatcher.routeRules.headerAction.withRequestHeadersToAdd

withRequestHeadersToAdd(requestHeadersToAdd)

"Headers to add to a matching request prior to forwarding the request to the\nbackendService."

fn spec.pathMatcher.routeRules.headerAction.withRequestHeadersToAddMixin

withRequestHeadersToAddMixin(requestHeadersToAdd)

"Headers to add to a matching request prior to forwarding the request to the\nbackendService."

Note: This function appends passed data to existing values

fn spec.pathMatcher.routeRules.headerAction.withRequestHeadersToRemove

withRequestHeadersToRemove(requestHeadersToRemove)

"A list of header names for headers that need to be removed from the request\nprior to forwarding the request to the backendService."

fn spec.pathMatcher.routeRules.headerAction.withRequestHeadersToRemoveMixin

withRequestHeadersToRemoveMixin(requestHeadersToRemove)

"A list of header names for headers that need to be removed from the request\nprior to forwarding the request to the backendService."

Note: This function appends passed data to existing values

fn spec.pathMatcher.routeRules.headerAction.withResponseHeadersToAdd

withResponseHeadersToAdd(responseHeadersToAdd)

"Headers to add the response prior to sending the response back to the client."

fn spec.pathMatcher.routeRules.headerAction.withResponseHeadersToAddMixin

withResponseHeadersToAddMixin(responseHeadersToAdd)

"Headers to add the response prior to sending the response back to the client."

Note: This function appends passed data to existing values

fn spec.pathMatcher.routeRules.headerAction.withResponseHeadersToRemove

withResponseHeadersToRemove(responseHeadersToRemove)

"A list of header names for headers that need to be removed from the response\nprior to sending the response back to the client."

fn spec.pathMatcher.routeRules.headerAction.withResponseHeadersToRemoveMixin

withResponseHeadersToRemoveMixin(responseHeadersToRemove)

"A list of header names for headers that need to be removed from the response\nprior to sending the response back to the client."

Note: This function appends passed data to existing values

obj spec.pathMatcher.routeRules.headerAction.requestHeadersToAdd

"Headers to add to a matching request prior to forwarding the request to the\nbackendService."

fn spec.pathMatcher.routeRules.headerAction.requestHeadersToAdd.withHeaderName

withHeaderName(headerName)

"The name of the header."

fn spec.pathMatcher.routeRules.headerAction.requestHeadersToAdd.withHeaderValue

withHeaderValue(headerValue)

"The value of the header to add."

fn spec.pathMatcher.routeRules.headerAction.requestHeadersToAdd.withReplace

withReplace(replace)

"If false, headerValue is appended to any values that already exist for the\nheader. If true, headerValue is set for the header, discarding any values that\nwere set for that header."

obj spec.pathMatcher.routeRules.headerAction.responseHeadersToAdd

"Headers to add the response prior to sending the response back to the client."

fn spec.pathMatcher.routeRules.headerAction.responseHeadersToAdd.withHeaderName

withHeaderName(headerName)

"The name of the header."

fn spec.pathMatcher.routeRules.headerAction.responseHeadersToAdd.withHeaderValue

withHeaderValue(headerValue)

"The value of the header to add."

fn spec.pathMatcher.routeRules.headerAction.responseHeadersToAdd.withReplace

withReplace(replace)

"If false, headerValue is appended to any values that already exist for the\nheader. If true, headerValue is set for the header, discarding any values that\nwere set for that header."

obj spec.pathMatcher.routeRules.matchRules

"The rules for determining a match."

fn spec.pathMatcher.routeRules.matchRules.withFullPathMatch

withFullPathMatch(fullPathMatch)

"For satisfying the matchRule condition, the path of the request must exactly\nmatch the value specified in fullPathMatch after removing any query parameters\nand anchor that may be part of the original URL. FullPathMatch must be between 1\nand 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must\nbe specified."

fn spec.pathMatcher.routeRules.matchRules.withHeaderMatches

withHeaderMatches(headerMatches)

"Specifies a list of header match criteria, all of which must match corresponding\nheaders in the request."

fn spec.pathMatcher.routeRules.matchRules.withHeaderMatchesMixin

withHeaderMatchesMixin(headerMatches)

"Specifies a list of header match criteria, all of which must match corresponding\nheaders in the request."

Note: This function appends passed data to existing values

fn spec.pathMatcher.routeRules.matchRules.withIgnoreCase

withIgnoreCase(ignoreCase)

"Specifies that prefixMatch and fullPathMatch matches are case sensitive.\nDefaults to false."

fn spec.pathMatcher.routeRules.matchRules.withMetadataFilters

withMetadataFilters(metadataFilters)

"Opaque filter criteria used by Loadbalancer to restrict routing configuration to\na limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS\nclients present node metadata. If a match takes place, the relevant routing\nconfiguration is made available to those proxies. For each metadataFilter in\nthis list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the\nfilterLabels must match the corresponding label provided in the metadata. If its\nfilterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match\nwith corresponding labels in the provided metadata. metadataFilters specified\nhere can be overrides those specified in ForwardingRule that refers to this\nUrlMap. metadataFilters only applies to Loadbalancers that have their\nloadBalancingScheme set to INTERNAL_SELF_MANAGED."

fn spec.pathMatcher.routeRules.matchRules.withMetadataFiltersMixin

withMetadataFiltersMixin(metadataFilters)

"Opaque filter criteria used by Loadbalancer to restrict routing configuration to\na limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS\nclients present node metadata. If a match takes place, the relevant routing\nconfiguration is made available to those proxies. For each metadataFilter in\nthis list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the\nfilterLabels must match the corresponding label provided in the metadata. If its\nfilterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match\nwith corresponding labels in the provided metadata. metadataFilters specified\nhere can be overrides those specified in ForwardingRule that refers to this\nUrlMap. metadataFilters only applies to Loadbalancers that have their\nloadBalancingScheme set to INTERNAL_SELF_MANAGED."

Note: This function appends passed data to existing values

fn spec.pathMatcher.routeRules.matchRules.withPrefixMatch

withPrefixMatch(prefixMatch)

"For satisfying the matchRule condition, the request's path must begin with the\nspecified prefixMatch. prefixMatch must begin with a /. The value must be\nbetween 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or\nregexMatch must be specified."

fn spec.pathMatcher.routeRules.matchRules.withQueryParameterMatches

withQueryParameterMatches(queryParameterMatches)

"Specifies a list of query parameter match criteria, all of which must match\ncorresponding query parameters in the request."

fn spec.pathMatcher.routeRules.matchRules.withQueryParameterMatchesMixin

withQueryParameterMatchesMixin(queryParameterMatches)

"Specifies a list of query parameter match criteria, all of which must match\ncorresponding query parameters in the request."

Note: This function appends passed data to existing values

fn spec.pathMatcher.routeRules.matchRules.withRegexMatch

withRegexMatch(regexMatch)

"For satisfying the matchRule condition, the path of the request must satisfy the\nregular expression specified in regexMatch after removing any query parameters\nand anchor supplied with the original URL. For regular expression grammar please\nsee en.cppreference.com/w/cpp/regex/ecmascript Only one of prefixMatch,\nfullPathMatch or regexMatch must be specified."

obj spec.pathMatcher.routeRules.matchRules.headerMatches

"Specifies a list of header match criteria, all of which must match corresponding\nheaders in the request."

fn spec.pathMatcher.routeRules.matchRules.headerMatches.withExactMatch

withExactMatch(exactMatch)

"The value should exactly match contents of exactMatch. Only one of exactMatch,\nprefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set."

fn spec.pathMatcher.routeRules.matchRules.headerMatches.withHeaderName

withHeaderName(headerName)

"The name of the HTTP header to match. For matching against the HTTP request's\nauthority, use a headerMatch with the header name \":authority\". For matching a\nrequest's method, use the headerName \":method\"."

fn spec.pathMatcher.routeRules.matchRules.headerMatches.withInvertMatch

withInvertMatch(invertMatch)

"If set to false, the headerMatch is considered a match if the match criteria\nabove are met. If set to true, the headerMatch is considered a match if the\nmatch criteria above are NOT met. Defaults to false."

fn spec.pathMatcher.routeRules.matchRules.headerMatches.withPrefixMatch

withPrefixMatch(prefixMatch)

"The value of the header must start with the contents of prefixMatch. Only one of\nexactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch\nmust be set."

fn spec.pathMatcher.routeRules.matchRules.headerMatches.withPresentMatch

withPresentMatch(presentMatch)

"A header with the contents of headerName must exist. The match takes place\nwhether or not the request's header has a value or not. Only one of exactMatch,\nprefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set."

fn spec.pathMatcher.routeRules.matchRules.headerMatches.withRegexMatch

withRegexMatch(regexMatch)

"The value of the header must match the regular expression specified in\nregexMatch. For regular expression grammar, please see:\nen.cppreference.com/w/cpp/regex/ecmascript For matching against a port\nspecified in the HTTP request, use a headerMatch with headerName set to PORT and\na regular expression that satisfies the RFC2616 Host header's port specifier.\nOnly one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or\nrangeMatch must be set."

fn spec.pathMatcher.routeRules.matchRules.headerMatches.withSuffixMatch

withSuffixMatch(suffixMatch)

"The value of the header must end with the contents of suffixMatch. Only one of\nexactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch\nmust be set."

obj spec.pathMatcher.routeRules.matchRules.headerMatches.rangeMatch

"The header value must be an integer and its value must be in the range specified\nin rangeMatch. If the header does not contain an integer, number or is empty,\nthe match fails. For example for a range [-5, 0]\n\n -3 will match\n 0 will not match\n 0.25 will not match\n -3someString will not match.\n\nOnly one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or\nrangeMatch must be set."

fn spec.pathMatcher.routeRules.matchRules.headerMatches.rangeMatch.withRangeEnd

withRangeEnd(rangeEnd)

"The end of the range (exclusive)."

fn spec.pathMatcher.routeRules.matchRules.headerMatches.rangeMatch.withRangeStart

withRangeStart(rangeStart)

"The start of the range (inclusive)."

obj spec.pathMatcher.routeRules.matchRules.metadataFilters

"Opaque filter criteria used by Loadbalancer to restrict routing configuration to\na limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS\nclients present node metadata. If a match takes place, the relevant routing\nconfiguration is made available to those proxies. For each metadataFilter in\nthis list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the\nfilterLabels must match the corresponding label provided in the metadata. If its\nfilterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match\nwith corresponding labels in the provided metadata. metadataFilters specified\nhere can be overrides those specified in ForwardingRule that refers to this\nUrlMap. metadataFilters only applies to Loadbalancers that have their\nloadBalancingScheme set to INTERNAL_SELF_MANAGED."

fn spec.pathMatcher.routeRules.matchRules.metadataFilters.withFilterLabels

withFilterLabels(filterLabels)

"The list of label value pairs that must match labels in the provided metadata\nbased on filterMatchCriteria This list must not be empty and can have at the\nmost 64 entries."

fn spec.pathMatcher.routeRules.matchRules.metadataFilters.withFilterLabelsMixin

withFilterLabelsMixin(filterLabels)

"The list of label value pairs that must match labels in the provided metadata\nbased on filterMatchCriteria This list must not be empty and can have at the\nmost 64 entries."

Note: This function appends passed data to existing values

fn spec.pathMatcher.routeRules.matchRules.metadataFilters.withFilterMatchCriteria

withFilterMatchCriteria(filterMatchCriteria)

"Specifies how individual filterLabel matches within the list of filterLabels\ncontribute towards the overall metadataFilter match. Supported values are:\n\n MATCH_ANY: At least one of the filterLabels must have a matching label in the\nprovided metadata.\n MATCH_ALL: All filterLabels must have matching labels in\nthe provided metadata. Possible values: [\"MATCH_ALL\", \"MATCH_ANY\"]."

obj spec.pathMatcher.routeRules.matchRules.metadataFilters.filterLabels

"The list of label value pairs that must match labels in the provided metadata\nbased on filterMatchCriteria This list must not be empty and can have at the\nmost 64 entries."

fn spec.pathMatcher.routeRules.matchRules.metadataFilters.filterLabels.withName

withName(name)

"Name of metadata label. The name can have a maximum length of 1024 characters\nand must be at least 1 character long."

fn spec.pathMatcher.routeRules.matchRules.metadataFilters.filterLabels.withValue

withValue(value)

"The value of the label must match the specified value. value can have a maximum\nlength of 1024 characters."

obj spec.pathMatcher.routeRules.matchRules.queryParameterMatches

"Specifies a list of query parameter match criteria, all of which must match\ncorresponding query parameters in the request."

fn spec.pathMatcher.routeRules.matchRules.queryParameterMatches.withExactMatch

withExactMatch(exactMatch)

"The queryParameterMatch matches if the value of the parameter exactly matches\nthe contents of exactMatch. Only one of presentMatch, exactMatch and regexMatch\nmust be set."

fn spec.pathMatcher.routeRules.matchRules.queryParameterMatches.withName

withName(name)

"The name of the query parameter to match. The query parameter must exist in the\nrequest, in the absence of which the request match fails."

fn spec.pathMatcher.routeRules.matchRules.queryParameterMatches.withPresentMatch

withPresentMatch(presentMatch)

"Specifies that the queryParameterMatch matches if the request contains the query\nparameter, irrespective of whether the parameter has a value or not. Only one of\npresentMatch, exactMatch and regexMatch must be set."

fn spec.pathMatcher.routeRules.matchRules.queryParameterMatches.withRegexMatch

withRegexMatch(regexMatch)

"The queryParameterMatch matches if the value of the parameter matches the\nregular expression specified by regexMatch. For the regular expression grammar,\nplease see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch,\nexactMatch and regexMatch must be set."

obj spec.pathMatcher.routeRules.routeAction

"In response to a matching matchRule, the load balancer performs advanced routing\nactions like URL rewrites, header transformations, etc. prior to forwarding the\nrequest to the selected backend. If routeAction specifies any\nweightedBackendServices, service must not be set. Conversely if service is set,\nrouteAction cannot contain any weightedBackendServices. Only one of routeAction\nor urlRedirect must be set."

fn spec.pathMatcher.routeRules.routeAction.withWeightedBackendServices

withWeightedBackendServices(weightedBackendServices)

"A list of weighted backend services to send traffic to when a route match\noccurs. The weights determine the fraction of traffic that flows to their\ncorresponding backend service. If all traffic needs to go to a single backend\nservice, there must be one weightedBackendService with weight set to a non 0\nnumber. Once a backendService is identified and before forwarding the request to\nthe backend service, advanced routing actions like Url rewrites and header\ntransformations are applied depending on additional settings specified in this\nHttpRouteAction."

fn spec.pathMatcher.routeRules.routeAction.withWeightedBackendServicesMixin

withWeightedBackendServicesMixin(weightedBackendServices)

"A list of weighted backend services to send traffic to when a route match\noccurs. The weights determine the fraction of traffic that flows to their\ncorresponding backend service. If all traffic needs to go to a single backend\nservice, there must be one weightedBackendService with weight set to a non 0\nnumber. Once a backendService is identified and before forwarding the request to\nthe backend service, advanced routing actions like Url rewrites and header\ntransformations are applied depending on additional settings specified in this\nHttpRouteAction."

Note: This function appends passed data to existing values

obj spec.pathMatcher.routeRules.routeAction.corsPolicy

"The specification for allowing client side cross-origin requests. Please see W3C\nRecommendation for Cross Origin Resource Sharing."

fn spec.pathMatcher.routeRules.routeAction.corsPolicy.withAllowCredentials

withAllowCredentials(allowCredentials)

"In response to a preflight request, setting this to true indicates that the\nactual request can include user credentials. This translates to the Access-\nControl-Allow-Credentials header. Defaults to false."

fn spec.pathMatcher.routeRules.routeAction.corsPolicy.withAllowHeaders

withAllowHeaders(allowHeaders)

"Specifies the content for the Access-Control-Allow-Headers header."

fn spec.pathMatcher.routeRules.routeAction.corsPolicy.withAllowHeadersMixin

withAllowHeadersMixin(allowHeaders)

"Specifies the content for the Access-Control-Allow-Headers header."

Note: This function appends passed data to existing values

fn spec.pathMatcher.routeRules.routeAction.corsPolicy.withAllowMethods

withAllowMethods(allowMethods)

"Specifies the content for the Access-Control-Allow-Methods header."

fn spec.pathMatcher.routeRules.routeAction.corsPolicy.withAllowMethodsMixin

withAllowMethodsMixin(allowMethods)

"Specifies the content for the Access-Control-Allow-Methods header."

Note: This function appends passed data to existing values

fn spec.pathMatcher.routeRules.routeAction.corsPolicy.withAllowOriginRegexes

withAllowOriginRegexes(allowOriginRegexes)

"Specifies the regular expression patterns that match allowed origins. For\nregular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript\nAn origin is allowed if it matches either allow_origins or allow_origin_regex."

fn spec.pathMatcher.routeRules.routeAction.corsPolicy.withAllowOriginRegexesMixin

withAllowOriginRegexesMixin(allowOriginRegexes)

"Specifies the regular expression patterns that match allowed origins. For\nregular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript\nAn origin is allowed if it matches either allow_origins or allow_origin_regex."

Note: This function appends passed data to existing values

fn spec.pathMatcher.routeRules.routeAction.corsPolicy.withAllowOrigins

withAllowOrigins(allowOrigins)

"Specifies the list of origins that will be allowed to do CORS requests. An\norigin is allowed if it matches either allow_origins or allow_origin_regex."

fn spec.pathMatcher.routeRules.routeAction.corsPolicy.withAllowOriginsMixin

withAllowOriginsMixin(allowOrigins)

"Specifies the list of origins that will be allowed to do CORS requests. An\norigin is allowed if it matches either allow_origins or allow_origin_regex."

Note: This function appends passed data to existing values

fn spec.pathMatcher.routeRules.routeAction.corsPolicy.withDisabled

withDisabled(disabled)

"If true, specifies the CORS policy is disabled.\nwhich indicates that the CORS policy is in effect. Defaults to false."

fn spec.pathMatcher.routeRules.routeAction.corsPolicy.withExposeHeaders

withExposeHeaders(exposeHeaders)

"Specifies the content for the Access-Control-Expose-Headers header."

fn spec.pathMatcher.routeRules.routeAction.corsPolicy.withExposeHeadersMixin

withExposeHeadersMixin(exposeHeaders)

"Specifies the content for the Access-Control-Expose-Headers header."

Note: This function appends passed data to existing values

fn spec.pathMatcher.routeRules.routeAction.corsPolicy.withMaxAge

withMaxAge(maxAge)

"Specifies how long the results of a preflight request can be cached. This\ntranslates to the content for the Access-Control-Max-Age header."

obj spec.pathMatcher.routeRules.routeAction.faultInjectionPolicy

"The specification for fault injection introduced into traffic to test the\nresiliency of clients to backend service failure. As part of fault injection,\nwhen clients send requests to a backend service, delays can be introduced by\nLoadbalancer on a percentage of requests before sending those request to the\nbackend service. Similarly requests from clients can be aborted by the\nLoadbalancer for a percentage of requests. timeout and retry_policy will be\nignored by clients that are configured with a fault_injection_policy."

obj spec.pathMatcher.routeRules.routeAction.faultInjectionPolicy.abort

"The specification for how client requests are aborted as part of fault\ninjection."

fn spec.pathMatcher.routeRules.routeAction.faultInjectionPolicy.abort.withHttpStatus

withHttpStatus(httpStatus)

"The HTTP status code used to abort the request. The value must be between 200\nand 599 inclusive."

fn spec.pathMatcher.routeRules.routeAction.faultInjectionPolicy.abort.withPercentage

withPercentage(percentage)

"The percentage of traffic (connections/operations/requests) which will be\naborted as part of fault injection. The value must be between 0.0 and 100.0\ninclusive."

obj spec.pathMatcher.routeRules.routeAction.faultInjectionPolicy.delay

"The specification for how client requests are delayed as part of fault\ninjection, before being sent to a backend service."

fn spec.pathMatcher.routeRules.routeAction.faultInjectionPolicy.delay.withPercentage

withPercentage(percentage)

"The percentage of traffic (connections/operations/requests) on which delay will\nbe introduced as part of fault injection. The value must be between 0.0 and\n100.0 inclusive."

obj spec.pathMatcher.routeRules.routeAction.faultInjectionPolicy.delay.fixedDelay

"Specifies the value of the fixed delay interval."

fn spec.pathMatcher.routeRules.routeAction.faultInjectionPolicy.delay.fixedDelay.withNanos

withNanos(nanos)

"Span of time that's a fraction of a second at nanosecond resolution. Durations\nless than one second are represented with a 0 'seconds' field and a positive\n'nanos' field. Must be from 0 to 999,999,999 inclusive."

fn spec.pathMatcher.routeRules.routeAction.faultInjectionPolicy.delay.fixedDelay.withSeconds

withSeconds(seconds)

"Span of time at a resolution of a second. Must be from 0 to 315,576,000,000\ninclusive."

obj spec.pathMatcher.routeRules.routeAction.requestMirrorPolicy

"Specifies the policy on how requests intended for the route's backends are\nshadowed to a separate mirrored backend service. Loadbalancer does not wait for\nresponses from the shadow service. Prior to sending traffic to the shadow\nservice, the host / authority header is suffixed with -shadow."

obj spec.pathMatcher.routeRules.routeAction.requestMirrorPolicy.backendServiceRef

"Required. The backend service resource being mirrored to."

fn spec.pathMatcher.routeRules.routeAction.requestMirrorPolicy.backendServiceRef.withExternal

withExternal(external)

"Allowed value: The selfLink field of a ComputeBackendService resource."

fn spec.pathMatcher.routeRules.routeAction.requestMirrorPolicy.backendServiceRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.pathMatcher.routeRules.routeAction.requestMirrorPolicy.backendServiceRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.pathMatcher.routeRules.routeAction.retryPolicy

"Specifies the retry policy associated with this route."

fn spec.pathMatcher.routeRules.routeAction.retryPolicy.withNumRetries

withNumRetries(numRetries)

"Specifies the allowed number retries. This number must be > 0."

fn spec.pathMatcher.routeRules.routeAction.retryPolicy.withRetryConditions

withRetryConditions(retryConditions)

"Specifies one or more conditions when this retry rule applies. Valid values are:\n\n 5xx: Loadbalancer will attempt a retry if the backend service responds with\n any 5xx response code, or if the backend service does not respond at all,\n example: disconnects, reset, read timeout, connection failure, and refused\n streams.\n gateway-error: Similar to 5xx, but only applies to response codes\n 502, 503 or 504.\n connect-failure: Loadbalancer will retry on failures\n connecting to backend services, for example due to connection timeouts.\n retriable-4xx: Loadbalancer will retry for retriable 4xx response codes.\n Currently the only retriable error supported is 409.\n refused-stream: Loadbalancer will retry if the backend service resets the stream with a\n REFUSED_STREAM error code. This reset type indicates that it is safe to retry.\n cancelled: Loadbalancer will retry if the gRPC status code in the response\n header is set to cancelled\n deadline-exceeded: Loadbalancer will retry if the\n gRPC status code in the response header is set to deadline-exceeded\n resource-exhausted: Loadbalancer will retry if the gRPC status code in the response\n header is set to resource-exhausted\n* unavailable: Loadbalancer will retry if the gRPC status code in\n the response header is set to unavailable."

fn spec.pathMatcher.routeRules.routeAction.retryPolicy.withRetryConditionsMixin

withRetryConditionsMixin(retryConditions)

"Specifies one or more conditions when this retry rule applies. Valid values are:\n\n 5xx: Loadbalancer will attempt a retry if the backend service responds with\n any 5xx response code, or if the backend service does not respond at all,\n example: disconnects, reset, read timeout, connection failure, and refused\n streams.\n gateway-error: Similar to 5xx, but only applies to response codes\n 502, 503 or 504.\n connect-failure: Loadbalancer will retry on failures\n connecting to backend services, for example due to connection timeouts.\n retriable-4xx: Loadbalancer will retry for retriable 4xx response codes.\n Currently the only retriable error supported is 409.\n refused-stream: Loadbalancer will retry if the backend service resets the stream with a\n REFUSED_STREAM error code. This reset type indicates that it is safe to retry.\n cancelled: Loadbalancer will retry if the gRPC status code in the response\n header is set to cancelled\n deadline-exceeded: Loadbalancer will retry if the\n gRPC status code in the response header is set to deadline-exceeded\n resource-exhausted: Loadbalancer will retry if the gRPC status code in the response\n header is set to resource-exhausted\n* unavailable: Loadbalancer will retry if the gRPC status code in\n the response header is set to unavailable."

Note: This function appends passed data to existing values

obj spec.pathMatcher.routeRules.routeAction.retryPolicy.perTryTimeout

"Specifies a non-zero timeout per retry attempt."

fn spec.pathMatcher.routeRules.routeAction.retryPolicy.perTryTimeout.withNanos

withNanos(nanos)

"Span of time that's a fraction of a second at nanosecond resolution. Durations\nless than one second are represented with a 0 'seconds' field and a positive\n'nanos' field. Must be from 0 to 999,999,999 inclusive."

fn spec.pathMatcher.routeRules.routeAction.retryPolicy.perTryTimeout.withSeconds

withSeconds(seconds)

"Span of time at a resolution of a second. Must be from 0 to 315,576,000,000\ninclusive."

obj spec.pathMatcher.routeRules.routeAction.timeout

"Specifies the timeout for the selected route. Timeout is computed from the time\nthe request is has been fully processed (i.e. end-of-stream) up until the\nresponse has been completely processed. Timeout includes all retries. If not\nspecified, the default value is 15 seconds."

fn spec.pathMatcher.routeRules.routeAction.timeout.withNanos

withNanos(nanos)

"Span of time that's a fraction of a second at nanosecond resolution. Durations\nless than one second are represented with a 0 'seconds' field and a positive\n'nanos' field. Must be from 0 to 999,999,999 inclusive."

fn spec.pathMatcher.routeRules.routeAction.timeout.withSeconds

withSeconds(seconds)

"Span of time at a resolution of a second. Must be from 0 to 315,576,000,000\ninclusive."

obj spec.pathMatcher.routeRules.routeAction.urlRewrite

"The spec to modify the URL of the request, prior to forwarding the request to\nthe matched service."

fn spec.pathMatcher.routeRules.routeAction.urlRewrite.withHostRewrite

withHostRewrite(hostRewrite)

"Prior to forwarding the request to the selected service, the request's host\nheader is replaced with contents of hostRewrite. The value must be between 1 and\n255 characters."

fn spec.pathMatcher.routeRules.routeAction.urlRewrite.withPathPrefixRewrite

withPathPrefixRewrite(pathPrefixRewrite)

"Prior to forwarding the request to the selected backend service, the matching\nportion of the request's path is replaced by pathPrefixRewrite. The value must\nbe between 1 and 1024 characters."

obj spec.pathMatcher.routeRules.routeAction.weightedBackendServices

"A list of weighted backend services to send traffic to when a route match\noccurs. The weights determine the fraction of traffic that flows to their\ncorresponding backend service. If all traffic needs to go to a single backend\nservice, there must be one weightedBackendService with weight set to a non 0\nnumber. Once a backendService is identified and before forwarding the request to\nthe backend service, advanced routing actions like Url rewrites and header\ntransformations are applied depending on additional settings specified in this\nHttpRouteAction."

fn spec.pathMatcher.routeRules.routeAction.weightedBackendServices.withWeight

withWeight(weight)

"Specifies the fraction of traffic sent to backendService, computed as weight /\n(sum of all weightedBackendService weights in routeAction) . The selection of a\nbackend service is determined only for new traffic. Once a user's request has\nbeen directed to a backendService, subsequent requests will be sent to the same\nbackendService as determined by the BackendService's session affinity policy.\nThe value must be between 0 and 1000."

obj spec.pathMatcher.routeRules.routeAction.weightedBackendServices.backendServiceRef

"Required. The default backend service resource. Before forwarding\nthe request to backendService, the loadbalancer applies any relevant\nheaderActions specified as part of this backendServiceWeight."

fn spec.pathMatcher.routeRules.routeAction.weightedBackendServices.backendServiceRef.withExternal

withExternal(external)

"Allowed value: The selfLink field of a ComputeBackendService resource."

fn spec.pathMatcher.routeRules.routeAction.weightedBackendServices.backendServiceRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.pathMatcher.routeRules.routeAction.weightedBackendServices.backendServiceRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction

"Specifies changes to request and response headers that need to take effect for\nthe selected backendService. headerAction specified here take effect before\nheaderAction in the enclosing HttpRouteRule, PathMatcher and UrlMap."

fn spec.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.withRequestHeadersToAdd

withRequestHeadersToAdd(requestHeadersToAdd)

"Headers to add to a matching request prior to forwarding the request to the\nbackendService."

fn spec.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.withRequestHeadersToAddMixin

withRequestHeadersToAddMixin(requestHeadersToAdd)

"Headers to add to a matching request prior to forwarding the request to the\nbackendService."

Note: This function appends passed data to existing values

fn spec.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.withRequestHeadersToRemove

withRequestHeadersToRemove(requestHeadersToRemove)

"A list of header names for headers that need to be removed from the request\nprior to forwarding the request to the backendService."

fn spec.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.withRequestHeadersToRemoveMixin

withRequestHeadersToRemoveMixin(requestHeadersToRemove)

"A list of header names for headers that need to be removed from the request\nprior to forwarding the request to the backendService."

Note: This function appends passed data to existing values

fn spec.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.withResponseHeadersToAdd

withResponseHeadersToAdd(responseHeadersToAdd)

"Headers to add the response prior to sending the response back to the client."

fn spec.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.withResponseHeadersToAddMixin

withResponseHeadersToAddMixin(responseHeadersToAdd)

"Headers to add the response prior to sending the response back to the client."

Note: This function appends passed data to existing values

fn spec.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.withResponseHeadersToRemove

withResponseHeadersToRemove(responseHeadersToRemove)

"A list of header names for headers that need to be removed from the response\nprior to sending the response back to the client."

fn spec.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.withResponseHeadersToRemoveMixin

withResponseHeadersToRemoveMixin(responseHeadersToRemove)

"A list of header names for headers that need to be removed from the response\nprior to sending the response back to the client."

Note: This function appends passed data to existing values

obj spec.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.requestHeadersToAdd

"Headers to add to a matching request prior to forwarding the request to the\nbackendService."

fn spec.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.requestHeadersToAdd.withHeaderName

withHeaderName(headerName)

"The name of the header."

fn spec.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.requestHeadersToAdd.withHeaderValue

withHeaderValue(headerValue)

"The value of the header to add."

fn spec.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.requestHeadersToAdd.withReplace

withReplace(replace)

"If false, headerValue is appended to any values that already exist for the\nheader. If true, headerValue is set for the header, discarding any values that\nwere set for that header."

obj spec.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.responseHeadersToAdd

"Headers to add the response prior to sending the response back to the client."

fn spec.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.responseHeadersToAdd.withHeaderName

withHeaderName(headerName)

"The name of the header."

fn spec.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.responseHeadersToAdd.withHeaderValue

withHeaderValue(headerValue)

"The value of the header to add."

fn spec.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.responseHeadersToAdd.withReplace

withReplace(replace)

"If false, headerValue is appended to any values that already exist for the\nheader. If true, headerValue is set for the header, discarding any values that\nwere set for that header."

obj spec.pathMatcher.routeRules.urlRedirect

"When this rule is matched, the request is redirected to a URL specified by\nurlRedirect. If urlRedirect is specified, service or routeAction must not be\nset."

fn spec.pathMatcher.routeRules.urlRedirect.withHostRedirect

withHostRedirect(hostRedirect)

"The host that will be used in the redirect response instead of the one\nthat was supplied in the request. The value must be between 1 and 255\ncharacters."

fn spec.pathMatcher.routeRules.urlRedirect.withHttpsRedirect

withHttpsRedirect(httpsRedirect)

"If set to true, the URL scheme in the redirected request is set to https.\nIf set to false, the URL scheme of the redirected request will remain the\nsame as that of the request. This must only be set for UrlMaps used in\nTargetHttpProxys. Setting this true for TargetHttpsProxy is not\npermitted. The default is set to false."

fn spec.pathMatcher.routeRules.urlRedirect.withPathRedirect

withPathRedirect(pathRedirect)

"The path that will be used in the redirect response instead of the one\nthat was supplied in the request. pathRedirect cannot be supplied\ntogether with prefixRedirect. Supply one alone or neither. If neither is\nsupplied, the path of the original request will be used for the redirect.\nThe value must be between 1 and 1024 characters."

fn spec.pathMatcher.routeRules.urlRedirect.withPrefixRedirect

withPrefixRedirect(prefixRedirect)

"The prefix that replaces the prefixMatch specified in the\nHttpRouteRuleMatch, retaining the remaining portion of the URL before\nredirecting the request. prefixRedirect cannot be supplied together with\npathRedirect. Supply one alone or neither. If neither is supplied, the\npath of the original request will be used for the redirect. The value\nmust be between 1 and 1024 characters."

fn spec.pathMatcher.routeRules.urlRedirect.withRedirectResponseCode

withRedirectResponseCode(redirectResponseCode)

"The HTTP Status code to use for this RedirectAction. Supported values are:\n\n MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.\n\n FOUND, which corresponds to 302.\n\n SEE_OTHER which corresponds to 303.\n\n TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method\nwill be retained.\n\n* PERMANENT_REDIRECT, which corresponds to 308. In this case,\nthe request method will be retained. Possible values: [\"FOUND\", \"MOVED_PERMANENTLY_DEFAULT\", \"PERMANENT_REDIRECT\", \"SEE_OTHER\", \"TEMPORARY_REDIRECT\"]."

fn spec.pathMatcher.routeRules.urlRedirect.withStripQuery

withStripQuery(stripQuery)

"If set to true, any accompanying query portion of the original URL is\nremoved prior to redirecting the request. If set to false, the query\nportion of the original URL is retained. The default value is false."

obj spec.test

"The list of expected URL mappings. Requests to update this UrlMap will\nsucceed only if all of the test cases pass."

fn spec.test.withDescription

withDescription(description)

"Description of this test case."

fn spec.test.withHost

withHost(host)

"Host portion of the URL."

fn spec.test.withPath

withPath(path)

"Path portion of the URL."

obj spec.test.service

"The backend service resource that should be matched by this test.\nFor the Global URL Map, it should be a reference to the backend\nservice or backend bucket.\nFor the Regional URL Map, it should be a reference to the backend\nservice."

obj spec.test.service.backendBucketRef

fn spec.test.service.backendBucketRef.withExternal

withExternal(external)

"Allowed value: The selfLink field of a ComputeBackendBucket resource."

fn spec.test.service.backendBucketRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.test.service.backendBucketRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.test.service.backendServiceRef

fn spec.test.service.backendServiceRef.withExternal

withExternal(external)

"Allowed value: The selfLink field of a ComputeBackendService resource."

fn spec.test.service.backendServiceRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.test.service.backendServiceRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"