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

Represents a QueryUsageHistoriesRequest.

Package

@google-cloud/capacityplanner

Constructors

(constructor)(properties)

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

Constructs a new QueryUsageHistoriesRequest.

Parameter
Name	Description
properties	IQueryUsageHistoriesRequest Properties to set

Properties

cloudResourceType

public cloudResourceType: string;

QueryUsageHistoriesRequest cloudResourceType.

confidentialMode

public confidentialMode: boolean;

QueryUsageHistoriesRequest confidentialMode.

diskType

public diskType: string;

QueryUsageHistoriesRequest diskType.

endDate

public endDate?: (google.type.IDate|null);

QueryUsageHistoriesRequest endDate.

gpuType

public gpuType: string;

QueryUsageHistoriesRequest gpuType.

isSpot

public isSpot: boolean;

QueryUsageHistoriesRequest isSpot.

locationLevel

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

QueryUsageHistoriesRequest locationLevel.

machineFamily

public machineFamily: string;

QueryUsageHistoriesRequest machineFamily.

machineShape

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

QueryUsageHistoriesRequest machineShape.

parent

public parent: string;

QueryUsageHistoriesRequest parent.

startDate

public startDate?: (google.type.IDate|null);

QueryUsageHistoriesRequest startDate.

tpuType

public tpuType: string;

QueryUsageHistoriesRequest tpuType.

usageAggregationMethod

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

QueryUsageHistoriesRequest usageAggregationMethod.

Methods

create(properties)

public static create(properties?: google.cloud.capacityplanner.v1beta.IQueryUsageHistoriesRequest): google.cloud.capacityplanner.v1beta.QueryUsageHistoriesRequest;

Creates a new QueryUsageHistoriesRequest instance using the specified properties.

Parameter
Name	Description
properties	IQueryUsageHistoriesRequest Properties to set

Returns
Type	Description
QueryUsageHistoriesRequest	QueryUsageHistoriesRequest instance

decode(reader, length)

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

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

decodeDelimited(reader)

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

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

Parameter
Name	Description
reader	(Reader|Uint8Array) Reader or buffer to decode from

Returns
Type	Description
QueryUsageHistoriesRequest	QueryUsageHistoriesRequest

encode(message, writer)

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

Encodes the specified QueryUsageHistoriesRequest message. Does not implicitly messages.

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

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

Parameters
Name	Description
message	IQueryUsageHistoriesRequest QueryUsageHistoriesRequest 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.QueryUsageHistoriesRequest;

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

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for QueryUsageHistoriesRequest

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

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

toObject(message, options)

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

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

Parameters
Name	Description
message	QueryUsageHistoriesRequest QueryUsageHistoriesRequest
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 QueryUsageHistoriesRequest 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