Skip to content

build.v1.buildRequest

"BuildRequest is the resource used to pass parameters to build generator"

Index

Fields

fn new

new(name)

new returns an instance of BuildRequest

fn withEnv

withEnv(env)

"env contains additional environment variables you want to pass into a builder container."

fn withEnvMixin

withEnvMixin(env)

"env contains additional environment variables you want to pass into a builder container."

Note: This function appends passed data to existing values

fn withLastVersion

withLastVersion(lastVersion)

"lastVersion (optional) is the LastVersion of the BuildConfig that was used to generate the build. If the BuildConfig in the generator doesn't match, a build will not be generated."

fn withTriggeredBy

withTriggeredBy(triggeredBy)

"triggeredBy describes which triggers started the most recent update to the build configuration and contains information about those triggers."

fn withTriggeredByMixin

withTriggeredByMixin(triggeredBy)

"triggeredBy describes which triggers started the most recent update to the build configuration and contains information about those triggers."

Note: This function appends passed data to existing values

obj binary

"BinaryBuildSource describes a binary file to be used for the Docker and Source build strategies, where the file will be extracted and used as the build source."

fn binary.withAsFile

withAsFile(asFile)

"asFile indicates that the provided binary input should be considered a single file within the build input. For example, specifying \"webapp.war\" would place the provided binary as /webapp.war for the builder. If left empty, the Docker and Source build strategies assume this file is a zip, tar, or tar.gz file and extract it as the source. The custom strategy receives this binary as standard input. This filename may not contain slashes or be '..' or '.'."

obj dockerStrategyOptions

"DockerStrategyOptions contains extra strategy options for Docker builds"

fn dockerStrategyOptions.withBuildArgs

withBuildArgs(buildArgs)

"Args contains any build arguments that are to be passed to Docker. See https://docs.docker.com/engine/reference/builder/#/arg for more details"

fn dockerStrategyOptions.withBuildArgsMixin

withBuildArgsMixin(buildArgs)

"Args contains any build arguments that are to be passed to Docker. See https://docs.docker.com/engine/reference/builder/#/arg for more details"

Note: This function appends passed data to existing values

fn dockerStrategyOptions.withNoCache

withNoCache(noCache)

"noCache overrides the docker-strategy noCache option in the build config"

obj from

"ObjectReference contains enough information to let you inspect or modify the referred object."

fn from.withApiVersion

withApiVersion(apiVersion)

"API version of the referent."

fn from.withFieldPath

withFieldPath(fieldPath)

"If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: \"spec.containers{name}\" (where \"name\" refers to the name of the container that triggered the event) or if no container name is specified \"spec.containers[2]\" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object."

fn from.withKind

withKind(kind)

"Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"

fn from.withName

withName(name)

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

fn from.withNamespace

withNamespace(namespace)

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

fn from.withResourceVersion

withResourceVersion(resourceVersion)

"Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency"

fn from.withUid

withUid(uid)

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

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)

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)

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."

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."

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/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 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/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only."

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 metadata.initializers

"Initializers tracks the progress of initialization."

fn metadata.initializers.withPending

withPending(pending)

"Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients."

fn metadata.initializers.withPendingMixin

withPendingMixin(pending)

"Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients."

Note: This function appends passed data to existing values

obj metadata.initializers.result

"Status is a return value for calls that don't return other objects."

fn metadata.initializers.result.withApiVersion

withApiVersion(apiVersion)

"APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources"

fn metadata.initializers.result.withCode

withCode(code)

"Suggested HTTP return code for this status, 0 if not set."

fn metadata.initializers.result.withKind

withKind(kind)

"Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"

fn metadata.initializers.result.withMessage

withMessage(message)

"A human-readable description of the status of this operation."

fn metadata.initializers.result.withMetadata

withMetadata(metadata)

"Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"

fn metadata.initializers.result.withReason

withReason(reason)

"A machine-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it."

obj metadata.initializers.result.details

"StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined."

fn metadata.initializers.result.details.withCauses

withCauses(causes)

"The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes."

fn metadata.initializers.result.details.withCausesMixin

withCausesMixin(causes)

"The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes."

Note: This function appends passed data to existing values

fn metadata.initializers.result.details.withGroup

withGroup(group)

"The group attribute of the resource associated with the status StatusReason."

fn metadata.initializers.result.details.withKind

withKind(kind)

"The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"

fn metadata.initializers.result.details.withName

withName(name)

"The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described)."

fn metadata.initializers.result.details.withRetryAfterSeconds

withRetryAfterSeconds(retryAfterSeconds)

"If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action."

fn metadata.initializers.result.details.withUid

withUid(uid)

"UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj revision

"SourceRevision is the revision or commit information from the source for the build"

fn revision.withType

withType(type)

"type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images'"

obj revision.git

"GitSourceRevision is the commit information from a git source for a build"

fn revision.git.withCommit

withCommit(commit)

"commit is the commit hash identifying a specific commit"

fn revision.git.withMessage

withMessage(message)

"message is the description of a specific commit"

obj revision.git.author

"SourceControlUser defines the identity of a user of source control"

fn revision.git.author.withEmail

withEmail(email)

"email of the source control user"

fn revision.git.author.withName

withName(name)

"name of the source control user"

obj revision.git.committer

"SourceControlUser defines the identity of a user of source control"

fn revision.git.committer.withEmail

withEmail(email)

"email of the source control user"

fn revision.git.committer.withName

withName(name)

"name of the source control user"

obj sourceStrategyOptions

"SourceStrategyOptions contains extra strategy options for Source builds"

fn sourceStrategyOptions.withIncremental

withIncremental(incremental)

"incremental overrides the source-strategy incremental option in the build config"

obj triggeredByImage

"ObjectReference contains enough information to let you inspect or modify the referred object."

fn triggeredByImage.withApiVersion

withApiVersion(apiVersion)

"API version of the referent."

fn triggeredByImage.withFieldPath

withFieldPath(fieldPath)

"If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: \"spec.containers{name}\" (where \"name\" refers to the name of the container that triggered the event) or if no container name is specified \"spec.containers[2]\" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object."

fn triggeredByImage.withKind

withKind(kind)

"Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"

fn triggeredByImage.withName

withName(name)

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

fn triggeredByImage.withNamespace

withNamespace(namespace)

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

fn triggeredByImage.withResourceVersion

withResourceVersion(resourceVersion)

"Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency"

fn triggeredByImage.withUid

withUid(uid)

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