luci: go.chromium.org/luci/scheduler/appengine/messages Index | Files

package messages

import "go.chromium.org/luci/scheduler/appengine/messages"

Index

Package Files

config.pb.go cron.pb.go generate.go

Variables

var Acl_Role_name = map[int32]string{
    0:  "READER",
    2:  "TRIGGERER",
    1:  "OWNER",
}
var Acl_Role_value = map[string]int32{
    "READER":    0,
    "TRIGGERER": 2,
    "OWNER":     1,
}
var TriggeringPolicy_Kind_name = map[int32]string{
    0:  "UNDEFINED",
    1:  "GREEDY_BATCHING",
    2:  "LOGARITHMIC_BATCHING",
}
var TriggeringPolicy_Kind_value = map[string]int32{
    "UNDEFINED":            0,
    "GREEDY_BATCHING":      1,
    "LOGARITHMIC_BATCHING": 2,
}

type Acl Uses

type Acl struct {
    // Role denotes a list of actions that an identity can perform.
    Role Acl_Role `protobuf:"varint,1,opt,name=role,enum=scheduler.config.Acl_Role" json:"role,omitempty"`
    // Either email or "group:xyz" or auth service identity string "kind:name".
    GrantedTo            string   `protobuf:"bytes,2,opt,name=granted_to,json=grantedTo" json:"granted_to,omitempty"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

A single access control rule.

func (*Acl) Descriptor Uses

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

func (*Acl) GetGrantedTo Uses

func (m *Acl) GetGrantedTo() string

func (*Acl) GetRole Uses

func (m *Acl) GetRole() Acl_Role

func (*Acl) ProtoMessage Uses

func (*Acl) ProtoMessage()

func (*Acl) Reset Uses

func (m *Acl) Reset()

func (*Acl) String Uses

func (m *Acl) String() string

func (*Acl) XXX_DiscardUnknown Uses

func (m *Acl) XXX_DiscardUnknown()

func (*Acl) XXX_Marshal Uses

func (m *Acl) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Acl) XXX_Merge Uses

func (dst *Acl) XXX_Merge(src proto.Message)

func (*Acl) XXX_Size Uses

func (m *Acl) XXX_Size() int

func (*Acl) XXX_Unmarshal Uses

func (m *Acl) XXX_Unmarshal(b []byte) error

type AclSet Uses

type AclSet struct {
    // A name of the ACL set, unique for a project.
    // Required. Must match regex '^[0-9A-Za-z_\-\.]{1,100}$'.
    Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
    // List of access control rules.
    // The order does not matter.
    Acls                 []*Acl   `protobuf:"bytes,2,rep,name=acls" json:"acls,omitempty"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

A set of Acl messages. Can be referenced in a Job or Trigger by name.

func (*AclSet) Descriptor Uses

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

func (*AclSet) GetAcls Uses

func (m *AclSet) GetAcls() []*Acl

func (*AclSet) GetName Uses

func (m *AclSet) GetName() string

func (*AclSet) ProtoMessage Uses

func (*AclSet) ProtoMessage()

func (*AclSet) Reset Uses

func (m *AclSet) Reset()

func (*AclSet) String Uses

func (m *AclSet) String() string

func (*AclSet) XXX_DiscardUnknown Uses

func (m *AclSet) XXX_DiscardUnknown()

func (*AclSet) XXX_Marshal Uses

func (m *AclSet) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*AclSet) XXX_Merge Uses

func (dst *AclSet) XXX_Merge(src proto.Message)

func (*AclSet) XXX_Size Uses

func (m *AclSet) XXX_Size() int

func (*AclSet) XXX_Unmarshal Uses

func (m *AclSet) XXX_Unmarshal(b []byte) error

type Acl_Role Uses

type Acl_Role int32
const (
    // Can do read-only operations, such as listing invocations of a Job.
    Acl_READER Acl_Role = 0
    // Can emit triggers for a Job.
    //
    // Being TRIGGERER implicitly grants READER permission.
    Acl_TRIGGERER Acl_Role = 2
    // Same as READER + TRIGGERER + can modify state of a Job or Invocation such
    // as aborting them.
    // LUCI scheduler (this service) is an OWNER of each `Job` and `Trigger`,
    // thus `Trigger`s are allowed to trigger all `Job`s defined in the same
    // project, regardless of their respective ACLs.
    Acl_OWNER Acl_Role = 1
)

func (Acl_Role) EnumDescriptor Uses

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

func (Acl_Role) String Uses

func (x Acl_Role) String() string

type BuildbucketTask Uses

type BuildbucketTask struct {
    // Server is hostname of the buildbucket service to use.
    // Typically, "cr-buildbucket.appspot.com".
    Server string `protobuf:"bytes,1,opt,name=server" json:"server,omitempty"`
    // Bucket defines what bucket to add the task to.
    Bucket string `protobuf:"bytes,2,opt,name=bucket" json:"bucket,omitempty"`
    // Builder defines what to run.
    Builder string `protobuf:"bytes,3,opt,name=builder" json:"builder,omitempty"`
    // Properties is arbitrary "key:value" pairs describing the task.
    // TODO(tandrii): which properties will be overridden if triggered?
    Properties []string `protobuf:"bytes,4,rep,name=properties" json:"properties,omitempty"`
    // Tags is a list of tags (as "key:value" pairs) to assign to the task.
    Tags                 []string `protobuf:"bytes,5,rep,name=tags" json:"tags,omitempty"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

BuildbucketTask specifies parameters of Buildbucket-based jobs.

func (*BuildbucketTask) Descriptor Uses

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

func (*BuildbucketTask) GetBucket Uses

func (m *BuildbucketTask) GetBucket() string

func (*BuildbucketTask) GetBuilder Uses

func (m *BuildbucketTask) GetBuilder() string

func (*BuildbucketTask) GetProperties Uses

func (m *BuildbucketTask) GetProperties() []string

func (*BuildbucketTask) GetServer Uses

func (m *BuildbucketTask) GetServer() string

func (*BuildbucketTask) GetTags Uses

func (m *BuildbucketTask) GetTags() []string

func (*BuildbucketTask) ProtoMessage Uses

func (*BuildbucketTask) ProtoMessage()

func (*BuildbucketTask) Reset Uses

func (m *BuildbucketTask) Reset()

func (*BuildbucketTask) String Uses

func (m *BuildbucketTask) String() string

func (*BuildbucketTask) XXX_DiscardUnknown Uses

func (m *BuildbucketTask) XXX_DiscardUnknown()

func (*BuildbucketTask) XXX_Marshal Uses

func (m *BuildbucketTask) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*BuildbucketTask) XXX_Merge Uses

func (dst *BuildbucketTask) XXX_Merge(src proto.Message)

func (*BuildbucketTask) XXX_Size Uses

func (m *BuildbucketTask) XXX_Size() int

func (*BuildbucketTask) XXX_Unmarshal Uses

func (m *BuildbucketTask) XXX_Unmarshal(b []byte) error

type GitilesTask Uses

type GitilesTask struct {
    // Repo is the URL of the Gitiles repository.
    Repo string `protobuf:"bytes,1,opt,name=repo" json:"repo,omitempty"`
    // Refs is a list of Git references to track.
    //
    // Each ref can be either:
    //  * a fully qualified ref like "refs/heads/master" or "refs/tags/v1.2.3"
    //  * a regular expression with "regexp:" prefix to match multiple refs, e.g.
    //    "regexp:refs/heads/[^/]+" or "regexp:refs/branch-heads/\d+\.\d+", but
    //    the regular expression should have a literal prefix with at least two
    //    slashes present, e.g. "refs/release-\d+/foobar" is not allowed, because
    //    the literal prefix "refs/release-" contains only one slash. The regexp
    //    should not start with ^ or end with $ as they will be added
    //    automatically.
    Refs                 []string `protobuf:"bytes,2,rep,name=refs" json:"refs,omitempty"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

GitilesTask specifies parameters of what repo and which refs to watch for new commits.

GitilesTask will trigger other jobs if either:

* ref's tip has changed (e.g. new commit landed on a ref),
* a ref has just been created.

func (*GitilesTask) Descriptor Uses

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

func (*GitilesTask) GetRefs Uses

func (m *GitilesTask) GetRefs() []string

func (*GitilesTask) GetRepo Uses

func (m *GitilesTask) GetRepo() string

func (*GitilesTask) ProtoMessage Uses

func (*GitilesTask) ProtoMessage()

func (*GitilesTask) Reset Uses

func (m *GitilesTask) Reset()

func (*GitilesTask) String Uses

func (m *GitilesTask) String() string

func (*GitilesTask) XXX_DiscardUnknown Uses

func (m *GitilesTask) XXX_DiscardUnknown()

func (*GitilesTask) XXX_Marshal Uses

func (m *GitilesTask) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GitilesTask) XXX_Merge Uses

func (dst *GitilesTask) XXX_Merge(src proto.Message)

func (*GitilesTask) XXX_Size Uses

func (m *GitilesTask) XXX_Size() int

func (*GitilesTask) XXX_Unmarshal Uses

func (m *GitilesTask) XXX_Unmarshal(b []byte) error

type Job Uses

type Job struct {
    // Id is a name of the job (unique for the project).
    //
    // Must match '^[0-9A-Za-z_\-\. \)\(]{1,100}$'.
    Id  string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
    // Schedule describes when to run the job.
    //
    // A job with a schedule can still be triggered by other triggering jobs
    // and via "Run now" button in UI.
    //
    // Supported kinds of schedules (illustrated by examples):
    //   - "* 0 * * * *": cron-like expression, in a syntax supported by
    //     https://github.com/gorhill/cronexpr (see its docs for full reference).
    //     The cron engine will attempt to start a job at specified moments in
    //     time (based on UTC clock). If when triggering a job, previous
    //     invocation is still running, an overrun will be recorded (and next
    //     attempt to start a job happens based on the schedule, not when the
    //     previous invocation finishes). Some examples:
    //       "0 */3 * * * *" - each 3 hours: at 12:00 AM UTC, 3:00 AM UTC, ...
    //       "0 */3 * * *" - exact same thing (last field is optional)
    //       "0 2,10,18 * * *" - at 2 AM UTC, 10 AM UTC, 6 PM UTC
    //       "0 7 * * *" - at 7 AM UTC, once a day.
    //   - "with 10s interval": runs invocations in a loop, waiting 10s after
    //     finishing invocation before starting a new one. Overruns are not
    //     possible.
    //   - "continuously" is alias for "with 0s interval", meaning the job will
    //     run in a loop without any pauses.
    //   - "triggered" schedule indicates that job is only started via "Run now"
    //     button or via a trigger.
    //
    // Default is "triggered".
    Schedule string `protobuf:"bytes,2,opt,name=schedule" json:"schedule,omitempty"`
    // Disabled is true to disable this job.
    //
    // Disabled job is equivalent to a deleted job: it can't be triggered, it
    // can't be referenced by other jobs and it doesn't show up in UI or API.
    //
    // Use this instead of commenting out the definition in case you want to
    // temporarily git rid of the job.
    Disabled bool `protobuf:"varint,3,opt,name=disabled" json:"disabled,omitempty"`
    // List of access control rules for the Job.
    // The order does not matter.
    // There can be at most 32 different acls for a Job, including those from
    // acl_sets.
    Acls []*Acl `protobuf:"bytes,5,rep,name=acls" json:"acls,omitempty"`
    // A list of ACL set names. Each ACL in each referenced ACL set will be
    // included in this Job.
    // The order does not matter.
    AclSets []string `protobuf:"bytes,6,rep,name=acl_sets,json=aclSets" json:"acl_sets,omitempty"`
    // TriggeringPolicy defines how job handles incoming triggering events.
    //
    // If not specified defaults to GREEDY_BATCHING with 1 max concurrent
    // invocation. See comments in TriggeringPolicy for more details.
    TriggeringPolicy *TriggeringPolicy `protobuf:"bytes,7,opt,name=triggering_policy,json=triggeringPolicy" json:"triggering_policy,omitempty"`
    // Noop is used for testing. It is "do nothing" task.
    Noop *NoopTask `protobuf:"bytes,100,opt,name=noop" json:"noop,omitempty"`
    // UrlFetch can be used to make a simple HTTP call.
    UrlFetch *UrlFetchTask `protobuf:"bytes,101,opt,name=url_fetch,json=urlFetch" json:"url_fetch,omitempty"`
    // BuildbucketTask can be used to schedule buildbucket job.
    Buildbucket          *BuildbucketTask `protobuf:"bytes,103,opt,name=buildbucket" json:"buildbucket,omitempty"`
    XXX_NoUnkeyedLiteral struct{}         `json:"-"`
    XXX_unrecognized     []byte           `json:"-"`
    XXX_sizecache        int32            `json:"-"`
}

Job specifies a single regular job belonging to a project.

Such jobs runs on a schedule or can be triggered by some trigger.

func (*Job) Descriptor Uses

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

func (*Job) GetAclSets Uses

func (m *Job) GetAclSets() []string

func (*Job) GetAcls Uses

func (m *Job) GetAcls() []*Acl

func (*Job) GetBuildbucket Uses

func (m *Job) GetBuildbucket() *BuildbucketTask

func (*Job) GetDisabled Uses

func (m *Job) GetDisabled() bool

func (*Job) GetId Uses

func (m *Job) GetId() string

func (*Job) GetNoop Uses

func (m *Job) GetNoop() *NoopTask

func (*Job) GetSchedule Uses

func (m *Job) GetSchedule() string

func (*Job) GetTriggeringPolicy Uses

func (m *Job) GetTriggeringPolicy() *TriggeringPolicy

func (*Job) GetUrlFetch Uses

func (m *Job) GetUrlFetch() *UrlFetchTask

func (*Job) ProtoMessage Uses

func (*Job) ProtoMessage()

func (*Job) Reset Uses

func (m *Job) Reset()

func (*Job) String Uses

func (m *Job) String() string

func (*Job) XXX_DiscardUnknown Uses

func (m *Job) XXX_DiscardUnknown()

func (*Job) XXX_Marshal Uses

func (m *Job) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Job) XXX_Merge Uses

func (dst *Job) XXX_Merge(src proto.Message)

func (*Job) XXX_Size Uses

func (m *Job) XXX_Size() int

func (*Job) XXX_Unmarshal Uses

func (m *Job) XXX_Unmarshal(b []byte) error

type NoopTask Uses

