v1beta1

package
v1.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 25, 2024 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Overview

+kubebuilder:object:generate=true +groupName=cloudscheduler.gcp.upbound.io +versionName=v1beta1

Index

Constants

View Source
const (
	CRDGroup   = "cloudscheduler.gcp.upbound.io"
	CRDVersion = "v1beta1"
)

Package type metadata.

Variables

View Source
var (
	// CRDGroupVersion is the API Group Version used to register the objects
	CRDGroupVersion = schema.GroupVersion{Group: CRDGroup, Version: CRDVersion}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: CRDGroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)
View Source
var (
	Job_Kind             = "Job"
	Job_GroupKind        = schema.GroupKind{Group: CRDGroup, Kind: Job_Kind}.String()
	Job_KindAPIVersion   = Job_Kind + "." + CRDGroupVersion.String()
	Job_GroupVersionKind = CRDGroupVersion.WithKind(Job_Kind)
)

Repository type metadata.

Functions

This section is empty.

Types

type AppEngineHTTPTargetInitParameters added in v0.35.0

type AppEngineHTTPTargetInitParameters struct {

	// App Engine Routing setting for the job.
	// Structure is documented below.
	AppEngineRouting []AppEngineRoutingInitParameters `json:"appEngineRouting,omitempty" tf:"app_engine_routing,omitempty"`

	// 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.
	Body *string `json:"body,omitempty" tf:"body,omitempty"`

	// Which HTTP method to use for the request.
	HTTPMethod *string `json:"httpMethod,omitempty" tf:"http_method,omitempty"`

	// HTTP request headers.
	// This map contains the header field names and values.
	// Headers can be set when the job is created.
	// +mapType=granular
	Headers map[string]*string `json:"headers,omitempty" tf:"headers,omitempty"`

	// 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
	RelativeURI *string `json:"relativeUri,omitempty" tf:"relative_uri,omitempty"`
}

func (*AppEngineHTTPTargetInitParameters) DeepCopy added in v0.35.0

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AppEngineHTTPTargetInitParameters.

func (*AppEngineHTTPTargetInitParameters) DeepCopyInto added in v0.35.0

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AppEngineHTTPTargetObservation

type AppEngineHTTPTargetObservation struct {

	// App Engine Routing setting for the job.
	// Structure is documented below.
	AppEngineRouting []AppEngineRoutingObservation `json:"appEngineRouting,omitempty" tf:"app_engine_routing,omitempty"`

	// 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.
	Body *string `json:"body,omitempty" tf:"body,omitempty"`

	// Which HTTP method to use for the request.
	HTTPMethod *string `json:"httpMethod,omitempty" tf:"http_method,omitempty"`

	// HTTP request headers.
	// This map contains the header field names and values.
	// Headers can be set when the job is created.
	// +mapType=granular
	Headers map[string]*string `json:"headers,omitempty" tf:"headers,omitempty"`

	// 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
	RelativeURI *string `json:"relativeUri,omitempty" tf:"relative_uri,omitempty"`
}

func (*AppEngineHTTPTargetObservation) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AppEngineHTTPTargetObservation.

func (*AppEngineHTTPTargetObservation) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AppEngineHTTPTargetParameters

type AppEngineHTTPTargetParameters struct {

	// App Engine Routing setting for the job.
	// Structure is documented below.
	// +kubebuilder:validation:Optional
	AppEngineRouting []AppEngineRoutingParameters `json:"appEngineRouting,omitempty" tf:"app_engine_routing,omitempty"`

	// 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.
	// +kubebuilder:validation:Optional
	Body *string `json:"body,omitempty" tf:"body,omitempty"`

	// Which HTTP method to use for the request.
	// +kubebuilder:validation:Optional
	HTTPMethod *string `json:"httpMethod,omitempty" tf:"http_method,omitempty"`

	// HTTP request headers.
	// This map contains the header field names and values.
	// Headers can be set when the job is created.
	// +kubebuilder:validation:Optional
	// +mapType=granular
	Headers map[string]*string `json:"headers,omitempty" tf:"headers,omitempty"`

	// 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
	// +kubebuilder:validation:Optional
	RelativeURI *string `json:"relativeUri" tf:"relative_uri,omitempty"`
}

func (*AppEngineHTTPTargetParameters) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AppEngineHTTPTargetParameters.

func (*AppEngineHTTPTargetParameters) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AppEngineRoutingInitParameters added in v0.35.0

type AppEngineRoutingInitParameters struct {

	// App instance.
	// By default, the job is sent to an instance which is available when the job is attempted.
	Instance *string `json:"instance,omitempty" tf:"instance,omitempty"`

	// App service.
	// By default, the job is sent to the service which is the default service when the job is attempted.
	Service *string `json:"service,omitempty" tf:"service,omitempty"`

	// App version.
	// By default, the job is sent to the version which is the default version when the job is attempted.
	Version *string `json:"version,omitempty" tf:"version,omitempty"`
}

func (*AppEngineRoutingInitParameters) DeepCopy added in v0.35.0

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AppEngineRoutingInitParameters.

func (*AppEngineRoutingInitParameters) DeepCopyInto added in v0.35.0

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AppEngineRoutingObservation

type AppEngineRoutingObservation struct {

	// App instance.
	// By default, the job is sent to an instance which is available when the job is attempted.
	Instance *string `json:"instance,omitempty" tf:"instance,omitempty"`

	// App service.
	// By default, the job is sent to the service which is the default service when the job is attempted.
	Service *string `json:"service,omitempty" tf:"service,omitempty"`

	// App version.
	// By default, the job is sent to the version which is the default version when the job is attempted.
	Version *string `json:"version,omitempty" tf:"version,omitempty"`
}

func (*AppEngineRoutingObservation) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AppEngineRoutingObservation.

func (*AppEngineRoutingObservation) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AppEngineRoutingParameters

type AppEngineRoutingParameters struct {

	// App instance.
	// By default, the job is sent to an instance which is available when the job is attempted.
	// +kubebuilder:validation:Optional
	Instance *string `json:"instance,omitempty" tf:"instance,omitempty"`

	// App service.
	// By default, the job is sent to the service which is the default service when the job is attempted.
	// +kubebuilder:validation:Optional
	Service *string `json:"service,omitempty" tf:"service,omitempty"`

	// App version.
	// By default, the job is sent to the version which is the default version when the job is attempted.
	// +kubebuilder:validation:Optional
	Version *string `json:"version,omitempty" tf:"version,omitempty"`
}

func (*AppEngineRoutingParameters) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AppEngineRoutingParameters.

func (*AppEngineRoutingParameters) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type HTTPTargetInitParameters added in v0.35.0

type HTTPTargetInitParameters struct {

	// 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.
	Body *string `json:"body,omitempty" tf:"body,omitempty"`

	// Which HTTP method to use for the request.
	HTTPMethod *string `json:"httpMethod,omitempty" tf:"http_method,omitempty"`

	// This map contains the header field names and values.
	// Repeated headers are not supported, but a header value can contain commas.
	// +mapType=granular
	Headers map[string]*string `json:"headers,omitempty" tf:"headers,omitempty"`

	// 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.
	OAuthToken []OAuthTokenInitParameters `json:"oauthToken,omitempty" tf:"oauth_token,omitempty"`

	// 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.
	OidcToken []OidcTokenInitParameters `json:"oidcToken,omitempty" tf:"oidc_token,omitempty"`

	// The full URI path that the request will be sent to.
	URI *string `json:"uri,omitempty" tf:"uri,omitempty"`
}

func (*HTTPTargetInitParameters) DeepCopy added in v0.35.0

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPTargetInitParameters.

func (*HTTPTargetInitParameters) DeepCopyInto added in v0.35.0

func (in *HTTPTargetInitParameters) DeepCopyInto(out *HTTPTargetInitParameters)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type HTTPTargetObservation

type HTTPTargetObservation struct {

	// 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.
	Body *string `json:"body,omitempty" tf:"body,omitempty"`

	// Which HTTP method to use for the request.
	HTTPMethod *string `json:"httpMethod,omitempty" tf:"http_method,omitempty"`

	// This map contains the header field names and values.
	// Repeated headers are not supported, but a header value can contain commas.
	// +mapType=granular
	Headers map[string]*string `json:"headers,omitempty" tf:"headers,omitempty"`

	// 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.
	OAuthToken []OAuthTokenObservation `json:"oauthToken,omitempty" tf:"oauth_token,omitempty"`

	// 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.
	OidcToken []OidcTokenObservation `json:"oidcToken,omitempty" tf:"oidc_token,omitempty"`

	// The full URI path that the request will be sent to.
	URI *string `json:"uri,omitempty" tf:"uri,omitempty"`
}

func (*HTTPTargetObservation) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPTargetObservation.

func (*HTTPTargetObservation) DeepCopyInto

func (in *HTTPTargetObservation) DeepCopyInto(out *HTTPTargetObservation)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type HTTPTargetParameters

type HTTPTargetParameters struct {

	// 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.
	// +kubebuilder:validation:Optional
	Body *string `json:"body,omitempty" tf:"body,omitempty"`

	// Which HTTP method to use for the request.
	// +kubebuilder:validation:Optional
	HTTPMethod *string `json:"httpMethod,omitempty" tf:"http_method,omitempty"`

	// This map contains the header field names and values.
	// Repeated headers are not supported, but a header value can contain commas.
	// +kubebuilder:validation:Optional
	// +mapType=granular
	Headers map[string]*string `json:"headers,omitempty" tf:"headers,omitempty"`

	// 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.
	// +kubebuilder:validation:Optional
	OAuthToken []OAuthTokenParameters `json:"oauthToken,omitempty" tf:"oauth_token,omitempty"`

	// 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.
	// +kubebuilder:validation:Optional
	OidcToken []OidcTokenParameters `json:"oidcToken,omitempty" tf:"oidc_token,omitempty"`

	// The full URI path that the request will be sent to.
	// +kubebuilder:validation:Optional
	URI *string `json:"uri" tf:"uri,omitempty"`
}

func (*HTTPTargetParameters) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPTargetParameters.

func (*HTTPTargetParameters) DeepCopyInto

func (in *HTTPTargetParameters) DeepCopyInto(out *HTTPTargetParameters)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Job

type Job struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              JobSpec   `json:"spec"`
	Status            JobStatus `json:"status,omitempty"`
}

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. +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status" +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status" +kubebuilder:printcolumn:name="EXTERNAL-NAME",type="string",JSONPath=".metadata.annotations.crossplane\\.io/external-name" +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:resource:scope=Cluster,categories={crossplane,managed,gcp}

func (*Job) DeepCopy

func (in *Job) DeepCopy() *Job

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Job.

func (*Job) DeepCopyInto

func (in *Job) DeepCopyInto(out *Job)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Job) DeepCopyObject

func (in *Job) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Job) GetCondition

func (mg *Job) GetCondition(ct xpv1.ConditionType) xpv1.Condition

GetCondition of this Job.

func (*Job) GetConnectionDetailsMapping

func (tr *Job) GetConnectionDetailsMapping() map[string]string

GetConnectionDetailsMapping for this Job

func (*Job) GetDeletionPolicy

func (mg *Job) GetDeletionPolicy() xpv1.DeletionPolicy

GetDeletionPolicy of this Job.

func (*Job) GetID

func (tr *Job) GetID() string

GetID returns ID of underlying Terraform resource of this Job

func (*Job) GetInitParameters added in v0.35.0

func (tr *Job) GetInitParameters() (map[string]any, error)

GetInitParameters of this Job

func (*Job) GetManagementPolicies added in v0.35.0

func (mg *Job) GetManagementPolicies() xpv1.ManagementPolicies

GetManagementPolicies of this Job.

func (*Job) GetMergedParameters added in v0.40.0

func (tr *Job) GetMergedParameters(shouldMergeInitProvider bool) (map[string]any, error)

GetInitParameters of this Job

func (*Job) GetObservation

func (tr *Job) GetObservation() (map[string]any, error)

GetObservation of this Job

func (*Job) GetParameters

func (tr *Job) GetParameters() (map[string]any, error)

GetParameters of this Job

func (*Job) GetProviderConfigReference

func (mg *Job) GetProviderConfigReference() *xpv1.Reference

GetProviderConfigReference of this Job.

func (*Job) GetPublishConnectionDetailsTo

func (mg *Job) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo

GetPublishConnectionDetailsTo of this Job.

func (*Job) GetTerraformResourceType

func (mg *Job) GetTerraformResourceType() string

