com.oracle.bmc.containerinstances.requests

Class ListContainersRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.containerinstances.requests.ListContainersRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210415")
public class ListContainersRequest
extends BmcRequest<Void>

Example: Click here to see how to use ListContainersRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListContainersRequest.Builder
static class	ListContainersRequest.SortBy The field to sort by.

Constructor Summary

Constructors

Constructor and Description
ListContainersRequest()

Method Summary

Modifier and Type	Method and Description
static ListContainersRequest.Builder	builder() Return a new builder for this request object.
boolean	equals(Object o) Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
String	getAvailabilityDomain() The name of the availability domain.
String	getCompartmentId() The ID of the compartment in which to list resources.
String	getContainerInstanceId() unique ContainerInstance identifier
String	getDisplayName() A filter to return only resources that match the entire display name given.
Container.LifecycleState	getLifecycleState() A filter to return only resources whose lifecycleState matches the given lifecycleState.
Integer	getLimit() The maximum number of items to return.
String	getOpcRequestId() The client request ID for tracing.
String	getPage() The page token representing the page at which to start retrieving results.
ListContainersRequest.SortBy	getSortBy() The field to sort by.
SortOrder	getSortOrder() The sort order to use, either ‘asc’ or ‘desc’.
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListContainersRequest.Builder	toBuilder() Return an instance of ListContainersRequest.Builder that allows you to modify request properties.
String	toString()

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListContainersRequest

public ListContainersRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

The ID of the compartment in which to list resources.

getLifecycleState

public Container.LifecycleState getLifecycleState()

A filter to return only resources whose lifecycleState matches the given lifecycleState.

getDisplayName

public String getDisplayName()

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

getContainerInstanceId

public String getContainerInstanceId()

unique ContainerInstance identifier

getAvailabilityDomain

public String getAvailabilityDomain()

The name of the availability domain.

Example: Uocm:PHX-AD-1

getLimit

public Integer getLimit()

The maximum number of items to return.

getPage

public String getPage()

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

getOpcRequestId

public String getOpcRequestId()

The client request ID for tracing.

getSortOrder

public SortOrder getSortOrder()

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

getSortBy

public ListContainersRequest.SortBy getSortBy()

The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

toBuilder

public ListContainersRequest.Builder toBuilder()

Return an instance of ListContainersRequest.Builder that allows you to modify request properties.

Returns:

instance of ListContainersRequest.Builder that allows you to modify request properties.

builder

public static ListContainersRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.

Overrides:

equals in class BmcRequest<Void>

hashCode

public int hashCode()

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to generate a hash.

Overrides:

hashCode in class BmcRequest<Void>