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