Class PutObjectHold.Builder (0.13.0)
Note: Some or all of the information on this page might not apply
to Trusted Cloud. For a list of services that are available in
Trusted Cloud, see Services available for
Trusted Cloud .
Version latestkeyboard_arrow_down
public static final class PutObjectHold . Builder extends GeneratedMessageV3 . Builder<PutObjectHold . Builder > implements PutObjectHoldOrBuilder
Describes options to update object hold.
Protobuf type google.cloud.storagebatchoperations.v1.PutObjectHold
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PutObjectHold . Builder addRepeatedField ( Descriptors . FieldDescriptor field , Object value )
Overrides
build()
public PutObjectHold build ()
buildPartial()
public PutObjectHold buildPartial ()
clear()
public PutObjectHold . Builder clear ()
Overrides
clearEventBasedHold()
public PutObjectHold . Builder clearEventBasedHold ()
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];
clearField(Descriptors.FieldDescriptor field)
public PutObjectHold . Builder clearField ( Descriptors . FieldDescriptor field )
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public PutObjectHold . Builder clearOneof ( Descriptors . OneofDescriptor oneof )
Overrides
clearTemporaryHold()
public PutObjectHold . Builder clearTemporaryHold ()
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];
clone()
public PutObjectHold . Builder clone ()
Overrides
getDefaultInstanceForType()
public PutObjectHold getDefaultInstanceForType ()
getDescriptorForType()
public Descriptors . Descriptor getDescriptorForType ()
Overrides
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];
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.
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];
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.
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
mergeFrom(PutObjectHold other)
public PutObjectHold . Builder mergeFrom ( PutObjectHold other )
public PutObjectHold . Builder mergeFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Overrides
mergeFrom(Message other)
public PutObjectHold . Builder mergeFrom ( Message other )
Parameter
Name
Description
other
Message
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PutObjectHold . Builder mergeUnknownFields ( UnknownFieldSet unknownFields )
Overrides
setEventBasedHold(PutObjectHold.HoldStatus value)
public PutObjectHold . Builder setEventBasedHold ( PutObjectHold . HoldStatus value )
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];
setEventBasedHoldValue(int value)
public PutObjectHold . Builder setEventBasedHoldValue ( int value )
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];
Parameter
Name
Description
value
int
The enum numeric value on the wire for eventBasedHold to set.
setField(Descriptors.FieldDescriptor field, Object value)
public PutObjectHold . Builder setField ( Descriptors . FieldDescriptor field , Object value )
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PutObjectHold . Builder setRepeatedField ( Descriptors . FieldDescriptor field , int index , Object value )
Overrides
setTemporaryHold(PutObjectHold.HoldStatus value)
public PutObjectHold . Builder setTemporaryHold ( PutObjectHold . HoldStatus value )
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];
setTemporaryHoldValue(int value)
public PutObjectHold . Builder setTemporaryHoldValue ( int value )
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];
Parameter
Name
Description
value
int
The enum numeric value on the wire for temporaryHold to set.
setUnknownFields(UnknownFieldSet unknownFields)
public final PutObjectHold . Builder setUnknownFields ( UnknownFieldSet unknownFields )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-02 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-02 UTC."],[],[],null,[]]