networking.v1alpha3.virtualService
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 withExportTo(exportTo)
fn withExportToMixin(exportTo)
fn withGateways(gateways)
fn withGatewaysMixin(gateways)
fn withHosts(hosts)
fn withHostsMixin(hosts)
fn withHttp(http)
fn withHttpMixin(http)
fn withTcp(tcp)
fn withTcpMixin(tcp)
fn withTls(tls)
fn withTlsMixin(tls)
obj spec.http
fn withMatch(match)
fn withMatchMixin(match)
fn withMirrorPercent(mirrorPercent)
fn withMirror_percent(mirror_percent)
fn withMirrors(mirrors)
fn withMirrorsMixin(mirrors)
fn withName(name)
fn withRoute(route)
fn withRouteMixin(route)
fn withTimeout(timeout)
obj spec.http.corsPolicy
fn withAllowCredentials(allowCredentials)
fn withAllowHeaders(allowHeaders)
fn withAllowHeadersMixin(allowHeaders)
fn withAllowMethods(allowMethods)
fn withAllowMethodsMixin(allowMethods)
fn withAllowOrigin(allowOrigin)
fn withAllowOriginMixin(allowOrigin)
fn withAllowOrigins(allowOrigins)
fn withAllowOriginsMixin(allowOrigins)
fn withExposeHeaders(exposeHeaders)
fn withExposeHeadersMixin(exposeHeaders)
fn withMaxAge(maxAge)
obj spec.http.corsPolicy.allowOrigins
obj spec.http.delegate
obj spec.http.directResponse
obj spec.http.fault
obj spec.http.headers
obj spec.http.match
fn withGateways(gateways)
fn withGatewaysMixin(gateways)
fn withHeaders(headers)
fn withHeadersMixin(headers)
fn withIgnoreUriCase(ignoreUriCase)
fn withName(name)
fn withPort(port)
fn withQueryParams(queryParams)
fn withQueryParamsMixin(queryParams)
fn withSourceLabels(sourceLabels)
fn withSourceLabelsMixin(sourceLabels)
fn withSourceNamespace(sourceNamespace)
fn withStatPrefix(statPrefix)
fn withWithoutHeaders(withoutHeaders)
fn withWithoutHeadersMixin(withoutHeaders)
obj spec.http.match.authority
obj spec.http.match.headers
obj spec.http.match.method
obj spec.http.match.queryParams
obj spec.http.match.scheme
obj spec.http.match.uri
obj spec.http.match.withoutHeaders
obj spec.http.mirror
obj spec.http.mirrorPercentage
obj spec.http.mirrors
obj spec.http.redirect
obj spec.http.retries
obj spec.http.rewrite
obj spec.http.route
obj spec.tcp
fn withMatch(match)
fn withMatchMixin(match)
fn withRoute(route)
fn withRouteMixin(route)
obj spec.tcp.match
fn withDestinationSubnets(destinationSubnets)
fn withDestinationSubnetsMixin(destinationSubnets)
fn withGateways(gateways)
fn withGatewaysMixin(gateways)
fn withPort(port)
fn withSourceLabels(sourceLabels)
fn withSourceLabelsMixin(sourceLabels)
fn withSourceNamespace(sourceNamespace)
fn withSourceSubnet(sourceSubnet)
obj spec.tcp.route
obj spec.tls
fn withMatch(match)
fn withMatchMixin(match)
fn withRoute(route)
fn withRouteMixin(route)
obj spec.tls.match
fn withDestinationSubnets(destinationSubnets)
fn withDestinationSubnetsMixin(destinationSubnets)
fn withGateways(gateways)
fn withGatewaysMixin(gateways)
fn withPort(port)
fn withSniHosts(sniHosts)
fn withSniHostsMixin(sniHosts)
fn withSourceLabels(sourceLabels)
fn withSourceLabelsMixin(sourceLabels)
fn withSourceNamespace(sourceNamespace)
obj spec.tls.route
Fields
fn new
new(name)
new returns an instance of VirtualService
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
"Configuration affecting label/content routing, sni routing, etc. See more details at: https://istio.io/docs/reference/config/networking/virtual-service.html"
fn spec.withExportTo
withExportTo(exportTo)
"A list of namespaces to which this virtual service is exported."
fn spec.withExportToMixin
withExportToMixin(exportTo)
"A list of namespaces to which this virtual service is exported."
Note: This function appends passed data to existing values
fn spec.withGateways
withGateways(gateways)
"The names of gateways and sidecars that should apply these routes."
fn spec.withGatewaysMixin
withGatewaysMixin(gateways)
"The names of gateways and sidecars that should apply these routes."
Note: This function appends passed data to existing values
fn spec.withHosts
withHosts(hosts)
"The destination hosts to which traffic is being sent."
fn spec.withHostsMixin
withHostsMixin(hosts)
"The destination hosts to which traffic is being sent."
Note: This function appends passed data to existing values
fn spec.withHttp
withHttp(http)
"An ordered list of route rules for HTTP traffic."
fn spec.withHttpMixin
withHttpMixin(http)
"An ordered list of route rules for HTTP traffic."
Note: This function appends passed data to existing values
fn spec.withTcp
withTcp(tcp)
"An ordered list of route rules for opaque TCP traffic."
fn spec.withTcpMixin
withTcpMixin(tcp)
"An ordered list of route rules for opaque TCP traffic."
Note: This function appends passed data to existing values
fn spec.withTls
withTls(tls)
fn spec.withTlsMixin
withTlsMixin(tls)
Note: This function appends passed data to existing values
obj spec.http
"An ordered list of route rules for HTTP traffic."
fn spec.http.withMatch
withMatch(match)
fn spec.http.withMatchMixin
withMatchMixin(match)
Note: This function appends passed data to existing values
fn spec.http.withMirrorPercent
withMirrorPercent(mirrorPercent)
"Percentage of the traffic to be mirrored by the mirror
field."
fn spec.http.withMirror_percent
withMirror_percent(mirror_percent)
"Percentage of the traffic to be mirrored by the mirror
field."
fn spec.http.withMirrors
withMirrors(mirrors)
fn spec.http.withMirrorsMixin
withMirrorsMixin(mirrors)
Note: This function appends passed data to existing values
fn spec.http.withName
withName(name)
"The name assigned to the route for debugging purposes."
fn spec.http.withRoute
withRoute(route)
"A HTTP rule can either return a direct_response, redirect or forward (default) traffic."
fn spec.http.withRouteMixin
withRouteMixin(route)
"A HTTP rule can either return a direct_response, redirect or forward (default) traffic."
Note: This function appends passed data to existing values
fn spec.http.withTimeout
withTimeout(timeout)
"Timeout for HTTP requests, default is disabled."
obj spec.http.corsPolicy
"Cross-Origin Resource Sharing policy (CORS)."
fn spec.http.corsPolicy.withAllowCredentials
withAllowCredentials(allowCredentials)
fn spec.http.corsPolicy.withAllowHeaders
withAllowHeaders(allowHeaders)
fn spec.http.corsPolicy.withAllowHeadersMixin
withAllowHeadersMixin(allowHeaders)
Note: This function appends passed data to existing values
fn spec.http.corsPolicy.withAllowMethods
withAllowMethods(allowMethods)
"List of HTTP methods allowed to access the resource."
fn spec.http.corsPolicy.withAllowMethodsMixin
withAllowMethodsMixin(allowMethods)
"List of HTTP methods allowed to access the resource."
Note: This function appends passed data to existing values
fn spec.http.corsPolicy.withAllowOrigin
withAllowOrigin(allowOrigin)
"The list of origins that are allowed to perform CORS requests."
fn spec.http.corsPolicy.withAllowOriginMixin
withAllowOriginMixin(allowOrigin)
"The list of origins that are allowed to perform CORS requests."
Note: This function appends passed data to existing values
fn spec.http.corsPolicy.withAllowOrigins
withAllowOrigins(allowOrigins)
"String patterns that match allowed origins."
fn spec.http.corsPolicy.withAllowOriginsMixin
withAllowOriginsMixin(allowOrigins)
"String patterns that match allowed origins."
Note: This function appends passed data to existing values
fn spec.http.corsPolicy.withExposeHeaders
withExposeHeaders(exposeHeaders)
fn spec.http.corsPolicy.withExposeHeadersMixin
withExposeHeadersMixin(exposeHeaders)
Note: This function appends passed data to existing values
fn spec.http.corsPolicy.withMaxAge
withMaxAge(maxAge)
obj spec.http.corsPolicy.allowOrigins
"String patterns that match allowed origins."
fn spec.http.corsPolicy.allowOrigins.withExact
withExact(exact)
fn spec.http.corsPolicy.allowOrigins.withPrefix
withPrefix(prefix)
fn spec.http.corsPolicy.allowOrigins.withRegex
withRegex(regex)
"RE2 style regex-based match (https://github.com/google/re2/wiki/Syntax)."
obj spec.http.delegate
fn spec.http.delegate.withName
withName(name)
"Name specifies the name of the delegate VirtualService."
fn spec.http.delegate.withNamespace
withNamespace(namespace)
"Namespace specifies the namespace where the delegate VirtualService resides."
obj spec.http.directResponse
"A HTTP rule can either return a direct_response, redirect or forward (default) traffic."
obj spec.http.directResponse.body
"Specifies the content of the response body."
fn spec.http.directResponse.body.withBytes
withBytes(bytes)
"response body as base64 encoded bytes."
fn spec.http.directResponse.body.withString
withString(string)
obj spec.http.fault
"Fault injection policy to apply on HTTP traffic at the client side."
obj spec.http.fault.abort
fn spec.http.fault.abort.withGrpcStatus
withGrpcStatus(grpcStatus)
"GRPC status code to use to abort the request."
fn spec.http.fault.abort.withHttp2Error
withHttp2Error(http2Error)
fn spec.http.fault.abort.withHttpStatus
withHttpStatus(httpStatus)
"HTTP status code to use to abort the Http request."
obj spec.http.fault.abort.percentage
"Percentage of requests to be aborted with the error code provided."
fn spec.http.fault.abort.percentage.withValue
withValue(value)
obj spec.http.fault.delay
fn spec.http.fault.delay.withExponentialDelay
withExponentialDelay(exponentialDelay)
fn spec.http.fault.delay.withFixedDelay
withFixedDelay(fixedDelay)
"Add a fixed delay before forwarding the request."
fn spec.http.fault.delay.withPercent
withPercent(percent)
"Percentage of requests on which the delay will be injected (0-100)."
obj spec.http.fault.delay.percentage
"Percentage of requests on which the delay will be injected."
fn spec.http.fault.delay.percentage.withValue
withValue(value)
obj spec.http.headers
obj spec.http.headers.request
fn spec.http.headers.request.withAdd
withAdd(add)
fn spec.http.headers.request.withAddMixin
withAddMixin(add)
Note: This function appends passed data to existing values
fn spec.http.headers.request.withRemove
withRemove(remove)
fn spec.http.headers.request.withRemoveMixin
withRemoveMixin(remove)
Note: This function appends passed data to existing values
fn spec.http.headers.request.withSet
withSet(set)
fn spec.http.headers.request.withSetMixin
withSetMixin(set)
Note: This function appends passed data to existing values
obj spec.http.headers.response
fn spec.http.headers.response.withAdd
withAdd(add)
fn spec.http.headers.response.withAddMixin
withAddMixin(add)
Note: This function appends passed data to existing values
fn spec.http.headers.response.withRemove
withRemove(remove)
fn spec.http.headers.response.withRemoveMixin
withRemoveMixin(remove)
Note: This function appends passed data to existing values
fn spec.http.headers.response.withSet
withSet(set)
fn spec.http.headers.response.withSetMixin
withSetMixin(set)
Note: This function appends passed data to existing values
obj spec.http.match
fn spec.http.match.withGateways
withGateways(gateways)
"Names of gateways where the rule should be applied."
fn spec.http.match.withGatewaysMixin
withGatewaysMixin(gateways)
"Names of gateways where the rule should be applied."
Note: This function appends passed data to existing values
fn spec.http.match.withHeaders
withHeaders(headers)
fn spec.http.match.withHeadersMixin
withHeadersMixin(headers)
Note: This function appends passed data to existing values
fn spec.http.match.withIgnoreUriCase
withIgnoreUriCase(ignoreUriCase)
"Flag to specify whether the URI matching should be case-insensitive."
fn spec.http.match.withName
withName(name)
"The name assigned to a match."
fn spec.http.match.withPort
withPort(port)
"Specifies the ports on the host that is being addressed."
fn spec.http.match.withQueryParams
withQueryParams(queryParams)
"Query parameters for matching."
fn spec.http.match.withQueryParamsMixin
withQueryParamsMixin(queryParams)
"Query parameters for matching."
Note: This function appends passed data to existing values
fn spec.http.match.withSourceLabels
withSourceLabels(sourceLabels)
fn spec.http.match.withSourceLabelsMixin
withSourceLabelsMixin(sourceLabels)
Note: This function appends passed data to existing values
fn spec.http.match.withSourceNamespace
withSourceNamespace(sourceNamespace)
"Source namespace constraining the applicability of a rule to workloads in that namespace."
fn spec.http.match.withStatPrefix
withStatPrefix(statPrefix)
"The human readable prefix to use when emitting statistics for this route."
fn spec.http.match.withWithoutHeaders
withWithoutHeaders(withoutHeaders)
"withoutHeader has the same syntax with the header, but has opposite meaning."
fn spec.http.match.withWithoutHeadersMixin
withWithoutHeadersMixin(withoutHeaders)
"withoutHeader has the same syntax with the header, but has opposite meaning."
Note: This function appends passed data to existing values
obj spec.http.match.authority
fn spec.http.match.authority.withExact
withExact(exact)
fn spec.http.match.authority.withPrefix
withPrefix(prefix)
fn spec.http.match.authority.withRegex
withRegex(regex)
"RE2 style regex-based match (https://github.com/google/re2/wiki/Syntax)."
obj spec.http.match.headers
fn spec.http.match.headers.withExact
withExact(header, value)
withExact
matches the header in an exact string
fn spec.http.match.headers.withExactMixin
withExactMixin(header, value)
withExact
matches the header in an exact string
fn spec.http.match.headers.withPrefix
withPrefix(header, value)
withPrefix
matches the header in an prefix-based
fn spec.http.match.headers.withPrefixMixin
withPrefixMixin(header, value)
withPrefix
matches the header in an prefix-based
fn spec.http.match.headers.withRegex
withRegex(header, value)
withRegex
matches the header in an RE2 style regex-based
fn spec.http.match.headers.withRegexMixin
withRegexMixin(header, value)
withRegex
matches the header in an RE2 style regex-based
obj spec.http.match.method
fn spec.http.match.method.withExact
withExact(exact)
fn spec.http.match.method.withPrefix
withPrefix(prefix)
fn spec.http.match.method.withRegex
withRegex(regex)
"RE2 style regex-based match (https://github.com/google/re2/wiki/Syntax)."
obj spec.http.match.queryParams
fn spec.http.match.queryParams.withExact
withExact(key, value)
withExact
matches the header in an exact string
fn spec.http.match.queryParams.withExactMixin
withExactMixin(key, value)
withExact
matches the header in an exact string
fn spec.http.match.queryParams.withRegex
withRegex(key, value)
withRegex
matches the header in an RE2 style regex-based
fn spec.http.match.queryParams.withRegexMixin
withRegexMixin(key, value)
withRegex
matches the header in an RE2 style regex-based
obj spec.http.match.scheme
fn spec.http.match.scheme.withExact
withExact(exact)
fn spec.http.match.scheme.withPrefix
withPrefix(prefix)
fn spec.http.match.scheme.withRegex
withRegex(regex)
"RE2 style regex-based match (https://github.com/google/re2/wiki/Syntax)."
obj spec.http.match.uri
fn spec.http.match.uri.withExact
withExact(exact)
fn spec.http.match.uri.withPrefix
withPrefix(prefix)
fn spec.http.match.uri.withRegex
withRegex(regex)
"RE2 style regex-based match (https://github.com/google/re2/wiki/Syntax)."
obj spec.http.match.withoutHeaders
fn spec.http.match.withoutHeaders.withExact
withExact(header, value)
withExact
matches the header in an exact string
fn spec.http.match.withoutHeaders.withExactMixin
withExactMixin(header, value)
withExact
matches the header in an exact string
fn spec.http.match.withoutHeaders.withPrefix
withPrefix(header, value)
withPrefix
matches the header in an prefix-based
fn spec.http.match.withoutHeaders.withPrefixMixin
withPrefixMixin(header, value)
withPrefix
matches the header in an prefix-based
fn spec.http.match.withoutHeaders.withRegex
withRegex(header, value)
withRegex
matches the header in an RE2 style regex-based
fn spec.http.match.withoutHeaders.withRegexMixin
withRegexMixin(header, value)
withRegex
matches the header in an RE2 style regex-based
obj spec.http.mirror
fn spec.http.mirror.withHost
withHost(host)
"The name of a service from the service registry."
fn spec.http.mirror.withSubset
withSubset(subset)
"The name of a subset within the service."
obj spec.http.mirror.port
"Specifies the port on the host that is being addressed."
fn spec.http.mirror.port.withNumber
withNumber(number)
obj spec.http.mirrorPercentage
"Percentage of the traffic to be mirrored by the mirror
field."
fn spec.http.mirrorPercentage.withValue
withValue(value)
obj spec.http.mirrors
obj spec.http.mirrors.destination
fn spec.http.mirrors.destination.withHost
withHost(host)
"The name of a service from the service registry."
fn spec.http.mirrors.destination.withSubset
withSubset(subset)
"The name of a subset within the service."
obj spec.http.mirrors.destination.port
"Specifies the port on the host that is being addressed."
fn spec.http.mirrors.destination.port.withNumber
withNumber(number)
obj spec.http.mirrors.percentage
fn spec.http.mirrors.percentage.withValue
withValue(value)
obj spec.http.redirect
"A HTTP rule can either return a direct_response, redirect or forward (default) traffic."
fn spec.http.redirect.withAuthority
withAuthority(authority)
fn spec.http.redirect.withDerivePort
withDerivePort(derivePort)
fn spec.http.redirect.withPort
withPort(port)
"On a redirect, overwrite the port portion of the URL with this value."
fn spec.http.redirect.withRedirectCode
withRedirectCode(redirectCode)
fn spec.http.redirect.withScheme
withScheme(scheme)
"On a redirect, overwrite the scheme portion of the URL with this value."
fn spec.http.redirect.withUri
withUri(uri)
obj spec.http.retries
"Retry policy for HTTP requests."
fn spec.http.retries.withAttempts
withAttempts(attempts)
"Number of retries to be allowed for a given request."
fn spec.http.retries.withPerTryTimeout
withPerTryTimeout(perTryTimeout)
"Timeout per attempt for a given request, including the initial call and any retries."
fn spec.http.retries.withRetryOn
withRetryOn(retryOn)
"Specifies the conditions under which retry takes place."
fn spec.http.retries.withRetryRemoteLocalities
withRetryRemoteLocalities(retryRemoteLocalities)
"Flag to specify whether the retries should retry to other localities."
obj spec.http.rewrite
"Rewrite HTTP URIs and Authority headers."
fn spec.http.rewrite.withAuthority
withAuthority(authority)
"rewrite the Authority/Host header with this value."
fn spec.http.rewrite.withUri
withUri(uri)
obj spec.http.rewrite.uriRegexRewrite
"rewrite the path portion of the URI with the specified regex."
fn spec.http.rewrite.uriRegexRewrite.withMatch
withMatch(match)
"RE2 style regex-based match (https://github.com/google/re2/wiki/Syntax)."
fn spec.http.rewrite.uriRegexRewrite.withRewrite
withRewrite(rewrite)
"The string that should replace into matching portions of original URI."
obj spec.http.route
"A HTTP rule can either return a direct_response, redirect or forward (default) traffic."
fn spec.http.route.withWeight
withWeight(weight)
"Weight specifies the relative proportion of traffic to be forwarded to the destination."
obj spec.http.route.destination
fn spec.http.route.destination.withHost
withHost(host)
"The name of a service from the service registry."
fn spec.http.route.destination.withSubset
withSubset(subset)
"The name of a subset within the service."
obj spec.http.route.destination.port
"Specifies the port on the host that is being addressed."
fn spec.http.route.destination.port.withNumber
withNumber(number)
obj spec.http.route.headers
obj spec.http.route.headers.request
fn spec.http.route.headers.request.withAdd
withAdd(add)
fn spec.http.route.headers.request.withAddMixin
withAddMixin(add)
Note: This function appends passed data to existing values
fn spec.http.route.headers.request.withRemove
withRemove(remove)
fn spec.http.route.headers.request.withRemoveMixin
withRemoveMixin(remove)
Note: This function appends passed data to existing values
fn spec.http.route.headers.request.withSet
withSet(set)
fn spec.http.route.headers.request.withSetMixin
withSetMixin(set)
Note: This function appends passed data to existing values
obj spec.http.route.headers.response
fn spec.http.route.headers.response.withAdd
withAdd(add)
fn spec.http.route.headers.response.withAddMixin
withAddMixin(add)
Note: This function appends passed data to existing values
fn spec.http.route.headers.response.withRemove
withRemove(remove)
fn spec.http.route.headers.response.withRemoveMixin
withRemoveMixin(remove)
Note: This function appends passed data to existing values
fn spec.http.route.headers.response.withSet
withSet(set)
fn spec.http.route.headers.response.withSetMixin
withSetMixin(set)
Note: This function appends passed data to existing values
obj spec.tcp
"An ordered list of route rules for opaque TCP traffic."
fn spec.tcp.withMatch
withMatch(match)
fn spec.tcp.withMatchMixin
withMatchMixin(match)
Note: This function appends passed data to existing values
fn spec.tcp.withRoute
withRoute(route)
"The destination to which the connection should be forwarded to."
fn spec.tcp.withRouteMixin
withRouteMixin(route)
"The destination to which the connection should be forwarded to."
Note: This function appends passed data to existing values
obj spec.tcp.match
fn spec.tcp.match.withDestinationSubnets
withDestinationSubnets(destinationSubnets)
"IPv4 or IPv6 ip addresses of destination with optional subnet."
fn spec.tcp.match.withDestinationSubnetsMixin
withDestinationSubnetsMixin(destinationSubnets)
"IPv4 or IPv6 ip addresses of destination with optional subnet."
Note: This function appends passed data to existing values
fn spec.tcp.match.withGateways
withGateways(gateways)
"Names of gateways where the rule should be applied."
fn spec.tcp.match.withGatewaysMixin
withGatewaysMixin(gateways)
"Names of gateways where the rule should be applied."
Note: This function appends passed data to existing values
fn spec.tcp.match.withPort
withPort(port)
"Specifies the port on the host that is being addressed."
fn spec.tcp.match.withSourceLabels
withSourceLabels(sourceLabels)
fn spec.tcp.match.withSourceLabelsMixin
withSourceLabelsMixin(sourceLabels)
Note: This function appends passed data to existing values
fn spec.tcp.match.withSourceNamespace
withSourceNamespace(sourceNamespace)
"Source namespace constraining the applicability of a rule to workloads in that namespace."
fn spec.tcp.match.withSourceSubnet
withSourceSubnet(sourceSubnet)
"IPv4 or IPv6 ip address of source with optional subnet."
obj spec.tcp.route
"The destination to which the connection should be forwarded to."
fn spec.tcp.route.withWeight
withWeight(weight)
"Weight specifies the relative proportion of traffic to be forwarded to the destination."
obj spec.tcp.route.destination
fn spec.tcp.route.destination.withHost
withHost(host)
"The name of a service from the service registry."
fn spec.tcp.route.destination.withSubset
withSubset(subset)
"The name of a subset within the service."
obj spec.tcp.route.destination.port
"Specifies the port on the host that is being addressed."
fn spec.tcp.route.destination.port.withNumber
withNumber(number)
obj spec.tls
fn spec.tls.withMatch
withMatch(match)
fn spec.tls.withMatchMixin
withMatchMixin(match)
Note: This function appends passed data to existing values
fn spec.tls.withRoute
withRoute(route)
"The destination to which the connection should be forwarded to."
fn spec.tls.withRouteMixin
withRouteMixin(route)
"The destination to which the connection should be forwarded to."
Note: This function appends passed data to existing values
obj spec.tls.match
fn spec.tls.match.withDestinationSubnets
withDestinationSubnets(destinationSubnets)
"IPv4 or IPv6 ip addresses of destination with optional subnet."
fn spec.tls.match.withDestinationSubnetsMixin
withDestinationSubnetsMixin(destinationSubnets)
"IPv4 or IPv6 ip addresses of destination with optional subnet."
Note: This function appends passed data to existing values
fn spec.tls.match.withGateways
withGateways(gateways)
"Names of gateways where the rule should be applied."
fn spec.tls.match.withGatewaysMixin
withGatewaysMixin(gateways)
"Names of gateways where the rule should be applied."
Note: This function appends passed data to existing values
fn spec.tls.match.withPort
withPort(port)
"Specifies the port on the host that is being addressed."
fn spec.tls.match.withSniHosts
withSniHosts(sniHosts)
"SNI (server name indicator) to match on."
fn spec.tls.match.withSniHostsMixin
withSniHostsMixin(sniHosts)
"SNI (server name indicator) to match on."
Note: This function appends passed data to existing values
fn spec.tls.match.withSourceLabels
withSourceLabels(sourceLabels)
fn spec.tls.match.withSourceLabelsMixin
withSourceLabelsMixin(sourceLabels)
Note: This function appends passed data to existing values
fn spec.tls.match.withSourceNamespace
withSourceNamespace(sourceNamespace)
"Source namespace constraining the applicability of a rule to workloads in that namespace."
obj spec.tls.route
"The destination to which the connection should be forwarded to."
fn spec.tls.route.withWeight
withWeight(weight)
"Weight specifies the relative proportion of traffic to be forwarded to the destination."
obj spec.tls.route.destination
fn spec.tls.route.destination.withHost
withHost(host)
"The name of a service from the service registry."
fn spec.tls.route.destination.withSubset
withSubset(subset)
"The name of a subset within the service."
obj spec.tls.route.destination.port
"Specifies the port on the host that is being addressed."
fn spec.tls.route.destination.port.withNumber
withNumber(number)