Represents a TransferJob.
Package
@google-cloud/storage-transferConstructors
(constructor)(properties)
constructor(properties?: google.storagetransfer.v1.ITransferJob);Constructs a new TransferJob.
| Parameter | |
|---|---|
| Name | Description |
properties |
ITransferJob
Properties to set |
Properties
creationTime
public creationTime?: (google.protobuf.ITimestamp|null);TransferJob creationTime.
deletionTime
public deletionTime?: (google.protobuf.ITimestamp|null);TransferJob deletionTime.
description
public description: string;TransferJob description.
eventStream
public eventStream?: (google.storagetransfer.v1.IEventStream|null);TransferJob eventStream.
lastModificationTime
public lastModificationTime?: (google.protobuf.ITimestamp|null);TransferJob lastModificationTime.
latestOperationName
public latestOperationName: string;TransferJob latestOperationName.
loggingConfig
public loggingConfig?: (google.storagetransfer.v1.ILoggingConfig|null);TransferJob loggingConfig.
name
public name: string;TransferJob name.
notificationConfig
public notificationConfig?: (google.storagetransfer.v1.INotificationConfig|null);TransferJob notificationConfig.
projectId
public projectId: string;TransferJob projectId.
schedule
public schedule?: (google.storagetransfer.v1.ISchedule|null);TransferJob schedule.
status
public status: (google.storagetransfer.v1.TransferJob.Status|keyof typeof google.storagetransfer.v1.TransferJob.Status);TransferJob status.
transferSpec
public transferSpec?: (google.storagetransfer.v1.ITransferSpec|null);TransferJob transferSpec.
Methods
create(properties)
public static create(properties?: google.storagetransfer.v1.ITransferJob): google.storagetransfer.v1.TransferJob;Creates a new TransferJob instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ITransferJob
Properties to set |
| Returns | |
|---|---|
| Type | Description |
TransferJob | TransferJob instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.storagetransfer.v1.TransferJob;Decodes a TransferJob 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 |
TransferJob | TransferJob |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.storagetransfer.v1.TransferJob;Decodes a TransferJob message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
TransferJob | TransferJob |
encode(message, writer)
public static encode(message: google.storagetransfer.v1.ITransferJob, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified TransferJob message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ITransferJob
TransferJob 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.ITransferJob, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified TransferJob message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ITransferJob
TransferJob 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.TransferJob;Creates a TransferJob 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 |
TransferJob | TransferJob |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for TransferJob
| 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 TransferJob to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.storagetransfer.v1.TransferJob, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a TransferJob message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
TransferJob
TransferJob |
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 TransferJob message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|