TransferRun

google.cloud.bigquery.datatransfer.v1. TransferRun

Represents a TransferRun.

Constructor

new TransferRun(propertiesopt)

Constructs a new TransferRun.

Parameters:
Name Type Attributes Description
properties google.cloud.bigquery.datatransfer.v1.ITransferRun <optional>

Properties to set

Implements:
  • ITransferRun

Members

dataSourceId :string

TransferRun dataSourceId.

destination :"destinationDatasetId"|undefined

TransferRun destination.

destinationDatasetId :string

TransferRun destinationDatasetId.

emailPreferences :google.cloud.bigquery.datatransfer.v1.IEmailPreferences|null|undefined

TransferRun emailPreferences.

endTime :google.protobuf.ITimestamp|null|undefined

TransferRun endTime.

errorStatus :google.rpc.IStatus|null|undefined

TransferRun errorStatus.

name :string

TransferRun name.

notificationPubsubTopic :string

TransferRun notificationPubsubTopic.

params :google.protobuf.IStruct|null|undefined

TransferRun params.

runTime :google.protobuf.ITimestamp|null|undefined

TransferRun runTime.

schedule :string

TransferRun schedule.

scheduleTime :google.protobuf.ITimestamp|null|undefined

TransferRun scheduleTime.

startTime :google.protobuf.ITimestamp|null|undefined

TransferRun startTime.

state :google.cloud.bigquery.datatransfer.v1.TransferState

TransferRun state.

updateTime :google.protobuf.ITimestamp|null|undefined

TransferRun updateTime.

userId :number|Long

TransferRun userId.

Methods

(static) create(propertiesopt) → {google.cloud.bigquery.datatransfer.v1.TransferRun}

Creates a new TransferRun instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.bigquery.datatransfer.v1.ITransferRun <optional>

Properties to set

(static) decode(reader, lengthopt) → {google.cloud.bigquery.datatransfer.v1.TransferRun}

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

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.cloud.bigquery.datatransfer.v1.TransferRun}

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

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

Reader or buffer to decode from

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 TransferRun message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.bigquery.datatransfer.v1.ITransferRun

TransferRun message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

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

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

Parameters:
Name Type Attributes Description
message google.cloud.bigquery.datatransfer.v1.ITransferRun

TransferRun message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

(static) fromObject(object) → {google.cloud.bigquery.datatransfer.v1.TransferRun}

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

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

Plain object

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

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

Parameters:
Name Type Attributes Description
message google.cloud.bigquery.datatransfer.v1.TransferRun

TransferRun

options $protobuf.IConversionOptions <optional>

Conversion options

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

Verifies a TransferRun message.

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

Plain object to verify

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

Converts this TransferRun to JSON.