Class ExportReservationsUsageRequest (0.1.0)

public final class ExportReservationsUsageRequest extends GeneratedMessageV3 implements ExportReservationsUsageRequestOrBuilder

The ExportReservationsUsage request

Protobuf type google.cloud.capacityplanner.v1beta.ExportReservationsUsageRequest

Inheritance

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

Static Fields

CLOUD_RESOURCE_TYPE_FIELD_NUMBER

public static final int CLOUD_RESOURCE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

END_DATE_FIELD_NUMBER

public static final int END_DATE_FIELD_NUMBER
Field Value
Type Description
int

GPU_TYPE_FIELD_NUMBER

public static final int GPU_TYPE_FIELD_NUMBER
Field Value
Type Description
int

LOCATION_LEVEL_FIELD_NUMBER

public static final int LOCATION_LEVEL_FIELD_NUMBER
Field Value
Type Description
int

MACHINE_FAMILY_FIELD_NUMBER

public static final int MACHINE_FAMILY_FIELD_NUMBER
Field Value
Type Description
int

MACHINE_SHAPE_FIELD_NUMBER

public static final int MACHINE_SHAPE_FIELD_NUMBER
Field Value
Type Description
int

OUTPUT_CONFIG_FIELD_NUMBER

public static final int OUTPUT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

SHARE_TYPE_FIELD_NUMBER

public static final int SHARE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

START_DATE_FIELD_NUMBER

public static final int START_DATE_FIELD_NUMBER
Field Value
Type Description
int

USAGE_AGGREGATION_METHOD_FIELD_NUMBER

public static final int USAGE_AGGREGATION_METHOD_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExportReservationsUsageRequest getDefaultInstance()
Returns
Type Description
ExportReservationsUsageRequest

getDescriptor()

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

newBuilder()

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

