Package com.oracle.bmc.ospgateway.requests

Class PayInvoiceRequest.Builder

java.lang.Object

com.oracle.bmc.ospgateway.requests.PayInvoiceRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<PayInvoiceRequest,PayInvoiceDetails>

Enclosing class:

PayInvoiceRequest

public static class PayInvoiceRequest.Builder
extends Object
implements BmcRequest.Builder<PayInvoiceRequest,PayInvoiceDetails>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PayInvoiceRequest.Builder	body$(PayInvoiceDetails body)	Alternative setter for the body parameter.
PayInvoiceRequest	build()	Build the instance of PayInvoiceRequest as configured by this builder
PayInvoiceRequest	buildWithoutInvocationCallback()	Build the instance of PayInvoiceRequest as configured by this builder
PayInvoiceRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment.
PayInvoiceRequest.Builder	copy(PayInvoiceRequest o)	Copy method to populate the builder with values from the given instance.
PayInvoiceRequest.Builder	ifMatch(String ifMatch)	For optimistic concurrency control.
PayInvoiceRequest.Builder	internalInvoiceId(String internalInvoiceId)	The identifier of the invoice.
PayInvoiceRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
PayInvoiceRequest.Builder	opcRequestId(String opcRequestId)	The unique Oracle-assigned identifier for the request.
PayInvoiceRequest.Builder	opcRetryToken(String opcRetryToken)	For requests that are not idempotent (creates being the main place of interest), THE APIs should take a header called opc-retry-token to identify the customer desire across requests, to introduce some level of idempotency.
PayInvoiceRequest.Builder	ospHomeRegion(String ospHomeRegion)	The home region’s public name of the logged in user.
PayInvoiceRequest.Builder	payInvoiceDetails(PayInvoiceDetails payInvoiceDetails)	Invoice payment request.
PayInvoiceRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

ospHomeRegion

public PayInvoiceRequest.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

internalInvoiceId

public PayInvoiceRequest.Builder internalInvoiceId(String internalInvoiceId)

The identifier of the invoice.

Parameters:

internalInvoiceId - the value to set

Returns:

this builder instance

compartmentId

public PayInvoiceRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

payInvoiceDetails

public PayInvoiceRequest.Builder payInvoiceDetails(PayInvoiceDetails payInvoiceDetails)

Invoice payment request.

Parameters:

payInvoiceDetails - the value to set

Returns:

this builder instance

ifMatch

public PayInvoiceRequest.Builder ifMatch(String ifMatch)

For optimistic concurrency control.

In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.

Parameters:

ifMatch - the value to set

Returns:

this builder instance

opcRetryToken

public PayInvoiceRequest.Builder opcRetryToken(String opcRetryToken)

For requests that are not idempotent (creates being the main place of interest), THE APIs should take a header called opc-retry-token to identify the customer desire across requests, to introduce some level of idempotency.

Parameters:

opcRetryToken - the value to set

Returns:

this builder instance

opcRequestId

public PayInvoiceRequest.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

invocationCallback

public PayInvoiceRequest.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 PayInvoiceRequest.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 PayInvoiceRequest.Builder copy(PayInvoiceRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<PayInvoiceRequest,PayInvoiceDetails>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public PayInvoiceRequest build()

Build the instance of PayInvoiceRequest 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<PayInvoiceRequest,PayInvoiceDetails>

Returns:

instance of PayInvoiceRequest

body$

public PayInvoiceRequest.Builder body$(PayInvoiceDetails body)

Alternative setter for the body parameter.

Specified by:

body$ in interface BmcRequest.Builder<PayInvoiceRequest,PayInvoiceDetails>

Parameters:

body - the body parameter

Returns:

this builder instance

buildWithoutInvocationCallback

public PayInvoiceRequest buildWithoutInvocationCallback()

Build the instance of PayInvoiceRequest 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 PayInvoiceRequest