v1beta1

package
v1.55.0 Latest Latest
Warning

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

 Go to latest Published: Jul 1, 2021 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Generate deepcopy object for cloudscheduler/v1beta1 API group

Package v1beta1 contains API Schema definitions for the cloudscheduler v1beta1 API group. +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/GoogleCloudPlatform/k8s-config-connector/pkg/apis/cloudscheduler +k8s:defaulter-gen=TypeMeta +groupName=cloudscheduler.cnrm.cloud.google.com

Index

Constants

This section is empty.

Variables

View Source 
var (
	// SchemeGroupVersion is the group version used to register these objects.
	SchemeGroupVersion = schema.GroupVersion{Group: "cloudscheduler.cnrm.cloud.google.com", Version: "v1beta1"}

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

	// AddToScheme is a global function that registers this API group & version to a scheme
	AddToScheme = SchemeBuilder.AddToScheme

	CloudSchedulerJobGVK = schema.GroupVersionKind{
		Group:   SchemeGroupVersion.Group,
		Version: SchemeGroupVersion.Version,
		Kind:    reflect.TypeOf(CloudSchedulerJob{}).Name(),
	}
)

Functions

This section is empty.

Types

type CloudSchedulerJob 

type CloudSchedulerJob struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   CloudSchedulerJobSpec   `json:"spec,omitempty"`
	Status CloudSchedulerJobStatus `json:"status,omitempty"`
}

CloudSchedulerJob is the Schema for the cloudscheduler API +k8s:openapi-gen=true

func (*CloudSchedulerJob) DeepCopy 

func (in *CloudSchedulerJob) DeepCopy() *CloudSchedulerJob

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

func (*CloudSchedulerJob) DeepCopyInto 

func (in *CloudSchedulerJob) DeepCopyInto(out *CloudSchedulerJob)

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

func (*CloudSchedulerJob) DeepCopyObject 

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

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

type CloudSchedulerJobList 

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

CloudSchedulerJobList contains a list of CloudSchedulerJob

func (*CloudSchedulerJobList) DeepCopy 

func (in *CloudSchedulerJobList) DeepCopy() *CloudSchedulerJobList

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

func (*CloudSchedulerJobList) DeepCopyInto 

func (in *CloudSchedulerJobList) DeepCopyInto(out *CloudSchedulerJobList)

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

func (*CloudSchedulerJobList) DeepCopyObject 

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

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

type CloudSchedulerJobSpec 

type CloudSchedulerJobSpec struct {
	/* Appengine HTTP target. */
	// +optional
	AppEngineHttpTarget *JobAppEngineHttpTarget `json:"appEngineHttpTarget,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, between 15 seconds and 24 hours. */
	// +optional
	AttemptDeadline *string `json:"attemptDeadline,omitempty"`

	/* Optionally caller-specified in jobs.create or jobs.patch. A human-readable description for the job. This string must not contain more than 500 characters. */
	// +optional
	Description *string `json:"description,omitempty"`

	/* HTTP target. */
	// +optional
	HttpTarget *JobHttpTarget `json:"httpTarget,omitempty"`

	/* The location for the resource */
	Location string `json:"location"`

	/* Pub/Sub target. */
	// +optional
	PubsubTarget *JobPubsubTarget `json:"pubsubTarget,omitempty"`

	/* Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default. */
	// +optional
	ResourceID *string `json:"resourceID,omitempty"`

	/* Settings that determine the retry behavior. */
	// +optional
	RetryConfig *JobRetryConfig `json:"retryConfig,omitempty"`

	/* Required, except when used with times, with exponential backoff, until the next scheduled start time. */
	// +optional
	Schedule *string `json:"schedule,omitempty"`

	/* Specifies the time zone to be used in interpreting (http://en.wikipedia.org/wiki/Tz_database). Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT). */
	// +optional
	TimeZone *string `json:"timeZone,omitempty"`
}

func (*CloudSchedulerJobSpec) DeepCopy 

func (in *CloudSchedulerJobSpec) DeepCopy() *CloudSchedulerJobSpec

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

func (*CloudSchedulerJobSpec) DeepCopyInto 

func (in *CloudSchedulerJobSpec) DeepCopyInto(out *CloudSchedulerJobSpec)

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

type CloudSchedulerJobStatus 

type CloudSchedulerJobStatus struct {
	/* Conditions represent the latest available observations of the
	   CloudSchedulerJob's current state. */
	Conditions []v1alpha1.Condition `json:"conditions,omitempty"`
	/*  */
	AppEngineHttpTarget JobAppEngineHttpTargetStatus `json:"appEngineHttpTarget,omitempty"`
	/* Output only. The time the last job attempt started. */
	LastAttemptTime string `json:"lastAttemptTime,omitempty"`
	/* ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource. */
	ObservedGeneration int `json:"observedGeneration,omitempty"`
	/* Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule. */
	ScheduleTime string `json:"scheduleTime,omitempty"`
	/* Output only. State of the job. Possible values: STATE_UNSPECIFIED, ENABLED, PAUSED, DISABLED, UPDATE_FAILED */
	State string `json:"state,omitempty"`
	/* Output only. The response from the target for the last attempted execution. */
	Status JobStatusStatus `json:"status,omitempty"`
	/* Output only. The creation time of the job. */
	UserUpdateTime string `json:"userUpdateTime,omitempty"`
}

func (*CloudSchedulerJobStatus) DeepCopy 

func (in *CloudSchedulerJobStatus) DeepCopy() *CloudSchedulerJobStatus

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

func (*CloudSchedulerJobStatus) DeepCopyInto 

func (in *CloudSchedulerJobStatus) DeepCopyInto(out *CloudSchedulerJobStatus)

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

type JobAppEngineHttpTarget 

type JobAppEngineHttpTarget struct {
	/* Appengine Routing setting for the job. */
	// +optional
	AppEngineRouting *JobAppEngineRouting `json:"appEngineRouting,omitempty"`

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

	/* HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"Appengine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"Appengine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. The headers below are output only. They cannot be set or overridden: * `X-Google-*`: For Google internal use only. * `X-Appengine-*`: For Google internal use only. In addition, some Appengine headers, which contain job-specific information, are also be sent to the job handler. */
	// +optional
	Headers map[string]string `json:"headers,omitempty"`

	/* The HTTP method to use for the request. PATCH and OPTIONS are not permitted. Possible values: HTTP_METHOD_UNSPECIFIED, POST, GET, HEAD, PUT, DELETE, PATCH, OPTIONS */
	// +optional
	HttpMethod *string `json:"httpMethod,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. */
	// +optional
	RelativeUri *string `json:"relativeUri,omitempty"`
}

