Reference documentation and code samples for the Google Cloud Capacity Planner V1beta Client class Allocation.
Repesents Allocation which is part of aggregated reservations data response of "QueryReservations".
Generated from protobuf message google.cloud.capacityplanner.v1beta.Allocation
Namespace
Google \ Cloud \ CapacityPlanner \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ specific_allocation |
Allocation\SpecificSKUAllocation
Reservation for instances with specific machine shapes. |
↳ id |
int|string
The unique identifier for the resource. This identifier is defined by the server. |
↳ create_time |
Google\Protobuf\Timestamp
The creation timestamp for this allocation. |
↳ zone |
string
Zone in which the reservation resides. |
↳ description |
string
A description while creating reservation. |
↳ allocation |
string
The reservation resource name. |
↳ owner_project_id |
string
|
↳ status |
int
The status of the reservation. |
↳ share_settings |
Allocation\ShareSettings
Specify share-settings to create a shared reservation. |
↳ auto_delete_time |
Google\Protobuf\Timestamp
Absolute time in future when the reservation will be auto-deleted by Compute Engine. |
getSpecificAllocation
Reservation for instances with specific machine shapes.
| Returns | |
|---|---|
| Type | Description |
Allocation\SpecificSKUAllocation|null |
|
hasSpecificAllocation
setSpecificAllocation
Reservation for instances with specific machine shapes.
| Parameter | |
|---|---|
| Name | Description |
var |
Allocation\SpecificSKUAllocation
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getId
The unique identifier for the resource. This identifier is defined by the server.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setId
The unique identifier for the resource. This identifier is defined by the server.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
The creation timestamp for this allocation.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
The creation timestamp for this allocation.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getZone
Zone in which the reservation resides.
| Returns | |
|---|---|
| Type | Description |
string |
|
setZone
Zone in which the reservation resides.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
A description while creating reservation.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
A description while creating reservation.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAllocation
The reservation resource name.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAllocation
The reservation resource name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOwnerProjectId
Generated from protobuf field string owner_project_id = 10;
| Returns | |
|---|---|
| Type | Description |
string |
|
setOwnerProjectId
Generated from protobuf field string owner_project_id = 10;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStatus
The status of the reservation.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type Status. |
setStatus
The status of the reservation.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type Status. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getShareSettings
Specify share-settings to create a shared reservation.
| Returns | |
|---|---|
| Type | Description |
Allocation\ShareSettings|null |
|
hasShareSettings
clearShareSettings
setShareSettings
Specify share-settings to create a shared reservation.
| Parameter | |
|---|---|
| Name | Description |
var |
Allocation\ShareSettings
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAutoDeleteTime
Absolute time in future when the reservation will be auto-deleted by Compute Engine.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasAutoDeleteTime
clearAutoDeleteTime
setAutoDeleteTime
Absolute time in future when the reservation will be auto-deleted by Compute Engine.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getType
| Returns | |
|---|---|
| Type | Description |
string |
|