com.google.api.services.storage.model

Class Bucket.Lifecycle.Rule.Condition

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.storage.model.Bucket.Lifecycle.Rule.Condition

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Bucket.Lifecycle.Rule

public static final class Bucket.Lifecycle.Rule.Condition
extends com.google.api.client.json.GenericJson

The condition(s) under which the action will be taken.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Condition()

Method Summary

Modifier and Type	Method and Description
Bucket.Lifecycle.Rule.Condition	clone()
Integer	getAge() Age of an object (in days).
com.google.api.client.util.DateTime	getCreatedBefore() A date in RFC 3339 format with only the date part (for instance, "2013-01-15").
com.google.api.client.util.DateTime	getCustomTimeBefore() A date in RFC 3339 format with only the date part (for instance, "2013-01-15").
Integer	getDaysSinceCustomTime() Number of days elapsed since the user-specified timestamp set on an object.
Integer	getDaysSinceNoncurrentTime() Number of days elapsed since the noncurrent timestamp of an object.
Boolean	getIsLive() Relevant only for versioned objects.
String	getMatchesPattern() A regular expression that satisfies the RE2 syntax.
List<String>	getMatchesPrefix() List of object name prefixes.
List<String>	getMatchesStorageClass() Objects having any of the storage classes specified by this condition will be matched.
List<String>	getMatchesSuffix() List of object name suffixes.
com.google.api.client.util.DateTime	getNoncurrentTimeBefore() A date in RFC 3339 format with only the date part (for instance, "2013-01-15").
Integer	getNumNewerVersions() Relevant only for versioned objects.
Bucket.Lifecycle.Rule.Condition	set(String fieldName, Object value)
Bucket.Lifecycle.Rule.Condition	setAge(Integer age) Age of an object (in days).
Bucket.Lifecycle.Rule.Condition	setCreatedBefore(com.google.api.client.util.DateTime createdBefore) A date in RFC 3339 format with only the date part (for instance, "2013-01-15").
Bucket.Lifecycle.Rule.Condition	setCustomTimeBefore(com.google.api.client.util.DateTime customTimeBefore) A date in RFC 3339 format with only the date part (for instance, "2013-01-15").
Bucket.Lifecycle.Rule.Condition	setDaysSinceCustomTime(Integer daysSinceCustomTime) Number of days elapsed since the user-specified timestamp set on an object.
Bucket.Lifecycle.Rule.Condition	setDaysSinceNoncurrentTime(Integer daysSinceNoncurrentTime) Number of days elapsed since the noncurrent timestamp of an object.
Bucket.Lifecycle.Rule.Condition	setIsLive(Boolean isLive) Relevant only for versioned objects.
Bucket.Lifecycle.Rule.Condition	setMatchesPattern(String matchesPattern) A regular expression that satisfies the RE2 syntax.
Bucket.Lifecycle.Rule.Condition	setMatchesPrefix(List<String> matchesPrefix) List of object name prefixes.
Bucket.Lifecycle.Rule.Condition	setMatchesStorageClass(List<String> matchesStorageClass) Objects having any of the storage classes specified by this condition will be matched.
Bucket.Lifecycle.Rule.Condition	setMatchesSuffix(List<String> matchesSuffix) List of object name suffixes.
Bucket.Lifecycle.Rule.Condition	setNoncurrentTimeBefore(com.google.api.client.util.DateTime noncurrentTimeBefore) A date in RFC 3339 format with only the date part (for instance, "2013-01-15").
Bucket.Lifecycle.Rule.Condition	setNumNewerVersions(Integer numNewerVersions) Relevant only for versioned objects.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Condition

public Condition()

Method Detail

getAge

public Integer getAge()

Age of an object (in days). This condition is satisfied when an object reaches the specified age.

Returns:

value or null for none

setAge

public Bucket.Lifecycle.Rule.Condition setAge(Integer age)

Age of an object (in days). This condition is satisfied when an object reaches the specified age.

Parameters:

age - age or null for none

getCreatedBefore

public com.google.api.client.util.DateTime getCreatedBefore()

A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when an object is created before midnight of the specified date in UTC.

Returns:

value or null for none

setCreatedBefore

public Bucket.Lifecycle.Rule.Condition setCreatedBefore(com.google.api.client.util.DateTime createdBefore)

A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when an object is created before midnight of the specified date in UTC.

Parameters:

createdBefore - createdBefore or null for none

getCustomTimeBefore

public com.google.api.client.util.DateTime getCustomTimeBefore()

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:

value or null for none

setCustomTimeBefore

