Class UpdateDatabaseDdlMetadata (6.74.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

ACTIONS_FIELD_NUMBER

public static final int ACTIONS_FIELD_NUMBER
Field Value
Type Description
int

COMMIT_TIMESTAMPS_FIELD_NUMBER

public static final int COMMIT_TIMESTAMPS_FIELD_NUMBER
Field Value
Type Description
int

DATABASE_FIELD_NUMBER

public static final int DATABASE_FIELD_NUMBER
Field Value
Type Description
int

PROGRESS_FIELD_NUMBER

public static final int PROGRESS_FIELD_NUMBER
Field Value
Type Description
int

STATEMENTS_FIELD_NUMBER

public static final int STATEMENTS_FIELD_NUMBER
Field Value
Type Description
int

THROTTLED_FIELD_NUMBER

public static final int THROTTLED_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static UpdateDatabaseDdlMetadata getDefaultInstance()
Returns
Type Description
UpdateDatabaseDdlMetadata

getDescriptor()

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

newBuilder()

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

newBuilder(UpdateDatabaseDdlMetadata prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getActions(int index)

public DdlStatementActionInfo getActions(int index)

The brief action info for the DDL statements. actions[i] is the brief info for statements[i].

repeated .google.spanner.admin.database.v1.DdlStatementActionInfo actions = 6;

Parameter
Name Description
index int
Returns
Type Description
DdlStatementActionInfo

getActionsCount()

public int getActionsCount()

The brief action info for the DDL statements. actions[i] is the brief info for statements[i].

repeated .google.spanner.admin.database.v1.DdlStatementActionInfo actions = 6;

Returns
Type Description
int

getActionsList()

public List<DdlStatementActionInfo> getActionsList()

The brief action info for the DDL statements. actions[i] is the brief info for statements[i].

repeated .google.spanner.admin.database.v1.DdlStatementActionInfo actions = 6;

Returns
Type Description
List<DdlStatementActionInfo>

getActionsOrBuilder(int index)

public DdlStatementActionInfoOrBuilder getActionsOrBuilder(int index)

The brief action info for the DDL statements. actions[i] is the brief info for statements[i].

repeated .google.spanner.admin.database.v1.DdlStatementActionInfo actions = 6;

Parameter
Name Description
index int
Returns
Type Description
DdlStatementActionInfoOrBuilder

getActionsOrBuilderList()

public List<? extends DdlStatementActionInfoOrBuilder> getActionsOrBuilderList()

The brief action info for the DDL statements. actions[i] is the brief info for statements[i].

repeated .google.spanner.admin.database.v1.DdlStatementActionInfo actions = 6;

Returns
Type Description
List<? extends com.google.spanner.admin.database.v1.DdlStatementActionInfoOrBuilder>

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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
List<? extends com.google.protobuf.TimestampOrBuilder>

getDatabase()

public String getDatabase()

The database being modified.

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

Returns
Type Description
String

The database.

getDatabaseBytes()

public ByteString getDatabaseBytes()

The database being modified.

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

Returns
Type Description
ByteString

The bytes for database.

getDefaultInstanceForType()

public UpdateDatabaseDdlMetadata getDefaultInstanceForType()
Returns
Type Description
UpdateDatabaseDdlMetadata

getParserForType()

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

getProgress(int index)

public OperationProgress getProgress(int index)

The progress of the UpdateDatabaseDdl operations. All DDL statements will have continuously updating progress, and progress[i] is the operation progress for statements[i]. Also, 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.

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

Parameter
Name Description
index int
Returns
Type Description
OperationProgress

getProgressCount()

public int getProgressCount()

The progress of the UpdateDatabaseDdl operations. All DDL statements will have continuously updating progress, and progress[i] is the operation progress for statements[i]. Also, 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.

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

Returns
Type Description
int

getProgressList()

public List<OperationProgress> getProgressList()

The progress of the UpdateDatabaseDdl operations. All DDL statements will have continuously updating progress, and progress[i] is the operation progress for statements[i]. Also, 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.

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

Returns
Type Description
List<OperationProgress>

getProgressOrBuilder(int index)

public OperationProgressOrBuilder getProgressOrBuilder(int index)

The progress of the UpdateDatabaseDdl operations. All DDL statements will have continuously updating progress, and progress[i] is the operation progress for statements[i]. Also, 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.

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

Parameter
Name Description
index int
Returns
Type Description
OperationProgressOrBuilder

getProgressOrBuilderList()

public List<? extends OperationProgressOrBuilder> getProgressOrBuilderList()

The progress of the UpdateDatabaseDdl operations. All DDL statements will have continuously updating progress, and progress[i] is the operation progress for statements[i]. Also, 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.

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

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Name Description
index int

The index of the value to return.

Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
boolean

The throttled.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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