com.oracle.bmc.apigateway.requests

Class ListDeploymentsRequest

java.lang.Object

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

com.oracle.bmc.apigateway.requests.ListDeploymentsRequest

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

Example: Click here to see how to use ListDeploymentsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListDeploymentsRequest.Builder
static class	ListDeploymentsRequest.SortBy The field to sort by.
static class	ListDeploymentsRequest.SortOrder The sort order to use, either ‘asc’ or ‘desc’.

Method Summary

Modifier and Type	Method and Description
static ListDeploymentsRequest.Builder	builder()
String	getCompartmentId() The ocid of the compartment in which to list resources.
String	getDisplayName() A user-friendly name.
String	getGatewayId() Filter deployments by the gateway ocid.
Deployment.LifecycleState	getLifecycleState() A filter to return only resources that match the given lifecycle state.
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.
ListDeploymentsRequest.SortBy	getSortBy() The field to sort by.
ListDeploymentsRequest.SortOrder	getSortOrder() The sort order to use, either ‘asc’ or ‘desc’.

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

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static ListDeploymentsRequest.Builder builder()

getCompartmentId

public String getCompartmentId()

The ocid of the compartment in which to list resources.

getGatewayId

public String getGatewayId()

Filter deployments by the gateway ocid.

getDisplayName

public String getDisplayName()

A user-friendly name. Does not have to be unique, and it’s changeable.

Example: `My new resource`

getLifecycleState

public Deployment.LifecycleState getLifecycleState()

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

Example: `SUCCEEDED`

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.

getSortOrder

public ListDeploymentsRequest.SortOrder getSortOrder()

The sort order to use, either ‘asc’ or ‘desc’. The default order depends on the sortBy value.

getSortBy

public ListDeploymentsRequest.SortBy getSortBy()

The field to sort by. You can provide one sort order (sortOrder). Default order for timeCreated is descending. Default order for displayName is ascending. The displayName sort order is case sensitive.

getOpcRequestId

public String getOpcRequestId()

The client request id for tracing.