Optional. The duration 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. Any nanos value
specified will be rounded down to the nearest second.
Optional. The duration 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. Any nanos value
specified will be rounded down to the nearest second.
Optional. The duration 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. Any nanos value
specified will be rounded down to the nearest second.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Interface Bucket.RetentionPolicyOrBuilder (2.55.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.55.0 (latest)](/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.54.0](/java/docs/reference/google-cloud-storage/2.54.0/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.53.3](/java/docs/reference/google-cloud-storage/2.53.3/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.52.3](/java/docs/reference/google-cloud-storage/2.52.3/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.50.0](/java/docs/reference/google-cloud-storage/2.50.0/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.49.0](/java/docs/reference/google-cloud-storage/2.49.0/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.48.2](/java/docs/reference/google-cloud-storage/2.48.2/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.47.0](/java/docs/reference/google-cloud-storage/2.47.0/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.46.0](/java/docs/reference/google-cloud-storage/2.46.0/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.45.0](/java/docs/reference/google-cloud-storage/2.45.0/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.44.1](/java/docs/reference/google-cloud-storage/2.44.1/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.43.2](/java/docs/reference/google-cloud-storage/2.43.2/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.42.0](/java/docs/reference/google-cloud-storage/2.42.0/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.41.0](/java/docs/reference/google-cloud-storage/2.41.0/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.40.1](/java/docs/reference/google-cloud-storage/2.40.1/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.39.0](/java/docs/reference/google-cloud-storage/2.39.0/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.38.0](/java/docs/reference/google-cloud-storage/2.38.0/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.37.0](/java/docs/reference/google-cloud-storage/2.37.0/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.36.1](/java/docs/reference/google-cloud-storage/2.36.1/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.34.0](/java/docs/reference/google-cloud-storage/2.34.0/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.33.0](/java/docs/reference/google-cloud-storage/2.33.0/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.32.1](/java/docs/reference/google-cloud-storage/2.32.1/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.30.1](/java/docs/reference/google-cloud-storage/2.30.1/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.29.1](/java/docs/reference/google-cloud-storage/2.29.1/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.28.0](/java/docs/reference/google-cloud-storage/2.28.0/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.27.1](/java/docs/reference/google-cloud-storage/2.27.1/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.24.0](/java/docs/reference/google-cloud-storage/2.24.0/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.23.0](/java/docs/reference/google-cloud-storage/2.23.0/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.22.6](/java/docs/reference/google-cloud-storage/2.22.6/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.21.0](/java/docs/reference/google-cloud-storage/2.21.0/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.20.2](/java/docs/reference/google-cloud-storage/2.20.2/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.19.0](/java/docs/reference/google-cloud-storage/2.19.0/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.18.0](/java/docs/reference/google-cloud-storage/2.18.0/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.17.2](/java/docs/reference/google-cloud-storage/2.17.2/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.16.0](/java/docs/reference/google-cloud-storage/2.16.0/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.15.1](/java/docs/reference/google-cloud-storage/2.15.1/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.14.0](/java/docs/reference/google-cloud-storage/2.14.0/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.13.1](/java/docs/reference/google-cloud-storage/2.13.1/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.12.0](/java/docs/reference/google-cloud-storage/2.12.0/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.11.3](/java/docs/reference/google-cloud-storage/2.11.3/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.10.0](/java/docs/reference/google-cloud-storage/2.10.0/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.9.3](/java/docs/reference/google-cloud-storage/2.9.3/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.8.1](/java/docs/reference/google-cloud-storage/2.8.1/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.7.1](/java/docs/reference/google-cloud-storage/2.7.1/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.6.1](/java/docs/reference/google-cloud-storage/2.6.1/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.5.1](/java/docs/reference/google-cloud-storage/2.5.1/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.4.5](/java/docs/reference/google-cloud-storage/2.4.5/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.3.0](/java/docs/reference/google-cloud-storage/2.3.0/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.2.3](/java/docs/reference/google-cloud-storage/2.2.3/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder)\n- [2.1.10](/java/docs/reference/google-cloud-storage/2.1.10/com.google.storage.v2.Bucket.RetentionPolicyOrBuilder) \n\n public static interface Bucket.RetentionPolicyOrBuilder extends MessageOrBuilder\n\nImplements\n----------\n\n[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)\n\nMethods\n-------\n\n### getEffectiveTime()\n\n public abstract Timestamp getEffectiveTime()\n\nOptional. Server-determined value that indicates the time from which\npolicy was enforced and effective.\n\n`\n.google.protobuf.Timestamp effective_time = 1 [(.google.api.field_behavior) = OPTIONAL];\n`\n\n### getEffectiveTimeOrBuilder()\n\n public abstract TimestampOrBuilder getEffectiveTimeOrBuilder()\n\nOptional. Server-determined value that indicates the time from which\npolicy was enforced and effective.\n\n`\n.google.protobuf.Timestamp effective_time = 1 [(.google.api.field_behavior) = OPTIONAL];\n`\n\n### getIsLocked()\n\n public abstract boolean getIsLocked()\n\nOptional. Once locked, an object retention policy cannot be modified.\n\n`bool is_locked = 2 [(.google.api.field_behavior) = OPTIONAL];`\n\n### getRetentionDuration()\n\n public abstract Duration getRetentionDuration()\n\nOptional. The duration that objects need to be retained. Retention\nduration must be greater than zero and less than 100 years. Note that\nenforcement of retention periods less than a day is not guaranteed. Such\nperiods should only be used for testing purposes. Any `nanos` value\nspecified will be rounded down to the nearest second.\n\n`\n.google.protobuf.Duration retention_duration = 4 [(.google.api.field_behavior) = OPTIONAL];\n`\n\n### getRetentionDurationOrBuilder()\n\n public abstract DurationOrBuilder getRetentionDurationOrBuilder()\n\nOptional. The duration that objects need to be retained. Retention\nduration must be greater than zero and less than 100 years. Note that\nenforcement of retention periods less than a day is not guaranteed. Such\nperiods should only be used for testing purposes. Any `nanos` value\nspecified will be rounded down to the nearest second.\n\n`\n.google.protobuf.Duration retention_duration = 4 [(.google.api.field_behavior) = OPTIONAL];\n`\n\n### hasEffectiveTime()\n\n public abstract boolean hasEffectiveTime()\n\nOptional. Server-determined value that indicates the time from which\npolicy was enforced and effective.\n\n`\n.google.protobuf.Timestamp effective_time = 1 [(.google.api.field_behavior) = OPTIONAL];\n`\n\n### hasRetentionDuration()\n\n public abstract boolean hasRetentionDuration()\n\nOptional. The duration that objects need to be retained. Retention\nduration must be greater than zero and less than 100 years. Note that\nenforcement of retention periods less than a day is not guaranteed. Such\nperiods should only be used for testing purposes. Any `nanos` value\nspecified will be rounded down to the nearest second.\n\n`\n.google.protobuf.Duration retention_duration = 4 [(.google.api.field_behavior) = OPTIONAL];\n`"]]