GetTerraformResourceType returns Terraform resource type for this Job

func (*Job) GetTerraformSchemaVersion

func (tr *Job) GetTerraformSchemaVersion() int

GetTerraformSchemaVersion returns the associated Terraform schema version

func (*Job) GetWriteConnectionSecretToReference

func (mg *Job) GetWriteConnectionSecretToReference() *xpv1.SecretReference

GetWriteConnectionSecretToReference of this Job.

func (*Job) Hub added in v0.41.2

func (tr *Job) Hub()

Hub marks this type as a conversion hub.

func (*Job) LateInitialize

func (tr *Job) LateInitialize(attrs []byte) (bool, error)

LateInitialize this Job using its observed tfState. returns True if there are any spec changes for the resource.

func (*Job) ResolveReferences

func (mg *Job) ResolveReferences(ctx context.Context, c client.Reader) error

func (*Job) SetConditions

func (mg *Job) SetConditions(c ...xpv1.Condition)

SetConditions of this Job.

func (*Job) SetDeletionPolicy

func (mg *Job) SetDeletionPolicy(r xpv1.DeletionPolicy)

SetDeletionPolicy of this Job.

func (*Job) SetManagementPolicies added in v0.35.0

func (mg *Job) SetManagementPolicies(r xpv1.ManagementPolicies)

SetManagementPolicies of this Job.

func (*Job) SetObservation

func (tr *Job) SetObservation(obs map[string]any) error

SetObservation for this Job

func (*Job) SetParameters

func (tr *Job) SetParameters(params map[string]any) error

SetParameters for this Job

func (*Job) SetProviderConfigReference

func (mg *Job) SetProviderConfigReference(r *xpv1.Reference)

SetProviderConfigReference of this Job.

func (*Job) SetPublishConnectionDetailsTo

func (mg *Job) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)

SetPublishConnectionDetailsTo of this Job.

func (*Job) SetWriteConnectionSecretToReference

func (mg *Job) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)

SetWriteConnectionSecretToReference of this Job.

type JobInitParameters added in v0.35.0

type JobInitParameters struct {

	// 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.
	AppEngineHTTPTarget []AppEngineHTTPTargetInitParameters `json:"appEngineHttpTarget,omitempty" tf:"app_engine_http_target,omitempty"`

	// 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:
	AttemptDeadline *string `json:"attemptDeadline,omitempty" tf:"attempt_deadline,omitempty"`

	// A human-readable description for the job.
	// This string must not contain more than 500 characters.
	Description *string `json:"description,omitempty" tf:"description,omitempty"`

	// HTTP target.
	// If the job providers a http_target the cron will
	// send a request to the targeted url
	// Structure is documented below.
	HTTPTarget []HTTPTargetInitParameters `json:"httpTarget,omitempty" tf:"http_target,omitempty"`

	// Sets the job to a paused state. Jobs default to being enabled when this property is not set.
	Paused *bool `json:"paused,omitempty" tf:"paused,omitempty"`

	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project *string `json:"project,omitempty" tf:"project,omitempty"`

	// 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.
	PubsubTarget []PubsubTargetInitParameters `json:"pubsubTarget,omitempty" tf:"pubsub_target,omitempty"`

	// 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.
	RetryConfig []RetryConfigInitParameters `json:"retryConfig,omitempty" tf:"retry_config,omitempty"`

	// Describes the schedule on which the job will be executed.
	Schedule *string `json:"schedule,omitempty" tf:"schedule,omitempty"`

	// 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.
	TimeZone *string `json:"timeZone,omitempty" tf:"time_zone,omitempty"`
}

func (*JobInitParameters) DeepCopy added in v0.35.0

func (in *JobInitParameters) DeepCopy() *JobInitParameters

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JobInitParameters.

func (*JobInitParameters) DeepCopyInto added in v0.35.0

func (in *JobInitParameters) DeepCopyInto(out *JobInitParameters)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type JobList

type JobList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Job `json:"items"`
}

JobList contains a list of Jobs

func (*JobList) DeepCopy

func (in *JobList) DeepCopy() *JobList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JobList.

func (*JobList) DeepCopyInto

func (in *JobList) DeepCopyInto(out *JobList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*JobList) DeepCopyObject

func (in *JobList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*JobList) GetItems

