Class ObjectRetention (0.22.0)

public final class ObjectRetention extends GeneratedMessageV3 implements ObjectRetentionOrBuilder

Describes options for object retention update.

Protobuf type google.cloud.storagebatchoperations.v1.ObjectRetention

Static Fields

RETAIN_UNTIL_TIME_FIELD_NUMBER

public static final int RETAIN_UNTIL_TIME_FIELD_NUMBER
Field Value
Type Description
int

RETENTION_MODE_FIELD_NUMBER

public static final int RETENTION_MODE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ObjectRetention getDefaultInstance()
Returns
Type Description
ObjectRetention

getDescriptor()

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

newBuilder()

public static ObjectRetention.Builder newBuilder()
Returns
Type Description
ObjectRetention.Builder

newBuilder(ObjectRetention prototype)

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

parseDelimitedFrom(InputStream input)

public static ObjectRetention parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ObjectRetention
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static ObjectRetention parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ObjectRetention
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static ObjectRetention parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ObjectRetention
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static ObjectRetention parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ObjectRetention
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static ObjectRetention parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ObjectRetention
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<ObjectRetention> parser()
Returns
Type Description
Parser<ObjectRetention>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ObjectRetention getDefaultInstanceForType()
Returns
Type Description
ObjectRetention

getParserForType()

public Parser<ObjectRetention> getParserForType()
Returns
Type Description
Parser<ObjectRetention>
Overrides

getRetainUntilTime()

public String getRetainUntilTime()

Required. The time when the object will be retained until. UNSET will clear the retention. Must be specified in RFC 3339 format e.g. YYYY-MM-DD'T'HH:MM:SS.SS'Z' or YYYY-MM-DD'T'HH:MM:SS'Z'.

optional string retain_until_time = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The retainUntilTime.

getRetainUntilTimeBytes()

public ByteString getRetainUntilTimeBytes()

Required. The time when the object will be retained until. UNSET will clear the retention. Must be specified in RFC 3339 format e.g. YYYY-MM-DD'T'HH:MM:SS.SS'Z' or YYYY-MM-DD'T'HH:MM:SS'Z'.

optional string retain_until_time = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for retainUntilTime.

getRetentionMode()

public ObjectRetention.RetentionMode getRetentionMode()

Required. The retention mode of the object.

optional .google.cloud.storagebatchoperations.v1.ObjectRetention.RetentionMode retention_mode = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ObjectRetention.RetentionMode

The retentionMode.

getRetentionModeValue()

public int getRetentionModeValue()

Required. The retention mode of the object.

optional .google.cloud.storagebatchoperations.v1.ObjectRetention.RetentionMode retention_mode = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for retentionMode.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasRetainUntilTime()

public boolean hasRetainUntilTime()

Required. The time when the object will be retained until. UNSET will clear the retention. Must be specified in RFC 3339 format e.g. YYYY-MM-DD'T'HH:MM:SS.SS'Z' or YYYY-MM-DD'T'HH:MM:SS'Z'.

optional string retain_until_time = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the retainUntilTime field is set.

hasRetentionMode()

public boolean hasRetentionMode()

Required. The retention mode of the object.

optional .google.cloud.storagebatchoperations.v1.ObjectRetention.RetentionMode retention_mode = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the retentionMode 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 ObjectRetention.Builder newBuilderForType()
Returns
Type Description
ObjectRetention.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public ObjectRetention.Builder toBuilder()
Returns
Type Description
ObjectRetention.Builder

writeTo(CodedOutputStream output)

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