Package com.oracle.bmc.licensemanager.requests

Class ListProductLicensesRequest.Builder

java.lang.Object

com.oracle.bmc.licensemanager.requests.ListProductLicensesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListProductLicensesRequest,Void>

Enclosing class:

ListProductLicensesRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListProductLicensesRequest	build()	Build the instance of ListProductLicensesRequest as configured by this builder
ListProductLicensesRequest	buildWithoutInvocationCallback()	Build the instance of ListProductLicensesRequest as configured by this builder
ListProductLicensesRequest.Builder	compartmentId(String compartmentId)	The compartment OCID used for the license record, product license, and configuration.
ListProductLicensesRequest.Builder	copy(ListProductLicensesRequest o)	Copy method to populate the builder with values from the given instance.
ListProductLicensesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListProductLicensesRequest.Builder	isCompartmentIdInSubtree(Boolean isCompartmentIdInSubtree)	Indicates if the given compartment is the root compartment.
ListProductLicensesRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListProductLicensesRequest.Builder	opcRequestId(String opcRequestId)	The unique Oracle-assigned identifier for the request.
ListProductLicensesRequest.Builder	page(String page)	A token representing the position at which to start retrieving results.
ListProductLicensesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListProductLicensesRequest.Builder	sortBy(ListProductLicensesRequest.SortBy sortBy)	Specifies the attribute with which to sort the rules.
ListProductLicensesRequest.Builder	sortOrder(ListProductLicensesRequest.SortOrder sortOrder)	The sort order to use, whether ASC or DESC.

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

compartmentId

public ListProductLicensesRequest.Builder compartmentId(String compartmentId)

The compartment OCID used for the license record, product license, and configuration.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

limit

public ListProductLicensesRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListProductLicensesRequest.Builder page(String page)

A token representing the position at which to start retrieving results.

This must come from the opc-next-page header field of a previous response.

Parameters:

page - the value to set

Returns:

this builder instance

opcRequestId

public ListProductLicensesRequest.Builder opcRequestId(String opcRequestId)

The 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

isCompartmentIdInSubtree

public ListProductLicensesRequest.Builder isCompartmentIdInSubtree(Boolean isCompartmentIdInSubtree)

Indicates if the given compartment is the root compartment.

Parameters:

isCompartmentIdInSubtree - the value to set

Returns:

this builder instance

sortOrder

public ListProductLicensesRequest.Builder sortOrder(ListProductLicensesRequest.SortOrder sortOrder)

The sort order to use, whether ASC or DESC.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListProductLicensesRequest.Builder sortBy(ListProductLicensesRequest.SortBy sortBy)

Specifies the attribute with which to sort the rules.

Default: totalLicenseUnitsConsumed

**totalLicenseUnitsConsumed:** Sorts by totalLicenseUnitsConsumed of ProductLicense.

Parameters:

sortBy - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListProductLicensesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListProductLicensesRequest build()

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

Returns:

instance of ListProductLicensesRequest

buildWithoutInvocationCallback

public ListProductLicensesRequest buildWithoutInvocationCallback()

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