newBuilder(ExportReservationsUsageRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCloudResourceType()

public String getCloudResourceType()

Required. The resource for the ReservationsUsage values to return. Possible values include "gce-vcpus", "gce-ram", "gce-local-ssd", and "gce-gpu".

string cloud_resource_type = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The cloudResourceType.

getCloudResourceTypeBytes()

public ByteString getCloudResourceTypeBytes()

Required. The resource for the ReservationsUsage values to return. Possible values include "gce-vcpus", "gce-ram", "gce-local-ssd", and "gce-gpu".

string cloud_resource_type = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for cloudResourceType.

getDefaultInstanceForType()

public ExportReservationsUsageRequest getDefaultInstanceForType()
Returns
Type Description
ExportReservationsUsageRequest

getEndDate()

public Date getEndDate()

Optional. The end date of reservations usage.

.google.type.Date end_date = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.Date

The endDate.

getEndDateOrBuilder()

public DateOrBuilder getEndDateOrBuilder()

Optional. The end date of reservations usage.

.google.type.Date end_date = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.DateOrBuilder

getGpuType()

public String getGpuType()

Optional. The GPU type to query reservations and usage by. For example: NVIDIA T4.

string gpu_type = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The gpuType.

getGpuTypeBytes()

public ByteString getGpuTypeBytes()

Optional. The GPU type to query reservations and usage by. For example: NVIDIA T4.

string gpu_type = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for gpuType.

getLocationLevel()

public TimeSeries.LocationType getLocationLevel()

Optional. The location level of the reservations usage timeseries.

.google.cloud.capacityplanner.v1beta.TimeSeries.LocationType location_level = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TimeSeries.LocationType

The locationLevel.

getLocationLevelValue()

public int getLocationLevelValue()

Optional. The location level of the reservations usage timeseries.

.google.cloud.capacityplanner.v1beta.TimeSeries.LocationType location_level = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for locationLevel.

getMachineFamily()

public String getMachineFamily()

Optional. The machine family to query reservations and usage by. For example: n1, n2d.

string machine_family = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The machineFamily.

getMachineFamilyBytes()

public ByteString getMachineFamilyBytes()

Optional. The machine family to query reservations and usage by. For example: n1, n2d.

string machine_family = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for machineFamily.

getMachineShape()

public MachineShape getMachineShape()

Optional. The machine_shape as a filter to select matching reservations and its usage.

.google.cloud.capacityplanner.v1beta.MachineShape machine_shape = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MachineShape

The machineShape.

getMachineShapeOrBuilder()

public MachineShapeOrBuilder getMachineShapeOrBuilder()

Optional. The machine_shape as a filter to select matching reservations and its usage.

.google.cloud.capacityplanner.v1beta.MachineShape machine_shape = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MachineShapeOrBuilder

getOutputConfig()

public OutputConfig getOutputConfig()

Required. Output configuration indicating where the results will be output to.

.google.cloud.capacityplanner.v1beta.OutputConfig output_config = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
OutputConfig

The outputConfig.

getOutputConfigOrBuilder()

public OutputConfigOrBuilder getOutputConfigOrBuilder()

Required. Output configuration indicating where the results will be output to.

.google.cloud.capacityplanner.v1beta.OutputConfig output_config = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
OutputConfigOrBuilder

getParent()

public String getParent()

Required. The compute engine resource and location of the reservationsusage. The format is: projects/{project}/locations/{location} or organizations/{organization}/locations/{location} or folders/{folder}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The compute engine resource and location of the reservationsusage. The format is: projects/{project}/locations/{location} or organizations/{organization}/locations/{location} or folders/{folder}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

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

getResourceCase()

public ExportReservationsUsageRequest.ResourceCase getResourceCase()
Returns
Type Description
ExportReservationsUsageRequest.ResourceCase

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getShareType()

public ExportReservationsUsageRequest.ShareType getShareType()

Optional. Type of share settings to filter reservations in response. If unspecified, all types are included.

.google.cloud.capacityplanner.v1beta.ExportReservationsUsageRequest.ShareType share_type = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ExportReservationsUsageRequest.ShareType

The shareType.

getShareTypeValue()

public int getShareTypeValue()

Optional. Type of share settings to filter reservations in response. If unspecified, all types are included.

.google.cloud.capacityplanner.v1beta.ExportReservationsUsageRequest.ShareType share_type = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for shareType.

getStartDate()

public Date getStartDate()

Optional. The start date of reservations usage.

.google.type.Date start_date = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.Date

The startDate.

getStartDateOrBuilder()

public DateOrBuilder getStartDateOrBuilder()

Optional. The start date of reservations usage.

.google.type.Date start_date = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.DateOrBuilder

getUsageAggregationMethod()

public UsageHistory.AggregationMethod getUsageAggregationMethod()

Required. The method that should be used to convert sampled reservations data to daily usage values.

.google.cloud.capacityplanner.v1beta.UsageHistory.AggregationMethod usage_aggregation_method = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
UsageHistory.AggregationMethod

The usageAggregationMethod.

getUsageAggregationMethodValue()

public int getUsageAggregationMethodValue()

Required. The method that should be used to convert sampled reservations data to daily usage values.

.google.cloud.capacityplanner.v1beta.UsageHistory.AggregationMethod usage_aggregation_method = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for usageAggregationMethod.

hasEndDate()

public boolean hasEndDate()

Optional. The end date of reservations usage.

.google.type.Date end_date = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the endDate field is set.

hasGpuType()

public boolean hasGpuType()

Optional. The GPU type to query reservations and usage by. For example: NVIDIA T4.

string gpu_type = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the gpuType field is set.

hasMachineFamily()

public boolean hasMachineFamily()

Optional. The machine family to query reservations and usage by. For example: n1, n2d.

string machine_family = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the machineFamily field is set.

hasMachineShape()

public boolean hasMachineShape()

Optional. The machine_shape as a filter to select matching reservations and its usage.

.google.cloud.capacityplanner.v1beta.MachineShape machine_shape = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the machineShape field is set.

hasOutputConfig()

public boolean hasOutputConfig()

Required. Output configuration indicating where the results will be output to.

.google.cloud.capacityplanner.v1beta.OutputConfig output_config = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the outputConfig field is set.

hasStartDate()

public boolean hasStartDate()

Optional. The start date of reservations usage.

.google.type.Date start_date = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the startDate 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 ExportReservationsUsageRequest.Builder newBuilderForType()
Returns
Type Description
ExportReservationsUsageRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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