Package software.amazon.awssdk.services.billingconductor.model

Class GetBillingGroupCostReportRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.billingconductor.model.BillingconductorRequest

software.amazon.awssdk.services.billingconductor.model.GetBillingGroupCostReportRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetBillingGroupCostReportRequest.Builder,GetBillingGroupCostReportRequest>

@Generated("software.amazon.awssdk:codegen")
public final class GetBillingGroupCostReportRequest
extends BillingconductorRequest
implements ToCopyableBuilder<GetBillingGroupCostReportRequest.Builder,GetBillingGroupCostReportRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetBillingGroupCostReportRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Number (ARN) that uniquely identifies the billing group.
BillingPeriodRange	billingPeriodRange()	A time range for which the margin summary is effective.
static GetBillingGroupCostReportRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
List<GroupByAttributeName>	groupBy()	A list of strings that specify the attributes that are used to break down costs in the margin summary reports for the billing group.
List<String>	groupByAsStrings()	A list of strings that specify the attributes that are used to break down costs in the margin summary reports for the billing group.
boolean	hasGroupBy()	For responses, this returns true if the service returned a value for the GroupBy property.
int	hashCode()
Integer	maxResults()	The maximum number of margin summary reports to retrieve.
String	nextToken()	The pagination token used on subsequent calls to get reports.
List<SdkField<?>>	sdkFields()
static Class<? extends GetBillingGroupCostReportRequest.Builder>	serializableBuilderClass()
GetBillingGroupCostReportRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

arn

public final String arn()

The Amazon Resource Number (ARN) that uniquely identifies the billing group.

Returns:

The Amazon Resource Number (ARN) that uniquely identifies the billing group.

billingPeriodRange

public final BillingPeriodRange billingPeriodRange()

A time range for which the margin summary is effective. You can specify up to 12 months.

Returns:

A time range for which the margin summary is effective. You can specify up to 12 months.

groupBy

public final List<GroupByAttributeName> groupBy()

A list of strings that specify the attributes that are used to break down costs in the margin summary reports for the billing group. For example, you can view your costs by the Amazon Web Service name or the billing period.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGroupBy() method.

Returns:

A list of strings that specify the attributes that are used to break down costs in the margin summary reports for the billing group. For example, you can view your costs by the Amazon Web Service name or the billing period.

hasGroupBy

public final boolean hasGroupBy()

For responses, this returns true if the service returned a value for the GroupBy property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

groupByAsStrings

public final List<String> groupByAsStrings()

A list of strings that specify the attributes that are used to break down costs in the margin summary reports for the billing group. For example, you can view your costs by the Amazon Web Service name or the billing period.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGroupBy() method.

Returns:

A list of strings that specify the attributes that are used to break down costs in the margin summary reports for the billing group. For example, you can view your costs by the Amazon Web Service name or the billing period.

maxResults

public final Integer maxResults()

The maximum number of margin summary reports to retrieve.

Returns:

The maximum number of margin summary reports to retrieve.

nextToken

public final String nextToken()

The pagination token used on subsequent calls to get reports.

Returns:

The pagination token used on subsequent calls to get reports.

toBuilder

public GetBillingGroupCostReportRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetBillingGroupCostReportRequest.Builder,GetBillingGroupCostReportRequest>

Specified by:

toBuilder in class BillingconductorRequest

builder

public static GetBillingGroupCostReportRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetBillingGroupCostReportRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo