com.ibm.cloud.platform_services.enterprise_usage_reports.v1.model

Class GetResourceUsageReportOptions

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.cloud.platform_services.enterprise_usage_reports.v1.model.GetResourceUsageReportOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class GetResourceUsageReportOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The getResourceUsageReport options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetResourceUsageReportOptions.Builder Builder.

Method Summary

Modifier and Type	Method and Description
java.lang.String	accountGroupId() Gets the accountGroupId.
java.lang.String	accountId() Gets the accountId.
java.lang.String	billingUnitId() Gets the billingUnitId.
java.lang.Boolean	children() Gets the children.
java.lang.String	enterpriseId() Gets the enterpriseId.
java.lang.Long	limit() Gets the limit.
java.lang.String	month() Gets the month.
GetResourceUsageReportOptions.Builder	newBuilder() New builder.
java.lang.String	offset() Gets the offset.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public GetResourceUsageReportOptions.Builder newBuilder()

New builder.

Returns:

a GetResourceUsageReportOptions builder

enterpriseId

public java.lang.String enterpriseId()

Gets the enterpriseId. The ID of the enterprise for which the reports are queried. This parameter cannot be used with the `account_id` or `account_group_id` query parameters.

Returns:

the enterpriseId

accountGroupId

public java.lang.String accountGroupId()

Gets the accountGroupId. The ID of the account group for which the reports are queried. This parameter cannot be used with the `account_id` or `enterprise_id` query parameters.

Returns:

the accountGroupId

accountId

public java.lang.String accountId()

Gets the accountId. The ID of the account for which the reports are queried. This parameter cannot be used with the `account_group_id` or `enterprise_id` query parameters.

Returns:

the accountId

children

public java.lang.Boolean children()

Gets the children. Returns the reports for the immediate child entities under the current account group or enterprise. This parameter cannot be used with the `account_id` query parameter.

Returns:

the children

month

public java.lang.String month()

Gets the month. The billing month for which the usage report is requested. The format is in yyyy-mm. Defaults to the month in which the report is queried.

Returns:

the month

billingUnitId

public java.lang.String billingUnitId()

Gets the billingUnitId. The ID of the billing unit by which to filter the reports.

Returns:

the billingUnitId

limit

public java.lang.Long limit()

Gets the limit. The maximum number of search results to be returned.

Returns:

the limit

offset

public java.lang.String offset()

Gets the offset. An opaque value representing the offset of the first item to be returned by a search query. If not specified, then the first page of results is returned. To retrieve the next page of search results, use the 'offset' query parameter value within the 'next.href' URL found within a prior search query response.

Returns:

the offset