public Bucket.Lifecycle.Rule.Condition setCustomTimeBefore(com.google.api.client.util.DateTime customTimeBefore)

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.

Parameters:

customTimeBefore - customTimeBefore or null for none

getDaysSinceCustomTime

public Integer getDaysSinceCustomTime()

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:

value or null for none

setDaysSinceCustomTime

public Bucket.Lifecycle.Rule.Condition setDaysSinceCustomTime(Integer daysSinceCustomTime)

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.

Parameters:

daysSinceCustomTime - daysSinceCustomTime or null for none

getDaysSinceNoncurrentTime

public Integer getDaysSinceNoncurrentTime()

Number of days elapsed since the noncurrent timestamp of an object. The condition is satisfied if the days elapsed is at least this number. This condition is relevant only for versioned objects. 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.

Returns:

value or null for none

setDaysSinceNoncurrentTime

public Bucket.Lifecycle.Rule.Condition setDaysSinceNoncurrentTime(Integer daysSinceNoncurrentTime)

Number of days elapsed since the noncurrent timestamp of an object. The condition is satisfied if the days elapsed is at least this number. This condition is relevant only for versioned objects. 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.

Parameters:

daysSinceNoncurrentTime - daysSinceNoncurrentTime or null for none

getIsLive

public Boolean getIsLive()

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

Returns:

value or null for none

setIsLive

public Bucket.Lifecycle.Rule.Condition setIsLive(Boolean isLive)

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

Parameters:

isLive - isLive or null for none

getMatchesPattern

public String getMatchesPattern()

A regular expression that satisfies the RE2 syntax. This condition is satisfied when the name of the object matches the RE2 pattern. Note: This feature is currently in the "Early Access" launch stage and is only available to a whitelisted set of users; that means that this feature may be changed in backward-incompatible ways and that it is not guaranteed to be released.

Returns:

value or null for none

setMatchesPattern

public Bucket.Lifecycle.Rule.Condition setMatchesPattern(String matchesPattern)

A regular expression that satisfies the RE2 syntax. This condition is satisfied when the name of the object matches the RE2 pattern. Note: This feature is currently in the "Early Access" launch stage and is only available to a whitelisted set of users; that means that this feature may be changed in backward-incompatible ways and that it is not guaranteed to be released.

Parameters:

matchesPattern - matchesPattern or null for none

getMatchesPrefix

public List<String> getMatchesPrefix()

List of object name prefixes. This condition will be satisfied when at least one of the prefixes exactly matches the beginning of the object name.

Returns:

value or null for none

setMatchesPrefix

public Bucket.Lifecycle.Rule.Condition setMatchesPrefix(List<String> matchesPrefix)

List of object name prefixes. This condition will be satisfied when at least one of the prefixes exactly matches the beginning of the object name.

Parameters:

matchesPrefix - matchesPrefix or null for none

getMatchesStorageClass

public List<String> getMatchesStorageClass()

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

Returns:

value or null for none

setMatchesStorageClass

public Bucket.Lifecycle.Rule.Condition setMatchesStorageClass(List<String> matchesStorageClass)

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

Parameters:

matchesStorageClass - matchesStorageClass or null for none

getMatchesSuffix

public List<String> getMatchesSuffix()

List of object name suffixes. This condition will be satisfied when at least one of the suffixes exactly matches the end of the object name.

Returns:

value or null for none

setMatchesSuffix

public Bucket.Lifecycle.Rule.Condition setMatchesSuffix(List<String> matchesSuffix)

List of object name suffixes. This condition will be satisfied when at least one of the suffixes exactly matches the end of the object name.

Parameters:

matchesSuffix - matchesSuffix or null for none

getNoncurrentTimeBefore

public com.google.api.client.util.DateTime getNoncurrentTimeBefore()

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.

Returns:

value or null for none

setNoncurrentTimeBefore

public Bucket.Lifecycle.Rule.Condition setNoncurrentTimeBefore(com.google.api.client.util.DateTime noncurrentTimeBefore)

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.

Parameters:

noncurrentTimeBefore - noncurrentTimeBefore or null for none

getNumNewerVersions

public Integer getNumNewerVersions()

Relevant only for versioned objects. 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 object.

Returns:

value or null for none

setNumNewerVersions

public Bucket.Lifecycle.Rule.Condition setNumNewerVersions(Integer numNewerVersions)

Relevant only for versioned objects. 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 object.

Parameters:

numNewerVersions - numNewerVersions or null for none

set

public Bucket.Lifecycle.Rule.Condition set(String fieldName,
                                           Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Bucket.Lifecycle.Rule.Condition clone()

Overrides:

clone in class com.google.api.client.json.GenericJson