cloudbuild.v1beta1.trigger
"Trigger is the Schema for the Triggers API. Configuration for an automated build in response to source repository changes."
Index
fn new(name)obj metadatafn 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 specfn withDeletionPolicy(deletionPolicy)fn withManagementPolicies(managementPolicies)fn withManagementPoliciesMixin(managementPolicies)obj spec.forProviderfn withApprovalConfig(approvalConfig)fn withApprovalConfigMixin(approvalConfig)fn withBitbucketServerTriggerConfig(bitbucketServerTriggerConfig)fn withBitbucketServerTriggerConfigMixin(bitbucketServerTriggerConfig)fn withBuild(build)fn withBuildMixin(build)fn withDescription(description)fn withDisabled(disabled)fn withFilename(filename)fn withFilter(filter)fn withGitFileSource(gitFileSource)fn withGitFileSourceMixin(gitFileSource)fn withGithub(github)fn withGithubMixin(github)fn withIgnoredFiles(ignoredFiles)fn withIgnoredFilesMixin(ignoredFiles)fn withIncludeBuildLogs(includeBuildLogs)fn withIncludedFiles(includedFiles)fn withIncludedFilesMixin(includedFiles)fn withLocation(location)fn withName(name)fn withProject(project)fn withPubsubConfig(pubsubConfig)fn withPubsubConfigMixin(pubsubConfig)fn withServiceAccount(serviceAccount)fn withSourceToBuild(sourceToBuild)fn withSourceToBuildMixin(sourceToBuild)fn withSubstitutions(substitutions)fn withSubstitutionsMixin(substitutions)fn withTags(tags)fn withTagsMixin(tags)fn withTriggerTemplate(triggerTemplate)fn withTriggerTemplateMixin(triggerTemplate)fn withWebhookConfig(webhookConfig)fn withWebhookConfigMixin(webhookConfig)obj spec.forProvider.approvalConfigobj spec.forProvider.bitbucketServerTriggerConfigfn withBitbucketServerConfigResource(bitbucketServerConfigResource)fn withProjectKey(projectKey)fn withPullRequest(pullRequest)fn withPullRequestMixin(pullRequest)fn withPush(push)fn withPushMixin(push)fn withRepoSlug(repoSlug)obj spec.forProvider.bitbucketServerTriggerConfig.pullRequestobj spec.forProvider.bitbucketServerTriggerConfig.push
obj spec.forProvider.buildfn withArtifacts(artifacts)fn withArtifactsMixin(artifacts)fn withAvailableSecrets(availableSecrets)fn withAvailableSecretsMixin(availableSecrets)fn withImages(images)fn withImagesMixin(images)fn withLogsBucket(logsBucket)fn withOptions(options)fn withOptionsMixin(options)fn withQueueTtl(queueTtl)fn withSecret(secret)fn withSecretMixin(secret)fn withSource(source)fn withSourceMixin(source)fn withStep(step)fn withStepMixin(step)fn withSubstitutions(substitutions)fn withSubstitutionsMixin(substitutions)fn withTags(tags)fn withTagsMixin(tags)fn withTimeout(timeout)obj spec.forProvider.build.artifactsobj spec.forProvider.build.availableSecretsobj spec.forProvider.build.optionsfn withDiskSizeGb(diskSizeGb)fn withDynamicSubstitutions(dynamicSubstitutions)fn withEnv(env)fn withEnvMixin(env)fn withLogStreamingOption(logStreamingOption)fn withLogging(logging)fn withMachineType(machineType)fn withRequestedVerifyOption(requestedVerifyOption)fn withSecretEnv(secretEnv)fn withSecretEnvMixin(secretEnv)fn withSourceProvenanceHash(sourceProvenanceHash)fn withSourceProvenanceHashMixin(sourceProvenanceHash)fn withSubstitutionOption(substitutionOption)fn withVolumes(volumes)fn withVolumesMixin(volumes)fn withWorkerPool(workerPool)obj spec.forProvider.build.options.volumes
obj spec.forProvider.build.secretobj spec.forProvider.build.sourceobj spec.forProvider.build.stepfn withAllowExitCodes(allowExitCodes)fn withAllowExitCodesMixin(allowExitCodes)fn withAllowFailure(allowFailure)fn withArgs(args)fn withArgsMixin(args)fn withDir(dir)fn withEntrypoint(entrypoint)fn withEnv(env)fn withEnvMixin(env)fn withId(id)fn withName(name)fn withScript(script)fn withSecretEnv(secretEnv)fn withSecretEnvMixin(secretEnv)fn withTimeout(timeout)fn withTiming(timing)fn withVolumes(volumes)fn withVolumesMixin(volumes)fn withWaitFor(waitFor)fn withWaitForMixin(waitFor)obj spec.forProvider.build.step.volumes
obj spec.forProvider.gitFileSourceobj spec.forProvider.githubobj spec.forProvider.pubsubConfigobj spec.forProvider.serviceAccountRefobj spec.forProvider.serviceAccountSelectorobj spec.forProvider.sourceToBuildobj spec.forProvider.triggerTemplateobj spec.forProvider.webhookConfig
obj spec.initProviderfn withApprovalConfig(approvalConfig)fn withApprovalConfigMixin(approvalConfig)fn withBitbucketServerTriggerConfig(bitbucketServerTriggerConfig)fn withBitbucketServerTriggerConfigMixin(bitbucketServerTriggerConfig)fn withBuild(build)fn withBuildMixin(build)fn withDescription(description)fn withDisabled(disabled)fn withFilename(filename)fn withFilter(filter)fn withGitFileSource(gitFileSource)fn withGitFileSourceMixin(gitFileSource)fn withGithub(github)fn withGithubMixin(github)fn withIgnoredFiles(ignoredFiles)fn withIgnoredFilesMixin(ignoredFiles)fn withIncludeBuildLogs(includeBuildLogs)fn withIncludedFiles(includedFiles)fn withIncludedFilesMixin(includedFiles)fn withLocation(location)fn withName(name)fn withProject(project)fn withPubsubConfig(pubsubConfig)fn withPubsubConfigMixin(pubsubConfig)fn withSourceToBuild(sourceToBuild)fn withSourceToBuildMixin(sourceToBuild)fn withSubstitutions(substitutions)fn withSubstitutionsMixin(substitutions)fn withTags(tags)fn withTagsMixin(tags)fn withTriggerTemplate(triggerTemplate)fn withTriggerTemplateMixin(triggerTemplate)fn withWebhookConfig(webhookConfig)fn withWebhookConfigMixin(webhookConfig)obj spec.initProvider.approvalConfigobj spec.initProvider.bitbucketServerTriggerConfigfn withBitbucketServerConfigResource(bitbucketServerConfigResource)fn withProjectKey(projectKey)fn withPullRequest(pullRequest)fn withPullRequestMixin(pullRequest)fn withPush(push)fn withPushMixin(push)fn withRepoSlug(repoSlug)obj spec.initProvider.bitbucketServerTriggerConfig.pullRequestobj spec.initProvider.bitbucketServerTriggerConfig.push
obj spec.initProvider.buildfn withArtifacts(artifacts)fn withArtifactsMixin(artifacts)fn withAvailableSecrets(availableSecrets)fn withAvailableSecretsMixin(availableSecrets)fn withImages(images)fn withImagesMixin(images)fn withLogsBucket(logsBucket)fn withOptions(options)fn withOptionsMixin(options)fn withQueueTtl(queueTtl)fn withSecret(secret)fn withSecretMixin(secret)fn withSource(source)fn withSourceMixin(source)fn withStep(step)fn withStepMixin(step)fn withSubstitutions(substitutions)fn withSubstitutionsMixin(substitutions)fn withTags(tags)fn withTagsMixin(tags)fn withTimeout(timeout)obj spec.initProvider.build.artifactsobj spec.initProvider.build.availableSecretsobj spec.initProvider.build.optionsfn withDiskSizeGb(diskSizeGb)fn withDynamicSubstitutions(dynamicSubstitutions)fn withEnv(env)fn withEnvMixin(env)fn withLogStreamingOption(logStreamingOption)fn withLogging(logging)fn withMachineType(machineType)fn withRequestedVerifyOption(requestedVerifyOption)fn withSecretEnv(secretEnv)fn withSecretEnvMixin(secretEnv)fn withSourceProvenanceHash(sourceProvenanceHash)fn withSourceProvenanceHashMixin(sourceProvenanceHash)fn withSubstitutionOption(substitutionOption)fn withVolumes(volumes)fn withVolumesMixin(volumes)fn withWorkerPool(workerPool)obj spec.initProvider.build.options.volumes
obj spec.initProvider.build.secretobj spec.initProvider.build.sourceobj spec.initProvider.build.stepfn withAllowExitCodes(allowExitCodes)fn withAllowExitCodesMixin(allowExitCodes)fn withAllowFailure(allowFailure)fn withArgs(args)fn withArgsMixin(args)fn withDir(dir)fn withEntrypoint(entrypoint)fn withEnv(env)fn withEnvMixin(env)fn withId(id)fn withName(name)fn withScript(script)fn withSecretEnv(secretEnv)fn withSecretEnvMixin(secretEnv)fn withTimeout(timeout)fn withTiming(timing)fn withVolumes(volumes)fn withVolumesMixin(volumes)fn withWaitFor(waitFor)fn withWaitForMixin(waitFor)obj spec.initProvider.build.step.volumes
obj spec.initProvider.gitFileSourceobj spec.initProvider.githubobj spec.initProvider.pubsubConfigobj spec.initProvider.sourceToBuildobj spec.initProvider.triggerTemplate
obj spec.providerConfigRefobj spec.providerRefobj spec.publishConnectionDetailsToobj spec.writeConnectionSecretToRef
Fields
fn new
new(name)
new returns an instance of Trigger
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
"TriggerSpec defines the desired state of Trigger"
fn spec.withDeletionPolicy
withDeletionPolicy(deletionPolicy)
"DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either \"Delete\" or \"Orphan\" the external resource. This field is planned to be deprecated in favor of the ManagementPolicies field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223"
fn spec.withManagementPolicies
withManagementPolicies(managementPolicies)
"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md"
fn spec.withManagementPoliciesMixin
withManagementPoliciesMixin(managementPolicies)
"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md"
Note: This function appends passed data to existing values
obj spec.forProvider
fn spec.forProvider.withApprovalConfig
withApprovalConfig(approvalConfig)
"Configuration for manual approval to start a build invocation of this BuildTrigger. Builds created by this trigger will require approval before they execute. Any user with a Cloud Build Approver role for the project can approve a build. Structure is documented below."
fn spec.forProvider.withApprovalConfigMixin
withApprovalConfigMixin(approvalConfig)
"Configuration for manual approval to start a build invocation of this BuildTrigger. Builds created by this trigger will require approval before they execute. Any user with a Cloud Build Approver role for the project can approve a build. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.withBitbucketServerTriggerConfig
withBitbucketServerTriggerConfig(bitbucketServerTriggerConfig)
"BitbucketServerTriggerConfig describes the configuration of a trigger that creates a build whenever a Bitbucket Server event is received. Structure is documented below."
fn spec.forProvider.withBitbucketServerTriggerConfigMixin
withBitbucketServerTriggerConfigMixin(bitbucketServerTriggerConfig)
"BitbucketServerTriggerConfig describes the configuration of a trigger that creates a build whenever a Bitbucket Server event is received. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.withBuild
withBuild(build)
"Contents of the build template. Either a filename or build template must be provided. Structure is documented below."
fn spec.forProvider.withBuildMixin
withBuildMixin(build)
"Contents of the build template. Either a filename or build template must be provided. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.withDescription
withDescription(description)
"Human-readable description of the trigger."
fn spec.forProvider.withDisabled
withDisabled(disabled)
"Whether the trigger is disabled or not. If true, the trigger will never result in a build."
fn spec.forProvider.withFilename
withFilename(filename)
"Path, from the source root, to a file whose contents is used for the template. Either a filename or build template must be provided. Set this only when using trigger_template or github. When using Pub/Sub, Webhook or Manual set the file name using git_file_source instead."
fn spec.forProvider.withFilter
withFilter(filter)
"A Common Expression Language string. Used only with Pub/Sub and Webhook."
fn spec.forProvider.withGitFileSource
withGitFileSource(gitFileSource)
"The file source describing the local or remote Build template. Structure is documented below."
fn spec.forProvider.withGitFileSourceMixin
withGitFileSourceMixin(gitFileSource)
"The file source describing the local or remote Build template. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.withGithub
withGithub(github)
"Describes the configuration of a trigger that creates a build whenever a GitHub event is received. One of trigger_template, github, pubsub_config or webhook_config must be provided. Structure is documented below."
fn spec.forProvider.withGithubMixin
withGithubMixin(github)
"Describes the configuration of a trigger that creates a build whenever a GitHub event is received. One of trigger_template, github, pubsub_config or webhook_config must be provided. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.withIgnoredFiles
withIgnoredFiles(ignoredFiles)
"ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for **. If ignoredFiles and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignoredFiles is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignoredFiles globs, then we do not trigger a build."
fn spec.forProvider.withIgnoredFilesMixin
withIgnoredFilesMixin(ignoredFiles)
"ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for **. If ignoredFiles and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignoredFiles is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignoredFiles globs, then we do not trigger a build."
Note: This function appends passed data to existing values
fn spec.forProvider.withIncludeBuildLogs
withIncludeBuildLogs(includeBuildLogs)
"Build logs will be sent back to GitHub as part of the checkrun result. Values can be INCLUDE_BUILD_LOGS_UNSPECIFIED or INCLUDE_BUILD_LOGS_WITH_STATUS Possible values are: INCLUDE_BUILD_LOGS_UNSPECIFIED, INCLUDE_BUILD_LOGS_WITH_STATUS."
fn spec.forProvider.withIncludedFiles
withIncludedFiles(includedFiles)
"ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for **. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is not empty, then we make sure that at least one of those files matches a includedFiles glob. If not, then we do not trigger a build."
fn spec.forProvider.withIncludedFilesMixin
withIncludedFilesMixin(includedFiles)
"ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for **. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is not empty, then we make sure that at least one of those files matches a includedFiles glob. If not, then we do not trigger a build."
Note: This function appends passed data to existing values
fn spec.forProvider.withLocation
withLocation(location)
"The Cloud Build location for the trigger. If not specified, \"global\" is used."
fn spec.forProvider.withName
withName(name)
"Name of the trigger. Must be unique within the project."
fn spec.forProvider.withProject
withProject(project)
"The ID of the project in which the resource belongs. If it is not provided, the provider project is used."
fn spec.forProvider.withPubsubConfig
withPubsubConfig(pubsubConfig)
"PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published. One of trigger_template, github, pubsub_config webhook_config or source_to_build must be provided. Structure is documented below."
fn spec.forProvider.withPubsubConfigMixin
withPubsubConfigMixin(pubsubConfig)
"PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published. One of trigger_template, github, pubsub_config webhook_config or source_to_build must be provided. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.withServiceAccount
withServiceAccount(serviceAccount)
"The service account used for all user-controlled operations including triggers.patch, triggers.run, builds.create, and builds.cancel. If no service account is set, then the standard Cloud Build service account ([PROJECT_NUM]@system.gserviceaccount.com) will be used instead. Format: projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}"
fn spec.forProvider.withSourceToBuild
withSourceToBuild(sourceToBuild)
"The repo and ref of the repository from which to build. This field is used only for those triggers that do not respond to SCM events. Triggers that respond to such events build source at whatever commit caused the event. This field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers. One of trigger_template, github, pubsub_config webhook_config or source_to_build must be provided. Structure is documented below."
fn spec.forProvider.withSourceToBuildMixin
withSourceToBuildMixin(sourceToBuild)
"The repo and ref of the repository from which to build. This field is used only for those triggers that do not respond to SCM events. Triggers that respond to such events build source at whatever commit caused the event. This field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers. One of trigger_template, github, pubsub_config webhook_config or source_to_build must be provided. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.withSubstitutions
withSubstitutions(substitutions)
"Substitutions data for Build resource."
fn spec.forProvider.withSubstitutionsMixin
withSubstitutionsMixin(substitutions)
"Substitutions data for Build resource."
Note: This function appends passed data to existing values
fn spec.forProvider.withTags
withTags(tags)
"Tags for annotation of a BuildTrigger"
fn spec.forProvider.withTagsMixin
withTagsMixin(tags)
"Tags for annotation of a BuildTrigger"
Note: This function appends passed data to existing values
fn spec.forProvider.withTriggerTemplate
withTriggerTemplate(triggerTemplate)
"Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. One of trigger_template, github, pubsub_config, webhook_config or source_to_build must be provided. Structure is documented below."
fn spec.forProvider.withTriggerTemplateMixin
withTriggerTemplateMixin(triggerTemplate)
"Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. One of trigger_template, github, pubsub_config, webhook_config or source_to_build must be provided. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.withWebhookConfig
withWebhookConfig(webhookConfig)
"WebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger's webhook URL. One of trigger_template, github, pubsub_config webhook_config or source_to_build must be provided. Structure is documented below."
fn spec.forProvider.withWebhookConfigMixin
withWebhookConfigMixin(webhookConfig)
"WebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger's webhook URL. One of trigger_template, github, pubsub_config webhook_config or source_to_build must be provided. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.forProvider.approvalConfig
"Configuration for manual approval to start a build invocation of this BuildTrigger. Builds created by this trigger will require approval before they execute. Any user with a Cloud Build Approver role for the project can approve a build. Structure is documented below."
fn spec.forProvider.approvalConfig.withApprovalRequired
withApprovalRequired(approvalRequired)
"Whether or not approval is needed. If this is set on a build, it will become pending when run, and will need to be explicitly approved to start."
obj spec.forProvider.bitbucketServerTriggerConfig
"BitbucketServerTriggerConfig describes the configuration of a trigger that creates a build whenever a Bitbucket Server event is received. Structure is documented below."
fn spec.forProvider.bitbucketServerTriggerConfig.withBitbucketServerConfigResource
withBitbucketServerConfigResource(bitbucketServerConfigResource)
"The Bitbucket server config resource that this trigger config maps to."
fn spec.forProvider.bitbucketServerTriggerConfig.withProjectKey
withProjectKey(projectKey)
"Key of the project that the repo is in. For example: The key for https://mybitbucket.server/projects/TEST/repos/test-repo is \"TEST\"."
fn spec.forProvider.bitbucketServerTriggerConfig.withPullRequest
withPullRequest(pullRequest)
"Filter to match changes in pull requests. Structure is documented below."
fn spec.forProvider.bitbucketServerTriggerConfig.withPullRequestMixin
withPullRequestMixin(pullRequest)
"Filter to match changes in pull requests. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.bitbucketServerTriggerConfig.withPush
withPush(push)
"Filter to match changes in refs like branches, tags. Structure is documented below."
fn spec.forProvider.bitbucketServerTriggerConfig.withPushMixin
withPushMixin(push)
"Filter to match changes in refs like branches, tags. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.bitbucketServerTriggerConfig.withRepoSlug
withRepoSlug(repoSlug)
"Slug of the repository. A repository slug is a URL-friendly version of a repository name, automatically generated by Bitbucket for use in the URL. For example, if the repository name is 'test repo', in the URL it would become 'test-repo' as in https://mybitbucket.server/projects/TEST/repos/test-repo."
obj spec.forProvider.bitbucketServerTriggerConfig.pullRequest
"Filter to match changes in pull requests. Structure is documented below."
fn spec.forProvider.bitbucketServerTriggerConfig.pullRequest.withBranch
withBranch(branch)
"Regex of branches to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax"
fn spec.forProvider.bitbucketServerTriggerConfig.pullRequest.withCommentControl
withCommentControl(commentControl)
"Configure builds to run whether a repository owner or collaborator need to comment /gcbrun. Possible values are: COMMENTS_DISABLED, COMMENTS_ENABLED, COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY."
fn spec.forProvider.bitbucketServerTriggerConfig.pullRequest.withInvertRegex
withInvertRegex(invertRegex)
"Only trigger a build if the revision regex does NOT match the revision regex."
obj spec.forProvider.bitbucketServerTriggerConfig.push
"Filter to match changes in refs like branches, tags. Structure is documented below."
fn spec.forProvider.bitbucketServerTriggerConfig.push.withBranch
withBranch(branch)
"Regex of branches to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax"
fn spec.forProvider.bitbucketServerTriggerConfig.push.withInvertRegex
withInvertRegex(invertRegex)
"Only trigger a build if the revision regex does NOT match the revision regex."
fn spec.forProvider.bitbucketServerTriggerConfig.push.withTag
withTag(tag)
"Regex of tags to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax"
obj spec.forProvider.build
"Contents of the build template. Either a filename or build template must be provided. Structure is documented below."
fn spec.forProvider.build.withArtifacts
withArtifacts(artifacts)
"Artifacts produced by the build that should be uploaded upon successful completion of all build steps. Structure is documented below."
fn spec.forProvider.build.withArtifactsMixin
withArtifactsMixin(artifacts)
"Artifacts produced by the build that should be uploaded upon successful completion of all build steps. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.build.withAvailableSecrets
withAvailableSecrets(availableSecrets)
"Secrets and secret environment variables. Structure is documented below."
fn spec.forProvider.build.withAvailableSecretsMixin
withAvailableSecretsMixin(availableSecrets)
"Secrets and secret environment variables. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.build.withImages
withImages(images)
"A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build status is marked FAILURE."
fn spec.forProvider.build.withImagesMixin
withImagesMixin(images)
"A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build status is marked FAILURE."
Note: This function appends passed data to existing values
fn spec.forProvider.build.withLogsBucket
withLogsBucket(logsBucket)
"Google Cloud Storage bucket where logs should be written. Logs file names will be of the format ${logsBucket}/log-${build_id}.txt."
fn spec.forProvider.build.withOptions
withOptions(options)
"Special options for this build. Structure is documented below."
fn spec.forProvider.build.withOptionsMixin
withOptionsMixin(options)
"Special options for this build. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.build.withQueueTtl
withQueueTtl(queueTtl)
"TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be EXPIRED. The TTL starts ticking from createTime. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: \"3.5s\"."
fn spec.forProvider.build.withSecret
withSecret(secret)
"Secrets to decrypt using Cloud Key Management Service. Structure is documented below."
fn spec.forProvider.build.withSecretMixin
withSecretMixin(secret)
"Secrets to decrypt using Cloud Key Management Service. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.build.withSource
withSource(source)
"The location of the source files to build. One of storageSource or repoSource must be provided. Structure is documented below."
fn spec.forProvider.build.withSourceMixin
withSourceMixin(source)
"The location of the source files to build. One of storageSource or repoSource must be provided. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.build.withStep
withStep(step)
"The operations to be performed on the workspace. Structure is documented below."
fn spec.forProvider.build.withStepMixin
withStepMixin(step)
"The operations to be performed on the workspace. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.build.withSubstitutions
withSubstitutions(substitutions)
"Substitutions data for Build resource."
fn spec.forProvider.build.withSubstitutionsMixin
withSubstitutionsMixin(substitutions)
"Substitutions data for Build resource."
Note: This function appends passed data to existing values
fn spec.forProvider.build.withTags
withTags(tags)
"Tags for annotation of a Build. These are not docker tags."
fn spec.forProvider.build.withTagsMixin
withTagsMixin(tags)
"Tags for annotation of a Build. These are not docker tags."
Note: This function appends passed data to existing values
fn spec.forProvider.build.withTimeout
withTimeout(timeout)
"Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be TIMEOUT. This timeout must be equal to or greater than the sum of the timeouts for build steps within the build. The expected format is the number of seconds followed by s. Default time is ten minutes (600s)."
obj spec.forProvider.build.artifacts
"Artifacts produced by the build that should be uploaded upon successful completion of all build steps. Structure is documented below."
fn spec.forProvider.build.artifacts.withImages
withImages(images)
"A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build status is marked FAILURE."
fn spec.forProvider.build.artifacts.withImagesMixin
withImagesMixin(images)
"A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build status is marked FAILURE."
Note: This function appends passed data to existing values
fn spec.forProvider.build.artifacts.withObjects
withObjects(objects)
"A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE. Structure is documented below."
fn spec.forProvider.build.artifacts.withObjectsMixin
withObjectsMixin(objects)
"A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.forProvider.build.artifacts.objects
"A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE. Structure is documented below."
fn spec.forProvider.build.artifacts.objects.withLocation
withLocation(location)
"Cloud Storage bucket and optional object path, in the form \"gs://bucket/path/to/somewhere/\". Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix."
fn spec.forProvider.build.artifacts.objects.withPaths
withPaths(paths)
"Path globs used to match files in the build's workspace."
fn spec.forProvider.build.artifacts.objects.withPathsMixin
withPathsMixin(paths)
"Path globs used to match files in the build's workspace."
Note: This function appends passed data to existing values
obj spec.forProvider.build.availableSecrets
"Secrets and secret environment variables. Structure is documented below."
fn spec.forProvider.build.availableSecrets.withSecretManager
withSecretManager(secretManager)
"Pairs a secret environment variable with a SecretVersion in Secret Manager. Structure is documented below."
fn spec.forProvider.build.availableSecrets.withSecretManagerMixin
withSecretManagerMixin(secretManager)
"Pairs a secret environment variable with a SecretVersion in Secret Manager. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.forProvider.build.availableSecrets.secretManager
"Pairs a secret environment variable with a SecretVersion in Secret Manager. Structure is documented below."
fn spec.forProvider.build.availableSecrets.secretManager.withEnv
withEnv(env)
"A list of environment variable definitions to be used when running a step. The elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\" being given the value \"VALUE\"."
fn spec.forProvider.build.availableSecrets.secretManager.withVersionName
withVersionName(versionName)
"Resource name of the SecretVersion. In format: projects//secrets//versions/*"
obj spec.forProvider.build.options
"Special options for this build. Structure is documented below."
fn spec.forProvider.build.options.withDiskSizeGb
withDiskSizeGb(diskSizeGb)
"Requested disk size for the VM that runs the build. Note that this is NOT \"disk free\"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 1000GB; builds that request more than the maximum are rejected with an error."
fn spec.forProvider.build.options.withDynamicSubstitutions
withDynamicSubstitutions(dynamicSubstitutions)
"Option to specify whether or not to apply bash style string operations to the substitutions. NOTE this is always enabled for triggered builds and cannot be overridden in the build configuration file."
fn spec.forProvider.build.options.withEnv
withEnv(env)
"A list of environment variable definitions to be used when running a step. The elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\" being given the value \"VALUE\"."
fn spec.forProvider.build.options.withEnvMixin
withEnvMixin(env)
"A list of environment variable definitions to be used when running a step. The elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\" being given the value \"VALUE\"."
Note: This function appends passed data to existing values
fn spec.forProvider.build.options.withLogStreamingOption
withLogStreamingOption(logStreamingOption)
"Option to define build log streaming behavior to Google Cloud Storage. Possible values are: STREAM_DEFAULT, STREAM_ON, STREAM_OFF."
fn spec.forProvider.build.options.withLogging
withLogging(logging)
"Option to specify the logging mode, which determines if and where build logs are stored. Possible values are: LOGGING_UNSPECIFIED, LEGACY, GCS_ONLY, STACKDRIVER_ONLY, CLOUD_LOGGING_ONLY, NONE."
fn spec.forProvider.build.options.withMachineType
withMachineType(machineType)
"Compute Engine machine type on which to run the build. Possible values are: UNSPECIFIED, N1_HIGHCPU_8, N1_HIGHCPU_32, E2_HIGHCPU_8, E2_HIGHCPU_32."
fn spec.forProvider.build.options.withRequestedVerifyOption
withRequestedVerifyOption(requestedVerifyOption)
"Requested verifiability options. Possible values are: NOT_VERIFIED, VERIFIED."
fn spec.forProvider.build.options.withSecretEnv
withSecretEnv(secretEnv)
"A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret."
fn spec.forProvider.build.options.withSecretEnvMixin
withSecretEnvMixin(secretEnv)
"A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret."
Note: This function appends passed data to existing values
fn spec.forProvider.build.options.withSourceProvenanceHash
withSourceProvenanceHash(sourceProvenanceHash)
"Requested hash for SourceProvenance. Each value may be one of: NONE, SHA256, MD5."
fn spec.forProvider.build.options.withSourceProvenanceHashMixin
withSourceProvenanceHashMixin(sourceProvenanceHash)
"Requested hash for SourceProvenance. Each value may be one of: NONE, SHA256, MD5."
Note: This function appends passed data to existing values
fn spec.forProvider.build.options.withSubstitutionOption
withSubstitutionOption(substitutionOption)
"Option to specify behavior when there is an error in the substitution checks. NOTE this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file. Possible values are: MUST_MATCH, ALLOW_LOOSE."
fn spec.forProvider.build.options.withVolumes
withVolumes(volumes)
"List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. Structure is documented below."
fn spec.forProvider.build.options.withVolumesMixin
withVolumesMixin(volumes)
"List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.build.options.withWorkerPool
withWorkerPool(workerPool)
"Option to specify a WorkerPool for the build. Format projects/{project}/workerPools/{workerPool} This field is experimental."
obj spec.forProvider.build.options.volumes
"List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. Structure is documented below."
fn spec.forProvider.build.options.volumes.withName
withName(name)
"Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps."
fn spec.forProvider.build.options.volumes.withPath
withPath(path)
"Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths."
obj spec.forProvider.build.secret
"Secrets to decrypt using Cloud Key Management Service. Structure is documented below."
fn spec.forProvider.build.secret.withKmsKeyName
withKmsKeyName(kmsKeyName)
"Cloud KMS key name to use to decrypt these envs."
fn spec.forProvider.build.secret.withSecretEnv
withSecretEnv(secretEnv)
"A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret."
fn spec.forProvider.build.secret.withSecretEnvMixin
withSecretEnvMixin(secretEnv)
"A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret."
Note: This function appends passed data to existing values
obj spec.forProvider.build.source
"The location of the source files to build. One of storageSource or repoSource must be provided. Structure is documented below."
fn spec.forProvider.build.source.withRepoSource
withRepoSource(repoSource)
"Location of the source in a Google Cloud Source Repository. Structure is documented below."
fn spec.forProvider.build.source.withRepoSourceMixin
withRepoSourceMixin(repoSource)
"Location of the source in a Google Cloud Source Repository. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.build.source.withStorageSource
withStorageSource(storageSource)
"Location of the source in an archive file in Google Cloud Storage. Structure is documented below."
fn spec.forProvider.build.source.withStorageSourceMixin
withStorageSourceMixin(storageSource)
"Location of the source in an archive file in Google Cloud Storage. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.forProvider.build.source.repoSource
"Location of the source in a Google Cloud Source Repository. Structure is documented below."
fn spec.forProvider.build.source.repoSource.withBranchName
withBranchName(branchName)
"Name of the branch to build. Exactly one a of branch name, tag, or commit SHA must be provided. This field is a regular expression."
fn spec.forProvider.build.source.repoSource.withCommitSha
withCommitSha(commitSha)
"Explicit commit SHA to build. Exactly one of a branch name, tag, or commit SHA must be provided."
fn spec.forProvider.build.source.repoSource.withDir
withDir(dir)
"Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's dir is specified and is an absolute path, this value is ignored for that step's execution."
fn spec.forProvider.build.source.repoSource.withInvertRegex
withInvertRegex(invertRegex)
"Only trigger a build if the revision regex does NOT match the revision regex."
fn spec.forProvider.build.source.repoSource.withProjectId
withProjectId(projectId)
"ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed."
fn spec.forProvider.build.source.repoSource.withRepoName
withRepoName(repoName)
"Name of the Cloud Source Repository. If omitted, the name \"default\" is assumed."
fn spec.forProvider.build.source.repoSource.withSubstitutions
withSubstitutions(substitutions)
"Substitutions data for Build resource."
fn spec.forProvider.build.source.repoSource.withSubstitutionsMixin
withSubstitutionsMixin(substitutions)
"Substitutions data for Build resource."
Note: This function appends passed data to existing values
fn spec.forProvider.build.source.repoSource.withTagName
withTagName(tagName)
"Name of the tag to build. Exactly one of a branch name, tag, or commit SHA must be provided. This field is a regular expression."
obj spec.forProvider.build.source.storageSource
"Location of the source in an archive file in Google Cloud Storage. Structure is documented below."
fn spec.forProvider.build.source.storageSource.withBucket
withBucket(bucket)
"Google Cloud Storage bucket containing the source."
fn spec.forProvider.build.source.storageSource.withGeneration
withGeneration(generation)
"Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used"
fn spec.forProvider.build.source.storageSource.withObject
withObject(object)
"Google Cloud Storage object containing the source. This object must be a gzipped archive file (.tar.gz) containing source to build."
obj spec.forProvider.build.step
"The operations to be performed on the workspace. Structure is documented below."
fn spec.forProvider.build.step.withAllowExitCodes
withAllowExitCodes(allowExitCodes)
"Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes. If allowFailure is also specified, this field will take precedence."
fn spec.forProvider.build.step.withAllowExitCodesMixin
withAllowExitCodesMixin(allowExitCodes)
"Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes. If allowFailure is also specified, this field will take precedence."
Note: This function appends passed data to existing values
fn spec.forProvider.build.step.withAllowFailure
withAllowFailure(allowFailure)
"Allow this build step to fail without failing the entire build. If false, the entire build will fail if this step fails. Otherwise, the build will succeed, but this step will still have a failure status. Error information will be reported in the failureDetail field. allowExitCodes takes precedence over this field."
fn spec.forProvider.build.step.withArgs
withArgs(args)
"A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the args are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments."
fn spec.forProvider.build.step.withArgsMixin
withArgsMixin(args)
"A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the args are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments."
Note: This function appends passed data to existing values
fn spec.forProvider.build.step.withDir
withDir(dir)
"Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's dir is specified and is an absolute path, this value is ignored for that step's execution."
fn spec.forProvider.build.step.withEntrypoint
withEntrypoint(entrypoint)
"Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used"
fn spec.forProvider.build.step.withEnv
withEnv(env)
"A list of environment variable definitions to be used when running a step. The elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\" being given the value \"VALUE\"."
fn spec.forProvider.build.step.withEnvMixin
withEnvMixin(env)
"A list of environment variable definitions to be used when running a step. The elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\" being given the value \"VALUE\"."
Note: This function appends passed data to existing values
fn spec.forProvider.build.step.withId
withId(id)
"Unique identifier for this build step, used in wait_for to reference this build step as a dependency."
fn spec.forProvider.build.step.withName
withName(name)
"Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps."
fn spec.forProvider.build.step.withScript
withScript(script)
"A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args."
fn spec.forProvider.build.step.withSecretEnv
withSecretEnv(secretEnv)
"A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret."
fn spec.forProvider.build.step.withSecretEnvMixin
withSecretEnvMixin(secretEnv)
"A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret."
Note: This function appends passed data to existing values
fn spec.forProvider.build.step.withTimeout
withTimeout(timeout)
"Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out."
fn spec.forProvider.build.step.withTiming
withTiming(timing)
"Output only. Stores timing information for executing this build step."
fn spec.forProvider.build.step.withVolumes
withVolumes(volumes)
"List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. Structure is documented below."
fn spec.forProvider.build.step.withVolumesMixin
withVolumesMixin(volumes)
"List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.build.step.withWaitFor
withWaitFor(waitFor)
"The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in wait_for have completed successfully. If wait_for is empty, this build step will start when all previous build steps in the Build.Steps list have completed successfully."
fn spec.forProvider.build.step.withWaitForMixin
withWaitForMixin(waitFor)
"The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in wait_for have completed successfully. If wait_for is empty, this build step will start when all previous build steps in the Build.Steps list have completed successfully."
Note: This function appends passed data to existing values
obj spec.forProvider.build.step.volumes
"List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. Structure is documented below."
fn spec.forProvider.build.step.volumes.withName
withName(name)
"Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps."
fn spec.forProvider.build.step.volumes.withPath
withPath(path)
"Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths."
obj spec.forProvider.gitFileSource
"The file source describing the local or remote Build template. Structure is documented below."
fn spec.forProvider.gitFileSource.withGithubEnterpriseConfig
withGithubEnterpriseConfig(githubEnterpriseConfig)
"The full resource name of the github enterprise config. Format: projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}. projects/{project}/githubEnterpriseConfigs/{id}."
fn spec.forProvider.gitFileSource.withPath
withPath(path)
"The path of the file, with the repo root as the root of the path."
fn spec.forProvider.gitFileSource.withRepoType
withRepoType(repoType)
"The type of the repo, since it may not be explicit from the repo field (e.g from a URL). Values can be UNKNOWN, CLOUD_SOURCE_REPOSITORIES, GITHUB, BITBUCKET_SERVER Possible values are: UNKNOWN, CLOUD_SOURCE_REPOSITORIES, GITHUB, BITBUCKET_SERVER."
fn spec.forProvider.gitFileSource.withRevision
withRevision(revision)
"The branch, tag, arbitrary ref, or SHA version of the repo to use when resolving the filename . This field respects the same syntax/resolution as described here: https://git-scm.com/docs/gitrevisions If unspecified, the revision from which the trigger invocation originated is assumed to be the revision from which to read the specified path."
fn spec.forProvider.gitFileSource.withUri
withUri(uri)
"The URI of the repo . If unspecified, the repo from which the trigger invocation originated is assumed to be the repo from which to read the specified path."
obj spec.forProvider.github
"Describes the configuration of a trigger that creates a build whenever a GitHub event is received. One of trigger_template, github, pubsub_config or webhook_config must be provided. Structure is documented below."
fn spec.forProvider.github.withEnterpriseConfigResourceName
withEnterpriseConfigResourceName(enterpriseConfigResourceName)
"The resource name of the github enterprise config that should be applied to this installation. For example: \"projects/{$projectId}/locations/{$locationId}/githubEnterpriseConfigs/{$configId}\
fn spec.forProvider.github.withName
withName(name)
"Name of the repository. For example: The name for https://github.com/googlecloudplatform/cloud-builders is \"cloud-builders\"."
fn spec.forProvider.github.withOwner
withOwner(owner)
"Owner of the repository. For example: The owner for https://github.com/googlecloudplatform/cloud-builders is \"googlecloudplatform\"."
fn spec.forProvider.github.withPullRequest
withPullRequest(pullRequest)
"filter to match changes in pull requests. Specify only one of pull_request or push. Structure is documented below."
fn spec.forProvider.github.withPullRequestMixin
withPullRequestMixin(pullRequest)
"filter to match changes in pull requests. Specify only one of pull_request or push. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.github.withPush
withPush(push)
"filter to match changes in refs, like branches or tags. Specify only one of pull_request or push. Structure is documented below."
fn spec.forProvider.github.withPushMixin
withPushMixin(push)
"filter to match changes in refs, like branches or tags. Specify only one of pull_request or push. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.forProvider.github.pullRequest
"filter to match changes in pull requests. Specify only one of pull_request or push. Structure is documented below."
fn spec.forProvider.github.pullRequest.withBranch
withBranch(branch)
"Regex of branches to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax"
fn spec.forProvider.github.pullRequest.withCommentControl
withCommentControl(commentControl)
"Configure builds to run whether a repository owner or collaborator need to comment /gcbrun. Possible values are: COMMENTS_DISABLED, COMMENTS_ENABLED, COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY."
fn spec.forProvider.github.pullRequest.withInvertRegex
withInvertRegex(invertRegex)
"Only trigger a build if the revision regex does NOT match the revision regex."
obj spec.forProvider.github.push
"filter to match changes in refs, like branches or tags. Specify only one of pull_request or push. Structure is documented below."
fn spec.forProvider.github.push.withBranch
withBranch(branch)
"Regex of branches to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax"
fn spec.forProvider.github.push.withInvertRegex
withInvertRegex(invertRegex)
"Only trigger a build if the revision regex does NOT match the revision regex."
fn spec.forProvider.github.push.withTag
withTag(tag)
"Regex of tags to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax"
obj spec.forProvider.pubsubConfig
"PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published. One of trigger_template, github, pubsub_config webhook_config or source_to_build must be provided. Structure is documented below."
fn spec.forProvider.pubsubConfig.withServiceAccountEmail
withServiceAccountEmail(serviceAccountEmail)
"Service account that will make the push request."
fn spec.forProvider.pubsubConfig.withTopic
withTopic(topic)
"The name of the topic from which this subscription is receiving messages."
obj spec.forProvider.pubsubConfig.topicRef
"Reference to a Topic in pubsub to populate topic."
fn spec.forProvider.pubsubConfig.topicRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.pubsubConfig.topicRef.policy
"Policies for referencing."
fn spec.forProvider.pubsubConfig.topicRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.pubsubConfig.topicRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.pubsubConfig.topicSelector
"Selector for a Topic in pubsub to populate topic."
fn spec.forProvider.pubsubConfig.topicSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.pubsubConfig.topicSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.pubsubConfig.topicSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.pubsubConfig.topicSelector.policy
"Policies for selection."
fn spec.forProvider.pubsubConfig.topicSelector.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.pubsubConfig.topicSelector.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.serviceAccountRef
"Reference to a ServiceAccount in cloudplatform to populate serviceAccount."
fn spec.forProvider.serviceAccountRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.serviceAccountRef.policy
"Policies for referencing."
fn spec.forProvider.serviceAccountRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.serviceAccountRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.serviceAccountSelector
"Selector for a ServiceAccount in cloudplatform to populate serviceAccount."
fn spec.forProvider.serviceAccountSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.serviceAccountSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.serviceAccountSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.serviceAccountSelector.policy
"Policies for selection."
fn spec.forProvider.serviceAccountSelector.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.serviceAccountSelector.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.sourceToBuild
"The repo and ref of the repository from which to build. This field is used only for those triggers that do not respond to SCM events. Triggers that respond to such events build source at whatever commit caused the event. This field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers. One of trigger_template, github, pubsub_config webhook_config or source_to_build must be provided. Structure is documented below."
fn spec.forProvider.sourceToBuild.withGithubEnterpriseConfig
withGithubEnterpriseConfig(githubEnterpriseConfig)
"The full resource name of the github enterprise config. Format: projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}. projects/{project}/githubEnterpriseConfigs/{id}."
fn spec.forProvider.sourceToBuild.withRef
withRef(ref)
"The branch or tag to use. Must start with \"refs/\" ."
fn spec.forProvider.sourceToBuild.withRepoType
withRepoType(repoType)
"The type of the repo, since it may not be explicit from the repo field (e.g from a URL). Values can be UNKNOWN, CLOUD_SOURCE_REPOSITORIES, GITHUB, BITBUCKET_SERVER Possible values are: UNKNOWN, CLOUD_SOURCE_REPOSITORIES, GITHUB, BITBUCKET_SERVER."
fn spec.forProvider.sourceToBuild.withUri
withUri(uri)
"The URI of the repo."
obj spec.forProvider.triggerTemplate
"Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. One of trigger_template, github, pubsub_config, webhook_config or source_to_build must be provided. Structure is documented below."
fn spec.forProvider.triggerTemplate.withBranchName
withBranchName(branchName)
"Name of the branch to build. Exactly one a of branch name, tag, or commit SHA must be provided. This field is a regular expression."
fn spec.forProvider.triggerTemplate.withCommitSha
withCommitSha(commitSha)
"Explicit commit SHA to build. Exactly one of a branch name, tag, or commit SHA must be provided."
fn spec.forProvider.triggerTemplate.withDir
withDir(dir)
"Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's dir is specified and is an absolute path, this value is ignored for that step's execution."
fn spec.forProvider.triggerTemplate.withInvertRegex
withInvertRegex(invertRegex)
"Only trigger a build if the revision regex does NOT match the revision regex."
fn spec.forProvider.triggerTemplate.withProjectId
withProjectId(projectId)
"ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed."
fn spec.forProvider.triggerTemplate.withRepoName
withRepoName(repoName)
"Name of the Cloud Source Repository. If omitted, the name \"default\" is assumed."
fn spec.forProvider.triggerTemplate.withTagName
withTagName(tagName)
"Name of the tag to build. Exactly one of a branch name, tag, or commit SHA must be provided. This field is a regular expression."
obj spec.forProvider.webhookConfig
"WebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger's webhook URL. One of trigger_template, github, pubsub_config webhook_config or source_to_build must be provided. Structure is documented below."
fn spec.forProvider.webhookConfig.withSecret
withSecret(secret)
"Resource name for the secret required as a URL parameter."
obj spec.forProvider.webhookConfig.secretRef
"Reference to a SecretVersion in secretmanager to populate secret."
fn spec.forProvider.webhookConfig.secretRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.webhookConfig.secretRef.policy
"Policies for referencing."
fn spec.forProvider.webhookConfig.secretRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.webhookConfig.secretRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.webhookConfig.secretSelector
"Selector for a SecretVersion in secretmanager to populate secret."
fn spec.forProvider.webhookConfig.secretSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.webhookConfig.secretSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.webhookConfig.secretSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.webhookConfig.secretSelector.policy
"Policies for selection."
fn spec.forProvider.webhookConfig.secretSelector.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.webhookConfig.secretSelector.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.initProvider
"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler."
fn spec.initProvider.withApprovalConfig
withApprovalConfig(approvalConfig)
"Configuration for manual approval to start a build invocation of this BuildTrigger. Builds created by this trigger will require approval before they execute. Any user with a Cloud Build Approver role for the project can approve a build. Structure is documented below."
fn spec.initProvider.withApprovalConfigMixin
withApprovalConfigMixin(approvalConfig)
"Configuration for manual approval to start a build invocation of this BuildTrigger. Builds created by this trigger will require approval before they execute. Any user with a Cloud Build Approver role for the project can approve a build. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.withBitbucketServerTriggerConfig
withBitbucketServerTriggerConfig(bitbucketServerTriggerConfig)
"BitbucketServerTriggerConfig describes the configuration of a trigger that creates a build whenever a Bitbucket Server event is received. Structure is documented below."
fn spec.initProvider.withBitbucketServerTriggerConfigMixin
withBitbucketServerTriggerConfigMixin(bitbucketServerTriggerConfig)
"BitbucketServerTriggerConfig describes the configuration of a trigger that creates a build whenever a Bitbucket Server event is received. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.withBuild
withBuild(build)
"Contents of the build template. Either a filename or build template must be provided. Structure is documented below."
fn spec.initProvider.withBuildMixin
withBuildMixin(build)
"Contents of the build template. Either a filename or build template must be provided. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.withDescription
withDescription(description)
"Human-readable description of the trigger."
fn spec.initProvider.withDisabled
withDisabled(disabled)
"Whether the trigger is disabled or not. If true, the trigger will never result in a build."
fn spec.initProvider.withFilename
withFilename(filename)
"Path, from the source root, to a file whose contents is used for the template. Either a filename or build template must be provided. Set this only when using trigger_template or github. When using Pub/Sub, Webhook or Manual set the file name using git_file_source instead."
fn spec.initProvider.withFilter
withFilter(filter)
"A Common Expression Language string. Used only with Pub/Sub and Webhook."
fn spec.initProvider.withGitFileSource
withGitFileSource(gitFileSource)
"The file source describing the local or remote Build template. Structure is documented below."
fn spec.initProvider.withGitFileSourceMixin
withGitFileSourceMixin(gitFileSource)
"The file source describing the local or remote Build template. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.withGithub
withGithub(github)
"Describes the configuration of a trigger that creates a build whenever a GitHub event is received. One of trigger_template, github, pubsub_config or webhook_config must be provided. Structure is documented below."
fn spec.initProvider.withGithubMixin
withGithubMixin(github)
"Describes the configuration of a trigger that creates a build whenever a GitHub event is received. One of trigger_template, github, pubsub_config or webhook_config must be provided. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.withIgnoredFiles
withIgnoredFiles(ignoredFiles)
"ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for **. If ignoredFiles and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignoredFiles is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignoredFiles globs, then we do not trigger a build."
fn spec.initProvider.withIgnoredFilesMixin
withIgnoredFilesMixin(ignoredFiles)
"ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for **. If ignoredFiles and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignoredFiles is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignoredFiles globs, then we do not trigger a build."
Note: This function appends passed data to existing values
fn spec.initProvider.withIncludeBuildLogs
withIncludeBuildLogs(includeBuildLogs)
"Build logs will be sent back to GitHub as part of the checkrun result. Values can be INCLUDE_BUILD_LOGS_UNSPECIFIED or INCLUDE_BUILD_LOGS_WITH_STATUS Possible values are: INCLUDE_BUILD_LOGS_UNSPECIFIED, INCLUDE_BUILD_LOGS_WITH_STATUS."
fn spec.initProvider.withIncludedFiles
withIncludedFiles(includedFiles)
"ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for **. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is not empty, then we make sure that at least one of those files matches a includedFiles glob. If not, then we do not trigger a build."
fn spec.initProvider.withIncludedFilesMixin
withIncludedFilesMixin(includedFiles)
"ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for **. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is not empty, then we make sure that at least one of those files matches a includedFiles glob. If not, then we do not trigger a build."
Note: This function appends passed data to existing values
fn spec.initProvider.withLocation
withLocation(location)
"The Cloud Build location for the trigger. If not specified, \"global\" is used."
fn spec.initProvider.withName
withName(name)
"Name of the trigger. Must be unique within the project."
fn spec.initProvider.withProject
withProject(project)
"The ID of the project in which the resource belongs. If it is not provided, the provider project is used."
fn spec.initProvider.withPubsubConfig
withPubsubConfig(pubsubConfig)
"PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published. One of trigger_template, github, pubsub_config webhook_config or source_to_build must be provided. Structure is documented below."
fn spec.initProvider.withPubsubConfigMixin
withPubsubConfigMixin(pubsubConfig)
"PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published. One of trigger_template, github, pubsub_config webhook_config or source_to_build must be provided. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.withSourceToBuild
withSourceToBuild(sourceToBuild)
"The repo and ref of the repository from which to build. This field is used only for those triggers that do not respond to SCM events. Triggers that respond to such events build source at whatever commit caused the event. This field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers. One of trigger_template, github, pubsub_config webhook_config or source_to_build must be provided. Structure is documented below."
fn spec.initProvider.withSourceToBuildMixin
withSourceToBuildMixin(sourceToBuild)
"The repo and ref of the repository from which to build. This field is used only for those triggers that do not respond to SCM events. Triggers that respond to such events build source at whatever commit caused the event. This field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers. One of trigger_template, github, pubsub_config webhook_config or source_to_build must be provided. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.withSubstitutions
withSubstitutions(substitutions)
"Substitutions data for Build resource."
fn spec.initProvider.withSubstitutionsMixin
withSubstitutionsMixin(substitutions)
"Substitutions data for Build resource."
Note: This function appends passed data to existing values
fn spec.initProvider.withTags
withTags(tags)
"Tags for annotation of a BuildTrigger"
fn spec.initProvider.withTagsMixin
withTagsMixin(tags)
"Tags for annotation of a BuildTrigger"
Note: This function appends passed data to existing values
fn spec.initProvider.withTriggerTemplate
withTriggerTemplate(triggerTemplate)
"Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. One of trigger_template, github, pubsub_config, webhook_config or source_to_build must be provided. Structure is documented below."
fn spec.initProvider.withTriggerTemplateMixin
withTriggerTemplateMixin(triggerTemplate)
"Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. One of trigger_template, github, pubsub_config, webhook_config or source_to_build must be provided. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.withWebhookConfig
withWebhookConfig(webhookConfig)
"WebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger's webhook URL. One of trigger_template, github, pubsub_config webhook_config or source_to_build must be provided. Structure is documented below."
fn spec.initProvider.withWebhookConfigMixin
withWebhookConfigMixin(webhookConfig)
"WebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger's webhook URL. One of trigger_template, github, pubsub_config webhook_config or source_to_build must be provided. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.initProvider.approvalConfig
"Configuration for manual approval to start a build invocation of this BuildTrigger. Builds created by this trigger will require approval before they execute. Any user with a Cloud Build Approver role for the project can approve a build. Structure is documented below."
fn spec.initProvider.approvalConfig.withApprovalRequired
withApprovalRequired(approvalRequired)
"Whether or not approval is needed. If this is set on a build, it will become pending when run, and will need to be explicitly approved to start."
obj spec.initProvider.bitbucketServerTriggerConfig
"BitbucketServerTriggerConfig describes the configuration of a trigger that creates a build whenever a Bitbucket Server event is received. Structure is documented below."
fn spec.initProvider.bitbucketServerTriggerConfig.withBitbucketServerConfigResource
withBitbucketServerConfigResource(bitbucketServerConfigResource)
"The Bitbucket server config resource that this trigger config maps to."
fn spec.initProvider.bitbucketServerTriggerConfig.withProjectKey
withProjectKey(projectKey)
"Key of the project that the repo is in. For example: The key for https://mybitbucket.server/projects/TEST/repos/test-repo is \"TEST\"."
fn spec.initProvider.bitbucketServerTriggerConfig.withPullRequest
withPullRequest(pullRequest)
"Filter to match changes in pull requests. Structure is documented below."
fn spec.initProvider.bitbucketServerTriggerConfig.withPullRequestMixin
withPullRequestMixin(pullRequest)
"Filter to match changes in pull requests. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.bitbucketServerTriggerConfig.withPush
withPush(push)
"Filter to match changes in refs like branches, tags. Structure is documented below."
fn spec.initProvider.bitbucketServerTriggerConfig.withPushMixin
withPushMixin(push)
"Filter to match changes in refs like branches, tags. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.bitbucketServerTriggerConfig.withRepoSlug
withRepoSlug(repoSlug)
"Slug of the repository. A repository slug is a URL-friendly version of a repository name, automatically generated by Bitbucket for use in the URL. For example, if the repository name is 'test repo', in the URL it would become 'test-repo' as in https://mybitbucket.server/projects/TEST/repos/test-repo."
obj spec.initProvider.bitbucketServerTriggerConfig.pullRequest
"Filter to match changes in pull requests. Structure is documented below."
fn spec.initProvider.bitbucketServerTriggerConfig.pullRequest.withBranch
withBranch(branch)
"Regex of branches to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax"
fn spec.initProvider.bitbucketServerTriggerConfig.pullRequest.withCommentControl
withCommentControl(commentControl)
"Configure builds to run whether a repository owner or collaborator need to comment /gcbrun. Possible values are: COMMENTS_DISABLED, COMMENTS_ENABLED, COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY."
fn spec.initProvider.bitbucketServerTriggerConfig.pullRequest.withInvertRegex
withInvertRegex(invertRegex)
"Only trigger a build if the revision regex does NOT match the revision regex."
obj spec.initProvider.bitbucketServerTriggerConfig.push
"Filter to match changes in refs like branches, tags. Structure is documented below."
fn spec.initProvider.bitbucketServerTriggerConfig.push.withBranch
withBranch(branch)
"Regex of branches to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax"
fn spec.initProvider.bitbucketServerTriggerConfig.push.withInvertRegex
withInvertRegex(invertRegex)
"Only trigger a build if the revision regex does NOT match the revision regex."
fn spec.initProvider.bitbucketServerTriggerConfig.push.withTag
withTag(tag)
"Regex of tags to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax"
obj spec.initProvider.build
"Contents of the build template. Either a filename or build template must be provided. Structure is documented below."
fn spec.initProvider.build.withArtifacts
withArtifacts(artifacts)
"Artifacts produced by the build that should be uploaded upon successful completion of all build steps. Structure is documented below."
fn spec.initProvider.build.withArtifactsMixin
withArtifactsMixin(artifacts)
"Artifacts produced by the build that should be uploaded upon successful completion of all build steps. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.build.withAvailableSecrets
withAvailableSecrets(availableSecrets)
"Secrets and secret environment variables. Structure is documented below."
fn spec.initProvider.build.withAvailableSecretsMixin
withAvailableSecretsMixin(availableSecrets)
"Secrets and secret environment variables. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.build.withImages
withImages(images)
"A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build status is marked FAILURE."
fn spec.initProvider.build.withImagesMixin
withImagesMixin(images)
"A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build status is marked FAILURE."
Note: This function appends passed data to existing values
fn spec.initProvider.build.withLogsBucket
withLogsBucket(logsBucket)
"Google Cloud Storage bucket where logs should be written. Logs file names will be of the format ${logsBucket}/log-${build_id}.txt."
fn spec.initProvider.build.withOptions
withOptions(options)
"Special options for this build. Structure is documented below."
fn spec.initProvider.build.withOptionsMixin
withOptionsMixin(options)
"Special options for this build. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.build.withQueueTtl
withQueueTtl(queueTtl)
"TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be EXPIRED. The TTL starts ticking from createTime. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: \"3.5s\"."
fn spec.initProvider.build.withSecret
withSecret(secret)
"Secrets to decrypt using Cloud Key Management Service. Structure is documented below."
fn spec.initProvider.build.withSecretMixin
withSecretMixin(secret)
"Secrets to decrypt using Cloud Key Management Service. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.build.withSource
withSource(source)
"The location of the source files to build. One of storageSource or repoSource must be provided. Structure is documented below."
fn spec.initProvider.build.withSourceMixin
withSourceMixin(source)
"The location of the source files to build. One of storageSource or repoSource must be provided. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.build.withStep
withStep(step)
"The operations to be performed on the workspace. Structure is documented below."
fn spec.initProvider.build.withStepMixin
withStepMixin(step)
"The operations to be performed on the workspace. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.build.withSubstitutions
withSubstitutions(substitutions)
"Substitutions data for Build resource."
fn spec.initProvider.build.withSubstitutionsMixin
withSubstitutionsMixin(substitutions)
"Substitutions data for Build resource."
Note: This function appends passed data to existing values
fn spec.initProvider.build.withTags
withTags(tags)
"Tags for annotation of a Build. These are not docker tags."
fn spec.initProvider.build.withTagsMixin
withTagsMixin(tags)
"Tags for annotation of a Build. These are not docker tags."
Note: This function appends passed data to existing values
fn spec.initProvider.build.withTimeout
withTimeout(timeout)
"Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be TIMEOUT. This timeout must be equal to or greater than the sum of the timeouts for build steps within the build. The expected format is the number of seconds followed by s. Default time is ten minutes (600s)."
obj spec.initProvider.build.artifacts
"Artifacts produced by the build that should be uploaded upon successful completion of all build steps. Structure is documented below."
fn spec.initProvider.build.artifacts.withImages
withImages(images)
"A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build status is marked FAILURE."
fn spec.initProvider.build.artifacts.withImagesMixin
withImagesMixin(images)
"A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build status is marked FAILURE."
Note: This function appends passed data to existing values
fn spec.initProvider.build.artifacts.withObjects
withObjects(objects)
"A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE. Structure is documented below."
fn spec.initProvider.build.artifacts.withObjectsMixin
withObjectsMixin(objects)
"A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.initProvider.build.artifacts.objects
"A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE. Structure is documented below."
fn spec.initProvider.build.artifacts.objects.withLocation
withLocation(location)
"Cloud Storage bucket and optional object path, in the form \"gs://bucket/path/to/somewhere/\". Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix."
fn spec.initProvider.build.artifacts.objects.withPaths
withPaths(paths)
"Path globs used to match files in the build's workspace."
fn spec.initProvider.build.artifacts.objects.withPathsMixin
withPathsMixin(paths)
"Path globs used to match files in the build's workspace."
Note: This function appends passed data to existing values
obj spec.initProvider.build.availableSecrets
"Secrets and secret environment variables. Structure is documented below."
fn spec.initProvider.build.availableSecrets.withSecretManager
withSecretManager(secretManager)
"Pairs a secret environment variable with a SecretVersion in Secret Manager. Structure is documented below."
fn spec.initProvider.build.availableSecrets.withSecretManagerMixin
withSecretManagerMixin(secretManager)
"Pairs a secret environment variable with a SecretVersion in Secret Manager. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.initProvider.build.availableSecrets.secretManager
"Pairs a secret environment variable with a SecretVersion in Secret Manager. Structure is documented below."
fn spec.initProvider.build.availableSecrets.secretManager.withEnv
withEnv(env)
"A list of environment variable definitions to be used when running a step. The elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\" being given the value \"VALUE\"."
fn spec.initProvider.build.availableSecrets.secretManager.withVersionName
withVersionName(versionName)
"Resource name of the SecretVersion. In format: projects//secrets//versions/*"
obj spec.initProvider.build.options
"Special options for this build. Structure is documented below."
fn spec.initProvider.build.options.withDiskSizeGb
withDiskSizeGb(diskSizeGb)
"Requested disk size for the VM that runs the build. Note that this is NOT \"disk free\"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 1000GB; builds that request more than the maximum are rejected with an error."
fn spec.initProvider.build.options.withDynamicSubstitutions
withDynamicSubstitutions(dynamicSubstitutions)
"Option to specify whether or not to apply bash style string operations to the substitutions. NOTE this is always enabled for triggered builds and cannot be overridden in the build configuration file."
fn spec.initProvider.build.options.withEnv
withEnv(env)
"A list of environment variable definitions to be used when running a step. The elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\" being given the value \"VALUE\"."
fn spec.initProvider.build.options.withEnvMixin
withEnvMixin(env)
"A list of environment variable definitions to be used when running a step. The elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\" being given the value \"VALUE\"."
Note: This function appends passed data to existing values
fn spec.initProvider.build.options.withLogStreamingOption
withLogStreamingOption(logStreamingOption)
"Option to define build log streaming behavior to Google Cloud Storage. Possible values are: STREAM_DEFAULT, STREAM_ON, STREAM_OFF."
fn spec.initProvider.build.options.withLogging
withLogging(logging)
"Option to specify the logging mode, which determines if and where build logs are stored. Possible values are: LOGGING_UNSPECIFIED, LEGACY, GCS_ONLY, STACKDRIVER_ONLY, CLOUD_LOGGING_ONLY, NONE."
fn spec.initProvider.build.options.withMachineType
withMachineType(machineType)
"Compute Engine machine type on which to run the build. Possible values are: UNSPECIFIED, N1_HIGHCPU_8, N1_HIGHCPU_32, E2_HIGHCPU_8, E2_HIGHCPU_32."
fn spec.initProvider.build.options.withRequestedVerifyOption
withRequestedVerifyOption(requestedVerifyOption)
"Requested verifiability options. Possible values are: NOT_VERIFIED, VERIFIED."
fn spec.initProvider.build.options.withSecretEnv
withSecretEnv(secretEnv)
"A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret."
fn spec.initProvider.build.options.withSecretEnvMixin
withSecretEnvMixin(secretEnv)
"A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret."
Note: This function appends passed data to existing values
fn spec.initProvider.build.options.withSourceProvenanceHash
withSourceProvenanceHash(sourceProvenanceHash)
"Requested hash for SourceProvenance. Each value may be one of: NONE, SHA256, MD5."
fn spec.initProvider.build.options.withSourceProvenanceHashMixin
withSourceProvenanceHashMixin(sourceProvenanceHash)
"Requested hash for SourceProvenance. Each value may be one of: NONE, SHA256, MD5."
Note: This function appends passed data to existing values
fn spec.initProvider.build.options.withSubstitutionOption
withSubstitutionOption(substitutionOption)
"Option to specify behavior when there is an error in the substitution checks. NOTE this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file. Possible values are: MUST_MATCH, ALLOW_LOOSE."
fn spec.initProvider.build.options.withVolumes
withVolumes(volumes)
"List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. Structure is documented below."
fn spec.initProvider.build.options.withVolumesMixin
withVolumesMixin(volumes)
"List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.build.options.withWorkerPool
withWorkerPool(workerPool)
"Option to specify a WorkerPool for the build. Format projects/{project}/workerPools/{workerPool} This field is experimental."
obj spec.initProvider.build.options.volumes
"List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. Structure is documented below."
fn spec.initProvider.build.options.volumes.withName
withName(name)
"Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps."
fn spec.initProvider.build.options.volumes.withPath
withPath(path)
"Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths."
obj spec.initProvider.build.secret
"Secrets to decrypt using Cloud Key Management Service. Structure is documented below."
fn spec.initProvider.build.secret.withKmsKeyName
withKmsKeyName(kmsKeyName)
"Cloud KMS key name to use to decrypt these envs."
fn spec.initProvider.build.secret.withSecretEnv
withSecretEnv(secretEnv)
"A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret."
fn spec.initProvider.build.secret.withSecretEnvMixin
withSecretEnvMixin(secretEnv)
"A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret."
Note: This function appends passed data to existing values
obj spec.initProvider.build.source
"The location of the source files to build. One of storageSource or repoSource must be provided. Structure is documented below."
fn spec.initProvider.build.source.withRepoSource
withRepoSource(repoSource)
"Location of the source in a Google Cloud Source Repository. Structure is documented below."
fn spec.initProvider.build.source.withRepoSourceMixin
withRepoSourceMixin(repoSource)
"Location of the source in a Google Cloud Source Repository. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.build.source.withStorageSource
withStorageSource(storageSource)
"Location of the source in an archive file in Google Cloud Storage. Structure is documented below."
fn spec.initProvider.build.source.withStorageSourceMixin
withStorageSourceMixin(storageSource)
"Location of the source in an archive file in Google Cloud Storage. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.initProvider.build.source.repoSource
"Location of the source in a Google Cloud Source Repository. Structure is documented below."
fn spec.initProvider.build.source.repoSource.withBranchName
withBranchName(branchName)
"Name of the branch to build. Exactly one a of branch name, tag, or commit SHA must be provided. This field is a regular expression."
fn spec.initProvider.build.source.repoSource.withCommitSha
withCommitSha(commitSha)
"Explicit commit SHA to build. Exactly one of a branch name, tag, or commit SHA must be provided."
fn spec.initProvider.build.source.repoSource.withDir
withDir(dir)
"Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's dir is specified and is an absolute path, this value is ignored for that step's execution."
fn spec.initProvider.build.source.repoSource.withInvertRegex
withInvertRegex(invertRegex)
"Only trigger a build if the revision regex does NOT match the revision regex."
fn spec.initProvider.build.source.repoSource.withProjectId
withProjectId(projectId)
"ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed."
fn spec.initProvider.build.source.repoSource.withRepoName
withRepoName(repoName)
"Name of the Cloud Source Repository. If omitted, the name \"default\" is assumed."
fn spec.initProvider.build.source.repoSource.withSubstitutions
withSubstitutions(substitutions)
"Substitutions data for Build resource."
fn spec.initProvider.build.source.repoSource.withSubstitutionsMixin
withSubstitutionsMixin(substitutions)
"Substitutions data for Build resource."
Note: This function appends passed data to existing values
fn spec.initProvider.build.source.repoSource.withTagName
withTagName(tagName)
"Name of the tag to build. Exactly one of a branch name, tag, or commit SHA must be provided. This field is a regular expression."
obj spec.initProvider.build.source.storageSource
"Location of the source in an archive file in Google Cloud Storage. Structure is documented below."
fn spec.initProvider.build.source.storageSource.withBucket
withBucket(bucket)
"Google Cloud Storage bucket containing the source."
fn spec.initProvider.build.source.storageSource.withGeneration
withGeneration(generation)
"Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used"
fn spec.initProvider.build.source.storageSource.withObject
withObject(object)
"Google Cloud Storage object containing the source. This object must be a gzipped archive file (.tar.gz) containing source to build."
obj spec.initProvider.build.step
"The operations to be performed on the workspace. Structure is documented below."
fn spec.initProvider.build.step.withAllowExitCodes
withAllowExitCodes(allowExitCodes)
"Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes. If allowFailure is also specified, this field will take precedence."
fn spec.initProvider.build.step.withAllowExitCodesMixin
withAllowExitCodesMixin(allowExitCodes)
"Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes. If allowFailure is also specified, this field will take precedence."
Note: This function appends passed data to existing values
fn spec.initProvider.build.step.withAllowFailure
withAllowFailure(allowFailure)
"Allow this build step to fail without failing the entire build. If false, the entire build will fail if this step fails. Otherwise, the build will succeed, but this step will still have a failure status. Error information will be reported in the failureDetail field. allowExitCodes takes precedence over this field."
fn spec.initProvider.build.step.withArgs
withArgs(args)
"A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the args are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments."
fn spec.initProvider.build.step.withArgsMixin
withArgsMixin(args)
"A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the args are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments."
Note: This function appends passed data to existing values
fn spec.initProvider.build.step.withDir
withDir(dir)
"Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's dir is specified and is an absolute path, this value is ignored for that step's execution."
fn spec.initProvider.build.step.withEntrypoint
withEntrypoint(entrypoint)
"Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used"
fn spec.initProvider.build.step.withEnv
withEnv(env)
"A list of environment variable definitions to be used when running a step. The elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\" being given the value \"VALUE\"."
fn spec.initProvider.build.step.withEnvMixin
withEnvMixin(env)
"A list of environment variable definitions to be used when running a step. The elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\" being given the value \"VALUE\"."
Note: This function appends passed data to existing values
fn spec.initProvider.build.step.withId
withId(id)
"Unique identifier for this build step, used in wait_for to reference this build step as a dependency."
fn spec.initProvider.build.step.withName
withName(name)
"Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps."
fn spec.initProvider.build.step.withScript
withScript(script)
"A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args."
fn spec.initProvider.build.step.withSecretEnv
withSecretEnv(secretEnv)
"A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret."
fn spec.initProvider.build.step.withSecretEnvMixin
withSecretEnvMixin(secretEnv)
"A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret."
Note: This function appends passed data to existing values
fn spec.initProvider.build.step.withTimeout
withTimeout(timeout)
"Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out."
fn spec.initProvider.build.step.withTiming
withTiming(timing)
"Output only. Stores timing information for executing this build step."
fn spec.initProvider.build.step.withVolumes
withVolumes(volumes)
"List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. Structure is documented below."
fn spec.initProvider.build.step.withVolumesMixin
withVolumesMixin(volumes)
"List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.build.step.withWaitFor
withWaitFor(waitFor)
"The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in wait_for have completed successfully. If wait_for is empty, this build step will start when all previous build steps in the Build.Steps list have completed successfully."
fn spec.initProvider.build.step.withWaitForMixin
withWaitForMixin(waitFor)
"The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in wait_for have completed successfully. If wait_for is empty, this build step will start when all previous build steps in the Build.Steps list have completed successfully."
Note: This function appends passed data to existing values
obj spec.initProvider.build.step.volumes
"List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. Structure is documented below."
fn spec.initProvider.build.step.volumes.withName
withName(name)
"Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps."
fn spec.initProvider.build.step.volumes.withPath
withPath(path)
"Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths."
obj spec.initProvider.gitFileSource
"The file source describing the local or remote Build template. Structure is documented below."
fn spec.initProvider.gitFileSource.withGithubEnterpriseConfig
withGithubEnterpriseConfig(githubEnterpriseConfig)
"The full resource name of the github enterprise config. Format: projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}. projects/{project}/githubEnterpriseConfigs/{id}."
fn spec.initProvider.gitFileSource.withPath
withPath(path)
"The path of the file, with the repo root as the root of the path."
fn spec.initProvider.gitFileSource.withRepoType
withRepoType(repoType)
"The type of the repo, since it may not be explicit from the repo field (e.g from a URL). Values can be UNKNOWN, CLOUD_SOURCE_REPOSITORIES, GITHUB, BITBUCKET_SERVER Possible values are: UNKNOWN, CLOUD_SOURCE_REPOSITORIES, GITHUB, BITBUCKET_SERVER."
fn spec.initProvider.gitFileSource.withRevision
withRevision(revision)
"The branch, tag, arbitrary ref, or SHA version of the repo to use when resolving the filename . This field respects the same syntax/resolution as described here: https://git-scm.com/docs/gitrevisions If unspecified, the revision from which the trigger invocation originated is assumed to be the revision from which to read the specified path."
fn spec.initProvider.gitFileSource.withUri
withUri(uri)
"The URI of the repo . If unspecified, the repo from which the trigger invocation originated is assumed to be the repo from which to read the specified path."
obj spec.initProvider.github
"Describes the configuration of a trigger that creates a build whenever a GitHub event is received. One of trigger_template, github, pubsub_config or webhook_config must be provided. Structure is documented below."
fn spec.initProvider.github.withEnterpriseConfigResourceName
withEnterpriseConfigResourceName(enterpriseConfigResourceName)
"The resource name of the github enterprise config that should be applied to this installation. For example: \"projects/{$projectId}/locations/{$locationId}/githubEnterpriseConfigs/{$configId}\
fn spec.initProvider.github.withName
withName(name)
"Name of the repository. For example: The name for https://github.com/googlecloudplatform/cloud-builders is \"cloud-builders\"."
fn spec.initProvider.github.withOwner
withOwner(owner)
"Owner of the repository. For example: The owner for https://github.com/googlecloudplatform/cloud-builders is \"googlecloudplatform\"."
fn spec.initProvider.github.withPullRequest
withPullRequest(pullRequest)
"filter to match changes in pull requests. Specify only one of pull_request or push. Structure is documented below."
fn spec.initProvider.github.withPullRequestMixin
withPullRequestMixin(pullRequest)
"filter to match changes in pull requests. Specify only one of pull_request or push. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.github.withPush
withPush(push)
"filter to match changes in refs, like branches or tags. Specify only one of pull_request or push. Structure is documented below."
fn spec.initProvider.github.withPushMixin
withPushMixin(push)
"filter to match changes in refs, like branches or tags. Specify only one of pull_request or push. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.initProvider.github.pullRequest
"filter to match changes in pull requests. Specify only one of pull_request or push. Structure is documented below."
fn spec.initProvider.github.pullRequest.withBranch
withBranch(branch)
"Regex of branches to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax"
fn spec.initProvider.github.pullRequest.withCommentControl
withCommentControl(commentControl)
"Configure builds to run whether a repository owner or collaborator need to comment /gcbrun. Possible values are: COMMENTS_DISABLED, COMMENTS_ENABLED, COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY."
fn spec.initProvider.github.pullRequest.withInvertRegex
withInvertRegex(invertRegex)
"Only trigger a build if the revision regex does NOT match the revision regex."
obj spec.initProvider.github.push
"filter to match changes in refs, like branches or tags. Specify only one of pull_request or push. Structure is documented below."
fn spec.initProvider.github.push.withBranch
withBranch(branch)
"Regex of branches to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax"
fn spec.initProvider.github.push.withInvertRegex
withInvertRegex(invertRegex)
"Only trigger a build if the revision regex does NOT match the revision regex."
fn spec.initProvider.github.push.withTag
withTag(tag)
"Regex of tags to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax"
obj spec.initProvider.pubsubConfig
"PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published. One of trigger_template, github, pubsub_config webhook_config or source_to_build must be provided. Structure is documented below."
fn spec.initProvider.pubsubConfig.withServiceAccountEmail
withServiceAccountEmail(serviceAccountEmail)
"Service account that will make the push request."
obj spec.initProvider.sourceToBuild
"The repo and ref of the repository from which to build. This field is used only for those triggers that do not respond to SCM events. Triggers that respond to such events build source at whatever commit caused the event. This field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers. One of trigger_template, github, pubsub_config webhook_config or source_to_build must be provided. Structure is documented below."
fn spec.initProvider.sourceToBuild.withGithubEnterpriseConfig
withGithubEnterpriseConfig(githubEnterpriseConfig)
"The full resource name of the github enterprise config. Format: projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}. projects/{project}/githubEnterpriseConfigs/{id}."
fn spec.initProvider.sourceToBuild.withRef
withRef(ref)
"The branch or tag to use. Must start with \"refs/\" ."
fn spec.initProvider.sourceToBuild.withRepoType
withRepoType(repoType)
"The type of the repo, since it may not be explicit from the repo field (e.g from a URL). Values can be UNKNOWN, CLOUD_SOURCE_REPOSITORIES, GITHUB, BITBUCKET_SERVER Possible values are: UNKNOWN, CLOUD_SOURCE_REPOSITORIES, GITHUB, BITBUCKET_SERVER."
fn spec.initProvider.sourceToBuild.withUri
withUri(uri)
"The URI of the repo."
obj spec.initProvider.triggerTemplate
"Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. One of trigger_template, github, pubsub_config, webhook_config or source_to_build must be provided. Structure is documented below."
fn spec.initProvider.triggerTemplate.withBranchName
withBranchName(branchName)
"Name of the branch to build. Exactly one a of branch name, tag, or commit SHA must be provided. This field is a regular expression."
fn spec.initProvider.triggerTemplate.withCommitSha
withCommitSha(commitSha)
"Explicit commit SHA to build. Exactly one of a branch name, tag, or commit SHA must be provided."
fn spec.initProvider.triggerTemplate.withDir
withDir(dir)
"Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's dir is specified and is an absolute path, this value is ignored for that step's execution."
fn spec.initProvider.triggerTemplate.withInvertRegex
withInvertRegex(invertRegex)
"Only trigger a build if the revision regex does NOT match the revision regex."
fn spec.initProvider.triggerTemplate.withProjectId
withProjectId(projectId)
"ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed."
fn spec.initProvider.triggerTemplate.withRepoName
withRepoName(repoName)
"Name of the Cloud Source Repository. If omitted, the name \"default\" is assumed."
fn spec.initProvider.triggerTemplate.withTagName
withTagName(tagName)
"Name of the tag to build. Exactly one of a branch name, tag, or commit SHA must be provided. This field is a regular expression."
obj spec.providerConfigRef
"ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured."
fn spec.providerConfigRef.withName
withName(name)
"Name of the referenced object."
obj spec.providerConfigRef.policy
"Policies for referencing."
fn spec.providerConfigRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.providerConfigRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.providerRef
"ProviderReference specifies the provider that will be used to create, observe, update, and delete this managed resource. Deprecated: Please use ProviderConfigReference, i.e. providerConfigRef"
fn spec.providerRef.withName
withName(name)
"Name of the referenced object."
obj spec.providerRef.policy
"Policies for referencing."
fn spec.providerRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.providerRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.publishConnectionDetailsTo
"PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource."
fn spec.publishConnectionDetailsTo.withName
withName(name)
"Name is the name of the connection secret."
obj spec.publishConnectionDetailsTo.configRef
"SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret."
fn spec.publishConnectionDetailsTo.configRef.withName
withName(name)
"Name of the referenced object."
obj spec.publishConnectionDetailsTo.configRef.policy
"Policies for referencing."
fn spec.publishConnectionDetailsTo.configRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.publishConnectionDetailsTo.configRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.publishConnectionDetailsTo.metadata
"Metadata is the metadata for connection secret."
fn spec.publishConnectionDetailsTo.metadata.withAnnotations
withAnnotations(annotations)
"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."
fn spec.publishConnectionDetailsTo.metadata.withAnnotationsMixin
withAnnotationsMixin(annotations)
"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."
Note: This function appends passed data to existing values
fn spec.publishConnectionDetailsTo.metadata.withLabels
withLabels(labels)
"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."
fn spec.publishConnectionDetailsTo.metadata.withLabelsMixin
withLabelsMixin(labels)
"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."
Note: This function appends passed data to existing values
fn spec.publishConnectionDetailsTo.metadata.withType
withType(type)
"Type is the SecretType for the connection secret. - Only valid for Kubernetes Secret Stores."
obj spec.writeConnectionSecretToRef
"WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other."
fn spec.writeConnectionSecretToRef.withName
withName(name)
"Name of the secret."
fn spec.writeConnectionSecretToRef.withNamespace
withNamespace(namespace)
"Namespace of the secret."