MetadataOptions

google.storagetransfer.v1. MetadataOptions

Represents a MetadataOptions.

Constructor

new MetadataOptions(propertiesopt)

Constructs a new MetadataOptions.

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

Properties to set
Implements:
  • IMetadataOptions

Members

acl

MetadataOptions acl.

gid

MetadataOptions gid.

kmsKey

MetadataOptions kmsKey.

mode

MetadataOptions mode.

storageClass

MetadataOptions storageClass.

MetadataOptions symlink.

temporaryHold

MetadataOptions temporaryHold.

timeCreated

MetadataOptions timeCreated.

uid

MetadataOptions uid.

Acl

Acl enum.

Properties:
Name Type Description
ACL_UNSPECIFIED number

ACL_UNSPECIFIED value
ACL_DESTINATION_BUCKET_DEFAULT number

ACL_DESTINATION_BUCKET_DEFAULT value
ACL_PRESERVE number

ACL_PRESERVE value

GID

GID enum.

Properties:
Name Type Description
GID_UNSPECIFIED number

GID_UNSPECIFIED value
GID_SKIP number

GID_SKIP value
GID_NUMBER number

GID_NUMBER value

KmsKey

KmsKey enum.

Properties:
Name Type Description
KMS_KEY_UNSPECIFIED number

KMS_KEY_UNSPECIFIED value
KMS_KEY_DESTINATION_BUCKET_DEFAULT number

KMS_KEY_DESTINATION_BUCKET_DEFAULT value
KMS_KEY_PRESERVE number

KMS_KEY_PRESERVE value

Mode

Mode enum.

Properties:
Name Type Description
MODE_UNSPECIFIED number

MODE_UNSPECIFIED value
MODE_SKIP number

MODE_SKIP value
MODE_PRESERVE number

MODE_PRESERVE value

StorageClass

StorageClass enum.

Properties:
Name Type Description
STORAGE_CLASS_UNSPECIFIED number

STORAGE_CLASS_UNSPECIFIED value
STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT number

STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT value
STORAGE_CLASS_PRESERVE number

STORAGE_CLASS_PRESERVE value
STORAGE_CLASS_STANDARD number

STORAGE_CLASS_STANDARD value
STORAGE_CLASS_NEARLINE number

STORAGE_CLASS_NEARLINE value
STORAGE_CLASS_COLDLINE number

STORAGE_CLASS_COLDLINE value
STORAGE_CLASS_ARCHIVE number

STORAGE_CLASS_ARCHIVE value

Symlink enum.

Properties:
Name Type Description
SYMLINK_UNSPECIFIED number

SYMLINK_UNSPECIFIED value
SYMLINK_SKIP number

SYMLINK_SKIP value
SYMLINK_PRESERVE number

SYMLINK_PRESERVE value

TemporaryHold

TemporaryHold enum.

Properties:
Name Type Description
TEMPORARY_HOLD_UNSPECIFIED number

TEMPORARY_HOLD_UNSPECIFIED value
TEMPORARY_HOLD_SKIP number

TEMPORARY_HOLD_SKIP value
TEMPORARY_HOLD_PRESERVE number

TEMPORARY_HOLD_PRESERVE value

TimeCreated

TimeCreated enum.

Properties:
Name Type Description
TIME_CREATED_UNSPECIFIED number

TIME_CREATED_UNSPECIFIED value
TIME_CREATED_SKIP number

TIME_CREATED_SKIP value
TIME_CREATED_PRESERVE_AS_CUSTOM_TIME number

TIME_CREATED_PRESERVE_AS_CUSTOM_TIME value

UID

UID enum.

Properties:
Name Type Description
UID_UNSPECIFIED number

UID_UNSPECIFIED value
UID_SKIP number

UID_SKIP value
UID_NUMBER number

UID_NUMBER value

Methods

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

Converts this MetadataOptions to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new MetadataOptions instance using the specified properties.

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

Properties to set
Returns:
Type Description
google.storagetransfer.v1.MetadataOptions

MetadataOptions instance

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

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

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

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

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

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

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

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

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

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

MetadataOptions

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for MetadataOptions

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 MetadataOptions message. Also converts values to other types if specified.

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

MetadataOptions
options $protobuf.IConversionOptions <optional>

Conversion options
Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a MetadataOptions 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