com.oracle.bmc.ospgateway

Interface InvoiceServiceAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

InvoiceServiceAsyncClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20191001")
public interface InvoiceServiceAsync
extends AutoCloseable

This site describes all the Rest endpoints of OSP Gateway.

Method Summary

Modifier and Type	Method and Description
Future<DownloadPdfContentResponse>	downloadPdfContent(DownloadPdfContentRequest request, AsyncHandler<DownloadPdfContentRequest,DownloadPdfContentResponse> handler) Returns an invoice in pdf format
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetInvoiceResponse>	getInvoice(GetInvoiceRequest request, AsyncHandler<GetInvoiceRequest,GetInvoiceResponse> handler) Returns an invoice by invoice id
Future<ListInvoiceLinesResponse>	listInvoiceLines(ListInvoiceLinesRequest request, AsyncHandler<ListInvoiceLinesRequest,ListInvoiceLinesResponse> handler) Returns the invoice product list by invoice id
Future<ListInvoicesResponse>	listInvoices(ListInvoicesRequest request, AsyncHandler<ListInvoicesRequest,ListInvoicesResponse> handler) Returns a list of invoices
Future<PayInvoiceResponse>	payInvoice(PayInvoiceRequest request, AsyncHandler<PayInvoiceRequest,PayInvoiceResponse> handler) Pay an invoice
void	refreshClient() Rebuilds the client from scratch.
void	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
void	useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled) Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

refreshClient

void refreshClient()

Rebuilds the client from scratch. Useful to refresh certificates.

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the serice.

getEndpoint

String getEndpoint()

Gets the set endpoint for REST call (ex, https://www.example.com)

setRegion

void setRegion(Region region)

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.

Parameters:

region - The region of the service.

setRegion

void setRegion(String regionId)

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Parameters:

regionId - The public region ID.

useRealmSpecificEndpointTemplate

void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)

Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

Parameters:

realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

downloadPdfContent

Future<DownloadPdfContentResponse> downloadPdfContent(DownloadPdfContentRequest request,
                                                      AsyncHandler<DownloadPdfContentRequest,DownloadPdfContentResponse> handler)

Returns an invoice in pdf format

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getInvoice

Future<GetInvoiceResponse> getInvoice(GetInvoiceRequest request,
                                      AsyncHandler<GetInvoiceRequest,GetInvoiceResponse> handler)

Returns an invoice by invoice id

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listInvoiceLines

Future<ListInvoiceLinesResponse> listInvoiceLines(ListInvoiceLinesRequest request,
                                                  AsyncHandler<ListInvoiceLinesRequest,ListInvoiceLinesResponse> handler)

Returns the invoice product list by invoice id

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listInvoices

Future<ListInvoicesResponse> listInvoices(ListInvoicesRequest request,
                                          AsyncHandler<ListInvoicesRequest,ListInvoicesResponse> handler)

Returns a list of invoices

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

payInvoice

Future<PayInvoiceResponse> payInvoice(PayInvoiceRequest request,
                                      AsyncHandler<PayInvoiceRequest,PayInvoiceResponse> handler)

Pay an invoice

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.