Class protos.google.cloud.capacityplanner.v1beta.TimeSeries (0.1.2)

Represents a TimeSeries.

Package

@google-cloud/capacityplanner

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.capacityplanner.v1beta.ITimeSeries);

Constructs a new TimeSeries.

Parameter
Name Description
properties ITimeSeries

Properties to set

Properties

cloudResourceType

public cloudResourceType: string;

TimeSeries cloudResourceType.

confidentialMode

public confidentialMode: boolean;

TimeSeries confidentialMode.

diskType

public diskType: string;

TimeSeries diskType.

gpuType

public gpuType: string;

TimeSeries gpuType.

isSpot

public isSpot: boolean;

TimeSeries isSpot.

location

public location: string;

TimeSeries location.

locationType

public locationType: (google.cloud.capacityplanner.v1beta.TimeSeries.LocationType|keyof typeof google.cloud.capacityplanner.v1beta.TimeSeries.LocationType);

TimeSeries locationType.

machineFamily

public machineFamily: string;

TimeSeries machineFamily.

machineShape

public machineShape?: (google.cloud.capacityplanner.v1beta.IMachineShape|null);

TimeSeries machineShape.

points

public points: google.cloud.capacityplanner.v1beta.IPoint[];

TimeSeries points.

tpuType

public tpuType: string;

TimeSeries tpuType.

unit

public unit: string;

TimeSeries unit.

Methods

create(properties)

public static create(properties?: google.cloud.capacityplanner.v1beta.ITimeSeries): google.cloud.capacityplanner.v1beta.TimeSeries;

Creates a new TimeSeries instance using the specified properties.

Parameter
Name Description
properties ITimeSeries

Properties to set

Returns
Type Description
TimeSeries

TimeSeries instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.capacityplanner.v1beta.TimeSeries;

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

TimeSeries

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.capacityplanner.v1beta.TimeSeries;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
TimeSeries

TimeSeries

encode(message, writer)

public static encode(message: google.cloud.capacityplanner.v1beta.ITimeSeries, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified TimeSeries message. Does not implicitly messages.

Parameters
Name Description
message ITimeSeries

TimeSeries 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.capacityplanner.v1beta.ITimeSeries, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ITimeSeries

TimeSeries 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.capacityplanner.v1beta.TimeSeries;

Creates a TimeSeries 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
TimeSeries

TimeSeries

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for TimeSeries

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

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message TimeSeries

TimeSeries

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 TimeSeries 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