Represents an ExportForecastsRequest.
Implements
Package
@google-cloud/capacityplannerConstructors
(constructor)(properties)
constructor(properties?: google.cloud.capacityplanner.v1beta.IExportForecastsRequest);Constructs a new ExportForecastsRequest.
| Parameter | |
|---|---|
| Name | Description |
properties |
IExportForecastsRequest
Properties to set |
Properties
aggregationMethod
public aggregationMethod: (google.cloud.capacityplanner.v1beta.UsageHistory.AggregationMethod|keyof typeof google.cloud.capacityplanner.v1beta.UsageHistory.AggregationMethod);ExportForecastsRequest aggregationMethod.
diskType
public diskType: string;ExportForecastsRequest diskType.
endDate
public endDate?: (google.type.IDate|null);ExportForecastsRequest endDate.
gpuType
public gpuType: string;ExportForecastsRequest gpuType.
machineFamily
public machineFamily: string;ExportForecastsRequest machineFamily.
machineShape
public machineShape?: (google.cloud.capacityplanner.v1beta.IMachineShape|null);ExportForecastsRequest machineShape.
outputConfig
public outputConfig?: (google.cloud.capacityplanner.v1beta.IOutputConfig|null);ExportForecastsRequest outputConfig.
parent
public parent: string;ExportForecastsRequest parent.
predictionInterval
public predictionInterval: (google.cloud.capacityplanner.v1beta.Forecast.PredictionInterval|keyof typeof google.cloud.capacityplanner.v1beta.Forecast.PredictionInterval);ExportForecastsRequest predictionInterval.
resourceType
public resourceType: string;ExportForecastsRequest resourceType.
startDate
public startDate?: (google.type.IDate|null);ExportForecastsRequest startDate.
tpuType
public tpuType: string;ExportForecastsRequest tpuType.
Methods
create(properties)
public static create(properties?: google.cloud.capacityplanner.v1beta.IExportForecastsRequest): google.cloud.capacityplanner.v1beta.ExportForecastsRequest;Creates a new ExportForecastsRequest instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IExportForecastsRequest
Properties to set |
| Returns | |
|---|---|
| Type | Description |
ExportForecastsRequest |
ExportForecastsRequest instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.capacityplanner.v1beta.ExportForecastsRequest;Decodes an ExportForecastsRequest 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 |
ExportForecastsRequest |
ExportForecastsRequest |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.capacityplanner.v1beta.ExportForecastsRequest;Decodes an ExportForecastsRequest message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
ExportForecastsRequest |
ExportForecastsRequest |
encode(message, writer)
public static encode(message: google.cloud.capacityplanner.v1beta.IExportForecastsRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ExportForecastsRequest message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IExportForecastsRequest
ExportForecastsRequest 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.IExportForecastsRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ExportForecastsRequest message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IExportForecastsRequest
ExportForecastsRequest 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.ExportForecastsRequest;Creates an ExportForecastsRequest 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 |
ExportForecastsRequest |
ExportForecastsRequest |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for ExportForecastsRequest
| 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 ExportForecastsRequest to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.capacityplanner.v1beta.ExportForecastsRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an ExportForecastsRequest message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
ExportForecastsRequest
ExportForecastsRequest |
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 an ExportForecastsRequest message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|