Class protos.google.storagetransfer.v1.AwsS3CompatibleData (3.6.0)
Stay organized with collections Save and categorize content based on your preferences.

Represents an AwsS3CompatibleData.

Package

Constructors

(constructor)(properties)

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

Constructs a new AwsS3CompatibleData.

Parameter
Name	Description
`properties`	`IAwsS3CompatibleData` Properties to set

Properties

bucketName

public bucketName: string;

AwsS3CompatibleData bucketName.

dataProvider

public dataProvider?: "s3Metadata";

AwsS3CompatibleData dataProvider.

endpoint

public endpoint: string;

AwsS3CompatibleData endpoint.

path

public path: string;

AwsS3CompatibleData path.

region

public region: string;

AwsS3CompatibleData region.

s3Metadata

public s3Metadata?: (google.storagetransfer.v1.IS3CompatibleMetadata|null);

AwsS3CompatibleData s3Metadata.

Methods

create(properties)

public static create(properties?: google.storagetransfer.v1.IAwsS3CompatibleData): google.storagetransfer.v1.AwsS3CompatibleData;

Creates a new AwsS3CompatibleData instance using the specified properties.

Parameter
Name	Description
`properties`	`IAwsS3CompatibleData` Properties to set

Returns
Type	Description
`AwsS3CompatibleData`	AwsS3CompatibleData instance

decode(reader, length)

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

Decodes an AwsS3CompatibleData message from the specified reader or buffer.

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

Returns
Type	Description
`AwsS3CompatibleData`	AwsS3CompatibleData

decodeDelimited(reader)

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

Decodes an AwsS3CompatibleData message from the specified reader or buffer, length delimited.

Parameter
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`AwsS3CompatibleData`	AwsS3CompatibleData

encode(message, writer)

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

Encodes the specified AwsS3CompatibleData message. Does not implicitly messages.

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

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

Parameters
Name	Description
`message`	`IAwsS3CompatibleData` AwsS3CompatibleData 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.AwsS3CompatibleData;

Creates an AwsS3CompatibleData 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
`AwsS3CompatibleData`	AwsS3CompatibleData

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for AwsS3CompatibleData

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

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

toObject(message, options)

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

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

Parameters
Name	Description
`message`	`AwsS3CompatibleData` AwsS3CompatibleData
`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 an AwsS3CompatibleData 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

Class protos.google.storagetransfer.v1.AwsS3CompatibleData (3.6.0) Stay organized with collections Save and categorize content based on your preferences.