ListInvoicesRequest.Builder (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.ospgateway.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 and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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 compartment.
`ListInvoicesRequest.Builder`	`copy(ListInvoicesRequest o)` Copy method to populate the builder with values from the given instance.
`ListInvoicesRequest.Builder`	`invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)` Set the invocation callback for the request to be built.
`ListInvoicesRequest.Builder`	`invoiceId(String invoiceId)` The invoice query param (not unique).
`ListInvoicesRequest.Builder`	`limit(Integer limit)` For list pagination.
`ListInvoicesRequest.Builder`	`opcRequestId(String opcRequestId)` The unique Oracle-assigned identifier for the request.
`ListInvoicesRequest.Builder`	`ospHomeRegion(String ospHomeRegion)` The home region’s public name of the logged in user.
`ListInvoicesRequest.Builder`	`page(String page)` For list pagination.
`ListInvoicesRequest.Builder`	`retryConfiguration(RetryConfiguration retryConfiguration)` Set the retry configuration for the request to be built.
`ListInvoicesRequest.Builder`	`searchText(String searchText)` A filter to only return resources that match the given value.
`ListInvoicesRequest.Builder`	`sortBy(ListInvoicesRequest.SortBy sortBy)` The field to sort by.
`ListInvoicesRequest.Builder`	`sortOrder(ListInvoicesRequest.SortOrder sortOrder)` The sort order to use (ascending or descending).
`ListInvoicesRequest.Builder`	`status(List<ListInvoicesRequest.Status> status)` A filter to only return resources that match one of the status elements.
`ListInvoicesRequest.Builder`	`status(ListInvoicesRequest.Status singularValue)` Singular setter.
`ListInvoicesRequest.Builder`	`timeInvoiceEnd(Date timeInvoiceEnd)` description: End time (UTC) of the target invoice date range for which to fetch invoice data (exclusive).
`ListInvoicesRequest.Builder`	`timeInvoiceStart(Date timeInvoiceStart)` description: Start time (UTC) of the target invoice date range for which to fetch invoice data (inclusive).
`ListInvoicesRequest.Builder`	`timePaymentEnd(Date timePaymentEnd)` description: End time (UTC) of the target payment date range for which to fetch invoice data (exclusive).
`ListInvoicesRequest.Builder`	`timePaymentStart(Date timePaymentStart)` description: Start time (UTC) of the target payment date range for which to fetch invoice data (inclusive).
`ListInvoicesRequest.Builder`	`type(List<ListInvoicesRequest.Type> type)` A filter to only return resources that match the given type exactly.
`ListInvoicesRequest.Builder`	`type(ListInvoicesRequest.Type singularValue)` Singular setter.

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
  - ospHomeRegion
```
public ListInvoicesRequest.Builder ospHomeRegion(String ospHomeRegion)
```
    The home region’s public name of the logged in user.
    
    Parameters:
    
    ospHomeRegion - the value to set
    
    Returns:
    
    this builder instance
  - compartmentId
```
public ListInvoicesRequest.Builder compartmentId(String compartmentId)
```
    The OCID of the compartment.
    
    Parameters:
    
    compartmentId - the value to set
    
    Returns:
    
    this builder instance
  - opcRequestId
```
public ListInvoicesRequest.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
  - invoiceId
```
public ListInvoicesRequest.Builder invoiceId(String invoiceId)
```
    The invoice query param (not unique).
    
    Parameters:
    
    invoiceId - the value to set
    
    Returns:
    
    this builder instance
  - type
```
public ListInvoicesRequest.Builder type(List<ListInvoicesRequest.Type> type)
```
    A filter to only return resources that match the given type exactly.
    
    Parameters:
    
    type - the value to set
    
    Returns:
    
    this builder instance
  - type
```
public ListInvoicesRequest.Builder type(ListInvoicesRequest.Type singularValue)
```
    Singular setter. A filter to only return resources that match the given type exactly.
    
    Parameters:
    
    singularValue - the singular value to set
    
    Returns:
    
    this builder instance
  - searchText
```
public ListInvoicesRequest.Builder searchText(String searchText)
```
    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
    
    Parameters:
    
    searchText - the value to set
    
    Returns:
    
    this builder instance
  - timeInvoiceStart
```
public ListInvoicesRequest.Builder timeInvoiceStart(Date timeInvoiceStart)
```
    description: Start time (UTC) of the target invoice date range for which to fetch invoice data (inclusive).
    
    Parameters:
    
    timeInvoiceStart - the value to set
    
    Returns:
    
    this builder instance
  - timeInvoiceEnd
```
public ListInvoicesRequest.Builder timeInvoiceEnd(Date timeInvoiceEnd)
```
    description: End time (UTC) of the target invoice date range for which to fetch invoice data (exclusive).
    
    Parameters:
    
    timeInvoiceEnd - the value to set
    
    Returns:
    
    this builder instance
  - timePaymentStart
```
public ListInvoicesRequest.Builder timePaymentStart(Date timePaymentStart)
```
    description: Start time (UTC) of the target payment date range for which to fetch invoice data (inclusive).
    
    Parameters:
    
    timePaymentStart - the value to set
    
    Returns:
    
    this builder instance
  - timePaymentEnd
```
public ListInvoicesRequest.Builder timePaymentEnd(Date timePaymentEnd)
```
    description: End time (UTC) of the target payment date range for which to fetch invoice data (exclusive).
    
    Parameters:
    
    timePaymentEnd - the value to set
    
    Returns:
    
    this builder instance
  - status
```
public ListInvoicesRequest.Builder status(List<ListInvoicesRequest.Status> status)
```
    A filter to only return resources that match one of the status elements.
    
    Parameters:
    
    status - the value to set
    
    Returns:
    
    this builder instance
  - status
```
public ListInvoicesRequest.Builder status(ListInvoicesRequest.Status singularValue)
```
    Singular setter. A filter to only return resources that match one of the status elements.
    
    Parameters:
    
    singularValue - the singular value to set
    
    Returns:
    
    this builder instance
  - page
```
public ListInvoicesRequest.Builder page(String page)
```
    For list pagination. The value of the opc-next-page response header from the previous “List” call.
    
    Parameters:
    
    page - the value to set
    
    Returns:
    
    this builder instance
  - limit
```
public ListInvoicesRequest.Builder limit(Integer limit)
```
    For list pagination. The maximum number of results per page, or items to return in a paginated “List” call.
    
    Parameters:
    
    limit - the value to set
    
    Returns:
    
    this builder instance
  - sortBy
```
public ListInvoicesRequest.Builder sortBy(ListInvoicesRequest.SortBy sortBy)
```
    The field to sort by. Only one field can be selected for sorting.
    
    Parameters:
    
    sortBy - the value to set
    
    Returns:
    
    this builder instance
  - sortOrder
```
public ListInvoicesRequest.Builder sortOrder(ListInvoicesRequest.SortOrder sortOrder)
```
    The sort order to use (ascending or descending).
    
    Parameters:
    
    sortOrder - 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

Class ListInvoicesRequest.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder

Constructor Detail

Builder

Method Detail

ospHomeRegion

compartmentId

opcRequestId

invoiceId

type

type

searchText

timeInvoiceStart

timeInvoiceEnd

timePaymentStart

timePaymentEnd

status

status

page

limit

sortBy

sortOrder

invocationCallback

retryConfiguration

copy

build

buildWithoutInvocationCallback