com.oracle.bmc.cloudbridge.requests

Class ListEnvironmentsRequest

java.lang.Object

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

com.oracle.bmc.cloudbridge.requests.ListEnvironmentsRequest

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

Example: Click here to see how to use ListEnvironmentsRequest.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ListEnvironmentsRequest()

Method Summary

Modifier and Type	Method and Description
static ListEnvironmentsRequest.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() The ID of the compartment in which to list resources.
String	getDisplayName() A filter to return only resources that match the entire display name given.
String	getEnvironmentId() A filter to return only resources that match the given environment ID.
Environment.LifecycleState	getLifecycleState() A filter to return only resources where their lifecycleState matches the given lifecycleState.
Integer	getLimit() The maximum number of items to return.
String	getOpcRequestId() The client request ID for tracing.
String	getPage() A token representing the position at which to start retrieving results.
ListEnvironmentsRequest.SortBy	getSortBy() The field to sort by.
SortOrders	getSortOrder() The sort order to use, either ‘ASC’ or ‘DESC’.
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListEnvironmentsRequest.Builder	toBuilder() Return an instance of ListEnvironmentsRequest.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

ListEnvironmentsRequest

public ListEnvironmentsRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

The ID of the compartment in which to list resources.

getLifecycleState

public Environment.LifecycleState getLifecycleState()

A filter to return only resources where their lifecycleState matches the given lifecycleState.

getDisplayName

public String getDisplayName()

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

getEnvironmentId

public String getEnvironmentId()

A filter to return only resources that match the given environment ID.

getLimit

public Integer getLimit()

The maximum number of items to return.

getPage

public String getPage()

A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response.

getSortOrder

public SortOrders getSortOrder()

The sort order to use, either ‘ASC’ or ‘DESC’.

getSortBy

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

getOpcRequestId

public String getOpcRequestId()

The client request ID for tracing.

toBuilder

public ListEnvironmentsRequest.Builder toBuilder()

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

Returns:

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

builder

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