Package com.oracle.bmc.ccdoffers.requests

Class ListCcdOffersRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.ccdoffers.requests.ListCcdOffersRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20240601")
public class ListCcdOffersRequest
extends BmcRequest<Void>

Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.98.0/ccdoffers/ListCcdOffersExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListCcdOffersRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListCcdOffersRequest.Builder
static class	ListCcdOffersRequest.SortBy	The sort by field to use, whether “DISPLAYNAME” or “TIMECREATED”.
static class	ListCcdOffersRequest.SortOrder	The sort order to use, whether “asc” or “desc”.

Constructor Summary

Constructors

Constructor	Description
ListCcdOffersRequest()

Method Summary

Modifier and Type	Method	Description
static ListCcdOffersRequest.Builder	builder()	Return a new builder for this request object.
boolean	equals(Object o)	Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
String	getCompartmentId()	The OCID of the compartment (remember that the tenancy is simply the root compartment).
String	getDisplayName()	Filter by the resource display name.
CcdOffer.LifecycleDetails	getLifecycleDetails()	The life cycle details of a CCD offer that’s being requested.
CcdOffer.LifecycleState	getLifecycleState()	The life cycle of a CCD offer that’s being requested, which always defaults to Active.
Integer	getLimit()	The maximum number of items to return in a paginated “List” call.
String	getOpcRequestId()	Unique Oracle-assigned identifier for the request.
String	getPage()	The value of the opc-next-page response header from the previous “List” call.
ListCcdOffersRequest.SortBy	getSortBy()	The sort by field to use, whether “DISPLAYNAME” or “TIMECREATED”.
ListCcdOffersRequest.SortOrder	getSortOrder()	The sort order to use, whether “asc” or “desc”.
CcdOffer.SourceType	getSourceType()	Filter CCD offers or commitments by the commercial workflow that created the associated offer.
String	getSubscriptionId()	The subscription ID associated with the CCD offer.
CcdOffer.TypeOfOffer	getTypeOfOffer()	The CCD offer type to use when filtering results.
int	hashCode()	Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListCcdOffersRequest.Builder	toBuilder()	Return an instance of ListCcdOffersRequest.Builder that allows you to modify request properties.
String	toString()

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

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

Constructor Detail

ListCcdOffersRequest

public ListCcdOffersRequest()

Method Detail

getSubscriptionId

public String getSubscriptionId()

The subscription ID associated with the CCD offer.

getCompartmentId

public String getCompartmentId()

The OCID of the compartment (remember that the tenancy is simply the root compartment).

getOpcRequestId

public String getOpcRequestId()

Unique Oracle-assigned identifier for the request.

If you need to contact Oracle about a particular request, please provide the request ID.

getPage

public String getPage()

The value of the opc-next-page response header from the previous “List” call.

getLimit

public Integer getLimit()

The maximum number of items to return in a paginated “List” call.

getLifecycleState

public CcdOffer.LifecycleState getLifecycleState()

The life cycle of a CCD offer that’s being requested, which always defaults to Active.

If you want to filter by scheduled, current, canceled, or ended, use the lifecycleDetails query parameter.

getLifecycleDetails

public CcdOffer.LifecycleDetails getLifecycleDetails()

The life cycle details of a CCD offer that’s being requested.

The accepted values are Scheduled, Current, Canceled, or Ended. If a null or empty value is passed, it will return for all resources.

getTypeOfOffer

public CcdOffer.TypeOfOffer getTypeOfOffer()

The CCD offer type to use when filtering results.

getSourceType

public CcdOffer.SourceType getSourceType()

Filter CCD offers or commitments by the commercial workflow that created the associated offer.

getSortOrder

public ListCcdOffersRequest.SortOrder getSortOrder()

The sort order to use, whether “asc” or “desc”.

By default, it is ascending.

getSortBy

public ListCcdOffersRequest.SortBy getSortBy()

The sort by field to use, whether “DISPLAYNAME” or “TIMECREATED”.

By default, it is TIMECREATED.

getDisplayName

public String getDisplayName()

Filter by the resource display name.

toBuilder

public ListCcdOffersRequest.Builder toBuilder()

Return an instance of ListCcdOffersRequest.Builder that allows you to modify request properties.

Returns:

instance of ListCcdOffersRequest.Builder that allows you to modify request properties.

builder

public static ListCcdOffersRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.

Overrides:

equals in class BmcRequest<Void>

hashCode

public int hashCode()

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to generate a hash.

Overrides:

hashCode in class BmcRequest<Void>