Package com.oracle.bmc.ospgateway.requests

Class PaySubscriptionRequest.Builder

java.lang.Object

com.oracle.bmc.ospgateway.requests.PaySubscriptionRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<PaySubscriptionRequest,PaySubscriptionDetails>

Enclosing class:

PaySubscriptionRequest

public static class PaySubscriptionRequest.Builder
extends Object
implements BmcRequest.Builder<PaySubscriptionRequest,PaySubscriptionDetails>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PaySubscriptionRequest.Builder	body$(PaySubscriptionDetails body)	Alternative setter for the body parameter.
PaySubscriptionRequest	build()	Build the instance of PaySubscriptionRequest as configured by this builder
PaySubscriptionRequest	buildWithoutInvocationCallback()	Build the instance of PaySubscriptionRequest as configured by this builder
PaySubscriptionRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment.
PaySubscriptionRequest.Builder	copy(PaySubscriptionRequest o)	Copy method to populate the builder with values from the given instance.
PaySubscriptionRequest.Builder	ifMatch(String ifMatch)	For optimistic concurrency control.
PaySubscriptionRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
PaySubscriptionRequest.Builder	opcRequestId(String opcRequestId)	The unique Oracle-assigned identifier for the request.
PaySubscriptionRequest.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.
PaySubscriptionRequest.Builder	ospHomeRegion(String ospHomeRegion)	The home region’s public name of the logged in user.
PaySubscriptionRequest.Builder	paySubscriptionDetails(PaySubscriptionDetails paySubscriptionDetails)	subscription payment request.
PaySubscriptionRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
PaySubscriptionRequest.Builder	subscriptionId(String subscriptionId)	Subscription id(OCID).

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 PaySubscriptionRequest.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

subscriptionId

public PaySubscriptionRequest.Builder subscriptionId(String subscriptionId)

Subscription id(OCID).

Parameters:

subscriptionId - the value to set

Returns:

this builder instance

compartmentId

public PaySubscriptionRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

paySubscriptionDetails

public PaySubscriptionRequest.Builder paySubscriptionDetails(PaySubscriptionDetails paySubscriptionDetails)

subscription payment request.

Parameters:

paySubscriptionDetails - the value to set

Returns:

this builder instance

ifMatch

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

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

Specified by:

copy in interface BmcRequest.Builder<PaySubscriptionRequest,PaySubscriptionDetails>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public PaySubscriptionRequest build()

Build the instance of PaySubscriptionRequest 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<PaySubscriptionRequest,PaySubscriptionDetails>

Returns:

instance of PaySubscriptionRequest

body$

public PaySubscriptionRequest.Builder body$(PaySubscriptionDetails body)

Alternative setter for the body parameter.

Specified by:

body$ in interface BmcRequest.Builder<PaySubscriptionRequest,PaySubscriptionDetails>

Parameters:

body - the body parameter

Returns:

this builder instance

buildWithoutInvocationCallback

public PaySubscriptionRequest buildWithoutInvocationCallback()

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