com.oracle.bmc.identity.requests

Class ListGroupsRequest

java.lang.Object

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

com.oracle.bmc.identity.requests.ListGroupsRequest

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

Example: Click here to see how to use ListGroupsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListGroupsRequest.Builder
static class	ListGroupsRequest.SortBy The field to sort by.
static class	ListGroupsRequest.SortOrder The sort order to use, either ascending (ASC) or descending (DESC).

Method Summary

Modifier and Type	Method and Description
static ListGroupsRequest.Builder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o) Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
String	getCompartmentId() The OCID of the compartment (remember that the tenancy is simply the root compartment).
Group.LifecycleState	getLifecycleState() A filter to only return resources that match the given lifecycle state.
Integer	getLimit() The maximum number of items to return in a paginated “List” call.
String	getName() A filter to only return resources that match the given name exactly.
String	getPage() The value of the opc-next-page response header from the previous “List” call.
ListGroupsRequest.SortBy	getSortBy() The field to sort by.
ListGroupsRequest.SortOrder	getSortOrder() The sort order to use, either ascending (ASC) or descending (DESC).
int	hashCode() Uses invocationCallback and retryConfiguration to generate a hash.
ListGroupsRequest.Builder	toBuilder()
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

Method Detail

builder

public static ListGroupsRequest.Builder builder()

toBuilder

public ListGroupsRequest.Builder toBuilder()

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>

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Description copied from class: BmcRequest

Uses invocationCallback and retryConfiguration to generate a hash.

Overrides:

hashCode in class BmcRequest<Void>

getCompartmentId

public String getCompartmentId()

The OCID of the compartment (remember that the tenancy is simply the root compartment).

getPage

public String getPage()

The value of the opc-next-page response header from the previous “List” call.

getLimit

public Integer getLimit()

The maximum number of items to return in a paginated “List” call.

getName

public String getName()

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

getSortBy

public ListGroupsRequest.SortBy getSortBy()

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

*Note:** In general, some "List" operations (for example, ListInstances) let you optionally filter by Availability Domain if the scope of the resource type is within a single Availability Domain. If you call one of these "List" operations without specifying an Availability Domain, the resources are grouped by Availability Domain, then sorted.

getSortOrder

public ListGroupsRequest.SortOrder getSortOrder()

The sort order to use, either ascending (ASC) or descending (DESC). The NAME sort order is case sensitive.

getLifecycleState

public Group.LifecycleState getLifecycleState()

A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.