Constructor
new TransferRun(propertiesopt)
Constructs a new TransferRun.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.bigquery.datatransfer.v1.ITransferRun |
<optional> |
Properties to set |
- Implements:
-
- ITransferRun
Members
dataSourceId
TransferRun dataSourceId.
destination
TransferRun destination.
destinationDatasetId
TransferRun destinationDatasetId.
emailPreferences
TransferRun emailPreferences.
endTime
TransferRun endTime.
errorStatus
TransferRun errorStatus.
name
TransferRun name.
notificationPubsubTopic
TransferRun notificationPubsubTopic.
params
TransferRun params.
runTime
TransferRun runTime.
schedule
TransferRun schedule.
scheduleTime
TransferRun scheduleTime.
startTime
TransferRun startTime.
state
TransferRun state.
updateTime
TransferRun updateTime.
userId
TransferRun userId.
Methods
toJSON() → {Object.<string, *>}
Converts this TransferRun to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.bigquery.datatransfer.v1.TransferRun}
Creates a new TransferRun instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.bigquery.datatransfer.v1.ITransferRun |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.bigquery.datatransfer.v1.TransferRun |
TransferRun instance |
(static) decode(reader, lengthopt) → {google.cloud.bigquery.datatransfer.v1.TransferRun}
Decodes a TransferRun 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.TransferRun |
TransferRun |
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.TransferRun}
Decodes a TransferRun 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.TransferRun |
TransferRun |
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 TransferRun message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.bigquery.datatransfer.v1.ITransferRun |
TransferRun 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 TransferRun message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.bigquery.datatransfer.v1.ITransferRun |
TransferRun 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.TransferRun}
Creates a TransferRun 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.TransferRun |
TransferRun |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for TransferRun
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 TransferRun message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.bigquery.datatransfer.v1.TransferRun |
TransferRun |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a TransferRun message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|