TransferJob

google.storagetransfer.v1. TransferJob

Represents a TransferJob.

Constructor

new TransferJob(propertiesopt)

Constructs a new TransferJob.

Parameters:
Name Type Attributes Description
properties google.storagetransfer.v1.ITransferJob <optional>

Properties to set

Implements:
  • ITransferJob

Members

Status

Status enum.

Properties:
Name Type Description
STATUS_UNSPECIFIED number

STATUS_UNSPECIFIED value

ENABLED number

ENABLED value

DISABLED number

DISABLED value

DELETED number

DELETED value

creationTime

TransferJob creationTime.

deletionTime

TransferJob deletionTime.

description

TransferJob description.

lastModificationTime

TransferJob lastModificationTime.

latestOperationName

TransferJob latestOperationName.

loggingConfig

TransferJob loggingConfig.

name

TransferJob name.

notificationConfig

TransferJob notificationConfig.

projectId

TransferJob projectId.

schedule

TransferJob schedule.

status

TransferJob status.

transferSpec

TransferJob transferSpec.

Methods

(static) create(propertiesopt) → {google.storagetransfer.v1.TransferJob}

Creates a new TransferJob instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.storagetransfer.v1.ITransferJob <optional>

Properties to set

Returns:
Type Description
google.storagetransfer.v1.TransferJob

TransferJob instance

(static) decode(reader, lengthopt) → {google.storagetransfer.v1.TransferJob}

Decodes a TransferJob message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.storagetransfer.v1.TransferJob

TransferJob

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.storagetransfer.v1.TransferJob}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.storagetransfer.v1.TransferJob

TransferJob

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified TransferJob message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.storagetransfer.v1.ITransferJob

TransferJob message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.storagetransfer.v1.ITransferJob

TransferJob message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.storagetransfer.v1.TransferJob}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.storagetransfer.v1.TransferJob

TransferJob

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.storagetransfer.v1.TransferJob

TransferJob

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a TransferJob message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not

toJSON() → {Object.<string, *>}

Converts this TransferJob to JSON.

Returns:
Type Description
Object.<string, *>

JSON object