Class UpdateDatabaseDdlMetadata (6.25.1)

public final class UpdateDatabaseDdlMetadata extends GeneratedMessageV3 implements UpdateDatabaseDdlMetadataOrBuilder

Metadata type for the operation returned by UpdateDatabaseDdl.

Protobuf type google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata

Static Fields

COMMIT_TIMESTAMPS_FIELD_NUMBER

public static final int COMMIT_TIMESTAMPS_FIELD_NUMBER
Field Value
TypeDescription
int

DATABASE_FIELD_NUMBER

public static final int DATABASE_FIELD_NUMBER
Field Value
TypeDescription
int

PROGRESS_FIELD_NUMBER

public static final int PROGRESS_FIELD_NUMBER
Field Value
TypeDescription
int

STATEMENTS_FIELD_NUMBER

public static final int STATEMENTS_FIELD_NUMBER
Field Value
TypeDescription
int

THROTTLED_FIELD_NUMBER

public static final int THROTTLED_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static UpdateDatabaseDdlMetadata getDefaultInstance()
Returns
TypeDescription
UpdateDatabaseDdlMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static UpdateDatabaseDdlMetadata.Builder newBuilder()
Returns
TypeDescription
UpdateDatabaseDdlMetadata.Builder

newBuilder(UpdateDatabaseDdlMetadata prototype)

public static UpdateDatabaseDdlMetadata.Builder newBuilder(UpdateDatabaseDdlMetadata prototype)
Parameter
NameDescription
prototypeUpdateDatabaseDdlMetadata
Returns
TypeDescription
UpdateDatabaseDdlMetadata.Builder

parseDelimitedFrom(InputStream input)

public static UpdateDatabaseDdlMetadata parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UpdateDatabaseDdlMetadata
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateDatabaseDdlMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateDatabaseDdlMetadata
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static UpdateDatabaseDdlMetadata parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
UpdateDatabaseDdlMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UpdateDatabaseDdlMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateDatabaseDdlMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UpdateDatabaseDdlMetadata parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
UpdateDatabaseDdlMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UpdateDatabaseDdlMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateDatabaseDdlMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UpdateDatabaseDdlMetadata parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
UpdateDatabaseDdlMetadata
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateDatabaseDdlMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateDatabaseDdlMetadata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static UpdateDatabaseDdlMetadata parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UpdateDatabaseDdlMetadata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateDatabaseDdlMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateDatabaseDdlMetadata
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static UpdateDatabaseDdlMetadata parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
UpdateDatabaseDdlMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UpdateDatabaseDdlMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateDatabaseDdlMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<UpdateDatabaseDdlMetadata> parser()
Returns
TypeDescription
Parser<UpdateDatabaseDdlMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCommitTimestamps(int index)

public Timestamp getCommitTimestamps(int index)

Reports the commit timestamps of all statements that have succeeded so far, where commit_timestamps[i] is the commit timestamp for the statement statements[i].

repeated .google.protobuf.Timestamp commit_timestamps = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
Timestamp

getCommitTimestampsCount()

public int getCommitTimestampsCount()

Reports the commit timestamps of all statements that have succeeded so far, where commit_timestamps[i] is the commit timestamp for the statement statements[i].

repeated .google.protobuf.Timestamp commit_timestamps = 3;

Returns
TypeDescription
int

getCommitTimestampsList()

public List<Timestamp> getCommitTimestampsList()

Reports the commit timestamps of all statements that have succeeded so far, where commit_timestamps[i] is the commit timestamp for the statement statements[i].

repeated .google.protobuf.Timestamp commit_timestamps = 3;

Returns
TypeDescription
List<Timestamp>

getCommitTimestampsOrBuilder(int index)

public TimestampOrBuilder getCommitTimestampsOrBuilder(int index)

Reports the commit timestamps of all statements that have succeeded so far, where commit_timestamps[i] is the commit timestamp for the statement statements[i].

repeated .google.protobuf.Timestamp commit_timestamps = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
TimestampOrBuilder

getCommitTimestampsOrBuilderList()

public List<? extends TimestampOrBuilder> getCommitTimestampsOrBuilderList()

Reports the commit timestamps of all statements that have succeeded so far, where commit_timestamps[i] is the commit timestamp for the statement statements[i].

repeated .google.protobuf.Timestamp commit_timestamps = 3;

