Class protos.google.cloud.compute.v1.Project (6.5.0)

Represents a Project.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.compute.v1.IProject);

Constructs a new Project.

Parameter
Name Description
properties IProject

Properties to set

Properties

cloudArmorTier

public cloudArmorTier?: (string|null);

Project cloudArmorTier.

commonInstanceMetadata

public commonInstanceMetadata?: (google.cloud.compute.v1.IMetadata|null);

Project commonInstanceMetadata.

creationTimestamp

public creationTimestamp?: (string|null);

Project creationTimestamp.

defaultNetworkTier

public defaultNetworkTier?: (string|null);

Project defaultNetworkTier.

defaultServiceAccount

public defaultServiceAccount?: (string|null);

Project defaultServiceAccount.

description

public description?: (string|null);

Project description.

enabledFeatures

public enabledFeatures: string[];

Project enabledFeatures.

id

public id?: (number|Long|string|null);

Project id.

kind

public kind?: (string|null);

Project kind.

name

public name?: (string|null);

Project name.

quotas

public quotas: google.cloud.compute.v1.IQuota[];

Project quotas.

public selfLink?: (string|null);

Project selfLink.

usageExportLocation

public usageExportLocation?: (google.cloud.compute.v1.IUsageExportLocation|null);

Project usageExportLocation.

vmDnsSetting

public vmDnsSetting?: (string|null);

Project vmDnsSetting.

xpnProjectStatus

public xpnProjectStatus?: (string|null);

Project xpnProjectStatus.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IProject): google.cloud.compute.v1.Project;

Creates a new Project instance using the specified properties.

Parameter
Name Description
properties IProject

Properties to set

Returns
Type Description
Project

Project instance

decode(reader, length)

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

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

Project

decodeDelimited(reader)

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

Decodes a Project message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Project

Project

encode(message, writer)

public static encode(message: google.cloud.compute.v1.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.compute.v1.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.compute.v1.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
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.compute.v1.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 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