func (*JobAppEngineHttpTarget) DeepCopy 

func (in *JobAppEngineHttpTarget) DeepCopy() *JobAppEngineHttpTarget

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

func (*JobAppEngineHttpTarget) DeepCopyInto 

func (in *JobAppEngineHttpTarget) DeepCopyInto(out *JobAppEngineHttpTarget)

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

type JobAppEngineHttpTargetStatus 

type JobAppEngineHttpTargetStatus struct {
	/*  */
	AppEngineRouting JobAppEngineRoutingStatus `json:"appEngineRouting,omitempty"`
}

func (*JobAppEngineHttpTargetStatus) DeepCopy 

func (in *JobAppEngineHttpTargetStatus) DeepCopy() *JobAppEngineHttpTargetStatus

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

func (*JobAppEngineHttpTargetStatus) DeepCopyInto 

func (in *JobAppEngineHttpTargetStatus) DeepCopyInto(out *JobAppEngineHttpTargetStatus)

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

type JobAppEngineRouting 

type JobAppEngineRouting struct {
	/* App instance. By default, the job is sent to an instance which is available when the job is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. For more information, see App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing. */
	// +optional
	Instance *string `json:"instance,omitempty"`

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

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

func (*JobAppEngineRouting) DeepCopy 

func (in *JobAppEngineRouting) DeepCopy() *JobAppEngineRouting

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

func (*JobAppEngineRouting) DeepCopyInto 

func (in *JobAppEngineRouting) DeepCopyInto(out *JobAppEngineRouting)

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

type JobAppEngineRoutingStatus 

type JobAppEngineRoutingStatus struct {
	/* Output only. The host that the job is sent to. For more information about how Appengine requests are routed, see (https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). The host is constructed as: * `host = is invalid, then the job will be sent to the default version of the default service when the job is attempted. */
	Host string `json:"host,omitempty"`
}

func (*JobAppEngineRoutingStatus) DeepCopy 

func (in *JobAppEngineRoutingStatus) DeepCopy() *JobAppEngineRoutingStatus

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

func (*JobAppEngineRoutingStatus) DeepCopyInto 

func (in *JobAppEngineRoutingStatus) DeepCopyInto(out *JobAppEngineRoutingStatus)

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

type JobDetailsStatus 

type JobDetailsStatus struct {
	/* A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics. */
	TypeUrl string `json:"typeUrl,omitempty"`

	/* Must be a valid serialized protocol buffer of the above specified type. */
	Value string `json:"value,omitempty"`
}

func (*JobDetailsStatus) DeepCopy 

func (in *JobDetailsStatus) DeepCopy() *JobDetailsStatus

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

func (*JobDetailsStatus) DeepCopyInto 

func (in *JobDetailsStatus) DeepCopyInto(out *JobDetailsStatus)

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

type JobHttpTarget 

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

	/* The user can specify HTTP request headers to send with the job's HTTP request. This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas. These headers represent a subset of the headers that will accompany the job's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is below: - Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-Appengine-*`: Google internal use only. The total size of headers must be less than 80KB. */
	// +optional
	Headers map[string]string `json:"headers,omitempty"`

	/* Which HTTP method to use for the request. Possible values: HTTP_METHOD_UNSPECIFIED, POST, GET, HEAD, PUT, DELETE, PATCH, OPTIONS */
	// +optional
	HttpMethod *string `json:"httpMethod,omitempty"`

	/* If specified, an (https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. */
	// +optional
	OauthToken *JobOauthToken `json:"oauthToken,omitempty"`

	/* If specified, an (https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. */
	// +optional
	OidcToken *JobOidcToken `json:"oidcToken,omitempty"`

	/* Required. The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. */
	Uri string `json:"uri"`
}

