Skip to content

cloudscheduler.v1beta1.job

"Job is the Schema for the Jobs API. A scheduled job that can publish a PubSub message or an HTTP request every X interval of time, using a crontab format string."

Index

Fields

fn new

new(name)

new returns an instance of Job

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"JobSpec defines the desired state of Job"

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

withAppEngineHttpTarget(appEngineHttpTarget)

"App Engine HTTP target. If the job providers a App Engine HTTP target the cron will send a request to the service instance Structure is documented below."

fn spec.forProvider.withAppEngineHttpTargetMixin

withAppEngineHttpTargetMixin(appEngineHttpTarget)

"App Engine HTTP target. If the job providers a App Engine HTTP target the cron will send a request to the service instance Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.withAttemptDeadline

withAttemptDeadline(attemptDeadline)

"The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig. The allowed duration for this deadline is:"

fn spec.forProvider.withDescription

withDescription(description)

"A human-readable description for the job. This string must not contain more than 500 characters."

fn spec.forProvider.withHttpTarget

withHttpTarget(httpTarget)

"HTTP target. If the job providers a http_target the cron will send a request to the targeted url Structure is documented below."

fn spec.forProvider.withHttpTargetMixin

withHttpTargetMixin(httpTarget)

"HTTP target. If the job providers a http_target the cron will send a request to the targeted url Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.withPaused

withPaused(paused)

"Sets the job to a paused state. Jobs default to being enabled when this property is not set."

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

withPubsubTarget(pubsubTarget)

"Pub/Sub target If the job providers a Pub/Sub target the cron will publish a message to the provided topic Structure is documented below."

fn spec.forProvider.withPubsubTargetMixin

withPubsubTargetMixin(pubsubTarget)

"Pub/Sub target If the job providers a Pub/Sub target the cron will publish a message to the provided topic Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.withRegion

withRegion(region)

"Region where the scheduler job resides."

fn spec.forProvider.withRetryConfig

withRetryConfig(retryConfig)

"By default, if a job does not complete successfully, meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings Structure is documented below."

fn spec.forProvider.withRetryConfigMixin

withRetryConfigMixin(retryConfig)

"By default, if a job does not complete successfully, meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.withSchedule

withSchedule(schedule)

"Describes the schedule on which the job will be executed."

fn spec.forProvider.withTimeZone

withTimeZone(timeZone)

"Specifies the time zone to be used in interpreting schedule. The value of this field must be a time zone name from the tz database."

obj spec.forProvider.appEngineHttpTarget

"App Engine HTTP target. If the job providers a App Engine HTTP target the cron will send a request to the service instance Structure is documented below."

fn spec.forProvider.appEngineHttpTarget.withAppEngineRouting

withAppEngineRouting(appEngineRouting)

"App Engine Routing setting for the job. Structure is documented below."

fn spec.forProvider.appEngineHttpTarget.withAppEngineRoutingMixin

withAppEngineRoutingMixin(appEngineRouting)

"App Engine Routing setting for the job. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.appEngineHttpTarget.withBody

withBody(body)

"HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod. A base64-encoded string."

fn spec.forProvider.appEngineHttpTarget.withHeaders

withHeaders(headers)

"HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created."

fn spec.forProvider.appEngineHttpTarget.withHeadersMixin

withHeadersMixin(headers)

"HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created."

Note: This function appends passed data to existing values

fn spec.forProvider.appEngineHttpTarget.withHttpMethod

withHttpMethod(httpMethod)

"Which HTTP method to use for the request."

fn spec.forProvider.appEngineHttpTarget.withRelativeUri

withRelativeUri(relativeUri)

"The relative URI. The relative URL must begin with \"/\" and must be a valid HTTP relative URL. It can contain a path, query string arguments, and # fragments. If the relative URL is empty, then the root path \"/\" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters"

obj spec.forProvider.appEngineHttpTarget.appEngineRouting

"App Engine Routing setting for the job. Structure is documented below."

fn spec.forProvider.appEngineHttpTarget.appEngineRouting.withInstance

withInstance(instance)

"App instance. By default, the job is sent to an instance which is available when the job is attempted."

fn spec.forProvider.appEngineHttpTarget.appEngineRouting.withService

withService(service)

"App service. By default, the job is sent to the service which is the default service when the job is attempted."

fn spec.forProvider.appEngineHttpTarget.appEngineRouting.withVersion

withVersion(version)

"App version. By default, the job is sent to the version which is the default version when the job is attempted."

obj spec.forProvider.httpTarget

"HTTP target. If the job providers a http_target the cron will send a request to the targeted url Structure is documented below."

fn spec.forProvider.httpTarget.withBody

withBody(body)

"HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod. A base64-encoded string."

fn spec.forProvider.httpTarget.withHeaders

