Capacity Planner V1BETA API - Class Google::Cloud::CapacityPlanner::V1beta::ExportReservationsUsageRequest (v0.2.0)

Version latest

• 0.2.0 (latest)
• 0.1.0

Reference documentation and code samples for the Capacity Planner V1BETA API class Google::Cloud::CapacityPlanner::V1beta::ExportReservationsUsageRequest.

The ExportReservationsUsage request

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#cloud_resource_type

def cloud_resource_type() -> ::String

Returns

• (::String) — Required. The resource for the ReservationsUsage values to return. Possible values include "gce-vcpus", "gce-ram", "gce-local-ssd", and "gce-gpu".

#cloud_resource_type=

def cloud_resource_type=(value) -> ::String

Parameter

• value (::String) — Required. The resource for the ReservationsUsage values to return. Possible values include "gce-vcpus", "gce-ram", "gce-local-ssd", and "gce-gpu".

Returns

• (::String) — Required. The resource for the ReservationsUsage values to return. Possible values include "gce-vcpus", "gce-ram", "gce-local-ssd", and "gce-gpu".

#end_date

def end_date() -> ::Google::Type::Date

Returns

• (::Google::Type::Date) — Optional. The end date of reservations usage.

#end_date=

def end_date=(value) -> ::Google::Type::Date

Parameter

• value (::Google::Type::Date) — Optional. The end date of reservations usage.

Returns

• (::Google::Type::Date) — Optional. The end date of reservations usage.

#gpu_type

def gpu_type() -> ::String

Returns

• (::String) — Optional. The GPU type to query reservations and usage by. For example: NVIDIA T4.

  Note: The following fields are mutually exclusive: gpu_type, machine_family, machine_shape. If a field in that set is populated, all other fields in the set will automatically be cleared.

#gpu_type=

def gpu_type=(value) -> ::String

Parameter

• value (::String) — Optional. The GPU type to query reservations and usage by. For example: NVIDIA T4.

  Note: The following fields are mutually exclusive: gpu_type, machine_family, machine_shape. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::String) — Optional. The GPU type to query reservations and usage by. For example: NVIDIA T4.

  Note: The following fields are mutually exclusive: gpu_type, machine_family, machine_shape. If a field in that set is populated, all other fields in the set will automatically be cleared.

#location_level

def location_level() -> ::Google::Cloud::CapacityPlanner::V1beta::TimeSeries::LocationType

Returns

• (::Google::Cloud::CapacityPlanner::V1beta::TimeSeries::LocationType) — Optional. The location level of the reservations usage timeseries.

#location_level=

def location_level=(value) -> ::Google::Cloud::CapacityPlanner::V1beta::TimeSeries::LocationType

Parameter

• value (::Google::Cloud::CapacityPlanner::V1beta::TimeSeries::LocationType) — Optional. The location level of the reservations usage timeseries.

Returns

• (::Google::Cloud::CapacityPlanner::V1beta::TimeSeries::LocationType) — Optional. The location level of the reservations usage timeseries.

#machine_family

def machine_family() -> ::String

Returns

• (::String) — Optional. The machine family to query reservations and usage by. For example: n1, n2d.

  Note: The following fields are mutually exclusive: machine_family, machine_shape, gpu_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#machine_family=

def machine_family=(value) -> ::String

Parameter

• value (::String) — Optional. The machine family to query reservations and usage by. For example: n1, n2d.

  Note: The following fields are mutually exclusive: machine_family, machine_shape, gpu_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::String) — Optional. The machine family to query reservations and usage by. For example: n1, n2d.

  Note: The following fields are mutually exclusive: machine_family, machine_shape, gpu_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#machine_shape

def machine_shape() -> ::Google::Cloud::CapacityPlanner::V1beta::MachineShape

Returns

• (::Google::Cloud::CapacityPlanner::V1beta::MachineShape) — Optional. The machine_shape as a filter to select matching reservations and its usage.

  Note: The following fields are mutually exclusive: machine_shape, machine_family, gpu_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#machine_shape=

def machine_shape=(value) -> ::Google::Cloud::CapacityPlanner::V1beta::MachineShape

Parameter

• value (::Google::Cloud::CapacityPlanner::V1beta::MachineShape) — Optional. The machine_shape as a filter to select matching reservations and its usage.

  Note: The following fields are mutually exclusive: machine_shape, machine_family, gpu_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::CapacityPlanner::V1beta::MachineShape) — Optional. The machine_shape as a filter to select matching reservations and its usage.

  Note: The following fields are mutually exclusive: machine_shape, machine_family, gpu_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#output_config

def output_config() -> ::Google::Cloud::CapacityPlanner::V1beta::OutputConfig

Returns

• (::Google::Cloud::CapacityPlanner::V1beta::OutputConfig) — Required. Output configuration indicating where the results will be output to.

#output_config=

def output_config=(value) -> ::Google::Cloud::CapacityPlanner::V1beta::OutputConfig

Parameter

• value (::Google::Cloud::CapacityPlanner::V1beta::OutputConfig) — Required. Output configuration indicating where the results will be output to.

Returns

• (::Google::Cloud::CapacityPlanner::V1beta::OutputConfig) — Required. Output configuration indicating where the results will be output to.

#parent

def parent() -> ::String

Returns

• (::String) — 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}

#parent=

def parent=(value) -> ::String

Parameter

• value (::String) — 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}

Returns

• (::String) — 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}

#share_type

def share_type() -> ::Google::Cloud::CapacityPlanner::V1beta::ExportReservationsUsageRequest::ShareType

Returns

• (::Google::Cloud::CapacityPlanner::V1beta::ExportReservationsUsageRequest::ShareType) — Optional. Type of share settings to filter reservations in response. If unspecified, all types are included.

#share_type=

def share_type=(value) -> ::Google::Cloud::CapacityPlanner::V1beta::ExportReservationsUsageRequest::ShareType

Parameter

• value (::Google::Cloud::CapacityPlanner::V1beta::ExportReservationsUsageRequest::ShareType) — Optional. Type of share settings to filter reservations in response. If unspecified, all types are included.

Returns

• (::Google::Cloud::CapacityPlanner::V1beta::ExportReservationsUsageRequest::ShareType) — Optional. Type of share settings to filter reservations in response. If unspecified, all types are included.

#start_date

def start_date() -> ::Google::Type::Date

Returns

• (::Google::Type::Date) — Optional. The start date of reservations usage.

#start_date=

def start_date=(value) -> ::Google::Type::Date

Parameter

• value (::Google::Type::Date) — Optional. The start date of reservations usage.

Returns

• (::Google::Type::Date) — Optional. The start date of reservations usage.

#usage_aggregation_method

def usage_aggregation_method() -> ::Google::Cloud::CapacityPlanner::V1beta::UsageHistory::AggregationMethod

Returns

• (::Google::Cloud::CapacityPlanner::V1beta::UsageHistory::AggregationMethod) — Required. The method that should be used to convert sampled reservations data to daily usage values.

#usage_aggregation_method=

def usage_aggregation_method=(value) -> ::Google::Cloud::CapacityPlanner::V1beta::UsageHistory::AggregationMethod

Parameter

• value (::Google::Cloud::CapacityPlanner::V1beta::UsageHistory::AggregationMethod) — Required. The method that should be used to convert sampled reservations data to daily usage values.

Returns

• (::Google::Cloud::CapacityPlanner::V1beta::UsageHistory::AggregationMethod) — Required. The method that should be used to convert sampled reservations data to daily usage values.