Class protos.google.storagetransfer.v1.S3CompatibleMetadata (2.2.1)

Version 2.2.1

• 3.4.0 (latest)
• 3.0.0
• 2.3.2
• 2.2.1
• 2.1.1
• 1.2.0
• 1.1.1
• 1.0.1

Represents a S3CompatibleMetadata.

Package

@google-cloud/storage-transfer

Constructors

(constructor)(properties)

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

Constructs a new S3CompatibleMetadata.

Parameter

Name	Description
properties	IS3CompatibleMetadata Properties to set

Properties

authMethod

public authMethod: (google.storagetransfer.v1.S3CompatibleMetadata.AuthMethod|keyof typeof google.storagetransfer.v1.S3CompatibleMetadata.AuthMethod);

S3CompatibleMetadata authMethod.

listApi

public listApi: (google.storagetransfer.v1.S3CompatibleMetadata.ListApi|keyof typeof google.storagetransfer.v1.S3CompatibleMetadata.ListApi);

S3CompatibleMetadata listApi.

protocol

public protocol: (google.storagetransfer.v1.S3CompatibleMetadata.NetworkProtocol|keyof typeof google.storagetransfer.v1.S3CompatibleMetadata.NetworkProtocol);

S3CompatibleMetadata protocol.

requestModel

public requestModel: (google.storagetransfer.v1.S3CompatibleMetadata.RequestModel|keyof typeof google.storagetransfer.v1.S3CompatibleMetadata.RequestModel);

S3CompatibleMetadata requestModel.

Methods

create(properties)

public static create(properties?: google.storagetransfer.v1.IS3CompatibleMetadata): google.storagetransfer.v1.S3CompatibleMetadata;

Creates a new S3CompatibleMetadata instance using the specified properties.

Parameter

Name	Description
properties	IS3CompatibleMetadata Properties to set

Returns

Type	Description
google.storagetransfer.v1.S3CompatibleMetadata	S3CompatibleMetadata instance

decode(reader, length)

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

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

decodeDelimited(reader)

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

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

encode(message, writer)

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

Encodes the specified S3CompatibleMetadata message. Does not implicitly messages.

Parameters

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

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

Parameters

Name	Description
message	IS3CompatibleMetadata S3CompatibleMetadata 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.S3CompatibleMetadata;

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

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for S3CompatibleMetadata

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 S3CompatibleMetadata to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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