ListInvoicesRequest (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.requests.BmcRequest<Void>
- - com.oracle.bmc.ospgateway.requests.ListInvoicesRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20191001")
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 (ascending or descending).
`static class`	`ListInvoicesRequest.Status` A filter to only return resources that match one of the status elements.
`static class`	`ListInvoicesRequest.Type` A filter to only return resources that match the given type exactly.

Constructor Summary

Constructors
Constructor and Description

ListInvoicesRequest()

Constructors
Constructor and Description
`ListInvoicesRequest()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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`	`getCompartmentId()` The OCID of the compartment.
`String`	`getInvoiceId()` The invoice query param (not unique).
`Integer`	`getLimit()` For list pagination.
`String`	`getOpcRequestId()` The unique Oracle-assigned identifier for the request.
`String`	`getOspHomeRegion()` The home region’s public name of the logged in user.
`String`	`getPage()` For list pagination.
`String`	`getSearchText()` A filter to only return resources that match the given value.
`ListInvoicesRequest.SortBy`	`getSortBy()` The field to sort by.
`ListInvoicesRequest.SortOrder`	`getSortOrder()` The sort order to use (ascending or descending).
`List<ListInvoicesRequest.Status>`	`getStatus()` A filter to only return resources that match one of the status elements.
`Date`	`getTimeInvoiceEnd()` description: End time (UTC) of the target invoice date range for which to fetch invoice data (exclusive).
`Date`	`getTimeInvoiceStart()` description: Start time (UTC) of the target invoice date range for which to fetch invoice data (inclusive).
`Date`	`getTimePaymentEnd()` description: End time (UTC) of the target payment date range for which to fetch invoice data (exclusive).
`Date`	`getTimePaymentStart()` description: Start time (UTC) of the target payment date range for which to fetch invoice data (inclusive).
`List<ListInvoicesRequest.Type>`	`getType()` A filter to only return resources that match the given type exactly.
`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
  - getOspHomeRegion
```
public String getOspHomeRegion()
```
    The home region’s public name of the logged in user.
  - getCompartmentId
```
public String getCompartmentId()
```
    The OCID of the compartment.
  - getOpcRequestId
```
public String getOpcRequestId()
```
    The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  - getInvoiceId
```
public String getInvoiceId()
```
    The invoice query param (not unique).
  - getType
```
public List<ListInvoicesRequest.Type> getType()
```
    A filter to only return resources that match the given type exactly.
  - getSearchText
```
public String getSearchText()
```
    A filter to only return resources that match the given value. Looking for partial matches in the following fileds: Invoice No., Reference No. (plan number), Payment Ref, Total Amount(plan number), Balance Due(plan number) and Party/Customer Name
  - getTimeInvoiceStart
```
public Date getTimeInvoiceStart()
```
    description: Start time (UTC) of the target invoice date range for which to fetch invoice data (inclusive).
  - getTimeInvoiceEnd
```
public Date getTimeInvoiceEnd()
```
    description: End time (UTC) of the target invoice date range for which to fetch invoice data (exclusive).
  - getTimePaymentStart
```
public Date getTimePaymentStart()
```
    description: Start time (UTC) of the target payment date range for which to fetch invoice data (inclusive).
  - getTimePaymentEnd
```
public Date getTimePaymentEnd()
```
    description: End time (UTC) of the target payment date range for which to fetch invoice data (exclusive).
  - getStatus
```
public List<ListInvoicesRequest.Status> getStatus()
```
    A filter to only return resources that match one of the status elements.
  - getPage
```
public String getPage()
```
    For list pagination. The value of the opc-next-page response header from the previous “List” call.
  - getLimit
```
public Integer getLimit()
```
    For list pagination. The maximum number of results per page, or items to return in a paginated “List” call.
  - getSortBy
```
public ListInvoicesRequest.SortBy getSortBy()
```
    The field to sort by. Only one field can be selected for sorting.
  - getSortOrder
```
public ListInvoicesRequest.SortOrder getSortOrder()
```
    The sort order to use (ascending or descending).
  - 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>

Class ListInvoicesRequest

Nested Class Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

ListInvoicesRequest

Method Detail

getOspHomeRegion

getCompartmentId

getOpcRequestId

getInvoiceId

getType

getSearchText

getTimeInvoiceStart

getTimeInvoiceEnd

getTimePaymentStart

getTimePaymentEnd

getStatus

getPage

getLimit

getSortBy

getSortOrder

toBuilder

builder

toString

equals

hashCode