Class protos.google.cloud.sql.v1.CloneContext (0.8.0)

Represents a CloneContext.

Package

@google-cloud/sql

Constructors

(constructor)(properties)

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

Constructs a new CloneContext.

Parameter
Name Description
properties ICloneContext

Properties to set

Properties

_preferredZone

public _preferredZone?: "preferredZone";

CloneContext _preferredZone.

allocatedIpRange

public allocatedIpRange: string;

CloneContext allocatedIpRange.

binLogCoordinates

public binLogCoordinates?: (google.cloud.sql.v1.IBinLogCoordinates|null);

CloneContext binLogCoordinates.

databaseNames

public databaseNames: string[];

CloneContext databaseNames.

destinationInstanceName

public destinationInstanceName: string;

CloneContext destinationInstanceName.

kind

public kind: string;

CloneContext kind.

pitrTimestampMs

public pitrTimestampMs: (number|Long|string);

CloneContext pitrTimestampMs.

pointInTime

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

CloneContext pointInTime.

preferredZone

public preferredZone?: (string|null);

CloneContext preferredZone.

Methods

create(properties)

public static create(properties?: google.cloud.sql.v1.ICloneContext): google.cloud.sql.v1.CloneContext;

Creates a new CloneContext instance using the specified properties.

Parameter
Name Description
properties ICloneContext

Properties to set

Returns
Type Description
CloneContext

CloneContext instance

decode(reader, length)

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

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

CloneContext

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
CloneContext

CloneContext

encode(message, writer)

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

Encodes the specified CloneContext message. Does not implicitly messages.

Parameters
Name Description
message ICloneContext

CloneContext 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.ICloneContext, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ICloneContext

CloneContext 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.CloneContext;

Creates a CloneContext 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
CloneContext

CloneContext

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for CloneContext

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message CloneContext

CloneContext

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 a CloneContext 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