Package com.oracle.bmc.apigateway.requests

Class CreateApiRequest.Builder

java.lang.Object

com.oracle.bmc.apigateway.requests.CreateApiRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<CreateApiRequest,CreateApiDetails>

Enclosing class:

CreateApiRequest

public static class CreateApiRequest.Builder
extends Object
implements BmcRequest.Builder<CreateApiRequest,CreateApiDetails>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CreateApiRequest.Builder	body$(CreateApiDetails body)	Alternative setter for the body parameter.
CreateApiRequest	build()	Build the instance of CreateApiRequest as configured by this builder
CreateApiRequest	buildWithoutInvocationCallback()	Build the instance of CreateApiRequest as configured by this builder
CreateApiRequest.Builder	copy(CreateApiRequest o)	Copy method to populate the builder with values from the given instance.
CreateApiRequest.Builder	createApiDetails(CreateApiDetails createApiDetails)	Details for the new API.
CreateApiRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
CreateApiRequest.Builder	opcRequestId(String opcRequestId)	The client request id for tracing.
CreateApiRequest.Builder	opcRetryToken(String opcRetryToken)	A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.
CreateApiRequest.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

createApiDetails

public CreateApiRequest.Builder createApiDetails(CreateApiDetails createApiDetails)

Details for the new API.

Parameters:

createApiDetails - the value to set

Returns:

this builder instance

opcRetryToken

public CreateApiRequest.Builder opcRetryToken(String opcRetryToken)

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.

Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Parameters:

opcRetryToken - the value to set

Returns:

this builder instance

opcRequestId

public CreateApiRequest.Builder opcRequestId(String opcRequestId)

The client request id for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<CreateApiRequest,CreateApiDetails>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public CreateApiRequest build()

Build the instance of CreateApiRequest 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<CreateApiRequest,CreateApiDetails>

Returns:

instance of CreateApiRequest

body$

public CreateApiRequest.Builder body$(CreateApiDetails body)

Alternative setter for the body parameter.

Specified by:

body$ in interface BmcRequest.Builder<CreateApiRequest,CreateApiDetails>

Parameters:

body - the body parameter

Returns:

this builder instance

buildWithoutInvocationCallback

public CreateApiRequest buildWithoutInvocationCallback()

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