TransferConfig

google.cloud.bigquery.datatransfer.v1. TransferConfig

Represents a TransferConfig.

Constructor

new TransferConfig(propertiesopt)

Constructs a new TransferConfig.

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

Properties to set

Implements:
  • ITransferConfig

Members

dataRefreshWindowDays :number

TransferConfig dataRefreshWindowDays.

datasetRegion :string

TransferConfig datasetRegion.

dataSourceId :string

TransferConfig dataSourceId.

destination :"destinationDatasetId"|undefined

TransferConfig destination.

destinationDatasetId :string

TransferConfig destinationDatasetId.

disabled :boolean

TransferConfig disabled.

displayName :string

TransferConfig displayName.

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

TransferConfig emailPreferences.

name :string

TransferConfig name.

nextRunTime :google.protobuf.ITimestamp|null|undefined

TransferConfig nextRunTime.

notificationPubsubTopic :string

TransferConfig notificationPubsubTopic.

params :google.protobuf.IStruct|null|undefined

TransferConfig params.

schedule :string

TransferConfig schedule.

scheduleOptions :google.cloud.bigquery.datatransfer.v1.IScheduleOptions|null|undefined

TransferConfig scheduleOptions.

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

TransferConfig state.

updateTime :google.protobuf.ITimestamp|null|undefined

TransferConfig updateTime.

userId :number|Long

TransferConfig userId.

Methods

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

Creates a new TransferConfig instance using the specified properties.

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

Properties to set

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

Decodes a TransferConfig 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.TransferConfig}

Decodes a TransferConfig 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 TransferConfig message. Does not implicitly verify messages.

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

TransferConfig message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

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

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

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

TransferConfig message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

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

Creates a TransferConfig 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 TransferConfig message. Also converts values to other types if specified.

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

TransferConfig

options $protobuf.IConversionOptions <optional>

Conversion options

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

Verifies a TransferConfig message.

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

Plain object to verify

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

Converts this TransferConfig to JSON.