Skip to content

pt.v1beta1.resources

"Resources specifies Patch & Transform resource templates."

Index

Fields

fn new

new(name)

new returns an instance of Resources

fn withPatchSets

withPatchSets(patchSets)

"PatchSets define a named set of patches that may be included by any\nresource. PatchSets cannot themselves refer to other PatchSets."

fn withPatchSetsMixin

withPatchSetsMixin(patchSets)

"PatchSets define a named set of patches that may be included by any\nresource. PatchSets cannot themselves refer to other PatchSets."

Note: This function appends passed data to existing values

fn withResources

withResources(resources)

"Resources is a list of resource templates that will be used when a\ncomposite resource is created."

fn withResourcesMixin

withResourcesMixin(resources)

"Resources is a list of resource templates that will be used when a\ncomposite resource is created."

Note: This function appends passed data to existing values

obj environment

"Environment represents the Composition environment.\n\n\nTHIS IS AN ALPHA FIELD.\nDo not use it in production. It may be changed or removed without notice."

fn environment.withPatches

withPatches(patches)

"Patches is a list of environment patches that are executed before a\ncomposition's resources are composed. These patches are between the XR\nand the Environment. Either from the Environment to the XR, or vice\nversa."

fn environment.withPatchesMixin

withPatchesMixin(patches)

"Patches is a list of environment patches that are executed before a\ncomposition's resources are composed. These patches are between the XR\nand the Environment. Either from the Environment to the XR, or vice\nversa."

Note: This function appends passed data to existing values

obj environment.patches

"Patches is a list of environment patches that are executed before a\ncomposition's resources are composed. These patches are between the XR\nand the Environment. Either from the Environment to the XR, or vice\nversa."

fn environment.patches.withFromFieldPath

withFromFieldPath(fromFieldPath)

"FromFieldPath is the path of the field on the resource whose value is\nto be used as input. Required when type is FromCompositeFieldPath or\nToCompositeFieldPath."

fn environment.patches.withToFieldPath

withToFieldPath(toFieldPath)

"ToFieldPath is the path of the field on the resource whose value will\nbe changed with the result of transforms. Leave empty if you'd like to\npropagate to the same path as fromFieldPath."

fn environment.patches.withTransforms

withTransforms(transforms)

"Transforms are the list of functions that are used as a FIFO pipe for the\ninput to be transformed."

fn environment.patches.withTransformsMixin

withTransformsMixin(transforms)

"Transforms are the list of functions that are used as a FIFO pipe for the\ninput to be transformed."

Note: This function appends passed data to existing values

fn environment.patches.withType

withType(type)

"Type sets the patching behaviour to be used. Each patch type may require\nits own fields to be set on the Patch object."

obj environment.patches.combine

"Combine is the patch configuration for a CombineFromComposite,\nCombineToComposite patch."

fn environment.patches.combine.withStrategy

withStrategy(strategy)

"Strategy defines the strategy to use to combine the input variable values.\nCurrently only string is supported."

fn environment.patches.combine.withVariables

withVariables(variables)

"Variables are the list of variables whose values will be retrieved and\ncombined."

fn environment.patches.combine.withVariablesMixin

withVariablesMixin(variables)

"Variables are the list of variables whose values will be retrieved and\ncombined."

Note: This function appends passed data to existing values

obj environment.patches.combine.string

"String declares that input variables should be combined into a single\nstring, using the relevant settings for formatting purposes."

fn environment.patches.combine.string.withFmt

withFmt(fmt)

"Format the input using a Go format string. See\nhttps://golang.org/pkg/fmt/ for details."

obj environment.patches.combine.variables

"Variables are the list of variables whose values will be retrieved and\ncombined."

fn environment.patches.combine.variables.withFromFieldPath

withFromFieldPath(fromFieldPath)

"FromFieldPath is the path of the field on the source whose value is\nto be used as input."

obj environment.patches.policy

"Policy configures the specifics of patching behaviour."

fn environment.patches.policy.withFromFieldPath

withFromFieldPath(fromFieldPath)

