Class protos.google.cloud.resourcemanager.v3.Project (4.1.3)

Version 4.1.3

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

Represents a Project.

Package

@google-cloud/resource-manager

Constructors

(constructor)(properties)

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

Constructs a new Project.

Parameter

Name	Description
properties	IProject Properties to set

Properties

createTime

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

Project createTime.

deleteTime

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

Project deleteTime.

displayName

public displayName: string;

Project displayName.

etag

public etag: string;

Project etag.

labels

public labels: { [k: string]: string };

Project labels.

name

public name: string;

Project name.

parent

public parent: string;

Project parent.

projectId

public projectId: string;

Project projectId.

state

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

Project state.

updateTime

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

Project updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.resourcemanager.v3.IProject): google.cloud.resourcemanager.v3.Project;

Creates a new Project instance using the specified properties.

Parameter

Name	Description
properties	IProject Properties to set

Returns

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

decode(reader, length)

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

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

decodeDelimited(reader)

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

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

encode(message, writer)

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

Encodes the specified Project message. Does not implicitly messages.

Parameters

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

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

Parameters

Name	Description
message	IProject Project 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.Project;

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

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Project

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

Returns

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

toObject(message, options)

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

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

Parameters

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