Google Cloud Capacity Planner V1beta Client - Class Status (0.1.0)

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud Capacity Planner V1beta Client class Status.

Represents status related to the future reservation.

Generated from protobuf message google.cloud.capacityplanner.v1beta.FutureReservation.Status

Namespace

Google \ Cloud \ CapacityPlanner \ V1beta \ FutureReservation

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ procurement_status	int Current state of this Future Reservation
↳ lock_time	Google\Protobuf\Timestamp Time when Future Reservation would become LOCKED, after which no modifications to Future Reservation will be allowed. Applicable only after the Future Reservation is in the APPROVED state. The lock_time is an RFC3339 string. The procurement_status will transition to PROCURING state at this time.
↳ auto_created_reservations	array Fully qualified urls of the automatically created reservations at start_time.
↳ fulfilled_count	int|string This count indicates the fulfilled capacity so far. This is set during "PROVISIONING" state. This count also includes capacity delivered as part of existing matching reservations.

getProcurementStatus

Current state of this Future Reservation

Returns
Type	Description
int	Enum of type ProcurementStatus.

setProcurementStatus

Current state of this Future Reservation

Parameter
Name	Description
var	int Enum of type ProcurementStatus.

Returns
Type	Description
$this

getLockTime

Time when Future Reservation would become LOCKED, after which no modifications to Future Reservation will be allowed. Applicable only after the Future Reservation is in the APPROVED state. The lock_time is an RFC3339 string. The procurement_status will transition to PROCURING state at this time.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasLockTime

clearLockTime

setLockTime

Time when Future Reservation would become LOCKED, after which no modifications to Future Reservation will be allowed. Applicable only after the Future Reservation is in the APPROVED state. The lock_time is an RFC3339 string. The procurement_status will transition to PROCURING state at this time.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getAutoCreatedReservations

Fully qualified urls of the automatically created reservations at start_time.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setAutoCreatedReservations

Fully qualified urls of the automatically created reservations at start_time.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getFulfilledCount

This count indicates the fulfilled capacity so far. This is set during "PROVISIONING" state. This count also includes capacity delivered as part of existing matching reservations.

Returns
Type	Description
int|string

setFulfilledCount

This count indicates the fulfilled capacity so far. This is set during "PROVISIONING" state. This count also includes capacity delivered as part of existing matching reservations.

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this