cloudscheduler

package
v0.214.0 Latest Latest
Warning

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

 Go to latest Published: Dec 19, 2024 License: BSD-3-Clause Imports: 18 Imported by: 5

Documentation

Overview

Package cloudscheduler provides access to the Cloud Scheduler API.

For product documentation, see: https://cloud.google.com/scheduler/

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example: 

import "google.golang.org/api/cloudscheduler/v1beta1"
...
ctx := context.Background()
cloudschedulerService, err := cloudscheduler.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey: 

cloudschedulerService, err := cloudscheduler.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource: 

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
cloudschedulerService, err := cloudscheduler.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source 
const (
	// See, edit, configure, and delete your Google Cloud data and see the email
	// address for your Google Account.
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type AppEngineHttpTarget 

type AppEngineHttpTarget struct {
	// AppEngineRouting: App Engine Routing setting for the job.
	AppEngineRouting *AppEngineRouting `json:"appEngineRouting,omitempty"`
	// Body: 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.
	Body string `json:"body,omitempty"`
	// Headers: 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. *
	// `X-CloudScheduler-JobName`: This header will contain the job name. *
	// `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the
	// unix-cron format, this header will contain the job schedule as an offset of
	// UTC parsed according to RFC3339. If the job has a body and the following
	// headers are not set by the user, Cloud Scheduler sets default values: *
	// `Content-Type`: This will be set to "application/octet-stream". You can
	// override this default by explicitly setting `Content-Type` to a particular
	// media type when creating the job. For example, you can set `Content-Type` to
	// "application/json". The headers below are output only. They cannot be set
	// or overridden: * `Content-Length`: This is computed by Cloud Scheduler. *
	// `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google
	// internal use only. In addition, some App Engine headers, which contain
	// job-specific information, are also be sent to the job handler.
	Headers map[string]string `json:"headers,omitempty"`
	// HttpMethod: The HTTP method to use for the request. PATCH and OPTIONS are
	// not permitted.
	//
	// Possible values:
	//   "HTTP_METHOD_UNSPECIFIED" - HTTP method unspecified. Defaults to POST.
	//   "POST" - HTTP POST
	//   "GET" - HTTP GET
	//   "HEAD" - HTTP HEAD
	//   "PUT" - HTTP PUT
	//   "DELETE" - HTTP DELETE
	//   "PATCH" - HTTP PATCH
	//   "OPTIONS" - HTTP OPTIONS
	HttpMethod string `json:"httpMethod,omitempty"`
	// RelativeUri: The relative URI. The relative URL must begin with "/" and must
	// be a valid HTTP relative URL. It can contain a path, query string arguments,
	// and `#` fragments. If the relative URL is empty, then the root path "/" will
	// be used. No spaces are allowed, and the maximum length allowed is 2083
	// characters.
	RelativeUri string `json:"relativeUri,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AppEngineRouting") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AppEngineRouting") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AppEngineHttpTarget: App Engine target. The job will be pushed to a job handler by means of an HTTP request via an 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) MarshalJSON 

func (s AppEngineHttpTarget) MarshalJSON() ([]byte, error)

type AppEngineRouting 

type AppEngineRouting struct {
	// Host: 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
	// .appspot.com, which is associated with the job's project ID. * `service =`
	// service * `version =` version * `version_dot_service =` version `+ '.' +`
	// service * `instance =` instance * `instance_dot_service =` instance `+ '.'
	// +` service * `instance_dot_version =` instance `+ '.' +` version *
	// `instance_dot_version_dot_service =` instance `+ '.' +` version `+ '.' +`
	// service If service is empty, then the job will be sent to the service which
	// is the default service when the job is attempted. If version is empty, then
	// the job will be sent to the version which is the default version when the
	// job is attempted. If instance is empty, then the job will be sent to an
	// instance which is available when the job is attempted. If service, version,
	// or instance 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"`
	// Instance: 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 `json:"instance,omitempty"`
	// Service: 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"`
	// Version: 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"`
	// ForceSendFields is a list of field names (e.g. "Host") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Host") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AppEngineRouting: App Engine Routing. For more information about services, versions, and instances see An Overview of App Engine (https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), Microservices Architecture on Google App Engine (https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), 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).

func (AppEngineRouting) MarshalJSON 

func (s AppEngineRouting) MarshalJSON() ([]byte, error)

type Empty 

type Empty struct {
	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
}

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

type HttpTarget 

type HttpTarget struct {
	// Body: HTTP request body. A request body is allowed only if the HTTP method
	// is POST, PUT, or PATCH. It is an error to set body on a job with an
	// incompatible HttpMethod.
	Body string `json:"body,omitempty"`
	// Headers: HTTP request headers. This map contains the header field names and
	// values. The user can specify HTTP request headers to send with the job's
	// HTTP request. Repeated headers are not supported, but a header value can
	// contain commas. The following headers represent a subset of the headers that
	// accompany the job's HTTP request. Some HTTP request headers are ignored or
	// replaced. A partial list of headers that are 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. *
	// `X-CloudScheduler`: This header will be set to true. *
	// `X-CloudScheduler-JobName`: This header will contain the job name. *
	// `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the
	// unix-cron format, this header will contain the job schedule as an offset of
	// UTC parsed according to RFC3339. If the job has a body and the following
	// headers are not set by the user, Cloud Scheduler sets default values: *
	// `Content-Type`: This will be set to "application/octet-stream". You can
	// override this default by explicitly setting `Content-Type` to a particular
	// media type when creating the job. For example, you can set `Content-Type` to
	// "application/json". The total size of headers must be less than 80KB.
	Headers map[string]string `json:"headers,omitempty"`
	// HttpMethod: Which HTTP method to use for the request.
	//
	// Possible values:
	//   "HTTP_METHOD_UNSPECIFIED" - HTTP method unspecified. Defaults to POST.
	//   "POST" - HTTP POST
	//   "GET" - HTTP GET
	//   "HEAD" - HTTP HEAD
	//   "PUT" - HTTP PUT
	//   "DELETE" - HTTP DELETE
	//   "PATCH" - HTTP PATCH
	//   "OPTIONS" - HTTP OPTIONS
	HttpMethod string `json:"httpMethod,omitempty"`
	// OauthToken: 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 `json:"oauthToken,omitempty"`
	// OidcToken: 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 `json:"oidcToken,omitempty"`
	// Uri: 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 uri 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,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Body") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Body") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

HttpTarget: Http target. The job will be pushed to the job handler by means of an HTTP request via an 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) MarshalJSON 

func (s HttpTarget) MarshalJSON() ([]byte, error)

type Job 

type Job struct {
	// AppEngineHttpTarget: App Engine HTTP target.
	AppEngineHttpTarget *AppEngineHttpTarget `json:"appEngineHttpTarget,omitempty"`
	// AttemptDeadline: The deadline for job attempts. If the request handler does
	// not respond by this deadline then the request is cancelled and the attempt
	// is marked as a `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed
	// in execution logs. Cloud Scheduler will retry the job according to the
	// RetryConfig. The default and the allowed values depend on the type of
	// target: * For HTTP targets, the default is 3 minutes. The deadline must be
	// in the interval [15 seconds, 30 minutes]. * For App Engine HTTP targets, 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, this field is ignored.
	AttemptDeadline string `json:"attemptDeadline,omitempty"`
	// Description: Optionally caller-specified in CreateJob or UpdateJob. A
	// human-readable description for the job. This string must not contain more
	// than 500 characters.
	Description string `json:"description,omitempty"`
	// HttpTarget: HTTP target.
	HttpTarget *HttpTarget `json:"httpTarget,omitempty"`
	// LastAttemptTime: Output only. The time the last job attempt started.
	LastAttemptTime string `json:"lastAttemptTime,omitempty"`
	// LegacyAppEngineCron: 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 `json:"legacyAppEngineCron,omitempty"`
	// Name: Optionally caller-specified in 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. 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 `json:"name,omitempty"`
	// PubsubTarget: Pub/Sub target.
	PubsubTarget *PubsubTarget `json:"pubsubTarget,omitempty"`
	// RetryConfig: Settings that determine the retry behavior.
	RetryConfig *RetryConfig `json:"retryConfig,omitempty"`
	// Schedule: Required, except when used with 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 > 0 and a job attempt fails, the job
	// will be tried a total of retry_count times, with exponential backoff, until
	// the next scheduled start time. If retry_count is 0, a job attempt will not
	// be retried if it fails. Instead the Cloud Scheduler system will wait for the
	// next scheduled execution time. Setting retry_count to 0 does not prevent
	// failed jobs from running according to schedule after the failure.
	Schedule string `json:"schedule,omitempty"`
	// ScheduleTime: 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"`
	// State: Output only. State of the job.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - Unspecified state.
	//   "ENABLED" - The job is executing normally.
	//   "PAUSED" - The job is paused by the user. It will not execute. A user can
	// intentionally pause the job using PauseJobRequest.
	//   "DISABLED" - The job is disabled by the system due to error. The user
	// cannot directly set a job to be disabled.
	//   "UPDATE_FAILED" - The job state resulting from a failed
	// CloudScheduler.UpdateJob operation. To recover a job from this state, retry
	// CloudScheduler.UpdateJob until a successful response is received.
	State string `json:"state,omitempty"`
	// Status: Output only. The response from the target for the last attempted
	// execution.
	Status *Status `json:"status,omitempty"`
	// TimeZone: Specifies the time zone to be used in interpreting schedule. The
	// value of this field must be a time zone name from the tz database
	// (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 `json:"timeZone,omitempty"`
	// UserUpdateTime: Output only. The creation time of the job.
	UserUpdateTime string `json:"userUpdateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AppEngineHttpTarget") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AppEngineHttpTarget") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (Job) MarshalJSON 

func (s Job) MarshalJSON() ([]byte, error)

type ListJobsResponse 

type ListJobsResponse struct {
	// Jobs: The list of jobs.
	Jobs []*Job `json:"jobs,omitempty"`
	// NextPageToken: A token to retrieve next page of results. Pass this value in
	// the page_token field in the subsequent call to 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 `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Jobs") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Jobs") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListJobsResponse: Response message for listing jobs using ListJobs.

func (ListJobsResponse) MarshalJSON 

func (s ListJobsResponse) MarshalJSON() ([]byte, error)

type ListLocationsResponse 

type ListLocationsResponse struct {
	// Locations: A list of locations that matches the specified filter in the
	// request.
	Locations []*Location `json:"locations,omitempty"`
	// NextPageToken: The standard List next-page token.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Locations") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Locations") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListLocationsResponse: The response message for Locations.ListLocations.

func (ListLocationsResponse) MarshalJSON 

func (s ListLocationsResponse) MarshalJSON() ([]byte, error)

type Location 

type Location struct {
	// DisplayName: The friendly name for this location, typically a nearby city
	// name. For example, "Tokyo".
	DisplayName string `json:"displayName,omitempty"`
	// Labels: Cross-service attributes for the location. For example
	// {"cloud.googleapis.com/region": "us-east1"}
	Labels map[string]string `json:"labels,omitempty"`
	// LocationId: The canonical id for this location. For example: "us-east1".
	LocationId string `json:"locationId,omitempty"`
	// Metadata: Service-specific metadata. For example the available capacity at
	// the given location.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`
	// Name: Resource name for the location, which may vary between
	// implementations. For example:
	// "projects/example-project/locations/us-east1"
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DisplayName") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Location: A resource that represents a Google Cloud location.

func (Location) MarshalJSON 

func (s Location) MarshalJSON() ([]byte, error)

type OAuthToken added in v0.3.1 

type OAuthToken struct {
	// Scope: 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"`
	// ServiceAccountEmail: 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 `json:"serviceAccountEmail,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Scope") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Scope") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OAuthToken: Contains information needed for generating an OAuth token (https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.

func (OAuthToken) MarshalJSON added in v0.3.1 

func (s OAuthToken) MarshalJSON() ([]byte, error)

type OidcToken added in v0.3.1 

type OidcToken struct {
	// Audience: Audience to be used when generating OIDC token. If not specified,
	// the URI specified in target will be used.
	Audience string `json:"audience,omitempty"`
	// ServiceAccountEmail: 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 `json:"serviceAccountEmail,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Audience") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Audience") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OidcToken: Contains information needed for generating an OpenID Connect token (https://developers.google.com/identity/protocols/OpenIDConnect). 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) MarshalJSON added in v0.3.1 

func (s OidcToken) MarshalJSON() ([]byte, error)

type OperationMetadata added in v0.200.0 

type OperationMetadata struct {
	// ApiVersion: Output only. API version used to start the operation.
	ApiVersion string `json:"apiVersion,omitempty"`
	// CancelRequested: Output only. Identifies whether the user has requested
	// cancellation of the operation. Operations that have been cancelled
	// successfully have google.longrunning.Operation.error value with a
	// google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
	CancelRequested bool `json:"cancelRequested,omitempty"`
	// CreateTime: Output only. The time the operation was created.
	CreateTime string `json:"createTime,omitempty"`
	// EndTime: Output only. The time the operation finished running.
	EndTime string `json:"endTime,omitempty"`
	// StatusDetail: Output only. Human-readable status of the operation, if any.
	StatusDetail string `json:"statusDetail,omitempty"`
	// Target: Output only. Server-defined resource path for the target of the
	// operation.
	Target string `json:"target,omitempty"`
	// Verb: Output only. Name of the verb executed by the operation.
	Verb string `json:"verb,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ApiVersion") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ApiVersion") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OperationMetadata: Represents the metadata of the long-running operation.

func (OperationMetadata) MarshalJSON added in v0.200.0 

func (s OperationMetadata) MarshalJSON() ([]byte, error)

type PauseJobRequest 

type PauseJobRequest struct {
}

PauseJobRequest: Request message for PauseJob.

type ProjectsLocationsGetCall 

type ProjectsLocationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsGetCall) Context 

func (c *ProjectsLocationsGetCall) Context(ctx context.Context) *ProjectsLocationsGetCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsGetCall) Do 

func (c *ProjectsLocationsGetCall) Do(opts ...googleapi.CallOption) (*Location, error)

Do executes the "cloudscheduler.projects.locations.get" call. Any non-2xx status code is an error. Response headers are in either *Location.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsGetCall) Fields 

func (c *ProjectsLocationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsGetCall) Header 

func (c *ProjectsLocationsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsGetCall) IfNoneMatch 

func (c *ProjectsLocationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsJobsCreateCall 

type ProjectsLocationsJobsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsJobsCreateCall) Context 

func (c *ProjectsLocationsJobsCreateCall) Context(ctx context.Context) *ProjectsLocationsJobsCreateCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsJobsCreateCall) Do 

func (c *ProjectsLocationsJobsCreateCall) Do(opts ...googleapi.CallOption) (*Job, error)

Do executes the "cloudscheduler.projects.locations.jobs.create" call. Any non-2xx status code is an error. Response headers are in either *Job.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsJobsCreateCall) Fields 

func (c *ProjectsLocationsJobsCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsJobsCreateCall) Header 

func (c *ProjectsLocationsJobsCreateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsJobsDeleteCall 

type ProjectsLocationsJobsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsJobsDeleteCall) Context 

func (c *ProjectsLocationsJobsDeleteCall) Context(ctx context.Context) *ProjectsLocationsJobsDeleteCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsJobsDeleteCall) Do 

func (c *ProjectsLocationsJobsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "cloudscheduler.projects.locations.jobs.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsJobsDeleteCall) Fields 

func (c *ProjectsLocationsJobsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsJobsDeleteCall) Header 

func (c *ProjectsLocationsJobsDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsJobsDeleteCall) LegacyAppEngineCron added in v0.37.0 

func (c *ProjectsLocationsJobsDeleteCall) LegacyAppEngineCron(legacyAppEngineCron bool) *ProjectsLocationsJobsDeleteCall

LegacyAppEngineCron sets the optional parameter "legacyAppEngineCron": 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.

type ProjectsLocationsJobsGetCall 

type ProjectsLocationsJobsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsJobsGetCall) Context 

func (c *ProjectsLocationsJobsGetCall) Context(ctx context.Context) *ProjectsLocationsJobsGetCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsJobsGetCall) Do 

func (c *ProjectsLocationsJobsGetCall) Do(opts ...googleapi.CallOption) (*Job, error)

Do executes the "cloudscheduler.projects.locations.jobs.get" call. Any non-2xx status code is an error. Response headers are in either *Job.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsJobsGetCall) Fields 

func (c *ProjectsLocationsJobsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsJobsGetCall) Header 

func (c *ProjectsLocationsJobsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsJobsGetCall) IfNoneMatch 

func (c *ProjectsLocationsJobsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsJobsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsJobsListCall 

type ProjectsLocationsJobsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsJobsListCall) Context 

func (c *ProjectsLocationsJobsListCall) Context(ctx context.Context) *ProjectsLocationsJobsListCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsJobsListCall) Do 

func (c *ProjectsLocationsJobsListCall) Do(opts ...googleapi.CallOption) (*ListJobsResponse, error)

Do executes the "cloudscheduler.projects.locations.jobs.list" call. Any non-2xx status code is an error. Response headers are in either *ListJobsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsJobsListCall) Fields 

func (c *ProjectsLocationsJobsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsJobsListCall) Filter added in v0.54.0 

func (c *ProjectsLocationsJobsListCall) Filter(filter string) *ProjectsLocationsJobsListCall

Filter sets the optional parameter "filter": `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.

func (*ProjectsLocationsJobsListCall) Header 

func (c *ProjectsLocationsJobsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsJobsListCall) IfNoneMatch 

func (c *ProjectsLocationsJobsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsJobsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsJobsListCall) LegacyAppEngineCron added in v0.37.0 

func (c *ProjectsLocationsJobsListCall) LegacyAppEngineCron(legacyAppEngineCron bool) *ProjectsLocationsJobsListCall

LegacyAppEngineCron sets the optional parameter "legacyAppEngineCron": 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.

func (*ProjectsLocationsJobsListCall) PageSize 

func (c *ProjectsLocationsJobsListCall) PageSize(pageSize int64) *ProjectsLocationsJobsListCall

PageSize sets the optional parameter "pageSize": 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.

func (*ProjectsLocationsJobsListCall) PageToken 

func (c *ProjectsLocationsJobsListCall) PageToken(pageToken string) *ProjectsLocationsJobsListCall

PageToken sets the optional parameter "pageToken": 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 returned from the previous call to ListJobs. It is an error to switch the value of filter or order_by while iterating through pages.

func (*ProjectsLocationsJobsListCall) Pages 

func (c *ProjectsLocationsJobsListCall) Pages(ctx context.Context, f func(*ListJobsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsJobsPatchCall 

type ProjectsLocationsJobsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsJobsPatchCall) Context 

func (c *ProjectsLocationsJobsPatchCall) Context(ctx context.Context) *ProjectsLocationsJobsPatchCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsJobsPatchCall) Do 

func (c *ProjectsLocationsJobsPatchCall) Do(opts ...googleapi.CallOption) (*Job, error)

Do executes the "cloudscheduler.projects.locations.jobs.patch" call. Any non-2xx status code is an error. Response headers are in either *Job.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsJobsPatchCall) Fields 

func (c *ProjectsLocationsJobsPatchCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsJobsPatchCall) Header 

func (c *ProjectsLocationsJobsPatchCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsJobsPatchCall) UpdateMask 

func (c *ProjectsLocationsJobsPatchCall) UpdateMask(updateMask string) *ProjectsLocationsJobsPatchCall

UpdateMask sets the optional parameter "updateMask": A mask used to specify which fields of the job are being updated.

type ProjectsLocationsJobsPauseCall 

type ProjectsLocationsJobsPauseCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsJobsPauseCall) Context 

func (c *ProjectsLocationsJobsPauseCall) Context(ctx context.Context) *ProjectsLocationsJobsPauseCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsJobsPauseCall) Do 

func (c *ProjectsLocationsJobsPauseCall) Do(opts ...googleapi.CallOption) (*Job, error)

Do executes the "cloudscheduler.projects.locations.jobs.pause" call. Any non-2xx status code is an error. Response headers are in either *Job.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsJobsPauseCall) Fields 

func (c *ProjectsLocationsJobsPauseCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsPauseCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsJobsPauseCall) Header 

func (c *ProjectsLocationsJobsPauseCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsJobsResumeCall 

type ProjectsLocationsJobsResumeCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsJobsResumeCall) Context 

func (c *ProjectsLocationsJobsResumeCall) Context(ctx context.Context) *ProjectsLocationsJobsResumeCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsJobsResumeCall) Do 

func (c *ProjectsLocationsJobsResumeCall) Do(opts ...googleapi.CallOption) (*Job, error)

Do executes the "cloudscheduler.projects.locations.jobs.resume" call. Any non-2xx status code is an error. Response headers are in either *Job.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsJobsResumeCall) Fields 

func (c *ProjectsLocationsJobsResumeCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsResumeCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsJobsResumeCall) Header 

func (c *ProjectsLocationsJobsResumeCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsJobsRunCall 

type ProjectsLocationsJobsRunCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsJobsRunCall) Context 

func (c *ProjectsLocationsJobsRunCall) Context(ctx context.Context) *ProjectsLocationsJobsRunCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsJobsRunCall) Do 

