Class protos.google.storagetransfer.v1.GcsData (1.2.0)

Represents a GcsData.

Package

Constructors

(constructor)(properties)

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

Constructs a new GcsData.

Parameter

Name	Description
properties	`IGcsData` Properties to set

Properties

bucketName

public bucketName: string;

GcsData bucketName.

path

public path: string;

GcsData path.

Methods

create(properties)

public static create(properties?: google.storagetransfer.v1.IGcsData): google.storagetransfer.v1.GcsData;

Creates a new GcsData instance using the specified properties.

Parameter

Name	Description
properties	`IGcsData` Properties to set

Returns

Type	Description
google.storagetransfer.v1.GcsData	GcsData instance

decode(reader, length)

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

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

decodeDelimited(reader)

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

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

encode(message, writer)

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

Encodes the specified GcsData message. Does not implicitly messages.

Parameters

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

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

Parameters

Name	Description
message	`IGcsData` GcsData 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.GcsData;

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

toJSON()

public toJSON(): { [k: string]: any };

Converts this GcsData to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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