func (l *JobList) GetItems() []resource.Managed

GetItems of this JobList.

type JobObservation

type JobObservation struct {

	// 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.
	AppEngineHTTPTarget []AppEngineHTTPTargetObservation `json:"appEngineHttpTarget,omitempty" tf:"app_engine_http_target,omitempty"`

	// 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:
	AttemptDeadline *string `json:"attemptDeadline,omitempty" tf:"attempt_deadline,omitempty"`

	// A human-readable description for the job.
	// This string must not contain more than 500 characters.
	Description *string `json:"description,omitempty" tf:"description,omitempty"`

	// HTTP target.
	// If the job providers a http_target the cron will
	// send a request to the targeted url
	// Structure is documented below.
	HTTPTarget []HTTPTargetObservation `json:"httpTarget,omitempty" tf:"http_target,omitempty"`

	// an identifier for the resource with format projects/{{project}}/locations/{{region}}/jobs/{{name}}
	ID *string `json:"id,omitempty" tf:"id,omitempty"`

	// Sets the job to a paused state. Jobs default to being enabled when this property is not set.
	Paused *bool `json:"paused,omitempty" tf:"paused,omitempty"`

	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project *string `json:"project,omitempty" tf:"project,omitempty"`

	// 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.
	PubsubTarget []PubsubTargetObservation `json:"pubsubTarget,omitempty" tf:"pubsub_target,omitempty"`

	// Region where the scheduler job resides.
	Region *string `json:"region,omitempty" tf:"region,omitempty"`

	// 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.
	RetryConfig []RetryConfigObservation `json:"retryConfig,omitempty" tf:"retry_config,omitempty"`

	// Describes the schedule on which the job will be executed.
	Schedule *string `json:"schedule,omitempty" tf:"schedule,omitempty"`

	// State of the job.
	State *string `json:"state,omitempty" tf:"state,omitempty"`

	// 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.
	TimeZone *string `json:"timeZone,omitempty" tf:"time_zone,omitempty"`
}

func (*JobObservation) DeepCopy

func (in *JobObservation) DeepCopy() *JobObservation

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JobObservation.

func (*JobObservation) DeepCopyInto

func (in *JobObservation) DeepCopyInto(out *JobObservation)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type JobParameters

type JobParameters struct {

	// 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.
	// +kubebuilder:validation:Optional
	AppEngineHTTPTarget []AppEngineHTTPTargetParameters `json:"appEngineHttpTarget,omitempty" tf:"app_engine_http_target,omitempty"`

	// 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:
	// +kubebuilder:validation:Optional
	AttemptDeadline *string `json:"attemptDeadline,omitempty" tf:"attempt_deadline,omitempty"`

	// A human-readable description for the job.
	// This string must not contain more than 500 characters.
	// +kubebuilder:validation:Optional
	Description *string `json:"description,omitempty" tf:"description,omitempty"`

	// HTTP target.
	// If the job providers a http_target the cron will
	// send a request to the targeted url
	// Structure is documented below.
	// +kubebuilder:validation:Optional
	HTTPTarget []HTTPTargetParameters `json:"httpTarget,omitempty" tf:"http_target,omitempty"`

	// Sets the job to a paused state. Jobs default to being enabled when this property is not set.
	// +kubebuilder:validation:Optional
	Paused *bool `json:"paused,omitempty" tf:"paused,omitempty"`

	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	// +kubebuilder:validation:Optional
	Project *string `json:"project,omitempty" tf:"project,omitempty"`

	// 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.
	// +kubebuilder:validation:Optional
	PubsubTarget []PubsubTargetParameters `json:"pubsubTarget,omitempty" tf:"pubsub_target,omitempty"`

	// Region where the scheduler job resides.
	// +kubebuilder:validation:Required
	Region *string `json:"region" tf:"region,omitempty"`

	// 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.
	// +kubebuilder:validation:Optional
	RetryConfig []RetryConfigParameters `json:"retryConfig,omitempty" tf:"retry_config,omitempty"`

	// Describes the schedule on which the job will be executed.
	// +kubebuilder:validation:Optional
	Schedule *string `json:"schedule,omitempty" tf:"schedule,omitempty"`

	// 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.
	// +kubebuilder:validation:Optional
	TimeZone *string `json:"timeZone,omitempty" tf:"time_zone,omitempty"`
}

