Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class protos.google.storagetransfer.v1.TransferOptions (1.2.0)

Represents a TransferOptions.

Package

@google-cloud/storage-transfer

Constructors

(constructor)(properties)

constructor(properties?: google.storagetransfer.v1.ITransferOptions);

Constructs a new TransferOptions.

Parameter

Name	Description
properties	`ITransferOptions` Properties to set

Properties

deleteObjectsFromSourceAfterTransfer

public deleteObjectsFromSourceAfterTransfer: boolean;

TransferOptions deleteObjectsFromSourceAfterTransfer.

deleteObjectsUniqueInSink

public deleteObjectsUniqueInSink: boolean;

TransferOptions deleteObjectsUniqueInSink.

metadataOptions

public metadataOptions?: (google.storagetransfer.v1.IMetadataOptions|null);

TransferOptions metadataOptions.

overwriteObjectsAlreadyExistingInSink

public overwriteObjectsAlreadyExistingInSink: boolean;

TransferOptions overwriteObjectsAlreadyExistingInSink.

overwriteWhen

public overwriteWhen: (google.storagetransfer.v1.TransferOptions.OverwriteWhen|keyof typeof google.storagetransfer.v1.TransferOptions.OverwriteWhen);

TransferOptions overwriteWhen.

Methods

create(properties)

public static create(properties?: google.storagetransfer.v1.ITransferOptions): google.storagetransfer.v1.TransferOptions;

Creates a new TransferOptions instance using the specified properties.

Parameter

Name	Description
properties	`ITransferOptions` Properties to set

Returns

Type	Description
google.storagetransfer.v1.TransferOptions	TransferOptions instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.storagetransfer.v1.TransferOptions;

Decodes a TransferOptions message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.storagetransfer.v1.TransferOptions	TransferOptions

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.storagetransfer.v1.TransferOptions;

Decodes a TransferOptions message from the specified reader or buffer, length delimited.

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.storagetransfer.v1.TransferOptions	TransferOptions

encode(message, writer)

public static encode(message: google.storagetransfer.v1.ITransferOptions, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified TransferOptions message. Does not implicitly messages.

Parameters

Name	Description
message	`ITransferOptions` TransferOptions 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.ITransferOptions, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified TransferOptions message, length delimited. Does not implicitly messages.

Parameters

Name	Description
message	`ITransferOptions` TransferOptions 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.TransferOptions;

Creates a TransferOptions 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
google.storagetransfer.v1.TransferOptions	TransferOptions

toJSON()

public toJSON(): { [k: string]: any };

Converts this TransferOptions to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.storagetransfer.v1.TransferOptions, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a TransferOptions message. Also converts values to other types if specified.

Parameters

Name	Description
message	`google.storagetransfer.v1.TransferOptions` TransferOptions
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 TransferOptions message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not