Package com.oracle.bmc.ccdoffers.requests

Class ListCcdCommitmentsRequest

java.lang.Object

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

com.oracle.bmc.ccdoffers.requests.ListCcdCommitmentsRequest

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

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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ListCcdCommitmentsRequest()

Method Summary

Modifier and Type	Method	Description
static ListCcdCommitmentsRequest.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.
CcdCommitment.LifecycleDetails	getLifecycleDetails()	The lifecycle details of a CCD commitment that’s being requested.
CcdCommitment.LifecycleState	getLifecycleState()	The lifecycle of a CCD commitment 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.
ListCcdCommitmentsRequest.SortBy	getSortBy()	The sort by field to use, whether “DISPLAYNAME” or “TIMECREATED”.
ListCcdCommitmentsRequest.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.
int	hashCode()	Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListCcdCommitmentsRequest.Builder	toBuilder()	Return an instance of ListCcdCommitmentsRequest.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

ListCcdCommitmentsRequest

public ListCcdCommitmentsRequest()

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 CcdCommitment.LifecycleState getLifecycleState()

The lifecycle of a CCD commitment that’s being requested, which always defaults to Active.

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

getLifecycleDetails

public CcdCommitment.LifecycleDetails getLifecycleDetails()

The lifecycle details of a CCD commitment that’s being requested.

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

getSourceType

public CcdOffer.SourceType getSourceType()

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

getSortOrder

public ListCcdCommitmentsRequest.SortOrder getSortOrder()

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

By default, it is ascending.

getDisplayName

public String getDisplayName()

Filter by the resource display name.

getSortBy

public ListCcdCommitmentsRequest.SortBy getSortBy()

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

By default, it is TIMECREATED.

toBuilder

public ListCcdCommitmentsRequest.Builder toBuilder()

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

Returns:

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

builder

public static ListCcdCommitmentsRequest.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>