Reference documentation and code samples for the Google Cloud Capacity Planner V1beta Client class ReservationData.
Response entity for reservations data.
Generated from protobuf message google.cloud.capacityplanner.v1beta.ReservationData
Namespace
Google \ Cloud \ CapacityPlanner \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The resource name of the connection in the form of: |
↳ time_series |
TimeSeries
The collection of data points that represent the aggregated reserved value for reservations filtered by the criteria. |
↳ used_reservation_values |
TimeSeries
The collection of data points that represent the aggregated used value for reservations filtered by the criteria. |
↳ future_reservations |
array<FutureReservation>
Future reservations filtered by the criteria. |
↳ allocations |
array<Allocation>
Allocations filtered by the criteria. |
getName
Identifier. The resource name of the connection in the form of:
projects/{project_id}/locations/{location_id}/reservations/{reservation_id}
or
organizations/{organization_id}/locations/{location_id}/reservations/{reservation_id}
or
folders/{folder_id}/locations/{location_id}/reservations/{reservation_id}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The resource name of the connection in the form of:
projects/{project_id}/locations/{location_id}/reservations/{reservation_id}
or
organizations/{organization_id}/locations/{location_id}/reservations/{reservation_id}
or
folders/{folder_id}/locations/{location_id}/reservations/{reservation_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTimeSeries
The collection of data points that represent the aggregated reserved value for reservations filtered by the criteria.
| Returns | |
|---|---|
| Type | Description |
TimeSeries|null |
|
hasTimeSeries
clearTimeSeries
setTimeSeries
The collection of data points that represent the aggregated reserved value for reservations filtered by the criteria.
| Parameter | |
|---|---|
| Name | Description |
var |
TimeSeries
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUsedReservationValues
The collection of data points that represent the aggregated used value for reservations filtered by the criteria.
| Returns | |
|---|---|
| Type | Description |
TimeSeries|null |
|
hasUsedReservationValues
clearUsedReservationValues
setUsedReservationValues
The collection of data points that represent the aggregated used value for reservations filtered by the criteria.
| Parameter | |
|---|---|
| Name | Description |
var |
TimeSeries
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFutureReservations
Future reservations filtered by the criteria.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setFutureReservations
Future reservations filtered by the criteria.
| Parameter | |
|---|---|
| Name | Description |
var |
array<FutureReservation>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAllocations
Allocations filtered by the criteria.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setAllocations
Allocations filtered by the criteria.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Allocation>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|