Class FutureReservation (0.1.0) 

public final class FutureReservation extends GeneratedMessageV3 implements FutureReservationOrBuilder

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

Protobuf type google.cloud.capacityplanner.v1beta.FutureReservation

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > FutureReservation

Static Fields

AUTO_CREATED_RESERVATIONS_DELETE_TIME_FIELD_NUMBER

public static final int AUTO_CREATED_RESERVATIONS_DELETE_TIME_FIELD_NUMBER
Field Value
Type Description
int

AUTO_DELETE_AUTO_CREATED_RESERVATIONS_FIELD_NUMBER

public static final int AUTO_DELETE_AUTO_CREATED_RESERVATIONS_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

FUTURE_RESERVATION_FIELD_NUMBER

public static final int FUTURE_RESERVATION_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

NAME_PREFIX_FIELD_NUMBER

public static final int NAME_PREFIX_FIELD_NUMBER
Field Value
Type Description
int

OWNER_PROJECT_ID_FIELD_NUMBER

public static final int OWNER_PROJECT_ID_FIELD_NUMBER
Field Value
Type Description
int

SHARE_SETTINGS_FIELD_NUMBER

public static final int SHARE_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

SPECIFIC_SKU_PROPERTIES_FIELD_NUMBER

public static final int SPECIFIC_SKU_PROPERTIES_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

TIME_WINDOW_FIELD_NUMBER

public static final int TIME_WINDOW_FIELD_NUMBER
Field Value
Type Description
int

ZONE_FIELD_NUMBER

public static final int ZONE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static FutureReservation getDefaultInstance()
Returns
Type Description
FutureReservation

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static FutureReservation.Builder newBuilder()
Returns
Type Description
FutureReservation.Builder

newBuilder(FutureReservation prototype)

public static FutureReservation.Builder newBuilder(FutureReservation prototype)
Parameter
Name Description
prototype FutureReservation
Returns
Type Description
FutureReservation.Builder

parseDelimitedFrom(InputStream input)

public static FutureReservation parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FutureReservation
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FutureReservation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FutureReservation
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static FutureReservation parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
FutureReservation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FutureReservation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FutureReservation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FutureReservation parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
FutureReservation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FutureReservation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FutureReservation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FutureReservation parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
FutureReservation
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FutureReservation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FutureReservation
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static FutureReservation parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FutureReservation
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FutureReservation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FutureReservation
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static FutureReservation parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
FutureReservation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FutureReservation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FutureReservation
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<FutureReservation> parser()
Returns
Type Description
Parser<FutureReservation>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAutoCreatedReservationsDeleteTime()

public Timestamp 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.

.google.protobuf.Timestamp auto_created_reservations_delete_time = 13;

Returns
Type Description
Timestamp

The autoCreatedReservationsDeleteTime.

getAutoCreatedReservationsDeleteTimeOrBuilder()

public TimestampOrBuilder getAutoCreatedReservationsDeleteTimeOrBuilder()

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

.google.protobuf.Timestamp auto_created_reservations_delete_time = 13;

Returns
Type Description
TimestampOrBuilder

getAutoDeleteAutoCreatedReservations()

public boolean 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.

bool auto_delete_auto_created_reservations = 14;

Returns
Type Description
boolean

The autoDeleteAutoCreatedReservations.

getCreateTime()

public Timestamp getCreateTime()

The creation timestamp for this future reservation.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

The creation timestamp for this future reservation.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public FutureReservation getDefaultInstanceForType()
Returns
Type Description
FutureReservation

getDescription()

public String getDescription()

Description of the future reservation provided by user.

string description = 6;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Description of the future reservation provided by user.

string description = 6;

Returns
Type Description
ByteString

The bytes for description.

getFutureReservation()

public String getFutureReservation()

The future reservation resource name.

string future_reservation = 7;

Returns
Type Description
String

The futureReservation.

getFutureReservationBytes()

public ByteString getFutureReservationBytes()

The future reservation resource name.

string future_reservation = 7;

Returns
Type Description
ByteString

The bytes for futureReservation.

getId()

public long getId()

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

int64 id = 1;

Returns
Type Description
long

The id.

getNamePrefix()

public String 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 <name-prefix>-date-####.

string name_prefix = 11;

Returns
Type Description
String

The namePrefix.

getNamePrefixBytes()

public ByteString getNamePrefixBytes()

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 <name-prefix>-date-####.

string name_prefix = 11;

Returns
Type Description
ByteString

The bytes for namePrefix.

getOwnerProjectId()

public String getOwnerProjectId()

string owner_project_id = 15;

Returns
Type Description
String

The ownerProjectId.

getOwnerProjectIdBytes()

public ByteString getOwnerProjectIdBytes()

string owner_project_id = 15;

Returns
Type Description
ByteString

The bytes for ownerProjectId.

getParserForType()

