Represents a Reservation.
Package
@google-cloud/computeConstructors
(constructor)(properties)
constructor(properties?: google.cloud.compute.v1.IReservation);Constructs a new Reservation.
| Parameter | |
|---|---|
| Name | Description |
properties |
IReservation
Properties to set |
Properties
_aggregateReservation
public _aggregateReservation?: "aggregateReservation";Reservation _aggregateReservation.
_commitment
public _commitment?: "commitment";Reservation _commitment.
_creationTimestamp
public _creationTimestamp?: "creationTimestamp";Reservation _creationTimestamp.
_description
public _description?: "description";Reservation _description.
_id
public _id?: "id";Reservation _id.
_kind
public _kind?: "kind";Reservation _kind.
_name
public _name?: "name";Reservation _name.
_resourceStatus
public _resourceStatus?: "resourceStatus";Reservation _resourceStatus.
_satisfiesPzs
public _satisfiesPzs?: "satisfiesPzs";Reservation _satisfiesPzs.
_selfLink
public _selfLink?: "selfLink";Reservation _selfLink.
_shareSettings
public _shareSettings?: "shareSettings";Reservation _shareSettings.
_specificReservation
public _specificReservation?: "specificReservation";Reservation _specificReservation.
_specificReservationRequired
public _specificReservationRequired?: "specificReservationRequired";Reservation _specificReservationRequired.
_status
public _status?: "status";Reservation _status.
_zone
public _zone?: "zone";Reservation _zone.
aggregateReservation
public aggregateReservation?: (google.cloud.compute.v1.IAllocationAggregateReservation|null);Reservation aggregateReservation.
commitment
public commitment?: (string|null);Reservation commitment.
creationTimestamp
public creationTimestamp?: (string|null);Reservation creationTimestamp.
description
public description?: (string|null);Reservation description.
id
public id?: (number|Long|string|null);Reservation id.
kind
public kind?: (string|null);Reservation kind.
name
public name?: (string|null);Reservation name.
resourcePolicies
public resourcePolicies: { [k: string]: string };Reservation resourcePolicies.
resourceStatus
public resourceStatus?: (google.cloud.compute.v1.IAllocationResourceStatus|null);Reservation resourceStatus.
satisfiesPzs
public satisfiesPzs?: (boolean|null);Reservation satisfiesPzs.
selfLink
public selfLink?: (string|null);Reservation selfLink.
shareSettings
public shareSettings?: (google.cloud.compute.v1.IShareSettings|null);Reservation shareSettings.
specificReservation
public specificReservation?: (google.cloud.compute.v1.IAllocationSpecificSKUReservation|null);Reservation specificReservation.
specificReservationRequired
public specificReservationRequired?: (boolean|null);Reservation specificReservationRequired.
status
public status?: (string|null);Reservation status.
zone
public zone?: (string|null);Reservation zone.
Methods
create(properties)
public static create(properties?: google.cloud.compute.v1.IReservation): google.cloud.compute.v1.Reservation;Creates a new Reservation instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IReservation
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Reservation |
Reservation instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.compute.v1.Reservation;Decodes a Reservation 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 |
Reservation |
Reservation |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.compute.v1.Reservation;Decodes a Reservation message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Reservation |
Reservation |
encode(message, writer)
public static encode(message: google.cloud.compute.v1.IReservation, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Reservation message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IReservation
Reservation 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.compute.v1.IReservation, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Reservation message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IReservation
Reservation 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.compute.v1.Reservation;Creates a Reservation 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 |
Reservation |
Reservation |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Reservation
| 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 Reservation to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.compute.v1.Reservation, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Reservation message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Reservation
Reservation |
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 Reservation message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|