withHeaders(headers)

"This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas."

fn spec.forProvider.httpTarget.withHeadersMixin

withHeadersMixin(headers)

"This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas."

Note: This function appends passed data to existing values

fn spec.forProvider.httpTarget.withHttpMethod

withHttpMethod(httpMethod)

"Which HTTP method to use for the request."

fn spec.forProvider.httpTarget.withOauthToken

withOauthToken(oauthToken)

"Contains information needed for generating an OAuth token. This type of authorization should be used when sending requests to a GCP endpoint. Structure is documented below."

fn spec.forProvider.httpTarget.withOauthTokenMixin

withOauthTokenMixin(oauthToken)

"Contains information needed for generating an OAuth token. This type of authorization should be used when sending requests to a GCP endpoint. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.httpTarget.withOidcToken

withOidcToken(oidcToken)

"Contains information needed for generating an OpenID Connect token. This type of authorization should be used when sending requests to third party endpoints or Cloud Run. Structure is documented below."

fn spec.forProvider.httpTarget.withOidcTokenMixin

withOidcTokenMixin(oidcToken)

"Contains information needed for generating an OpenID Connect token. This type of authorization should be used when sending requests to third party endpoints or Cloud Run. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.httpTarget.withUri

withUri(uri)

"The full URI path that the request will be sent to."

obj spec.forProvider.httpTarget.oauthToken

"Contains information needed for generating an OAuth token. This type of authorization should be used when sending requests to a GCP endpoint. Structure is documented below."

fn spec.forProvider.httpTarget.oauthToken.withScope

withScope(scope)

"OAuth scope to be used for generating OAuth access token. If not specified, \"https://www.googleapis.com/auth/cloud-platform\" will be used."

fn spec.forProvider.httpTarget.oauthToken.withServiceAccountEmail

withServiceAccountEmail(serviceAccountEmail)

"Service account email to be used for generating OAuth token. The service account must be within the same project as the job."

obj spec.forProvider.httpTarget.oidcToken

"Contains information needed for generating an OpenID Connect token. This type of authorization should be used when sending requests to third party endpoints or Cloud Run. Structure is documented below."

fn spec.forProvider.httpTarget.oidcToken.withAudience

withAudience(audience)

"Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used."

fn spec.forProvider.httpTarget.oidcToken.withServiceAccountEmail

withServiceAccountEmail(serviceAccountEmail)

"Service account email to be used for generating OAuth token. The service account must be within the same project as the job."

obj spec.forProvider.pubsubTarget

"Pub/Sub target If the job providers a Pub/Sub target the cron will publish a message to the provided topic Structure is documented below."

fn spec.forProvider.pubsubTarget.withAttributes

withAttributes(attributes)

"Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute."

fn spec.forProvider.pubsubTarget.withAttributesMixin

withAttributesMixin(attributes)

"Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute."

Note: This function appends passed data to existing values

fn spec.forProvider.pubsubTarget.withData

withData(data)

"The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute. A base64-encoded string."

fn spec.forProvider.pubsubTarget.withTopicName

withTopicName(topicName)

"The full resource name for the Cloud Pub/Sub topic to which messages will be published when a job is delivered. ~>NOTE: The topic name must be in the same format as required by PubSub's PublishRequest.name, e.g. projects/my-project/topics/my-topic."

obj spec.forProvider.pubsubTarget.topicNameRef

"Reference to a Topic in pubsub to populate topicName."

fn spec.forProvider.pubsubTarget.topicNameRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.pubsubTarget.topicNameRef.policy

"Policies for referencing."

fn spec.forProvider.pubsubTarget.topicNameRef.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.pubsubTarget.topicNameRef.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.pubsubTarget.topicNameSelector

"Selector for a Topic in pubsub to populate topicName."

fn spec.forProvider.pubsubTarget.topicNameSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.pubsubTarget.topicNameSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.pubsubTarget.topicNameSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.pubsubTarget.topicNameSelector.policy

"Policies for selection."

fn spec.forProvider.pubsubTarget.topicNameSelector.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.pubsubTarget.topicNameSelector.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.retryConfig

"By default, if a job does not complete successfully, meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings Structure is documented below."

fn spec.forProvider.retryConfig.withMaxBackoffDuration

withMaxBackoffDuration(maxBackoffDuration)

"The maximum amount of time to wait before retrying a job after it fails. A duration in seconds with up to nine fractional digits, terminated by 's'."

fn spec.forProvider.retryConfig.withMaxDoublings

withMaxDoublings(maxDoublings)

"The time between retries will double maxDoublings times. A job's retry interval starts at minBackoffDuration, then doubles maxDoublings times, then increases linearly, and finally retries retries at intervals of maxBackoffDuration up to retryCount times."

