Constructor
new TransferSpec(propertiesopt)
Constructs a new TransferSpec.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.storagetransfer.v1.ITransferSpec |
<optional> |
Properties to set |
- Implements:
-
- ITransferSpec
Members
awsS3CompatibleDataSource
TransferSpec awsS3CompatibleDataSource.
awsS3DataSource
TransferSpec awsS3DataSource.
azureBlobStorageDataSource
TransferSpec azureBlobStorageDataSource.
dataSink
TransferSpec dataSink.
dataSource
TransferSpec dataSource.
gcsDataSink
TransferSpec gcsDataSink.
gcsDataSource
TransferSpec gcsDataSource.
gcsIntermediateDataLocation
TransferSpec gcsIntermediateDataLocation.
hdfsDataSource
TransferSpec hdfsDataSource.
httpDataSource
TransferSpec httpDataSource.
intermediateDataLocation
TransferSpec intermediateDataLocation.
objectConditions
TransferSpec objectConditions.
posixDataSink
TransferSpec posixDataSink.
posixDataSource
TransferSpec posixDataSource.
sinkAgentPoolName
TransferSpec sinkAgentPoolName.
sourceAgentPoolName
TransferSpec sourceAgentPoolName.
transferManifest
TransferSpec transferManifest.
transferOptions
TransferSpec transferOptions.
Methods
toJSON() → {Object.<string, *>}
Converts this TransferSpec to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.storagetransfer.v1.TransferSpec}
Creates a new TransferSpec instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.storagetransfer.v1.ITransferSpec |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.storagetransfer.v1.TransferSpec |
TransferSpec instance |
(static) decode(reader, lengthopt) → {google.storagetransfer.v1.TransferSpec}
Decodes a TransferSpec 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.storagetransfer.v1.TransferSpec |
TransferSpec |
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.storagetransfer.v1.TransferSpec}
Decodes a TransferSpec 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.storagetransfer.v1.TransferSpec |
TransferSpec |
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 TransferSpec message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.storagetransfer.v1.ITransferSpec |
TransferSpec 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 TransferSpec message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.storagetransfer.v1.ITransferSpec |
TransferSpec message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.storagetransfer.v1.TransferSpec}
Creates a TransferSpec 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.storagetransfer.v1.TransferSpec |
TransferSpec |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for TransferSpec
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 TransferSpec message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.storagetransfer.v1.TransferSpec |
TransferSpec |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a TransferSpec message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|