Represents an Allocation.
Package
@google-cloud/capacityplannerConstructors
(constructor)(properties)
constructor(properties?: google.cloud.capacityplanner.v1beta.IAllocation);Constructs a new Allocation.
| Parameter | |
|---|---|
| Name | Description |
properties |
IAllocation
Properties to set |
Properties
allocation
public allocation: string;Allocation allocation.
autoDeleteTime
public autoDeleteTime?: (google.protobuf.ITimestamp|null);Allocation autoDeleteTime.
createTime
public createTime?: (google.protobuf.ITimestamp|null);Allocation createTime.
description
public description: string;Allocation description.
id
public id: (number|Long|string);Allocation id.
ownerProjectId
public ownerProjectId: string;Allocation ownerProjectId.
shareSettings
public shareSettings?: (google.cloud.capacityplanner.v1beta.Allocation.IShareSettings|null);Allocation shareSettings.
specificAllocation
public specificAllocation?: (google.cloud.capacityplanner.v1beta.Allocation.ISpecificSKUAllocation|null);Allocation specificAllocation.
status
public status: (google.cloud.capacityplanner.v1beta.Allocation.Status|keyof typeof google.cloud.capacityplanner.v1beta.Allocation.Status);Allocation status.
type
public type?: "specificAllocation";Allocation type.
zone
public zone: string;Allocation zone.
Methods
create(properties)
public static create(properties?: google.cloud.capacityplanner.v1beta.IAllocation): google.cloud.capacityplanner.v1beta.Allocation;Creates a new Allocation instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IAllocation
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Allocation |
Allocation instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.capacityplanner.v1beta.Allocation;Decodes an Allocation 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 |
Allocation |
Allocation |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.capacityplanner.v1beta.Allocation;Decodes an Allocation message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Allocation |
Allocation |
encode(message, writer)
public static encode(message: google.cloud.capacityplanner.v1beta.IAllocation, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Allocation message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IAllocation
Allocation 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.IAllocation, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Allocation message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IAllocation
Allocation 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.Allocation;Creates an Allocation 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 |
Allocation |
Allocation |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Allocation
| 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 Allocation to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.capacityplanner.v1beta.Allocation, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an Allocation message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Allocation
Allocation |
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 Allocation message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|