Represents a DataSource.
Package
@google-cloud/bigquery-data-transferConstructors
(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.
clientId
public clientId: string;DataSource clientId.
dataRefreshType
public dataRefreshType: (google.cloud.bigquery.datatransfer.v1.DataSource.DataRefreshType|keyof typeof google.cloud.bigquery.datatransfer.v1.DataSource.DataRefreshType);DataSource dataRefreshType.
dataSourceId
public dataSourceId: string;DataSource dataSourceId.
defaultDataRefreshWindowDays
public defaultDataRefreshWindowDays: number;DataSource defaultDataRefreshWindowDays.
defaultSchedule
public defaultSchedule: string;DataSource defaultSchedule.
description
public description: string;DataSource description.
displayName
public displayName: string;DataSource displayName.
helpUrl
public helpUrl: string;DataSource helpUrl.
manualRunsDisabled
public manualRunsDisabled: boolean;DataSource manualRunsDisabled.
minimumScheduleInterval
public minimumScheduleInterval?: (google.protobuf.IDuration|null);DataSource minimumScheduleInterval.
name
public name: string;DataSource name.
parameters
public parameters: google.cloud.bigquery.datatransfer.v1.IDataSourceParameter[];DataSource parameters.
scopes
public scopes: string[];DataSource scopes.
supportsCustomSchedule
public supportsCustomSchedule: boolean;DataSource supportsCustomSchedule.
supportsMultipleTransfers
public supportsMultipleTransfers: boolean;DataSource supportsMultipleTransfers.
transferType
public transferType: (google.cloud.bigquery.datatransfer.v1.TransferType|keyof typeof google.cloud.bigquery.datatransfer.v1.TransferType);DataSource transferType.
updateDeadlineSeconds
public updateDeadlineSeconds: number;DataSource updateDeadlineSeconds.
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 |
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 |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
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 |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
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 |
DataSource | DataSource |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for DataSource
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
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 |
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) |
|