Package com.oracle.bmc.ccdoffers.requests

Class ListCcdOffersRequest.Builder

java.lang.Object

com.oracle.bmc.ccdoffers.requests.ListCcdOffersRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListCcdOffersRequest,Void>

Enclosing class:

ListCcdOffersRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

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 ListCcdOffersRequest.Builder subscriptionId(String subscriptionId)

The subscription ID associated with the CCD offer.

Parameters:

subscriptionId - the value to set

Returns:

this builder instance

compartmentId

public ListCcdOffersRequest.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 ListCcdOffersRequest.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 ListCcdOffersRequest.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 ListCcdOffersRequest.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 ListCcdOffersRequest.Builder lifecycleState(CcdOffer.LifecycleState lifecycleState)

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.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

lifecycleDetails

public ListCcdOffersRequest.Builder lifecycleDetails(CcdOffer.LifecycleDetails lifecycleDetails)

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.

Parameters:

lifecycleDetails - the value to set

Returns:

this builder instance

typeOfOffer

public ListCcdOffersRequest.Builder typeOfOffer(CcdOffer.TypeOfOffer typeOfOffer)

The CCD offer type to use when filtering results.

Parameters:

typeOfOffer - the value to set

Returns:

this builder instance

sourceType

public ListCcdOffersRequest.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 ListCcdOffersRequest.Builder sortOrder(ListCcdOffersRequest.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

sortBy

public ListCcdOffersRequest.Builder sortBy(ListCcdOffersRequest.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

displayName

public ListCcdOffersRequest.Builder displayName(String displayName)

Filter by the resource display name.

Parameters:

displayName - the value to set

Returns:

this builder instance

invocationCallback

public ListCcdOffersRequest.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 ListCcdOffersRequest.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 ListCcdOffersRequest.Builder copy(ListCcdOffersRequest o)

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

Specified by:

copy in interface BmcRequest.Builder<ListCcdOffersRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListCcdOffersRequest build()

Build the instance of ListCcdOffersRequest 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<ListCcdOffersRequest,Void>

Returns:

instance of ListCcdOffersRequest

buildWithoutInvocationCallback

public ListCcdOffersRequest buildWithoutInvocationCallback()

Build the instance of ListCcdOffersRequest 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 ListCcdOffersRequest