"FromFieldPath specifies how to patch from a field path. The default is\n'Optional', which means the patch will be a no-op if the specified\nfromFieldPath does not exist. Use 'Required' to prevent the creation of a\nnew composed resource until the required path exists."

fn environment.patches.policy.withToFieldPath

withToFieldPath(toFieldPath)

"ToFieldPath specifies how to patch to a field path. The default is\n'Replace', which means the patch will completely replace the target field,\nor create it if it does not exist. Use 'MergeObjects' to recursively merge the patch\nobject with the target object, while keeping target object keys, but overwriting any array values, or use\n'MergeObjectsAppendArrays' to recursively merge the patch object with the target object, while keeping\ntarget object keys and appending any array values to target array values, or use\n'ForceMergeObjects' to recursively merge the patch object with the target object, overwriting\nany target object keys, including array values, or use\n'ForceMergeObjectsAppendArrays' to recursively merge the patch object with the target object,\noverwriting target object keys, and appending any array values to target array values.\n'MergeObject' is deprecated, use 'MergeObjects' instead, which is functionally identical.\n'AppendArray' is deprecated, use 'ForceMergeObjectsAppendArrays' instead, which is functionally identical."

obj environment.patches.transforms

"Transforms are the list of functions that are used as a FIFO pipe for the\ninput to be transformed."

fn environment.patches.transforms.withMap

withMap(map)

"Map uses the input as a key in the given map and returns the value."

fn environment.patches.transforms.withMapMixin

withMapMixin(map)

"Map uses the input as a key in the given map and returns the value."

Note: This function appends passed data to existing values

fn environment.patches.transforms.withType

withType(type)

"Type of the transform to be run."

obj environment.patches.transforms.convert

"Convert is used to cast the input into the given output type."

fn environment.patches.transforms.convert.withFormat

withFormat(format)

"The expected input format.\n\n\n quantity - parses the input as a K8s resource.Quantity.\nOnly used during string -> float64 conversions.\n json - parses the input as a JSON string.\nOnly used during string -> object or string -> list conversions.\n\n\nIf this property is null, the default conversion is applied."

fn environment.patches.transforms.convert.withToType

withToType(toType)

"ToType is the type of the output of this transform."

obj environment.patches.transforms.match

"Match is a more complex version of Map that matches a list of patterns."

fn environment.patches.transforms.match.withFallbackTo

withFallbackTo(fallbackTo)

"Determines to what value the transform should fallback if no pattern matches."

fn environment.patches.transforms.match.withFallbackValue

withFallbackValue(fallbackValue)

"The fallback value that should be returned by the transform if now pattern\nmatches."

fn environment.patches.transforms.match.withPatterns

withPatterns(patterns)

"The patterns that should be tested against the input string.\nPatterns are tested in order. The value of the first match is used as\nresult of this transform."

fn environment.patches.transforms.match.withPatternsMixin

withPatternsMixin(patterns)

"The patterns that should be tested against the input string.\nPatterns are tested in order. The value of the first match is used as\nresult of this transform."

Note: This function appends passed data to existing values

obj environment.patches.transforms.match.patterns

"The patterns that should be tested against the input string.\nPatterns are tested in order. The value of the first match is used as\nresult of this transform."

fn environment.patches.transforms.match.patterns.withLiteral

withLiteral(literal)

"Literal exactly matches the input string (case sensitive).\nIs required if type is literal."

fn environment.patches.transforms.match.patterns.withRegexp

withRegexp(regexp)

"Regexp to match against the input string.\nIs required if type is regexp."

fn environment.patches.transforms.match.patterns.withResult

withResult(result)

"The value that is used as result of the transform if the pattern matches."

fn environment.patches.transforms.match.patterns.withType

withType(type)

"Type specifies how the pattern matches the input.\n\n\n literal - the pattern value has to exactly match (case sensitive) the\ninput string. This is the default.\n\n\n regexp - the pattern treated as a regular expression against\nwhich the input string is tested. Crossplane will throw an error if the\nkey is not a valid regexp."

obj environment.patches.transforms.math

"Math is used to transform the input via mathematical operations such as\nmultiplication."

fn environment.patches.transforms.math.withClampMax

withClampMax(clampMax)

"ClampMax makes sure that the value is not bigger than the given value."

