Package com.oracle.bmc.disasterrecovery.requests

Class ListDrProtectionGroupsRequest

java.lang.Object

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

com.oracle.bmc.disasterrecovery.requests.ListDrProtectionGroupsRequest

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

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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ListDrProtectionGroupsRequest()

Method Summary

Modifier and Type	Method	Description
static ListDrProtectionGroupsRequest.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 (OCID) of the compartment in which to list resources.
String	getDisplayName()	A filter to return only resources that match the given display name.
String	getDrProtectionGroupId()	The OCID of the DR protection group.
DrProtectionGroupLifecycleState	getLifecycleState()	A filter to return only DR protection groups that match the given lifecycle state.
DrProtectionGroupLifecycleSubState	getLifecycleSubState()	A filter to return only DR protection groups that match the given lifecycle sub-state.
Integer	getLimit()	For list pagination.
String	getOpcRequestId()	The client request ID for tracing.
String	getPage()	For list pagination.
DrProtectionGroupRole	getRole()	The DR protection group Role.
ListDrProtectionGroupsRequest.SortBy	getSortBy()	The field to sort by.
SortOrder	getSortOrder()	The sort order to use, either ‘asc’ or ‘desc’.
int	hashCode()	Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListDrProtectionGroupsRequest.Builder	toBuilder()	Return an instance of ListDrProtectionGroupsRequest.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

ListDrProtectionGroupsRequest

public ListDrProtectionGroupsRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

The ID (OCID) of the compartment in which to list resources.

Example: ocid1.compartment.oc1..uniqueID

getLifecycleState

public DrProtectionGroupLifecycleState getLifecycleState()

A filter to return only DR protection groups that match the given lifecycle state.

getDrProtectionGroupId

public String getDrProtectionGroupId()

The OCID of the DR protection group.

Optional query param.

Example: ocid1.drprotectiongroup.oc1..uniqueID

getDisplayName

public String getDisplayName()

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

Example: MyResourceDisplayName

getLimit

public Integer getLimit()

For list pagination.

The maximum number of results per page, or items to return in a paginated “List” call. 1 is the minimum, 1000 is the maximum.

For important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

Example: 100

getPage

public String getPage()

For list pagination.

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

For important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

getSortOrder

public SortOrder getSortOrder()

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

getSortBy

public ListDrProtectionGroupsRequest.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. If no value is specified timeCreated is default.

Example: MyResourceDisplayName

getOpcRequestId

public String getOpcRequestId()

The client request ID for tracing.

getRole

public DrProtectionGroupRole getRole()

The DR protection group Role.

getLifecycleSubState

public DrProtectionGroupLifecycleSubState getLifecycleSubState()

A filter to return only DR protection groups that match the given lifecycle sub-state.

toBuilder

public ListDrProtectionGroupsRequest.Builder toBuilder()

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

Returns:

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

builder

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