func (*JobHttpTarget) DeepCopy 

func (in *JobHttpTarget) DeepCopy() *JobHttpTarget

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

func (*JobHttpTarget) DeepCopyInto 

func (in *JobHttpTarget) DeepCopyInto(out *JobHttpTarget)

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

type JobOauthToken 

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

	/*  */
	// +optional
	ServiceAccountRef *v1alpha1.ResourceRef `json:"serviceAccountRef,omitempty"`
}

func (*JobOauthToken) DeepCopy 

func (in *JobOauthToken) DeepCopy() *JobOauthToken

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

func (*JobOauthToken) DeepCopyInto 

func (in *JobOauthToken) DeepCopyInto(out *JobOauthToken)

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

type JobOidcToken 

type JobOidcToken struct {
	/* Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. */
	// +optional
	Audience *string `json:"audience,omitempty"`

	/*  */
	// +optional
	ServiceAccountRef *v1alpha1.ResourceRef `json:"serviceAccountRef,omitempty"`
}

func (*JobOidcToken) DeepCopy 

func (in *JobOidcToken) DeepCopy() *JobOidcToken

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

func (*JobOidcToken) DeepCopyInto 

func (in *JobOidcToken) DeepCopyInto(out *JobOidcToken)

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

type JobPubsubTarget 

type JobPubsubTarget struct {
	/* Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute. */
	// +optional
	Attributes map[string]string `json:"attributes,omitempty"`

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

	/*  */
	TopicRef v1alpha1.ResourceRef `json:"topicRef"`
}

func (*JobPubsubTarget) DeepCopy 

func (in *JobPubsubTarget) DeepCopy() *JobPubsubTarget

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

func (*JobPubsubTarget) DeepCopyInto 

func (in *JobPubsubTarget) DeepCopyInto(out *JobPubsubTarget)

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

type JobRetryConfig 

type JobRetryConfig struct {
	/* The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour. */
	// +optional
	MaxBackoffDuration *string `json:"maxBackoffDuration,omitempty"`

	/* The time between retries will double `max_doublings` times. A job's retry interval starts at times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... The default value of this field is 5. */
	// +optional
	MaxDoublings *int `json:"maxDoublings,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. The default value for max_retry_duration is zero, which means retry duration is unlimited. */
	// +optional
	MaxRetryDuration *string `json:"maxRetryDuration,omitempty"`

	/* The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds. */
	// +optional
	MinBackoffDuration *string `json:"minBackoffDuration,omitempty"`

	/* The number of attempts that the system will make to run a job using the exponential backoff procedure described by maxDoublings. The default value of retry_count is zero. If retry_count is zero, a job attempt will *not* be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. If retry_count is set to a non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retry_count times, or until the next scheduled execution time, whichever comes first. Values greater than 5 and negative values are not allowed. */
	// +optional
	RetryCount *int `json:"retryCount,omitempty"`
}

func (*JobRetryConfig) DeepCopy 

func (in *JobRetryConfig) DeepCopy() *JobRetryConfig

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

func (*JobRetryConfig) DeepCopyInto 

func (in *JobRetryConfig) DeepCopyInto(out *JobRetryConfig)

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

type JobStatusStatus 

type JobStatusStatus struct {
	/* The status code, which should be an enum value of google.rpc.Code. */
	Code int `json:"code,omitempty"`

	/* A list of messages that carry the error details. There is a common set of message types for APIs to use. */
	Details []JobDetailsStatus `json:"details,omitempty"`

	/* A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the field, or localized by the client. */
	Message string `json:"message,omitempty"`
}

func (*JobStatusStatus) DeepCopy 

func (in *JobStatusStatus) DeepCopy() *JobStatusStatus

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

func (*JobStatusStatus) DeepCopyInto 

func (in *JobStatusStatus) DeepCopyInto(out *JobStatusStatus)

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.