fn environment.patches.transforms.math.withClampMin

withClampMin(clampMin)

"ClampMin makes sure that the value is not smaller than the given value."

fn environment.patches.transforms.math.withMultiply

withMultiply(multiply)

"Multiply the value."

fn environment.patches.transforms.math.withType

withType(type)

"Type of the math transform to be run."

obj environment.patches.transforms.string

"String is used to transform the input into a string or a different kind\nof string. Note that the input does not necessarily need to be a string."

fn environment.patches.transforms.string.withConvert

withConvert(convert)

"Optional conversion method to be specified.\nToUpper and ToLower change the letter case of the input string.\nToBase64 and FromBase64 perform a base64 conversion based on the input string.\nToJson converts any input value into its raw JSON representation.\nToSha1, ToSha256 and ToSha512 generate a hash value based on the input\nconverted to JSON."

fn environment.patches.transforms.string.withFmt

withFmt(fmt)

"Format the input using a Go format string. See\nhttps://golang.org/pkg/fmt/ for details."

fn environment.patches.transforms.string.withTrim

withTrim(trim)

"Trim the prefix or suffix from the input"

fn environment.patches.transforms.string.withType

withType(type)

"Type of the string transform to be run."

obj environment.patches.transforms.string.join

"Join the input strings."

fn environment.patches.transforms.string.join.withSeparator

withSeparator(separator)

"Separator to join the input strings."

obj environment.patches.transforms.string.regexp

"Extract a match from the input using a regular expression."

fn environment.patches.transforms.string.regexp.withGroup

withGroup(group)

"Group number to match. 0 (the default) matches the entire expression."

fn environment.patches.transforms.string.regexp.withMatch

withMatch(match)

"Match string. May optionally include submatches, aka capture groups.\nSee https://pkg.go.dev/regexp/ for details."

obj environment.patches.transforms.string.replace

"Search/Replace applied to the input string."

fn environment.patches.transforms.string.replace.withReplace

withReplace(replace)

"The Replace string replaces all occurrences of the search string."

fn environment.patches.transforms.string.replace.withSearch

withSearch(search)

"The Search string to match."

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"

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 patchSets

"PatchSets define a named set of patches that may be included by any\nresource. PatchSets cannot themselves refer to other PatchSets."

fn patchSets.withName

withName(name)

"Name of this PatchSet."

fn patchSets.withPatches

withPatches(patches)

"Patches will be applied as an overlay to the base resource."

fn patchSets.withPatchesMixin

withPatchesMixin(patches)

"Patches will be applied as an overlay to the base resource."

Note: This function appends passed data to existing values

obj patchSets.patches

"Patches will be applied as an overlay to the base resource."

fn patchSets.patches.withFromFieldPath

withFromFieldPath(fromFieldPath)

"FromFieldPath is the path of the field on the resource whose value is\nto be used as input. Required when type is FromCompositeFieldPath or\nToCompositeFieldPath."

fn patchSets.patches.withToFieldPath

withToFieldPath(toFieldPath)

"ToFieldPath is the path of the field on the resource whose value will\nbe changed with the result of transforms. Leave empty if you'd like to\npropagate to the same path as fromFieldPath."

fn patchSets.patches.withTransforms

withTransforms(transforms)

"Transforms are the list of functions that are used as a FIFO pipe for the\ninput to be transformed."

fn patchSets.patches.withTransformsMixin

withTransformsMixin(transforms)

"Transforms are the list of functions that are used as a FIFO pipe for the\ninput to be transformed."

Note: This function appends passed data to existing values

fn patchSets.patches.withType

withType(type)

"Type sets the patching behaviour to be used. Each patch type may require\nits own fields to be set on the ComposedPatch object."

obj patchSets.patches.combine

"Combine is the patch configuration for a CombineFromComposite,\nCombineToComposite patch."

fn patchSets.patches.combine.withStrategy

withStrategy(strategy)

"Strategy defines the strategy to use to combine the input variable values.\nCurrently only string is supported."

fn patchSets.patches.combine.withVariables

withVariables(variables)

"Variables are the list of variables whose values will be retrieved and\ncombined."

