Class protos.google.storagetransfer.v1.TransferOperation (1.0.1)

Version 1.0.1

• 3.0.0 (latest)
• 2.3.2
• 2.2.1
• 2.1.1
• 1.2.0
• 1.1.1
• 1.0.1

Represents a TransferOperation.

Package

@google-cloud/storage-transfer!

Constructors

(constructor)(properties)

constructor(properties?: google.storagetransfer.v1.ITransferOperation);

Constructs a new TransferOperation.

Parameter

Name	Description
properties	ITransferOperation Properties to set

Properties

counters

public counters?: (google.storagetransfer.v1.ITransferCounters|null);

TransferOperation counters.

Property Value

Type	Description
(google.storagetransfer.v1.ITransferCounters|null)

endTime

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

TransferOperation endTime.

Property Value

Type	Description
(google.protobuf.ITimestamp|null)

errorBreakdowns

public errorBreakdowns: google.storagetransfer.v1.IErrorSummary[];

TransferOperation errorBreakdowns.

Property Value

Type	Description
google.storagetransfer.v1.IErrorSummary[]

name

public name: string;

TransferOperation name.

Property Value

Type	Description
string

notificationConfig

public notificationConfig?: (google.storagetransfer.v1.INotificationConfig|null);

TransferOperation notificationConfig.

Property Value

Type	Description
(google.storagetransfer.v1.INotificationConfig|null)

projectId

public projectId: string;

TransferOperation projectId.

Property Value

Type	Description
string

startTime

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

TransferOperation startTime.

Property Value

Type	Description
(google.protobuf.ITimestamp|null)

status

public status: (google.storagetransfer.v1.TransferOperation.Status|keyof typeof google.storagetransfer.v1.TransferOperation.Status);

TransferOperation status.

Property Value

Type	Description
(google.storagetransfer.v1.TransferOperation.Status|keyof typeof google.storagetransfer.v1.TransferOperation.Status)

transferJobName

public transferJobName: string;

TransferOperation transferJobName.

Property Value

Type	Description
string

transferSpec

public transferSpec?: (google.storagetransfer.v1.ITransferSpec|null);

TransferOperation transferSpec.

Property Value

Type	Description
(google.storagetransfer.v1.ITransferSpec|null)

Methods

create(properties)

public static create(properties?: google.storagetransfer.v1.ITransferOperation): google.storagetransfer.v1.TransferOperation;

Creates a new TransferOperation instance using the specified properties.

Parameter

Name	Description
properties	ITransferOperation Properties to set

Returns

Type	Description
google.storagetransfer.v1.TransferOperation	TransferOperation instance

decode(reader, length)

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

Decodes a TransferOperation message from the specified reader or buffer.

Parameters

Name	Description
reader	($protobuf.Reader|Uint8Array) Reader or buffer to decode from
length	number Message length if known beforehand

Returns

Type	Description
google.storagetransfer.v1.TransferOperation	TransferOperation

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.storagetransfer.v1.TransferOperation;

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

Parameter

Name	Description
reader	($protobuf.Reader|Uint8Array) Reader or buffer to decode from

Returns

Type	Description
google.storagetransfer.v1.TransferOperation	TransferOperation

encode(message, writer)

public static encode(message: google.storagetransfer.v1.ITransferOperation, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified TransferOperation message. Does not implicitly messages.

Parameters

Name	Description
message	ITransferOperation TransferOperation 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.storagetransfer.v1.ITransferOperation, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	ITransferOperation TransferOperation 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.storagetransfer.v1.TransferOperation;

Creates a TransferOperation 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
google.storagetransfer.v1.TransferOperation	TransferOperation

toJSON()

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

Converts this TransferOperation to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	google.storagetransfer.v1.TransferOperation TransferOperation
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 TransferOperation 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