Package com.oracle.bmc.osubsubscription.requests

Class ListCommitmentsRequest.Builder

java.lang.Object

com.oracle.bmc.osubsubscription.requests.ListCommitmentsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListCommitmentsRequest,Void>

Enclosing class:

ListCommitmentsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListCommitmentsRequest	build()	Build the instance of ListCommitmentsRequest as configured by this builder
ListCommitmentsRequest	buildWithoutInvocationCallback()	Build the instance of ListCommitmentsRequest as configured by this builder
ListCommitmentsRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment.
ListCommitmentsRequest.Builder	copy(ListCommitmentsRequest o)	Copy method to populate the builder with values from the given instance.
ListCommitmentsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListCommitmentsRequest.Builder	limit(Integer limit)	The maximum number of items to return in a paginated “List” call.
ListCommitmentsRequest.Builder	opcRequestId(String opcRequestId)	Unique Oracle-assigned identifier for the request.
ListCommitmentsRequest.Builder	page(String page)	The value of the opc-next-page response header from the previous “List” call.
ListCommitmentsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListCommitmentsRequest.Builder	sortBy(ListCommitmentsRequest.SortBy sortBy)	The field to sort by.
ListCommitmentsRequest.Builder	sortOrder(ListCommitmentsRequest.SortOrder sortOrder)	The sort order to use, either ascending (ASC) or descending (DESC).
ListCommitmentsRequest.Builder	subscribedServiceId(String subscribedServiceId)	This param is used to get the commitments for a particular subscribed service
ListCommitmentsRequest.Builder	xOneGatewaySubscriptionId(String xOneGatewaySubscriptionId)	This header is meant to be used only for internal purposes and will be ignored on any public request.
ListCommitmentsRequest.Builder	xOneOriginRegion(String xOneOriginRegion)	The OCI home region name in case home region is not us-ashburn-1 (IAD), e.g.

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

subscribedServiceId

public ListCommitmentsRequest.Builder subscribedServiceId(String subscribedServiceId)

This param is used to get the commitments for a particular subscribed service

Parameters:

subscribedServiceId - the value to set

Returns:

this builder instance

compartmentId

public ListCommitmentsRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

limit

public ListCommitmentsRequest.Builder limit(Integer limit)

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

Default: (50)

Example: 500

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListCommitmentsRequest.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

sortOrder

public ListCommitmentsRequest.Builder sortOrder(ListCommitmentsRequest.SortOrder sortOrder)

The sort order to use, either ascending (ASC) or descending (DESC).

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListCommitmentsRequest.Builder sortBy(ListCommitmentsRequest.SortBy sortBy)

The field to sort by.

You can provide one sort order (sortOrder).

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListCommitmentsRequest.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

xOneGatewaySubscriptionId

public ListCommitmentsRequest.Builder xOneGatewaySubscriptionId(String xOneGatewaySubscriptionId)

This header is meant to be used only for internal purposes and will be ignored on any public request.

The purpose of this header is to help on Gateway to API calls identification.

Parameters:

xOneGatewaySubscriptionId - the value to set

Returns:

this builder instance

xOneOriginRegion

public ListCommitmentsRequest.Builder xOneOriginRegion(String xOneOriginRegion)

The OCI home region name in case home region is not us-ashburn-1 (IAD), e.g.

ap-mumbai-1, us-phoenix-1 etc.

Parameters:

xOneOriginRegion - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListCommitmentsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListCommitmentsRequest build()

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

Returns:

instance of ListCommitmentsRequest

buildWithoutInvocationCallback

public ListCommitmentsRequest buildWithoutInvocationCallback()

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