Class protos.google.cloud.resourcemanager.v3.Folder (3.0.0)

Version 3.0.0

• 4.3.0 (latest)
• 4.2.1
• 4.1.3
• 3.2.0
• 3.1.0
• 3.0.0
• 2.0.1

Represents a Folder.

Package

@google-cloud/resource-manager

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.resourcemanager.v3.IFolder);

Constructs a new Folder.

Parameter

Name	Description
properties	IFolder Properties to set

Properties

createTime

public createTime?: (google.protobuf.ITimestamp|null);

Folder createTime.

deleteTime

public deleteTime?: (google.protobuf.ITimestamp|null);

Folder deleteTime.

displayName

public displayName: string;

Folder displayName.

etag

public etag: string;

Folder etag.

name

public name: string;

Folder name.

parent

public parent: string;

Folder parent.

state

public state: (google.cloud.resourcemanager.v3.Folder.State|keyof typeof google.cloud.resourcemanager.v3.Folder.State);

Folder state.

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

Folder updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.resourcemanager.v3.IFolder): google.cloud.resourcemanager.v3.Folder;

Creates a new Folder instance using the specified properties.

Parameter

Name	Description
properties	IFolder Properties to set

Returns

Type	Description
google.cloud.resourcemanager.v3.Folder	Folder instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.resourcemanager.v3.Folder;

Decodes a Folder 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.resourcemanager.v3.Folder	Folder

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.resourcemanager.v3.Folder;

Decodes a Folder 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.resourcemanager.v3.Folder	Folder

encode(message, writer)

public static encode(message: google.cloud.resourcemanager.v3.IFolder, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Folder message. Does not implicitly messages.

Parameters

Name	Description
message	IFolder Folder 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.resourcemanager.v3.IFolder, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	IFolder Folder 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.resourcemanager.v3.Folder;

Creates a Folder 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.resourcemanager.v3.Folder	Folder

toJSON()

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

Converts this Folder to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	google.cloud.resourcemanager.v3.Folder Folder
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 Folder 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