Package com.oracle.bmc.apiplatform.requests

Class ListApiPlatformInstancesRequest.Builder

java.lang.Object

com.oracle.bmc.apiplatform.requests.ListApiPlatformInstancesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListApiPlatformInstancesRequest,Void>

Enclosing class:

ListApiPlatformInstancesRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListApiPlatformInstancesRequest	build()	Build the instance of ListApiPlatformInstancesRequest as configured by this builder
ListApiPlatformInstancesRequest	buildWithoutInvocationCallback()	Build the instance of ListApiPlatformInstancesRequest as configured by this builder
ListApiPlatformInstancesRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment in which to list resources.
ListApiPlatformInstancesRequest.Builder	copy(ListApiPlatformInstancesRequest o)	Copy method to populate the builder with values from the given instance.
ListApiPlatformInstancesRequest.Builder	id(String id)	The OCID of the instance
ListApiPlatformInstancesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListApiPlatformInstancesRequest.Builder	lifecycleState(ApiPlatformInstance.LifecycleState lifecycleState)	A filter to return only resources that match the given lifecycle state.
ListApiPlatformInstancesRequest.Builder	limit(Integer limit)	For list pagination.
ListApiPlatformInstancesRequest.Builder	name(String name)	A filter to return only resources that match the given name exactly
ListApiPlatformInstancesRequest.Builder	opcRequestId(String opcRequestId)	Unique Oracle-assigned identifier for the request.
ListApiPlatformInstancesRequest.Builder	page(String page)	For list pagination.
ListApiPlatformInstancesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListApiPlatformInstancesRequest.Builder	sortBy(ListApiPlatformInstancesRequest.SortBy sortBy)	The field to sort by.
ListApiPlatformInstancesRequest.Builder	sortOrder(SortOrder sortOrder)	The sort order to use, either ascending (ASC) or descending (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 ListApiPlatformInstancesRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment in which to list resources.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

lifecycleState

public ListApiPlatformInstancesRequest.Builder lifecycleState(ApiPlatformInstance.LifecycleState lifecycleState)

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

The state value is case-insensitive.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

name

public ListApiPlatformInstancesRequest.Builder name(String name)

A filter to return only resources that match the given name exactly

Parameters:

name - the value to set

Returns:

this builder instance

id

public ListApiPlatformInstancesRequest.Builder id(String id)

The OCID of the instance

Parameters:

id - the value to set

Returns:

this builder instance

limit

public ListApiPlatformInstancesRequest.Builder limit(Integer limit)

For list pagination.

The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListApiPlatformInstancesRequest.Builder page(String page)

For list pagination.

The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

Parameters:

page - the value to set

Returns:

this builder instance

sortOrder

public ListApiPlatformInstancesRequest.Builder sortOrder(SortOrder sortOrder)

The sort order to use, either ascending (ASC) or descending (DESC).

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListApiPlatformInstancesRequest.Builder sortBy(ListApiPlatformInstancesRequest.SortBy sortBy)

The field to sort by.

You can provide only one sort order. Default order for timeCreated is descending. Default order for name is ascending.

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListApiPlatformInstancesRequest.Builder opcRequestId(String opcRequestId)

Unique Oracle-assigned identifier for the request.

If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListApiPlatformInstancesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListApiPlatformInstancesRequest build()

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

Returns:

instance of ListApiPlatformInstancesRequest

buildWithoutInvocationCallback

public ListApiPlatformInstancesRequest buildWithoutInvocationCallback()

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