fn spec.forProvider.retryConfig.withMaxRetryDuration

withMaxRetryDuration(maxRetryDuration)

"The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retryCount, the job will be retried until both limits are reached. A duration in seconds with up to nine fractional digits, terminated by 's'."

fn spec.forProvider.retryConfig.withMinBackoffDuration

withMinBackoffDuration(minBackoffDuration)

"The minimum amount of time to wait before retrying a job after it fails. A duration in seconds with up to nine fractional digits, terminated by 's'."

fn spec.forProvider.retryConfig.withRetryCount

withRetryCount(retryCount)

"The number of attempts that the system will make to run a job using the exponential backoff procedure described by maxDoublings. Values greater than 5 and negative values are not allowed."

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

withAppEngineHttpTarget(appEngineHttpTarget)

"App Engine HTTP target. If the job providers a App Engine HTTP target the cron will send a request to the service instance Structure is documented below."

fn spec.initProvider.withAppEngineHttpTargetMixin

withAppEngineHttpTargetMixin(appEngineHttpTarget)

"App Engine HTTP target. If the job providers a App Engine HTTP target the cron will send a request to the service instance Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.withAttemptDeadline

withAttemptDeadline(attemptDeadline)

"The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig. The allowed duration for this deadline is:"

fn spec.initProvider.withDescription

withDescription(description)

"A human-readable description for the job. This string must not contain more than 500 characters."

fn spec.initProvider.withHttpTarget

withHttpTarget(httpTarget)

"HTTP target. If the job providers a http_target the cron will send a request to the targeted url Structure is documented below."

fn spec.initProvider.withHttpTargetMixin

withHttpTargetMixin(httpTarget)

"HTTP target. If the job providers a http_target the cron will send a request to the targeted url Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.withPaused

withPaused(paused)

"Sets the job to a paused state. Jobs default to being enabled when this property is not set."

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

withPubsubTarget(pubsubTarget)

"Pub/Sub target If the job providers a Pub/Sub target the cron will publish a message to the provided topic Structure is documented below."

fn spec.initProvider.withPubsubTargetMixin

withPubsubTargetMixin(pubsubTarget)

"Pub/Sub target If the job providers a Pub/Sub target the cron will publish a message to the provided topic Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.withRetryConfig

withRetryConfig(retryConfig)

"By default, if a job does not complete successfully, meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings Structure is documented below."

fn spec.initProvider.withRetryConfigMixin

withRetryConfigMixin(retryConfig)

"By default, if a job does not complete successfully, meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.withSchedule

withSchedule(schedule)

"Describes the schedule on which the job will be executed."

fn spec.initProvider.withTimeZone

withTimeZone(timeZone)

"Specifies the time zone to be used in interpreting schedule. The value of this field must be a time zone name from the tz database."

obj spec.initProvider.appEngineHttpTarget

"App Engine HTTP target. If the job providers a App Engine HTTP target the cron will send a request to the service instance Structure is documented below."

fn spec.initProvider.appEngineHttpTarget.withAppEngineRouting

withAppEngineRouting(appEngineRouting)

"App Engine Routing setting for the job. Structure is documented below."

fn spec.initProvider.appEngineHttpTarget.withAppEngineRoutingMixin

withAppEngineRoutingMixin(appEngineRouting)

"App Engine Routing setting for the job. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.appEngineHttpTarget.withBody

withBody(body)

"HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod. A base64-encoded string."

fn spec.initProvider.appEngineHttpTarget.withHeaders

withHeaders(headers)

"HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created."

fn spec.initProvider.appEngineHttpTarget.withHeadersMixin

withHeadersMixin(headers)

"HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created."

Note: This function appends passed data to existing values

fn spec.initProvider.appEngineHttpTarget.withHttpMethod

withHttpMethod(httpMethod)

"Which HTTP method to use for the request."

fn spec.initProvider.appEngineHttpTarget.withRelativeUri

withRelativeUri(relativeUri)

"The relative URI. The relative URL must begin with \"/\" and must be a valid HTTP relative URL. It can contain a path, query string arguments, and # fragments. If the relative URL is empty, then the root path \"/\" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters"

obj spec.initProvider.appEngineHttpTarget.appEngineRouting

"App Engine Routing setting for the job. Structure is documented below."

fn spec.initProvider.appEngineHttpTarget.appEngineRouting.withInstance

withInstance(instance)

"App instance. By default, the job is sent to an instance which is available when the job is attempted."

fn spec.initProvider.appEngineHttpTarget.appEngineRouting.withService

withService(service)

"App service. By default, the job is sent to the service which is the default service when the job is attempted."

fn spec.initProvider.appEngineHttpTarget.appEngineRouting.withVersion

withVersion(version)

