compute.v1beta1.regionURLMap
"RegionURLMap is the Schema for the RegionURLMaps API. UrlMaps are used to route requests to a backend service based on rules that you define for the host and path of an incoming URL."
Index
fn new(name)
obj metadata
fn withAnnotations(annotations)
fn withAnnotationsMixin(annotations)
fn withClusterName(clusterName)
fn withCreationTimestamp(creationTimestamp)
fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
fn withDeletionTimestamp(deletionTimestamp)
fn withFinalizers(finalizers)
fn withFinalizersMixin(finalizers)
fn withGenerateName(generateName)
fn withGeneration(generation)
fn withLabels(labels)
fn withLabelsMixin(labels)
fn withName(name)
fn withNamespace(namespace)
fn withOwnerReferences(ownerReferences)
fn withOwnerReferencesMixin(ownerReferences)
fn withResourceVersion(resourceVersion)
fn withSelfLink(selfLink)
fn withUid(uid)
obj spec
fn withDeletionPolicy(deletionPolicy)
fn withManagementPolicies(managementPolicies)
fn withManagementPoliciesMixin(managementPolicies)
obj spec.forProvider
fn withDefaultRouteAction(defaultRouteAction)
fn withDefaultRouteActionMixin(defaultRouteAction)
fn withDefaultService(defaultService)
fn withDefaultUrlRedirect(defaultUrlRedirect)
fn withDefaultUrlRedirectMixin(defaultUrlRedirect)
fn withDescription(description)
fn withHostRule(hostRule)
fn withHostRuleMixin(hostRule)
fn withPathMatcher(pathMatcher)
fn withPathMatcherMixin(pathMatcher)
fn withProject(project)
fn withRegion(region)
fn withTest(test)
fn withTestMixin(test)
obj spec.forProvider.defaultRouteAction
fn withCorsPolicy(corsPolicy)
fn withCorsPolicyMixin(corsPolicy)
fn withFaultInjectionPolicy(faultInjectionPolicy)
fn withFaultInjectionPolicyMixin(faultInjectionPolicy)
fn withRequestMirrorPolicy(requestMirrorPolicy)
fn withRequestMirrorPolicyMixin(requestMirrorPolicy)
fn withRetryPolicy(retryPolicy)
fn withRetryPolicyMixin(retryPolicy)
fn withTimeout(timeout)
fn withTimeoutMixin(timeout)
fn withUrlRewrite(urlRewrite)
fn withUrlRewriteMixin(urlRewrite)
fn withWeightedBackendServices(weightedBackendServices)
fn withWeightedBackendServicesMixin(weightedBackendServices)
obj spec.forProvider.defaultRouteAction.corsPolicy
fn withAllowCredentials(allowCredentials)
fn withAllowHeaders(allowHeaders)
fn withAllowHeadersMixin(allowHeaders)
fn withAllowMethods(allowMethods)
fn withAllowMethodsMixin(allowMethods)
fn withAllowOriginRegexes(allowOriginRegexes)
fn withAllowOriginRegexesMixin(allowOriginRegexes)
fn withAllowOrigins(allowOrigins)
fn withAllowOriginsMixin(allowOrigins)
fn withDisabled(disabled)
fn withExposeHeaders(exposeHeaders)
fn withExposeHeadersMixin(exposeHeaders)
fn withMaxAge(maxAge)
obj spec.forProvider.defaultRouteAction.faultInjectionPolicy
obj spec.forProvider.defaultRouteAction.requestMirrorPolicy
obj spec.forProvider.defaultRouteAction.retryPolicy
obj spec.forProvider.defaultRouteAction.timeout
obj spec.forProvider.defaultRouteAction.urlRewrite
obj spec.forProvider.defaultRouteAction.weightedBackendServices
fn withBackendService(backendService)
fn withHeaderAction(headerAction)
fn withHeaderActionMixin(headerAction)
fn withWeight(weight)
obj spec.forProvider.defaultRouteAction.weightedBackendServices.backendServiceRef
obj spec.forProvider.defaultRouteAction.weightedBackendServices.backendServiceSelector
obj spec.forProvider.defaultRouteAction.weightedBackendServices.headerAction
fn withRequestHeadersToAdd(requestHeadersToAdd)
fn withRequestHeadersToAddMixin(requestHeadersToAdd)
fn withRequestHeadersToRemove(requestHeadersToRemove)
fn withRequestHeadersToRemoveMixin(requestHeadersToRemove)
fn withResponseHeadersToAdd(responseHeadersToAdd)
fn withResponseHeadersToAddMixin(responseHeadersToAdd)
fn withResponseHeadersToRemove(responseHeadersToRemove)
fn withResponseHeadersToRemoveMixin(responseHeadersToRemove)
obj spec.forProvider.defaultRouteAction.weightedBackendServices.headerAction.requestHeadersToAdd
obj spec.forProvider.defaultRouteAction.weightedBackendServices.headerAction.responseHeadersToAdd
obj spec.forProvider.defaultServiceRef
obj spec.forProvider.defaultServiceSelector
obj spec.forProvider.defaultUrlRedirect
obj spec.forProvider.hostRule
obj spec.forProvider.pathMatcher
fn withDefaultService(defaultService)
fn withDefaultUrlRedirect(defaultUrlRedirect)
fn withDefaultUrlRedirectMixin(defaultUrlRedirect)
fn withDescription(description)
fn withName(name)
fn withPathRule(pathRule)
fn withPathRuleMixin(pathRule)
fn withRouteRules(routeRules)
fn withRouteRulesMixin(routeRules)
obj spec.forProvider.pathMatcher.defaultServiceRef
obj spec.forProvider.pathMatcher.defaultServiceSelector
obj spec.forProvider.pathMatcher.defaultUrlRedirect
obj spec.forProvider.pathMatcher.pathRule
fn withPaths(paths)
fn withPathsMixin(paths)
fn withRouteAction(routeAction)
fn withRouteActionMixin(routeAction)
fn withService(service)
fn withUrlRedirect(urlRedirect)
fn withUrlRedirectMixin(urlRedirect)
obj spec.forProvider.pathMatcher.pathRule.routeAction
fn withCorsPolicy(corsPolicy)
fn withCorsPolicyMixin(corsPolicy)
fn withFaultInjectionPolicy(faultInjectionPolicy)
fn withFaultInjectionPolicyMixin(faultInjectionPolicy)
fn withRequestMirrorPolicy(requestMirrorPolicy)
fn withRequestMirrorPolicyMixin(requestMirrorPolicy)
fn withRetryPolicy(retryPolicy)
fn withRetryPolicyMixin(retryPolicy)
fn withTimeout(timeout)
fn withTimeoutMixin(timeout)
fn withUrlRewrite(urlRewrite)
fn withUrlRewriteMixin(urlRewrite)
fn withWeightedBackendServices(weightedBackendServices)
fn withWeightedBackendServicesMixin(weightedBackendServices)
obj spec.forProvider.pathMatcher.pathRule.routeAction.corsPolicy
fn withAllowCredentials(allowCredentials)
fn withAllowHeaders(allowHeaders)
fn withAllowHeadersMixin(allowHeaders)
fn withAllowMethods(allowMethods)
fn withAllowMethodsMixin(allowMethods)
fn withAllowOriginRegexes(allowOriginRegexes)
fn withAllowOriginRegexesMixin(allowOriginRegexes)
fn withAllowOrigins(allowOrigins)
fn withAllowOriginsMixin(allowOrigins)
fn withDisabled(disabled)
fn withExposeHeaders(exposeHeaders)
fn withExposeHeadersMixin(exposeHeaders)
fn withMaxAge(maxAge)
obj spec.forProvider.pathMatcher.pathRule.routeAction.faultInjectionPolicy
obj spec.forProvider.pathMatcher.pathRule.routeAction.requestMirrorPolicy
obj spec.forProvider.pathMatcher.pathRule.routeAction.retryPolicy
obj spec.forProvider.pathMatcher.pathRule.routeAction.timeout
obj spec.forProvider.pathMatcher.pathRule.routeAction.urlRewrite
obj spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices
fn withBackendService(backendService)
fn withHeaderAction(headerAction)
fn withHeaderActionMixin(headerAction)
fn withWeight(weight)
obj spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.backendServiceRef
obj spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.backendServiceSelector
obj spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction
fn withRequestHeadersToAdd(requestHeadersToAdd)
fn withRequestHeadersToAddMixin(requestHeadersToAdd)
fn withRequestHeadersToRemove(requestHeadersToRemove)
fn withRequestHeadersToRemoveMixin(requestHeadersToRemove)
fn withResponseHeadersToAdd(responseHeadersToAdd)
fn withResponseHeadersToAddMixin(responseHeadersToAdd)
fn withResponseHeadersToRemove(responseHeadersToRemove)
fn withResponseHeadersToRemoveMixin(responseHeadersToRemove)
obj spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.requestHeadersToAdd
obj spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.responseHeadersToAdd
obj spec.forProvider.pathMatcher.pathRule.serviceRef
obj spec.forProvider.pathMatcher.pathRule.serviceSelector
obj spec.forProvider.pathMatcher.pathRule.urlRedirect
obj spec.forProvider.pathMatcher.routeRules
fn withHeaderAction(headerAction)
fn withHeaderActionMixin(headerAction)
fn withMatchRules(matchRules)
fn withMatchRulesMixin(matchRules)
fn withPriority(priority)
fn withRouteAction(routeAction)
fn withRouteActionMixin(routeAction)
fn withService(service)
fn withUrlRedirect(urlRedirect)
fn withUrlRedirectMixin(urlRedirect)
obj spec.forProvider.pathMatcher.routeRules.headerAction
fn withRequestHeadersToAdd(requestHeadersToAdd)
fn withRequestHeadersToAddMixin(requestHeadersToAdd)
fn withRequestHeadersToRemove(requestHeadersToRemove)
fn withRequestHeadersToRemoveMixin(requestHeadersToRemove)
fn withResponseHeadersToAdd(responseHeadersToAdd)
fn withResponseHeadersToAddMixin(responseHeadersToAdd)
fn withResponseHeadersToRemove(responseHeadersToRemove)
fn withResponseHeadersToRemoveMixin(responseHeadersToRemove)
obj spec.forProvider.pathMatcher.routeRules.headerAction.requestHeadersToAdd
obj spec.forProvider.pathMatcher.routeRules.headerAction.responseHeadersToAdd
obj spec.forProvider.pathMatcher.routeRules.matchRules
fn withFullPathMatch(fullPathMatch)
fn withHeaderMatches(headerMatches)
fn withHeaderMatchesMixin(headerMatches)
fn withIgnoreCase(ignoreCase)
fn withMetadataFilters(metadataFilters)
fn withMetadataFiltersMixin(metadataFilters)
fn withPrefixMatch(prefixMatch)
fn withQueryParameterMatches(queryParameterMatches)
fn withQueryParameterMatchesMixin(queryParameterMatches)
fn withRegexMatch(regexMatch)
obj spec.forProvider.pathMatcher.routeRules.matchRules.headerMatches
fn withExactMatch(exactMatch)
fn withHeaderName(headerName)
fn withInvertMatch(invertMatch)
fn withPrefixMatch(prefixMatch)
fn withPresentMatch(presentMatch)
fn withRangeMatch(rangeMatch)
fn withRangeMatchMixin(rangeMatch)
fn withRegexMatch(regexMatch)
fn withSuffixMatch(suffixMatch)
obj spec.forProvider.pathMatcher.routeRules.matchRules.headerMatches.rangeMatch
obj spec.forProvider.pathMatcher.routeRules.matchRules.metadataFilters
obj spec.forProvider.pathMatcher.routeRules.matchRules.queryParameterMatches
obj spec.forProvider.pathMatcher.routeRules.routeAction
fn withCorsPolicy(corsPolicy)
fn withCorsPolicyMixin(corsPolicy)
fn withFaultInjectionPolicy(faultInjectionPolicy)
fn withFaultInjectionPolicyMixin(faultInjectionPolicy)
fn withRequestMirrorPolicy(requestMirrorPolicy)
fn withRequestMirrorPolicyMixin(requestMirrorPolicy)
fn withRetryPolicy(retryPolicy)
fn withRetryPolicyMixin(retryPolicy)
fn withTimeout(timeout)
fn withTimeoutMixin(timeout)
fn withUrlRewrite(urlRewrite)
fn withUrlRewriteMixin(urlRewrite)
fn withWeightedBackendServices(weightedBackendServices)
fn withWeightedBackendServicesMixin(weightedBackendServices)
obj spec.forProvider.pathMatcher.routeRules.routeAction.corsPolicy
fn withAllowCredentials(allowCredentials)
fn withAllowHeaders(allowHeaders)
fn withAllowHeadersMixin(allowHeaders)
fn withAllowMethods(allowMethods)
fn withAllowMethodsMixin(allowMethods)
fn withAllowOriginRegexes(allowOriginRegexes)
fn withAllowOriginRegexesMixin(allowOriginRegexes)
fn withAllowOrigins(allowOrigins)
fn withAllowOriginsMixin(allowOrigins)
fn withDisabled(disabled)
fn withExposeHeaders(exposeHeaders)
fn withExposeHeadersMixin(exposeHeaders)
fn withMaxAge(maxAge)
obj spec.forProvider.pathMatcher.routeRules.routeAction.faultInjectionPolicy
obj spec.forProvider.pathMatcher.routeRules.routeAction.requestMirrorPolicy
obj spec.forProvider.pathMatcher.routeRules.routeAction.retryPolicy
obj spec.forProvider.pathMatcher.routeRules.routeAction.timeout
obj spec.forProvider.pathMatcher.routeRules.routeAction.urlRewrite
obj spec.forProvider.pathMatcher.routeRules.routeAction.weightedBackendServices
fn withBackendService(backendService)
fn withHeaderAction(headerAction)
fn withHeaderActionMixin(headerAction)
fn withWeight(weight)
obj spec.forProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction
fn withRequestHeadersToAdd(requestHeadersToAdd)
fn withRequestHeadersToAddMixin(requestHeadersToAdd)
fn withRequestHeadersToRemove(requestHeadersToRemove)
fn withRequestHeadersToRemoveMixin(requestHeadersToRemove)
fn withResponseHeadersToAdd(responseHeadersToAdd)
fn withResponseHeadersToAddMixin(responseHeadersToAdd)
fn withResponseHeadersToRemove(responseHeadersToRemove)
fn withResponseHeadersToRemoveMixin(responseHeadersToRemove)
obj spec.forProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.requestHeadersToAdd
obj spec.forProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.responseHeadersToAdd
obj spec.forProvider.pathMatcher.routeRules.serviceRef
obj spec.forProvider.pathMatcher.routeRules.serviceSelector
obj spec.forProvider.pathMatcher.routeRules.urlRedirect
obj spec.forProvider.test
obj spec.initProvider
fn withDefaultRouteAction(defaultRouteAction)
fn withDefaultRouteActionMixin(defaultRouteAction)
fn withDefaultUrlRedirect(defaultUrlRedirect)
fn withDefaultUrlRedirectMixin(defaultUrlRedirect)
fn withDescription(description)
fn withHostRule(hostRule)
fn withHostRuleMixin(hostRule)
fn withPathMatcher(pathMatcher)
fn withPathMatcherMixin(pathMatcher)
fn withProject(project)
fn withTest(test)
fn withTestMixin(test)
obj spec.initProvider.defaultRouteAction
fn withCorsPolicy(corsPolicy)
fn withCorsPolicyMixin(corsPolicy)
fn withFaultInjectionPolicy(faultInjectionPolicy)
fn withFaultInjectionPolicyMixin(faultInjectionPolicy)
fn withRequestMirrorPolicy(requestMirrorPolicy)
fn withRequestMirrorPolicyMixin(requestMirrorPolicy)
fn withRetryPolicy(retryPolicy)
fn withRetryPolicyMixin(retryPolicy)
fn withTimeout(timeout)
fn withTimeoutMixin(timeout)
fn withUrlRewrite(urlRewrite)
fn withUrlRewriteMixin(urlRewrite)
fn withWeightedBackendServices(weightedBackendServices)
fn withWeightedBackendServicesMixin(weightedBackendServices)
obj spec.initProvider.defaultRouteAction.corsPolicy
fn withAllowCredentials(allowCredentials)
fn withAllowHeaders(allowHeaders)
fn withAllowHeadersMixin(allowHeaders)
fn withAllowMethods(allowMethods)
fn withAllowMethodsMixin(allowMethods)
fn withAllowOriginRegexes(allowOriginRegexes)
fn withAllowOriginRegexesMixin(allowOriginRegexes)
fn withAllowOrigins(allowOrigins)
fn withAllowOriginsMixin(allowOrigins)
fn withDisabled(disabled)
fn withExposeHeaders(exposeHeaders)
fn withExposeHeadersMixin(exposeHeaders)
fn withMaxAge(maxAge)
obj spec.initProvider.defaultRouteAction.faultInjectionPolicy
obj spec.initProvider.defaultRouteAction.retryPolicy
obj spec.initProvider.defaultRouteAction.timeout
obj spec.initProvider.defaultRouteAction.urlRewrite
obj spec.initProvider.defaultRouteAction.weightedBackendServices
fn withHeaderAction(headerAction)
fn withHeaderActionMixin(headerAction)
fn withWeight(weight)
obj spec.initProvider.defaultRouteAction.weightedBackendServices.headerAction
fn withRequestHeadersToAdd(requestHeadersToAdd)
fn withRequestHeadersToAddMixin(requestHeadersToAdd)
fn withRequestHeadersToRemove(requestHeadersToRemove)
fn withRequestHeadersToRemoveMixin(requestHeadersToRemove)
fn withResponseHeadersToAdd(responseHeadersToAdd)
fn withResponseHeadersToAddMixin(responseHeadersToAdd)
fn withResponseHeadersToRemove(responseHeadersToRemove)
fn withResponseHeadersToRemoveMixin(responseHeadersToRemove)
obj spec.initProvider.defaultRouteAction.weightedBackendServices.headerAction.requestHeadersToAdd
obj spec.initProvider.defaultRouteAction.weightedBackendServices.headerAction.responseHeadersToAdd
obj spec.initProvider.defaultUrlRedirect
obj spec.initProvider.hostRule
obj spec.initProvider.pathMatcher
fn withDefaultUrlRedirect(defaultUrlRedirect)
fn withDefaultUrlRedirectMixin(defaultUrlRedirect)
fn withDescription(description)
fn withName(name)
fn withPathRule(pathRule)
fn withPathRuleMixin(pathRule)
fn withRouteRules(routeRules)
fn withRouteRulesMixin(routeRules)
obj spec.initProvider.pathMatcher.defaultUrlRedirect
obj spec.initProvider.pathMatcher.pathRule
fn withPaths(paths)
fn withPathsMixin(paths)
fn withRouteAction(routeAction)
fn withRouteActionMixin(routeAction)
fn withUrlRedirect(urlRedirect)
fn withUrlRedirectMixin(urlRedirect)
obj spec.initProvider.pathMatcher.pathRule.routeAction
fn withCorsPolicy(corsPolicy)
fn withCorsPolicyMixin(corsPolicy)
fn withFaultInjectionPolicy(faultInjectionPolicy)
fn withFaultInjectionPolicyMixin(faultInjectionPolicy)
fn withRequestMirrorPolicy(requestMirrorPolicy)
fn withRequestMirrorPolicyMixin(requestMirrorPolicy)
fn withRetryPolicy(retryPolicy)
fn withRetryPolicyMixin(retryPolicy)
fn withTimeout(timeout)
fn withTimeoutMixin(timeout)
fn withUrlRewrite(urlRewrite)
fn withUrlRewriteMixin(urlRewrite)
fn withWeightedBackendServices(weightedBackendServices)
fn withWeightedBackendServicesMixin(weightedBackendServices)
obj spec.initProvider.pathMatcher.pathRule.routeAction.corsPolicy
fn withAllowCredentials(allowCredentials)
fn withAllowHeaders(allowHeaders)
fn withAllowHeadersMixin(allowHeaders)
fn withAllowMethods(allowMethods)
fn withAllowMethodsMixin(allowMethods)
fn withAllowOriginRegexes(allowOriginRegexes)
fn withAllowOriginRegexesMixin(allowOriginRegexes)
fn withAllowOrigins(allowOrigins)
fn withAllowOriginsMixin(allowOrigins)
fn withDisabled(disabled)
fn withExposeHeaders(exposeHeaders)
fn withExposeHeadersMixin(exposeHeaders)
fn withMaxAge(maxAge)
obj spec.initProvider.pathMatcher.pathRule.routeAction.faultInjectionPolicy
obj spec.initProvider.pathMatcher.pathRule.routeAction.retryPolicy
obj spec.initProvider.pathMatcher.pathRule.routeAction.timeout
obj spec.initProvider.pathMatcher.pathRule.routeAction.urlRewrite
obj spec.initProvider.pathMatcher.pathRule.routeAction.weightedBackendServices
fn withHeaderAction(headerAction)
fn withHeaderActionMixin(headerAction)
fn withWeight(weight)
obj spec.initProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction
fn withRequestHeadersToAdd(requestHeadersToAdd)
fn withRequestHeadersToAddMixin(requestHeadersToAdd)
fn withRequestHeadersToRemove(requestHeadersToRemove)
fn withRequestHeadersToRemoveMixin(requestHeadersToRemove)
fn withResponseHeadersToAdd(responseHeadersToAdd)
fn withResponseHeadersToAddMixin(responseHeadersToAdd)
fn withResponseHeadersToRemove(responseHeadersToRemove)
fn withResponseHeadersToRemoveMixin(responseHeadersToRemove)
obj spec.initProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.requestHeadersToAdd
obj spec.initProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.responseHeadersToAdd
obj spec.initProvider.pathMatcher.pathRule.urlRedirect
obj spec.initProvider.pathMatcher.routeRules
fn withHeaderAction(headerAction)
fn withHeaderActionMixin(headerAction)
fn withMatchRules(matchRules)
fn withMatchRulesMixin(matchRules)
fn withPriority(priority)
fn withRouteAction(routeAction)
fn withRouteActionMixin(routeAction)
fn withUrlRedirect(urlRedirect)
fn withUrlRedirectMixin(urlRedirect)
obj spec.initProvider.pathMatcher.routeRules.headerAction
fn withRequestHeadersToAdd(requestHeadersToAdd)
fn withRequestHeadersToAddMixin(requestHeadersToAdd)
fn withRequestHeadersToRemove(requestHeadersToRemove)
fn withRequestHeadersToRemoveMixin(requestHeadersToRemove)
fn withResponseHeadersToAdd(responseHeadersToAdd)
fn withResponseHeadersToAddMixin(responseHeadersToAdd)
fn withResponseHeadersToRemove(responseHeadersToRemove)
fn withResponseHeadersToRemoveMixin(responseHeadersToRemove)
obj spec.initProvider.pathMatcher.routeRules.headerAction.requestHeadersToAdd
obj spec.initProvider.pathMatcher.routeRules.headerAction.responseHeadersToAdd
obj spec.initProvider.pathMatcher.routeRules.matchRules
fn withFullPathMatch(fullPathMatch)
fn withHeaderMatches(headerMatches)
fn withHeaderMatchesMixin(headerMatches)
fn withIgnoreCase(ignoreCase)
fn withMetadataFilters(metadataFilters)
fn withMetadataFiltersMixin(metadataFilters)
fn withPrefixMatch(prefixMatch)
fn withQueryParameterMatches(queryParameterMatches)
fn withQueryParameterMatchesMixin(queryParameterMatches)
fn withRegexMatch(regexMatch)
obj spec.initProvider.pathMatcher.routeRules.matchRules.headerMatches
fn withExactMatch(exactMatch)
fn withHeaderName(headerName)
fn withInvertMatch(invertMatch)
fn withPrefixMatch(prefixMatch)
fn withPresentMatch(presentMatch)
fn withRangeMatch(rangeMatch)
fn withRangeMatchMixin(rangeMatch)
fn withRegexMatch(regexMatch)
fn withSuffixMatch(suffixMatch)
obj spec.initProvider.pathMatcher.routeRules.matchRules.headerMatches.rangeMatch
obj spec.initProvider.pathMatcher.routeRules.matchRules.metadataFilters
obj spec.initProvider.pathMatcher.routeRules.matchRules.queryParameterMatches
obj spec.initProvider.pathMatcher.routeRules.routeAction
fn withCorsPolicy(corsPolicy)
fn withCorsPolicyMixin(corsPolicy)
fn withFaultInjectionPolicy(faultInjectionPolicy)
fn withFaultInjectionPolicyMixin(faultInjectionPolicy)
fn withRequestMirrorPolicy(requestMirrorPolicy)
fn withRequestMirrorPolicyMixin(requestMirrorPolicy)
fn withRetryPolicy(retryPolicy)
fn withRetryPolicyMixin(retryPolicy)
fn withTimeout(timeout)
fn withTimeoutMixin(timeout)
fn withUrlRewrite(urlRewrite)
fn withUrlRewriteMixin(urlRewrite)
fn withWeightedBackendServices(weightedBackendServices)
fn withWeightedBackendServicesMixin(weightedBackendServices)
obj spec.initProvider.pathMatcher.routeRules.routeAction.corsPolicy
fn withAllowCredentials(allowCredentials)
fn withAllowHeaders(allowHeaders)
fn withAllowHeadersMixin(allowHeaders)
fn withAllowMethods(allowMethods)
fn withAllowMethodsMixin(allowMethods)
fn withAllowOriginRegexes(allowOriginRegexes)
fn withAllowOriginRegexesMixin(allowOriginRegexes)
fn withAllowOrigins(allowOrigins)
fn withAllowOriginsMixin(allowOrigins)
fn withDisabled(disabled)
fn withExposeHeaders(exposeHeaders)
fn withExposeHeadersMixin(exposeHeaders)
fn withMaxAge(maxAge)
obj spec.initProvider.pathMatcher.routeRules.routeAction.faultInjectionPolicy
obj spec.initProvider.pathMatcher.routeRules.routeAction.requestMirrorPolicy
obj spec.initProvider.pathMatcher.routeRules.routeAction.retryPolicy
obj spec.initProvider.pathMatcher.routeRules.routeAction.timeout
obj spec.initProvider.pathMatcher.routeRules.routeAction.urlRewrite
obj spec.initProvider.pathMatcher.routeRules.routeAction.weightedBackendServices
fn withBackendService(backendService)
fn withHeaderAction(headerAction)
fn withHeaderActionMixin(headerAction)
fn withWeight(weight)
obj spec.initProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction
fn withRequestHeadersToAdd(requestHeadersToAdd)
fn withRequestHeadersToAddMixin(requestHeadersToAdd)
fn withRequestHeadersToRemove(requestHeadersToRemove)
fn withRequestHeadersToRemoveMixin(requestHeadersToRemove)
fn withResponseHeadersToAdd(responseHeadersToAdd)
fn withResponseHeadersToAddMixin(responseHeadersToAdd)
fn withResponseHeadersToRemove(responseHeadersToRemove)
fn withResponseHeadersToRemoveMixin(responseHeadersToRemove)
obj spec.initProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.requestHeadersToAdd
obj spec.initProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.responseHeadersToAdd
obj spec.initProvider.pathMatcher.routeRules.urlRedirect
obj spec.initProvider.test
obj spec.providerConfigRef
obj spec.providerRef
obj spec.publishConnectionDetailsTo
obj spec.writeConnectionSecretToRef
Fields
fn new
new(name)
new returns an instance of RegionURLMap
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
"RegionURLMapSpec defines the desired state of RegionURLMap"
fn spec.withDeletionPolicy
withDeletionPolicy(deletionPolicy)
"DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either \"Delete\" or \"Orphan\" the external resource. This field is planned to be deprecated in favor of the ManagementPolicies field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223"
fn spec.withManagementPolicies
withManagementPolicies(managementPolicies)
"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md"
fn spec.withManagementPoliciesMixin
withManagementPoliciesMixin(managementPolicies)
"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md"
Note: This function appends passed data to existing values
obj spec.forProvider
fn spec.forProvider.withDefaultRouteAction
withDefaultRouteAction(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. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below."
fn spec.forProvider.withDefaultRouteActionMixin
withDefaultRouteActionMixin(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. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.withDefaultService
withDefaultService(defaultService)
"The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set."
fn spec.forProvider.withDefaultUrlRedirect
withDefaultUrlRedirect(defaultUrlRedirect)
"When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below."
fn spec.forProvider.withDefaultUrlRedirectMixin
withDefaultUrlRedirectMixin(defaultUrlRedirect)
"When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.withDescription
withDescription(description)
"An optional description of this resource. Provide this property when you create the resource."
fn spec.forProvider.withHostRule
withHostRule(hostRule)
"The list of HostRules to use against the URL. Structure is documented below."
fn spec.forProvider.withHostRuleMixin
withHostRuleMixin(hostRule)
"The list of HostRules to use against the URL. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.withPathMatcher
withPathMatcher(pathMatcher)
"The list of named PathMatchers to use against the URL. Structure is documented below."
fn spec.forProvider.withPathMatcherMixin
withPathMatcherMixin(pathMatcher)
"The list of named PathMatchers to use against the URL. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.withProject
withProject(project)
"The ID of the project in which the resource belongs. If it is not provided, the provider project is used."
fn spec.forProvider.withRegion
withRegion(region)
"The Region in which the url map should reside. If it is not provided, the provider region is used."
fn spec.forProvider.withTest
withTest(test)
"The list of expected URL mappings. Requests to update this UrlMap will succeed only if all of the test cases pass. Structure is documented below."
fn spec.forProvider.withTestMixin
withTestMixin(test)
"The list of expected URL mappings. Requests to update this UrlMap will succeed only if all of the test cases pass. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.forProvider.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. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below."
fn spec.forProvider.defaultRouteAction.withCorsPolicy
withCorsPolicy(corsPolicy)
"The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below."
fn spec.forProvider.defaultRouteAction.withCorsPolicyMixin
withCorsPolicyMixin(corsPolicy)
"The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.defaultRouteAction.withFaultInjectionPolicy
withFaultInjectionPolicy(faultInjectionPolicy)
"The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As 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. Similarly requests from clients can be aborted by the load balancer for a percentage of requests. timeout 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. Fault 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. Structure is documented below."
fn spec.forProvider.defaultRouteAction.withFaultInjectionPolicyMixin
withFaultInjectionPolicyMixin(faultInjectionPolicy)
"The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As 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. Similarly requests from clients can be aborted by the load balancer for a percentage of requests. timeout 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. Fault 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. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.defaultRouteAction.withRequestMirrorPolicy
withRequestMirrorPolicy(requestMirrorPolicy)
"Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The 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. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below."
fn spec.forProvider.defaultRouteAction.withRequestMirrorPolicyMixin
withRequestMirrorPolicyMixin(requestMirrorPolicy)
"Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The 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. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.defaultRouteAction.withRetryPolicy
withRetryPolicy(retryPolicy)
"Specifies the retry policy associated with this route. Structure is documented below."
fn spec.forProvider.defaultRouteAction.withRetryPolicyMixin
withRetryPolicyMixin(retryPolicy)
"Specifies the retry policy associated with this route. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.defaultRouteAction.withTimeout
withTimeout(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. If not specified, this field uses the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true. Structure is documented below."
fn spec.forProvider.defaultRouteAction.withTimeoutMixin
withTimeoutMixin(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. If not specified, this field uses the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.defaultRouteAction.withUrlRewrite
withUrlRewrite(urlRewrite)
"The spec to modify the URL of the request, before forwarding the request to the matched service. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below."
fn spec.forProvider.defaultRouteAction.withUrlRewriteMixin
withUrlRewriteMixin(urlRewrite)
"The spec to modify the URL of the request, before forwarding the request to the matched service. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.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. After 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. Structure is documented below."
fn spec.forProvider.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. After 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. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.forProvider.defaultRouteAction.corsPolicy
"The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below."
fn spec.forProvider.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 translates to the Access- Control-Allow-Credentials header. Defaults to false."
fn spec.forProvider.defaultRouteAction.corsPolicy.withAllowHeaders
withAllowHeaders(allowHeaders)
"Specifies the content for the Access-Control-Allow-Headers header."
fn spec.forProvider.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.forProvider.defaultRouteAction.corsPolicy.withAllowMethods
withAllowMethods(allowMethods)
"Specifies the content for the Access-Control-Allow-Methods header."
fn spec.forProvider.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.forProvider.defaultRouteAction.corsPolicy.withAllowOriginRegexes
withAllowOriginRegexes(allowOriginRegexes)
"Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either allow_origins or allow_origin_regex."
fn spec.forProvider.defaultRouteAction.corsPolicy.withAllowOriginRegexesMixin
withAllowOriginRegexesMixin(allowOriginRegexes)
"Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either allow_origins or allow_origin_regex."
Note: This function appends passed data to existing values
fn spec.forProvider.defaultRouteAction.corsPolicy.withAllowOrigins
withAllowOrigins(allowOrigins)
"Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either allow_origins or allow_origin_regex."
fn spec.forProvider.defaultRouteAction.corsPolicy.withAllowOriginsMixin
withAllowOriginsMixin(allowOrigins)
"Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either allow_origins or allow_origin_regex."
Note: This function appends passed data to existing values
fn spec.forProvider.defaultRouteAction.corsPolicy.withDisabled
withDisabled(disabled)
"If true, specifies the CORS policy is disabled. which indicates that the CORS policy is in effect. Defaults to false."
fn spec.forProvider.defaultRouteAction.corsPolicy.withExposeHeaders
withExposeHeaders(exposeHeaders)
"Specifies the content for the Access-Control-Expose-Headers header."
fn spec.forProvider.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.forProvider.defaultRouteAction.corsPolicy.withMaxAge
withMaxAge(maxAge)
"Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header."
obj spec.forProvider.defaultRouteAction.faultInjectionPolicy
"The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As 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. Similarly requests from clients can be aborted by the load balancer for a percentage of requests. timeout 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. Fault 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. Structure is documented below."
fn spec.forProvider.defaultRouteAction.faultInjectionPolicy.withAbort
withAbort(abort)
"The specification for how client requests are aborted as part of fault injection. Structure is documented below."
fn spec.forProvider.defaultRouteAction.faultInjectionPolicy.withAbortMixin
withAbortMixin(abort)
"The specification for how client requests are aborted as part of fault injection. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.defaultRouteAction.faultInjectionPolicy.withDelay
withDelay(delay)
"The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below."
fn spec.forProvider.defaultRouteAction.faultInjectionPolicy.withDelayMixin
withDelayMixin(delay)
"The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.forProvider.defaultRouteAction.faultInjectionPolicy.abort
"The specification for how client requests are aborted as part of fault injection. Structure is documented below."
fn spec.forProvider.defaultRouteAction.faultInjectionPolicy.abort.withHttpStatus
withHttpStatus(httpStatus)
"The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive."
fn spec.forProvider.defaultRouteAction.faultInjectionPolicy.abort.withPercentage
withPercentage(percentage)
"The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive."
obj spec.forProvider.defaultRouteAction.faultInjectionPolicy.delay
"The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below."
fn spec.forProvider.defaultRouteAction.faultInjectionPolicy.delay.withFixedDelay
withFixedDelay(fixedDelay)
"Specifies the value of the fixed delay interval. Structure is documented below."
fn spec.forProvider.defaultRouteAction.faultInjectionPolicy.delay.withFixedDelayMixin
withFixedDelayMixin(fixedDelay)
"Specifies the value of the fixed delay interval. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.defaultRouteAction.faultInjectionPolicy.delay.withPercentage
withPercentage(percentage)
"The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive."
obj spec.forProvider.defaultRouteAction.faultInjectionPolicy.delay.fixedDelay
"Specifies the value of the fixed delay interval. Structure is documented below."
fn spec.forProvider.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 represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive."
fn spec.forProvider.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."
obj spec.forProvider.defaultRouteAction.requestMirrorPolicy
"Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The 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. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below."
fn spec.forProvider.defaultRouteAction.requestMirrorPolicy.withBackendService
withBackendService(backendService)
"The default RegionBackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight."
obj spec.forProvider.defaultRouteAction.requestMirrorPolicy.backendServiceRef
"Reference to a RegionBackendService in compute to populate backendService."
fn spec.forProvider.defaultRouteAction.requestMirrorPolicy.backendServiceRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.defaultRouteAction.requestMirrorPolicy.backendServiceRef.policy
"Policies for referencing."
fn spec.forProvider.defaultRouteAction.requestMirrorPolicy.backendServiceRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.defaultRouteAction.requestMirrorPolicy.backendServiceRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.defaultRouteAction.requestMirrorPolicy.backendServiceSelector
"Selector for a RegionBackendService in compute to populate backendService."
fn spec.forProvider.defaultRouteAction.requestMirrorPolicy.backendServiceSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.defaultRouteAction.requestMirrorPolicy.backendServiceSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.defaultRouteAction.requestMirrorPolicy.backendServiceSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.defaultRouteAction.requestMirrorPolicy.backendServiceSelector.policy
"Policies for selection."
fn spec.forProvider.defaultRouteAction.requestMirrorPolicy.backendServiceSelector.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.defaultRouteAction.requestMirrorPolicy.backendServiceSelector.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.defaultRouteAction.retryPolicy
"Specifies the retry policy associated with this route. Structure is documented below."
fn spec.forProvider.defaultRouteAction.retryPolicy.withNumRetries
withNumRetries(numRetries)
"Specifies the allowed number retries. This number must be > 0."
fn spec.forProvider.defaultRouteAction.retryPolicy.withPerTryTimeout
withPerTryTimeout(perTryTimeout)
"Specifies a non-zero timeout per retry attempt. Structure is documented below."
fn spec.forProvider.defaultRouteAction.retryPolicy.withPerTryTimeoutMixin
withPerTryTimeoutMixin(perTryTimeout)
"Specifies a non-zero timeout per retry attempt. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.defaultRouteAction.retryPolicy.withRetryConditions
withRetryConditions(retryConditions)
"Specifies one or more conditions when this retry rule applies. Valid values are:"
fn spec.forProvider.defaultRouteAction.retryPolicy.withRetryConditionsMixin
withRetryConditionsMixin(retryConditions)
"Specifies one or more conditions when this retry rule applies. Valid values are:"
Note: This function appends passed data to existing values
obj spec.forProvider.defaultRouteAction.retryPolicy.perTryTimeout
"Specifies a non-zero timeout per retry attempt. Structure is documented below."
fn spec.forProvider.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 represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive."
fn spec.forProvider.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."
obj spec.forProvider.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. If not specified, this field uses the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true. Structure is documented below."
fn spec.forProvider.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.forProvider.defaultRouteAction.timeout.withSeconds
withSeconds(seconds)
"Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive."
obj spec.forProvider.defaultRouteAction.urlRewrite
"The spec to modify the URL of the request, before forwarding the request to the matched service. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below."
fn spec.forProvider.defaultRouteAction.urlRewrite.withHostRewrite
withHostRewrite(hostRewrite)
"Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters."
fn spec.forProvider.defaultRouteAction.urlRewrite.withPathPrefixRewrite
withPathPrefixRewrite(pathPrefixRewrite)
"Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters."
obj spec.forProvider.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. After 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. Structure is documented below."
fn spec.forProvider.defaultRouteAction.weightedBackendServices.withBackendService
withBackendService(backendService)
"The default RegionBackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight."
fn spec.forProvider.defaultRouteAction.weightedBackendServices.withHeaderAction
withHeaderAction(headerAction)
"Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below."
fn spec.forProvider.defaultRouteAction.weightedBackendServices.withHeaderActionMixin
withHeaderActionMixin(headerAction)
"Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.defaultRouteAction.weightedBackendServices.withWeight
withWeight(weight)
"Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. The value must be between 0 and 1000"
obj spec.forProvider.defaultRouteAction.weightedBackendServices.backendServiceRef
"Reference to a RegionBackendService in compute to populate backendService."
fn spec.forProvider.defaultRouteAction.weightedBackendServices.backendServiceRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.defaultRouteAction.weightedBackendServices.backendServiceRef.policy
"Policies for referencing."
fn spec.forProvider.defaultRouteAction.weightedBackendServices.backendServiceRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.defaultRouteAction.weightedBackendServices.backendServiceRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.defaultRouteAction.weightedBackendServices.backendServiceSelector
"Selector for a RegionBackendService in compute to populate backendService."
fn spec.forProvider.defaultRouteAction.weightedBackendServices.backendServiceSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.defaultRouteAction.weightedBackendServices.backendServiceSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.defaultRouteAction.weightedBackendServices.backendServiceSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.defaultRouteAction.weightedBackendServices.backendServiceSelector.policy
"Policies for selection."
fn spec.forProvider.defaultRouteAction.weightedBackendServices.backendServiceSelector.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.defaultRouteAction.weightedBackendServices.backendServiceSelector.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.defaultRouteAction.weightedBackendServices.headerAction
"Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below."
fn spec.forProvider.defaultRouteAction.weightedBackendServices.headerAction.withRequestHeadersToAdd
withRequestHeadersToAdd(requestHeadersToAdd)
"Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below."
fn spec.forProvider.defaultRouteAction.weightedBackendServices.headerAction.withRequestHeadersToAddMixin
withRequestHeadersToAddMixin(requestHeadersToAdd)
"Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.defaultRouteAction.weightedBackendServices.headerAction.withRequestHeadersToRemove
withRequestHeadersToRemove(requestHeadersToRemove)
"A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService."
fn spec.forProvider.defaultRouteAction.weightedBackendServices.headerAction.withRequestHeadersToRemoveMixin
withRequestHeadersToRemoveMixin(requestHeadersToRemove)
"A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService."
Note: This function appends passed data to existing values
fn spec.forProvider.defaultRouteAction.weightedBackendServices.headerAction.withResponseHeadersToAdd
withResponseHeadersToAdd(responseHeadersToAdd)
"Headers to add the response prior to sending the response back to the client. Structure is documented below."
fn spec.forProvider.defaultRouteAction.weightedBackendServices.headerAction.withResponseHeadersToAddMixin
withResponseHeadersToAddMixin(responseHeadersToAdd)
"Headers to add the response prior to sending the response back to the client. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.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 response back to the client."
fn spec.forProvider.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 response back to the client."
Note: This function appends passed data to existing values
obj spec.forProvider.defaultRouteAction.weightedBackendServices.headerAction.requestHeadersToAdd
"Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below."
fn spec.forProvider.defaultRouteAction.weightedBackendServices.headerAction.requestHeadersToAdd.withHeaderName
withHeaderName(headerName)
"The name of the header."
fn spec.forProvider.defaultRouteAction.weightedBackendServices.headerAction.requestHeadersToAdd.withHeaderValue
withHeaderValue(headerValue)
"The value of the header to add."
fn spec.forProvider.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."
obj spec.forProvider.defaultRouteAction.weightedBackendServices.headerAction.responseHeadersToAdd
"Headers to add the response prior to sending the response back to the client. Structure is documented below."
fn spec.forProvider.defaultRouteAction.weightedBackendServices.headerAction.responseHeadersToAdd.withHeaderName
withHeaderName(headerName)
"The name of the header."
fn spec.forProvider.defaultRouteAction.weightedBackendServices.headerAction.responseHeadersToAdd.withHeaderValue
withHeaderValue(headerValue)
"The value of the header to add."
fn spec.forProvider.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."
obj spec.forProvider.defaultServiceRef
"Reference to a RegionBackendService in compute to populate defaultService."
fn spec.forProvider.defaultServiceRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.defaultServiceRef.policy
"Policies for referencing."
fn spec.forProvider.defaultServiceRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.defaultServiceRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.defaultServiceSelector
"Selector for a RegionBackendService in compute to populate defaultService."
fn spec.forProvider.defaultServiceSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.defaultServiceSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.defaultServiceSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.defaultServiceSelector.policy
"Policies for selection."
fn spec.forProvider.defaultServiceSelector.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.defaultServiceSelector.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.defaultUrlRedirect
"When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below."
fn spec.forProvider.defaultUrlRedirect.withHostRedirect
withHostRedirect(hostRedirect)
"The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters."
fn spec.forProvider.defaultUrlRedirect.withHttpsRedirect
withHttpsRedirect(httpsRedirect)
"If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false."
fn spec.forProvider.defaultUrlRedirect.withPathRedirect
withPathRedirect(pathRedirect)
"The path that will be used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters."
fn spec.forProvider.defaultUrlRedirect.withPrefixRedirect
withPrefixRedirect(prefixRedirect)
"The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters."
fn spec.forProvider.defaultUrlRedirect.withRedirectResponseCode
withRedirectResponseCode(redirectResponseCode)
"The HTTP Status code to use for this RedirectAction. Supported values are:"
fn spec.forProvider.defaultUrlRedirect.withStripQuery
withStripQuery(stripQuery)
"If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. This field is required to ensure an empty block is not set. The normal default value is false."
obj spec.forProvider.hostRule
"The list of HostRules to use against the URL. Structure is documented below."
fn spec.forProvider.hostRule.withDescription
withDescription(description)
"An optional description of this HostRule. Provide this property when you create the resource."
fn spec.forProvider.hostRule.withHosts
withHosts(hosts)
"The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or .."
fn spec.forProvider.hostRule.withHostsMixin
withHostsMixin(hosts)
"The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or .."
Note: This function appends passed data to existing values
fn spec.forProvider.hostRule.withPathMatcher
withPathMatcher(pathMatcher)
"The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion."
obj spec.forProvider.pathMatcher
"The list of named PathMatchers to use against the URL. Structure is documented below."
fn spec.forProvider.pathMatcher.withDefaultService
withDefaultService(defaultService)
"A reference to a RegionBackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion."
fn spec.forProvider.pathMatcher.withDefaultUrlRedirect
withDefaultUrlRedirect(defaultUrlRedirect)
"When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below."
fn spec.forProvider.pathMatcher.withDefaultUrlRedirectMixin
withDefaultUrlRedirectMixin(defaultUrlRedirect)
"When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.withDescription
withDescription(description)
"An optional description of this resource."
fn spec.forProvider.pathMatcher.withName
withName(name)
"The name to which this PathMatcher is referred by the HostRule."
fn spec.forProvider.pathMatcher.withPathRule
withPathRule(pathRule)
"The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/ will match before /a/b/ irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set. Structure is documented below."
fn spec.forProvider.pathMatcher.withPathRuleMixin
withPathRuleMixin(pathRule)
"The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/ will match before /a/b/ irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.withRouteRules
withRouteRules(routeRules)
"The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. Within a given pathMatcher, only one of pathRules or routeRules must be set. routeRules are not supported in UrlMaps intended for External load balancers. Structure is documented below."
fn spec.forProvider.pathMatcher.withRouteRulesMixin
withRouteRulesMixin(routeRules)
"The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. Within a given pathMatcher, only one of pathRules or routeRules must be set. routeRules are not supported in UrlMaps intended for External load balancers. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.forProvider.pathMatcher.defaultServiceRef
"Reference to a RegionBackendService in compute to populate defaultService."
fn spec.forProvider.pathMatcher.defaultServiceRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.pathMatcher.defaultServiceRef.policy
"Policies for referencing."
fn spec.forProvider.pathMatcher.defaultServiceRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.pathMatcher.defaultServiceRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.pathMatcher.defaultServiceSelector
"Selector for a RegionBackendService in compute to populate defaultService."
fn spec.forProvider.pathMatcher.defaultServiceSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.pathMatcher.defaultServiceSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.pathMatcher.defaultServiceSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.pathMatcher.defaultServiceSelector.policy
"Policies for selection."
fn spec.forProvider.pathMatcher.defaultServiceSelector.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.pathMatcher.defaultServiceSelector.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.pathMatcher.defaultUrlRedirect
"When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below."
fn spec.forProvider.pathMatcher.defaultUrlRedirect.withHostRedirect
withHostRedirect(hostRedirect)
"The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters."
fn spec.forProvider.pathMatcher.defaultUrlRedirect.withHttpsRedirect
withHttpsRedirect(httpsRedirect)
"If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false."
fn spec.forProvider.pathMatcher.defaultUrlRedirect.withPathRedirect
withPathRedirect(pathRedirect)
"The path that will be used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters."
fn spec.forProvider.pathMatcher.defaultUrlRedirect.withPrefixRedirect
withPrefixRedirect(prefixRedirect)
"The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters."
fn spec.forProvider.pathMatcher.defaultUrlRedirect.withRedirectResponseCode
withRedirectResponseCode(redirectResponseCode)
"The HTTP Status code to use for this RedirectAction. Supported values are:"
fn spec.forProvider.pathMatcher.defaultUrlRedirect.withStripQuery
withStripQuery(stripQuery)
"If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default value is false."
obj spec.forProvider.pathMatcher.pathRule
"The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/ will match before /a/b/ irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set. Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.withPaths
withPaths(paths)
"The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here."
fn spec.forProvider.pathMatcher.pathRule.withPathsMixin
withPathsMixin(paths)
"The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.pathRule.withRouteAction
withRouteAction(routeAction)
"In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.withRouteActionMixin
withRouteActionMixin(routeAction)
"In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.pathRule.withService
withService(service)
"A reference to expected RegionBackendService resource the given URL should be mapped to."
fn spec.forProvider.pathMatcher.pathRule.withUrlRedirect
withUrlRedirect(urlRedirect)
"When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.withUrlRedirectMixin
withUrlRedirectMixin(urlRedirect)
"When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.forProvider.pathMatcher.pathRule.routeAction
"In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.routeAction.withCorsPolicy
withCorsPolicy(corsPolicy)
"The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.routeAction.withCorsPolicyMixin
withCorsPolicyMixin(corsPolicy)
"The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.pathRule.routeAction.withFaultInjectionPolicy
withFaultInjectionPolicy(faultInjectionPolicy)
"The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.routeAction.withFaultInjectionPolicyMixin
withFaultInjectionPolicyMixin(faultInjectionPolicy)
"The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.pathRule.routeAction.withRequestMirrorPolicy
withRequestMirrorPolicy(requestMirrorPolicy)
"Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.routeAction.withRequestMirrorPolicyMixin
withRequestMirrorPolicyMixin(requestMirrorPolicy)
"Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.pathRule.routeAction.withRetryPolicy
withRetryPolicy(retryPolicy)
"Specifies the retry policy associated with this route. Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.routeAction.withRetryPolicyMixin
withRetryPolicyMixin(retryPolicy)
"Specifies the retry policy associated with this route. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.pathRule.routeAction.withTimeout
withTimeout(timeout)
"Specifies the timeout for the selected route. Timeout is computed from the time the request is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, the default value is 15 seconds. Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.routeAction.withTimeoutMixin
withTimeoutMixin(timeout)
"Specifies the timeout for the selected route. Timeout is computed from the time the request is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, the default value is 15 seconds. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.pathRule.routeAction.withUrlRewrite
withUrlRewrite(urlRewrite)
"The spec to modify the URL of the request, prior to forwarding the request to the matched service Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.routeAction.withUrlRewriteMixin
withUrlRewriteMixin(urlRewrite)
"The spec to modify the URL of the request, prior to forwarding the request to the matched service Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.pathRule.routeAction.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 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.routeAction.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 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.forProvider.pathMatcher.pathRule.routeAction.corsPolicy
"The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.routeAction.corsPolicy.withAllowCredentials
withAllowCredentials(allowCredentials)
"In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access- Control-Allow-Credentials header. Defaults to false."
fn spec.forProvider.pathMatcher.pathRule.routeAction.corsPolicy.withAllowHeaders
withAllowHeaders(allowHeaders)
"Specifies the content for the Access-Control-Allow-Headers header."
fn spec.forProvider.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.forProvider.pathMatcher.pathRule.routeAction.corsPolicy.withAllowMethods
withAllowMethods(allowMethods)
"Specifies the content for the Access-Control-Allow-Methods header."
fn spec.forProvider.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.forProvider.pathMatcher.pathRule.routeAction.corsPolicy.withAllowOriginRegexes
withAllowOriginRegexes(allowOriginRegexes)
"Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either allow_origins or allow_origin_regex."
fn spec.forProvider.pathMatcher.pathRule.routeAction.corsPolicy.withAllowOriginRegexesMixin
withAllowOriginRegexesMixin(allowOriginRegexes)
"Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either allow_origins or allow_origin_regex."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.pathRule.routeAction.corsPolicy.withAllowOrigins
withAllowOrigins(allowOrigins)
"Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either allow_origins or allow_origin_regex."
fn spec.forProvider.pathMatcher.pathRule.routeAction.corsPolicy.withAllowOriginsMixin
withAllowOriginsMixin(allowOrigins)
"Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either allow_origins or allow_origin_regex."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.pathRule.routeAction.corsPolicy.withDisabled
withDisabled(disabled)
"If true, specifies the CORS policy is disabled. which indicates that the CORS policy is in effect. Defaults to false."
fn spec.forProvider.pathMatcher.pathRule.routeAction.corsPolicy.withExposeHeaders
withExposeHeaders(exposeHeaders)
"Specifies the content for the Access-Control-Expose-Headers header."
fn spec.forProvider.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.forProvider.pathMatcher.pathRule.routeAction.corsPolicy.withMaxAge
withMaxAge(maxAge)
"Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header."
obj spec.forProvider.pathMatcher.pathRule.routeAction.faultInjectionPolicy
"The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.routeAction.faultInjectionPolicy.withAbort
withAbort(abort)
"The specification for how client requests are aborted as part of fault injection. Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.routeAction.faultInjectionPolicy.withAbortMixin
withAbortMixin(abort)
"The specification for how client requests are aborted as part of fault injection. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.pathRule.routeAction.faultInjectionPolicy.withDelay
withDelay(delay)
"The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.routeAction.faultInjectionPolicy.withDelayMixin
withDelayMixin(delay)
"The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.forProvider.pathMatcher.pathRule.routeAction.faultInjectionPolicy.abort
"The specification for how client requests are aborted as part of fault injection. Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.routeAction.faultInjectionPolicy.abort.withHttpStatus
withHttpStatus(httpStatus)
"The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive."
fn spec.forProvider.pathMatcher.pathRule.routeAction.faultInjectionPolicy.abort.withPercentage
withPercentage(percentage)
"The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive."
obj spec.forProvider.pathMatcher.pathRule.routeAction.faultInjectionPolicy.delay
"The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.routeAction.faultInjectionPolicy.delay.withFixedDelay
withFixedDelay(fixedDelay)
"Specifies the value of the fixed delay interval. Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.routeAction.faultInjectionPolicy.delay.withFixedDelayMixin
withFixedDelayMixin(fixedDelay)
"Specifies the value of the fixed delay interval. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.pathRule.routeAction.faultInjectionPolicy.delay.withPercentage
withPercentage(percentage)
"The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive."
obj spec.forProvider.pathMatcher.pathRule.routeAction.faultInjectionPolicy.delay.fixedDelay
"Specifies the value of the fixed delay interval. Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.routeAction.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 represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive."
fn spec.forProvider.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 inclusive."
obj spec.forProvider.pathMatcher.pathRule.routeAction.requestMirrorPolicy
"Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.routeAction.requestMirrorPolicy.withBackendService
withBackendService(backendService)
"The default RegionBackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight."
obj spec.forProvider.pathMatcher.pathRule.routeAction.requestMirrorPolicy.backendServiceRef
"Reference to a RegionBackendService in compute to populate backendService."
fn spec.forProvider.pathMatcher.pathRule.routeAction.requestMirrorPolicy.backendServiceRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.pathMatcher.pathRule.routeAction.requestMirrorPolicy.backendServiceRef.policy
"Policies for referencing."
fn spec.forProvider.pathMatcher.pathRule.routeAction.requestMirrorPolicy.backendServiceRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.pathMatcher.pathRule.routeAction.requestMirrorPolicy.backendServiceRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.pathMatcher.pathRule.routeAction.requestMirrorPolicy.backendServiceSelector
"Selector for a RegionBackendService in compute to populate backendService."
fn spec.forProvider.pathMatcher.pathRule.routeAction.requestMirrorPolicy.backendServiceSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.pathMatcher.pathRule.routeAction.requestMirrorPolicy.backendServiceSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.pathMatcher.pathRule.routeAction.requestMirrorPolicy.backendServiceSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.pathMatcher.pathRule.routeAction.requestMirrorPolicy.backendServiceSelector.policy
"Policies for selection."
fn spec.forProvider.pathMatcher.pathRule.routeAction.requestMirrorPolicy.backendServiceSelector.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.pathMatcher.pathRule.routeAction.requestMirrorPolicy.backendServiceSelector.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.pathMatcher.pathRule.routeAction.retryPolicy
"Specifies the retry policy associated with this route. Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.routeAction.retryPolicy.withNumRetries
withNumRetries(numRetries)
"Specifies the allowed number retries. This number must be > 0."
fn spec.forProvider.pathMatcher.pathRule.routeAction.retryPolicy.withPerTryTimeout
withPerTryTimeout(perTryTimeout)
"Specifies a non-zero timeout per retry attempt. Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.routeAction.retryPolicy.withPerTryTimeoutMixin
withPerTryTimeoutMixin(perTryTimeout)
"Specifies a non-zero timeout per retry attempt. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.pathRule.routeAction.retryPolicy.withRetryConditions
withRetryConditions(retryConditions)
"Specifies one or more conditions when this retry rule applies. Valid values are:"
fn spec.forProvider.pathMatcher.pathRule.routeAction.retryPolicy.withRetryConditionsMixin
withRetryConditionsMixin(retryConditions)
"Specifies one or more conditions when this retry rule applies. Valid values are:"
Note: This function appends passed data to existing values
obj spec.forProvider.pathMatcher.pathRule.routeAction.retryPolicy.perTryTimeout
"Specifies a non-zero timeout per retry attempt. Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.routeAction.retryPolicy.perTryTimeout.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.forProvider.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 inclusive."
obj spec.forProvider.pathMatcher.pathRule.routeAction.timeout
"Specifies the timeout for the selected route. Timeout is computed from the time the request is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, the default value is 15 seconds. Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.routeAction.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.forProvider.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 inclusive."
obj spec.forProvider.pathMatcher.pathRule.routeAction.urlRewrite
"The spec to modify the URL of the request, prior to forwarding the request to the matched service Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.routeAction.urlRewrite.withHostRewrite
withHostRewrite(hostRewrite)
"Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters."
fn spec.forProvider.pathMatcher.pathRule.routeAction.urlRewrite.withPathPrefixRewrite
withPathPrefixRewrite(pathPrefixRewrite)
"Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters."
obj spec.forProvider.pathMatcher.pathRule.routeAction.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 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.withBackendService
withBackendService(backendService)
"The default RegionBackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight."
fn spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.withHeaderAction
withHeaderAction(headerAction)
"Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.withHeaderActionMixin
withHeaderActionMixin(headerAction)
"Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.withWeight
withWeight(weight)
"Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. The value must be between 0 and 1000"
obj spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.backendServiceRef
"Reference to a RegionBackendService in compute to populate backendService."
fn spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.backendServiceRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.backendServiceRef.policy
"Policies for referencing."
fn spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.backendServiceRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.backendServiceRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.backendServiceSelector
"Selector for a RegionBackendService in compute to populate backendService."
fn spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.backendServiceSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.backendServiceSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.backendServiceSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.backendServiceSelector.policy
"Policies for selection."
fn spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.backendServiceSelector.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.backendServiceSelector.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction
"Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.withRequestHeadersToAdd
withRequestHeadersToAdd(requestHeadersToAdd)
"Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.withRequestHeadersToAddMixin
withRequestHeadersToAddMixin(requestHeadersToAdd)
"Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.withRequestHeadersToRemove
withRequestHeadersToRemove(requestHeadersToRemove)
"A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService."
fn spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.withRequestHeadersToRemoveMixin
withRequestHeadersToRemoveMixin(requestHeadersToRemove)
"A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.withResponseHeadersToAdd
withResponseHeadersToAdd(responseHeadersToAdd)
"Headers to add the response prior to sending the response back to the client. Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.withResponseHeadersToAddMixin
withResponseHeadersToAddMixin(responseHeadersToAdd)
"Headers to add the response prior to sending the response back to the client. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.withResponseHeadersToRemove
withResponseHeadersToRemove(responseHeadersToRemove)
"A list of header names for headers that need to be removed from the response prior to sending the response back to the client."
fn spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.withResponseHeadersToRemoveMixin
withResponseHeadersToRemoveMixin(responseHeadersToRemove)
"A list of header names for headers that need to be removed from the response prior to sending the response back to the client."
Note: This function appends passed data to existing values
obj spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.requestHeadersToAdd
"Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.requestHeadersToAdd.withHeaderName
withHeaderName(headerName)
"The name of the header."
fn spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.requestHeadersToAdd.withHeaderValue
withHeaderValue(headerValue)
"The value of the header to add."
fn spec.forProvider.pathMatcher.pathRule.routeAction.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."
obj spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.responseHeadersToAdd
"Headers to add the response prior to sending the response back to the client. Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.responseHeadersToAdd.withHeaderName
withHeaderName(headerName)
"The name of the header."
fn spec.forProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.responseHeadersToAdd.withHeaderValue
withHeaderValue(headerValue)
"The value of the header to add."
fn spec.forProvider.pathMatcher.pathRule.routeAction.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."
obj spec.forProvider.pathMatcher.pathRule.serviceRef
"Reference to a RegionBackendService in compute to populate service."
fn spec.forProvider.pathMatcher.pathRule.serviceRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.pathMatcher.pathRule.serviceRef.policy
"Policies for referencing."
fn spec.forProvider.pathMatcher.pathRule.serviceRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.pathMatcher.pathRule.serviceRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.pathMatcher.pathRule.serviceSelector
"Selector for a RegionBackendService in compute to populate service."
fn spec.forProvider.pathMatcher.pathRule.serviceSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.pathMatcher.pathRule.serviceSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.pathMatcher.pathRule.serviceSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.pathMatcher.pathRule.serviceSelector.policy
"Policies for selection."
fn spec.forProvider.pathMatcher.pathRule.serviceSelector.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.pathMatcher.pathRule.serviceSelector.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.pathMatcher.pathRule.urlRedirect
"When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Structure is documented below."
fn spec.forProvider.pathMatcher.pathRule.urlRedirect.withHostRedirect
withHostRedirect(hostRedirect)
"The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters."
fn spec.forProvider.pathMatcher.pathRule.urlRedirect.withHttpsRedirect
withHttpsRedirect(httpsRedirect)
"If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false."
fn spec.forProvider.pathMatcher.pathRule.urlRedirect.withPathRedirect
withPathRedirect(pathRedirect)
"The path that will be used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters."
fn spec.forProvider.pathMatcher.pathRule.urlRedirect.withPrefixRedirect
withPrefixRedirect(prefixRedirect)
"The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters."
fn spec.forProvider.pathMatcher.pathRule.urlRedirect.withRedirectResponseCode
withRedirectResponseCode(redirectResponseCode)
"The HTTP Status code to use for this RedirectAction. Supported values are:"
fn spec.forProvider.pathMatcher.pathRule.urlRedirect.withStripQuery
withStripQuery(stripQuery)
"If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default value is false."
obj spec.forProvider.pathMatcher.routeRules
"The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. Within a given pathMatcher, only one of pathRules or routeRules must be set. routeRules are not supported in UrlMaps intended for External load balancers. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.withHeaderAction
withHeaderAction(headerAction)
"Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.withHeaderActionMixin
withHeaderActionMixin(headerAction)
"Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.routeRules.withMatchRules
withMatchRules(matchRules)
"The rules for determining a match. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.withMatchRulesMixin
withMatchRulesMixin(matchRules)
"The rules for determining a match. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.routeRules.withPriority
withPriority(priority)
"For routeRules within a given pathMatcher, priority determines the order in which load balancer will interpret routeRules. RouteRules are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied. You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number between 0 and 2147483647 inclusive. Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules."
fn spec.forProvider.pathMatcher.routeRules.withRouteAction
withRouteAction(routeAction)
"In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.withRouteActionMixin
withRouteActionMixin(routeAction)
"In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.routeRules.withService
withService(service)
"A reference to expected RegionBackendService resource the given URL should be mapped to."
fn spec.forProvider.pathMatcher.routeRules.withUrlRedirect
withUrlRedirect(urlRedirect)
"When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.withUrlRedirectMixin
withUrlRedirectMixin(urlRedirect)
"When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.forProvider.pathMatcher.routeRules.headerAction
"Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.headerAction.withRequestHeadersToAdd
withRequestHeadersToAdd(requestHeadersToAdd)
"Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.headerAction.withRequestHeadersToAddMixin
withRequestHeadersToAddMixin(requestHeadersToAdd)
"Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.routeRules.headerAction.withRequestHeadersToRemove
withRequestHeadersToRemove(requestHeadersToRemove)
"A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService."
fn spec.forProvider.pathMatcher.routeRules.headerAction.withRequestHeadersToRemoveMixin
withRequestHeadersToRemoveMixin(requestHeadersToRemove)
"A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.routeRules.headerAction.withResponseHeadersToAdd
withResponseHeadersToAdd(responseHeadersToAdd)
"Headers to add the response prior to sending the response back to the client. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.headerAction.withResponseHeadersToAddMixin
withResponseHeadersToAddMixin(responseHeadersToAdd)
"Headers to add the response prior to sending the response back to the client. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.routeRules.headerAction.withResponseHeadersToRemove
withResponseHeadersToRemove(responseHeadersToRemove)
"A list of header names for headers that need to be removed from the response prior to sending the response back to the client."
fn spec.forProvider.pathMatcher.routeRules.headerAction.withResponseHeadersToRemoveMixin
withResponseHeadersToRemoveMixin(responseHeadersToRemove)
"A list of header names for headers that need to be removed from the response prior to sending the response back to the client."
Note: This function appends passed data to existing values
obj spec.forProvider.pathMatcher.routeRules.headerAction.requestHeadersToAdd
"Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.headerAction.requestHeadersToAdd.withHeaderName
withHeaderName(headerName)
"The name of the header."
fn spec.forProvider.pathMatcher.routeRules.headerAction.requestHeadersToAdd.withHeaderValue
withHeaderValue(headerValue)
"The value of the header to add."
fn spec.forProvider.pathMatcher.routeRules.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."
obj spec.forProvider.pathMatcher.routeRules.headerAction.responseHeadersToAdd
"Headers to add the response prior to sending the response back to the client. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.headerAction.responseHeadersToAdd.withHeaderName
withHeaderName(headerName)
"The name of the header."
fn spec.forProvider.pathMatcher.routeRules.headerAction.responseHeadersToAdd.withHeaderValue
withHeaderValue(headerValue)
"The value of the header to add."
fn spec.forProvider.pathMatcher.routeRules.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."
obj spec.forProvider.pathMatcher.routeRules.matchRules
"The rules for determining a match. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.matchRules.withFullPathMatch
withFullPathMatch(fullPathMatch)
"For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL. FullPathMatch must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified."
fn spec.forProvider.pathMatcher.routeRules.matchRules.withHeaderMatches
withHeaderMatches(headerMatches)
"Specifies a list of header match criteria, all of which must match corresponding headers in the request. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.matchRules.withHeaderMatchesMixin
withHeaderMatchesMixin(headerMatches)
"Specifies a list of header match criteria, all of which must match corresponding headers in the request. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.routeRules.matchRules.withIgnoreCase
withIgnoreCase(ignoreCase)
"Specifies that prefixMatch and fullPathMatch matches are case sensitive. Defaults to false."
fn spec.forProvider.pathMatcher.routeRules.matchRules.withMetadataFilters
withMetadataFilters(metadataFilters)
"Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. metadataFilters specified here can be overrides those specified in ForwardingRule that refers to this UrlMap. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.matchRules.withMetadataFiltersMixin
withMetadataFiltersMixin(metadataFilters)
"Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. metadataFilters specified here can be overrides those specified in ForwardingRule that refers to this UrlMap. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.routeRules.matchRules.withPrefixMatch
withPrefixMatch(prefixMatch)
"For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified."
fn spec.forProvider.pathMatcher.routeRules.matchRules.withQueryParameterMatches
withQueryParameterMatches(queryParameterMatches)
"Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.matchRules.withQueryParameterMatchesMixin
withQueryParameterMatchesMixin(queryParameterMatches)
"Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.routeRules.matchRules.withRegexMatch
withRegexMatch(regexMatch)
"The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch and regexMatch must be set."
obj spec.forProvider.pathMatcher.routeRules.matchRules.headerMatches
"Specifies a list of header match criteria, all of which must match corresponding headers in the request. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.matchRules.headerMatches.withExactMatch
withExactMatch(exactMatch)
"The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch and regexMatch must be set."
fn spec.forProvider.pathMatcher.routeRules.matchRules.headerMatches.withHeaderName
withHeaderName(headerName)
"The name of the header."
fn spec.forProvider.pathMatcher.routeRules.matchRules.headerMatches.withInvertMatch
withInvertMatch(invertMatch)
"If set to false, the headerMatch is considered a match if the match criteria above are met. If set to true, the headerMatch is considered a match if the match criteria above are NOT met. Defaults to false."
fn spec.forProvider.pathMatcher.routeRules.matchRules.headerMatches.withPrefixMatch
withPrefixMatch(prefixMatch)
"For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified."
fn spec.forProvider.pathMatcher.routeRules.matchRules.headerMatches.withPresentMatch
withPresentMatch(presentMatch)
"Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not. Only one of presentMatch, exactMatch and regexMatch must be set."
fn spec.forProvider.pathMatcher.routeRules.matchRules.headerMatches.withRangeMatch
withRangeMatch(rangeMatch)
"The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0]"
fn spec.forProvider.pathMatcher.routeRules.matchRules.headerMatches.withRangeMatchMixin
withRangeMatchMixin(rangeMatch)
"The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0]"
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.routeRules.matchRules.headerMatches.withRegexMatch
withRegexMatch(regexMatch)
"The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch and regexMatch must be set."
fn spec.forProvider.pathMatcher.routeRules.matchRules.headerMatches.withSuffixMatch
withSuffixMatch(suffixMatch)
"The value of the header must end with the contents of suffixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set."
obj spec.forProvider.pathMatcher.routeRules.matchRules.headerMatches.rangeMatch
"The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0]"
fn spec.forProvider.pathMatcher.routeRules.matchRules.headerMatches.rangeMatch.withRangeEnd
withRangeEnd(rangeEnd)
"The end of the range (exclusive)."
fn spec.forProvider.pathMatcher.routeRules.matchRules.headerMatches.rangeMatch.withRangeStart
withRangeStart(rangeStart)
"The start of the range (inclusive)."
obj spec.forProvider.pathMatcher.routeRules.matchRules.metadataFilters
"Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. metadataFilters specified here can be overrides those specified in ForwardingRule that refers to this UrlMap. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.matchRules.metadataFilters.withFilterLabels
withFilterLabels(filterLabels)
"The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.matchRules.metadataFilters.withFilterLabelsMixin
withFilterLabelsMixin(filterLabels)
"The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.routeRules.matchRules.metadataFilters.withFilterMatchCriteria
withFilterMatchCriteria(filterMatchCriteria)
"Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. Supported values are:"
obj spec.forProvider.pathMatcher.routeRules.matchRules.metadataFilters.filterLabels
"The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.matchRules.metadataFilters.filterLabels.withName
withName(name)
"The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails."
fn spec.forProvider.pathMatcher.routeRules.matchRules.metadataFilters.filterLabels.withValue
withValue(value)
"The value of the label must match the specified value. value can have a maximum length of 1024 characters."
obj spec.forProvider.pathMatcher.routeRules.matchRules.queryParameterMatches
"Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.matchRules.queryParameterMatches.withExactMatch
withExactMatch(exactMatch)
"The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch and regexMatch must be set."
fn spec.forProvider.pathMatcher.routeRules.matchRules.queryParameterMatches.withName
withName(name)
"The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails."
fn spec.forProvider.pathMatcher.routeRules.matchRules.queryParameterMatches.withPresentMatch
withPresentMatch(presentMatch)
"Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not. Only one of presentMatch, exactMatch and regexMatch must be set."
fn spec.forProvider.pathMatcher.routeRules.matchRules.queryParameterMatches.withRegexMatch
withRegexMatch(regexMatch)
"The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch and regexMatch must be set."
obj spec.forProvider.pathMatcher.routeRules.routeAction
"In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.routeAction.withCorsPolicy
withCorsPolicy(corsPolicy)
"The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.routeAction.withCorsPolicyMixin
withCorsPolicyMixin(corsPolicy)
"The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.routeRules.routeAction.withFaultInjectionPolicy
withFaultInjectionPolicy(faultInjectionPolicy)
"The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.routeAction.withFaultInjectionPolicyMixin
withFaultInjectionPolicyMixin(faultInjectionPolicy)
"The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.routeRules.routeAction.withRequestMirrorPolicy
withRequestMirrorPolicy(requestMirrorPolicy)
"Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.routeAction.withRequestMirrorPolicyMixin
withRequestMirrorPolicyMixin(requestMirrorPolicy)
"Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.routeRules.routeAction.withRetryPolicy
withRetryPolicy(retryPolicy)
"Specifies the retry policy associated with this route. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.routeAction.withRetryPolicyMixin
withRetryPolicyMixin(retryPolicy)
"Specifies the retry policy associated with this route. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.routeRules.routeAction.withTimeout
withTimeout(timeout)
"Specifies the timeout for the selected route. Timeout is computed from the time the request is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, the default value is 15 seconds. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.routeAction.withTimeoutMixin
withTimeoutMixin(timeout)
"Specifies the timeout for the selected route. Timeout is computed from the time the request is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, the default value is 15 seconds. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.routeRules.routeAction.withUrlRewrite
withUrlRewrite(urlRewrite)
"The spec to modify the URL of the request, prior to forwarding the request to the matched service Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.routeAction.withUrlRewriteMixin
withUrlRewriteMixin(urlRewrite)
"The spec to modify the URL of the request, prior to forwarding the request to the matched service Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.routeRules.routeAction.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 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.routeAction.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 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.forProvider.pathMatcher.routeRules.routeAction.corsPolicy
"The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.routeAction.corsPolicy.withAllowCredentials
withAllowCredentials(allowCredentials)
"In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access- Control-Allow-Credentials header. Defaults to false."
fn spec.forProvider.pathMatcher.routeRules.routeAction.corsPolicy.withAllowHeaders
withAllowHeaders(allowHeaders)
"Specifies the content for the Access-Control-Allow-Headers header."
fn spec.forProvider.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.forProvider.pathMatcher.routeRules.routeAction.corsPolicy.withAllowMethods
withAllowMethods(allowMethods)
"Specifies the content for the Access-Control-Allow-Methods header."
fn spec.forProvider.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.forProvider.pathMatcher.routeRules.routeAction.corsPolicy.withAllowOriginRegexes
withAllowOriginRegexes(allowOriginRegexes)
"Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either allow_origins or allow_origin_regex."
fn spec.forProvider.pathMatcher.routeRules.routeAction.corsPolicy.withAllowOriginRegexesMixin
withAllowOriginRegexesMixin(allowOriginRegexes)
"Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either allow_origins or allow_origin_regex."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.routeRules.routeAction.corsPolicy.withAllowOrigins
withAllowOrigins(allowOrigins)
"Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either allow_origins or allow_origin_regex."
fn spec.forProvider.pathMatcher.routeRules.routeAction.corsPolicy.withAllowOriginsMixin
withAllowOriginsMixin(allowOrigins)
"Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either allow_origins or allow_origin_regex."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.routeRules.routeAction.corsPolicy.withDisabled
withDisabled(disabled)
"If true, specifies the CORS policy is disabled. which indicates that the CORS policy is in effect. Defaults to false."
fn spec.forProvider.pathMatcher.routeRules.routeAction.corsPolicy.withExposeHeaders
withExposeHeaders(exposeHeaders)
"Specifies the content for the Access-Control-Expose-Headers header."
fn spec.forProvider.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.forProvider.pathMatcher.routeRules.routeAction.corsPolicy.withMaxAge
withMaxAge(maxAge)
"Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header."
obj spec.forProvider.pathMatcher.routeRules.routeAction.faultInjectionPolicy
"The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.routeAction.faultInjectionPolicy.withAbort
withAbort(abort)
"The specification for how client requests are aborted as part of fault injection. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.routeAction.faultInjectionPolicy.withAbortMixin
withAbortMixin(abort)
"The specification for how client requests are aborted as part of fault injection. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.routeRules.routeAction.faultInjectionPolicy.withDelay
withDelay(delay)
"The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.routeAction.faultInjectionPolicy.withDelayMixin
withDelayMixin(delay)
"The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.forProvider.pathMatcher.routeRules.routeAction.faultInjectionPolicy.abort
"The specification for how client requests are aborted as part of fault injection. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.routeAction.faultInjectionPolicy.abort.withHttpStatus
withHttpStatus(httpStatus)
"The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive."
fn spec.forProvider.pathMatcher.routeRules.routeAction.faultInjectionPolicy.abort.withPercentage
withPercentage(percentage)
"The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive."
obj spec.forProvider.pathMatcher.routeRules.routeAction.faultInjectionPolicy.delay
"The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.routeAction.faultInjectionPolicy.delay.withFixedDelay
withFixedDelay(fixedDelay)
"Specifies the value of the fixed delay interval. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.routeAction.faultInjectionPolicy.delay.withFixedDelayMixin
withFixedDelayMixin(fixedDelay)
"Specifies the value of the fixed delay interval. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.routeRules.routeAction.faultInjectionPolicy.delay.withPercentage
withPercentage(percentage)
"The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive."
obj spec.forProvider.pathMatcher.routeRules.routeAction.faultInjectionPolicy.delay.fixedDelay
"Specifies the value of the fixed delay interval. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.routeAction.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 represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive."
fn spec.forProvider.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 inclusive."
obj spec.forProvider.pathMatcher.routeRules.routeAction.requestMirrorPolicy
"Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.routeAction.requestMirrorPolicy.withBackendService
withBackendService(backendService)
"The default RegionBackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight."
obj spec.forProvider.pathMatcher.routeRules.routeAction.retryPolicy
"Specifies the retry policy associated with this route. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.routeAction.retryPolicy.withNumRetries
withNumRetries(numRetries)
"Specifies the allowed number retries. This number must be > 0."
fn spec.forProvider.pathMatcher.routeRules.routeAction.retryPolicy.withPerTryTimeout
withPerTryTimeout(perTryTimeout)
"Specifies a non-zero timeout per retry attempt. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.routeAction.retryPolicy.withPerTryTimeoutMixin
withPerTryTimeoutMixin(perTryTimeout)
"Specifies a non-zero timeout per retry attempt. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.routeRules.routeAction.retryPolicy.withRetryConditions
withRetryConditions(retryConditions)
"Specifies one or more conditions when this retry rule applies. Valid values are:"
fn spec.forProvider.pathMatcher.routeRules.routeAction.retryPolicy.withRetryConditionsMixin
withRetryConditionsMixin(retryConditions)
"Specifies one or more conditions when this retry rule applies. Valid values are:"
Note: This function appends passed data to existing values
obj spec.forProvider.pathMatcher.routeRules.routeAction.retryPolicy.perTryTimeout
"Specifies a non-zero timeout per retry attempt. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.routeAction.retryPolicy.perTryTimeout.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.forProvider.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 inclusive."
obj spec.forProvider.pathMatcher.routeRules.routeAction.timeout
"Specifies the timeout for the selected route. Timeout is computed from the time the request is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, the default value is 15 seconds. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.routeAction.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.forProvider.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 inclusive."
obj spec.forProvider.pathMatcher.routeRules.routeAction.urlRewrite
"The spec to modify the URL of the request, prior to forwarding the request to the matched service Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.routeAction.urlRewrite.withHostRewrite
withHostRewrite(hostRewrite)
"Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters."
fn spec.forProvider.pathMatcher.routeRules.routeAction.urlRewrite.withPathPrefixRewrite
withPathPrefixRewrite(pathPrefixRewrite)
"Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters."
obj spec.forProvider.pathMatcher.routeRules.routeAction.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 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.withBackendService
withBackendService(backendService)
"The default RegionBackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight."
fn spec.forProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.withHeaderAction
withHeaderAction(headerAction)
"Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.withHeaderActionMixin
withHeaderActionMixin(headerAction)
"Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.withWeight
withWeight(weight)
"Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. The value must be between 0 and 1000"
obj spec.forProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction
"Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.withRequestHeadersToAdd
withRequestHeadersToAdd(requestHeadersToAdd)
"Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.withRequestHeadersToAddMixin
withRequestHeadersToAddMixin(requestHeadersToAdd)
"Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.withRequestHeadersToRemove
withRequestHeadersToRemove(requestHeadersToRemove)
"A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService."
fn spec.forProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.withRequestHeadersToRemoveMixin
withRequestHeadersToRemoveMixin(requestHeadersToRemove)
"A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.withResponseHeadersToAdd
withResponseHeadersToAdd(responseHeadersToAdd)
"Headers to add the response prior to sending the response back to the client. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.withResponseHeadersToAddMixin
withResponseHeadersToAddMixin(responseHeadersToAdd)
"Headers to add the response prior to sending the response back to the client. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.withResponseHeadersToRemove
withResponseHeadersToRemove(responseHeadersToRemove)
"A list of header names for headers that need to be removed from the response prior to sending the response back to the client."
fn spec.forProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.withResponseHeadersToRemoveMixin
withResponseHeadersToRemoveMixin(responseHeadersToRemove)
"A list of header names for headers that need to be removed from the response prior to sending the response back to the client."
Note: This function appends passed data to existing values
obj spec.forProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.requestHeadersToAdd
"Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.requestHeadersToAdd.withHeaderName
withHeaderName(headerName)
"The name of the header."
fn spec.forProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.requestHeadersToAdd.withHeaderValue
withHeaderValue(headerValue)
"The value of the header to add."
fn spec.forProvider.pathMatcher.routeRules.routeAction.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."
obj spec.forProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.responseHeadersToAdd
"Headers to add the response prior to sending the response back to the client. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.responseHeadersToAdd.withHeaderName
withHeaderName(headerName)
"The name of the header."
fn spec.forProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.responseHeadersToAdd.withHeaderValue
withHeaderValue(headerValue)
"The value of the header to add."
fn spec.forProvider.pathMatcher.routeRules.routeAction.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."
obj spec.forProvider.pathMatcher.routeRules.serviceRef
"Reference to a RegionBackendService in compute to populate service."
fn spec.forProvider.pathMatcher.routeRules.serviceRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.pathMatcher.routeRules.serviceRef.policy
"Policies for referencing."
fn spec.forProvider.pathMatcher.routeRules.serviceRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.pathMatcher.routeRules.serviceRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.pathMatcher.routeRules.serviceSelector
"Selector for a RegionBackendService in compute to populate service."
fn spec.forProvider.pathMatcher.routeRules.serviceSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.pathMatcher.routeRules.serviceSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.pathMatcher.routeRules.serviceSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.pathMatcher.routeRules.serviceSelector.policy
"Policies for selection."
fn spec.forProvider.pathMatcher.routeRules.serviceSelector.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.pathMatcher.routeRules.serviceSelector.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.pathMatcher.routeRules.urlRedirect
"When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Structure is documented below."
fn spec.forProvider.pathMatcher.routeRules.urlRedirect.withHostRedirect
withHostRedirect(hostRedirect)
"The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters."
fn spec.forProvider.pathMatcher.routeRules.urlRedirect.withHttpsRedirect
withHttpsRedirect(httpsRedirect)
"If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false."
fn spec.forProvider.pathMatcher.routeRules.urlRedirect.withPathRedirect
withPathRedirect(pathRedirect)
"The path that will be used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters."
fn spec.forProvider.pathMatcher.routeRules.urlRedirect.withPrefixRedirect
withPrefixRedirect(prefixRedirect)
"The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters."
fn spec.forProvider.pathMatcher.routeRules.urlRedirect.withRedirectResponseCode
withRedirectResponseCode(redirectResponseCode)
"The HTTP Status code to use for this RedirectAction. Supported values are:"
fn spec.forProvider.pathMatcher.routeRules.urlRedirect.withStripQuery
withStripQuery(stripQuery)
"If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default value is false."
obj spec.forProvider.test
"The list of expected URL mappings. Requests to update this UrlMap will succeed only if all of the test cases pass. Structure is documented below."
fn spec.forProvider.test.withDescription
withDescription(description)
"Description of this test case."
fn spec.forProvider.test.withHost
withHost(host)
"Host portion of the URL."
fn spec.forProvider.test.withPath
withPath(path)
"Path portion of the URL."
fn spec.forProvider.test.withService
withService(service)
"A reference to expected RegionBackendService resource the given URL should be mapped to."
obj spec.forProvider.test.serviceRef
"Reference to a RegionBackendService in compute to populate service."
fn spec.forProvider.test.serviceRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.test.serviceRef.policy
"Policies for referencing."
fn spec.forProvider.test.serviceRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.test.serviceRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.test.serviceSelector
"Selector for a RegionBackendService in compute to populate service."
fn spec.forProvider.test.serviceSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.test.serviceSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.test.serviceSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.test.serviceSelector.policy
"Policies for selection."
fn spec.forProvider.test.serviceSelector.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.test.serviceSelector.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.initProvider
"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler."
fn spec.initProvider.withDefaultRouteAction
withDefaultRouteAction(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. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below."
fn spec.initProvider.withDefaultRouteActionMixin
withDefaultRouteActionMixin(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. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.withDefaultUrlRedirect
withDefaultUrlRedirect(defaultUrlRedirect)
"When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below."
fn spec.initProvider.withDefaultUrlRedirectMixin
withDefaultUrlRedirectMixin(defaultUrlRedirect)
"When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.withDescription
withDescription(description)
"An optional description of this resource. Provide this property when you create the resource."
fn spec.initProvider.withHostRule
withHostRule(hostRule)
"The list of HostRules to use against the URL. Structure is documented below."
fn spec.initProvider.withHostRuleMixin
withHostRuleMixin(hostRule)
"The list of HostRules to use against the URL. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.withPathMatcher
withPathMatcher(pathMatcher)
"The list of named PathMatchers to use against the URL. Structure is documented below."
fn spec.initProvider.withPathMatcherMixin
withPathMatcherMixin(pathMatcher)
"The list of named PathMatchers to use against the URL. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.withProject
withProject(project)
"The ID of the project in which the resource belongs. If it is not provided, the provider project is used."
fn spec.initProvider.withTest
withTest(test)
"The list of expected URL mappings. Requests to update this UrlMap will succeed only if all of the test cases pass. Structure is documented below."
fn spec.initProvider.withTestMixin
withTestMixin(test)
"The list of expected URL mappings. Requests to update this UrlMap will succeed only if all of the test cases pass. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.initProvider.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. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below."
fn spec.initProvider.defaultRouteAction.withCorsPolicy
withCorsPolicy(corsPolicy)
"The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below."
fn spec.initProvider.defaultRouteAction.withCorsPolicyMixin
withCorsPolicyMixin(corsPolicy)
"The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.defaultRouteAction.withFaultInjectionPolicy
withFaultInjectionPolicy(faultInjectionPolicy)
"The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As 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. Similarly requests from clients can be aborted by the load balancer for a percentage of requests. timeout 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. Fault 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. Structure is documented below."
fn spec.initProvider.defaultRouteAction.withFaultInjectionPolicyMixin
withFaultInjectionPolicyMixin(faultInjectionPolicy)
"The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As 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. Similarly requests from clients can be aborted by the load balancer for a percentage of requests. timeout 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. Fault 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. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.defaultRouteAction.withRequestMirrorPolicy
withRequestMirrorPolicy(requestMirrorPolicy)
"Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The 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. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below."
fn spec.initProvider.defaultRouteAction.withRequestMirrorPolicyMixin
withRequestMirrorPolicyMixin(requestMirrorPolicy)
"Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The 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. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.defaultRouteAction.withRetryPolicy
withRetryPolicy(retryPolicy)
"Specifies the retry policy associated with this route. Structure is documented below."
fn spec.initProvider.defaultRouteAction.withRetryPolicyMixin
withRetryPolicyMixin(retryPolicy)
"Specifies the retry policy associated with this route. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.defaultRouteAction.withTimeout
withTimeout(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. If not specified, this field uses the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true. Structure is documented below."
fn spec.initProvider.defaultRouteAction.withTimeoutMixin
withTimeoutMixin(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. If not specified, this field uses the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.defaultRouteAction.withUrlRewrite
withUrlRewrite(urlRewrite)
"The spec to modify the URL of the request, before forwarding the request to the matched service. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below."
fn spec.initProvider.defaultRouteAction.withUrlRewriteMixin
withUrlRewriteMixin(urlRewrite)
"The spec to modify the URL of the request, before forwarding the request to the matched service. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.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. After 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. Structure is documented below."
fn spec.initProvider.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. After 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. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.initProvider.defaultRouteAction.corsPolicy
"The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below."
fn spec.initProvider.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 translates to the Access- Control-Allow-Credentials header. Defaults to false."
fn spec.initProvider.defaultRouteAction.corsPolicy.withAllowHeaders
withAllowHeaders(allowHeaders)
"Specifies the content for the Access-Control-Allow-Headers header."
fn spec.initProvider.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.initProvider.defaultRouteAction.corsPolicy.withAllowMethods
withAllowMethods(allowMethods)
"Specifies the content for the Access-Control-Allow-Methods header."
fn spec.initProvider.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.initProvider.defaultRouteAction.corsPolicy.withAllowOriginRegexes
withAllowOriginRegexes(allowOriginRegexes)
"Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either allow_origins or allow_origin_regex."
fn spec.initProvider.defaultRouteAction.corsPolicy.withAllowOriginRegexesMixin
withAllowOriginRegexesMixin(allowOriginRegexes)
"Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either allow_origins or allow_origin_regex."
Note: This function appends passed data to existing values
fn spec.initProvider.defaultRouteAction.corsPolicy.withAllowOrigins
withAllowOrigins(allowOrigins)
"Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either allow_origins or allow_origin_regex."
fn spec.initProvider.defaultRouteAction.corsPolicy.withAllowOriginsMixin
withAllowOriginsMixin(allowOrigins)
"Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either allow_origins or allow_origin_regex."
Note: This function appends passed data to existing values
fn spec.initProvider.defaultRouteAction.corsPolicy.withDisabled
withDisabled(disabled)
"If true, specifies the CORS policy is disabled. which indicates that the CORS policy is in effect. Defaults to false."
fn spec.initProvider.defaultRouteAction.corsPolicy.withExposeHeaders
withExposeHeaders(exposeHeaders)
"Specifies the content for the Access-Control-Expose-Headers header."
fn spec.initProvider.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.initProvider.defaultRouteAction.corsPolicy.withMaxAge
withMaxAge(maxAge)
"Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header."
obj spec.initProvider.defaultRouteAction.faultInjectionPolicy
"The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As 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. Similarly requests from clients can be aborted by the load balancer for a percentage of requests. timeout 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. Fault 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. Structure is documented below."
fn spec.initProvider.defaultRouteAction.faultInjectionPolicy.withAbort
withAbort(abort)
"The specification for how client requests are aborted as part of fault injection. Structure is documented below."
fn spec.initProvider.defaultRouteAction.faultInjectionPolicy.withAbortMixin
withAbortMixin(abort)
"The specification for how client requests are aborted as part of fault injection. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.defaultRouteAction.faultInjectionPolicy.withDelay
withDelay(delay)
"The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below."
fn spec.initProvider.defaultRouteAction.faultInjectionPolicy.withDelayMixin
withDelayMixin(delay)
"The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.initProvider.defaultRouteAction.faultInjectionPolicy.abort
"The specification for how client requests are aborted as part of fault injection. Structure is documented below."
fn spec.initProvider.defaultRouteAction.faultInjectionPolicy.abort.withHttpStatus
withHttpStatus(httpStatus)
"The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive."
fn spec.initProvider.defaultRouteAction.faultInjectionPolicy.abort.withPercentage
withPercentage(percentage)
"The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive."
obj spec.initProvider.defaultRouteAction.faultInjectionPolicy.delay
"The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below."
fn spec.initProvider.defaultRouteAction.faultInjectionPolicy.delay.withFixedDelay
withFixedDelay(fixedDelay)
"Specifies the value of the fixed delay interval. Structure is documented below."
fn spec.initProvider.defaultRouteAction.faultInjectionPolicy.delay.withFixedDelayMixin
withFixedDelayMixin(fixedDelay)
"Specifies the value of the fixed delay interval. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.defaultRouteAction.faultInjectionPolicy.delay.withPercentage
withPercentage(percentage)
"The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive."
obj spec.initProvider.defaultRouteAction.faultInjectionPolicy.delay.fixedDelay
"Specifies the value of the fixed delay interval. Structure is documented below."
fn spec.initProvider.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 represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive."
fn spec.initProvider.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."
obj spec.initProvider.defaultRouteAction.retryPolicy
"Specifies the retry policy associated with this route. Structure is documented below."
fn spec.initProvider.defaultRouteAction.retryPolicy.withNumRetries
withNumRetries(numRetries)
"Specifies the allowed number retries. This number must be > 0."
fn spec.initProvider.defaultRouteAction.retryPolicy.withPerTryTimeout
withPerTryTimeout(perTryTimeout)
"Specifies a non-zero timeout per retry attempt. Structure is documented below."
fn spec.initProvider.defaultRouteAction.retryPolicy.withPerTryTimeoutMixin
withPerTryTimeoutMixin(perTryTimeout)
"Specifies a non-zero timeout per retry attempt. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.defaultRouteAction.retryPolicy.withRetryConditions
withRetryConditions(retryConditions)
"Specifies one or more conditions when this retry rule applies. Valid values are:"
fn spec.initProvider.defaultRouteAction.retryPolicy.withRetryConditionsMixin
withRetryConditionsMixin(retryConditions)
"Specifies one or more conditions when this retry rule applies. Valid values are:"
Note: This function appends passed data to existing values
obj spec.initProvider.defaultRouteAction.retryPolicy.perTryTimeout
"Specifies a non-zero timeout per retry attempt. Structure is documented below."
fn spec.initProvider.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 represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive."
fn spec.initProvider.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."
obj spec.initProvider.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. If not specified, this field uses the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true. Structure is documented below."
fn spec.initProvider.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.initProvider.defaultRouteAction.timeout.withSeconds
withSeconds(seconds)
"Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive."
obj spec.initProvider.defaultRouteAction.urlRewrite
"The spec to modify the URL of the request, before forwarding the request to the matched service. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below."
fn spec.initProvider.defaultRouteAction.urlRewrite.withHostRewrite
withHostRewrite(hostRewrite)
"Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters."
fn spec.initProvider.defaultRouteAction.urlRewrite.withPathPrefixRewrite
withPathPrefixRewrite(pathPrefixRewrite)
"Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters."
obj spec.initProvider.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. After 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. Structure is documented below."
fn spec.initProvider.defaultRouteAction.weightedBackendServices.withHeaderAction
withHeaderAction(headerAction)
"Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below."
fn spec.initProvider.defaultRouteAction.weightedBackendServices.withHeaderActionMixin
withHeaderActionMixin(headerAction)
"Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.defaultRouteAction.weightedBackendServices.withWeight
withWeight(weight)
"Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. The value must be between 0 and 1000"
obj spec.initProvider.defaultRouteAction.weightedBackendServices.headerAction
"Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below."
fn spec.initProvider.defaultRouteAction.weightedBackendServices.headerAction.withRequestHeadersToAdd
withRequestHeadersToAdd(requestHeadersToAdd)
"Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below."
fn spec.initProvider.defaultRouteAction.weightedBackendServices.headerAction.withRequestHeadersToAddMixin
withRequestHeadersToAddMixin(requestHeadersToAdd)
"Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.defaultRouteAction.weightedBackendServices.headerAction.withRequestHeadersToRemove
withRequestHeadersToRemove(requestHeadersToRemove)
"A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService."
fn spec.initProvider.defaultRouteAction.weightedBackendServices.headerAction.withRequestHeadersToRemoveMixin
withRequestHeadersToRemoveMixin(requestHeadersToRemove)
"A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService."
Note: This function appends passed data to existing values
fn spec.initProvider.defaultRouteAction.weightedBackendServices.headerAction.withResponseHeadersToAdd
withResponseHeadersToAdd(responseHeadersToAdd)
"Headers to add the response prior to sending the response back to the client. Structure is documented below."
fn spec.initProvider.defaultRouteAction.weightedBackendServices.headerAction.withResponseHeadersToAddMixin
withResponseHeadersToAddMixin(responseHeadersToAdd)
"Headers to add the response prior to sending the response back to the client. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.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 response back to the client."
fn spec.initProvider.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 response back to the client."
Note: This function appends passed data to existing values
obj spec.initProvider.defaultRouteAction.weightedBackendServices.headerAction.requestHeadersToAdd
"Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below."
fn spec.initProvider.defaultRouteAction.weightedBackendServices.headerAction.requestHeadersToAdd.withHeaderName
withHeaderName(headerName)
"The name of the header."
fn spec.initProvider.defaultRouteAction.weightedBackendServices.headerAction.requestHeadersToAdd.withHeaderValue
withHeaderValue(headerValue)
"The value of the header to add."
fn spec.initProvider.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."
obj spec.initProvider.defaultRouteAction.weightedBackendServices.headerAction.responseHeadersToAdd
"Headers to add the response prior to sending the response back to the client. Structure is documented below."
fn spec.initProvider.defaultRouteAction.weightedBackendServices.headerAction.responseHeadersToAdd.withHeaderName
withHeaderName(headerName)
"The name of the header."
fn spec.initProvider.defaultRouteAction.weightedBackendServices.headerAction.responseHeadersToAdd.withHeaderValue
withHeaderValue(headerValue)
"The value of the header to add."
fn spec.initProvider.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."
obj spec.initProvider.defaultUrlRedirect
"When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below."
fn spec.initProvider.defaultUrlRedirect.withHostRedirect
withHostRedirect(hostRedirect)
"The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters."
fn spec.initProvider.defaultUrlRedirect.withHttpsRedirect
withHttpsRedirect(httpsRedirect)
"If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false."
fn spec.initProvider.defaultUrlRedirect.withPathRedirect
withPathRedirect(pathRedirect)
"The path that will be used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters."
fn spec.initProvider.defaultUrlRedirect.withPrefixRedirect
withPrefixRedirect(prefixRedirect)
"The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters."
fn spec.initProvider.defaultUrlRedirect.withRedirectResponseCode
withRedirectResponseCode(redirectResponseCode)
"The HTTP Status code to use for this RedirectAction. Supported values are:"
fn spec.initProvider.defaultUrlRedirect.withStripQuery
withStripQuery(stripQuery)
"If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. This field is required to ensure an empty block is not set. The normal default value is false."
obj spec.initProvider.hostRule
"The list of HostRules to use against the URL. Structure is documented below."
fn spec.initProvider.hostRule.withDescription
withDescription(description)
"An optional description of this HostRule. Provide this property when you create the resource."
fn spec.initProvider.hostRule.withHosts
withHosts(hosts)
"The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or .."
fn spec.initProvider.hostRule.withHostsMixin
withHostsMixin(hosts)
"The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or .."
Note: This function appends passed data to existing values
fn spec.initProvider.hostRule.withPathMatcher
withPathMatcher(pathMatcher)
"The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion."
obj spec.initProvider.pathMatcher
"The list of named PathMatchers to use against the URL. Structure is documented below."
fn spec.initProvider.pathMatcher.withDefaultUrlRedirect
withDefaultUrlRedirect(defaultUrlRedirect)
"When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below."
fn spec.initProvider.pathMatcher.withDefaultUrlRedirectMixin
withDefaultUrlRedirectMixin(defaultUrlRedirect)
"When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.withDescription
withDescription(description)
"An optional description of this resource."
fn spec.initProvider.pathMatcher.withName
withName(name)
"The name to which this PathMatcher is referred by the HostRule."
fn spec.initProvider.pathMatcher.withPathRule
withPathRule(pathRule)
"The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/ will match before /a/b/ irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set. Structure is documented below."
fn spec.initProvider.pathMatcher.withPathRuleMixin
withPathRuleMixin(pathRule)
"The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/ will match before /a/b/ irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.withRouteRules
withRouteRules(routeRules)
"The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. Within a given pathMatcher, only one of pathRules or routeRules must be set. routeRules are not supported in UrlMaps intended for External load balancers. Structure is documented below."
fn spec.initProvider.pathMatcher.withRouteRulesMixin
withRouteRulesMixin(routeRules)
"The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. Within a given pathMatcher, only one of pathRules or routeRules must be set. routeRules are not supported in UrlMaps intended for External load balancers. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.initProvider.pathMatcher.defaultUrlRedirect
"When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below."
fn spec.initProvider.pathMatcher.defaultUrlRedirect.withHostRedirect
withHostRedirect(hostRedirect)
"The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters."
fn spec.initProvider.pathMatcher.defaultUrlRedirect.withHttpsRedirect
withHttpsRedirect(httpsRedirect)
"If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false."
fn spec.initProvider.pathMatcher.defaultUrlRedirect.withPathRedirect
withPathRedirect(pathRedirect)
"The path that will be used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters."
fn spec.initProvider.pathMatcher.defaultUrlRedirect.withPrefixRedirect
withPrefixRedirect(prefixRedirect)
"The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters."
fn spec.initProvider.pathMatcher.defaultUrlRedirect.withRedirectResponseCode
withRedirectResponseCode(redirectResponseCode)
"The HTTP Status code to use for this RedirectAction. Supported values are:"
fn spec.initProvider.pathMatcher.defaultUrlRedirect.withStripQuery
withStripQuery(stripQuery)
"If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default value is false."
obj spec.initProvider.pathMatcher.pathRule
"The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/ will match before /a/b/ irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set. Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.withPaths
withPaths(paths)
"The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here."
fn spec.initProvider.pathMatcher.pathRule.withPathsMixin
withPathsMixin(paths)
"The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.pathRule.withRouteAction
withRouteAction(routeAction)
"In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.withRouteActionMixin
withRouteActionMixin(routeAction)
"In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.pathRule.withUrlRedirect
withUrlRedirect(urlRedirect)
"When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.withUrlRedirectMixin
withUrlRedirectMixin(urlRedirect)
"When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.initProvider.pathMatcher.pathRule.routeAction
"In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.routeAction.withCorsPolicy
withCorsPolicy(corsPolicy)
"The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.routeAction.withCorsPolicyMixin
withCorsPolicyMixin(corsPolicy)
"The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.pathRule.routeAction.withFaultInjectionPolicy
withFaultInjectionPolicy(faultInjectionPolicy)
"The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.routeAction.withFaultInjectionPolicyMixin
withFaultInjectionPolicyMixin(faultInjectionPolicy)
"The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.pathRule.routeAction.withRequestMirrorPolicy
withRequestMirrorPolicy(requestMirrorPolicy)
"Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.routeAction.withRequestMirrorPolicyMixin
withRequestMirrorPolicyMixin(requestMirrorPolicy)
"Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.pathRule.routeAction.withRetryPolicy
withRetryPolicy(retryPolicy)
"Specifies the retry policy associated with this route. Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.routeAction.withRetryPolicyMixin
withRetryPolicyMixin(retryPolicy)
"Specifies the retry policy associated with this route. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.pathRule.routeAction.withTimeout
withTimeout(timeout)
"Specifies the timeout for the selected route. Timeout is computed from the time the request is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, the default value is 15 seconds. Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.routeAction.withTimeoutMixin
withTimeoutMixin(timeout)
"Specifies the timeout for the selected route. Timeout is computed from the time the request is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, the default value is 15 seconds. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.pathRule.routeAction.withUrlRewrite
withUrlRewrite(urlRewrite)
"The spec to modify the URL of the request, prior to forwarding the request to the matched service Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.routeAction.withUrlRewriteMixin
withUrlRewriteMixin(urlRewrite)
"The spec to modify the URL of the request, prior to forwarding the request to the matched service Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.pathRule.routeAction.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 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.routeAction.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 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.initProvider.pathMatcher.pathRule.routeAction.corsPolicy
"The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.routeAction.corsPolicy.withAllowCredentials
withAllowCredentials(allowCredentials)
"In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access- Control-Allow-Credentials header. Defaults to false."
fn spec.initProvider.pathMatcher.pathRule.routeAction.corsPolicy.withAllowHeaders
withAllowHeaders(allowHeaders)
"Specifies the content for the Access-Control-Allow-Headers header."
fn spec.initProvider.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.initProvider.pathMatcher.pathRule.routeAction.corsPolicy.withAllowMethods
withAllowMethods(allowMethods)
"Specifies the content for the Access-Control-Allow-Methods header."
fn spec.initProvider.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.initProvider.pathMatcher.pathRule.routeAction.corsPolicy.withAllowOriginRegexes
withAllowOriginRegexes(allowOriginRegexes)
"Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either allow_origins or allow_origin_regex."
fn spec.initProvider.pathMatcher.pathRule.routeAction.corsPolicy.withAllowOriginRegexesMixin
withAllowOriginRegexesMixin(allowOriginRegexes)
"Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either allow_origins or allow_origin_regex."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.pathRule.routeAction.corsPolicy.withAllowOrigins
withAllowOrigins(allowOrigins)
"Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either allow_origins or allow_origin_regex."
fn spec.initProvider.pathMatcher.pathRule.routeAction.corsPolicy.withAllowOriginsMixin
withAllowOriginsMixin(allowOrigins)
"Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either allow_origins or allow_origin_regex."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.pathRule.routeAction.corsPolicy.withDisabled
withDisabled(disabled)
"If true, specifies the CORS policy is disabled. which indicates that the CORS policy is in effect. Defaults to false."
fn spec.initProvider.pathMatcher.pathRule.routeAction.corsPolicy.withExposeHeaders
withExposeHeaders(exposeHeaders)
"Specifies the content for the Access-Control-Expose-Headers header."
fn spec.initProvider.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.initProvider.pathMatcher.pathRule.routeAction.corsPolicy.withMaxAge
withMaxAge(maxAge)
"Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header."
obj spec.initProvider.pathMatcher.pathRule.routeAction.faultInjectionPolicy
"The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.routeAction.faultInjectionPolicy.withAbort
withAbort(abort)
"The specification for how client requests are aborted as part of fault injection. Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.routeAction.faultInjectionPolicy.withAbortMixin
withAbortMixin(abort)
"The specification for how client requests are aborted as part of fault injection. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.pathRule.routeAction.faultInjectionPolicy.withDelay
withDelay(delay)
"The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.routeAction.faultInjectionPolicy.withDelayMixin
withDelayMixin(delay)
"The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.initProvider.pathMatcher.pathRule.routeAction.faultInjectionPolicy.abort
"The specification for how client requests are aborted as part of fault injection. Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.routeAction.faultInjectionPolicy.abort.withHttpStatus
withHttpStatus(httpStatus)
"The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive."
fn spec.initProvider.pathMatcher.pathRule.routeAction.faultInjectionPolicy.abort.withPercentage
withPercentage(percentage)
"The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive."
obj spec.initProvider.pathMatcher.pathRule.routeAction.faultInjectionPolicy.delay
"The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.routeAction.faultInjectionPolicy.delay.withFixedDelay
withFixedDelay(fixedDelay)
"Specifies the value of the fixed delay interval. Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.routeAction.faultInjectionPolicy.delay.withFixedDelayMixin
withFixedDelayMixin(fixedDelay)
"Specifies the value of the fixed delay interval. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.pathRule.routeAction.faultInjectionPolicy.delay.withPercentage
withPercentage(percentage)
"The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive."
obj spec.initProvider.pathMatcher.pathRule.routeAction.faultInjectionPolicy.delay.fixedDelay
"Specifies the value of the fixed delay interval. Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.routeAction.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 represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive."
fn spec.initProvider.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 inclusive."
obj spec.initProvider.pathMatcher.pathRule.routeAction.retryPolicy
"Specifies the retry policy associated with this route. Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.routeAction.retryPolicy.withNumRetries
withNumRetries(numRetries)
"Specifies the allowed number retries. This number must be > 0."
fn spec.initProvider.pathMatcher.pathRule.routeAction.retryPolicy.withPerTryTimeout
withPerTryTimeout(perTryTimeout)
"Specifies a non-zero timeout per retry attempt. Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.routeAction.retryPolicy.withPerTryTimeoutMixin
withPerTryTimeoutMixin(perTryTimeout)
"Specifies a non-zero timeout per retry attempt. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.pathRule.routeAction.retryPolicy.withRetryConditions
withRetryConditions(retryConditions)
"Specifies one or more conditions when this retry rule applies. Valid values are:"
fn spec.initProvider.pathMatcher.pathRule.routeAction.retryPolicy.withRetryConditionsMixin
withRetryConditionsMixin(retryConditions)
"Specifies one or more conditions when this retry rule applies. Valid values are:"
Note: This function appends passed data to existing values
obj spec.initProvider.pathMatcher.pathRule.routeAction.retryPolicy.perTryTimeout
"Specifies a non-zero timeout per retry attempt. Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.routeAction.retryPolicy.perTryTimeout.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.initProvider.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 inclusive."
obj spec.initProvider.pathMatcher.pathRule.routeAction.timeout
"Specifies the timeout for the selected route. Timeout is computed from the time the request is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, the default value is 15 seconds. Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.routeAction.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.initProvider.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 inclusive."
obj spec.initProvider.pathMatcher.pathRule.routeAction.urlRewrite
"The spec to modify the URL of the request, prior to forwarding the request to the matched service Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.routeAction.urlRewrite.withHostRewrite
withHostRewrite(hostRewrite)
"Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters."
fn spec.initProvider.pathMatcher.pathRule.routeAction.urlRewrite.withPathPrefixRewrite
withPathPrefixRewrite(pathPrefixRewrite)
"Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters."
obj spec.initProvider.pathMatcher.pathRule.routeAction.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 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.withHeaderAction
withHeaderAction(headerAction)
"Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.withHeaderActionMixin
withHeaderActionMixin(headerAction)
"Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.withWeight
withWeight(weight)
"Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. The value must be between 0 and 1000"
obj spec.initProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction
"Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.withRequestHeadersToAdd
withRequestHeadersToAdd(requestHeadersToAdd)
"Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.withRequestHeadersToAddMixin
withRequestHeadersToAddMixin(requestHeadersToAdd)
"Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.withRequestHeadersToRemove
withRequestHeadersToRemove(requestHeadersToRemove)
"A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService."
fn spec.initProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.withRequestHeadersToRemoveMixin
withRequestHeadersToRemoveMixin(requestHeadersToRemove)
"A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.withResponseHeadersToAdd
withResponseHeadersToAdd(responseHeadersToAdd)
"Headers to add the response prior to sending the response back to the client. Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.withResponseHeadersToAddMixin
withResponseHeadersToAddMixin(responseHeadersToAdd)
"Headers to add the response prior to sending the response back to the client. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.withResponseHeadersToRemove
withResponseHeadersToRemove(responseHeadersToRemove)
"A list of header names for headers that need to be removed from the response prior to sending the response back to the client."
fn spec.initProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.withResponseHeadersToRemoveMixin
withResponseHeadersToRemoveMixin(responseHeadersToRemove)
"A list of header names for headers that need to be removed from the response prior to sending the response back to the client."
Note: This function appends passed data to existing values
obj spec.initProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.requestHeadersToAdd
"Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.requestHeadersToAdd.withHeaderName
withHeaderName(headerName)
"The name of the header."
fn spec.initProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.requestHeadersToAdd.withHeaderValue
withHeaderValue(headerValue)
"The value of the header to add."
fn spec.initProvider.pathMatcher.pathRule.routeAction.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."
obj spec.initProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.responseHeadersToAdd
"Headers to add the response prior to sending the response back to the client. Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.responseHeadersToAdd.withHeaderName
withHeaderName(headerName)
"The name of the header."
fn spec.initProvider.pathMatcher.pathRule.routeAction.weightedBackendServices.headerAction.responseHeadersToAdd.withHeaderValue
withHeaderValue(headerValue)
"The value of the header to add."
fn spec.initProvider.pathMatcher.pathRule.routeAction.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."
obj spec.initProvider.pathMatcher.pathRule.urlRedirect
"When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Structure is documented below."
fn spec.initProvider.pathMatcher.pathRule.urlRedirect.withHostRedirect
withHostRedirect(hostRedirect)
"The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters."
fn spec.initProvider.pathMatcher.pathRule.urlRedirect.withHttpsRedirect
withHttpsRedirect(httpsRedirect)
"If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false."
fn spec.initProvider.pathMatcher.pathRule.urlRedirect.withPathRedirect
withPathRedirect(pathRedirect)
"The path that will be used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters."
fn spec.initProvider.pathMatcher.pathRule.urlRedirect.withPrefixRedirect
withPrefixRedirect(prefixRedirect)
"The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters."
fn spec.initProvider.pathMatcher.pathRule.urlRedirect.withRedirectResponseCode
withRedirectResponseCode(redirectResponseCode)
"The HTTP Status code to use for this RedirectAction. Supported values are:"
fn spec.initProvider.pathMatcher.pathRule.urlRedirect.withStripQuery
withStripQuery(stripQuery)
"If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default value is false."
obj spec.initProvider.pathMatcher.routeRules
"The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. Within a given pathMatcher, only one of pathRules or routeRules must be set. routeRules are not supported in UrlMaps intended for External load balancers. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.withHeaderAction
withHeaderAction(headerAction)
"Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.withHeaderActionMixin
withHeaderActionMixin(headerAction)
"Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.routeRules.withMatchRules
withMatchRules(matchRules)
"The rules for determining a match. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.withMatchRulesMixin
withMatchRulesMixin(matchRules)
"The rules for determining a match. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.routeRules.withPriority
withPriority(priority)
"For routeRules within a given pathMatcher, priority determines the order in which load balancer will interpret routeRules. RouteRules are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied. You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number between 0 and 2147483647 inclusive. Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules."
fn spec.initProvider.pathMatcher.routeRules.withRouteAction
withRouteAction(routeAction)
"In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.withRouteActionMixin
withRouteActionMixin(routeAction)
"In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.routeRules.withUrlRedirect
withUrlRedirect(urlRedirect)
"When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.withUrlRedirectMixin
withUrlRedirectMixin(urlRedirect)
"When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.initProvider.pathMatcher.routeRules.headerAction
"Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.headerAction.withRequestHeadersToAdd
withRequestHeadersToAdd(requestHeadersToAdd)
"Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.headerAction.withRequestHeadersToAddMixin
withRequestHeadersToAddMixin(requestHeadersToAdd)
"Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.routeRules.headerAction.withRequestHeadersToRemove
withRequestHeadersToRemove(requestHeadersToRemove)
"A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService."
fn spec.initProvider.pathMatcher.routeRules.headerAction.withRequestHeadersToRemoveMixin
withRequestHeadersToRemoveMixin(requestHeadersToRemove)
"A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.routeRules.headerAction.withResponseHeadersToAdd
withResponseHeadersToAdd(responseHeadersToAdd)
"Headers to add the response prior to sending the response back to the client. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.headerAction.withResponseHeadersToAddMixin
withResponseHeadersToAddMixin(responseHeadersToAdd)
"Headers to add the response prior to sending the response back to the client. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.routeRules.headerAction.withResponseHeadersToRemove
withResponseHeadersToRemove(responseHeadersToRemove)
"A list of header names for headers that need to be removed from the response prior to sending the response back to the client."
fn spec.initProvider.pathMatcher.routeRules.headerAction.withResponseHeadersToRemoveMixin
withResponseHeadersToRemoveMixin(responseHeadersToRemove)
"A list of header names for headers that need to be removed from the response prior to sending the response back to the client."
Note: This function appends passed data to existing values
obj spec.initProvider.pathMatcher.routeRules.headerAction.requestHeadersToAdd
"Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.headerAction.requestHeadersToAdd.withHeaderName
withHeaderName(headerName)
"The name of the header."
fn spec.initProvider.pathMatcher.routeRules.headerAction.requestHeadersToAdd.withHeaderValue
withHeaderValue(headerValue)
"The value of the header to add."
fn spec.initProvider.pathMatcher.routeRules.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."
obj spec.initProvider.pathMatcher.routeRules.headerAction.responseHeadersToAdd
"Headers to add the response prior to sending the response back to the client. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.headerAction.responseHeadersToAdd.withHeaderName
withHeaderName(headerName)
"The name of the header."
fn spec.initProvider.pathMatcher.routeRules.headerAction.responseHeadersToAdd.withHeaderValue
withHeaderValue(headerValue)
"The value of the header to add."
fn spec.initProvider.pathMatcher.routeRules.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."
obj spec.initProvider.pathMatcher.routeRules.matchRules
"The rules for determining a match. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.matchRules.withFullPathMatch
withFullPathMatch(fullPathMatch)
"For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL. FullPathMatch must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified."
fn spec.initProvider.pathMatcher.routeRules.matchRules.withHeaderMatches
withHeaderMatches(headerMatches)
"Specifies a list of header match criteria, all of which must match corresponding headers in the request. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.matchRules.withHeaderMatchesMixin
withHeaderMatchesMixin(headerMatches)
"Specifies a list of header match criteria, all of which must match corresponding headers in the request. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.routeRules.matchRules.withIgnoreCase
withIgnoreCase(ignoreCase)
"Specifies that prefixMatch and fullPathMatch matches are case sensitive. Defaults to false."
fn spec.initProvider.pathMatcher.routeRules.matchRules.withMetadataFilters
withMetadataFilters(metadataFilters)
"Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. metadataFilters specified here can be overrides those specified in ForwardingRule that refers to this UrlMap. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.matchRules.withMetadataFiltersMixin
withMetadataFiltersMixin(metadataFilters)
"Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. metadataFilters specified here can be overrides those specified in ForwardingRule that refers to this UrlMap. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.routeRules.matchRules.withPrefixMatch
withPrefixMatch(prefixMatch)
"For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified."
fn spec.initProvider.pathMatcher.routeRules.matchRules.withQueryParameterMatches
withQueryParameterMatches(queryParameterMatches)
"Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.matchRules.withQueryParameterMatchesMixin
withQueryParameterMatchesMixin(queryParameterMatches)
"Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.routeRules.matchRules.withRegexMatch
withRegexMatch(regexMatch)
"The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch and regexMatch must be set."
obj spec.initProvider.pathMatcher.routeRules.matchRules.headerMatches
"Specifies a list of header match criteria, all of which must match corresponding headers in the request. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.matchRules.headerMatches.withExactMatch
withExactMatch(exactMatch)
"The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch and regexMatch must be set."
fn spec.initProvider.pathMatcher.routeRules.matchRules.headerMatches.withHeaderName
withHeaderName(headerName)
"The name of the header."
fn spec.initProvider.pathMatcher.routeRules.matchRules.headerMatches.withInvertMatch
withInvertMatch(invertMatch)
"If set to false, the headerMatch is considered a match if the match criteria above are met. If set to true, the headerMatch is considered a match if the match criteria above are NOT met. Defaults to false."
fn spec.initProvider.pathMatcher.routeRules.matchRules.headerMatches.withPrefixMatch
withPrefixMatch(prefixMatch)
"For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified."
fn spec.initProvider.pathMatcher.routeRules.matchRules.headerMatches.withPresentMatch
withPresentMatch(presentMatch)
"Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not. Only one of presentMatch, exactMatch and regexMatch must be set."
fn spec.initProvider.pathMatcher.routeRules.matchRules.headerMatches.withRangeMatch
withRangeMatch(rangeMatch)
"The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0]"
fn spec.initProvider.pathMatcher.routeRules.matchRules.headerMatches.withRangeMatchMixin
withRangeMatchMixin(rangeMatch)
"The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0]"
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.routeRules.matchRules.headerMatches.withRegexMatch
withRegexMatch(regexMatch)
"The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch and regexMatch must be set."
fn spec.initProvider.pathMatcher.routeRules.matchRules.headerMatches.withSuffixMatch
withSuffixMatch(suffixMatch)
"The value of the header must end with the contents of suffixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set."
obj spec.initProvider.pathMatcher.routeRules.matchRules.headerMatches.rangeMatch
"The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0]"
fn spec.initProvider.pathMatcher.routeRules.matchRules.headerMatches.rangeMatch.withRangeEnd
withRangeEnd(rangeEnd)
"The end of the range (exclusive)."
fn spec.initProvider.pathMatcher.routeRules.matchRules.headerMatches.rangeMatch.withRangeStart
withRangeStart(rangeStart)
"The start of the range (inclusive)."
obj spec.initProvider.pathMatcher.routeRules.matchRules.metadataFilters
"Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. metadataFilters specified here can be overrides those specified in ForwardingRule that refers to this UrlMap. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.matchRules.metadataFilters.withFilterLabels
withFilterLabels(filterLabels)
"The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.matchRules.metadataFilters.withFilterLabelsMixin
withFilterLabelsMixin(filterLabels)
"The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.routeRules.matchRules.metadataFilters.withFilterMatchCriteria
withFilterMatchCriteria(filterMatchCriteria)
"Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. Supported values are:"
obj spec.initProvider.pathMatcher.routeRules.matchRules.metadataFilters.filterLabels
"The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.matchRules.metadataFilters.filterLabels.withName
withName(name)
"The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails."
fn spec.initProvider.pathMatcher.routeRules.matchRules.metadataFilters.filterLabels.withValue
withValue(value)
"The value of the label must match the specified value. value can have a maximum length of 1024 characters."
obj spec.initProvider.pathMatcher.routeRules.matchRules.queryParameterMatches
"Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.matchRules.queryParameterMatches.withExactMatch
withExactMatch(exactMatch)
"The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch and regexMatch must be set."
fn spec.initProvider.pathMatcher.routeRules.matchRules.queryParameterMatches.withName
withName(name)
"The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails."
fn spec.initProvider.pathMatcher.routeRules.matchRules.queryParameterMatches.withPresentMatch
withPresentMatch(presentMatch)
"Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not. Only one of presentMatch, exactMatch and regexMatch must be set."
fn spec.initProvider.pathMatcher.routeRules.matchRules.queryParameterMatches.withRegexMatch
withRegexMatch(regexMatch)
"The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch and regexMatch must be set."
obj spec.initProvider.pathMatcher.routeRules.routeAction
"In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.routeAction.withCorsPolicy
withCorsPolicy(corsPolicy)
"The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.routeAction.withCorsPolicyMixin
withCorsPolicyMixin(corsPolicy)
"The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.routeRules.routeAction.withFaultInjectionPolicy
withFaultInjectionPolicy(faultInjectionPolicy)
"The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.routeAction.withFaultInjectionPolicyMixin
withFaultInjectionPolicyMixin(faultInjectionPolicy)
"The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.routeRules.routeAction.withRequestMirrorPolicy
withRequestMirrorPolicy(requestMirrorPolicy)
"Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.routeAction.withRequestMirrorPolicyMixin
withRequestMirrorPolicyMixin(requestMirrorPolicy)
"Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.routeRules.routeAction.withRetryPolicy
withRetryPolicy(retryPolicy)
"Specifies the retry policy associated with this route. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.routeAction.withRetryPolicyMixin
withRetryPolicyMixin(retryPolicy)
"Specifies the retry policy associated with this route. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.routeRules.routeAction.withTimeout
withTimeout(timeout)
"Specifies the timeout for the selected route. Timeout is computed from the time the request is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, the default value is 15 seconds. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.routeAction.withTimeoutMixin
withTimeoutMixin(timeout)
"Specifies the timeout for the selected route. Timeout is computed from the time the request is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, the default value is 15 seconds. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.routeRules.routeAction.withUrlRewrite
withUrlRewrite(urlRewrite)
"The spec to modify the URL of the request, prior to forwarding the request to the matched service Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.routeAction.withUrlRewriteMixin
withUrlRewriteMixin(urlRewrite)
"The spec to modify the URL of the request, prior to forwarding the request to the matched service Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.routeRules.routeAction.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 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.routeAction.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 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.initProvider.pathMatcher.routeRules.routeAction.corsPolicy
"The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.routeAction.corsPolicy.withAllowCredentials
withAllowCredentials(allowCredentials)
"In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access- Control-Allow-Credentials header. Defaults to false."
fn spec.initProvider.pathMatcher.routeRules.routeAction.corsPolicy.withAllowHeaders
withAllowHeaders(allowHeaders)
"Specifies the content for the Access-Control-Allow-Headers header."
fn spec.initProvider.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.initProvider.pathMatcher.routeRules.routeAction.corsPolicy.withAllowMethods
withAllowMethods(allowMethods)
"Specifies the content for the Access-Control-Allow-Methods header."
fn spec.initProvider.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.initProvider.pathMatcher.routeRules.routeAction.corsPolicy.withAllowOriginRegexes
withAllowOriginRegexes(allowOriginRegexes)
"Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either allow_origins or allow_origin_regex."
fn spec.initProvider.pathMatcher.routeRules.routeAction.corsPolicy.withAllowOriginRegexesMixin
withAllowOriginRegexesMixin(allowOriginRegexes)
"Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either allow_origins or allow_origin_regex."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.routeRules.routeAction.corsPolicy.withAllowOrigins
withAllowOrigins(allowOrigins)
"Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either allow_origins or allow_origin_regex."
fn spec.initProvider.pathMatcher.routeRules.routeAction.corsPolicy.withAllowOriginsMixin
withAllowOriginsMixin(allowOrigins)
"Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either allow_origins or allow_origin_regex."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.routeRules.routeAction.corsPolicy.withDisabled
withDisabled(disabled)
"If true, specifies the CORS policy is disabled. which indicates that the CORS policy is in effect. Defaults to false."
fn spec.initProvider.pathMatcher.routeRules.routeAction.corsPolicy.withExposeHeaders
withExposeHeaders(exposeHeaders)
"Specifies the content for the Access-Control-Expose-Headers header."
fn spec.initProvider.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.initProvider.pathMatcher.routeRules.routeAction.corsPolicy.withMaxAge
withMaxAge(maxAge)
"Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header."
obj spec.initProvider.pathMatcher.routeRules.routeAction.faultInjectionPolicy
"The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.routeAction.faultInjectionPolicy.withAbort
withAbort(abort)
"The specification for how client requests are aborted as part of fault injection. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.routeAction.faultInjectionPolicy.withAbortMixin
withAbortMixin(abort)
"The specification for how client requests are aborted as part of fault injection. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.routeRules.routeAction.faultInjectionPolicy.withDelay
withDelay(delay)
"The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.routeAction.faultInjectionPolicy.withDelayMixin
withDelayMixin(delay)
"The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.initProvider.pathMatcher.routeRules.routeAction.faultInjectionPolicy.abort
"The specification for how client requests are aborted as part of fault injection. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.routeAction.faultInjectionPolicy.abort.withHttpStatus
withHttpStatus(httpStatus)
"The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive."
fn spec.initProvider.pathMatcher.routeRules.routeAction.faultInjectionPolicy.abort.withPercentage
withPercentage(percentage)
"The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive."
obj spec.initProvider.pathMatcher.routeRules.routeAction.faultInjectionPolicy.delay
"The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.routeAction.faultInjectionPolicy.delay.withFixedDelay
withFixedDelay(fixedDelay)
"Specifies the value of the fixed delay interval. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.routeAction.faultInjectionPolicy.delay.withFixedDelayMixin
withFixedDelayMixin(fixedDelay)
"Specifies the value of the fixed delay interval. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.routeRules.routeAction.faultInjectionPolicy.delay.withPercentage
withPercentage(percentage)
"The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive."
obj spec.initProvider.pathMatcher.routeRules.routeAction.faultInjectionPolicy.delay.fixedDelay
"Specifies the value of the fixed delay interval. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.routeAction.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 represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive."
fn spec.initProvider.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 inclusive."
obj spec.initProvider.pathMatcher.routeRules.routeAction.requestMirrorPolicy
"Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.routeAction.requestMirrorPolicy.withBackendService
withBackendService(backendService)
"The default RegionBackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight."
obj spec.initProvider.pathMatcher.routeRules.routeAction.retryPolicy
"Specifies the retry policy associated with this route. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.routeAction.retryPolicy.withNumRetries
withNumRetries(numRetries)
"Specifies the allowed number retries. This number must be > 0."
fn spec.initProvider.pathMatcher.routeRules.routeAction.retryPolicy.withPerTryTimeout
withPerTryTimeout(perTryTimeout)
"Specifies a non-zero timeout per retry attempt. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.routeAction.retryPolicy.withPerTryTimeoutMixin
withPerTryTimeoutMixin(perTryTimeout)
"Specifies a non-zero timeout per retry attempt. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.routeRules.routeAction.retryPolicy.withRetryConditions
withRetryConditions(retryConditions)
"Specifies one or more conditions when this retry rule applies. Valid values are:"
fn spec.initProvider.pathMatcher.routeRules.routeAction.retryPolicy.withRetryConditionsMixin
withRetryConditionsMixin(retryConditions)
"Specifies one or more conditions when this retry rule applies. Valid values are:"
Note: This function appends passed data to existing values
obj spec.initProvider.pathMatcher.routeRules.routeAction.retryPolicy.perTryTimeout
"Specifies a non-zero timeout per retry attempt. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.routeAction.retryPolicy.perTryTimeout.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.initProvider.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 inclusive."
obj spec.initProvider.pathMatcher.routeRules.routeAction.timeout
"Specifies the timeout for the selected route. Timeout is computed from the time the request is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, the default value is 15 seconds. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.routeAction.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.initProvider.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 inclusive."
obj spec.initProvider.pathMatcher.routeRules.routeAction.urlRewrite
"The spec to modify the URL of the request, prior to forwarding the request to the matched service Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.routeAction.urlRewrite.withHostRewrite
withHostRewrite(hostRewrite)
"Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters."
fn spec.initProvider.pathMatcher.routeRules.routeAction.urlRewrite.withPathPrefixRewrite
withPathPrefixRewrite(pathPrefixRewrite)
"Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters."
obj spec.initProvider.pathMatcher.routeRules.routeAction.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 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.withBackendService
withBackendService(backendService)
"The default RegionBackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight."
fn spec.initProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.withHeaderAction
withHeaderAction(headerAction)
"Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.withHeaderActionMixin
withHeaderActionMixin(headerAction)
"Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.withWeight
withWeight(weight)
"Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. The value must be between 0 and 1000"
obj spec.initProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction
"Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.withRequestHeadersToAdd
withRequestHeadersToAdd(requestHeadersToAdd)
"Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.withRequestHeadersToAddMixin
withRequestHeadersToAddMixin(requestHeadersToAdd)
"Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.withRequestHeadersToRemove
withRequestHeadersToRemove(requestHeadersToRemove)
"A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService."
fn spec.initProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.withRequestHeadersToRemoveMixin
withRequestHeadersToRemoveMixin(requestHeadersToRemove)
"A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.withResponseHeadersToAdd
withResponseHeadersToAdd(responseHeadersToAdd)
"Headers to add the response prior to sending the response back to the client. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.withResponseHeadersToAddMixin
withResponseHeadersToAddMixin(responseHeadersToAdd)
"Headers to add the response prior to sending the response back to the client. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.withResponseHeadersToRemove
withResponseHeadersToRemove(responseHeadersToRemove)
"A list of header names for headers that need to be removed from the response prior to sending the response back to the client."
fn spec.initProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.withResponseHeadersToRemoveMixin
withResponseHeadersToRemoveMixin(responseHeadersToRemove)
"A list of header names for headers that need to be removed from the response prior to sending the response back to the client."
Note: This function appends passed data to existing values
obj spec.initProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.requestHeadersToAdd
"Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.requestHeadersToAdd.withHeaderName
withHeaderName(headerName)
"The name of the header."
fn spec.initProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.requestHeadersToAdd.withHeaderValue
withHeaderValue(headerValue)
"The value of the header to add."
fn spec.initProvider.pathMatcher.routeRules.routeAction.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."
obj spec.initProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.responseHeadersToAdd
"Headers to add the response prior to sending the response back to the client. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.responseHeadersToAdd.withHeaderName
withHeaderName(headerName)
"The name of the header."
fn spec.initProvider.pathMatcher.routeRules.routeAction.weightedBackendServices.headerAction.responseHeadersToAdd.withHeaderValue
withHeaderValue(headerValue)
"The value of the header to add."
fn spec.initProvider.pathMatcher.routeRules.routeAction.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."
obj spec.initProvider.pathMatcher.routeRules.urlRedirect
"When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Structure is documented below."
fn spec.initProvider.pathMatcher.routeRules.urlRedirect.withHostRedirect
withHostRedirect(hostRedirect)
"The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters."
fn spec.initProvider.pathMatcher.routeRules.urlRedirect.withHttpsRedirect
withHttpsRedirect(httpsRedirect)
"If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false."
fn spec.initProvider.pathMatcher.routeRules.urlRedirect.withPathRedirect
withPathRedirect(pathRedirect)
"The path that will be used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters."
fn spec.initProvider.pathMatcher.routeRules.urlRedirect.withPrefixRedirect
withPrefixRedirect(prefixRedirect)
"The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters."
fn spec.initProvider.pathMatcher.routeRules.urlRedirect.withRedirectResponseCode
withRedirectResponseCode(redirectResponseCode)
"The HTTP Status code to use for this RedirectAction. Supported values are:"
fn spec.initProvider.pathMatcher.routeRules.urlRedirect.withStripQuery
withStripQuery(stripQuery)
"If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default value is false."
obj spec.initProvider.test
"The list of expected URL mappings. Requests to update this UrlMap will succeed only if all of the test cases pass. Structure is documented below."
fn spec.initProvider.test.withDescription
withDescription(description)
"Description of this test case."
fn spec.initProvider.test.withHost
withHost(host)
"Host portion of the URL."
fn spec.initProvider.test.withPath
withPath(path)
"Path portion of the URL."
obj spec.providerConfigRef
"ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured."
fn spec.providerConfigRef.withName
withName(name)
"Name of the referenced object."
obj spec.providerConfigRef.policy
"Policies for referencing."
fn spec.providerConfigRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.providerConfigRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.providerRef
"ProviderReference specifies the provider that will be used to create, observe, update, and delete this managed resource. Deprecated: Please use ProviderConfigReference, i.e. providerConfigRef
"
fn spec.providerRef.withName
withName(name)
"Name of the referenced object."
obj spec.providerRef.policy
"Policies for referencing."
fn spec.providerRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.providerRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.publishConnectionDetailsTo
"PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource."
fn spec.publishConnectionDetailsTo.withName
withName(name)
"Name is the name of the connection secret."
obj spec.publishConnectionDetailsTo.configRef
"SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret."
fn spec.publishConnectionDetailsTo.configRef.withName
withName(name)
"Name of the referenced object."
obj spec.publishConnectionDetailsTo.configRef.policy
"Policies for referencing."
fn spec.publishConnectionDetailsTo.configRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.publishConnectionDetailsTo.configRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.publishConnectionDetailsTo.metadata
"Metadata is the metadata for connection secret."
fn spec.publishConnectionDetailsTo.metadata.withAnnotations
withAnnotations(annotations)
"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."
fn spec.publishConnectionDetailsTo.metadata.withAnnotationsMixin
withAnnotationsMixin(annotations)
"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."
Note: This function appends passed data to existing values
fn spec.publishConnectionDetailsTo.metadata.withLabels
withLabels(labels)
"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."
fn spec.publishConnectionDetailsTo.metadata.withLabelsMixin
withLabelsMixin(labels)
"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."
Note: This function appends passed data to existing values
fn spec.publishConnectionDetailsTo.metadata.withType
withType(type)
"Type is the SecretType for the connection secret. - Only valid for Kubernetes Secret Stores."
obj spec.writeConnectionSecretToRef
"WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other."
fn spec.writeConnectionSecretToRef.withName
withName(name)
"Name of the secret."
fn spec.writeConnectionSecretToRef.withNamespace
withNamespace(namespace)
"Namespace of the secret."