Package com.ibm.cloud.platform_services.catalog_management.v1.model

Class GetConsumptionOfferingsOptions

java.lang.Object

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

com.ibm.cloud.platform_services.catalog_management.v1.model.GetConsumptionOfferingsOptions

All Implemented Interfaces:

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

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

The getConsumptionOfferings options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetConsumptionOfferingsOptions.Builder	Builder.
static interface	GetConsumptionOfferingsOptions.Select	What should be selected.

Method Summary

Modifier and Type	Method	Description
java.lang.String	catalog()	Gets the catalog.
java.lang.Boolean	digest()	Gets the digest.
java.lang.Boolean	includeHidden()	Gets the includeHidden.
java.lang.Long	limit()	Gets the limit.
GetConsumptionOfferingsOptions.Builder	newBuilder()	New builder.
java.lang.Long	offset()	Gets the offset.
java.lang.String	select()	Gets the select.

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 GetConsumptionOfferingsOptions.Builder newBuilder()

New builder.

Returns:

a GetConsumptionOfferingsOptions builder

digest

public java.lang.Boolean digest()

Gets the digest. true - Strip down the content of what is returned. For example don't return the readme. Makes the result much smaller. Defaults to false.

Returns:

the digest

catalog

public java.lang.String catalog()

Gets the catalog. catalog id. Narrow search down to just a particular catalog. It will apply the catalog's public filters to the public catalog offerings on the result.

Returns:

the catalog

select

public java.lang.String select()

Gets the select. What should be selected. Default is 'all' which will return both public and private offerings. 'public' returns only the public offerings and 'private' returns only the private offerings.

Returns:

the select

includeHidden

public java.lang.Boolean includeHidden()

Gets the includeHidden. true - include offerings which have been marked as hidden. The default is false and hidden offerings are not returned.

Returns:

the includeHidden

limit

public java.lang.Long limit()

Gets the limit. number or results to return.

Returns:

the limit

offset

public java.lang.Long offset()

Gets the offset. number of results to skip before returning values.

Returns:

the offset