Package com.oracle.bmc.apigateway.requests

Class ListApisRequest.Builder

java.lang.Object

com.oracle.bmc.apigateway.requests.ListApisRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListApisRequest,Void>

Enclosing class:

ListApisRequest

public static class ListApisRequest.Builder
extends Object
implements BmcRequest.Builder<ListApisRequest,Void>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListApisRequest	build()	Build the instance of ListApisRequest as configured by this builder
ListApisRequest	buildWithoutInvocationCallback()	Build the instance of ListApisRequest as configured by this builder
ListApisRequest.Builder	compartmentId(String compartmentId)	The ocid of the compartment in which to list resources.
ListApisRequest.Builder	copy(ListApisRequest o)	Copy method to populate the builder with values from the given instance.
ListApisRequest.Builder	displayName(String displayName)	A user-friendly name.
ListApisRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListApisRequest.Builder	lifecycleState(ApiSummary.LifecycleState lifecycleState)	A filter to return only resources that match the given lifecycle state.
ListApisRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListApisRequest.Builder	opcRequestId(String opcRequestId)	The client request id for tracing.
ListApisRequest.Builder	page(String page)	The page token representing the page at which to start retrieving results.
ListApisRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListApisRequest.Builder	sortBy(ListApisRequest.SortBy sortBy)	The field to sort by.
ListApisRequest.Builder	sortOrder(ListApisRequest.SortOrder sortOrder)	The sort order to use, either ‘asc’ or ‘desc’.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder

body$

Constructor Detail

Builder

public Builder()

Method Detail

compartmentId

public ListApisRequest.Builder compartmentId(String compartmentId)

The ocid of the compartment in which to list resources.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

displayName

public ListApisRequest.Builder displayName(String displayName)

A user-friendly name.

Does not have to be unique, and it’s changeable.

Example: My new resource

Parameters:

displayName - the value to set

Returns:

this builder instance

lifecycleState

public ListApisRequest.Builder lifecycleState(ApiSummary.LifecycleState lifecycleState)

A filter to return only resources that match the given lifecycle state.

Example: ACTIVE

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

limit

public ListApisRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListApisRequest.Builder page(String page)

The page token representing the page at which to start retrieving results.

This is usually retrieved from a previous list call.

Parameters:

page - the value to set

Returns:

this builder instance

sortOrder

public ListApisRequest.Builder sortOrder(ListApisRequest.SortOrder sortOrder)

The sort order to use, either ‘asc’ or ‘desc’.

The default order depends on the sortBy value.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListApisRequest.Builder sortBy(ListApisRequest.SortBy sortBy)

The field to sort by.

You can provide one sort order (sortOrder). Default order for timeCreated is descending. Default order for displayName is ascending. The displayName sort order is case sensitive.

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListApisRequest.Builder opcRequestId(String opcRequestId)

The client request id for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListApisRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListApisRequest build()

Build the instance of ListApisRequest 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<ListApisRequest,Void>

Returns:

instance of ListApisRequest

buildWithoutInvocationCallback

public ListApisRequest buildWithoutInvocationCallback()

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