Class PutObjectHold (0.2.0)

public final class PutObjectHold extends GeneratedMessageV3 implements PutObjectHoldOrBuilder

Describes options to update object hold.

Protobuf type google.cloud.storagebatchoperations.v1.PutObjectHold

Static Fields

EVENT_BASED_HOLD_FIELD_NUMBER

public static final int EVENT_BASED_HOLD_FIELD_NUMBER
Field Value
Type Description
int

TEMPORARY_HOLD_FIELD_NUMBER

public static final int TEMPORARY_HOLD_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PutObjectHold getDefaultInstance()
Returns
Type Description
PutObjectHold

getDescriptor()

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

newBuilder()

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

newBuilder(PutObjectHold prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public PutObjectHold getDefaultInstanceForType()
Returns
Type Description
PutObjectHold

getEventBasedHold()

public PutObjectHold.HoldStatus getEventBasedHold()

Required. Updates object event based holds state. When object event based hold is set, object cannot be deleted or replaced. Resets object's time in the bucket for the purposes of the retention period.

.google.cloud.storagebatchoperations.v1.PutObjectHold.HoldStatus event_based_hold = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
PutObjectHold.HoldStatus

The eventBasedHold.

getEventBasedHoldValue()

public int getEventBasedHoldValue()

Required. Updates object event based holds state. When object event based hold is set, object cannot be deleted or replaced. Resets object's time in the bucket for the purposes of the retention period.

.google.cloud.storagebatchoperations.v1.PutObjectHold.HoldStatus event_based_hold = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for eventBasedHold.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTemporaryHold()

public PutObjectHold.HoldStatus getTemporaryHold()

Required. Updates object temporary holds state. When object temporary hold is set, object cannot be deleted or replaced.

.google.cloud.storagebatchoperations.v1.PutObjectHold.HoldStatus temporary_hold = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
PutObjectHold.HoldStatus

The temporaryHold.

getTemporaryHoldValue()

public int getTemporaryHoldValue()

Required. Updates object temporary holds state. When object temporary hold is set, object cannot be deleted or replaced.

.google.cloud.storagebatchoperations.v1.PutObjectHold.HoldStatus temporary_hold = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for temporaryHold.

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 PutObjectHold.Builder newBuilderForType()
Returns
Type Description
PutObjectHold.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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