func (*JobParameters) DeepCopy

func (in *JobParameters) DeepCopy() *JobParameters

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JobParameters.

func (*JobParameters) DeepCopyInto

func (in *JobParameters) DeepCopyInto(out *JobParameters)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type JobSpec

type JobSpec struct {
	v1.ResourceSpec `json:",inline"`
	ForProvider     JobParameters `json:"forProvider"`
	// THIS IS A BETA FIELD. It will be honored
	// unless the Management Policies feature flag is disabled.
	// 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.
	InitProvider JobInitParameters `json:"initProvider,omitempty"`
}

JobSpec defines the desired state of Job

func (*JobSpec) DeepCopy

func (in *JobSpec) DeepCopy() *JobSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JobSpec.

func (*JobSpec) DeepCopyInto

func (in *JobSpec) DeepCopyInto(out *JobSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type JobStatus

type JobStatus struct {
	v1.ResourceStatus `json:",inline"`
	AtProvider        JobObservation `json:"atProvider,omitempty"`
}

JobStatus defines the observed state of Job.

func (*JobStatus) DeepCopy

func (in *JobStatus) DeepCopy() *JobStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JobStatus.

func (*JobStatus) DeepCopyInto

func (in *JobStatus) DeepCopyInto(out *JobStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type OAuthTokenInitParameters added in v0.35.0

type OAuthTokenInitParameters struct {

	// OAuth scope to be used for generating OAuth access token. If not specified,
	// "https://www.googleapis.com/auth/cloud-platform" will be used.
	Scope *string `json:"scope,omitempty" tf:"scope,omitempty"`

	// Service account email to be used for generating OAuth token.
	// The service account must be within the same project as the job.
	ServiceAccountEmail *string `json:"serviceAccountEmail,omitempty" tf:"service_account_email,omitempty"`
}

func (*OAuthTokenInitParameters) DeepCopy added in v0.35.0

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuthTokenInitParameters.

func (*OAuthTokenInitParameters) DeepCopyInto added in v0.35.0

func (in *OAuthTokenInitParameters) DeepCopyInto(out *OAuthTokenInitParameters)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type OAuthTokenObservation

type OAuthTokenObservation struct {

	// OAuth scope to be used for generating OAuth access token. If not specified,
	// "https://www.googleapis.com/auth/cloud-platform" will be used.
	Scope *string `json:"scope,omitempty" tf:"scope,omitempty"`

	// Service account email to be used for generating OAuth token.
	// The service account must be within the same project as the job.
	ServiceAccountEmail *string `json:"serviceAccountEmail,omitempty" tf:"service_account_email,omitempty"`
}

func (*OAuthTokenObservation) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuthTokenObservation.

func (*OAuthTokenObservation) DeepCopyInto

func (in *OAuthTokenObservation) DeepCopyInto(out *OAuthTokenObservation)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type OAuthTokenParameters

type OAuthTokenParameters struct {

	// OAuth scope to be used for generating OAuth access token. If not specified,
	// "https://www.googleapis.com/auth/cloud-platform" will be used.
	// +kubebuilder:validation:Optional
	Scope *string `json:"scope,omitempty" tf:"scope,omitempty"`

	// Service account email to be used for generating OAuth token.
	// The service account must be within the same project as the job.
	// +kubebuilder:validation:Optional
	ServiceAccountEmail *string `json:"serviceAccountEmail" tf:"service_account_email,omitempty"`
}

func (*OAuthTokenParameters) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuthTokenParameters.

func (*OAuthTokenParameters) DeepCopyInto

func (in *OAuthTokenParameters) DeepCopyInto(out *OAuthTokenParameters)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type OidcTokenInitParameters added in v0.35.0

type OidcTokenInitParameters struct {

	// Audience to be used when generating OIDC token. If not specified,
	// the URI specified in target will be used.
	Audience *string `json:"audience,omitempty" tf:"audience,omitempty"`

	// Service account email to be used for generating OAuth token.
	// The service account must be within the same project as the job.
	ServiceAccountEmail *string `json:"serviceAccountEmail,omitempty" tf:"service_account_email,omitempty"`
}

func (*OidcTokenInitParameters) DeepCopy added in v0.35.0

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OidcTokenInitParameters.

func (*OidcTokenInitParameters) DeepCopyInto added in v0.35.0

func (in *OidcTokenInitParameters) DeepCopyInto(out *OidcTokenInitParameters)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type OidcTokenObservation

type OidcTokenObservation struct {

	// Audience to be used when generating OIDC token. If not specified,
	// the URI specified in target will be used.
	Audience *string `json:"audience,omitempty" tf:"audience,omitempty"`

	// Service account email to be used for generating OAuth token.
	// The service account must be within the same project as the job.
	ServiceAccountEmail *string `json:"serviceAccountEmail,omitempty" tf:"service_account_email,omitempty"`
}

func (*OidcTokenObservation) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OidcTokenObservation.

func (*OidcTokenObservation) DeepCopyInto

func (in *OidcTokenObservation) DeepCopyInto(out *OidcTokenObservation)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type OidcTokenParameters

type OidcTokenParameters struct {

	// Audience to be used when generating OIDC token. If not specified,
	// the URI specified in target will be used.
	// +kubebuilder:validation:Optional
	Audience *string `json:"audience,omitempty" tf:"audience,omitempty"`

	// Service account email to be used for generating OAuth token.
	// The service account must be within the same project as the job.
	// +kubebuilder:validation:Optional
	ServiceAccountEmail *string `json:"serviceAccountEmail" tf:"service_account_email,omitempty"`
}

func (*OidcTokenParameters) DeepCopy

func (in *OidcTokenParameters) DeepCopy() *OidcTokenParameters

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OidcTokenParameters.

func (*OidcTokenParameters) DeepCopyInto

func (in *OidcTokenParameters) DeepCopyInto(out *OidcTokenParameters)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PubsubTargetInitParameters added in v0.35.0

type PubsubTargetInitParameters struct {

	// Attributes for PubsubMessage.
	// Pubsub message must contain either non-empty data, or at least one attribute.
	// +mapType=granular
	Attributes map[string]*string `json:"attributes,omitempty" tf:"attributes,omitempty"`

	// The message payload for PubsubMessage.
	// Pubsub message must contain either non-empty data, or at least one attribute.
	// A base64-encoded string.
	Data *string `json:"data,omitempty" tf:"data,omitempty"`

	// 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.
	// +crossplane:generate:reference:type=github.com/upbound/provider-gcp/apis/pubsub/v1beta1.Topic
	TopicName *string `json:"topicName,omitempty" tf:"topic_name,omitempty"`

	// Reference to a Topic in pubsub to populate topicName.
	// +kubebuilder:validation:Optional
	TopicNameRef *v1.Reference `json:"topicNameRef,omitempty" tf:"-"`

	// Selector for a Topic in pubsub to populate topicName.
	// +kubebuilder:validation:Optional
	TopicNameSelector *v1.Selector `json:"topicNameSelector,omitempty" tf:"-"`
}

func (*PubsubTargetInitParameters) DeepCopy added in v0.35.0

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PubsubTargetInitParameters.

func (*PubsubTargetInitParameters) DeepCopyInto added in v0.35.0

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PubsubTargetObservation

type PubsubTargetObservation struct {

	// Attributes for PubsubMessage.
	// Pubsub message must contain either non-empty data, or at least one attribute.
	// +mapType=granular
	Attributes map[string]*string `json:"attributes,omitempty" tf:"attributes,omitempty"`

	// The message payload for PubsubMessage.
	// Pubsub message must contain either non-empty data, or at least one attribute.
	// A base64-encoded string.
	Data *string `json:"data,omitempty" tf:"data,omitempty"`

	// 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.
	TopicName *string `json:"topicName,omitempty" tf:"topic_name,omitempty"`
}

func (*PubsubTargetObservation) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PubsubTargetObservation.

func (*PubsubTargetObservation) DeepCopyInto

func (in *PubsubTargetObservation) DeepCopyInto(out *PubsubTargetObservation)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PubsubTargetParameters

type PubsubTargetParameters struct {

	// Attributes for PubsubMessage.
	// Pubsub message must contain either non-empty data, or at least one attribute.
	// +kubebuilder:validation:Optional
	// +mapType=granular
	Attributes map[string]*string `json:"attributes,omitempty" tf:"attributes,omitempty"`

	// The message payload for PubsubMessage.
	// Pubsub message must contain either non-empty data, or at least one attribute.
	// A base64-encoded string.
	// +kubebuilder:validation:Optional
	Data *string `json:"data,omitempty" tf:"data,omitempty"`

	// 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.
	// +crossplane:generate:reference:type=github.com/upbound/provider-gcp/apis/pubsub/v1beta1.Topic
	// +kubebuilder:validation:Optional
	TopicName *string `json:"topicName,omitempty" tf:"topic_name,omitempty"`

	// Reference to a Topic in pubsub to populate topicName.
	// +kubebuilder:validation:Optional
	TopicNameRef *v1.Reference `json:"topicNameRef,omitempty" tf:"-"`

	// Selector for a Topic in pubsub to populate topicName.
	// +kubebuilder:validation:Optional
	TopicNameSelector *v1.Selector `json:"topicNameSelector,omitempty" tf:"-"`
}

func (*PubsubTargetParameters) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PubsubTargetParameters.

func (*PubsubTargetParameters) DeepCopyInto

func (in *PubsubTargetParameters) DeepCopyInto(out *PubsubTargetParameters)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RetryConfigInitParameters added in v0.35.0

type RetryConfigInitParameters struct {

	// 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'.
	MaxBackoffDuration *string `json:"maxBackoffDuration,omitempty" tf:"max_backoff_duration,omitempty"`

	// 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.
	MaxDoublings *float64 `json:"maxDoublings,omitempty" tf:"max_doublings,omitempty"`

	// 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'.
	MaxRetryDuration *string `json:"maxRetryDuration,omitempty" tf:"max_retry_duration,omitempty"`

	// 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'.
	MinBackoffDuration *string `json:"minBackoffDuration,omitempty" tf:"min_backoff_duration,omitempty"`

	// 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.
	RetryCount *float64 `json:"retryCount,omitempty" tf:"retry_count,omitempty"`
}

func (*RetryConfigInitParameters) DeepCopy added in v0.35.0

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RetryConfigInitParameters.

func (*RetryConfigInitParameters) DeepCopyInto added in v0.35.0

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RetryConfigObservation

type RetryConfigObservation struct {

	// 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'.
	MaxBackoffDuration *string `json:"maxBackoffDuration,omitempty" tf:"max_backoff_duration,omitempty"`

	// 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.
	MaxDoublings *float64 `json:"maxDoublings,omitempty" tf:"max_doublings,omitempty"`

	// 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'.
	MaxRetryDuration *string `json:"maxRetryDuration,omitempty" tf:"max_retry_duration,omitempty"`

	// 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'.
	MinBackoffDuration *string `json:"minBackoffDuration,omitempty" tf:"min_backoff_duration,omitempty"`

	// 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.
	RetryCount *float64 `json:"retryCount,omitempty" tf:"retry_count,omitempty"`
}

func (*RetryConfigObservation) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RetryConfigObservation.

func (*RetryConfigObservation) DeepCopyInto

func (in *RetryConfigObservation) DeepCopyInto(out *RetryConfigObservation)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RetryConfigParameters

type RetryConfigParameters struct {

	// 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'.
	// +kubebuilder:validation:Optional
	MaxBackoffDuration *string `json:"maxBackoffDuration,omitempty" tf:"max_backoff_duration,omitempty"`

	// 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.
	// +kubebuilder:validation:Optional
	MaxDoublings *float64 `json:"maxDoublings,omitempty" tf:"max_doublings,omitempty"`

	// 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'.
	// +kubebuilder:validation:Optional
	MaxRetryDuration *string `json:"maxRetryDuration,omitempty" tf:"max_retry_duration,omitempty"`

	// 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'.
	// +kubebuilder:validation:Optional
	MinBackoffDuration *string `json:"minBackoffDuration,omitempty" tf:"min_backoff_duration,omitempty"`

	// 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.
	// +kubebuilder:validation:Optional
	RetryCount *float64 `json:"retryCount,omitempty" tf:"retry_count,omitempty"`
}

func (*RetryConfigParameters) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RetryConfigParameters.

func (*RetryConfigParameters) DeepCopyInto

func (in *RetryConfigParameters) DeepCopyInto(out *RetryConfigParameters)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL