bucket

type Bucket interface {

	// RegisterWithBucket allows an end-user to register the bucket specification
	// within an integration.
	RegisterWithBucket(worker.Worker, Config) error
}

type Config struct {

	// Bucket is the name of the bucket to write blobs into.
	//
	// Example: "my-bucket"
	//
	// Required.
	Bucket string `json:"bucket"`

	// Policies allows to set activity policies, such as timeouts and retries.
	Policies Policies `json:"policies"`
	// contains filtered or unexported fields
}

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

type InputDelete struct {

	// Policies passed in the input can override the ones set when creating the
	// specification. It will only apply if allowed in the integration's Config
	// via AllowPoliciesOverride.
	Policies *Policies `json:"policies"`

	// Context represents the event's context, shared across every specifications
	// and integrations of this ecosystem.
	Context *event.Context `json:"context,omitempty"`

	// Path is the path and key of the blob to delete at.
	//
	// Example: "path/to/key.json"
	//
	// Required.
	Path string `json:"path"`
}

type InputWrite struct {

	// Policies passed in the input can override the ones set when creating the
	// specification. It will only apply if allowed in the integration's Config
	// via AllowPoliciesOverride.
	Policies *Policies `json:"policies"`

	// Context represents the event's context, shared across every specifications
	// and integrations of this ecosystem.
	Context *event.Context `json:"context,omitempty"`

	// Options allows the end-users to pass options to the blob when writing it
	// into the bucket.
	Options WriteOptions `json:"options,omitempty"`

	// Path is the path and key of the blob to write at.
	//
	// Example: "path/to/key.json"
	//
	// Required.
	Path string `json:"path"`

	// Blob is byte representation of the blob to write at Path.
	//
	// Required.
	Blob []byte `json:"blob"`
}

type OutputDelete struct {

	// Status is the status of the workflow or activity. It's one of "success",
	// "failure".
	Status lifecycle.Status `json:"status"`
}

type OutputWrite struct {

	// Status is the status of the workflow or activity. It's one of "success",
	// "failure".
	Status lifecycle.Status `json:"status"`
}

type Policies struct {

	// Execution is the policy to apply by the activity used to write or delete
	// a blob.
	//
	// Note: Since this is a short-live policy, activity's heartbeat is not used.
	// Therefore, Execution.HeartbeatTimeout is not applied. We advise to set a
	// short-live Execution.SingleAttemptTimeout, such as 3 seconds.
	Execution lifecycle.ActivityPolicy `json:"execution"`
	// contains filtered or unexported fields
}

type With func(*Handler) error

type WriteOptions struct {

	// CacheControl specifies caching attributes that services may use when serving
	// the blob. More info at:
	// https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control.
	CacheControl string `json:"cache,omitempty"`

	// ContentDisposition specifies whether the blob content is expected to be
	// displayed inline or as an attachment. More info at:
	// https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition.
	ContentDisposition string `json:"disposition,omitempty"`

	// ContentEncoding specifies the encoding used for the blob's content, if any.
	// More info at: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Encoding.
	ContentEncoding string `json:"encoding,omitempty"`

	// ContentLanguage specifies the language used in the blob's content, if any.
	// More info at: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Language.
	ContentLanguage string `json:"language,omitempty"`

	// ContentType specifies the MIME type of the blob being written. If not set,
	// it will be inferred from the content using the algorithm described at
	// http://mimesniff.spec.whatwg.org/. More info at:
	// https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type.
	ContentType string `json:"type,omitempty"`

	// ContentMD5 is used as a message integrity check. If len(ContentMD5) > 0,
	// the MD5 hash of the bytes written must match ContentMD5, or the activity
	// will return an error without completing the write. More info at:
	// https://tools.ietf.org/html/rfc1864.
	ContentMD5 []byte `json:"md5,omitempty"`
}