Class protos.google.cloud.sql.v1beta4.Operation (0.19.0)

Represents an Operation.

Package

@google-cloud/sql

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.sql.v1beta4.IOperation);

Constructs a new Operation.

Parameter
Name Description
properties IOperation

Properties to set

Properties

acquireSsrsLeaseContext

public acquireSsrsLeaseContext?: (google.cloud.sql.v1beta4.IAcquireSsrsLeaseContext|null);

Operation acquireSsrsLeaseContext.

apiWarning

public apiWarning?: (google.cloud.sql.v1beta4.IApiWarning|null);

Operation apiWarning.

backupContext

public backupContext?: (google.cloud.sql.v1beta4.IBackupContext|null);

Operation backupContext.

endTime

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

Operation endTime.

error

public error?: (google.cloud.sql.v1beta4.IOperationErrors|null);

Operation error.

exportContext

public exportContext?: (google.cloud.sql.v1beta4.IExportContext|null);

Operation exportContext.

importContext

public importContext?: (google.cloud.sql.v1beta4.IImportContext|null);

Operation importContext.

insertTime

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

Operation insertTime.

kind

public kind: string;

Operation kind.

name

public name: string;

Operation name.

operationType

public operationType: (google.cloud.sql.v1beta4.Operation.SqlOperationType|keyof typeof google.cloud.sql.v1beta4.Operation.SqlOperationType);

Operation operationType.

public selfLink: string;

Operation selfLink.

startTime

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

Operation startTime.

status

public status: (google.cloud.sql.v1beta4.Operation.SqlOperationStatus|keyof typeof google.cloud.sql.v1beta4.Operation.SqlOperationStatus);

Operation status.

targetId

public targetId: string;

Operation targetId.

public targetLink: string;

Operation targetLink.

targetProject

public targetProject: string;

Operation targetProject.

user

public user: string;

Operation user.

Methods

create(properties)

public static create(properties?: google.cloud.sql.v1beta4.IOperation): google.cloud.sql.v1beta4.Operation;

Creates a new Operation instance using the specified properties.

Parameter
Name Description
properties IOperation

Properties to set

Returns
Type Description
Operation

Operation instance

decode(reader, length)

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

Decodes an Operation 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
Operation

Operation

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Operation

Operation

encode(message, writer)

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

Encodes the specified Operation message. Does not implicitly messages.

Parameters
Name Description
message IOperation

Operation 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.v1beta4.IOperation, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IOperation

Operation 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.v1beta4.Operation;

Creates an Operation 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
Operation

Operation

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Operation

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message Operation

Operation

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 Operation 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