Compute V1 Client - Class ReservationBlock (2.4.0)

Reference documentation and code samples for the Compute V1 Client class ReservationBlock.

Represents a reservation block resource.

Generated from protobuf message google.cloud.compute.v1.ReservationBlock

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ count int

Output only. [Output Only] The number of resources that are allocated in this reservation block.

↳ creation_timestamp string

Output only. [Output Only] Creation timestamp inRFC3339 text format.

↳ health_info ReservationBlockHealthInfo

Output only. [Output Only] Health information for the reservation block.

↳ id int|string

Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

↳ in_use_count int

Output only. [Output Only] The number of instances that are currently in use on this reservation block.

↳ kind string

Output only. [Output Only] Type of the resource. Alwayscompute#reservationBlock for reservation blocks.

↳ name string

Output only. [Output Only] The name of this reservation block generated by Google Compute Engine. The name must be 1-63 characters long, and comply with RFC1035 @pattern a-z?

↳ physical_topology ReservationBlockPhysicalTopology

Output only. [Output Only] The physical topology of the reservation block.

↳ reservation_maintenance GroupMaintenanceInfo

Output only. [Output Only] Maintenance information for this reservation block.

↳ reservation_sub_block_count int

Output only. [Output Only] The number of reservation subBlocks associated with this reservation block.

↳ reservation_sub_block_in_use_count int

Output only. [Output Only] The number of in-use reservation subBlocks associated with this reservation block. If at least one VM is running on a subBlock, it is considered in-use.

↳ self_link string

Output only. [Output Only] Server-defined fully-qualified URL for this resource.

↳ self_link_with_id string

Output only. [Output Only] Server-defined URL for this resource with the resource id.

↳ status string

Output only. [Output Only] Status of the reservation block. Check the Status enum for the list of possible values.

↳ zone string

Output only. [Output Only] Zone in which the reservation block resides.

getCount

Output only. [Output Only] The number of resources that are allocated in this reservation block.

Returns
Type Description
int

hasCount

clearCount

setCount

Output only. [Output Only] The number of resources that are allocated in this reservation block.

Parameter
Name Description
var int
Returns
Type Description
$this

getCreationTimestamp

Output only. [Output Only] Creation timestamp inRFC3339 text format.

Returns
Type Description
string

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

Output only. [Output Only] Creation timestamp inRFC3339 text format.

Parameter
Name Description
var string
Returns
Type Description
$this

getHealthInfo

Output only. [Output Only] Health information for the reservation block.

Returns
Type Description
ReservationBlockHealthInfo|null

hasHealthInfo

clearHealthInfo

setHealthInfo

Output only. [Output Only] Health information for the reservation block.

Parameter
Name Description
var ReservationBlockHealthInfo
Returns
Type Description
$this

getId

Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

Returns
Type Description
int|string

hasId

clearId

setId

Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getInUseCount

Output only. [Output Only] The number of instances that are currently in use on this reservation block.

Returns
Type Description
int

hasInUseCount

clearInUseCount

setInUseCount

Output only. [Output Only] The number of instances that are currently in use on this reservation block.

Parameter
Name Description
var int
Returns
Type Description
$this

getKind

Output only. [Output Only] Type of the resource. Alwayscompute#reservationBlock for reservation blocks.

Returns
Type Description
string

hasKind

clearKind

setKind

Output only. [Output Only] Type of the resource. Alwayscompute#reservationBlock for reservation blocks.

Parameter
Name Description
var string
Returns
Type Description
$this

getName

Output only. [Output Only] The name of this reservation block generated by Google Compute Engine. The name must be 1-63 characters long, and comply with RFC1035 @pattern a-z?

Returns
Type Description
string

hasName

clearName

setName

Output only. [Output Only] The name of this reservation block generated by Google Compute Engine. The name must be 1-63 characters long, and comply with RFC1035 @pattern a-z?

Parameter
Name Description
var string
Returns
Type Description
$this

getPhysicalTopology

Output only. [Output Only] The physical topology of the reservation block.

Returns
Type Description
ReservationBlockPhysicalTopology|null

hasPhysicalTopology

clearPhysicalTopology

setPhysicalTopology

Output only. [Output Only] The physical topology of the reservation block.

Parameter
Name Description
var ReservationBlockPhysicalTopology
Returns
Type Description
$this

getReservationMaintenance

Output only. [Output Only] Maintenance information for this reservation block.

Returns
Type Description
GroupMaintenanceInfo|null

hasReservationMaintenance

clearReservationMaintenance

setReservationMaintenance

Output only. [Output Only] Maintenance information for this reservation block.

Parameter
Name Description
var GroupMaintenanceInfo
Returns
Type Description
$this

getReservationSubBlockCount

Output only. [Output Only] The number of reservation subBlocks associated with this reservation block.

Returns
Type Description
int

hasReservationSubBlockCount

clearReservationSubBlockCount

setReservationSubBlockCount

Output only. [Output Only] The number of reservation subBlocks associated with this reservation block.

Parameter
Name Description
var int
Returns
Type Description
$this

getReservationSubBlockInUseCount

Output only. [Output Only] The number of in-use reservation subBlocks associated with this reservation block. If at least one VM is running on a subBlock, it is considered in-use.

Returns
Type Description
int

hasReservationSubBlockInUseCount

clearReservationSubBlockInUseCount

setReservationSubBlockInUseCount

Output only. [Output Only] The number of in-use reservation subBlocks associated with this reservation block. If at least one VM is running on a subBlock, it is considered in-use.

Parameter
Name Description
var int
Returns
Type Description
$this

Output only. [Output Only] Server-defined fully-qualified URL for this resource.

Returns
Type Description
string

Output only. [Output Only] Server-defined fully-qualified URL for this resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getSelfLinkWithId

Output only. [Output Only] Server-defined URL for this resource with the resource id.

Returns
Type Description
string

hasSelfLinkWithId

clearSelfLinkWithId

setSelfLinkWithId

Output only. [Output Only] Server-defined URL for this resource with the resource id.

Parameter
Name Description
var string
Returns
Type Description
$this

getStatus

Output only. [Output Only] Status of the reservation block.

Check the Status enum for the list of possible values.

Returns
Type Description
string

hasStatus

clearStatus

setStatus

Output only. [Output Only] Status of the reservation block.

Check the Status enum for the list of possible values.

Parameter
Name Description
var string
Returns
Type Description
$this

getZone

Output only. [Output Only] Zone in which the reservation block resides.

Returns
Type Description
string

hasZone

clearZone

setZone

Output only. [Output Only] Zone in which the reservation block resides.

Parameter
Name Description
var string
Returns
Type Description
$this