Class protos.google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata (6.13.0)

Represents an UpdateDatabaseDdlMetadata.

Package

@google-cloud/spanner

Constructors

(constructor)(properties)

constructor(properties?: google.spanner.admin.database.v1.IUpdateDatabaseDdlMetadata);

Constructs a new UpdateDatabaseDdlMetadata.

Parameter
NameDescription
properties IUpdateDatabaseDdlMetadata

Properties to set

Properties

actions

public actions: google.spanner.admin.database.v1.IDdlStatementActionInfo[];

UpdateDatabaseDdlMetadata actions.

commitTimestamps

public commitTimestamps: google.protobuf.ITimestamp[];

UpdateDatabaseDdlMetadata commitTimestamps.

database

public database: string;

UpdateDatabaseDdlMetadata database.

progress

public progress: google.spanner.admin.database.v1.IOperationProgress[];

UpdateDatabaseDdlMetadata progress.

statements

public statements: string[];

UpdateDatabaseDdlMetadata statements.

throttled

public throttled: boolean;

UpdateDatabaseDdlMetadata throttled.

Methods

create(properties)

public static create(properties?: google.spanner.admin.database.v1.IUpdateDatabaseDdlMetadata): google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata;

Creates a new UpdateDatabaseDdlMetadata instance using the specified properties.

Parameter
NameDescription
properties IUpdateDatabaseDdlMetadata

Properties to set

Returns
TypeDescription
UpdateDatabaseDdlMetadata

UpdateDatabaseDdlMetadata instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata;

Decodes an UpdateDatabaseDdlMetadata message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
UpdateDatabaseDdlMetadata

UpdateDatabaseDdlMetadata

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata;

Decodes an UpdateDatabaseDdlMetadata message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
UpdateDatabaseDdlMetadata

UpdateDatabaseDdlMetadata

encode(message, writer)

public static encode(message: google.spanner.admin.database.v1.IUpdateDatabaseDdlMetadata, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified UpdateDatabaseDdlMetadata message. Does not implicitly messages.

Parameters
NameDescription
message IUpdateDatabaseDdlMetadata

UpdateDatabaseDdlMetadata message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.spanner.admin.database.v1.IUpdateDatabaseDdlMetadata, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified UpdateDatabaseDdlMetadata message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message IUpdateDatabaseDdlMetadata

UpdateDatabaseDdlMetadata message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata;

Creates an UpdateDatabaseDdlMetadata message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
UpdateDatabaseDdlMetadata

UpdateDatabaseDdlMetadata

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for UpdateDatabaseDdlMetadata

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this UpdateDatabaseDdlMetadata to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from an UpdateDatabaseDdlMetadata message. Also converts values to other types if specified.

Parameters
NameDescription
message UpdateDatabaseDdlMetadata

UpdateDatabaseDdlMetadata

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies an UpdateDatabaseDdlMetadata message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not