Class ObjectLifecycleRule.Builder

    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • name

        public ObjectLifecycleRule.Builder name​(String name)
        The name of the lifecycle rule to be applied.
        Parameters:
        name - the value to set
        Returns:
        this builder
      • target

        public ObjectLifecycleRule.Builder target​(String target)
        The target of the object lifecycle policy rule.

        The values of target can be either “objects”, “multipart-uploads” or “previous-object-versions”. This field when declared as “objects” is used to specify ARCHIVE, INFREQUENT_ACCESS or DELETE rule for objects. This field when declared as “previous-object-versions” is used to specify ARCHIVE, INFREQUENT_ACCESS or DELETE rule for previous versions of existing objects. This field when declared as “multipart-uploads” is used to specify the ABORT (only) rule for uncommitted multipart-uploads.

        Parameters:
        target - the value to set
        Returns:
        this builder
      • action

        public ObjectLifecycleRule.Builder action​(String action)
        The action of the object lifecycle policy rule.

        Rules using the action ‘ARCHIVE’ move objects from Standard and InfrequentAccess storage tiers into the Archive storage tier. Rules using the action ‘INFREQUENT_ACCESS’ move objects from Standard storage tier into the Infrequent Access Storage tier. Objects that are already in InfrequentAccess tier or in Archive tier are left untouched. Rules using the action ‘DELETE’ permanently delete objects from buckets. Rules using ‘ABORT’ abort the uncommitted multipart-uploads and permanently delete their parts from buckets.

        Parameters:
        action - the value to set
        Returns:
        this builder
      • timeAmount

        public ObjectLifecycleRule.Builder timeAmount​(Long timeAmount)
        Specifies the age of objects to apply the rule to.

        The timeAmount is interpreted in units defined by the timeUnit parameter, and is calculated in relation to each object’s Last-Modified time.

        Parameters:
        timeAmount - the value to set
        Returns:
        this builder
      • timeUnit

        public ObjectLifecycleRule.Builder timeUnit​(ObjectLifecycleRule.TimeUnit timeUnit)
        The unit that should be used to interpret timeAmount.

        Days are defined as starting and ending at midnight UTC. Years are defined as 365.2425 days long and likewise round up to the next midnight UTC.

        Parameters:
        timeUnit - the value to set
        Returns:
        this builder
      • isEnabled

        public ObjectLifecycleRule.Builder isEnabled​(Boolean isEnabled)
        A Boolean that determines whether this rule is currently enabled.
        Parameters:
        isEnabled - the value to set
        Returns:
        this builder