type NoopTask struct {
    SleepMs              int64    `protobuf:"varint,1,opt,name=sleep_ms,json=sleepMs" json:"sleep_ms,omitempty"`
    TriggersCount        int64    `protobuf:"varint,2,opt,name=triggers_count,json=triggersCount" json:"triggers_count,omitempty"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

NoopTask is used for testing. It is a "do nothing" task that can emit fake triggers.

func (*NoopTask) Descriptor Uses

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

func (*NoopTask) GetSleepMs Uses

func (m *NoopTask) GetSleepMs() int64

func (*NoopTask) GetTriggersCount Uses

func (m *NoopTask) GetTriggersCount() int64

func (*NoopTask) ProtoMessage Uses

func (*NoopTask) ProtoMessage()

func (*NoopTask) Reset Uses

func (m *NoopTask) Reset()

func (*NoopTask) String Uses

func (m *NoopTask) String() string

func (*NoopTask) XXX_DiscardUnknown Uses

func (m *NoopTask) XXX_DiscardUnknown()

func (*NoopTask) XXX_Marshal Uses

func (m *NoopTask) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*NoopTask) XXX_Merge Uses

func (dst *NoopTask) XXX_Merge(src proto.Message)

func (*NoopTask) XXX_Size Uses

func (m *NoopTask) XXX_Size() int

func (*NoopTask) XXX_Unmarshal Uses

func (m *NoopTask) XXX_Unmarshal(b []byte) error

type ProjectConfig Uses

type ProjectConfig struct {
    // Job is a set of jobs defined in the project.
    Job []*Job `protobuf:"bytes,1,rep,name=job" json:"job,omitempty"`
    // Trigger is a set of triggering jobs defined in the project.
    Trigger []*Trigger `protobuf:"bytes,2,rep,name=trigger" json:"trigger,omitempty"`
    // A list of ACL sets. Names must be unique.
    AclSets              []*AclSet `protobuf:"bytes,3,rep,name=acl_sets,json=aclSets" json:"acl_sets,omitempty"`
    XXX_NoUnkeyedLiteral struct{}  `json:"-"`
    XXX_unrecognized     []byte    `json:"-"`
    XXX_sizecache        int32     `json:"-"`
}

ProjectConfig defines a schema for a config file that describe jobs belonging to some project.

func (*ProjectConfig) Descriptor Uses

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

func (*ProjectConfig) GetAclSets Uses

func (m *ProjectConfig) GetAclSets() []*AclSet

func (*ProjectConfig) GetJob Uses

func (m *ProjectConfig) GetJob() []*Job

func (*ProjectConfig) GetTrigger Uses

func (m *ProjectConfig) GetTrigger() []*Trigger

func (*ProjectConfig) ProtoMessage Uses

func (*ProjectConfig) ProtoMessage()

func (*ProjectConfig) Reset Uses

func (m *ProjectConfig) Reset()

func (*ProjectConfig) String Uses

func (m *ProjectConfig) String() string

func (*ProjectConfig) XXX_DiscardUnknown Uses

func (m *ProjectConfig) XXX_DiscardUnknown()

func (*ProjectConfig) XXX_Marshal Uses

func (m *ProjectConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ProjectConfig) XXX_Merge Uses

func (dst *ProjectConfig) XXX_Merge(src proto.Message)

func (*ProjectConfig) XXX_Size Uses

func (m *ProjectConfig) XXX_Size() int

func (*ProjectConfig) XXX_Unmarshal Uses

func (m *ProjectConfig) XXX_Unmarshal(b []byte) error

type TaskDefWrapper Uses

type TaskDefWrapper struct {
    Noop                 *NoopTask        `protobuf:"bytes,1,opt,name=noop" json:"noop,omitempty"`
    UrlFetch             *UrlFetchTask    `protobuf:"bytes,2,opt,name=url_fetch,json=urlFetch" json:"url_fetch,omitempty"`
    Buildbucket          *BuildbucketTask `protobuf:"bytes,4,opt,name=buildbucket" json:"buildbucket,omitempty"`
    Gitiles              *GitilesTask     `protobuf:"bytes,5,opt,name=gitiles" json:"gitiles,omitempty"`
    XXX_NoUnkeyedLiteral struct{}         `json:"-"`
    XXX_unrecognized     []byte           `json:"-"`
    XXX_sizecache        int32            `json:"-"`
}

TaskDefWrapper is a union type of all possible tasks known to the scheduler.

It is used internally when storing jobs in the datastore.

func (*TaskDefWrapper) Descriptor Uses

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

func (*TaskDefWrapper) GetBuildbucket Uses

func (m *TaskDefWrapper) GetBuildbucket() *BuildbucketTask

func (*TaskDefWrapper) GetGitiles Uses

func (m *TaskDefWrapper) GetGitiles() *GitilesTask

func (*TaskDefWrapper) GetNoop Uses

func (m *TaskDefWrapper) GetNoop() *NoopTask

func (*TaskDefWrapper) GetUrlFetch Uses

func (m *TaskDefWrapper) GetUrlFetch() *UrlFetchTask

func (*TaskDefWrapper) ProtoMessage Uses

func (*TaskDefWrapper) ProtoMessage()

func (*TaskDefWrapper) Reset Uses

func (m *TaskDefWrapper) Reset()

func (*TaskDefWrapper) String Uses

func (m *TaskDefWrapper) String() string

func (*TaskDefWrapper) XXX_DiscardUnknown Uses

func (m *TaskDefWrapper) XXX_DiscardUnknown()

func (*TaskDefWrapper) XXX_Marshal Uses

func (m *TaskDefWrapper) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TaskDefWrapper) XXX_Merge Uses

func (dst *TaskDefWrapper) XXX_Merge(src proto.Message)

func (*TaskDefWrapper) XXX_Size Uses

func (m *TaskDefWrapper) XXX_Size() int

func (*TaskDefWrapper) XXX_Unmarshal Uses

func (m *TaskDefWrapper) XXX_Unmarshal(b []byte) error

type Trigger Uses

type Trigger struct {
    // Id is a name of the job (unique for the project).
    //
    // Must match '^[0-9A-Za-z_\-\. \)\(]{1,100}$'. It's in the same namespace as
    // regular jobs.
    Id  string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
    // Schedule describes when to run this triggering job.
    //
    // See Job.schedule for more info. Default is "with 30s interval".
    Schedule string `protobuf:"bytes,2,opt,name=schedule" json:"schedule,omitempty"`
    // Disabled is true to disable this job.
    //
    // Se Job.disabled for more info.
    Disabled bool `protobuf:"varint,3,opt,name=disabled" json:"disabled,omitempty"`
    // ACLs, see Job.acls and Job.acl_sets.
    Acls    []*Acl   `protobuf:"bytes,4,rep,name=acls" json:"acls,omitempty"`
    AclSets []string `protobuf:"bytes,5,rep,name=acl_sets,json=aclSets" json:"acl_sets,omitempty"`
    // TriggeringPolicy defines how job handles incoming triggering events.
    //
    // It is rare for a trigger itself to have a non-default triggering policy,
    // so most likely you should not touch this field.
    TriggeringPolicy *TriggeringPolicy `protobuf:"bytes,6,opt,name=triggering_policy,json=triggeringPolicy" json:"triggering_policy,omitempty"`
    // Triggers are IDs of jobs triggered by this trigger.
    Triggers []string `protobuf:"bytes,200,rep,name=triggers" json:"triggers,omitempty"`
    // Noop is used for testing. It is "do nothing" trigger.
    Noop *NoopTask `protobuf:"bytes,100,opt,name=noop" json:"noop,omitempty"`
    // Gitiles is used to trigger jobs for new commits on Gitiles.
    Gitiles              *GitilesTask `protobuf:"bytes,101,opt,name=gitiles" json:"gitiles,omitempty"`
    XXX_NoUnkeyedLiteral struct{}     `json:"-"`
    XXX_unrecognized     []byte       `json:"-"`
    XXX_sizecache        int32        `json:"-"`
}

Trigger specifies a job that triggers other jobs.

It is a special kind of a job that periodically checks the state of the world and triggers other jobs.

func (*Trigger) Descriptor Uses

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

func (*Trigger) GetAclSets Uses

func (m *Trigger) GetAclSets() []string

func (*Trigger) GetAcls Uses

func (m *Trigger) GetAcls() []*Acl

func (*Trigger) GetDisabled Uses

func (m *Trigger) GetDisabled() bool

func (*Trigger) GetGitiles Uses

func (m *Trigger) GetGitiles() *GitilesTask

func (*Trigger) GetId Uses

func (m *Trigger) GetId() string

func (*Trigger) GetNoop Uses

func (m *Trigger) GetNoop() *NoopTask

func (*Trigger) GetSchedule Uses

func (m *Trigger) GetSchedule() string

func (*Trigger) GetTriggeringPolicy Uses

func (m *Trigger) GetTriggeringPolicy() *TriggeringPolicy

func (*Trigger) GetTriggers Uses

func (m *Trigger) GetTriggers() []string

func (*Trigger) ProtoMessage Uses

func (*Trigger) ProtoMessage()

func (*Trigger) Reset Uses

func (m *Trigger) Reset()

func (*Trigger) String Uses

func (m *Trigger) String() string

func (*Trigger) XXX_DiscardUnknown Uses

func (m *Trigger) XXX_DiscardUnknown()

func (*Trigger) XXX_Marshal Uses

func (m *Trigger) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Trigger) XXX_Merge Uses

func (dst *Trigger) XXX_Merge(src proto.Message)

func (*Trigger) XXX_Size Uses

func (m *Trigger) XXX_Size() int

func (*Trigger) XXX_Unmarshal Uses

func (m *Trigger) XXX_Unmarshal(b []byte) error

type TriggeringPolicy Uses

type TriggeringPolicy struct {
    // Defines an algorithm to use for the triggering decisions.
    //
    // See comments for Kind enum field.
    //
    // Default is GREEDY_BATCHING.
    Kind TriggeringPolicy_Kind `protobuf:"varint,1,opt,name=kind,enum=scheduler.config.TriggeringPolicy_Kind" json:"kind,omitempty"`
    // Limits number of job invocations running at the same time.
    //
    // If the number of current active invocations is more or equal to this
    // setting, the triggering function will be skipped completely, since it isn't
    // allowed to trigger anything anyway.
    //
    // Default is 1.
    MaxConcurrentInvocations int64 `protobuf:"varint,2,opt,name=max_concurrent_invocations,json=maxConcurrentInvocations" json:"max_concurrent_invocations,omitempty"`
    // Limits how many triggers can be put into one invocation request.
    //
    // For example, setting this to 1 will make each trigger launch its own
    // invocation.
    //
    // Default is 1000 (which is ~= unlimited).
    MaxBatchSize int64 `protobuf:"varint,3,opt,name=max_batch_size,json=maxBatchSize" json:"max_batch_size,omitempty"`
    // Base of the logarithm operation during logarithmic batching.
    //
    // For example, setting this to 2, will cause 3 out of 8 pending triggers to
    // be combined into a single invocation with LOGARITHMIC_BATCHING kind. This
    // value is ignored by other policy kinds. Must be larger or equal to 1.0001
    // for numerical stability reasons.
    //
    // Required.
    LogBase              float32  `protobuf:"fixed32,4,opt,name=log_base,json=logBase" json:"log_base,omitempty"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

TriggeringPolicy defines a function that decides when and how to launch a job invocation, given the job's current state and a set of pending triggers.

func (*TriggeringPolicy) Descriptor Uses

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

func (*TriggeringPolicy) GetKind Uses

func (m *TriggeringPolicy) GetKind() TriggeringPolicy_Kind

func (*TriggeringPolicy) GetLogBase Uses

func (m *TriggeringPolicy) GetLogBase() float32

func (*TriggeringPolicy) GetMaxBatchSize Uses

func (m *TriggeringPolicy) GetMaxBatchSize() int64

func (*TriggeringPolicy) GetMaxConcurrentInvocations Uses

func (m *TriggeringPolicy) GetMaxConcurrentInvocations() int64

func (*TriggeringPolicy) ProtoMessage Uses

func (*TriggeringPolicy) ProtoMessage()

func (*TriggeringPolicy) Reset Uses

func (m *TriggeringPolicy) Reset()

func (*TriggeringPolicy) String Uses

func (m *TriggeringPolicy) String() string

func (*TriggeringPolicy) XXX_DiscardUnknown Uses

func (m *TriggeringPolicy) XXX_DiscardUnknown()

func (*TriggeringPolicy) XXX_Marshal Uses

func (m *TriggeringPolicy) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TriggeringPolicy) XXX_Merge Uses

