Represents a TransferRun.
Package
@google-cloud/bigquery-data-transferConstructors
(constructor)(properties)
constructor(properties?: google.cloud.bigquery.datatransfer.v1.ITransferRun);Constructs a new TransferRun.
| Parameter | |
|---|---|
| Name | Description |
properties |
ITransferRun
Properties to set |
Properties
dataSourceId
public dataSourceId: string;TransferRun dataSourceId.
destination
public destination?: "destinationDatasetId";TransferRun destination.
destinationDatasetId
public destinationDatasetId?: (string|null);TransferRun destinationDatasetId.
emailPreferences
public emailPreferences?: (google.cloud.bigquery.datatransfer.v1.IEmailPreferences|null);TransferRun emailPreferences.
endTime
public endTime?: (google.protobuf.ITimestamp|null);TransferRun endTime.
errorStatus
public errorStatus?: (google.rpc.IStatus|null);TransferRun errorStatus.
name
public name: string;TransferRun name.
notificationPubsubTopic
public notificationPubsubTopic: string;TransferRun notificationPubsubTopic.
params
public params?: (google.protobuf.IStruct|null);TransferRun params.
runTime
public runTime?: (google.protobuf.ITimestamp|null);TransferRun runTime.
schedule
public schedule: string;TransferRun schedule.
scheduleTime
public scheduleTime?: (google.protobuf.ITimestamp|null);TransferRun scheduleTime.
startTime
public startTime?: (google.protobuf.ITimestamp|null);TransferRun startTime.
state
public state: (google.cloud.bigquery.datatransfer.v1.TransferState|keyof typeof google.cloud.bigquery.datatransfer.v1.TransferState);TransferRun state.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);TransferRun updateTime.
userId
public userId: (number|Long|string);TransferRun userId.
Methods
create(properties)
public static create(properties?: google.cloud.bigquery.datatransfer.v1.ITransferRun): google.cloud.bigquery.datatransfer.v1.TransferRun;Creates a new TransferRun instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ITransferRun
Properties to set |
| Returns | |
|---|---|
| Type | Description |
TransferRun | TransferRun instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.bigquery.datatransfer.v1.TransferRun;Decodes a TransferRun 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 |
TransferRun | TransferRun |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.bigquery.datatransfer.v1.TransferRun;Decodes a TransferRun message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
TransferRun | TransferRun |
encode(message, writer)
public static encode(message: google.cloud.bigquery.datatransfer.v1.ITransferRun, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified TransferRun message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ITransferRun
TransferRun 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.ITransferRun, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified TransferRun message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ITransferRun
TransferRun 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.TransferRun;Creates a TransferRun 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 |
TransferRun | TransferRun |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for TransferRun
| 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 TransferRun to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.bigquery.datatransfer.v1.TransferRun, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a TransferRun message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
TransferRun
TransferRun |
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 TransferRun message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|