Class protos.google.cloud.bigquery.datatransfer.v1.DataSource (2.2.7)

Represents a DataSource.

Package

@google-cloud/bigquery-data-transfer!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.bigquery.datatransfer.v1.IDataSource);

Constructs a new DataSource.

Parameter

Name	Description
properties	`IDataSource` Properties to set

Properties

authorizationType

public authorizationType: (google.cloud.bigquery.datatransfer.v1.DataSource.AuthorizationType|keyof typeof google.cloud.bigquery.datatransfer.v1.DataSource.AuthorizationType);

DataSource authorizationType.

Property Value

Type	Description
(google.cloud.bigquery.datatransfer.v1.DataSource.AuthorizationType\|keyof typeof google.cloud.bigquery.datatransfer.v1.DataSource.AuthorizationType)

clientId

public clientId: string;

DataSource clientId.

Property Value

Type	Description
string

dataRefreshType

public dataRefreshType: (google.cloud.bigquery.datatransfer.v1.DataSource.DataRefreshType|keyof typeof google.cloud.bigquery.datatransfer.v1.DataSource.DataRefreshType);

DataSource dataRefreshType.

Property Value

Type	Description
(google.cloud.bigquery.datatransfer.v1.DataSource.DataRefreshType\|keyof typeof google.cloud.bigquery.datatransfer.v1.DataSource.DataRefreshType)

dataSourceId

public dataSourceId: string;

DataSource dataSourceId.

Property Value

Type	Description
string

defaultDataRefreshWindowDays

public defaultDataRefreshWindowDays: number;

DataSource defaultDataRefreshWindowDays.

Property Value

Type	Description
number

defaultSchedule

public defaultSchedule: string;

DataSource defaultSchedule.

Property Value

Type	Description
string

description

public description: string;

DataSource description.

Property Value

Type	Description
string

displayName

public displayName: string;

DataSource displayName.

Property Value

Type	Description
string

helpUrl

public helpUrl: string;

DataSource helpUrl.

Property Value

Type	Description
string

manualRunsDisabled

public manualRunsDisabled: boolean;

DataSource manualRunsDisabled.

Property Value

Type	Description
boolean

minimumScheduleInterval

public minimumScheduleInterval?: (google.protobuf.IDuration|null);

DataSource minimumScheduleInterval.

Property Value

Type	Description
(google.protobuf.IDuration\|null)

name

public name: string;

DataSource name.

Property Value

Type	Description
string

parameters

public parameters: google.cloud.bigquery.datatransfer.v1.IDataSourceParameter[];

DataSource parameters.

Property Value

Type	Description
google.cloud.bigquery.datatransfer.v1.IDataSourceParameter[]

scopes

public scopes: string[];

DataSource scopes.

Property Value

Type	Description
string[]

supportsCustomSchedule

public supportsCustomSchedule: boolean;

DataSource supportsCustomSchedule.

Property Value

Type	Description
boolean

supportsMultipleTransfers

public supportsMultipleTransfers: boolean;

DataSource supportsMultipleTransfers.

Property Value

Type	Description
boolean

transferType

public transferType: (google.cloud.bigquery.datatransfer.v1.TransferType|keyof typeof google.cloud.bigquery.datatransfer.v1.TransferType);

DataSource transferType.

Property Value

Type	Description
(google.cloud.bigquery.datatransfer.v1.TransferType\|keyof typeof google.cloud.bigquery.datatransfer.v1.TransferType)

updateDeadlineSeconds

public updateDeadlineSeconds: number;

DataSource updateDeadlineSeconds.

Property Value

Type	Description
number

Methods

create(properties)

public static create(properties?: google.cloud.bigquery.datatransfer.v1.IDataSource): google.cloud.bigquery.datatransfer.v1.DataSource;

Creates a new DataSource instance using the specified properties.

Parameter

Name	Description
properties	`IDataSource` Properties to set

Returns

Type	Description
google.cloud.bigquery.datatransfer.v1.DataSource	DataSource instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.bigquery.datatransfer.v1.DataSource;

Decodes a DataSource message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

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

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.bigquery.datatransfer.v1.DataSource;

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

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

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

encode(message, writer)

public static encode(message: google.cloud.bigquery.datatransfer.v1.IDataSource, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified DataSource message. Does not implicitly messages.

Parameters

Name	Description
message	`IDataSource` DataSource 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.cloud.bigquery.datatransfer.v1.IDataSource, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IDataSource` DataSource 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.cloud.bigquery.datatransfer.v1.DataSource;

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

toJSON()

public toJSON(): { [k: string]: any };

Converts this DataSource to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.cloud.bigquery.datatransfer.v1.DataSource, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters

Name	Description
message	`google.cloud.bigquery.datatransfer.v1.DataSource` DataSource
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 DataSource message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not