Class protos.google.cloud.bigquery.migration.v2alpha.MigrationSubtask (1.0.0)

Represents a MigrationSubtask.

Package

@google-cloud/bigquery-migration

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.bigquery.migration.v2alpha.IMigrationSubtask);

Constructs a new MigrationSubtask.

Parameter
NameDescription
properties IMigrationSubtask

Properties to set

Properties

createTime

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

MigrationSubtask createTime.

lastUpdateTime

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

MigrationSubtask lastUpdateTime.

metrics

public metrics: google.cloud.bigquery.migration.v2alpha.ITimeSeries[];

MigrationSubtask metrics.

name

public name: string;

MigrationSubtask name.

processingError

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

MigrationSubtask processingError.

resourceErrorCount

public resourceErrorCount: number;

MigrationSubtask resourceErrorCount.

resourceErrorDetails

public resourceErrorDetails: google.cloud.bigquery.migration.v2alpha.IResourceErrorDetail[];

MigrationSubtask resourceErrorDetails.

state

public state: (google.cloud.bigquery.migration.v2alpha.MigrationSubtask.State|keyof typeof google.cloud.bigquery.migration.v2alpha.MigrationSubtask.State);

MigrationSubtask state.

taskId

public taskId: string;

MigrationSubtask taskId.

type

public type: string;

MigrationSubtask type.

Methods

create(properties)

public static create(properties?: google.cloud.bigquery.migration.v2alpha.IMigrationSubtask): google.cloud.bigquery.migration.v2alpha.MigrationSubtask;

Creates a new MigrationSubtask instance using the specified properties.

Parameter
NameDescription
properties IMigrationSubtask

Properties to set

Returns
TypeDescription
MigrationSubtask

MigrationSubtask instance

decode(reader, length)

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

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

MigrationSubtask

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
MigrationSubtask

MigrationSubtask

encode(message, writer)

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

Encodes the specified MigrationSubtask message. Does not implicitly messages.

Parameters
NameDescription
message IMigrationSubtask

MigrationSubtask 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.v2alpha.IMigrationSubtask, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IMigrationSubtask

MigrationSubtask 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.v2alpha.MigrationSubtask;

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

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

Plain object

Returns
TypeDescription
MigrationSubtask

MigrationSubtask

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for MigrationSubtask

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message MigrationSubtask

MigrationSubtask

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