func (dst *TriggeringPolicy) XXX_Merge(src proto.Message)

func (*TriggeringPolicy) XXX_Size Uses

func (m *TriggeringPolicy) XXX_Size() int

func (*TriggeringPolicy) XXX_Unmarshal Uses

func (m *TriggeringPolicy) XXX_Unmarshal(b []byte) error

type TriggeringPolicy_Kind Uses

type TriggeringPolicy_Kind int32
const (
    // A placeholder for unrecognized policy kind.
    TriggeringPolicy_UNDEFINED TriggeringPolicy_Kind = 0
    // A greedy triggering function that takes all pending triggers (up to
    // max_batch_size limit) and collapses them into one new invocation,
    // deriving its properties from the most recent trigger alone. It doesn't
    // wait for a full batch, nor tries to batch evenly.
    TriggeringPolicy_GREEDY_BATCHING TriggeringPolicy_Kind = 1
    // A logarithmic triggering function that takes log_k N pending triggers (up
    // to max_batch_size limit) and collapses them into one new incovation,
    // deriving its properties from the most recent trigger alone, where N is
    // the total number of pending triggers and k is specified by the log_base
    // field below.
    TriggeringPolicy_LOGARITHMIC_BATCHING TriggeringPolicy_Kind = 2
)

func (TriggeringPolicy_Kind) EnumDescriptor Uses

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

