S3CompatibleMetadata

google.storagetransfer.v1. S3CompatibleMetadata

Represents a S3CompatibleMetadata.

Constructor

new S3CompatibleMetadata(propertiesopt)

Constructs a new S3CompatibleMetadata.

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

Properties to set

Implements:
  • IS3CompatibleMetadata

Members

authMethod

S3CompatibleMetadata authMethod.

listApi

S3CompatibleMetadata listApi.

protocol

S3CompatibleMetadata protocol.

requestModel

S3CompatibleMetadata requestModel.

AuthMethod

AuthMethod enum.

Properties:
Name Type Description
AUTH_METHOD_UNSPECIFIED number

AUTH_METHOD_UNSPECIFIED value

AUTH_METHOD_AWS_SIGNATURE_V4 number

AUTH_METHOD_AWS_SIGNATURE_V4 value

AUTH_METHOD_AWS_SIGNATURE_V2 number

AUTH_METHOD_AWS_SIGNATURE_V2 value

ListApi

ListApi enum.

Properties:
Name Type Description
LIST_API_UNSPECIFIED number

LIST_API_UNSPECIFIED value

LIST_OBJECTS_V2 number

LIST_OBJECTS_V2 value

LIST_OBJECTS number

LIST_OBJECTS value

NetworkProtocol

NetworkProtocol enum.

Properties:
Name Type Description
NETWORK_PROTOCOL_UNSPECIFIED number

NETWORK_PROTOCOL_UNSPECIFIED value

NETWORK_PROTOCOL_HTTPS number

NETWORK_PROTOCOL_HTTPS value

NETWORK_PROTOCOL_HTTP number

NETWORK_PROTOCOL_HTTP value

RequestModel

RequestModel enum.

Properties:
Name Type Description
REQUEST_MODEL_UNSPECIFIED number

REQUEST_MODEL_UNSPECIFIED value

REQUEST_MODEL_VIRTUAL_HOSTED_STYLE number

REQUEST_MODEL_VIRTUAL_HOSTED_STYLE value

REQUEST_MODEL_PATH_STYLE number

REQUEST_MODEL_PATH_STYLE value

Methods

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

Converts this S3CompatibleMetadata to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new S3CompatibleMetadata instance using the specified properties.

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

Properties to set

Returns:
Type Description
google.storagetransfer.v1.S3CompatibleMetadata

S3CompatibleMetadata instance

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

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

S3CompatibleMetadata

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

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

S3CompatibleMetadata

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

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

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

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

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

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

S3CompatibleMetadata

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for S3CompatibleMetadata

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

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

S3CompatibleMetadata

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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