Class protos.google.cloud.bigquery.datatransfer.v1.TransferConfig (4.2.1)

Represents a TransferConfig.

Package

@google-cloud/bigquery-data-transfer

Constructors

(constructor)(properties)

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

Constructs a new TransferConfig.

Parameter
Name Description
properties ITransferConfig

Properties to set

Properties

_ownerInfo

public _ownerInfo?: "ownerInfo";

TransferConfig _ownerInfo.

dataRefreshWindowDays

public dataRefreshWindowDays: number;

TransferConfig dataRefreshWindowDays.

datasetRegion

public datasetRegion: string;

TransferConfig datasetRegion.

dataSourceId

public dataSourceId: string;

TransferConfig dataSourceId.

destination

public destination?: "destinationDatasetId";

TransferConfig destination.

destinationDatasetId

public destinationDatasetId?: (string|null);

TransferConfig destinationDatasetId.

disabled

public disabled: boolean;

TransferConfig disabled.

displayName

public displayName: string;

TransferConfig displayName.

emailPreferences

public emailPreferences?: (google.cloud.bigquery.datatransfer.v1.IEmailPreferences|null);

TransferConfig emailPreferences.

encryptionConfiguration

public encryptionConfiguration?: (google.cloud.bigquery.datatransfer.v1.IEncryptionConfiguration|null);

TransferConfig encryptionConfiguration.

name

public name: string;

TransferConfig name.

nextRunTime

public nextRunTime?: (google.protobuf.ITimestamp|null);

TransferConfig nextRunTime.

notificationPubsubTopic

public notificationPubsubTopic: string;

TransferConfig notificationPubsubTopic.

ownerInfo

public ownerInfo?: (google.cloud.bigquery.datatransfer.v1.IUserInfo|null);

TransferConfig ownerInfo.

params

public params?: (google.protobuf.IStruct|null);

TransferConfig params.

schedule

public schedule: string;

TransferConfig schedule.

scheduleOptions

public scheduleOptions?: (google.cloud.bigquery.datatransfer.v1.IScheduleOptions|null);

TransferConfig scheduleOptions.

state

public state: (google.cloud.bigquery.datatransfer.v1.TransferState|keyof typeof google.cloud.bigquery.datatransfer.v1.TransferState);

TransferConfig state.

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

TransferConfig updateTime.

userId

public userId: (number|Long|string);

TransferConfig userId.

Methods

create(properties)

public static create(properties?: google.cloud.bigquery.datatransfer.v1.ITransferConfig): google.cloud.bigquery.datatransfer.v1.TransferConfig;

Creates a new TransferConfig instance using the specified properties.

Parameter
Name Description
properties ITransferConfig

Properties to set
Returns
Type Description
TransferConfig

TransferConfig instance

decode(reader, length)

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

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

TransferConfig

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
TransferConfig

TransferConfig

encode(message, writer)

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

Encodes the specified TransferConfig message. Does not implicitly messages.

Parameters
Name Description
message ITransferConfig

TransferConfig 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.ITransferConfig, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ITransferConfig

TransferConfig 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.TransferConfig;

Creates a TransferConfig 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
TransferConfig

TransferConfig

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for TransferConfig

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 TransferConfig to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message TransferConfig

TransferConfig
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 TransferConfig 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