Class protos.google.cloud.sql.v1.ImportContext.SqlBakImportOptions (0.5.0)

Represents a SqlBakImportOptions.

Package

@google-cloud/sql

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.sql.v1.ImportContext.ISqlBakImportOptions);

Constructs a new SqlBakImportOptions.

Parameter
NameDescription
properties ISqlBakImportOptions

Properties to set

Properties

bakType

public bakType: (google.cloud.sql.v1.BakType|keyof typeof google.cloud.sql.v1.BakType);

SqlBakImportOptions bakType.

encryptionOptions

public encryptionOptions?: (google.cloud.sql.v1.ImportContext.SqlBakImportOptions.IEncryptionOptions|null);

SqlBakImportOptions encryptionOptions.

noRecovery

public noRecovery?: (google.protobuf.IBoolValue|null);

SqlBakImportOptions noRecovery.

recoveryOnly

public recoveryOnly?: (google.protobuf.IBoolValue|null);

SqlBakImportOptions recoveryOnly.

stopAt

public stopAt?: (google.protobuf.ITimestamp|null);

SqlBakImportOptions stopAt.

stopAtMark

public stopAtMark: string;

SqlBakImportOptions stopAtMark.

striped

public striped?: (google.protobuf.IBoolValue|null);

SqlBakImportOptions striped.

Methods

create(properties)

public static create(properties?: google.cloud.sql.v1.ImportContext.ISqlBakImportOptions): google.cloud.sql.v1.ImportContext.SqlBakImportOptions;

Creates a new SqlBakImportOptions instance using the specified properties.

Parameter
NameDescription
properties ISqlBakImportOptions

Properties to set

Returns
TypeDescription
SqlBakImportOptions

SqlBakImportOptions instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.sql.v1.ImportContext.SqlBakImportOptions;

Decodes a SqlBakImportOptions 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
SqlBakImportOptions

SqlBakImportOptions

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.sql.v1.ImportContext.SqlBakImportOptions;

Decodes a SqlBakImportOptions message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
SqlBakImportOptions

SqlBakImportOptions

encode(message, writer)

public static encode(message: google.cloud.sql.v1.ImportContext.ISqlBakImportOptions, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified SqlBakImportOptions message. Does not implicitly messages.

Parameters
NameDescription
message ISqlBakImportOptions

SqlBakImportOptions 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.cloud.sql.v1.ImportContext.ISqlBakImportOptions, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ISqlBakImportOptions

SqlBakImportOptions 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.cloud.sql.v1.ImportContext.SqlBakImportOptions;

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

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

Plain object

Returns
TypeDescription
SqlBakImportOptions

SqlBakImportOptions

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SqlBakImportOptions

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 SqlBakImportOptions to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.sql.v1.ImportContext.SqlBakImportOptions, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message SqlBakImportOptions

SqlBakImportOptions

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a SqlBakImportOptions 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