Reference documentation and code samples for the Cloud Spanner V1 Client class UpdateDatabaseDdlMetadata.
Metadata type for the operation returned by UpdateDatabaseDdl.
Generated from protobuf message google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata
Namespace
Google \ Cloud \ Spanner \ Admin \ Database \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ database |
string
The database being modified. |
↳ statements |
array
For an update this list contains all the statements. For an individual statement, this list contains only that statement. |
↳ commit_timestamps |
array<Google\Protobuf\Timestamp>
Reports the commit timestamps of all statements that have succeeded so far, where |
↳ throttled |
bool
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. |
↳ progress |
array<Google\Cloud\Spanner\Admin\Database\V1\OperationProgress>
The progress of the UpdateDatabaseDdl operations. All DDL statements will have continuously updating progress, and |
↳ actions |
array<Google\Cloud\Spanner\Admin\Database\V1\DdlStatementActionInfo>
The brief action info for the DDL statements. |
getDatabase
The database being modified.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDatabase
The database being modified.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStatements
For an update this list contains all the statements. For an individual statement, this list contains only that statement.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setStatements
For an update this list contains all the statements. For an individual statement, this list contains only that statement.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCommitTimestamps
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].
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setCommitTimestamps
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].
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Protobuf\Timestamp>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setThrottled
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.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProgress
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setProgress
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Spanner\Admin\Database\V1\OperationProgress>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getActions
The brief action info for the DDL statements.
actions[i] is the brief info for statements[i].
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setActions
The brief action info for the DDL statements.
actions[i] is the brief info for statements[i].
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Spanner\Admin\Database\V1\DdlStatementActionInfo>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|