DataSource

google.cloud.bigquery.datatransfer.v1. DataSource

Represents a DataSource.

Constructor

new DataSource(propertiesopt)

Constructs a new DataSource.

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

Properties to set

Implements:
  • IDataSource

Members

authorizationType

DataSource authorizationType.

clientId

DataSource clientId.

dataRefreshType

DataSource dataRefreshType.

dataSourceId

DataSource dataSourceId.

defaultDataRefreshWindowDays

DataSource defaultDataRefreshWindowDays.

defaultSchedule

DataSource defaultSchedule.

description

DataSource description.

displayName

DataSource displayName.

helpUrl

DataSource helpUrl.

manualRunsDisabled

DataSource manualRunsDisabled.

minimumScheduleInterval

DataSource minimumScheduleInterval.

name

DataSource name.

parameters

DataSource parameters.

scopes

DataSource scopes.

supportsCustomSchedule

DataSource supportsCustomSchedule.

supportsMultipleTransfers

DataSource supportsMultipleTransfers.

transferType

DataSource transferType.

updateDeadlineSeconds

DataSource updateDeadlineSeconds.

AuthorizationType

AuthorizationType enum.

Properties:
Name Type Description
AUTHORIZATION_TYPE_UNSPECIFIED number

AUTHORIZATION_TYPE_UNSPECIFIED value

AUTHORIZATION_CODE number

AUTHORIZATION_CODE value

GOOGLE_PLUS_AUTHORIZATION_CODE number

GOOGLE_PLUS_AUTHORIZATION_CODE value

FIRST_PARTY_OAUTH number

FIRST_PARTY_OAUTH value

DataRefreshType

DataRefreshType enum.

Properties:
Name Type Description
DATA_REFRESH_TYPE_UNSPECIFIED number

DATA_REFRESH_TYPE_UNSPECIFIED value

SLIDING_WINDOW number

SLIDING_WINDOW value

CUSTOM_SLIDING_WINDOW number

CUSTOM_SLIDING_WINDOW value

Methods

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

Converts this DataSource to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new DataSource instance using the specified properties.

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

Properties to set

Returns:
Type Description
google.cloud.bigquery.datatransfer.v1.DataSource

DataSource instance

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

Decodes a DataSource 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.cloud.bigquery.datatransfer.v1.DataSource

DataSource

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.DataSource}

Decodes a DataSource 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.cloud.bigquery.datatransfer.v1.DataSource

DataSource

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

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

DataSource 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 DataSource message, length delimited. Does not implicitly verify messages.

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

DataSource message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

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

Creates a DataSource 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.cloud.bigquery.datatransfer.v1.DataSource

DataSource

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for DataSource

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

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

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

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

DataSource

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a DataSource 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