fn patchSets.patches.combine.withVariablesMixin

withVariablesMixin(variables)

"Variables are the list of variables whose values will be retrieved and\ncombined."

Note: This function appends passed data to existing values

obj patchSets.patches.combine.string

"String declares that input variables should be combined into a single\nstring, using the relevant settings for formatting purposes."

fn patchSets.patches.combine.string.withFmt

withFmt(fmt)

"Format the input using a Go format string. See\nhttps://golang.org/pkg/fmt/ for details."

obj patchSets.patches.combine.variables

"Variables are the list of variables whose values will be retrieved and\ncombined."

fn patchSets.patches.combine.variables.withFromFieldPath

withFromFieldPath(fromFieldPath)

"FromFieldPath is the path of the field on the source whose value is\nto be used as input."

obj patchSets.patches.policy

"Policy configures the specifics of patching behaviour."

fn patchSets.patches.policy.withFromFieldPath

withFromFieldPath(fromFieldPath)

"FromFieldPath specifies how to patch from a field path. The default is\n'Optional', which means the patch will be a no-op if the specified\nfromFieldPath does not exist. Use 'Required' to prevent the creation of a\nnew composed resource until the required path exists."

fn patchSets.patches.policy.withToFieldPath

withToFieldPath(toFieldPath)

"ToFieldPath specifies how to patch to a field path. The default is\n'Replace', which means the patch will completely replace the target field,\nor create it if it does not exist. Use 'MergeObjects' to recursively merge the patch\nobject with the target object, while keeping target object keys, but overwriting any array values, or use\n'MergeObjectsAppendArrays' to recursively merge the patch object with the target object, while keeping\ntarget object keys and appending any array values to target array values, or use\n'ForceMergeObjects' to recursively merge the patch object with the target object, overwriting\nany target object keys, including array values, or use\n'ForceMergeObjectsAppendArrays' to recursively merge the patch object with the target object,\noverwriting target object keys, and appending any array values to target array values.\n'MergeObject' is deprecated, use 'MergeObjects' instead, which is functionally identical.\n'AppendArray' is deprecated, use 'ForceMergeObjectsAppendArrays' instead, which is functionally identical."

obj patchSets.patches.transforms

"Transforms are the list of functions that are used as a FIFO pipe for the\ninput to be transformed."

fn patchSets.patches.transforms.withMap

withMap(map)

"Map uses the input as a key in the given map and returns the value."

fn patchSets.patches.transforms.withMapMixin

withMapMixin(map)

"Map uses the input as a key in the given map and returns the value."

Note: This function appends passed data to existing values

fn patchSets.patches.transforms.withType

withType(type)

"Type of the transform to be run."

obj patchSets.patches.transforms.convert

"Convert is used to cast the input into the given output type."

fn patchSets.patches.transforms.convert.withFormat

withFormat(format)

"The expected input format.\n\n\n quantity - parses the input as a K8s resource.Quantity.\nOnly used during string -> float64 conversions.\n json - parses the input as a JSON string.\nOnly used during string -> object or string -> list conversions.\n\n\nIf this property is null, the default conversion is applied."

fn patchSets.patches.transforms.convert.withToType

withToType(toType)

"ToType is the type of the output of this transform."

obj patchSets.patches.transforms.match

"Match is a more complex version of Map that matches a list of patterns."

fn patchSets.patches.transforms.match.withFallbackTo

withFallbackTo(fallbackTo)

"Determines to what value the transform should fallback if no pattern matches."

fn patchSets.patches.transforms.match.withFallbackValue

withFallbackValue(fallbackValue)

"The fallback value that should be returned by the transform if now pattern\nmatches."

fn patchSets.patches.transforms.match.withPatterns

withPatterns(patterns)

"The patterns that should be tested against the input string.\nPatterns are tested in order. The value of the first match is used as\nresult of this transform."

fn patchSets.patches.transforms.match.withPatternsMixin

withPatternsMixin(patterns)

"The patterns that should be tested against the input string.\nPatterns are tested in order. The value of the first match is used as\nresult of this transform."

Note: This function appends passed data to existing values

obj patchSets.patches.transforms.match.patterns

