Class Object.Retention (2.53.0)

public static final class Object.Retention extends GeneratedMessageV3 implements Object.RetentionOrBuilder

Specifies retention parameters of the object. Objects under retention cannot be deleted or overwritten until their retention expires.

Protobuf type google.storage.v2.Object.Retention

Static Fields

MODE_FIELD_NUMBER

public static final int MODE_FIELD_NUMBER
Field Value
Type Description
int

RETAIN_UNTIL_TIME_FIELD_NUMBER

public static final int RETAIN_UNTIL_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Object.Retention getDefaultInstance()
Returns
Type Description
Object.Retention

getDescriptor()

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

newBuilder()

public static Object.Retention.Builder newBuilder()
Returns
Type Description
Object.Retention.Builder

newBuilder(Object.Retention prototype)

public static Object.Retention.Builder newBuilder(Object.Retention prototype)
Parameter
Name Description
prototype Object.Retention
Returns
Type Description
Object.Retention.Builder

parseDelimitedFrom(InputStream input)

public static Object.Retention parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Object.Retention
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static Object.Retention parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Object.Retention
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static Object.Retention parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Object.Retention
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static Object.Retention parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Object.Retention
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static Object.Retention parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Object.Retention
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<Object.Retention> parser()
Returns
Type Description
Parser<Retention>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public Object.Retention getDefaultInstanceForType()
Returns
Type Description
Object.Retention

getMode()

public Object.Retention.Mode getMode()

Optional. The mode of the Retention.

.google.storage.v2.Object.Retention.Mode mode = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Object.Retention.Mode

The mode.

getModeValue()

public int getModeValue()

Optional. The mode of the Retention.

.google.storage.v2.Object.Retention.Mode mode = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for mode.

getParserForType()

public Parser<Object.Retention> getParserForType()
Returns
Type Description
Parser<Retention>
Overrides

getRetainUntilTime()

public Timestamp getRetainUntilTime()

Optional. The timestamp that the object needs to be retained until. Value cannot be set in the past or more than 100 years in the future.

.google.protobuf.Timestamp retain_until_time = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Timestamp

The retainUntilTime.

getRetainUntilTimeOrBuilder()

public TimestampOrBuilder getRetainUntilTimeOrBuilder()

Optional. The timestamp that the object needs to be retained until. Value cannot be set in the past or more than 100 years in the future.

.google.protobuf.Timestamp retain_until_time = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TimestampOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasRetainUntilTime()

public boolean hasRetainUntilTime()

Optional. The timestamp that the object needs to be retained until. Value cannot be set in the past or more than 100 years in the future.

.google.protobuf.Timestamp retain_until_time = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the retainUntilTime 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 Object.Retention.Builder newBuilderForType()
Returns
Type Description
Object.Retention.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Object.Retention.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Object.Retention.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public Object.Retention.Builder toBuilder()
Returns
Type Description
Object.Retention.Builder

writeTo(CodedOutputStream output)

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