Represents a TransferOperation.
Package
@google-cloud/storage-transferConstructors
(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.
endTime
public endTime?: (google.protobuf.ITimestamp|null);TransferOperation endTime.
errorBreakdowns
public errorBreakdowns: google.storagetransfer.v1.IErrorSummary[];TransferOperation errorBreakdowns.
loggingConfig
public loggingConfig?: (google.storagetransfer.v1.ILoggingConfig|null);TransferOperation loggingConfig.
name
public name: string;TransferOperation name.
notificationConfig
public notificationConfig?: (google.storagetransfer.v1.INotificationConfig|null);TransferOperation notificationConfig.
projectId
public projectId: string;TransferOperation projectId.
startTime
public startTime?: (google.protobuf.ITimestamp|null);TransferOperation startTime.
status
public status: (google.storagetransfer.v1.TransferOperation.Status|keyof typeof google.storagetransfer.v1.TransferOperation.Status);TransferOperation status.
transferJobName
public transferJobName: string;TransferOperation transferJobName.
transferSpec
public transferSpec?: (google.storagetransfer.v1.ITransferSpec|null);TransferOperation transferSpec.
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 |
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 |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
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 |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
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 |
TransferOperation |
TransferOperation |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for TransferOperation
| 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 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 |
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) |
|