"The patterns that should be tested against the input string.\nPatterns are tested in order. The value of the first match is used as\nresult of this transform."

fn patchSets.patches.transforms.match.patterns.withLiteral

withLiteral(literal)

"Literal exactly matches the input string (case sensitive).\nIs required if type is literal."

fn patchSets.patches.transforms.match.patterns.withRegexp

withRegexp(regexp)

"Regexp to match against the input string.\nIs required if type is regexp."

fn patchSets.patches.transforms.match.patterns.withResult

withResult(result)

"The value that is used as result of the transform if the pattern matches."

fn patchSets.patches.transforms.match.patterns.withType

withType(type)

"Type specifies how the pattern matches the input.\n\n\n literal - the pattern value has to exactly match (case sensitive) the\ninput string. This is the default.\n\n\n regexp - the pattern treated as a regular expression against\nwhich the input string is tested. Crossplane will throw an error if the\nkey is not a valid regexp."

obj patchSets.patches.transforms.math

"Math is used to transform the input via mathematical operations such as\nmultiplication."

fn patchSets.patches.transforms.math.withClampMax

withClampMax(clampMax)

"ClampMax makes sure that the value is not bigger than the given value."

fn patchSets.patches.transforms.math.withClampMin

withClampMin(clampMin)

"ClampMin makes sure that the value is not smaller than the given value."

fn patchSets.patches.transforms.math.withMultiply

withMultiply(multiply)

"Multiply the value."

fn patchSets.patches.transforms.math.withType

withType(type)

"Type of the math transform to be run."

obj patchSets.patches.transforms.string

"String is used to transform the input into a string or a different kind\nof string. Note that the input does not necessarily need to be a string."

fn patchSets.patches.transforms.string.withConvert

withConvert(convert)

"Optional conversion method to be specified.\nToUpper and ToLower change the letter case of the input string.\nToBase64 and FromBase64 perform a base64 conversion based on the input string.\nToJson converts any input value into its raw JSON representation.\nToSha1, ToSha256 and ToSha512 generate a hash value based on the input\nconverted to JSON."

fn patchSets.patches.transforms.string.withFmt

withFmt(fmt)

"Format the input using a Go format string. See\nhttps://golang.org/pkg/fmt/ for details."

fn patchSets.patches.transforms.string.withTrim

withTrim(trim)

"Trim the prefix or suffix from the input"

fn patchSets.patches.transforms.string.withType

withType(type)

"Type of the string transform to be run."

obj patchSets.patches.transforms.string.join

"Join the input strings."

fn patchSets.patches.transforms.string.join.withSeparator

withSeparator(separator)

"Separator to join the input strings."

obj patchSets.patches.transforms.string.regexp

"Extract a match from the input using a regular expression."

fn patchSets.patches.transforms.string.regexp.withGroup

withGroup(group)

"Group number to match. 0 (the default) matches the entire expression."

fn patchSets.patches.transforms.string.regexp.withMatch

withMatch(match)

"Match string. May optionally include submatches, aka capture groups.\nSee https://pkg.go.dev/regexp/ for details."

obj patchSets.patches.transforms.string.replace

"Search/Replace applied to the input string."

fn patchSets.patches.transforms.string.replace.withReplace

withReplace(replace)

"The Replace string replaces all occurrences of the search string."

fn patchSets.patches.transforms.string.replace.withSearch

withSearch(search)

"The Search string to match."

obj resources

"Resources is a list of resource templates that will be used when a\ncomposite resource is created."

fn resources.withBase

withBase(base)

"Base of the composed resource that patches will be applied to and from.\nIf base is omitted, a previous Function within the pipeline must have\nproduced the named composed resource. Patches will be applied to and from\nthat resource. If base is specified, and a previous Function within the\npipeline produced the name composed resource, it will be overwritten."

fn resources.withBaseMixin

withBaseMixin(base)

"Base of the composed resource that patches will be applied to and from.\nIf base is omitted, a previous Function within the pipeline must have\nproduced the named composed resource. Patches will be applied to and from\nthat resource. If base is specified, and a previous Function within the\npipeline produced the name composed resource, it will be overwritten."

