TransferOptions

google.storagetransfer.v1. TransferOptions

Represents a TransferOptions.

Constructor

new TransferOptions(propertiesopt)

Constructs a new TransferOptions.

Parameters:
Name Type Attributes Description
properties google.storagetransfer.v1.ITransferOptions <optional>

Properties to set

Implements:
  • ITransferOptions

Members

OverwriteWhen

OverwriteWhen enum.

Properties:
Name Type Description
OVERWRITE_WHEN_UNSPECIFIED number

OVERWRITE_WHEN_UNSPECIFIED value

DIFFERENT number

DIFFERENT value

NEVER number

NEVER value

ALWAYS number

ALWAYS value

deleteObjectsFromSourceAfterTransfer

TransferOptions deleteObjectsFromSourceAfterTransfer.

deleteObjectsUniqueInSink

TransferOptions deleteObjectsUniqueInSink.

metadataOptions

TransferOptions metadataOptions.

overwriteObjectsAlreadyExistingInSink

TransferOptions overwriteObjectsAlreadyExistingInSink.

overwriteWhen

TransferOptions overwriteWhen.

Methods

(static) create(propertiesopt) → {google.storagetransfer.v1.TransferOptions}

Creates a new TransferOptions instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.storagetransfer.v1.ITransferOptions <optional>

Properties to set

Returns:
Type Description
google.storagetransfer.v1.TransferOptions

TransferOptions instance

(static) decode(reader, lengthopt) → {google.storagetransfer.v1.TransferOptions}

Decodes a TransferOptions 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.TransferOptions

TransferOptions

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.TransferOptions}

Decodes a TransferOptions 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.TransferOptions

TransferOptions

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 TransferOptions message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.storagetransfer.v1.ITransferOptions

TransferOptions 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 TransferOptions message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.storagetransfer.v1.ITransferOptions

TransferOptions 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.TransferOptions}

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

TransferOptions

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.storagetransfer.v1.TransferOptions

TransferOptions

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a TransferOptions message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not

toJSON() → {Object.<string, *>}

Converts this TransferOptions to JSON.

Returns:
Type Description
Object.<string, *>

JSON object