Class: Google::Cloud::Storage::Bucket::Lifecycle::Rule

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/storage/bucket/lifecycle.rb

Overview

Bucket Lifecycle Rule

Represents an Object Lifecycle Management rule for a bucket. The action for the rule will be taken when its conditions are met. Accessed via Google::Cloud::Storage::Bucket#lifecycle.

Examples:

Retrieving a bucket's lifecycle management rules.

require "google/cloud/storage"

storage = Google::Cloud::Storage.new
bucket = storage.bucket "my-bucket"

bucket.lifecycle.size #=> 2
rule = bucket.lifecycle.first
rule.action #=> "SetStorageClass"
rule.storage_class #=> "COLDLINE"
rule.age #=> 10
rule.matches_storage_class #=> ["STANDARD", "NEARLINE"]
rule.matches_prefix #=> ["myprefix/foo"]
rule.matches_suffix #=> [".jpg", ".png"]

Updating the bucket's lifecycle rules in a block.

require "google/cloud/storage"

storage = Google::Cloud::Storage.new
bucket = storage.bucket "my-bucket"

bucket.update do |b|
  b.lifecycle do |l|
    # Remove the last rule from the array
    l.pop
    # Remove rules with the given condition
    l.delete_if do |r|
      r.matches_storage_class.include? "NEARLINE"
    end
    # Update rules
    l.each do |r|
      r.age = 90 if r.action == "Delete"
    end
    # Add a rule
    l.add_set_storage_class_rule "COLDLINE", age: 10
  end
end

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#action ⇒ String

The type of action taken when the rule's conditions are met. Currently, only Delete and SetStorageClass are supported.

Returns:

  • (String) —

    the current value of action



437
438
439
 
# File 'lib/google/cloud/storage/bucket/lifecycle.rb', line 437

def action
  @action
end

#age ⇒ Integer

The age of a file (in days). This condition is satisfied when a file reaches the specified age.

Returns:

  • (Integer) —

    the current value of age



437
438
439
 
# File 'lib/google/cloud/storage/bucket/lifecycle.rb', line 437

def age
  @age
end

#created_before ⇒ String, ...

A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when a file is created before midnight of the specified date in UTC. When returned by the service, a non-empty value will always be a Date object.

Returns:

  • (String, Date, nil) —

    the current value of created_before



437
438
439
 
# File 'lib/google/cloud/storage/bucket/lifecycle.rb', line 437

def created_before
  @created_before
end

#custom_time_before ⇒ String, ...

A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the custom time on an object is before this date in UTC.

Returns:

  • (String, Date, nil) —

    the current value of custom_time_before



437
438
439
 
# File 'lib/google/cloud/storage/bucket/lifecycle.rb', line 437

def custom_time_before
  @custom_time_before
end

#days_since_custom_time ⇒ Integer?

Represents the number of days elapsed since the user-specified timestamp set on an object. The condition is satisfied if the days elapsed is at least this number. If no custom timestamp is specified on an object, the condition does not apply.

Returns:

  • (Integer, nil) —

    the current value of days_since_custom_time



437
438
439
 
# File 'lib/google/cloud/storage/bucket/lifecycle.rb', line 437

def days_since_custom_time
  @days_since_custom_time
end

#days_since_noncurrent_time ⇒ Integer

Represents the number of days elapsed since the noncurrent timestamp of an object. The condition is satisfied if the days elapsed is at least this number. The value of the field must be a nonnegative integer. If it's zero, the object version will become eligible for Lifecycle action as soon as it becomes noncurrent. Relevant only for versioning-enabled buckets. (See Google::Cloud::Storage::Bucket#versioning?)

Returns:

  • (Integer) —

    the current value of days_since_noncurrent_time



437
438
439
 
# File 'lib/google/cloud/storage/bucket/lifecycle.rb', line 437

def days_since_noncurrent_time
  @days_since_noncurrent_time
end

#is_live ⇒ Boolean

Relevant only for versioned files. If the value is true, this condition matches live files; if the value is false, it matches archived files.

Returns:

  • (Boolean) —

    the current value of is_live



437
438
439
 
# File 'lib/google/cloud/storage/bucket/lifecycle.rb', line 437

def is_live
  @is_live
end

#matches_prefix ⇒ Object

Returns the value of attribute matches_prefix.



449
450
451
 
# File 'lib/google/cloud/storage/bucket/lifecycle.rb', line 449

def matches_prefix
  @matches_prefix
end

#matches_storage_class ⇒ Array<String>

Files having any of the storage classes specified by this condition will be matched. Values include STANDARD, NEARLINE, COLDLINE, and ARCHIVE. REGIONAL, MULTI_REGIONAL, and DURABLE_REDUCED_AVAILABILITY are supported as legacy storage classes.

Returns:

  • (Array<String>) —

    the current value of matches_storage_class



437
438
439
 
# File 'lib/google/cloud/storage/bucket/lifecycle.rb', line 437

def matches_storage_class
  @matches_storage_class
end

#matches_suffix ⇒ Object

Returns the value of attribute matches_suffix.



450
451
452
 
# File 'lib/google/cloud/storage/bucket/lifecycle.rb', line 450

def matches_suffix
  @matches_suffix
end

#noncurrent_time_before ⇒ String, ...

A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the noncurrent time on an object is before this date in UTC. This condition is relevant only for versioned objects. When returned by the service, a non-empty value will always be a Date object.

Returns:

  • (String, Date, nil) —

    the current value of noncurrent_time_before



437
438
439
 
# File 'lib/google/cloud/storage/bucket/lifecycle.rb', line 437

def noncurrent_time_before
  @noncurrent_time_before
end

#num_newer_versions ⇒ Integer

Relevant only for versioned files. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the file.

Returns:

  • (Integer) —

    the current value of num_newer_versions



437
438
439
 
# File 'lib/google/cloud/storage/bucket/lifecycle.rb', line 437

def num_newer_versions
  @num_newer_versions
end

#storage_class ⇒ String

The target storage class for the action. Required only if the action is SetStorageClass.

Returns:

  • (String) —

    the current value of storage_class



437
438
439
 
# File 'lib/google/cloud/storage/bucket/lifecycle.rb', line 437

def storage_class
  @storage_class
end