com.oracle.bmc.apigateway.requests

Class ChangeApiCompartmentRequest.Builder

java.lang.Object

com.oracle.bmc.apigateway.requests.ChangeApiCompartmentRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ChangeApiCompartmentRequest,ChangeApiCompartmentDetails>

Enclosing class:

ChangeApiCompartmentRequest

public static class ChangeApiCompartmentRequest.Builder
extends Object
implements BmcRequest.Builder<ChangeApiCompartmentRequest,ChangeApiCompartmentDetails>

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ChangeApiCompartmentRequest.Builder	apiId(String apiId) The ocid of the API.
ChangeApiCompartmentRequest.Builder	body$(ChangeApiCompartmentDetails body) Alternative setter for the body parameter.
ChangeApiCompartmentRequest	build() Build the instance of ChangeApiCompartmentRequest as configured by this builder
ChangeApiCompartmentRequest	buildWithoutInvocationCallback() Build the instance of ChangeApiCompartmentRequest as configured by this builder
ChangeApiCompartmentRequest.Builder	changeApiCompartmentDetails(ChangeApiCompartmentDetails changeApiCompartmentDetails) Details of the target compartment.
ChangeApiCompartmentRequest.Builder	copy(ChangeApiCompartmentRequest o) Copy method to populate the builder with values from the given instance.
ChangeApiCompartmentRequest.Builder	ifMatch(String ifMatch) For optimistic concurrency control.
ChangeApiCompartmentRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
ChangeApiCompartmentRequest.Builder	opcRequestId(String opcRequestId) The client request id for tracing.
ChangeApiCompartmentRequest.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.
ChangeApiCompartmentRequest.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

apiId

public ChangeApiCompartmentRequest.Builder apiId(String apiId)

The ocid of the API.

Parameters:

apiId - the value to set

Returns:

this builder instance

changeApiCompartmentDetails

public ChangeApiCompartmentRequest.Builder changeApiCompartmentDetails(ChangeApiCompartmentDetails changeApiCompartmentDetails)

Details of the target compartment.

Parameters:

changeApiCompartmentDetails - the value to set

Returns:

this builder instance

opcRetryToken

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

ifMatch

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

opcRequestId

public ChangeApiCompartmentRequest.Builder opcRequestId(String opcRequestId)

The client request id for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ChangeApiCompartmentRequest,ChangeApiCompartmentDetails>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ChangeApiCompartmentRequest build()

Build the instance of ChangeApiCompartmentRequest 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<ChangeApiCompartmentRequest,ChangeApiCompartmentDetails>

Returns:

instance of ChangeApiCompartmentRequest

body$

public ChangeApiCompartmentRequest.Builder body$(ChangeApiCompartmentDetails body)

Alternative setter for the body parameter.

Specified by:

body$ in interface BmcRequest.Builder<ChangeApiCompartmentRequest,ChangeApiCompartmentDetails>

Parameters:

body - the body parameter

Returns:

this builder instance

buildWithoutInvocationCallback

public ChangeApiCompartmentRequest buildWithoutInvocationCallback()

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