com.oracle.bmc.datasafe.requests

Class ListAuditArchiveRetrievalsRequest

java.lang.Object

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

com.oracle.bmc.datasafe.requests.ListAuditArchiveRetrievalsRequest

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

Example: Click here to see how to use ListAuditArchiveRetrievalsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListAuditArchiveRetrievalsRequest.AccessLevel Valid values are RESTRICTED and ACCESSIBLE.
static class	ListAuditArchiveRetrievalsRequest.Builder
static class	ListAuditArchiveRetrievalsRequest.SortBy The field used for sorting.
static class	ListAuditArchiveRetrievalsRequest.SortOrder The sort order to use, either ascending (ASC) or descending (DESC).

Constructor Summary

Constructors

Constructor and Description
ListAuditArchiveRetrievalsRequest()

Method Summary

Modifier and Type	Method and Description
static ListAuditArchiveRetrievalsRequest.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’.
ListAuditArchiveRetrievalsRequest.AccessLevel	getAccessLevel() Valid values are RESTRICTED and ACCESSIBLE.
String	getAuditArchiveRetrievalId() OCID of the archive retrieval.
String	getCompartmentId() A filter to return only resources that match the specified compartment OCID.
Boolean	getCompartmentIdInSubtree() Default is false.
String	getDisplayName() A filter to return only resources that match the specified display name.
AuditArchiveRetrievalLifecycleState	getLifecycleState() A filter to return only resources that matches the specified lifecycle state.
Integer	getLimit() For list pagination.
String	getOpcRequestId() Unique identifier for the request.
String	getPage() For list pagination.
ListAuditArchiveRetrievalsRequest.SortBy	getSortBy() The field used for sorting.
ListAuditArchiveRetrievalsRequest.SortOrder	getSortOrder() The sort order to use, either ascending (ASC) or descending (DESC).
String	getTargetId() The OCID of the target associated with the archive retrieval.
Date	getTimeOfExpiry() The date time when retrieved archive data will be deleted from Data Safe and unloaded back into archival.
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListAuditArchiveRetrievalsRequest.Builder	toBuilder() Return an instance of ListAuditArchiveRetrievalsRequest.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

ListAuditArchiveRetrievalsRequest

public ListAuditArchiveRetrievalsRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

A filter to return only resources that match the specified compartment OCID.

getDisplayName

public String getDisplayName()

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

getCompartmentIdInSubtree

public Boolean getCompartmentIdInSubtree()

Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the ‘accessLevel’ setting.

getAccessLevel

public ListAuditArchiveRetrievalsRequest.AccessLevel getAccessLevel()

Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

getAuditArchiveRetrievalId

public String getAuditArchiveRetrievalId()

OCID of the archive retrieval.

getTargetId

public String getTargetId()

The OCID of the target associated with the archive retrieval.

getLimit

public Integer getLimit()

For list pagination. The maximum number of items to return per page in a paginated “List” call. For details about how pagination works, see List Pagination.

getPage

public String getPage()

For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous “List” call. For details about how pagination works, see List Pagination.

getLifecycleState

public AuditArchiveRetrievalLifecycleState getLifecycleState()

A filter to return only resources that matches the specified lifecycle state.

getTimeOfExpiry

public Date getTimeOfExpiry()

The date time when retrieved archive data will be deleted from Data Safe and unloaded back into archival.

getSortOrder

public ListAuditArchiveRetrievalsRequest.SortOrder getSortOrder()

The sort order to use, either ascending (ASC) or descending (DESC).

getSortBy

public ListAuditArchiveRetrievalsRequest.SortBy getSortBy()

The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

getOpcRequestId

public String getOpcRequestId()

Unique identifier for the request.

toBuilder

public ListAuditArchiveRetrievalsRequest.Builder toBuilder()

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

Returns:

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

builder

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