Class FreeInstanceMetadata (6.85.0)

public final class FreeInstanceMetadata extends GeneratedMessageV3 implements FreeInstanceMetadataOrBuilder

Free instance specific metadata that is kept even after an instance has been upgraded for tracking purposes.

Protobuf type google.spanner.admin.instance.v1.FreeInstanceMetadata

Static Fields

EXPIRE_BEHAVIOR_FIELD_NUMBER

public static final int EXPIRE_BEHAVIOR_FIELD_NUMBER
Field Value
Type Description
int

EXPIRE_TIME_FIELD_NUMBER

public static final int EXPIRE_TIME_FIELD_NUMBER
Field Value
Type Description
int

UPGRADE_TIME_FIELD_NUMBER

public static final int UPGRADE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static FreeInstanceMetadata getDefaultInstance()
Returns
Type Description
FreeInstanceMetadata

getDescriptor()

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

newBuilder()

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

newBuilder(FreeInstanceMetadata prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public FreeInstanceMetadata getDefaultInstanceForType()
Returns
Type Description
FreeInstanceMetadata

getExpireBehavior()

public FreeInstanceMetadata.ExpireBehavior getExpireBehavior()

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.

.google.spanner.admin.instance.v1.FreeInstanceMetadata.ExpireBehavior expire_behavior = 3;

Returns
Type Description
FreeInstanceMetadata.ExpireBehavior

The expireBehavior.

getExpireBehaviorValue()

public int getExpireBehaviorValue()

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.

.google.spanner.admin.instance.v1.FreeInstanceMetadata.ExpireBehavior expire_behavior = 3;

Returns
Type Description
int

The enum numeric value on the wire for expireBehavior.

getExpireTime()

public Timestamp getExpireTime()

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.

.google.protobuf.Timestamp expire_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The expireTime.

getExpireTimeOrBuilder()

public TimestampOrBuilder getExpireTimeOrBuilder()

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.

.google.protobuf.Timestamp expire_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUpgradeTime()

public Timestamp getUpgradeTime()

Output only. If present, the timestamp at which the free instance was upgraded to a provisioned instance.

.google.protobuf.Timestamp upgrade_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The upgradeTime.

getUpgradeTimeOrBuilder()

public TimestampOrBuilder getUpgradeTimeOrBuilder()

Output only. If present, the timestamp at which the free instance was upgraded to a provisioned instance.

.google.protobuf.Timestamp upgrade_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasExpireTime()

public boolean hasExpireTime()

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.

.google.protobuf.Timestamp expire_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the expireTime field is set.

hasUpgradeTime()

public boolean hasUpgradeTime()

Output only. If present, the timestamp at which the free instance was upgraded to a provisioned instance.

.google.protobuf.Timestamp upgrade_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the upgradeTime field is set.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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