Note: This function appends passed data to existing values

fn resources.withConnectionDetails

withConnectionDetails(connectionDetails)

"ConnectionDetails lists the propagation secret keys from this composed\nresource to the composition instance connection secret."

fn resources.withConnectionDetailsMixin

withConnectionDetailsMixin(connectionDetails)

"ConnectionDetails lists the propagation secret keys from this composed\nresource to the composition instance connection secret."

Note: This function appends passed data to existing values

fn resources.withName

withName(name)

"A Name uniquely identifies this entry within its resources array."

fn resources.withPatches

withPatches(patches)

"Patches to and from the composed resource."

fn resources.withPatchesMixin

withPatchesMixin(patches)

"Patches to and from the composed resource."

Note: This function appends passed data to existing values

fn resources.withReadinessChecks

withReadinessChecks(readinessChecks)

"ReadinessChecks allows users to define custom readiness checks. All\nchecks have to return true in order for resource to be considered ready.\nThe default readiness check is to have the \"Ready\" condition to be\n\"True\"."

fn resources.withReadinessChecksMixin

withReadinessChecksMixin(readinessChecks)

"ReadinessChecks allows users to define custom readiness checks. All\nchecks have to return true in order for resource to be considered ready.\nThe default readiness check is to have the \"Ready\" condition to be\n\"True\"."

Note: This function appends passed data to existing values

obj resources.connectionDetails

"ConnectionDetails lists the propagation secret keys from this composed\nresource to the composition instance connection secret."

fn resources.connectionDetails.withFromConnectionSecretKey

withFromConnectionSecretKey(fromConnectionSecretKey)

"FromConnectionSecretKey is the key that will be used to fetch the value\nfrom the composed resource's connection secret."

fn resources.connectionDetails.withFromFieldPath

withFromFieldPath(fromFieldPath)

"FromFieldPath is the path of the field on the composed resource whose\nvalue to be used as input. Name must be specified if the type is\nFromFieldPath."

fn resources.connectionDetails.withName

withName(name)

"Name of the connection secret key that will be propagated to the\nconnection secret of the composed resource."

fn resources.connectionDetails.withType

withType(type)

"Type sets the connection detail fetching behavior to be used. Each\nconnection detail type may require its own fields to be set on the\nConnectionDetail object."

fn resources.connectionDetails.withValue

withValue(value)

"Value that will be propagated to the connection secret of the composite\nresource. May be set to inject a fixed, non-sensitive connection secret\nvalue, for example a well-known port."

obj resources.patches

"Patches to and from the composed resource."

fn resources.patches.withFromFieldPath

withFromFieldPath(fromFieldPath)

"FromFieldPath is the path of the field on the resource whose value is\nto be used as input. Required when type is FromCompositeFieldPath or\nToCompositeFieldPath."

fn resources.patches.withPatchSetName

withPatchSetName(patchSetName)

"PatchSetName to include patches from. Required when type is PatchSet."

fn resources.patches.withToFieldPath

withToFieldPath(toFieldPath)

"ToFieldPath is the path of the field on the resource whose value will\nbe changed with the result of transforms. Leave empty if you'd like to\npropagate to the same path as fromFieldPath."

fn resources.patches.withTransforms

withTransforms(transforms)

"Transforms are the list of functions that are used as a FIFO pipe for the\ninput to be transformed."

fn resources.patches.withTransformsMixin

withTransformsMixin(transforms)

"Transforms are the list of functions that are used as a FIFO pipe for the\ninput to be transformed."

Note: This function appends passed data to existing values

fn resources.patches.withType

withType(type)

"Type sets the patching behaviour to be used. Each patch type may require\nits own fields to be set on the ComposedPatch object."

obj resources.patches.combine

"Combine is the patch configuration for a CombineFromComposite,\nCombineToComposite patch."

fn resources.patches.combine.withStrategy

withStrategy(strategy)

"Strategy defines the strategy to use to combine the input variable values.\nCurrently only string is supported."

fn resources.patches.combine.withVariables

withVariables(variables)

"Variables are the list of variables whose values will be retrieved and\ncombined."

fn resources.patches.combine.withVariablesMixin

