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

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

Repesents Future Reservation request which is part of aggregated reservations data response of "QueryReservations".

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

Namespace

Google \ Cloud \ CapacityPlanner \ V1beta

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ specific_sku_properties
FutureReservation\SpecificSKUProperties

Future Reservation configuration to indicate instance properties and total count.

↳ id
int|string

A unique identifier for this future reservation. The server defines this identifier.

↳ create_time
Google\Protobuf\Timestamp

The creation timestamp for this future reservation.

↳ zone
string

URL of the Zone where this future reservation resides.

↳ description
string

Description of the future reservation provided by user.

↳ future_reservation
string

The future reservation resource name.

↳ owner_project_id
string
↳ time_window
FutureReservation\TimeWindow

Time window for this Future Reservation.

↳ share_settings
Allocation\ShareSettings

List of Projects/Folders to share with.

↳ name_prefix
string

Name prefix for the reservations to be created at the time of delivery. The name prefix must comply with RFC1035. Maximum allowed length for name prefix is 20. Automatically created reservations name format will be

↳ status
FutureReservation\Status

Status of the Future Reservation

↳ auto_created_reservations_delete_time
Google\Protobuf\Timestamp

Future timestamp when the FR auto-created reservations will be deleted by Compute Engine. Format of this field must be a valid RFC3339 value.

↳ auto_delete_auto_created_reservations
bool

Setting for enabling or disabling automatic deletion for auto-created reservation. If set to true, auto-created reservations will be deleted at Future Reservation's end time (default) or at user's defined timestamp if any of the [auto_created_reservations_delete_time, auto_created_reservations_duration] values is specified. For keeping auto-created reservation indefinitely, this value should be set to false.

getSpecificSkuProperties

Future Reservation configuration to indicate instance properties and total count.

Returns
Type
Description

hasSpecificSkuProperties

setSpecificSkuProperties

Future Reservation configuration to indicate instance properties and total count.

Parameter
Name
Description
Returns
Type
Description
$this

getId

A unique identifier for this future reservation. The server defines this identifier.

Returns
Type
Description
int|string

setId

A unique identifier for this future reservation. The server defines this identifier.

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

getCreateTime

The creation timestamp for this future reservation.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

The creation timestamp for this future reservation.

Parameter
Name
Description
Returns
Type
Description
$this

getZone

URL of the Zone where this future reservation resides.

Returns
Type
Description
string

setZone

URL of the Zone where this future reservation resides.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDescription

Description of the future reservation provided by user.

Returns
Type
Description
string

setDescription

Description of the future reservation provided by user.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getFutureReservation

The future reservation resource name.

Returns
Type
Description
string

setFutureReservation

The future reservation resource name.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getOwnerProjectId

Generated from protobuf field string owner_project_id = 15;

Returns
Type
Description
string

setOwnerProjectId

Generated from protobuf field string owner_project_id = 15;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getTimeWindow

Time window for this Future Reservation.

Returns
Type
Description

hasTimeWindow

clearTimeWindow

setTimeWindow

Time window for this Future Reservation.

Parameter
Name
Description
Returns
Type
Description
$this

getShareSettings

List of Projects/Folders to share with.

Returns
Type
Description

hasShareSettings

clearShareSettings

setShareSettings

List of Projects/Folders to share with.

Parameter
Name
Description
Returns
Type
Description
$this

getNamePrefix

Name prefix for the reservations to be created at the time of delivery. The name prefix must comply with RFC1035.

Maximum allowed length for name prefix is 20. Automatically created reservations name format will be

Returns
Type
Description
string

setNamePrefix

Name prefix for the reservations to be created at the time of delivery. The name prefix must comply with RFC1035.

Maximum allowed length for name prefix is 20. Automatically created reservations name format will be

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getStatus

Status of the Future Reservation

Returns
Type
Description

hasStatus

clearStatus

setStatus

Status of the Future Reservation

Parameter
Name
Description
Returns
Type
Description
$this

getAutoCreatedReservationsDeleteTime

Future timestamp when the FR auto-created reservations will be deleted by Compute Engine. Format of this field must be a valid RFC3339 value.

Returns
Type
Description

hasAutoCreatedReservationsDeleteTime

clearAutoCreatedReservationsDeleteTime

setAutoCreatedReservationsDeleteTime

Future timestamp when the FR auto-created reservations will be deleted by Compute Engine. Format of this field must be a valid RFC3339 value.

Parameter
Name
Description
Returns
Type
Description
$this

getAutoDeleteAutoCreatedReservations

Setting for enabling or disabling automatic deletion for auto-created reservation. If set to true, auto-created reservations will be deleted at Future Reservation's end time (default) or at user's defined timestamp if any of the [auto_created_reservations_delete_time, auto_created_reservations_duration] values is specified.

For keeping auto-created reservation indefinitely, this value should be set to false.

Returns
Type
Description
bool

setAutoDeleteAutoCreatedReservations

Setting for enabling or disabling automatic deletion for auto-created reservation. If set to true, auto-created reservations will be deleted at Future Reservation's end time (default) or at user's defined timestamp if any of the [auto_created_reservations_delete_time, auto_created_reservations_duration] values is specified.

For keeping auto-created reservation indefinitely, this value should be set to false.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getType

Returns
Type
Description
string
Design a Mobile Site
View Site in Mobile | Classic
Share by: