Represents a TransferSpec.
Package
@google-cloud/storage-transferConstructors
(constructor)(properties)
constructor(properties?: google.storagetransfer.v1.ITransferSpec);
Constructs a new TransferSpec.
Parameter | |
---|---|
Name | Description |
properties |
ITransferSpec
Properties to set |
Properties
awsS3CompatibleDataSource
public awsS3CompatibleDataSource?: (google.storagetransfer.v1.IAwsS3CompatibleData|null);
TransferSpec awsS3CompatibleDataSource.
awsS3DataSource
public awsS3DataSource?: (google.storagetransfer.v1.IAwsS3Data|null);
TransferSpec awsS3DataSource.
azureBlobStorageDataSource
public azureBlobStorageDataSource?: (google.storagetransfer.v1.IAzureBlobStorageData|null);
TransferSpec azureBlobStorageDataSource.
dataSink
public dataSink?: ("gcsDataSink"|"posixDataSink");
TransferSpec dataSink.
dataSource
public dataSource?: ("gcsDataSource"|"awsS3DataSource"|"httpDataSource"|"posixDataSource"|"azureBlobStorageDataSource"|"awsS3CompatibleDataSource");
TransferSpec dataSource.
gcsDataSink
public gcsDataSink?: (google.storagetransfer.v1.IGcsData|null);
TransferSpec gcsDataSink.
gcsDataSource
public gcsDataSource?: (google.storagetransfer.v1.IGcsData|null);
TransferSpec gcsDataSource.
gcsIntermediateDataLocation
public gcsIntermediateDataLocation?: (google.storagetransfer.v1.IGcsData|null);
TransferSpec gcsIntermediateDataLocation.
httpDataSource
public httpDataSource?: (google.storagetransfer.v1.IHttpData|null);
TransferSpec httpDataSource.
intermediateDataLocation
public intermediateDataLocation?: "gcsIntermediateDataLocation";
TransferSpec intermediateDataLocation.
objectConditions
public objectConditions?: (google.storagetransfer.v1.IObjectConditions|null);
TransferSpec objectConditions.
posixDataSink
public posixDataSink?: (google.storagetransfer.v1.IPosixFilesystem|null);
TransferSpec posixDataSink.
posixDataSource
public posixDataSource?: (google.storagetransfer.v1.IPosixFilesystem|null);
TransferSpec posixDataSource.
sinkAgentPoolName
public sinkAgentPoolName: string;
TransferSpec sinkAgentPoolName.
sourceAgentPoolName
public sourceAgentPoolName: string;
TransferSpec sourceAgentPoolName.
transferManifest
public transferManifest?: (google.storagetransfer.v1.ITransferManifest|null);
TransferSpec transferManifest.
transferOptions
public transferOptions?: (google.storagetransfer.v1.ITransferOptions|null);
TransferSpec transferOptions.
Methods
create(properties)
public static create(properties?: google.storagetransfer.v1.ITransferSpec): google.storagetransfer.v1.TransferSpec;
Creates a new TransferSpec instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
ITransferSpec
Properties to set |
Returns | |
---|---|
Type | Description |
TransferSpec | TransferSpec instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.storagetransfer.v1.TransferSpec;
Decodes a TransferSpec 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 |
TransferSpec | TransferSpec |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.storagetransfer.v1.TransferSpec;
Decodes a TransferSpec message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
TransferSpec | TransferSpec |
encode(message, writer)
public static encode(message: google.storagetransfer.v1.ITransferSpec, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified TransferSpec message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
ITransferSpec
TransferSpec 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.storagetransfer.v1.ITransferSpec, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified TransferSpec message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
ITransferSpec
TransferSpec 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.storagetransfer.v1.TransferSpec;
Creates a TransferSpec 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 |
TransferSpec | TransferSpec |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for TransferSpec
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 TransferSpec to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.storagetransfer.v1.TransferSpec, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a TransferSpec message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
TransferSpec
TransferSpec |
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 TransferSpec message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|