withVariablesMixin(variables)

"Variables are the list of variables whose values will be retrieved and\ncombined."

Note: This function appends passed data to existing values

obj resources.patches.combine.string

"String declares that input variables should be combined into a single\nstring, using the relevant settings for formatting purposes."

fn resources.patches.combine.string.withFmt

withFmt(fmt)

"Format the input using a Go format string. See\nhttps://golang.org/pkg/fmt/ for details."

obj resources.patches.combine.variables

"Variables are the list of variables whose values will be retrieved and\ncombined."

fn resources.patches.combine.variables.withFromFieldPath

withFromFieldPath(fromFieldPath)

"FromFieldPath is the path of the field on the source whose value is\nto be used as input."

obj resources.patches.policy

"Policy configures the specifics of patching behaviour."

fn resources.patches.policy.withFromFieldPath

withFromFieldPath(fromFieldPath)

"FromFieldPath specifies how to patch from a field path. The default is\n'Optional', which means the patch will be a no-op if the specified\nfromFieldPath does not exist. Use 'Required' to prevent the creation of a\nnew composed resource until the required path exists."

fn resources.patches.policy.withToFieldPath

withToFieldPath(toFieldPath)

"ToFieldPath specifies how to patch to a field path. The default is\n'Replace', which means the patch will completely replace the target field,\nor create it if it does not exist. Use 'MergeObjects' to recursively merge the patch\nobject with the target object, while keeping target object keys, but overwriting any array values, or use\n'MergeObjectsAppendArrays' to recursively merge the patch object with the target object, while keeping\ntarget object keys and appending any array values to target array values, or use\n'ForceMergeObjects' to recursively merge the patch object with the target object, overwriting\nany target object keys, including array values, or use\n'ForceMergeObjectsAppendArrays' to recursively merge the patch object with the target object,\noverwriting target object keys, and appending any array values to target array values.\n'MergeObject' is deprecated, use 'MergeObjects' instead, which is functionally identical.\n'AppendArray' is deprecated, use 'ForceMergeObjectsAppendArrays' instead, which is functionally identical."

obj resources.patches.transforms

"Transforms are the list of functions that are used as a FIFO pipe for the\ninput to be transformed."

fn resources.patches.transforms.withMap

withMap(map)

"Map uses the input as a key in the given map and returns the value."

fn resources.patches.transforms.withMapMixin

withMapMixin(map)

"Map uses the input as a key in the given map and returns the value."

Note: This function appends passed data to existing values

fn resources.patches.transforms.withType

withType(type)

"Type of the transform to be run."

obj resources.patches.transforms.convert

"Convert is used to cast the input into the given output type."

fn resources.patches.transforms.convert.withFormat

withFormat(format)

"The expected input format.\n\n\n quantity - parses the input as a K8s resource.Quantity.\nOnly used during string -> float64 conversions.\n json - parses the input as a JSON string.\nOnly used during string -> object or string -> list conversions.\n\n\nIf this property is null, the default conversion is applied."

fn resources.patches.transforms.convert.withToType

withToType(toType)

"ToType is the type of the output of this transform."

obj resources.patches.transforms.match

"Match is a more complex version of Map that matches a list of patterns."

fn resources.patches.transforms.match.withFallbackTo

withFallbackTo(fallbackTo)

"Determines to what value the transform should fallback if no pattern matches."

fn resources.patches.transforms.match.withFallbackValue

withFallbackValue(fallbackValue)

"The fallback value that should be returned by the transform if now pattern\nmatches."

fn resources.patches.transforms.match.withPatterns

withPatterns(patterns)

"The patterns that should be tested against the input string.\nPatterns are tested in order. The value of the first match is used as\nresult of this transform."

fn resources.patches.transforms.match.withPatternsMixin

withPatternsMixin(patterns)

"The patterns that should be tested against the input string.\nPatterns are tested in order. The value of the first match is used as\nresult of this transform."

Note: This function appends passed data to existing values

obj resources.patches.transforms.match.patterns

"The patterns that should be tested against the input string.\nPatterns are tested in order. The value of the first match is used as\nresult of this transform."

fn resources.patches.transforms.match.patterns.withLiteral

