Class protos.google.cloud.bigquery.migration.v2.MigrationTask (0.1.0)

Represents a MigrationTask.

Package

@google-cloud/bigquery-migration

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.bigquery.migration.v2.IMigrationTask);

Constructs a new MigrationTask.

Parameter
NameDescription
properties IMigrationTask

Properties to set

Properties

createTime

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

MigrationTask createTime.

id

public id: string;

MigrationTask id.

lastUpdateTime

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

MigrationTask lastUpdateTime.

processingError

public processingError?: (google.rpc.IErrorInfo|null);

MigrationTask processingError.

state

public state: (google.cloud.bigquery.migration.v2.MigrationTask.State|keyof typeof google.cloud.bigquery.migration.v2.MigrationTask.State);

MigrationTask state.

taskDetails

public taskDetails?: "translationConfigDetails";

MigrationTask taskDetails.

translationConfigDetails

public translationConfigDetails?: (google.cloud.bigquery.migration.v2.ITranslationConfigDetails|null);

MigrationTask translationConfigDetails.

type

public type: string;

MigrationTask type.

Methods

create(properties)

public static create(properties?: google.cloud.bigquery.migration.v2.IMigrationTask): google.cloud.bigquery.migration.v2.MigrationTask;

Creates a new MigrationTask instance using the specified properties.

Parameter
NameDescription
properties IMigrationTask

Properties to set

Returns
TypeDescription
google.cloud.bigquery.migration.v2.MigrationTask

MigrationTask instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.bigquery.migration.v2.MigrationTask;

Decodes a MigrationTask message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.bigquery.migration.v2.MigrationTask

MigrationTask

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.bigquery.migration.v2.MigrationTask;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.bigquery.migration.v2.MigrationTask

MigrationTask

encode(message, writer)

public static encode(message: google.cloud.bigquery.migration.v2.IMigrationTask, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified MigrationTask message. Does not implicitly messages.

Parameters
NameDescription
message IMigrationTask

MigrationTask 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.bigquery.migration.v2.IMigrationTask, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IMigrationTask

MigrationTask 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.bigquery.migration.v2.MigrationTask;

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

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

Plain object

Returns
TypeDescription
google.cloud.bigquery.migration.v2.MigrationTask

MigrationTask

toJSON()

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

Converts this MigrationTask to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.bigquery.migration.v2.MigrationTask, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message google.cloud.bigquery.migration.v2.MigrationTask

MigrationTask

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