func (c *ProjectsLocationsJobsRunCall) Do(opts ...googleapi.CallOption) (*Job, error)

Do executes the "cloudscheduler.projects.locations.jobs.run" call. Any non-2xx status code is an error. Response headers are in either *Job.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsJobsRunCall) Fields 

func (c *ProjectsLocationsJobsRunCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsRunCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsJobsRunCall) Header 

func (c *ProjectsLocationsJobsRunCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsJobsService 

type ProjectsLocationsJobsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsJobsService 

func NewProjectsLocationsJobsService(s *Service) *ProjectsLocationsJobsService

func (*ProjectsLocationsJobsService) Create 

func (r *ProjectsLocationsJobsService) Create(parent string, job *Job) *ProjectsLocationsJobsCreateCall

Create: Creates a job.

  • parent: The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`.

func (*ProjectsLocationsJobsService) Delete 

func (r *ProjectsLocationsJobsService) Delete(name string) *ProjectsLocationsJobsDeleteCall

Delete: Deletes a job.

  • name: The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

func (*ProjectsLocationsJobsService) Get 

func (r *ProjectsLocationsJobsService) Get(name string) *ProjectsLocationsJobsGetCall

Get: Gets a job.

  • name: The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

func (*ProjectsLocationsJobsService) List 

func (r *ProjectsLocationsJobsService) List(parent string) *ProjectsLocationsJobsListCall

List: Lists jobs.

  • parent: The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`.

func (*ProjectsLocationsJobsService) Patch 

func (r *ProjectsLocationsJobsService) Patch(name string, job *Job) *ProjectsLocationsJobsPatchCall

Patch: Updates a job. If successful, the updated 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 state. A job in this state may not be executed. If this happens, retry the UpdateJob request until a successful response is received.

  • name: Optionally caller-specified in 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. 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.

func (*ProjectsLocationsJobsService) Pause 

func (r *ProjectsLocationsJobsService) Pause(name string, pausejobrequest *PauseJobRequest) *ProjectsLocationsJobsPauseCall

Pause: Pauses a job. If a job is paused then the system will stop executing the job until it is re-enabled via ResumeJob. The state of the job is stored in state; if paused it will be set to Job.State.PAUSED. A job must be in Job.State.ENABLED to be paused.

  • name: The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

func (*ProjectsLocationsJobsService) Resume 

func (r *ProjectsLocationsJobsService) Resume(name string, resumejobrequest *ResumeJobRequest) *ProjectsLocationsJobsResumeCall

Resume: Resume a job. This method reenables a job after it has been Job.State.PAUSED. The state of a job is stored in Job.state; after calling this method it will be set to Job.State.ENABLED. A job must be in Job.State.PAUSED to be resumed.

  • name: The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

func (*ProjectsLocationsJobsService) Run 

func (r *ProjectsLocationsJobsService) Run(name string, runjobrequest *RunJobRequest) *ProjectsLocationsJobsRunCall

Run: Forces a job to run now. When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running.

  • name: The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

type ProjectsLocationsListCall 

type ProjectsLocationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsListCall) Context 

func (c *ProjectsLocationsListCall) Context(ctx context.Context) *ProjectsLocationsListCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsListCall) Do 

func (c *ProjectsLocationsListCall) Do(opts ...googleapi.CallOption) (*ListLocationsResponse, error)

Do executes the "cloudscheduler.projects.locations.list" call. Any non-2xx status code is an error. Response headers are in either *ListLocationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsListCall) Fields 

func (c *ProjectsLocationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsListCall) Filter 

func (c *ProjectsLocationsListCall) Filter(filter string) *ProjectsLocationsListCall

Filter sets the optional parameter "filter": A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160).

func (*ProjectsLocationsListCall) Header 

func (c *ProjectsLocationsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsListCall) IfNoneMatch 

func (c *ProjectsLocationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsListCall) PageSize 

func (c *ProjectsLocationsListCall) PageSize(pageSize int64) *ProjectsLocationsListCall

PageSize sets the optional parameter "pageSize": The maximum number of results to return. If not set, the service selects a default.

func (*ProjectsLocationsListCall) PageToken 

func (c *ProjectsLocationsListCall) PageToken(pageToken string) *ProjectsLocationsListCall

PageToken sets the optional parameter "pageToken": A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

func (*ProjectsLocationsListCall) Pages 

func (c *ProjectsLocationsListCall) Pages(ctx context.Context, f func(*ListLocationsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsService 

type ProjectsLocationsService struct {
	Jobs *ProjectsLocationsJobsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsService 

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

func (*ProjectsLocationsService) Get 

func (r *ProjectsLocationsService) Get(name string) *ProjectsLocationsGetCall

Get: Gets information about a location.

- name: Resource name for the location.

func (*ProjectsLocationsService) List 

func (r *ProjectsLocationsService) List(name string) *ProjectsLocationsListCall

List: Lists information about the supported locations for this service.

- name: The resource that owns the locations collection, if applicable.

type ProjectsService 

type ProjectsService struct {
	Locations *ProjectsLocationsService
	// contains filtered or unexported fields
}

func NewProjectsService 

func NewProjectsService(s *Service) *ProjectsService

type PubsubMessage 

type PubsubMessage struct {
	// Attributes: Optional. Attributes for this message. If this field is empty,
	// the message must contain non-empty data. This can be used to filter messages
	// on the subscription.
	Attributes map[string]string `json:"attributes,omitempty"`
	// Data: Optional. The message data field. If this field is empty, the message
	// must contain at least one attribute.
	Data string `json:"data,omitempty"`
	// MessageId: ID of this message, assigned by the server when the message is
	// published. Guaranteed to be unique within the topic. This value may be read
	// by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push
	// delivery. It must not be populated by the publisher in a `Publish` call.
	MessageId string `json:"messageId,omitempty"`
	// OrderingKey: Optional. If non-empty, identifies related messages for which
	// publish order should be respected. If a `Subscription` has
	// `enable_message_ordering` set to `true`, messages published with the same
	// non-empty `ordering_key` value will be delivered to subscribers in the order
	// in which they are received by the Pub/Sub system. All `PubsubMessage`s
	// published in a given `PublishRequest` must specify the same `ordering_key`
	// value. For more information, see ordering messages
	// (https://cloud.google.com/pubsub/docs/ordering).
	OrderingKey string `json:"orderingKey,omitempty"`
	// PublishTime: The time at which the message was published, populated by the
	// server when it receives the `Publish` call. It must not be populated by the
	// publisher in a `Publish` call.
	PublishTime string `json:"publishTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Attributes") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Attributes") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

PubsubMessage: A message that is published by publishers and consumed by subscribers. The message must contain either a non-empty data field or at least one attribute. Note that client libraries represent this object differently depending on the language. See the corresponding client library documentation (https://cloud.google.com/pubsub/docs/reference/libraries) for more information. See [quotas and limits] (https://cloud.google.com/pubsub/quotas) for more information about message limits.

func (PubsubMessage) MarshalJSON 

func (s PubsubMessage) MarshalJSON() ([]byte, error)

type PubsubTarget 

type PubsubTarget struct {
	// Attributes: Attributes for PubsubMessage. Pubsub message must contain either
	// non-empty data, or at least one attribute.
	Attributes map[string]string `json:"attributes,omitempty"`
	// Data: The message payload for PubsubMessage. Pubsub message must contain
	// either non-empty data, or at least one attribute.
	Data string `json:"data,omitempty"`
	// TopicName: Required. The name of the Cloud Pub/Sub topic to which messages
	// will be published when a job is delivered. The topic name must be in the
	// same format as required by Pub/Sub's PublishRequest.name
	// (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),
	// for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the
	// same project as the Cloud Scheduler job.
	TopicName string `json:"topicName,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Attributes") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Attributes") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (PubsubTarget) MarshalJSON 

func (s PubsubTarget) MarshalJSON() ([]byte, error)

type ResumeJobRequest 

type ResumeJobRequest struct {
}

ResumeJobRequest: Request message for ResumeJob.

type RetryConfig 

type RetryConfig struct {
	// MaxBackoffDuration: The maximum amount of time to wait before retrying a job
	// after it fails. The default value of this field is 1 hour.
	MaxBackoffDuration string `json:"maxBackoffDuration,omitempty"`
	// MaxDoublings: The time between retries will double `max_doublings` times. A
	// job's retry interval starts at min_backoff_duration, then doubles
	// `max_doublings` times, then increases linearly, and finally retries at
	// intervals of max_backoff_duration up to retry_count times. For example, if
	// min_backoff_duration is 10s, max_backoff_duration is 300s, and
	// `max_doublings` is 3, then the 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 until the
	// job has been attempted 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 int64 `json:"maxDoublings,omitempty"`
	// MaxRetryDuration: The time limit for retrying a failed job, measured from
	// time when an execution was first attempted. If specified with 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 string `json:"maxRetryDuration,omitempty"`
	// MinBackoffDuration: The minimum amount of time to wait before retrying a job
	// after it fails. The default value of this field is 5 seconds.
	MinBackoffDuration string `json:"minBackoffDuration,omitempty"`
	// RetryCount: The number of attempts that the system will make to run a job
	// using the exponential backoff procedure described by max_doublings. The
	// default value of retry_count is zero. If retry_count is 0, a job attempt
	// will not be retried if it fails. Instead the Cloud Scheduler system will
	// wait for the next scheduled execution time. Setting retry_count to 0 does
	// not prevent failed jobs from running according to schedule after the
	// failure. 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 int64 `json:"retryCount,omitempty"`
	// ForceSendFields is a list of field names (e.g. "MaxBackoffDuration") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "MaxBackoffDuration") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RetryConfig: 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.

func (RetryConfig) MarshalJSON 

func (s RetryConfig) MarshalJSON() ([]byte, error)

type RunJobRequest 

type RunJobRequest struct {
	// LegacyAppEngineCron: 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 `json:"legacyAppEngineCron,omitempty"`
	// ForceSendFields is a list of field names (e.g. "LegacyAppEngineCron") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "LegacyAppEngineCron") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RunJobRequest: Request message for forcing a job to run now using RunJob.

func (RunJobRequest) MarshalJSON added in v0.37.0 

func (s RunJobRequest) MarshalJSON() ([]byte, error)

type Service 

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New deprecated 

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService added in v0.3.0 

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type Status 

type Status struct {
	// Code: The status code, which should be an enum value of google.rpc.Code.
	Code int64 `json:"code,omitempty"`
	// Details: A list of messages that carry the error details. There is a common
	// set of message types for APIs to use.
	Details []googleapi.RawMessage `json:"details,omitempty"`
	// Message: A developer-facing error message, which should be in English. Any
	// user-facing error message should be localized and sent in the
	// google.rpc.Status.details field, or localized by the client.
	Message string `json:"message,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Code") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Code") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).

func (Status) MarshalJSON 

func (s Status) MarshalJSON() ([]byte, error)

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.