"App version. By default, the job is sent to the version which is the default version when the job is attempted."

obj spec.initProvider.httpTarget

"HTTP target. If the job providers a http_target the cron will send a request to the targeted url Structure is documented below."

fn spec.initProvider.httpTarget.withBody

withBody(body)

"HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod. A base64-encoded string."

fn spec.initProvider.httpTarget.withHeaders

withHeaders(headers)

"This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas."

fn spec.initProvider.httpTarget.withHeadersMixin

withHeadersMixin(headers)

"This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas."

Note: This function appends passed data to existing values

fn spec.initProvider.httpTarget.withHttpMethod

withHttpMethod(httpMethod)

"Which HTTP method to use for the request."

fn spec.initProvider.httpTarget.withOauthToken

withOauthToken(oauthToken)

"Contains information needed for generating an OAuth token. This type of authorization should be used when sending requests to a GCP endpoint. Structure is documented below."

fn spec.initProvider.httpTarget.withOauthTokenMixin

withOauthTokenMixin(oauthToken)

"Contains information needed for generating an OAuth token. This type of authorization should be used when sending requests to a GCP endpoint. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.httpTarget.withOidcToken

withOidcToken(oidcToken)

"Contains information needed for generating an OpenID Connect token. This type of authorization should be used when sending requests to third party endpoints or Cloud Run. Structure is documented below."

fn spec.initProvider.httpTarget.withOidcTokenMixin

withOidcTokenMixin(oidcToken)

"Contains information needed for generating an OpenID Connect token. This type of authorization should be used when sending requests to third party endpoints or Cloud Run. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.httpTarget.withUri

withUri(uri)

"The full URI path that the request will be sent to."

obj spec.initProvider.httpTarget.oauthToken

"Contains information needed for generating an OAuth token. This type of authorization should be used when sending requests to a GCP endpoint. Structure is documented below."

fn spec.initProvider.httpTarget.oauthToken.withScope

withScope(scope)

"OAuth scope to be used for generating OAuth access token. If not specified, \"https://www.googleapis.com/auth/cloud-platform\" will be used."

fn spec.initProvider.httpTarget.oauthToken.withServiceAccountEmail

withServiceAccountEmail(serviceAccountEmail)

"Service account email to be used for generating OAuth token. The service account must be within the same project as the job."

obj spec.initProvider.httpTarget.oidcToken

"Contains information needed for generating an OpenID Connect token. This type of authorization should be used when sending requests to third party endpoints or Cloud Run. Structure is documented below."

fn spec.initProvider.httpTarget.oidcToken.withAudience

withAudience(audience)

"Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used."

fn spec.initProvider.httpTarget.oidcToken.withServiceAccountEmail

withServiceAccountEmail(serviceAccountEmail)

"Service account email to be used for generating OAuth token. The service account must be within the same project as the job."

obj spec.initProvider.pubsubTarget

"Pub/Sub target If the job providers a Pub/Sub target the cron will publish a message to the provided topic Structure is documented below."

fn spec.initProvider.pubsubTarget.withAttributes

withAttributes(attributes)

"Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute."

fn spec.initProvider.pubsubTarget.withAttributesMixin

withAttributesMixin(attributes)

"Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute."

Note: This function appends passed data to existing values

fn spec.initProvider.pubsubTarget.withData

withData(data)

"The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute. A base64-encoded string."

obj spec.initProvider.retryConfig

"By default, if a job does not complete successfully, meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings Structure is documented below."

fn spec.initProvider.retryConfig.withMaxBackoffDuration

withMaxBackoffDuration(maxBackoffDuration)

"The maximum amount of time to wait before retrying a job after it fails. A duration in seconds with up to nine fractional digits, terminated by 's'."

fn spec.initProvider.retryConfig.withMaxDoublings

withMaxDoublings(maxDoublings)

"The time between retries will double maxDoublings times. A job's retry interval starts at minBackoffDuration, then doubles maxDoublings times, then increases linearly, and finally retries retries at intervals of maxBackoffDuration up to retryCount times."

fn spec.initProvider.retryConfig.withMaxRetryDuration

withMaxRetryDuration(maxRetryDuration)

"The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retryCount, the job will be retried until both limits are reached. A duration in seconds with up to nine fractional digits, terminated by 's'."

fn spec.initProvider.retryConfig.withMinBackoffDuration

withMinBackoffDuration(minBackoffDuration)

"The minimum amount of time to wait before retrying a job after it fails. A duration in seconds with up to nine fractional digits, terminated by 's'."

fn spec.initProvider.retryConfig.withRetryCount

withRetryCount(retryCount)

"The number of attempts that the system will make to run a job using the exponential backoff procedure described by maxDoublings. Values greater than 5 and negative values are not allowed."

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