Package cloud.google.com/go/scheduler/apiv1beta1/schedulerpb (v1.10.13)

Version 1.10.13

• 1.11.1 (latest)
• 1.11.0
• 1.10.13
• 1.9.1
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.1.0

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Note: To get more information about this package, such as access to older versions, view this package on pkg.go.dev.

Variables

Job_State_name, Job_State_value

var (
	Job_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "ENABLED",
		2: "PAUSED",
		3: "DISABLED",
		4: "UPDATE_FAILED",
	}
	Job_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"ENABLED":           1,
		"PAUSED":            2,
		"DISABLED":          3,
		"UPDATE_FAILED":     4,
	}
)

Enum value maps for Job_State.

HttpMethod_name, HttpMethod_value

var (
	HttpMethod_name = map[int32]string{
		0: "HTTP_METHOD_UNSPECIFIED",
		1: "POST",
		2: "GET",
		3: "HEAD",
		4: "PUT",
		5: "DELETE",
		6: "PATCH",
		7: "OPTIONS",
	}
	HttpMethod_value = map[string]int32{
		"HTTP_METHOD_UNSPECIFIED": 0,
		"POST":                    1,
		"GET":                     2,
		"HEAD":                    3,
		"PUT":                     4,
		"DELETE":                  5,
		"PATCH":                   6,
		"OPTIONS":                 7,
	}
)

Enum value maps for HttpMethod.

File_google_cloud_scheduler_v1beta1_cloudscheduler_proto

var File_google_cloud_scheduler_v1beta1_cloudscheduler_proto protoreflect.FileDescriptor

File_google_cloud_scheduler_v1beta1_job_proto

var File_google_cloud_scheduler_v1beta1_job_proto protoreflect.FileDescriptor

File_google_cloud_scheduler_v1beta1_target_proto

var File_google_cloud_scheduler_v1beta1_target_proto protoreflect.FileDescriptor

Functions

func RegisterCloudSchedulerServer

func RegisterCloudSchedulerServer(s *grpc.Server, srv CloudSchedulerServer)

AppEngineHttpTarget

type AppEngineHttpTarget struct {
	HttpMethod HttpMethod "" /* 139 byte string literal not displayed */

	AppEngineRouting *AppEngineRouting `protobuf:"bytes,2,opt,name=app_engine_routing,json=appEngineRouting,proto3" json:"app_engine_routing,omitempty"`

	RelativeUri string `protobuf:"bytes,3,opt,name=relative_uri,json=relativeUri,proto3" json:"relative_uri,omitempty"`

	Headers map[string]string "" /* 155 byte string literal not displayed */

	Body []byte `protobuf:"bytes,5,opt,name=body,proto3" json:"body,omitempty"`

}

App Engine target. The job will be pushed to a job handler by means of an HTTP request via an [http_method][google.cloud.scheduler.v1beta1.AppEngineHttpTarget.http_method] such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. Error 503 is considered an App Engine system error instead of an application error. Requests returning error 503 will be retried regardless of retry configuration and not counted against retry counts. Any other response code, or a failure to receive a response before the deadline, constitutes a failed attempt.

func (*AppEngineHttpTarget) Descriptor

func (*AppEngineHttpTarget) Descriptor() ([]byte, []int)

Deprecated: Use AppEngineHttpTarget.ProtoReflect.Descriptor instead.

func (*AppEngineHttpTarget) GetAppEngineRouting

func (x *AppEngineHttpTarget) GetAppEngineRouting() *AppEngineRouting

func (*AppEngineHttpTarget) GetBody

func (x *AppEngineHttpTarget) GetBody() []byte

func (*AppEngineHttpTarget) GetHeaders

func (x *AppEngineHttpTarget) GetHeaders() map[string]string

func (*AppEngineHttpTarget) GetHttpMethod

func (x *AppEngineHttpTarget) GetHttpMethod() HttpMethod

func (*AppEngineHttpTarget) GetRelativeUri

func (x *AppEngineHttpTarget) GetRelativeUri() string

func (*AppEngineHttpTarget) ProtoMessage

func (*AppEngineHttpTarget) ProtoMessage()

func (*AppEngineHttpTarget) ProtoReflect

func (x *AppEngineHttpTarget) ProtoReflect() protoreflect.Message

func (*AppEngineHttpTarget) Reset

func (x *AppEngineHttpTarget) Reset()

func (*AppEngineHttpTarget) String

func (x *AppEngineHttpTarget) String() string

AppEngineRouting

