Package com.oracle.bmc.ccdoffers.requests

Class ListCcdCommitmentsRequest.Builder

java.lang.Object

com.oracle.bmc.ccdoffers.requests.ListCcdCommitmentsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListCcdCommitmentsRequest,Void>

Enclosing class:

ListCcdCommitmentsRequest

public static class ListCcdCommitmentsRequest.Builder
extends Object
implements BmcRequest.Builder<ListCcdCommitmentsRequest,Void>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListCcdCommitmentsRequest	build()	Build the instance of ListCcdCommitmentsRequest as configured by this builder
ListCcdCommitmentsRequest	buildWithoutInvocationCallback()	Build the instance of ListCcdCommitmentsRequest as configured by this builder
ListCcdCommitmentsRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment (remember that the tenancy is simply the root compartment).
ListCcdCommitmentsRequest.Builder	copy(ListCcdCommitmentsRequest o)	Copy method to populate the builder with values from the given instance.
ListCcdCommitmentsRequest.Builder	displayName(String displayName)	Filter by the resource display name.
ListCcdCommitmentsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListCcdCommitmentsRequest.Builder	lifecycleDetails(CcdCommitment.LifecycleDetails lifecycleDetails)	The lifecycle details of a CCD commitment that’s being requested.
ListCcdCommitmentsRequest.Builder	lifecycleState(CcdCommitment.LifecycleState lifecycleState)	The lifecycle of a CCD commitment that’s being requested, which always defaults to Active.
ListCcdCommitmentsRequest.Builder	limit(Integer limit)	The maximum number of items to return in a paginated “List” call.
ListCcdCommitmentsRequest.Builder	opcRequestId(String opcRequestId)	Unique Oracle-assigned identifier for the request.
ListCcdCommitmentsRequest.Builder	page(String page)	The value of the opc-next-page response header from the previous “List” call.
ListCcdCommitmentsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListCcdCommitmentsRequest.Builder	sortBy(ListCcdCommitmentsRequest.SortBy sortBy)	The sort by field to use, whether “DISPLAYNAME” or “TIMECREATED”.
ListCcdCommitmentsRequest.Builder	sortOrder(ListCcdCommitmentsRequest.SortOrder sortOrder)	The sort order to use, whether “asc” or “desc”.
ListCcdCommitmentsRequest.Builder	sourceType(CcdOffer.SourceType sourceType)	Filter CCD offers or commitments by the commercial workflow that created the associated offer.
ListCcdCommitmentsRequest.Builder	subscriptionId(String subscriptionId)	The subscription ID associated with the CCD offer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder

body$

Constructor Detail

Builder

public Builder()

Method Detail

subscriptionId

public ListCcdCommitmentsRequest.Builder subscriptionId(String subscriptionId)

The subscription ID associated with the CCD offer.

Parameters:

subscriptionId - the value to set

Returns:

this builder instance

compartmentId

public ListCcdCommitmentsRequest.Builder compartmentId(String compartmentId)

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

Parameters:

compartmentId - the value to set

Returns:

this builder instance

opcRequestId

public ListCcdCommitmentsRequest.Builder opcRequestId(String opcRequestId)

Unique Oracle-assigned identifier for the request.

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

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

page

public ListCcdCommitmentsRequest.Builder page(String page)

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

Parameters:

page - the value to set

Returns:

this builder instance

limit

public ListCcdCommitmentsRequest.Builder limit(Integer limit)

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

Parameters:

limit - the value to set

Returns:

this builder instance

lifecycleState

public ListCcdCommitmentsRequest.Builder lifecycleState(CcdCommitment.LifecycleState lifecycleState)

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.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

lifecycleDetails

public ListCcdCommitmentsRequest.Builder lifecycleDetails(CcdCommitment.LifecycleDetails lifecycleDetails)

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.

Parameters:

lifecycleDetails - the value to set

Returns:

this builder instance

sourceType

public ListCcdCommitmentsRequest.Builder sourceType(CcdOffer.SourceType sourceType)

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

Parameters:

sourceType - the value to set

Returns:

this builder instance

sortOrder

public ListCcdCommitmentsRequest.Builder sortOrder(ListCcdCommitmentsRequest.SortOrder sortOrder)

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

By default, it is ascending.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

displayName

public ListCcdCommitmentsRequest.Builder displayName(String displayName)

Filter by the resource display name.

Parameters:

displayName - the value to set

Returns:

this builder instance

sortBy

public ListCcdCommitmentsRequest.Builder sortBy(ListCcdCommitmentsRequest.SortBy sortBy)

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

By default, it is TIMECREATED.

Parameters:

sortBy - the value to set

Returns:

this builder instance

invocationCallback

public ListCcdCommitmentsRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)

Set the invocation callback for the request to be built.

Parameters:

invocationCallback - the invocation callback to be set for the request

Returns:

this builder instance

retryConfiguration

public ListCcdCommitmentsRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)

Set the retry configuration for the request to be built.

Parameters:

retryConfiguration - the retry configuration to be used for the request

Returns:

this builder instance

copy

public ListCcdCommitmentsRequest.Builder copy(ListCcdCommitmentsRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<ListCcdCommitmentsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListCcdCommitmentsRequest build()

Build the instance of ListCcdCommitmentsRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<ListCcdCommitmentsRequest,Void>

Returns:

instance of ListCcdCommitmentsRequest

buildWithoutInvocationCallback

public ListCcdCommitmentsRequest buildWithoutInvocationCallback()

Build the instance of ListCcdCommitmentsRequest as configured by this builder

Note that this method does not take calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method build() does

Returns:

instance of ListCcdCommitmentsRequest