cloudscheduler

Documentation

Overview

nolint: lll Package cloudscheduler exports types, functions, subpackages for provisioning cloudscheduler resources.

> This provider is a derived work of the [Terraform Provider](https://github.com/terraform-providers/terraform-provider-google) > distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature, > first check the [`pulumi/pulumi-gcp` repo](https://github.com/pulumi/pulumi-gcp/issues); however, if that doesn't turn up anything, > please consult the source [`terraform-providers/terraform-provider-google` repo](https://github.com/terraform-providers/terraform-provider-google/issues).

Index

• type Job
  • func GetJob(ctx *pulumi.Context, name string, id pulumi.ID, state *JobState, ...) (*Job, error)
  • func NewJob(ctx *pulumi.Context, name string, args *JobArgs, opts ...pulumi.ResourceOpt) (*Job, error)
  • func (r *Job) AppEngineHttpTarget() *pulumi.Output
  • func (r *Job) Description() *pulumi.StringOutput
  • func (r *Job) HttpTarget() *pulumi.Output
  • func (r *Job) ID() *pulumi.IDOutput
  • func (r *Job) Name() *pulumi.StringOutput
  • func (r *Job) Project() *pulumi.StringOutput
  • func (r *Job) PubsubTarget() *pulumi.Output
  • func (r *Job) Region() *pulumi.StringOutput
  • func (r *Job) RetryConfig() *pulumi.Output
  • func (r *Job) Schedule() *pulumi.StringOutput
  • func (r *Job) TimeZone() *pulumi.StringOutput
  • func (r *Job) URN() *pulumi.URNOutput
• type JobArgs
• type JobState

Types

type Job

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

> This content is derived from https://github.com/terraform-providers/terraform-provider-google/blob/master/website/docs/r/cloud_scheduler_job.html.markdown.

func GetJob

func GetJob(ctx *pulumi.Context,
	name string, id pulumi.ID, state *JobState, opts ...pulumi.ResourceOpt) (*Job, error)

GetJob gets an existing Job resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewJob

func NewJob(ctx *pulumi.Context,
	name string, args *JobArgs, opts ...pulumi.ResourceOpt) (*Job, error)

NewJob registers a new resource with the given unique name, arguments, and options.

func (*Job) AppEngineHttpTarget

func (r *Job) AppEngineHttpTarget() *pulumi.Output

App Engine HTTP target. If the job providers a App Engine HTTP target the cron will send a request to the service instance

func (*Job) Description

func (r *Job) Description() *pulumi.StringOutput

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

func (*Job) HttpTarget

func (r *Job) HttpTarget() *pulumi.Output

HTTP target. If the job providers a http_target the cron will send a request to the targeted url

func (*Job) ID

func (r *Job) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Job) Name

func (r *Job) Name() *pulumi.StringOutput

The name of the job.

func (*Job) Project

func (r *Job) Project() *pulumi.StringOutput

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

func (*Job) PubsubTarget

func (r *Job) PubsubTarget() *pulumi.Output

Pub/Sub target If the job providers a Pub/Sub target the cron will publish a message to the provided topic

func (*Job) Region

func (r *Job) Region() *pulumi.StringOutput

Region where the scheduler job resides

func (*Job) RetryConfig

func (r *Job) RetryConfig() *pulumi.Output

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

func (*Job) Schedule

func (r *Job) Schedule() *pulumi.StringOutput

Describes the schedule on which the job will be executed.

func (*Job) TimeZone

func (r *Job) TimeZone() *pulumi.StringOutput

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.

func (*Job) URN

func (r *Job) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type JobArgs

type JobArgs struct {
	// App Engine HTTP target. If the job providers a App Engine HTTP target the cron will send a request to the service
	// instance
	AppEngineHttpTarget interface{}
	// A human-readable description for the job. This string must not contain more than 500 characters.
	Description interface{}
	// HTTP target. If the job providers a http_target the cron will send a request to the targeted url
	HttpTarget interface{}
	// The name of the job.
	Name interface{}
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project interface{}
	// Pub/Sub target If the job providers a Pub/Sub target the cron will publish a message to the provided topic
	PubsubTarget interface{}
	// Region where the scheduler job resides
	Region interface{}
	// 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
	RetryConfig interface{}
	// Describes the schedule on which the job will be executed.
	Schedule interface{}
	// Specifies the time zone to be used in interpreting schedule. The value of this field must be a time zone name from the
	// tz database.
	TimeZone interface{}
}

The set of arguments for constructing a Job resource.

type JobState

type JobState struct {
	// App Engine HTTP target. If the job providers a App Engine HTTP target the cron will send a request to the service
	// instance
	AppEngineHttpTarget interface{}
	// A human-readable description for the job. This string must not contain more than 500 characters.
	Description interface{}
	// HTTP target. If the job providers a http_target the cron will send a request to the targeted url
	HttpTarget interface{}
	// The name of the job.
	Name interface{}
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project interface{}
	// Pub/Sub target If the job providers a Pub/Sub target the cron will publish a message to the provided topic
	PubsubTarget interface{}
	// Region where the scheduler job resides
	Region interface{}
	// 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
	RetryConfig interface{}
	// Describes the schedule on which the job will be executed.
	Schedule interface{}
	// Specifies the time zone to be used in interpreting schedule. The value of this field must be a time zone name from the
	// tz database.
	TimeZone interface{}
}

Input properties used for looking up and filtering Job resources.