com.oracle.bmc.containerinstances.requests

Class ListContainersRequest.Builder

java.lang.Object

com.oracle.bmc.containerinstances.requests.ListContainersRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListContainersRequest,Void>

Enclosing class:

ListContainersRequest

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

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

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

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

displayName

public ListContainersRequest.Builder displayName(String displayName)

A filter to return only resources that match the entire display name given.

Parameters:

displayName - the value to set

Returns:

this builder instance

containerInstanceId

public ListContainersRequest.Builder containerInstanceId(String containerInstanceId)

The OCID of the container instance.

Parameters:

containerInstanceId - the value to set

Returns:

this builder instance

availabilityDomain

public ListContainersRequest.Builder availabilityDomain(String availabilityDomain)

The name of the availability domain.

Example: Uocm:PHX-AD-1

Parameters:

availabilityDomain - the value to set

Returns:

this builder instance

limit

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

opcRequestId

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

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

sortOrder

public ListContainersRequest.Builder sortOrder(SortOrder sortOrder)

The sort order to use (ASC) or (DESC).

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListContainersRequest.Builder sortBy(ListContainersRequest.SortBy sortBy)

The field to sort by. You can provide one sort order. Default order for timeCreated is descending. Default order for displayName is ascending. If you don’t specify a value, timeCreated is the default.

Parameters:

sortBy - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListContainersRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListContainersRequest build()

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

Returns:

instance of ListContainersRequest

buildWithoutInvocationCallback

public ListContainersRequest buildWithoutInvocationCallback()

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