Returns
TypeDescription
List<? extends com.google.protobuf.TimestampOrBuilder>

getDatabase()

public String getDatabase()

The database being modified.

string database = 1 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The database.

getDatabaseBytes()

public ByteString getDatabaseBytes()

The database being modified.

string database = 1 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for database.

getDefaultInstanceForType()

public UpdateDatabaseDdlMetadata getDefaultInstanceForType()
Returns
TypeDescription
UpdateDatabaseDdlMetadata

getParserForType()

public Parser<UpdateDatabaseDdlMetadata> getParserForType()
Returns
TypeDescription
Parser<UpdateDatabaseDdlMetadata>
Overrides

getProgress(int index)

public OperationProgress getProgress(int index)

The progress of the UpdateDatabaseDdl operations. Currently, only index creation statements will have a continuously updating progress. For non-index creation statements, progress[i] will have start time and end time populated with commit timestamp of operation, as well as a progress of 100% once the operation has completed. progress[i] is the operation progress for statements[i].

repeated .google.spanner.admin.database.v1.OperationProgress progress = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
OperationProgress

getProgressCount()

public int getProgressCount()

The progress of the UpdateDatabaseDdl operations. Currently, only index creation statements will have a continuously updating progress. For non-index creation statements, progress[i] will have start time and end time populated with commit timestamp of operation, as well as a progress of 100% once the operation has completed. progress[i] is the operation progress for statements[i].

repeated .google.spanner.admin.database.v1.OperationProgress progress = 5;

Returns
TypeDescription
int

getProgressList()

public List<OperationProgress> getProgressList()

The progress of the UpdateDatabaseDdl operations. Currently, only index creation statements will have a continuously updating progress. For non-index creation statements, progress[i] will have start time and end time populated with commit timestamp of operation, as well as a progress of 100% once the operation has completed. progress[i] is the operation progress for statements[i].

repeated .google.spanner.admin.database.v1.OperationProgress progress = 5;

Returns
TypeDescription
List<OperationProgress>

getProgressOrBuilder(int index)

public OperationProgressOrBuilder getProgressOrBuilder(int index)

The progress of the UpdateDatabaseDdl operations. Currently, only index creation statements will have a continuously updating progress. For non-index creation statements, progress[i] will have start time and end time populated with commit timestamp of operation, as well as a progress of 100% once the operation has completed. progress[i] is the operation progress for statements[i].

repeated .google.spanner.admin.database.v1.OperationProgress progress = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
OperationProgressOrBuilder

getProgressOrBuilderList()

public List<? extends OperationProgressOrBuilder> getProgressOrBuilderList()

The progress of the UpdateDatabaseDdl operations. Currently, only index creation statements will have a continuously updating progress. For non-index creation statements, progress[i] will have start time and end time populated with commit timestamp of operation, as well as a progress of 100% once the operation has completed. progress[i] is the operation progress for statements[i].

repeated .google.spanner.admin.database.v1.OperationProgress progress = 5;

Returns
TypeDescription
List<? extends com.google.spanner.admin.database.v1.OperationProgressOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStatements(int index)

public String getStatements(int index)

For an update this list contains all the statements. For an individual statement, this list contains only that statement.

repeated string statements = 2;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The statements at the given index.

getStatementsBytes(int index)

public ByteString getStatementsBytes(int index)

For an update this list contains all the statements. For an individual statement, this list contains only that statement.

repeated string statements = 2;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the statements at the given index.

getStatementsCount()

public int getStatementsCount()

For an update this list contains all the statements. For an individual statement, this list contains only that statement.

repeated string statements = 2;

Returns
TypeDescription
int

The count of statements.

getStatementsList()

public ProtocolStringList getStatementsList()

For an update this list contains all the statements. For an individual statement, this list contains only that statement.

repeated string statements = 2;

Returns
TypeDescription
ProtocolStringList

A list containing the statements.

getThrottled()

public boolean getThrottled()

Output only. When true, indicates that the operation is throttled e.g due to resource constraints. When resources become available the operation will resume and this field will be false again.

bool throttled = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

The throttled.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public UpdateDatabaseDdlMetadata.Builder newBuilderForType()
Returns
TypeDescription
UpdateDatabaseDdlMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UpdateDatabaseDdlMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
UpdateDatabaseDdlMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public UpdateDatabaseDdlMetadata.Builder toBuilder()
Returns
TypeDescription
UpdateDatabaseDdlMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException