lifecycle

Documentation

Index

• type Action
• type And
  • func (a And) MarshalXML(e *xml.Encoder, start xml.StartElement) error
  • func (a And) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error
• type Expiration
  • func (e Expiration) IsDateNull() bool
  • func (e Expiration) IsDaysNull() bool
  • func (e Expiration) IsNull() bool
  • func (e Expiration) Validate() error
• type ExpirationDate
  • func (eDate *ExpirationDate) MarshalXML(e *xml.Encoder, startElement xml.StartElement) error
  • func (eDate *ExpirationDate) UnmarshalXML(d *xml.Decoder, startElement xml.StartElement) error
• type ExpirationDays
  • func (eDays *ExpirationDays) MarshalXML(e *xml.Encoder, startElement xml.StartElement) error
  • func (eDays *ExpirationDays) UnmarshalXML(d *xml.Decoder, startElement xml.StartElement) error
• type Filter
  • func (f Filter) Validate() error
• type Lifecycle
  • func ParseLifecycleConfig(reader io.Reader) (*Lifecycle, error)
  • func (lc Lifecycle) ComputeAction(objName string, modTime time.Time) Action
  • func (lc Lifecycle) FilterRuleActions(objName string) (Expiration, Transition)
  • func (lc Lifecycle) IsEmpty() bool
  • func (lc Lifecycle) Validate() error
• type NoncurrentVersionExpiration
  • func (n NoncurrentVersionExpiration) MarshalXML(e *xml.Encoder, start xml.StartElement) error
  • func (n NoncurrentVersionExpiration) UnmarshalXML(d *xml.Decoder, startElement xml.StartElement) error
• type NoncurrentVersionTransition
  • func (n NoncurrentVersionTransition) MarshalXML(e *xml.Encoder, start xml.StartElement) error
  • func (n NoncurrentVersionTransition) UnmarshalXML(d *xml.Decoder, startElement xml.StartElement) error
• type Rule
  • func (r Rule) Validate() error
• type Tag
  • func (t Tag) MarshalXML(e *xml.Encoder, start xml.StartElement) error
  • func (t Tag) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error
• type Transition
  • func (t Transition) MarshalXML(e *xml.Encoder, start xml.StartElement) error
  • func (t Transition) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

Types

type Action

type Action int

Action represents a delete action or other transition actions that will be implemented later.

const (
	// NoneAction means no action required after evaluting lifecycle rules
	NoneAction Action = iota
	// DeleteAction means the object needs to be removed after evaluting lifecycle rules
	DeleteAction
)

type And

type And struct {
	XMLName xml.Name `xml:"And"`
	Prefix  string   `xml:"Prefix,omitempty"`
	Tags    []Tag    `xml:"Tag,omitempty"`
}

And - a tag to combine a prefix and multiple tags for lifecycle configuration rule.

func (And) MarshalXML

func (a And) MarshalXML(e *xml.Encoder, start xml.StartElement) error

MarshalXML is extended to leave out <And></And> tags

func (And) UnmarshalXML

func (a And) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

UnmarshalXML is extended to indicate lack of support for And xml tag in object lifecycle configuration

type Expiration

type Expiration struct {
	XMLName xml.Name       `xml:"Expiration"`
	Days    ExpirationDays `xml:"Days,omitempty"`
	Date    ExpirationDate `xml:"Date,omitempty"`
}

Expiration - expiration actions for a rule in lifecycle configuration.

func (Expiration) IsDateNull

func (e Expiration) IsDateNull() bool

IsDateNull returns true if date field is null

func (Expiration) IsDaysNull

func (e Expiration) IsDaysNull() bool

IsDaysNull returns true if days field is null

func (Expiration) IsNull

func (e Expiration) IsNull() bool

IsNull returns true if both date and days fields are null

func (Expiration) Validate

func (e Expiration) Validate() error

Validate - validates the "Expiration" element

type ExpirationDate

type ExpirationDate struct {
	time.Time
}

ExpirationDate is a embedded type containing time.Time to unmarshal Date in Expiration

func (*ExpirationDate) MarshalXML

func (eDate *ExpirationDate) MarshalXML(e *xml.Encoder, startElement xml.StartElement) error

MarshalXML encodes expiration date if it is non-zero and encodes empty string otherwise

func (*ExpirationDate) UnmarshalXML

func (eDate *ExpirationDate) UnmarshalXML(d *xml.Decoder, startElement xml.StartElement) error

UnmarshalXML parses date from Expiration and validates date format

type ExpirationDays

type ExpirationDays int

ExpirationDays is a type alias to unmarshal Days in Expiration

func (*ExpirationDays) MarshalXML

func (eDays *ExpirationDays) MarshalXML(e *xml.Encoder, startElement xml.StartElement) error

MarshalXML encodes number of days to expire if it is non-zero and encodes empty string otherwise

func (*ExpirationDays) UnmarshalXML

func (eDays *ExpirationDays) UnmarshalXML(d *xml.Decoder, startElement xml.StartElement) error

UnmarshalXML parses number of days from Expiration and validates if greater than zero

type Filter

type Filter struct {
	XMLName xml.Name `xml:"Filter"`
	And     And      `xml:"And,omitempty"`
	Prefix  string   `xml:"Prefix"`
	Tag     Tag      `xml:"Tag,omitempty"`
}