withLiteral(literal)

"Literal exactly matches the input string (case sensitive).\nIs required if type is literal."

fn resources.patches.transforms.match.patterns.withRegexp

withRegexp(regexp)

"Regexp to match against the input string.\nIs required if type is regexp."

fn resources.patches.transforms.match.patterns.withResult

withResult(result)

"The value that is used as result of the transform if the pattern matches."

fn resources.patches.transforms.match.patterns.withType

withType(type)

"Type specifies how the pattern matches the input.\n\n\n literal - the pattern value has to exactly match (case sensitive) the\ninput string. This is the default.\n\n\n regexp - the pattern treated as a regular expression against\nwhich the input string is tested. Crossplane will throw an error if the\nkey is not a valid regexp."

obj resources.patches.transforms.math

"Math is used to transform the input via mathematical operations such as\nmultiplication."

fn resources.patches.transforms.math.withClampMax

withClampMax(clampMax)

"ClampMax makes sure that the value is not bigger than the given value."

fn resources.patches.transforms.math.withClampMin

withClampMin(clampMin)

"ClampMin makes sure that the value is not smaller than the given value."

fn resources.patches.transforms.math.withMultiply

withMultiply(multiply)

"Multiply the value."

fn resources.patches.transforms.math.withType

withType(type)

"Type of the math transform to be run."

obj resources.patches.transforms.string

"String is used to transform the input into a string or a different kind\nof string. Note that the input does not necessarily need to be a string."

fn resources.patches.transforms.string.withConvert

withConvert(convert)

"Optional conversion method to be specified.\nToUpper and ToLower change the letter case of the input string.\nToBase64 and FromBase64 perform a base64 conversion based on the input string.\nToJson converts any input value into its raw JSON representation.\nToSha1, ToSha256 and ToSha512 generate a hash value based on the input\nconverted to JSON."

fn resources.patches.transforms.string.withFmt

withFmt(fmt)

"Format the input using a Go format string. See\nhttps://golang.org/pkg/fmt/ for details."

fn resources.patches.transforms.string.withTrim

withTrim(trim)

"Trim the prefix or suffix from the input"

fn resources.patches.transforms.string.withType

withType(type)

"Type of the string transform to be run."

obj resources.patches.transforms.string.join

"Join the input strings."

fn resources.patches.transforms.string.join.withSeparator

withSeparator(separator)

"Separator to join the input strings."

obj resources.patches.transforms.string.regexp

"Extract a match from the input using a regular expression."

fn resources.patches.transforms.string.regexp.withGroup

withGroup(group)

"Group number to match. 0 (the default) matches the entire expression."

fn resources.patches.transforms.string.regexp.withMatch

withMatch(match)

"Match string. May optionally include submatches, aka capture groups.\nSee https://pkg.go.dev/regexp/ for details."

obj resources.patches.transforms.string.replace

"Search/Replace applied to the input string."

fn resources.patches.transforms.string.replace.withReplace

withReplace(replace)

"The Replace string replaces all occurrences of the search string."

fn resources.patches.transforms.string.replace.withSearch

withSearch(search)

"The Search string to match."

obj resources.readinessChecks

"ReadinessChecks allows users to define custom readiness checks. All\nchecks have to return true in order for resource to be considered ready.\nThe default readiness check is to have the \"Ready\" condition to be\n\"True\"."

fn resources.readinessChecks.withFieldPath

withFieldPath(fieldPath)

"FieldPath shows the path of the field whose value will be used."

fn resources.readinessChecks.withMatchInteger

withMatchInteger(matchInteger)

"MatchInt is the value you'd like to match if you're using \"MatchInt\" type."

fn resources.readinessChecks.withMatchString

withMatchString(matchString)

"MatchString is the value you'd like to match if you're using \"MatchString\" type."

fn resources.readinessChecks.withType

withType(type)

"Type indicates the type of probe you'd like to use."

obj resources.readinessChecks.matchCondition

"MatchCondition specifies the condition you'd like to match if you're using \"MatchCondition\" type."

fn resources.readinessChecks.matchCondition.withType

withType(type)

"Type indicates the type of condition you'd like to use."