Class Bucket.RetentionPolicy.Builder (2.4.5)

See more code actions.
public static final class Bucket.RetentionPolicy.Builder extends GeneratedMessageV3.Builder<Bucket.RetentionPolicy.Builder> implements Bucket.RetentionPolicyOrBuilder

Retention policy properties of a bucket.

Protobuf type google.storage.v2.Bucket.RetentionPolicy

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Bucket.RetentionPolicy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns Overrides

build()

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

buildPartial()

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

clear()

public Bucket.RetentionPolicy.Builder clear()
Returns Overrides

clearEffectiveTime()

public Bucket.RetentionPolicy.Builder clearEffectiveTime()

Server-determined value that indicates the time from which policy was enforced and effective. This value is in https://tools.ietf.org/html/rfc3339 format.

.google.protobuf.Timestamp effective_time = 1;

Returns

clearField(Descriptors.FieldDescriptor field)

public Bucket.RetentionPolicy.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns Overrides

clearIsLocked()

public Bucket.RetentionPolicy.Builder clearIsLocked()

Once locked, an object retention policy cannot be modified.

bool is_locked = 2;

Returns
Type Description
Bucket.RetentionPolicy.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Bucket.RetentionPolicy.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns Overrides

clearRetentionPeriod()

public Bucket.RetentionPolicy.Builder clearRetentionPeriod()

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.

int64 retention_period = 3;

Returns
Type Description
Bucket.RetentionPolicy.Builder

This builder for chaining.

clone()

public Bucket.RetentionPolicy.Builder clone()
Returns Overrides

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEffectiveTime()

public Timestamp getEffectiveTime()

Server-determined value that indicates the time from which policy was enforced and effective. This value is in https://tools.ietf.org/html/rfc3339 format.

.google.protobuf.Timestamp effective_time = 1;

Returns
Type Description
Timestamp

The effectiveTime.

getEffectiveTimeBuilder()

public Timestamp.Builder getEffectiveTimeBuilder()

Server-determined value that indicates the time from which policy was enforced and effective. This value is in https://tools.ietf.org/html/rfc3339 format.

.google.protobuf.Timestamp effective_time = 1;

Returns
Type Description
Builder

getEffectiveTimeOrBuilder()

public TimestampOrBuilder getEffectiveTimeOrBuilder()

Server-determined value that indicates the time from which policy was enforced and effective. This value is in https://tools.ietf.org/html/rfc3339 format.

.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.

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.

int64 retention_period = 3;

Returns
Type Description
long

The retentionPeriod.

hasEffectiveTime()

public boolean hasEffectiveTime()

Server-determined value that indicates the time from which policy was enforced and effective. This value is in https://tools.ietf.org/html/rfc3339 format.

.google.protobuf.Timestamp effective_time = 1;

Returns
Type Description
boolean

Whether the effectiveTime field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEffectiveTime(Timestamp value)

public Bucket.RetentionPolicy.Builder mergeEffectiveTime(Timestamp value)

Server-determined value that indicates the time from which policy was enforced and effective. This value is in https://tools.ietf.org/html/rfc3339 format.

.google.protobuf.Timestamp effective_time = 1;

Parameter
Name Description
value Timestamp
Returns

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Bucket.RetentionPolicy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns Overrides Exceptions
Type Description
IOException

mergeFrom(Message other)

public Bucket.RetentionPolicy.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns Overrides

mergeFrom(Bucket.RetentionPolicy other)

public Bucket.RetentionPolicy.Builder mergeFrom(Bucket.RetentionPolicy other)
Parameter
Name Description
other Bucket.RetentionPolicy
Returns

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Bucket.RetentionPolicy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns Overrides

setEffectiveTime(Timestamp value)

public Bucket.RetentionPolicy.Builder setEffectiveTime(Timestamp value)

Server-determined value that indicates the time from which policy was enforced and effective. This value is in https://tools.ietf.org/html/rfc3339 format.

.google.protobuf.Timestamp effective_time = 1;

Parameter
Name Description
value Timestamp
Returns

setEffectiveTime(Timestamp.Builder builderForValue)

public Bucket.RetentionPolicy.Builder setEffectiveTime(Timestamp.Builder builderForValue)

Server-determined value that indicates the time from which policy was enforced and effective. This value is in https://tools.ietf.org/html/rfc3339 format.

.google.protobuf.Timestamp effective_time = 1;

Parameter
Name Description
builderForValue Builder
Returns

setField(Descriptors.FieldDescriptor field, Object value)

public Bucket.RetentionPolicy.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns Overrides

setIsLocked(boolean value)

public Bucket.RetentionPolicy.Builder setIsLocked(boolean value)

Once locked, an object retention policy cannot be modified.

bool is_locked = 2;

Parameter
Name Description
value boolean

The isLocked to set.

Returns
Type Description
Bucket.RetentionPolicy.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Bucket.RetentionPolicy.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns Overrides

setRetentionPeriod(long value)

public Bucket.RetentionPolicy.Builder setRetentionPeriod(long value)

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.

int64 retention_period = 3;

Parameter
Name Description
value long

The retentionPeriod to set.

Returns
Type Description
Bucket.RetentionPolicy.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Bucket.RetentionPolicy.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns Overrides