@Generated(value="OracleSDKGenerator", comments="API Version: 20190501") public class ListApisRequest extends BmcRequest<Void>
Example: Click here to see how to use ListApisRequest.
Modifier and Type | Class and 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 and Description |
---|
ListApisRequest() |
Modifier and Type | Method and 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() |
getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue
public String getCompartmentId()
The ocid of the compartment in which to list resources.
public String getDisplayName()
A user-friendly name. Does not have to be unique, and it’s changeable.
Example: My new resource
public ApiSummary.LifecycleState getLifecycleState()
A filter to return only resources that match the given lifecycle state.
Example: ACTIVE
public Integer getLimit()
The maximum number of items to return.
public String getPage()
The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
public ListApisRequest.SortOrder getSortOrder()
The sort order to use, either ‘asc’ or ‘desc’. The default order depends on the sortBy value.
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.
public String getOpcRequestId()
The client request id for tracing.
public ListApisRequest.Builder toBuilder()
Return an instance of ListApisRequest.Builder
that allows you to modify request properties.
ListApisRequest.Builder
that allows you to modify request properties.public static ListApisRequest.Builder builder()
Return a new builder for this request object.
public boolean equals(Object o)
BmcRequest
Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
equals
in class BmcRequest<Void>
public int hashCode()
BmcRequest
Uses getInvocationCallback and getRetryConfiguration to generate a hash.
hashCode
in class BmcRequest<Void>
Copyright © 2016–2024. All rights reserved.