Class UpdateDatabaseDdlMetadata.Builder (6.83.0)

public static final class UpdateDatabaseDdlMetadata.Builder extends GeneratedMessageV3.Builder<UpdateDatabaseDdlMetadata.Builder> implements UpdateDatabaseDdlMetadataOrBuilder

Metadata type for the operation returned by UpdateDatabaseDdl.

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

Static Methods

getDescriptor()

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

Methods

addActions(DdlStatementActionInfo value)

public UpdateDatabaseDdlMetadata.Builder addActions(DdlStatementActionInfo value)

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
value DdlStatementActionInfo
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder

addActions(DdlStatementActionInfo.Builder builderForValue)

public UpdateDatabaseDdlMetadata.Builder addActions(DdlStatementActionInfo.Builder builderForValue)

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
builderForValue DdlStatementActionInfo.Builder
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder

addActions(int index, DdlStatementActionInfo value)

public UpdateDatabaseDdlMetadata.Builder addActions(int index, DdlStatementActionInfo value)

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;

Parameters
Name Description
index int
value DdlStatementActionInfo
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder

addActions(int index, DdlStatementActionInfo.Builder builderForValue)

public UpdateDatabaseDdlMetadata.Builder addActions(int index, DdlStatementActionInfo.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue DdlStatementActionInfo.Builder
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder

addActionsBuilder()

public DdlStatementActionInfo.Builder addActionsBuilder()

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
DdlStatementActionInfo.Builder

addActionsBuilder(int index)

public DdlStatementActionInfo.Builder addActionsBuilder(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.Builder

addAllActions(Iterable<? extends DdlStatementActionInfo> values)

public UpdateDatabaseDdlMetadata.Builder addAllActions(Iterable<? extends DdlStatementActionInfo> values)

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
values Iterable<? extends com.google.spanner.admin.database.v1.DdlStatementActionInfo>
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder

addAllCommitTimestamps(Iterable<? extends Timestamp> values)

public UpdateDatabaseDdlMetadata.Builder addAllCommitTimestamps(Iterable<? extends Timestamp> values)

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
values Iterable<? extends com.google.protobuf.Timestamp>
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder

addAllProgress(Iterable<? extends OperationProgress> values)

public UpdateDatabaseDdlMetadata.Builder addAllProgress(Iterable<? extends OperationProgress> values)

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
values Iterable<? extends com.google.spanner.admin.database.v1.OperationProgress>
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder

addAllStatements(Iterable<String> values)

public UpdateDatabaseDdlMetadata.Builder addAllStatements(Iterable<String> values)

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
values Iterable<String>

The statements to add.

Returns
Type Description
UpdateDatabaseDdlMetadata.Builder

This builder for chaining.

addCommitTimestamps(Timestamp value)

public UpdateDatabaseDdlMetadata.Builder addCommitTimestamps(Timestamp value)

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
value Timestamp
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder

addCommitTimestamps(Timestamp.Builder builderForValue)

public UpdateDatabaseDdlMetadata.Builder addCommitTimestamps(Timestamp.Builder builderForValue)

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
builderForValue Builder
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder

addCommitTimestamps(int index, Timestamp value)

public UpdateDatabaseDdlMetadata.Builder addCommitTimestamps(int index, Timestamp value)

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;

Parameters
Name Description
index int
value Timestamp
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder

addCommitTimestamps(int index, Timestamp.Builder builderForValue)

public UpdateDatabaseDdlMetadata.Builder addCommitTimestamps(int index, Timestamp.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue Builder
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder

addCommitTimestampsBuilder()

public Timestamp.Builder addCommitTimestampsBuilder()

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
Builder

addCommitTimestampsBuilder(int index)

public Timestamp.Builder addCommitTimestampsBuilder(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
Builder

addProgress(OperationProgress value)

public UpdateDatabaseDdlMetadata.Builder addProgress(OperationProgress value)

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
value OperationProgress
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder

addProgress(OperationProgress.Builder builderForValue)

public UpdateDatabaseDdlMetadata.Builder addProgress(OperationProgress.Builder builderForValue)

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
builderForValue OperationProgress.Builder
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder

addProgress(int index, OperationProgress value)

public UpdateDatabaseDdlMetadata.Builder addProgress(int index, OperationProgress value)

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;

Parameters
Name Description
index int
value OperationProgress
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder

addProgress(int index, OperationProgress.Builder builderForValue)

public UpdateDatabaseDdlMetadata.Builder addProgress(int index, OperationProgress.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue OperationProgress.Builder
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder

addProgressBuilder()

public OperationProgress.Builder addProgressBuilder()

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
OperationProgress.Builder

addProgressBuilder(int index)

public OperationProgress.Builder addProgressBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UpdateDatabaseDdlMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder
Overrides

addStatements(String value)

public UpdateDatabaseDdlMetadata.Builder addStatements(String value)

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
value String

The statements to add.

Returns
Type Description
UpdateDatabaseDdlMetadata.Builder

This builder for chaining.

addStatementsBytes(ByteString value)

public UpdateDatabaseDdlMetadata.Builder addStatementsBytes(ByteString value)

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
value ByteString

The bytes of the statements to add.

Returns
Type Description
UpdateDatabaseDdlMetadata.Builder

This builder for chaining.

build()

public UpdateDatabaseDdlMetadata build()
Returns
Type Description
UpdateDatabaseDdlMetadata

buildPartial()

public UpdateDatabaseDdlMetadata buildPartial()
Returns
Type Description
UpdateDatabaseDdlMetadata

clear()

public UpdateDatabaseDdlMetadata.Builder clear()
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder
Overrides

clearActions()

public UpdateDatabaseDdlMetadata.Builder clearActions()

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
UpdateDatabaseDdlMetadata.Builder

clearCommitTimestamps()

public UpdateDatabaseDdlMetadata.Builder clearCommitTimestamps()

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
UpdateDatabaseDdlMetadata.Builder

clearDatabase()

public UpdateDatabaseDdlMetadata.Builder clearDatabase()

The database being modified.

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

Returns
Type Description
UpdateDatabaseDdlMetadata.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public UpdateDatabaseDdlMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public UpdateDatabaseDdlMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder
Overrides

clearProgress()

public UpdateDatabaseDdlMetadata.Builder clearProgress()

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
UpdateDatabaseDdlMetadata.Builder

clearStatements()

public UpdateDatabaseDdlMetadata.Builder clearStatements()

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
UpdateDatabaseDdlMetadata.Builder

This builder for chaining.

clearThrottled()

public UpdateDatabaseDdlMetadata.Builder clearThrottled()

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
UpdateDatabaseDdlMetadata.Builder

This builder for chaining.

clone()

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

getActionsBuilder(int index)

public DdlStatementActionInfo.Builder getActionsBuilder(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.Builder

getActionsBuilderList()

public List<DdlStatementActionInfo.Builder> getActionsBuilderList()

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<Builder>

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

getCommitTimestampsBuilder(int index)

public Timestamp.Builder getCommitTimestampsBuilder(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
Builder

getCommitTimestampsBuilderList()

public List<Timestamp.Builder> getCommitTimestampsBuilderList()

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<Builder>

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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

getProgressBuilder(int index)

public OperationProgress.Builder getProgressBuilder(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.Builder

getProgressBuilderList()

public List<OperationProgress.Builder> getProgressBuilderList()

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<Builder>

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>

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UpdateDatabaseDdlMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public UpdateDatabaseDdlMetadata.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder
Overrides

mergeFrom(UpdateDatabaseDdlMetadata other)

public UpdateDatabaseDdlMetadata.Builder mergeFrom(UpdateDatabaseDdlMetadata other)
Parameter
Name Description
other UpdateDatabaseDdlMetadata
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UpdateDatabaseDdlMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder
Overrides

removeActions(int index)

public UpdateDatabaseDdlMetadata.Builder removeActions(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
UpdateDatabaseDdlMetadata.Builder

removeCommitTimestamps(int index)

public UpdateDatabaseDdlMetadata.Builder removeCommitTimestamps(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
UpdateDatabaseDdlMetadata.Builder

removeProgress(int index)

public UpdateDatabaseDdlMetadata.Builder removeProgress(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
UpdateDatabaseDdlMetadata.Builder

setActions(int index, DdlStatementActionInfo value)

public UpdateDatabaseDdlMetadata.Builder setActions(int index, DdlStatementActionInfo value)

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;

Parameters
Name Description
index int
value DdlStatementActionInfo
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder

setActions(int index, DdlStatementActionInfo.Builder builderForValue)

public UpdateDatabaseDdlMetadata.Builder setActions(int index, DdlStatementActionInfo.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue DdlStatementActionInfo.Builder
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder

setCommitTimestamps(int index, Timestamp value)

public UpdateDatabaseDdlMetadata.Builder setCommitTimestamps(int index, Timestamp value)

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;

Parameters
Name Description
index int
value Timestamp
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder

setCommitTimestamps(int index, Timestamp.Builder builderForValue)

public UpdateDatabaseDdlMetadata.Builder setCommitTimestamps(int index, Timestamp.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue Builder
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder

setDatabase(String value)

public UpdateDatabaseDdlMetadata.Builder setDatabase(String value)

The database being modified.

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

Parameter
Name Description
value String

The database to set.

Returns
Type Description
UpdateDatabaseDdlMetadata.Builder

This builder for chaining.

setDatabaseBytes(ByteString value)

public UpdateDatabaseDdlMetadata.Builder setDatabaseBytes(ByteString value)

The database being modified.

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

Parameter
Name Description
value ByteString

The bytes for database to set.

Returns
Type Description
UpdateDatabaseDdlMetadata.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public UpdateDatabaseDdlMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder
Overrides

setProgress(int index, OperationProgress value)

public UpdateDatabaseDdlMetadata.Builder setProgress(int index, OperationProgress value)

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;

Parameters
Name Description
index int
value OperationProgress
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder

setProgress(int index, OperationProgress.Builder builderForValue)

public UpdateDatabaseDdlMetadata.Builder setProgress(int index, OperationProgress.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue OperationProgress.Builder
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public UpdateDatabaseDdlMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder
Overrides

setStatements(int index, String value)

public UpdateDatabaseDdlMetadata.Builder setStatements(int index, String value)

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

repeated string statements = 2;

Parameters
Name Description
index int

The index to set the value at.

value String

The statements to set.

Returns
Type Description
UpdateDatabaseDdlMetadata.Builder

This builder for chaining.

setThrottled(boolean value)

public UpdateDatabaseDdlMetadata.Builder setThrottled(boolean value)

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];

Parameter
Name Description
value boolean

The throttled to set.

Returns
Type Description
UpdateDatabaseDdlMetadata.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final UpdateDatabaseDdlMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UpdateDatabaseDdlMetadata.Builder
Overrides