Package com.oracle.bmc.onesubscription.requests

Class ListInvoicesRequest.Builder

java.lang.Object

com.oracle.bmc.onesubscription.requests.ListInvoicesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListInvoicesRequest,Void>

Enclosing class:

ListInvoicesRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListInvoicesRequest.Builder	arCustomerTransactionId(String arCustomerTransactionId)	AR Unique identifier for an invoice .
ListInvoicesRequest	build()	Build the instance of ListInvoicesRequest as configured by this builder
ListInvoicesRequest	buildWithoutInvocationCallback()	Build the instance of ListInvoicesRequest as configured by this builder
ListInvoicesRequest.Builder	compartmentId(String compartmentId)	The OCID of the root compartment.
ListInvoicesRequest.Builder	copy(ListInvoicesRequest o)	Copy method to populate the builder with values from the given instance.
ListInvoicesRequest.Builder	fields(String singularValue)	Singular setter.
ListInvoicesRequest.Builder	fields(List<String> fields)	Partial response refers to an optimization technique offered by the RESTful web APIs to return only the information (fields) required by the client.
ListInvoicesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListInvoicesRequest.Builder	limit(Integer limit)	The maximum number of items to return in a paginated “List” call.
ListInvoicesRequest.Builder	opcRequestId(String opcRequestId)	Unique Oracle-assigned identifier for the request.
ListInvoicesRequest.Builder	page(String page)	The value of the ‘opc-next-page’ response header from the previous “List” call.
ListInvoicesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListInvoicesRequest.Builder	sortBy(ListInvoicesRequest.SortBy sortBy)	The field to sort by.
ListInvoicesRequest.Builder	sortOrder(ListInvoicesRequest.SortOrder sortOrder)	The sort order to use, either ascending (‘ASC’) or descending (‘DESC’).
ListInvoicesRequest.Builder	timeFrom(Date timeFrom)	Initial date to filter Invoice data in SPM.
ListInvoicesRequest.Builder	timeTo(Date timeTo)	Final date to filter Invoice data in SPM.

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 ListInvoicesRequest.Builder compartmentId(String compartmentId)

The OCID of the root compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

arCustomerTransactionId

public ListInvoicesRequest.Builder arCustomerTransactionId(String arCustomerTransactionId)

AR Unique identifier for an invoice .

Parameters:

arCustomerTransactionId - the value to set

Returns:

this builder instance

timeFrom

public ListInvoicesRequest.Builder timeFrom(Date timeFrom)

Initial date to filter Invoice data in SPM.

Parameters:

timeFrom - the value to set

Returns:

this builder instance

timeTo

public ListInvoicesRequest.Builder timeTo(Date timeTo)

Final date to filter Invoice data in SPM.

Parameters:

timeTo - the value to set

Returns:

this builder instance

sortOrder

public ListInvoicesRequest.Builder sortOrder(ListInvoicesRequest.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 ListInvoicesRequest.Builder sortBy(ListInvoicesRequest.SortBy sortBy)

The field to sort by.

You can provide one sort order (‘sortOrder’).

Parameters:

sortBy - the value to set

Returns:

this builder instance

limit

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

fields

public ListInvoicesRequest.Builder fields(List<String> fields)

Partial response refers to an optimization technique offered by the RESTful web APIs to return only the information (fields) required by the client.

This parameter is used to control what fields to return.

Parameters:

fields - the value to set

Returns:

this builder instance

fields

public ListInvoicesRequest.Builder fields(String singularValue)

Singular setter.

Partial response refers to an optimization technique offered by the RESTful web APIs to return only the information (fields) required by the client. This parameter is used to control what fields to return.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

opcRequestId

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

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListInvoicesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListInvoicesRequest build()

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

Returns:

instance of ListInvoicesRequest

buildWithoutInvocationCallback

public ListInvoicesRequest buildWithoutInvocationCallback()

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