func (TriggeringPolicy_Kind) String Uses

func (x TriggeringPolicy_Kind) String() string

type UrlFetchTask Uses

type UrlFetchTask struct {
    // Method is HTTP method to use, such as "GET" or "POST". Default is "GET".
    Method string `protobuf:"bytes,1,opt,name=method" json:"method,omitempty"`
    // Url to send the request to.
    Url string `protobuf:"bytes,2,opt,name=url" json:"url,omitempty"`
    // Timeout is how long to wait for request to complete. Default is 60 sec.
    TimeoutSec           int32    `protobuf:"varint,3,opt,name=timeout_sec,json=timeoutSec" json:"timeout_sec,omitempty"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

UrlFetchTask specifies parameters for simple HTTP call.

func (*UrlFetchTask) Descriptor Uses

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

func (*UrlFetchTask) GetMethod Uses

func (m *UrlFetchTask) GetMethod() string

func (*UrlFetchTask) GetTimeoutSec Uses

func (m *UrlFetchTask) GetTimeoutSec() int32

func (*UrlFetchTask) GetUrl Uses

func (m *UrlFetchTask) GetUrl() string

func (*UrlFetchTask) ProtoMessage Uses

func (*UrlFetchTask) ProtoMessage()

func (*UrlFetchTask) Reset Uses

func (m *UrlFetchTask) Reset()

func (*UrlFetchTask) String Uses

func (m *UrlFetchTask) String() string

func (*UrlFetchTask) XXX_DiscardUnknown Uses

func (m *UrlFetchTask) XXX_DiscardUnknown()

func (*UrlFetchTask) XXX_Marshal Uses

func (m *UrlFetchTask) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UrlFetchTask) XXX_Merge Uses

func (dst *UrlFetchTask) XXX_Merge(src proto.Message)

func (*UrlFetchTask) XXX_Size Uses

func (m *UrlFetchTask) XXX_Size() int

func (*UrlFetchTask) XXX_Unmarshal Uses

func (m *UrlFetchTask) XXX_Unmarshal(b []byte) error

Package messages imports 3 packages (graph) and is imported by 18 packages. Updated 2018-08-19. Refresh now. Tools for package owners.