Class protos.google.cloud.osconfig.v1.GcsObject (1.12.1)

Represents a GcsObject.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.osconfig.v1.IGcsObject);

Constructs a new GcsObject.

Parameter

Name	Description
properties	`IGcsObject` Properties to set

Properties

bucket

public bucket: string;

GcsObject bucket.

generationNumber

public generationNumber: (number|Long|string);

GcsObject generationNumber.

object

public object: string;

GcsObject object.

Methods

create(properties)

public static create(properties?: google.cloud.osconfig.v1.IGcsObject): google.cloud.osconfig.v1.GcsObject;

Creates a new GcsObject instance using the specified properties.

Parameter

Name	Description
properties	`IGcsObject` Properties to set

Returns

Type	Description
google.cloud.osconfig.v1.GcsObject	GcsObject instance

decode(reader, length)

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

Decodes a GcsObject 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.cloud.osconfig.v1.GcsObject	GcsObject

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.osconfig.v1.GcsObject;

Decodes a GcsObject 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.cloud.osconfig.v1.GcsObject	GcsObject

encode(message, writer)

public static encode(message: google.cloud.osconfig.v1.IGcsObject, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified GcsObject message. Does not implicitly messages.

Parameters

Name	Description
message	`IGcsObject` GcsObject 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.cloud.osconfig.v1.IGcsObject, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IGcsObject` GcsObject 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.cloud.osconfig.v1.GcsObject;

Creates a GcsObject 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.cloud.osconfig.v1.GcsObject	GcsObject

toJSON()

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

Converts this GcsObject to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.osconfig.v1.GcsObject` GcsObject
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 GcsObject 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