com.oracle.bmc.resourcemanager.requests

Class ListStacksRequest

java.lang.Object

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

com.oracle.bmc.resourcemanager.requests.ListStacksRequest

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

Example: Click here to see how to use ListStacksRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListStacksRequest.Builder
static class	ListStacksRequest.SortBy The field to use when sorting returned resources.
static class	ListStacksRequest.SortOrder The sort order to use when sorting returned resources.

Constructor Summary

Constructors

Constructor and Description
ListStacksRequest()

Method Summary

Modifier and Type	Method and Description
static ListStacksRequest.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	getCompartmentId() A filter to return only resources that exist in the compartment, identified by OCID.
String	getDisplayName() A filter to return only resources that match the given display name exactly.
String	getId() The OCID on which to query for a stack.
Stack.LifecycleState	getLifecycleState() A filter that returns only those resources that match the specified lifecycle state.
Integer	getLimit() The number of items returned in a paginated List call.
String	getOpcRequestId() Unique Oracle-assigned identifier for the request.
String	getPage() The value of the opc-next-page response header from the preceding List call.
ListStacksRequest.SortBy	getSortBy() The field to use when sorting returned resources.
ListStacksRequest.SortOrder	getSortOrder() The sort order to use when sorting returned resources.
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListStacksRequest.Builder	toBuilder() Return an instance of ListStacksRequest.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

ListStacksRequest

public ListStacksRequest()

Method Detail

getOpcRequestId

public String getOpcRequestId()

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

getCompartmentId

public String getCompartmentId()

A filter to return only resources that exist in the compartment, identified by OCID.

getId

public String getId()

The OCID on which to query for a stack.

getLifecycleState

public Stack.LifecycleState getLifecycleState()

A filter that returns only those resources that match the specified lifecycle state. The state value is case-insensitive. For more information about stack lifecycle states, see Key Concepts.

Allowable values: - CREATING - ACTIVE - DELETING - DELETED - FAILED

getDisplayName

public String getDisplayName()

A filter to return only resources that match the given display name exactly. Use this filter to list a resource by name. Requires sortBy set to DISPLAYNAME. Alternatively, when you know the resource OCID, use the related Get operation.

getSortBy

public ListStacksRequest.SortBy getSortBy()

The field to use when sorting returned resources. By default, TIMECREATED is ordered descending. By default, DISPLAYNAME is ordered ascending. Note that you can sort only on one field.

getSortOrder

public ListStacksRequest.SortOrder getSortOrder()

The sort order to use when sorting returned resources. Ascending (ASC) or descending (DESC).

getLimit

public Integer getLimit()

The number of items returned in a paginated List call. For information about pagination, see List Pagination.

getPage

public String getPage()

The value of the opc-next-page response header from the preceding List call. For information about pagination, see List Pagination.

toBuilder

public ListStacksRequest.Builder toBuilder()

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

Returns:

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

builder

public static ListStacksRequest.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>