Class protos.google.cloud.sql.v1.ExportContext (0.13.0)

Represents an ExportContext.

Package

@google-cloud/sql

Constructors

(constructor)(properties)

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

Constructs a new ExportContext.

Parameter
Name Description
properties IExportContext

Properties to set

Properties

bakExportOptions

public bakExportOptions?: (google.cloud.sql.v1.ExportContext.ISqlBakExportOptions|null);

ExportContext bakExportOptions.

csvExportOptions

public csvExportOptions?: (google.cloud.sql.v1.ExportContext.ISqlCsvExportOptions|null);

ExportContext csvExportOptions.

databases

public databases: string[];

ExportContext databases.

fileType

public fileType: (google.cloud.sql.v1.SqlFileType|keyof typeof google.cloud.sql.v1.SqlFileType);

ExportContext fileType.

kind

public kind: string;

ExportContext kind.

offload

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

ExportContext offload.

sqlExportOptions

public sqlExportOptions?: (google.cloud.sql.v1.ExportContext.ISqlExportOptions|null);

ExportContext sqlExportOptions.

uri

public uri: string;

ExportContext uri.

Methods

create(properties)

public static create(properties?: google.cloud.sql.v1.IExportContext): google.cloud.sql.v1.ExportContext;

Creates a new ExportContext instance using the specified properties.

Parameter
Name Description
properties IExportContext

Properties to set

Returns
Type Description
ExportContext

ExportContext instance

decode(reader, length)

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

Decodes an ExportContext message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
ExportContext

ExportContext

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
ExportContext

ExportContext

encode(message, writer)

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

Encodes the specified ExportContext message. Does not implicitly messages.

Parameters
Name Description
message IExportContext

ExportContext message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.sql.v1.IExportContext, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IExportContext

ExportContext message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.sql.v1.ExportContext;

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

Parameter
Name Description
object { [k: string]: any }

Plain object

Returns
Type Description
ExportContext

ExportContext

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ExportContext

Parameter
Name Description
typeUrlPrefix string

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

Returns
Type Description
string

The default type url

toJSON()

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

Converts this ExportContext to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message ExportContext

ExportContext

options $protobuf.IConversionOptions

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an ExportContext message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not