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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/onesubscription/ListInvoicesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListInvoicesRequest.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classListInvoicesRequest.Builderstatic classListInvoicesRequest.SortByThe field to sort by.static classListInvoicesRequest.SortOrderThe sort order to use, either ascending (‘ASC’) or descending (‘DESC’).
-
Constructor Summary
Constructors Constructor Description ListInvoicesRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListInvoicesRequest.Builderbuilder()Return a new builder for this request object.booleanequals(Object o)Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.StringgetArCustomerTransactionId()AR Unique identifier for an invoice .StringgetCompartmentId()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.IntegergetLimit()The maximum number of items to return in a paginated “List” call.StringgetOpcRequestId()Unique Oracle-assigned identifier for the request.StringgetPage()The value of the ‘opc-next-page’ response header from the previous “List” call.ListInvoicesRequest.SortBygetSortBy()The field to sort by.ListInvoicesRequest.SortOrdergetSortOrder()The sort order to use, either ascending (‘ASC’) or descending (‘DESC’).DategetTimeFrom()Initial date to filter Invoice data in SPM.DategetTimeTo()Final date to filter Invoice data in SPM.inthashCode()Uses getInvocationCallback and getRetryConfiguration to generate a hash.ListInvoicesRequest.BuildertoBuilder()Return an instance ofListInvoicesRequest.Builderthat allows you to modify request properties.StringtoString()-
Methods inherited from class com.oracle.bmc.requests.BmcRequest
getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue
-
-
-
-
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 ofListInvoicesRequest.Builderthat allows you to modify request properties.- Returns:
- instance of
ListInvoicesRequest.Builderthat 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
-
equals
public boolean equals(Object o)
Description copied from class:BmcRequestUses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.- Overrides:
equalsin classBmcRequest<Void>
-
hashCode
public int hashCode()
Description copied from class:BmcRequestUses getInvocationCallback and getRetryConfiguration to generate a hash.- Overrides:
hashCodein classBmcRequest<Void>
-
-