Class Bucket.RetentionPolicy (2.13.1)

public static final class Bucket.RetentionPolicy extends GeneratedMessageV3 implements Bucket.RetentionPolicyOrBuilder

Retention policy properties of a bucket.

Protobuf type google.storage.v2.Bucket.RetentionPolicy

Static Fields

EFFECTIVE_TIME_FIELD_NUMBER

public static final int EFFECTIVE_TIME_FIELD_NUMBER
Field Value
Type Description
int

IS_LOCKED_FIELD_NUMBER

public static final int IS_LOCKED_FIELD_NUMBER
Field Value
Type Description
int

RETENTION_PERIOD_FIELD_NUMBER

public static final int RETENTION_PERIOD_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Bucket.RetentionPolicy getDefaultInstance()
Returns
Type Description
Bucket.RetentionPolicy

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Bucket.RetentionPolicy.Builder newBuilder()
Returns
Type Description
Bucket.RetentionPolicy.Builder

newBuilder(Bucket.RetentionPolicy prototype)

public static Bucket.RetentionPolicy.Builder newBuilder(Bucket.RetentionPolicy prototype)
Parameter
Name Description
prototype Bucket.RetentionPolicy
Returns
Type Description
Bucket.RetentionPolicy.Builder

parseDelimitedFrom(InputStream input)

public static Bucket.RetentionPolicy parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Bucket.RetentionPolicy
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Bucket.RetentionPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Bucket.RetentionPolicy
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Bucket.RetentionPolicy parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Bucket.RetentionPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Bucket.RetentionPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Bucket.RetentionPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Bucket.RetentionPolicy parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Bucket.RetentionPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Bucket.RetentionPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Bucket.RetentionPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Bucket.RetentionPolicy parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Bucket.RetentionPolicy
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Bucket.RetentionPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Bucket.RetentionPolicy
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Bucket.RetentionPolicy parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Bucket.RetentionPolicy
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Bucket.RetentionPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Bucket.RetentionPolicy
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Bucket.RetentionPolicy parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Bucket.RetentionPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Bucket.RetentionPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Bucket.RetentionPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Bucket.RetentionPolicy> parser()
Returns
Type Description
Parser<RetentionPolicy>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Bucket.RetentionPolicy getDefaultInstanceForType()
Returns
Type Description
Bucket.RetentionPolicy

getEffectiveTime()

public Timestamp getEffectiveTime()

Server-determined value that indicates the time from which policy was enforced and effective.

.google.protobuf.Timestamp effective_time = 1;

Returns
Type Description
Timestamp

The effectiveTime.

getEffectiveTimeOrBuilder()

public TimestampOrBuilder getEffectiveTimeOrBuilder()

Server-determined value that indicates the time from which policy was enforced and effective.

.google.protobuf.Timestamp effective_time = 1;

Returns
Type Description
TimestampOrBuilder

getIsLocked()

public boolean getIsLocked()

Once locked, an object retention policy cannot be modified.

bool is_locked = 2;

Returns
Type Description
boolean

The isLocked.

getParserForType()

public Parser<Bucket.RetentionPolicy> getParserForType()
Returns
Type Description
Parser<RetentionPolicy>
Overrides

getRetentionPeriod()

public long getRetentionPeriod()

The duration in seconds that objects need to be retained. Retention duration must be greater than zero and less than 100 years. Note that enforcement of retention periods less than a day is not guaranteed. Such periods should only be used for testing purposes.

optional int64 retention_period = 3;

Returns
Type Description
long

The retentionPeriod.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hasEffectiveTime()

public boolean hasEffectiveTime()

Server-determined value that indicates the time from which policy was enforced and effective.

.google.protobuf.Timestamp effective_time = 1;

Returns
Type Description
boolean

Whether the effectiveTime field is set.

hasRetentionPeriod()

public boolean hasRetentionPeriod()

The duration in seconds that objects need to be retained. Retention duration must be greater than zero and less than 100 years. Note that enforcement of retention periods less than a day is not guaranteed. Such periods should only be used for testing purposes.

optional int64 retention_period = 3;

Returns
Type Description
boolean

Whether the retentionPeriod field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Bucket.RetentionPolicy.Builder newBuilderForType()
Returns
Type Description
Bucket.RetentionPolicy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Bucket.RetentionPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Bucket.RetentionPolicy.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Bucket.RetentionPolicy.Builder toBuilder()
Returns
Type Description
Bucket.RetentionPolicy.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException