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

Represents a QueryForecastsRequest.

Package

@google-cloud/capacityplanner

Constructors

(constructor)(properties)

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

Constructs a new QueryForecastsRequest.

Parameter
Name Description
properties IQueryForecastsRequest

Properties to set

Properties

aggregationMethod

public aggregationMethod: (google.cloud.capacityplanner.v1beta.UsageHistory.AggregationMethod|keyof typeof google.cloud.capacityplanner.v1beta.UsageHistory.AggregationMethod);

QueryForecastsRequest aggregationMethod.

cloudResourceType

public cloudResourceType: string;

QueryForecastsRequest cloudResourceType.

confidentialMode

public confidentialMode: boolean;

QueryForecastsRequest confidentialMode.

diskType

public diskType: string;

QueryForecastsRequest diskType.

forecastType

public forecastType: (google.cloud.capacityplanner.v1beta.Forecast.ForecastType|keyof typeof google.cloud.capacityplanner.v1beta.Forecast.ForecastType);

QueryForecastsRequest forecastType.

gpuType

public gpuType: string;

QueryForecastsRequest gpuType.

machineFamily

public machineFamily: string;

QueryForecastsRequest machineFamily.

machineShape

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

QueryForecastsRequest machineShape.

parent

public parent: string;

QueryForecastsRequest parent.

predictionInterval

public predictionInterval: (google.cloud.capacityplanner.v1beta.Forecast.PredictionInterval|keyof typeof google.cloud.capacityplanner.v1beta.Forecast.PredictionInterval);

QueryForecastsRequest predictionInterval.

tpuType

public tpuType: string;

QueryForecastsRequest tpuType.

Methods

create(properties)

public static create(properties?: google.cloud.capacityplanner.v1beta.IQueryForecastsRequest): google.cloud.capacityplanner.v1beta.QueryForecastsRequest;

Creates a new QueryForecastsRequest instance using the specified properties.

Parameter
Name Description
properties IQueryForecastsRequest

Properties to set

Returns
Type Description
QueryForecastsRequest

QueryForecastsRequest instance

decode(reader, length)

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

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

QueryForecastsRequest

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
QueryForecastsRequest

QueryForecastsRequest

encode(message, writer)

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

Encodes the specified QueryForecastsRequest message. Does not implicitly messages.

Parameters
Name Description
message IQueryForecastsRequest

QueryForecastsRequest 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.IQueryForecastsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IQueryForecastsRequest

QueryForecastsRequest 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.QueryForecastsRequest;

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

QueryForecastsRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for QueryForecastsRequest

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message QueryForecastsRequest

QueryForecastsRequest

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