public Parser<FutureReservation> getParserForType()
Returns
Type Description
Parser<FutureReservation>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getShareSettings()

public Allocation.ShareSettings getShareSettings()

List of Projects/Folders to share with.

.google.cloud.capacityplanner.v1beta.Allocation.ShareSettings share_settings = 10;

Returns
Type Description
Allocation.ShareSettings

The shareSettings.

getShareSettingsOrBuilder()

public Allocation.ShareSettingsOrBuilder getShareSettingsOrBuilder()

List of Projects/Folders to share with.

.google.cloud.capacityplanner.v1beta.Allocation.ShareSettings share_settings = 10;

Returns
Type Description
Allocation.ShareSettingsOrBuilder

getSpecificSkuProperties()

public FutureReservation.SpecificSKUProperties getSpecificSkuProperties()

Future Reservation configuration to indicate instance properties and total count.

.google.cloud.capacityplanner.v1beta.FutureReservation.SpecificSKUProperties specific_sku_properties = 8;

Returns
Type Description
FutureReservation.SpecificSKUProperties

The specificSkuProperties.

getSpecificSkuPropertiesOrBuilder()

public FutureReservation.SpecificSKUPropertiesOrBuilder getSpecificSkuPropertiesOrBuilder()

Future Reservation configuration to indicate instance properties and total count.

.google.cloud.capacityplanner.v1beta.FutureReservation.SpecificSKUProperties specific_sku_properties = 8;

Returns
Type Description
FutureReservation.SpecificSKUPropertiesOrBuilder

getStatus()

public FutureReservation.Status getStatus()

Status of the Future Reservation

.google.cloud.capacityplanner.v1beta.FutureReservation.Status status = 12;

Returns
Type Description
FutureReservation.Status

The status.

getStatusOrBuilder()

public FutureReservation.StatusOrBuilder getStatusOrBuilder()

Status of the Future Reservation

.google.cloud.capacityplanner.v1beta.FutureReservation.Status status = 12;

Returns
Type Description
FutureReservation.StatusOrBuilder

getTimeWindow()

public FutureReservation.TimeWindow getTimeWindow()

Time window for this Future Reservation.

.google.cloud.capacityplanner.v1beta.FutureReservation.TimeWindow time_window = 9;

Returns
Type Description
FutureReservation.TimeWindow

The timeWindow.

getTimeWindowOrBuilder()

public FutureReservation.TimeWindowOrBuilder getTimeWindowOrBuilder()

Time window for this Future Reservation.

.google.cloud.capacityplanner.v1beta.FutureReservation.TimeWindow time_window = 9;

Returns
Type Description
FutureReservation.TimeWindowOrBuilder

getTypeCase()

public FutureReservation.TypeCase getTypeCase()
Returns
Type Description
FutureReservation.TypeCase

getZone()

public String getZone()

URL of the Zone where this future reservation resides.

string zone = 5;

Returns
Type Description
String

The zone.

getZoneBytes()

public ByteString getZoneBytes()

URL of the Zone where this future reservation resides.

string zone = 5;

Returns
Type Description
ByteString

The bytes for zone.

hasAutoCreatedReservationsDeleteTime()

public boolean hasAutoCreatedReservationsDeleteTime()

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

.google.protobuf.Timestamp auto_created_reservations_delete_time = 13;

Returns
Type Description
boolean

Whether the autoCreatedReservationsDeleteTime field is set.

hasCreateTime()

public boolean hasCreateTime()

The creation timestamp for this future reservation.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
boolean

Whether the createTime field is set.

hasShareSettings()

public boolean hasShareSettings()

List of Projects/Folders to share with.

.google.cloud.capacityplanner.v1beta.Allocation.ShareSettings share_settings = 10;

Returns
Type Description
boolean

Whether the shareSettings field is set.

hasSpecificSkuProperties()

public boolean hasSpecificSkuProperties()

Future Reservation configuration to indicate instance properties and total count.

.google.cloud.capacityplanner.v1beta.FutureReservation.SpecificSKUProperties specific_sku_properties = 8;

Returns
Type Description
boolean

Whether the specificSkuProperties field is set.

hasStatus()

public boolean hasStatus()

Status of the Future Reservation

.google.cloud.capacityplanner.v1beta.FutureReservation.Status status = 12;

Returns
Type Description
boolean

Whether the status field is set.

hasTimeWindow()

public boolean hasTimeWindow()

Time window for this Future Reservation.

.google.cloud.capacityplanner.v1beta.FutureReservation.TimeWindow time_window = 9;

Returns
Type Description
boolean

Whether the timeWindow field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public FutureReservation.Builder newBuilderForType()
Returns
Type Description
FutureReservation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FutureReservation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
FutureReservation.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public FutureReservation.Builder toBuilder()
Returns
Type Description
FutureReservation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException