Specifies the expiration behavior of a free instance. The default of
ExpireBehavior is REMOVE_AFTER_GRACE_PERIOD. This can be modified during
or after creation, and before expiration.
Specifies the expiration behavior of a free instance. The default of
ExpireBehavior is REMOVE_AFTER_GRACE_PERIOD. This can be modified during
or after creation, and before expiration.
The enum numeric value on the wire for expireBehavior.
getExpireTime()
publicabstractTimestampgetExpireTime()
Output only. Timestamp after which the instance will either be upgraded or
scheduled for deletion after a grace period. ExpireBehavior is used to
choose between upgrading or scheduling the free instance for deletion. This
timestamp is set during the creation of a free instance.
Output only. Timestamp after which the instance will either be upgraded or
scheduled for deletion after a grace period. ExpireBehavior is used to
choose between upgrading or scheduling the free instance for deletion. This
timestamp is set during the creation of a free instance.
Output only. Timestamp after which the instance will either be upgraded or
scheduled for deletion after a grace period. ExpireBehavior is used to
choose between upgrading or scheduling the free instance for deletion. This
timestamp is set during the creation of a free instance.
[[["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-08-28 UTC."],[],[],null,["# Interface FreeInstanceMetadataOrBuilder (6.98.1)\n\nVersion latestkeyboard_arrow_down\n\n- [6.98.1 (latest)](/java/docs/reference/google-cloud-spanner/latest/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.98.0](/java/docs/reference/google-cloud-spanner/6.98.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.97.1](/java/docs/reference/google-cloud-spanner/6.97.1/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.96.1](/java/docs/reference/google-cloud-spanner/6.96.1/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.95.1](/java/docs/reference/google-cloud-spanner/6.95.1/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.94.0](/java/docs/reference/google-cloud-spanner/6.94.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.93.0](/java/docs/reference/google-cloud-spanner/6.93.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.89.0](/java/docs/reference/google-cloud-spanner/6.89.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.88.0](/java/docs/reference/google-cloud-spanner/6.88.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.87.0](/java/docs/reference/google-cloud-spanner/6.87.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.86.0](/java/docs/reference/google-cloud-spanner/6.86.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.85.0](/java/docs/reference/google-cloud-spanner/6.85.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.83.0](/java/docs/reference/google-cloud-spanner/6.83.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.82.0](/java/docs/reference/google-cloud-spanner/6.82.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.80.1](/java/docs/reference/google-cloud-spanner/6.80.1/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.79.0](/java/docs/reference/google-cloud-spanner/6.79.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.77.0](/java/docs/reference/google-cloud-spanner/6.77.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.74.1](/java/docs/reference/google-cloud-spanner/6.74.1/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.72.0](/java/docs/reference/google-cloud-spanner/6.72.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.71.0](/java/docs/reference/google-cloud-spanner/6.71.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.69.0](/java/docs/reference/google-cloud-spanner/6.69.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.68.0](/java/docs/reference/google-cloud-spanner/6.68.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.66.0](/java/docs/reference/google-cloud-spanner/6.66.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.65.1](/java/docs/reference/google-cloud-spanner/6.65.1/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.62.0](/java/docs/reference/google-cloud-spanner/6.62.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.60.0](/java/docs/reference/google-cloud-spanner/6.60.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.58.0](/java/docs/reference/google-cloud-spanner/6.58.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.57.0](/java/docs/reference/google-cloud-spanner/6.57.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.56.0](/java/docs/reference/google-cloud-spanner/6.56.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.55.0](/java/docs/reference/google-cloud-spanner/6.55.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.54.0](/java/docs/reference/google-cloud-spanner/6.54.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.53.0](/java/docs/reference/google-cloud-spanner/6.53.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.52.1](/java/docs/reference/google-cloud-spanner/6.52.1/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.51.0](/java/docs/reference/google-cloud-spanner/6.51.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.50.1](/java/docs/reference/google-cloud-spanner/6.50.1/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.49.0](/java/docs/reference/google-cloud-spanner/6.49.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.25.1](/java/docs/reference/google-cloud-spanner/6.25.1/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.24.0](/java/docs/reference/google-cloud-spanner/6.24.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.23.4](/java/docs/reference/google-cloud-spanner/6.23.4/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.22.0](/java/docs/reference/google-cloud-spanner/6.22.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.21.2](/java/docs/reference/google-cloud-spanner/6.21.2/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.20.0](/java/docs/reference/google-cloud-spanner/6.20.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.19.1](/java/docs/reference/google-cloud-spanner/6.19.1/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.18.0](/java/docs/reference/google-cloud-spanner/6.18.0/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.17.4](/java/docs/reference/google-cloud-spanner/6.17.4/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder)\n- [6.14.1](/java/docs/reference/google-cloud-spanner/6.14.1/com.google.spanner.admin.instance.v1.FreeInstanceMetadataOrBuilder) \n\n public interface FreeInstanceMetadataOrBuilder 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### getExpireBehavior()\n\n public abstract FreeInstanceMetadata.ExpireBehavior getExpireBehavior()\n\nSpecifies the expiration behavior of a free instance. The default of\nExpireBehavior is `REMOVE_AFTER_GRACE_PERIOD`. This can be modified during\nor after creation, and before expiration.\n\n`\n.google.spanner.admin.instance.v1.FreeInstanceMetadata.ExpireBehavior expire_behavior = 3;\n`\n\n### getExpireBehaviorValue()\n\n public abstract int getExpireBehaviorValue()\n\nSpecifies the expiration behavior of a free instance. The default of\nExpireBehavior is `REMOVE_AFTER_GRACE_PERIOD`. This can be modified during\nor after creation, and before expiration.\n\n`\n.google.spanner.admin.instance.v1.FreeInstanceMetadata.ExpireBehavior expire_behavior = 3;\n`\n\n### getExpireTime()\n\n public abstract Timestamp getExpireTime()\n\nOutput only. Timestamp after which the instance will either be upgraded or\nscheduled for deletion after a grace period. ExpireBehavior is used to\nchoose between upgrading or scheduling the free instance for deletion. This\ntimestamp is set during the creation of a free instance.\n\n`.google.protobuf.Timestamp expire_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];\n`\n\n### getExpireTimeOrBuilder()\n\n public abstract TimestampOrBuilder getExpireTimeOrBuilder()\n\nOutput only. Timestamp after which the instance will either be upgraded or\nscheduled for deletion after a grace period. ExpireBehavior is used to\nchoose between upgrading or scheduling the free instance for deletion. This\ntimestamp is set during the creation of a free instance.\n\n`.google.protobuf.Timestamp expire_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];\n`\n\n### getUpgradeTime()\n\n public abstract Timestamp getUpgradeTime()\n\nOutput only. If present, the timestamp at which the free instance was\nupgraded to a provisioned instance.\n\n`.google.protobuf.Timestamp upgrade_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];\n`\n\n### getUpgradeTimeOrBuilder()\n\n public abstract TimestampOrBuilder getUpgradeTimeOrBuilder()\n\nOutput only. If present, the timestamp at which the free instance was\nupgraded to a provisioned instance.\n\n`.google.protobuf.Timestamp upgrade_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];\n`\n\n### hasExpireTime()\n\n public abstract boolean hasExpireTime()\n\nOutput only. Timestamp after which the instance will either be upgraded or\nscheduled for deletion after a grace period. ExpireBehavior is used to\nchoose between upgrading or scheduling the free instance for deletion. This\ntimestamp is set during the creation of a free instance.\n\n`.google.protobuf.Timestamp expire_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];\n`\n\n### hasUpgradeTime()\n\n public abstract boolean hasUpgradeTime()\n\nOutput only. If present, the timestamp at which the free instance was\nupgraded to a provisioned instance.\n\n`.google.protobuf.Timestamp upgrade_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];\n`"]]