type AppEngineRouting struct {

	// App service.
	//
	// By default, the job is sent to the service which is the default
	// service when the job is attempted.
	Service string `protobuf:"bytes,1,opt,name=service,proto3" json:"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 `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// 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](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?#scaling_types_and_instance_classes).
	// App Engine Flex does not support instances. For more information, see
	// [App Engine Standard request
	// routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
	// and [App Engine Flex request
	// routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
	Instance string `protobuf:"bytes,3,opt,name=instance,proto3" json:"instance,omitempty"`
	// Output only. The host that the job is sent to.
	//
	// For more information about how App Engine requests are routed, see
	// [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
	//
	// The host is constructed as:
	//
	//   - `host = [application_domain_name]`

	//     `| [service] + '.' + [application_domain_name]`

	//     `| [version] + '.' + [application_domain_name]`

	//     `| [version_dot_service]+ '.' + [application_domain_name]`

	//     `| [instance] + '.' + [application_domain_name]`

	//     `| [instance_dot_service] + '.' + [application_domain_name]`

	//     `| [instance_dot_version] + '.' + [application_domain_name]`

	//     `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
	//
	//   - `application_domain_name` = The domain name of the app, for
	//     example 

App Engine Routing.

For more information about services, versions, and instances see An Overview of App Engine, Microservices Architecture on Google App Engine, App Engine Standard request routing, and App Engine Flex request routing.

func (*AppEngineRouting) Descriptor

func (*AppEngineRouting) Descriptor() ([]byte, []int)

Deprecated: Use AppEngineRouting.ProtoReflect.Descriptor instead.

func (*AppEngineRouting) GetHost

func (x *AppEngineRouting) GetHost() string

func (*AppEngineRouting) GetInstance

func (x *AppEngineRouting) GetInstance() string

func (*AppEngineRouting) GetService

func (x *AppEngineRouting) GetService() string

func (*AppEngineRouting) GetVersion

func (x *AppEngineRouting) GetVersion() string

func (*AppEngineRouting) ProtoMessage

func (*AppEngineRouting) ProtoMessage()

func (*AppEngineRouting) ProtoReflect

func (x *AppEngineRouting) ProtoReflect() protoreflect.Message

func (*AppEngineRouting) Reset

func (x *AppEngineRouting) Reset()

func (*AppEngineRouting) String

func (x *AppEngineRouting) String() string

CloudSchedulerClient

type CloudSchedulerClient interface {
	// Lists jobs.
	ListJobs(ctx context.Context, in *ListJobsRequest, opts ...grpc.CallOption) (*ListJobsResponse, error)
	// Gets a job.
	GetJob(ctx context.Context, in *GetJobRequest, opts ...grpc.CallOption) (*Job, error)
	// Creates a job.
	CreateJob(ctx context.Context, in *CreateJobRequest, opts ...grpc.CallOption) (*Job, error)
	// Updates a job.
	//
	// If successful, the updated [Job][google.cloud.scheduler.v1beta1.Job] is
	// returned. If the job does not exist, `NOT_FOUND` is returned.
	//
	// If UpdateJob does not successfully return, it is possible for the
	// job to be in an
	// [Job.State.UPDATE_FAILED][google.cloud.scheduler.v1beta1.Job.State.UPDATE_FAILED]
	// state. A job in this state may not be executed. If this happens, retry the
	// UpdateJob request until a successful response is received.
	UpdateJob(ctx context.Context, in *UpdateJobRequest, opts ...grpc.CallOption) (*Job, error)
	// Deletes a job.
	DeleteJob(ctx context.Context, in *DeleteJobRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Pauses a job.
	//
	// If a job is paused then the system will stop executing the job
	// until it is re-enabled via
	// [ResumeJob][google.cloud.scheduler.v1beta1.CloudScheduler.ResumeJob]. The
	// state of the job is stored in
	// [state][google.cloud.scheduler.v1beta1.Job.state]; if paused it will be set
	// to [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED]. A
	// job must be in
	// [Job.State.ENABLED][google.cloud.scheduler.v1beta1.Job.State.ENABLED] to be
	// paused.
	PauseJob(ctx context.Context, in *PauseJobRequest, opts ...grpc.CallOption) (*Job, error)
	// Resume a job.
	//
	// This method reenables a job after it has been
	// [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED]. The
	// state of a job is stored in
	// [Job.state][google.cloud.scheduler.v1beta1.Job.state]; after calling this
	// method it will be set to
	// [Job.State.ENABLED][google.cloud.scheduler.v1beta1.Job.State.ENABLED]. A
	// job must be in
	// [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED] to be
	// resumed.
	ResumeJob(ctx context.Context, in *ResumeJobRequest, opts ...grpc.CallOption) (*Job, error)
	// Forces a job to run now.
	//
	// When this method is called, Cloud Scheduler will dispatch the job, even
	// if the job is already running.
	RunJob(ctx context.Context, in *RunJobRequest, opts ...grpc.CallOption) (*Job, error)
}

CloudSchedulerClient is the client API for CloudScheduler service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewCloudSchedulerClient

func NewCloudSchedulerClient(cc grpc.ClientConnInterface) CloudSchedulerClient

CloudSchedulerServer

type CloudSchedulerServer interface {
	// Lists jobs.
	ListJobs(context.Context, *ListJobsRequest) (*ListJobsResponse, error)
	// Gets a job.
	GetJob(context.Context, *GetJobRequest) (*Job, error)
	// Creates a job.
	CreateJob(context.Context, *CreateJobRequest) (*Job, error)
	// Updates a job.
	//
	// If successful, the updated [Job][google.cloud.scheduler.v1beta1.Job] is
	// returned. If the job does not exist, `NOT_FOUND` is returned.
	//
	// If UpdateJob does not successfully return, it is possible for the
	// job to be in an
	// [Job.State.UPDATE_FAILED][google.cloud.scheduler.v1beta1.Job.State.UPDATE_FAILED]
	// state. A job in this state may not be executed. If this happens, retry the
	// UpdateJob request until a successful response is received.
	UpdateJob(context.Context, *UpdateJobRequest) (*Job, error)
	// Deletes a job.
	DeleteJob(context.Context, *DeleteJobRequest) (*emptypb.Empty, error)
	// Pauses a job.
	//
	// If a job is paused then the system will stop executing the job
	// until it is re-enabled via
	// [ResumeJob][google.cloud.scheduler.v1beta1.CloudScheduler.ResumeJob]. The
	// state of the job is stored in
	// [state][google.cloud.scheduler.v1beta1.Job.state]; if paused it will be set
	// to [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED]. A
	// job must be in
	// [Job.State.ENABLED][google.cloud.scheduler.v1beta1.Job.State.ENABLED] to be
	// paused.
	PauseJob(context.Context, *PauseJobRequest) (*Job, error)
	// Resume a job.
	//
	// This method reenables a job after it has been
	// [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED]. The
	// state of a job is stored in
	// [Job.state][google.cloud.scheduler.v1beta1.Job.state]; after calling this
	// method it will be set to
	// [Job.State.ENABLED][google.cloud.scheduler.v1beta1.Job.State.ENABLED]. A
	// job must be in
	// [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED] to be
	// resumed.
	ResumeJob(context.Context, *ResumeJobRequest) (*Job, error)
	// Forces a job to run now.
	//
	// When this method is called, Cloud Scheduler will dispatch the job, even
	// if the job is already running.
	RunJob(context.Context, *RunJobRequest) (*Job, error)
}

CloudSchedulerServer is the server API for CloudScheduler service.

CreateJobRequest

type CreateJobRequest struct {

	// Required. The location name. For example:
	// `projects/PROJECT_ID/locations/LOCATION_ID`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The job to add. The user can optionally specify a name for the
	// job in [name][google.cloud.scheduler.v1beta1.Job.name].
	// [name][google.cloud.scheduler.v1beta1.Job.name] cannot be the same as an
	// existing job. If a name is not specified then the system will
	// generate a random unique name that will be returned
	// ([name][google.cloud.scheduler.v1beta1.Job.name]) in the response.
	Job *Job `protobuf:"bytes,2,opt,name=job,proto3" json:"job,omitempty"`
	// contains filtered or unexported fields
}

Request message for [CreateJob][google.cloud.scheduler.v1beta1.CloudScheduler.CreateJob].

func (*CreateJobRequest) Descriptor

func (*CreateJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateJobRequest.ProtoReflect.Descriptor instead.

func (*CreateJobRequest) GetJob

func (x *CreateJobRequest) GetJob() *Job

func (*CreateJobRequest) GetParent

func (x *CreateJobRequest) GetParent() string

func (*CreateJobRequest) ProtoMessage

func (*CreateJobRequest) ProtoMessage()

func (*CreateJobRequest) ProtoReflect

func (x *CreateJobRequest) ProtoReflect() protoreflect.Message

func (*CreateJobRequest) Reset

func (x *CreateJobRequest) Reset()

func (*CreateJobRequest) String

func (x *CreateJobRequest) String() string

DeleteJobRequest

type DeleteJobRequest struct {

	// Required. The job name. For example:
	// `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// This field is used to manage the legacy App Engine Cron jobs using the
	// Cloud Scheduler API. If the field is set to true, the job in the __cron
	// queue with the corresponding name will be deleted instead.
	LegacyAppEngineCron bool `protobuf:"varint,2,opt,name=legacy_app_engine_cron,json=legacyAppEngineCron,proto3" json:"legacy_app_engine_cron,omitempty"`
	// contains filtered or unexported fields
}

Request message for deleting a job using [DeleteJob][google.cloud.scheduler.v1beta1.CloudScheduler.DeleteJob].

func (*DeleteJobRequest) Descriptor

func (*DeleteJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteJobRequest.ProtoReflect.Descriptor instead.

func (*DeleteJobRequest) GetLegacyAppEngineCron

func (x *DeleteJobRequest) GetLegacyAppEngineCron() bool

func (*DeleteJobRequest) GetName

func (x *DeleteJobRequest) GetName() string

func (*DeleteJobRequest) ProtoMessage

func (*DeleteJobRequest) ProtoMessage()

func (*DeleteJobRequest) ProtoReflect

func (x *DeleteJobRequest) ProtoReflect() protoreflect.Message

func (*DeleteJobRequest) Reset

func (x *DeleteJobRequest) Reset()

func (*DeleteJobRequest) String

func (x *DeleteJobRequest) String() string

GetJobRequest

type GetJobRequest struct {

	// Required. The job name. For example:
	// `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [GetJob][google.cloud.scheduler.v1beta1.CloudScheduler.GetJob].

func (*GetJobRequest) Descriptor

func (*GetJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetJobRequest.ProtoReflect.Descriptor instead.

func (*GetJobRequest) GetName

func (x *GetJobRequest) GetName() string

func (*GetJobRequest) ProtoMessage

func (*GetJobRequest) ProtoMessage()

func (*GetJobRequest) ProtoReflect

func (x *GetJobRequest) ProtoReflect() protoreflect.Message

func (*GetJobRequest) Reset

func (x *GetJobRequest) Reset()

func (*GetJobRequest) String

func (x *GetJobRequest) String() string

HttpMethod

type HttpMethod int32

The HTTP method used to execute the job.

HttpMethod_HTTP_METHOD_UNSPECIFIED, HttpMethod_POST, HttpMethod_GET, HttpMethod_HEAD, HttpMethod_PUT, HttpMethod_DELETE, HttpMethod_PATCH, HttpMethod_OPTIONS

const (
	// HTTP method unspecified. Defaults to POST.
	HttpMethod_HTTP_METHOD_UNSPECIFIED HttpMethod = 0
	// HTTP POST
	HttpMethod_POST HttpMethod = 1
	// HTTP GET
	HttpMethod_GET HttpMethod = 2
	// HTTP HEAD
	HttpMethod_HEAD HttpMethod = 3
	// HTTP PUT
	HttpMethod_PUT HttpMethod = 4
	// HTTP DELETE
	HttpMethod_DELETE HttpMethod = 5
	// HTTP PATCH
	HttpMethod_PATCH HttpMethod = 6
	// HTTP OPTIONS
	HttpMethod_OPTIONS HttpMethod = 7
)

func (HttpMethod) Descriptor

func (HttpMethod) Descriptor() protoreflect.EnumDescriptor

func (HttpMethod) Enum

func (x HttpMethod) Enum() *HttpMethod

func (HttpMethod) EnumDescriptor

func (HttpMethod) EnumDescriptor() ([]byte, []int)

Deprecated: Use HttpMethod.Descriptor instead.

func (HttpMethod) Number

func (x HttpMethod) Number() protoreflect.EnumNumber

func (HttpMethod) String

func (x HttpMethod) String() string

func (HttpMethod) Type

func (HttpMethod) Type() protoreflect.EnumType

HttpTarget

type HttpTarget struct {
	Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`

	HttpMethod HttpMethod "" /* 139 byte string literal not displayed */

	Headers map[string]string "" /* 155 byte string literal not displayed */

	Body []byte `protobuf:"bytes,4,opt,name=body,proto3" json:"body,omitempty"`

	AuthorizationHeader isHttpTarget_AuthorizationHeader `protobuf_oneof:"authorization_header"`

}

Http target. The job will be pushed to the job handler by means of an HTTP request via an [http_method][google.cloud.scheduler.v1beta1.HttpTarget.http_method] such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered.

func (*HttpTarget) Descriptor

func (*HttpTarget) Descriptor() ([]byte, []int)

Deprecated: Use HttpTarget.ProtoReflect.Descriptor instead.

func (*HttpTarget) GetAuthorizationHeader

func (m *HttpTarget) GetAuthorizationHeader() isHttpTarget_AuthorizationHeader

func (*HttpTarget) GetBody

func (x *HttpTarget) GetBody() []byte

func (*HttpTarget) GetHeaders

func (x *HttpTarget) GetHeaders() map[string]string

func (*HttpTarget) GetHttpMethod

func (x *HttpTarget) GetHttpMethod() HttpMethod

func (*HttpTarget) GetOauthToken

func (x *HttpTarget) GetOauthToken() *OAuthToken

func (*HttpTarget) GetOidcToken

func (x *HttpTarget) GetOidcToken() *OidcToken

func (*HttpTarget) GetUri

func (x *HttpTarget) GetUri() string

func (*HttpTarget) ProtoMessage

func (*HttpTarget) ProtoMessage()

func (*HttpTarget) ProtoReflect

func (x *HttpTarget) ProtoReflect() protoreflect.Message

func (*HttpTarget) Reset

func (x *HttpTarget) Reset()

func (*HttpTarget) String

func (x *HttpTarget) String() string

HttpTarget_OauthToken

type HttpTarget_OauthToken struct {
	// If specified, an
	// [OAuth token](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.
	OauthToken *OAuthToken `protobuf:"bytes,5,opt,name=oauth_token,json=oauthToken,proto3,oneof"`
}

HttpTarget_OidcToken

type HttpTarget_OidcToken struct {
	// If specified, an
	// [OIDC](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.
	OidcToken *OidcToken `protobuf:"bytes,6,opt,name=oidc_token,json=oidcToken,proto3,oneof"`
}

Job

type Job struct {

	// Optionally caller-specified in
	// [CreateJob][google.cloud.scheduler.v1beta1.CloudScheduler.CreateJob], after
	// which it becomes output only.
	//
	// The job name. For example:
	// `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
	//
	//   - `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
	//     hyphens (-), colons (:), or periods (.).
	//     For more information, see
	//     [Identifying
	//     projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
	//   - `LOCATION_ID` is the canonical ID for the job's location.
	//     The list of available locations can be obtained by calling
	//     [ListLocations][google.cloud.location.Locations.ListLocations].
	//     For more information, see https://cloud.google.com/about/locations/.
	//   - `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
	//     hyphens (-), or underscores (_). The maximum length is 500 characters.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optionally caller-specified in
	// [CreateJob][google.cloud.scheduler.v1beta1.CloudScheduler.CreateJob] or
	// [UpdateJob][google.cloud.scheduler.v1beta1.CloudScheduler.UpdateJob].
	//
	// A human-readable description for the job. This string must not contain
	// more than 500 characters.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// Required.
	//
	// Delivery settings containing destination and parameters.
	//
	// Types that are assignable to Target:
	//
	//	*Job_PubsubTarget
	//	*Job_AppEngineHttpTarget
	//	*Job_HttpTarget
	Target isJob_Target `protobuf_oneof:"target"`
	// Required, except when used with
	// [UpdateJob][google.cloud.scheduler.v1beta1.CloudScheduler.UpdateJob].
	//
	// Describes the schedule on which the job will be executed.
	//
	// The schedule can be either of the following types:
	//
	// * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview)
	// * English-like
	// [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)
	//
	// As a general rule, execution `n + 1` of a job will not begin
	// until execution `n` has finished. Cloud Scheduler will never
	// allow two simultaneously outstanding executions. For example,
	// this implies that if the `n+1`th execution is scheduled to run at
	// 16:00 but the `n`th execution takes until 16:15, the `n+1`th
	// execution will not start until `16:15`.
	// A scheduled start time will be delayed if the previous
	// execution has not ended when its scheduled time occurs.
	//
	// If [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count] >
	// 0 and a job attempt fails, the job will be tried a total of
	// [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count]
	// times, with exponential backoff, until the next scheduled start
	// time.
	Schedule string `protobuf:"bytes,20,opt,name=schedule,proto3" json:"schedule,omitempty"`
	// Specifies the time zone to be used in interpreting
	// [schedule][google.cloud.scheduler.v1beta1.Job.schedule]. The value of this
	// field must be a time zone name from the [tz
	// database](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).
	TimeZone string `protobuf:"bytes,21,opt,name=time_zone,json=timeZone,proto3" json:"time_zone,omitempty"`
	// Output only. The creation time of the job.
	UserUpdateTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=user_update_time,json=userUpdateTime,proto3" json:"user_update_time,omitempty"`
	// Output only. State of the job.
	State Job_State `protobuf:"varint,10,opt,name=state,proto3,enum=google.cloud.scheduler.v1beta1.Job_State" json:"state,omitempty"`
	// Output only. The response from the target for the last attempted execution.
	Status *status.Status `protobuf:"bytes,11,opt,name=status,proto3" json:"status,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 *timestamppb.Timestamp `protobuf:"bytes,17,opt,name=schedule_time,json=scheduleTime,proto3" json:"schedule_time,omitempty"`
	// Output only. The time the last job attempt started.
	LastAttemptTime *timestamppb.Timestamp `protobuf:"bytes,18,opt,name=last_attempt_time,json=lastAttemptTime,proto3" json:"last_attempt_time,omitempty"`
	// Settings that determine the retry behavior.
	RetryConfig *RetryConfig `protobuf:"bytes,19,opt,name=retry_config,json=retryConfig,proto3" json:"retry_config,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][google.cloud.scheduler.v1beta1.RetryConfig].
	//
	// The default and the allowed values depend on the type of target:
	//
	// * For [HTTP targets][google.cloud.scheduler.v1beta1.Job.http_target], the
	// default is 3 minutes. The deadline must be in the interval [15 seconds, 30
	// minutes].
	//
	// * For [App Engine HTTP
	// targets][google.cloud.scheduler.v1beta1.Job.app_engine_http_target], 0
	// indicates that the request has the default deadline. The default deadline
	// depends on the scaling type of the service: 10 minutes for standard apps
	// with automatic scaling, 24 hours for standard apps with manual and basic
	// scaling, and 60 minutes for flex apps. If the request deadline is set, it
	// must be in the interval [15 seconds, 24 hours 15 seconds].
	//
	// * For [Pub/Sub targets][google.cloud.scheduler.v1beta1.Job.pubsub_target],
	// this field is ignored.
	AttemptDeadline *durationpb.Duration `protobuf:"bytes,22,opt,name=attempt_deadline,json=attemptDeadline,proto3" json:"attempt_deadline,omitempty"`
	// Immutable. This field is used to manage the legacy App Engine Cron jobs
	// using the Cloud Scheduler API. If the field is set to true, the job will be
	// considered a legacy job. Note that App Engine Cron jobs have fewer
	// features than Cloud Scheduler jobs, e.g., are only limited to App Engine
	// targets.
	LegacyAppEngineCron bool `protobuf:"varint,23,opt,name=legacy_app_engine_cron,json=legacyAppEngineCron,proto3" json:"legacy_app_engine_cron,omitempty"`
	// contains filtered or unexported fields
}

Configuration for a job. The maximum allowed size for a job is 1MB.

func (*Job) Descriptor

func (*Job) Descriptor() ([]byte, []int)

Deprecated: Use Job.ProtoReflect.Descriptor instead.

func (*Job) GetAppEngineHttpTarget

func (x *Job) GetAppEngineHttpTarget() *AppEngineHttpTarget

func (*Job) GetAttemptDeadline

func (x *Job) GetAttemptDeadline() *durationpb.Duration

func (*Job) GetDescription

func (x *Job) GetDescription() string

func (*Job) GetHttpTarget

func (x *Job) GetHttpTarget() *HttpTarget

func (*Job) GetLastAttemptTime

func (x *Job) GetLastAttemptTime() *timestamppb.Timestamp

func (*Job) GetLegacyAppEngineCron

func (x *Job) GetLegacyAppEngineCron() bool

func (*Job) GetName

func (x *Job) GetName() string

func (*Job) GetPubsubTarget

func (x *Job) GetPubsubTarget() *PubsubTarget

func (*Job) GetRetryConfig

func (x *Job) GetRetryConfig() *RetryConfig

func (*Job) GetSchedule

func (x *Job) GetSchedule() string

func (*Job) GetScheduleTime

func (x *Job) GetScheduleTime() *timestamppb.Timestamp

func (*Job) GetState

func (x *Job) GetState() Job_State

func (*Job) GetStatus

func (x *Job) GetStatus() *status.Status

func (*Job) GetTarget

func (m *Job) GetTarget() isJob_Target

func (*Job) GetTimeZone

func (x *Job) GetTimeZone() string

func (*Job) GetUserUpdateTime

func (x *Job) GetUserUpdateTime() *timestamppb.Timestamp

func (*Job) ProtoMessage

func (*Job) ProtoMessage()

func (*Job) ProtoReflect

func (x *Job) ProtoReflect() protoreflect.Message

func (*Job) Reset

func (x *Job) Reset()

func (*Job) String

func (x *Job) String() string

Job_AppEngineHttpTarget

type Job_AppEngineHttpTarget struct {
	// App Engine HTTP target.
	AppEngineHttpTarget *AppEngineHttpTarget `protobuf:"bytes,5,opt,name=app_engine_http_target,json=appEngineHttpTarget,proto3,oneof"`
}

Job_HttpTarget

type Job_HttpTarget struct {
	// HTTP target.
	HttpTarget *HttpTarget `protobuf:"bytes,6,opt,name=http_target,json=httpTarget,proto3,oneof"`
}

Job_PubsubTarget

type Job_PubsubTarget struct {
	// Pub/Sub target.
	PubsubTarget *PubsubTarget `protobuf:"bytes,4,opt,name=pubsub_target,json=pubsubTarget,proto3,oneof"`
}

Job_State

type Job_State int32

State of the job.

Job_STATE_UNSPECIFIED, Job_ENABLED, Job_PAUSED, Job_DISABLED, Job_UPDATE_FAILED

const (
	// Unspecified state.
	Job_STATE_UNSPECIFIED Job_State = 0
	// The job is executing normally.
	Job_ENABLED Job_State = 1
	// The job is paused by the user. It will not execute. A user can
	// intentionally pause the job using
	// [PauseJobRequest][google.cloud.scheduler.v1beta1.PauseJobRequest].
	Job_PAUSED Job_State = 2
	// The job is disabled by the system due to error. The user
	// cannot directly set a job to be disabled.
	Job_DISABLED Job_State = 3
	// The job state resulting from a failed
	// [CloudScheduler.UpdateJob][google.cloud.scheduler.v1beta1.CloudScheduler.UpdateJob]
	// operation. To recover a job from this state, retry
	// [CloudScheduler.UpdateJob][google.cloud.scheduler.v1beta1.CloudScheduler.UpdateJob]
	// until a successful response is received.
	Job_UPDATE_FAILED Job_State = 4
)

func (Job_State) Descriptor

func (Job_State) Descriptor() protoreflect.EnumDescriptor

func (Job_State) Enum

func (x Job_State) Enum() *Job_State

func (Job_State) EnumDescriptor

func (Job_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Job_State.Descriptor instead.

func (Job_State) Number

func (x Job_State) Number() protoreflect.EnumNumber

func (Job_State) String

func (x Job_State) String() string

func (Job_State) Type

func (Job_State) Type() protoreflect.EnumType

ListJobsRequest

type ListJobsRequest struct {

	// Required. The location name. For example:
	// `projects/PROJECT_ID/locations/LOCATION_ID`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// `filter` can be used to specify a subset of jobs.
	//
	// If `filter` equals `target_config="HttpConfig"`, then the http
	// target jobs are retrieved. If `filter` equals
	// `target_config="PubSubConfig"`, then the Pub/Sub target jobs are
	// retrieved. If `filter` equals `labels.foo=value1
	// labels.foo=value2` then only jobs which are labeled with
	// foo=value1 AND foo=value2 will be returned.
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// Requested page size.
	//
	// The maximum page size is 500. If unspecified, the page size will
	// be the maximum. Fewer jobs than requested might be returned,
	// even if more jobs exist; use next_page_token to determine if more
	// jobs exist.
	PageSize int32 `protobuf:"varint,5,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A token identifying a page of results the server will return. To
	// request the first page results, page_token must be empty. To
	// request the next page of results, page_token must be the value of
	// [next_page_token][google.cloud.scheduler.v1beta1.ListJobsResponse.next_page_token]
	// returned from the previous call to
	// [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs]. It is
	// an error to switch the value of
	// [filter][google.cloud.scheduler.v1beta1.ListJobsRequest.filter] or
	// [order_by][google.cloud.scheduler.v1beta1.ListJobsRequest.order_by] while
	// iterating through pages.
	PageToken string `protobuf:"bytes,6,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// This field is used to manage the legacy App Engine Cron jobs using the
	// Cloud Scheduler API. If the field is set to true, the jobs in the __cron
	// queue will be listed instead.
	LegacyAppEngineCron bool `protobuf:"varint,7,opt,name=legacy_app_engine_cron,json=legacyAppEngineCron,proto3" json:"legacy_app_engine_cron,omitempty"`
	// contains filtered or unexported fields
}

Request message for listing jobs using [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs].

func (*ListJobsRequest) Descriptor

func (*ListJobsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListJobsRequest.ProtoReflect.Descriptor instead.

func (*ListJobsRequest) GetFilter

func (x *ListJobsRequest) GetFilter() string

func (*ListJobsRequest) GetLegacyAppEngineCron

func (x *ListJobsRequest) GetLegacyAppEngineCron() bool

func (*ListJobsRequest) GetPageSize

func (x *ListJobsRequest) GetPageSize() int32

func (*ListJobsRequest) GetPageToken

func (x *ListJobsRequest) GetPageToken() string

func (*ListJobsRequest) GetParent

func (x *ListJobsRequest) GetParent() string

func (*ListJobsRequest) ProtoMessage

func (*ListJobsRequest) ProtoMessage()

func (*ListJobsRequest) ProtoReflect

func (x *ListJobsRequest) ProtoReflect() protoreflect.Message

func (*ListJobsRequest) Reset

func (x *ListJobsRequest) Reset()

func (*ListJobsRequest) String

func (x *ListJobsRequest) String() string

ListJobsResponse

type ListJobsResponse struct {

	// The list of jobs.
	Jobs []*Job `protobuf:"bytes,1,rep,name=jobs,proto3" json:"jobs,omitempty"`
	// A token to retrieve next page of results. Pass this value in the
	// [page_token][google.cloud.scheduler.v1beta1.ListJobsRequest.page_token]
	// field in the subsequent call to
	// [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs] to
	// retrieve the next page of results. If this is empty it indicates that there
	// are no more results through which to paginate.
	//
	// The page token is valid for only 2 hours.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for listing jobs using [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs].

func (*ListJobsResponse) Descriptor

func (*ListJobsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListJobsResponse.ProtoReflect.Descriptor instead.

func (*ListJobsResponse) GetJobs

func (x *ListJobsResponse) GetJobs() []*Job

func (*ListJobsResponse) GetNextPageToken

func (x *ListJobsResponse) GetNextPageToken() string

func (*ListJobsResponse) ProtoMessage

func (*ListJobsResponse) ProtoMessage()

func (*ListJobsResponse) ProtoReflect

func (x *ListJobsResponse) ProtoReflect() protoreflect.Message

func (*ListJobsResponse) Reset

func (x *ListJobsResponse) Reset()

func (*ListJobsResponse) String

func (x *ListJobsResponse) String() string

OAuthToken

type OAuthToken struct {

	// [Service account email](https://cloud.google.com/iam/docs/service-accounts)
	// to be used for generating OAuth token.
	// The service account must be within the same project as the job. The caller
	// must have iam.serviceAccounts.actAs permission for the service account.
	ServiceAccountEmail string `protobuf:"bytes,1,opt,name=service_account_email,json=serviceAccountEmail,proto3" json:"service_account_email,omitempty"`
	// 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 `protobuf:"bytes,2,opt,name=scope,proto3" json:"scope,omitempty"`
	// contains filtered or unexported fields
}

Contains information needed for generating an OAuth token. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.

func (*OAuthToken) Descriptor

func (*OAuthToken) Descriptor() ([]byte, []int)

Deprecated: Use OAuthToken.ProtoReflect.Descriptor instead.

func (*OAuthToken) GetScope

func (x *OAuthToken) GetScope() string

func (*OAuthToken) GetServiceAccountEmail

func (x *OAuthToken) GetServiceAccountEmail() string

func (*OAuthToken) ProtoMessage

func (*OAuthToken) ProtoMessage()

func (*OAuthToken) ProtoReflect

func (x *OAuthToken) ProtoReflect() protoreflect.Message

func (*OAuthToken) Reset

func (x *OAuthToken) Reset()

func (*OAuthToken) String

func (x *OAuthToken) String() string

OidcToken

type OidcToken struct {

	// [Service account email](https://cloud.google.com/iam/docs/service-accounts)
	// to be used for generating OIDC token.
	// The service account must be within the same project as the job. The caller
	// must have iam.serviceAccounts.actAs permission for the service account.
	ServiceAccountEmail string `protobuf:"bytes,1,opt,name=service_account_email,json=serviceAccountEmail,proto3" json:"service_account_email,omitempty"`
	// Audience to be used when generating OIDC token. If not specified, the URI
	// specified in target will be used.
	Audience string `protobuf:"bytes,2,opt,name=audience,proto3" json:"audience,omitempty"`
	// contains filtered or unexported fields
}

Contains information needed for generating an OpenID Connect token. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.

func (*OidcToken) Descriptor

func (*OidcToken) Descriptor() ([]byte, []int)

Deprecated: Use OidcToken.ProtoReflect.Descriptor instead.

func (*OidcToken) GetAudience

func (x *OidcToken) GetAudience() string

func (*OidcToken) GetServiceAccountEmail

func (x *OidcToken) GetServiceAccountEmail() string

func (*OidcToken) ProtoMessage

func (*OidcToken) ProtoMessage()

func (*OidcToken) ProtoReflect

func (x *OidcToken) ProtoReflect() protoreflect.Message

func (*OidcToken) Reset

func (x *OidcToken) Reset()

func (*OidcToken) String

func (x *OidcToken) String() string

PauseJobRequest

type PauseJobRequest struct {

	// Required. The job name. For example:
	// `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PauseJob][google.cloud.scheduler.v1beta1.CloudScheduler.PauseJob].

func (*PauseJobRequest) Descriptor

func (*PauseJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use PauseJobRequest.ProtoReflect.Descriptor instead.

func (*PauseJobRequest) GetName

func (x *PauseJobRequest) GetName() string

func (*PauseJobRequest) ProtoMessage

func (*PauseJobRequest) ProtoMessage()

func (*PauseJobRequest) ProtoReflect

func (x *PauseJobRequest) ProtoReflect() protoreflect.Message

func (*PauseJobRequest) Reset

func (x *PauseJobRequest) Reset()

func (*PauseJobRequest) String

func (x *PauseJobRequest) String() string

PubsubTarget

type PubsubTarget struct {
	TopicName string `protobuf:"bytes,1,opt,name=topic_name,json=topicName,proto3" json:"topic_name,omitempty"`

	Data []byte `protobuf:"bytes,3,opt,name=data,proto3" json:"data,omitempty"`

	Attributes map[string]string "" /* 161 byte string literal not displayed */

}

Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic.

func (*PubsubTarget) Descriptor

func (*PubsubTarget) Descriptor() ([]byte, []int)

Deprecated: Use PubsubTarget.ProtoReflect.Descriptor instead.

func (*PubsubTarget) GetAttributes

func (x *PubsubTarget) GetAttributes() map[string]string

func (*PubsubTarget) GetData

func (x *PubsubTarget) GetData() []byte

func (*PubsubTarget) GetTopicName

func (x *PubsubTarget) GetTopicName() string

func (*PubsubTarget) ProtoMessage

func (*PubsubTarget) ProtoMessage()

func (*PubsubTarget) ProtoReflect

func (x *PubsubTarget) ProtoReflect() protoreflect.Message

func (*PubsubTarget) Reset

func (x *PubsubTarget) Reset()

func (*PubsubTarget) String

func (x *PubsubTarget) String() string

ResumeJobRequest

type ResumeJobRequest struct {

	// Required. The job name. For example:
	// `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ResumeJob][google.cloud.scheduler.v1beta1.CloudScheduler.ResumeJob].

func (*ResumeJobRequest) Descriptor

func (*ResumeJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use ResumeJobRequest.ProtoReflect.Descriptor instead.

func (*ResumeJobRequest) GetName

func (x *ResumeJobRequest) GetName() string

func (*ResumeJobRequest) ProtoMessage

func (*ResumeJobRequest) ProtoMessage()

func (*ResumeJobRequest) ProtoReflect

func (x *ResumeJobRequest) ProtoReflect() protoreflect.Message

func (*ResumeJobRequest) Reset

func (x *ResumeJobRequest) Reset()

func (*ResumeJobRequest) String

func (x *ResumeJobRequest) String() string

RetryConfig

type RetryConfig struct {

	// The number of attempts that the system will make to run a job using the
	// exponential backoff procedure described by
	// [max_doublings][google.cloud.scheduler.v1beta1.RetryConfig.max_doublings].
	//
	// 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.
	RetryCount int32 `protobuf:"varint,1,opt,name=retry_count,json=retryCount,proto3" json:"retry_count,omitempty"`
	// The time limit for retrying a failed job, measured from time when an
	// execution was first attempted. If specified with
	// [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count], 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.
	MaxRetryDuration *durationpb.Duration `protobuf:"bytes,2,opt,name=max_retry_duration,json=maxRetryDuration,proto3" json:"max_retry_duration,omitempty"`
	// The minimum amount of time to wait before retrying a job after
	// it fails.
	//
	// The default value of this field is 5 seconds.
	MinBackoffDuration *durationpb.Duration `protobuf:"bytes,3,opt,name=min_backoff_duration,json=minBackoffDuration,proto3" json:"min_backoff_duration,omitempty"`
	// The maximum amount of time to wait before retrying a job after
	// it fails.
	//
	// The default value of this field is 1 hour.
	MaxBackoffDuration *durationpb.Duration `protobuf:"bytes,4,opt,name=max_backoff_duration,json=maxBackoffDuration,proto3" json:"max_backoff_duration,omitempty"`
	// The time between retries will double `max_doublings` times.
	//
	// A job's retry interval starts at
	// [min_backoff_duration][google.cloud.scheduler.v1beta1.RetryConfig.min_backoff_duration],
	// then doubles `max_doublings` times, then increases linearly, and finally
	// retries at intervals of
	// [max_backoff_duration][google.cloud.scheduler.v1beta1.RetryConfig.max_backoff_duration]
	// up to [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count]
	// times.
	//
	// For example, if
	// [min_backoff_duration][google.cloud.scheduler.v1beta1.RetryConfig.min_backoff_duration]
	// is 10s,
	// [max_backoff_duration][google.cloud.scheduler.v1beta1.RetryConfig.max_backoff_duration]
	// is 300s, and `max_doublings` is 3, then the a job will first be retried in
	// 10s. The retry interval will double three times, and then increase linearly
	// by 2^3 * 10s.  Finally, the job will retry at intervals of
	// [max_backoff_duration][google.cloud.scheduler.v1beta1.RetryConfig.max_backoff_duration]
	// until the job has been attempted
	// [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count]
	// times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s,
	// 300s, 300s, ....
	//
	// The default value of this field is 5.
	MaxDoublings int32 `protobuf:"varint,5,opt,name=max_doublings,json=maxDoublings,proto3" json:"max_doublings,omitempty"`
	// contains filtered or unexported fields
}

Settings that determine the retry behavior.

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 in [RetryConfig][google.cloud.scheduler.v1beta1.RetryConfig].

func (*RetryConfig) Descriptor

func (*RetryConfig) Descriptor() ([]byte, []int)

Deprecated: Use RetryConfig.ProtoReflect.Descriptor instead.

func (*RetryConfig) GetMaxBackoffDuration

func (x *RetryConfig) GetMaxBackoffDuration() *durationpb.Duration

func (*RetryConfig) GetMaxDoublings

func (x *RetryConfig) GetMaxDoublings() int32

func (*RetryConfig) GetMaxRetryDuration

func (x *RetryConfig) GetMaxRetryDuration() *durationpb.Duration

func (*RetryConfig) GetMinBackoffDuration

func (x *RetryConfig) GetMinBackoffDuration() *durationpb.Duration

func (*RetryConfig) GetRetryCount

func (x *RetryConfig) GetRetryCount() int32

func (*RetryConfig) ProtoMessage

func (*RetryConfig) ProtoMessage()

func (*RetryConfig) ProtoReflect

func (x *RetryConfig) ProtoReflect() protoreflect.Message

func (*RetryConfig) Reset

func (x *RetryConfig) Reset()

func (*RetryConfig) String

func (x *RetryConfig) String() string

RunJobRequest

type RunJobRequest struct {

	// Required. The job name. For example:
	// `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// This field is used to manage the legacy App Engine Cron jobs using the
	// Cloud Scheduler API. If the field is set to true, the job in the __cron
	// queue with the corresponding name will be forced to run instead.
	LegacyAppEngineCron bool `protobuf:"varint,2,opt,name=legacy_app_engine_cron,json=legacyAppEngineCron,proto3" json:"legacy_app_engine_cron,omitempty"`
	// contains filtered or unexported fields
}

Request message for forcing a job to run now using [RunJob][google.cloud.scheduler.v1beta1.CloudScheduler.RunJob].

func (*RunJobRequest) Descriptor

func (*RunJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use RunJobRequest.ProtoReflect.Descriptor instead.

func (*RunJobRequest) GetLegacyAppEngineCron

func (x *RunJobRequest) GetLegacyAppEngineCron() bool

func (*RunJobRequest) GetName

func (x *RunJobRequest) GetName() string

func (*RunJobRequest) ProtoMessage

func (*RunJobRequest) ProtoMessage()

func (*RunJobRequest) ProtoReflect

func (x *RunJobRequest) ProtoReflect() protoreflect.Message

func (*RunJobRequest) Reset

func (x *RunJobRequest) Reset()

func (*RunJobRequest) String

func (x *RunJobRequest) String() string

UnimplementedCloudSchedulerServer

type UnimplementedCloudSchedulerServer struct {
}

UnimplementedCloudSchedulerServer can be embedded to have forward compatible implementations.

func (*UnimplementedCloudSchedulerServer) CreateJob

func (*UnimplementedCloudSchedulerServer) CreateJob(context.Context, *CreateJobRequest) (*Job, error)

func (*UnimplementedCloudSchedulerServer) DeleteJob

func (*UnimplementedCloudSchedulerServer) DeleteJob(context.Context, *DeleteJobRequest) (*emptypb.Empty, error)

func (*UnimplementedCloudSchedulerServer) GetJob

func (*UnimplementedCloudSchedulerServer) GetJob(context.Context, *GetJobRequest) (*Job, error)

func (*UnimplementedCloudSchedulerServer) ListJobs

func (*UnimplementedCloudSchedulerServer) ListJobs(context.Context, *ListJobsRequest) (*ListJobsResponse, error)

func (*UnimplementedCloudSchedulerServer) PauseJob

func (*UnimplementedCloudSchedulerServer) PauseJob(context.Context, *PauseJobRequest) (*Job, error)

func (*UnimplementedCloudSchedulerServer) ResumeJob

func (*UnimplementedCloudSchedulerServer) ResumeJob(context.Context, *ResumeJobRequest) (*Job, error)

func (*UnimplementedCloudSchedulerServer) RunJob

func (*UnimplementedCloudSchedulerServer) RunJob(context.Context, *RunJobRequest) (*Job, error)

func (*UnimplementedCloudSchedulerServer) UpdateJob

func (*UnimplementedCloudSchedulerServer) UpdateJob(context.Context, *UpdateJobRequest) (*Job, error)

UpdateJobRequest

type UpdateJobRequest struct {

	// Required. The new job properties.
	// [name][google.cloud.scheduler.v1beta1.Job.name] must be specified.
	//
	// Output only fields cannot be modified using UpdateJob.
	// Any value specified for an output only field will be ignored.
	Job *Job `protobuf:"bytes,1,opt,name=job,proto3" json:"job,omitempty"`
	// A  mask used to specify which fields of the job are being updated.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [UpdateJob][google.cloud.scheduler.v1beta1.CloudScheduler.UpdateJob].

func (*UpdateJobRequest) Descriptor

func (*UpdateJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateJobRequest.ProtoReflect.Descriptor instead.

func (*UpdateJobRequest) GetJob

func (x *UpdateJobRequest) GetJob() *Job

func (*UpdateJobRequest) GetUpdateMask

func (x *UpdateJobRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateJobRequest) ProtoMessage

func (*UpdateJobRequest) ProtoMessage()

func (*UpdateJobRequest) ProtoReflect

func (x *UpdateJobRequest) ProtoReflect() protoreflect.Message

func (*UpdateJobRequest) Reset

func (x *UpdateJobRequest) Reset()

func (*UpdateJobRequest) String

func (x *UpdateJobRequest) String() string