Package com.oracle.bmc.usage.requests

Class ListProductsRequest.Builder

java.lang.Object

com.oracle.bmc.usage.requests.ListProductsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListProductsRequest,Void>

Enclosing class:

ListProductsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListProductsRequest	build()	Build the instance of ListProductsRequest as configured by this builder
ListProductsRequest	buildWithoutInvocationCallback()	Build the instance of ListProductsRequest as configured by this builder
ListProductsRequest.Builder	copy(ListProductsRequest o)	Copy method to populate the builder with values from the given instance.
ListProductsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListProductsRequest.Builder	limit(Integer limit)	The maximum number of items to return in the paginated response.
ListProductsRequest.Builder	opcRequestId(String opcRequestId)	Unique, Oracle-assigned identifier for the request.
ListProductsRequest.Builder	page(String page)	The value of the ‘opc-next-page’ response header from the previous call.
ListProductsRequest.Builder	producttype(ListProductsRequest.Producttype producttype)	The field to specify the type of product.
ListProductsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListProductsRequest.Builder	sortBy(ListProductsRequest.SortBy sortBy)	The field to sort by.
ListProductsRequest.Builder	sortOrder(ListProductsRequest.SortOrder sortOrder)	The sort order to use, which can be ascending (ASC) or descending (DESC).
ListProductsRequest.Builder	subscriptionId(String subscriptionId)	The subscription ID for which rewards information is requested for.
ListProductsRequest.Builder	tenancyId(String tenancyId)	The OCID of the tenancy.
ListProductsRequest.Builder	usagePeriodKey(String usagePeriodKey)	The SPM Identifier for the usage period.

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

tenancyId

public ListProductsRequest.Builder tenancyId(String tenancyId)

The OCID of the tenancy.

Parameters:

tenancyId - the value to set

Returns:

this builder instance

subscriptionId

public ListProductsRequest.Builder subscriptionId(String subscriptionId)

The subscription ID for which rewards information is requested for.

Parameters:

subscriptionId - the value to set

Returns:

this builder instance

usagePeriodKey

public ListProductsRequest.Builder usagePeriodKey(String usagePeriodKey)

The SPM Identifier for the usage period.

Parameters:

usagePeriodKey - the value to set

Returns:

this builder instance

opcRequestId

public ListProductsRequest.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 ListProductsRequest.Builder page(String page)

The value of the ‘opc-next-page’ response header from the previous call.

Parameters:

page - the value to set

Returns:

this builder instance

limit

public ListProductsRequest.Builder limit(Integer limit)

The maximum number of items to return in the paginated response.

Parameters:

limit - the value to set

Returns:

this builder instance

sortOrder

public ListProductsRequest.Builder sortOrder(ListProductsRequest.SortOrder sortOrder)

The sort order to use, which can be ascending (ASC) or descending (DESC).

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListProductsRequest.Builder sortBy(ListProductsRequest.SortBy sortBy)

The field to sort by.

Supports one sort order.

Parameters:

sortBy - the value to set

Returns:

this builder instance

producttype

public ListProductsRequest.Builder producttype(ListProductsRequest.Producttype producttype)

The field to specify the type of product.

Parameters:

producttype - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListProductsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListProductsRequest build()

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

Returns:

instance of ListProductsRequest

buildWithoutInvocationCallback

public ListProductsRequest buildWithoutInvocationCallback()

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