Package com.oracle.bmc.apigateway.requests

Class ListApisRequest

java.lang.Object

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

com.oracle.bmc.apigateway.requests.ListApisRequest

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

Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/apigateway/ListApisExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListApisRequest.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ListApisRequest()

Method Summary

Modifier and Type	Method	Description
static ListApisRequest.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 ocid of the compartment in which to list resources.
String	getDisplayName()	A user-friendly name.
ApiSummary.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.
ListApisRequest.SortBy	getSortBy()	The field to sort by.
ListApisRequest.SortOrder	getSortOrder()	The sort order to use, either ‘asc’ or ‘desc’.
int	hashCode()	Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListApisRequest.Builder	toBuilder()	Return an instance of ListApisRequest.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

ListApisRequest

public ListApisRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

The ocid of the compartment in which to list resources.

getDisplayName

public String getDisplayName()

A user-friendly name.

Does not have to be unique, and it’s changeable.

Example: My new resource

getLifecycleState

public ApiSummary.LifecycleState getLifecycleState()

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

Example: ACTIVE

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 ListApisRequest.SortOrder getSortOrder()

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

The default order depends on the sortBy value.

getSortBy

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

toBuilder

public ListApisRequest.Builder toBuilder()

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

Returns:

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

builder

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