com.oracle.bmc.onesubscription.requests

Class ListInvoicesRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.onesubscription.requests.ListInvoicesRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190111")
public class ListInvoicesRequest
extends BmcRequest<Void>

Example: Click here to see how to use ListInvoicesRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListInvoicesRequest.Builder
static class	ListInvoicesRequest.SortBy The field to sort by.
static class	ListInvoicesRequest.SortOrder The sort order to use, either ascending (‘ASC’) or descending (‘DESC’).

Constructor Summary

Constructors

Constructor and Description
ListInvoicesRequest()

Method Summary

Modifier and Type	Method and Description
static ListInvoicesRequest.Builder	builder() Return a new builder for this request object.
boolean	equals(Object o) Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
String	getArCustomerTransactionId() AR Unique identifier for an invoice .
String	getCompartmentId() The OCID of the root compartment.
List<String>	getFields() Partial response refers to an optimization technique offered by the RESTful web APIs to return only the information (fields) required by the client.
Integer	getLimit() The maximum number of items to return in a paginated “List” call.
String	getOpcRequestId() Unique Oracle-assigned identifier for the request.
String	getPage() The value of the ‘opc-next-page’ response header from the previous “List” call.
ListInvoicesRequest.SortBy	getSortBy() The field to sort by.
ListInvoicesRequest.SortOrder	getSortOrder() The sort order to use, either ascending (‘ASC’) or descending (‘DESC’).
Date	getTimeFrom() Initial date to filter Invoice data in SPM.
Date	getTimeTo() Final date to filter Invoice data in SPM.
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListInvoicesRequest.Builder	toBuilder() Return an instance of ListInvoicesRequest.Builder that allows you to modify request properties.
String	toString()

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListInvoicesRequest

public ListInvoicesRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

The OCID of the root compartment.

getArCustomerTransactionId

public String getArCustomerTransactionId()

AR Unique identifier for an invoice .

getTimeFrom

public Date getTimeFrom()

Initial date to filter Invoice data in SPM.

getTimeTo

public Date getTimeTo()

Final date to filter Invoice data in SPM.

getSortOrder

public ListInvoicesRequest.SortOrder getSortOrder()

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

getSortBy

public ListInvoicesRequest.SortBy getSortBy()

The field to sort by. You can provide one sort order (‘sortOrder’).

getLimit

public Integer getLimit()

The maximum number of items to return in a paginated “List” call. Default: (50)

Example: '500'

getPage

public String getPage()

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

getFields

public List<String> getFields()

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.

getOpcRequestId

public String getOpcRequestId()

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

toBuilder

public ListInvoicesRequest.Builder toBuilder()

Return an instance of ListInvoicesRequest.Builder that allows you to modify request properties.

Returns:

instance of ListInvoicesRequest.Builder that allows you to modify request properties.

builder

public static ListInvoicesRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.

Overrides:

equals in class BmcRequest<Void>

hashCode

public int hashCode()

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to generate a hash.

Overrides:

hashCode in class BmcRequest<Void>