Filter - a filter for a lifecycle configuration Rule.

func (Filter) Validate

func (f Filter) Validate() error

Validate - validates the filter element

type Lifecycle

type Lifecycle struct {
	XMLName xml.Name `xml:"LifecycleConfiguration"`
	Rules   []Rule   `xml:"Rule"`
}

Lifecycle - Configuration for bucket lifecycle.

func ParseLifecycleConfig

func ParseLifecycleConfig(reader io.Reader) (*Lifecycle, error)

ParseLifecycleConfig - parses data in given reader to Lifecycle.

func (Lifecycle) ComputeAction

func (lc Lifecycle) ComputeAction(objName string, modTime time.Time) Action

ComputeAction returns the action to perform by evaluating all lifecycle rules against the object name and its modification time.

func (Lifecycle) FilterRuleActions

func (lc Lifecycle) FilterRuleActions(objName string) (Expiration, Transition)

FilterRuleActions returns the expiration and transition from the object name after evaluating all rules.

func (Lifecycle) IsEmpty

func (lc Lifecycle) IsEmpty() bool

IsEmpty - returns whether policy is empty or not.

func (Lifecycle) Validate

func (lc Lifecycle) Validate() error

Validate - validates the lifecycle configuration

type NoncurrentVersionExpiration

type NoncurrentVersionExpiration struct {
	XMLName        xml.Name `xml:"NoncurrentVersionExpiration"`
	NoncurrentDays int      `xml:"NoncurrentDays,omitempty"`
}

NoncurrentVersionExpiration - an action for lifecycle configuration rule.

func (NoncurrentVersionExpiration) MarshalXML

func (n NoncurrentVersionExpiration) MarshalXML(e *xml.Encoder, start xml.StartElement) error

MarshalXML is extended to leave out <NoncurrentVersionExpiration></NoncurrentVersionExpiration> tags

func (NoncurrentVersionExpiration) UnmarshalXML

func (n NoncurrentVersionExpiration) UnmarshalXML(d *xml.Decoder, startElement xml.StartElement) error

UnmarshalXML is extended to indicate lack of support for NoncurrentVersionExpiration xml tag in object lifecycle configuration

type NoncurrentVersionTransition

type NoncurrentVersionTransition struct {
	NoncurrentDays int    `xml:"NoncurrentDays"`
	StorageClass   string `xml:"StorageClass"`
}

NoncurrentVersionTransition - an action for lifecycle configuration rule.

func (NoncurrentVersionTransition) MarshalXML

func (n NoncurrentVersionTransition) MarshalXML(e *xml.Encoder, start xml.StartElement) error

MarshalXML is extended to leave out <NoncurrentVersionTransition></NoncurrentVersionTransition> tags

func (NoncurrentVersionTransition) UnmarshalXML

func (n NoncurrentVersionTransition) UnmarshalXML(d *xml.Decoder, startElement xml.StartElement) error

UnmarshalXML is extended to indicate lack of support for NoncurrentVersionTransition xml tag in object lifecycle configuration

type Rule

type Rule struct {
	XMLName    xml.Name   `xml:"Rule"`
	ID         string     `xml:"ID,omitempty"`
	Status     string     `xml:"Status"`
	Filter     Filter     `xml:"Filter"`
	Expiration Expiration `xml:"Expiration,omitempty"`
	Transition Transition `xml:"Transition,omitempty"`
	// FIXME: add a type to catch unsupported AbortIncompleteMultipartUpload AbortIncompleteMultipartUpload `xml:"AbortIncompleteMultipartUpload,omitempty"`
	NoncurrentVersionExpiration NoncurrentVersionExpiration `xml:"NoncurrentVersionExpiration,omitempty"`
	NoncurrentVersionTransition NoncurrentVersionTransition `xml:"NoncurrentVersionTransition,omitempty"`
}

Rule - a rule for lifecycle configuration.

func (Rule) Validate

func (r Rule) Validate() error

Validate - validates the rule element

type Tag

type Tag struct {
	XMLName xml.Name `xml:"Tag"`
	Key     string   `xml:"Key,omitempty"`
	Value   string   `xml:"Value,omitempty"`
}

Tag - a tag for a lifecycle configuration Rule filter.

func (Tag) MarshalXML

func (t Tag) MarshalXML(e *xml.Encoder, start xml.StartElement) error

MarshalXML is extended to leave out <Tag></Tag> tags

func (Tag) UnmarshalXML

func (t Tag) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

UnmarshalXML is extended to indicate lack of support for Tag xml tag in object lifecycle configuration

type Transition

type Transition struct {
	XMLName      xml.Name `xml:"Transition"`
	Days         int      `xml:"Days,omitempty"`
	Date         string   `xml:"Date,omitempty"`
	StorageClass string   `xml:"StorageClass"`
}

Transition - transition actions for a rule in lifecycle configuration.

func (Transition) MarshalXML

func (t Transition) MarshalXML(e *xml.Encoder, start xml.StartElement) error

MarshalXML is extended to leave out <Transition></Transition> tags

func (Transition) UnmarshalXML

func (t Transition) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

UnmarshalXML is extended to indicate lack of support for Transition xml tag in object lifecycle configuration