com.oracle.bmc.datasafe.requests

Class ListAlertsRequest

java.lang.Object

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

com.oracle.bmc.datasafe.requests.ListAlertsRequest

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

Example: Click here to see how to use ListAlertsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListAlertsRequest.AccessLevel Valid values are RESTRICTED and ACCESSIBLE.
static class	ListAlertsRequest.Builder
static class	ListAlertsRequest.Field Specifies a subset of fields to be returned in the response.
static class	ListAlertsRequest.SortBy The field to sort by.
static class	ListAlertsRequest.SortOrder The sort order to use, either ascending (ASC) or descending (DESC).

Constructor Summary

Constructors

Constructor and Description
ListAlertsRequest()

Method Summary

Modifier and Type	Method and Description
static ListAlertsRequest.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’.
ListAlertsRequest.AccessLevel	getAccessLevel() Valid values are RESTRICTED and ACCESSIBLE.
String	getCompartmentId() A filter to return only resources that match the specified compartment OCID.
Boolean	getCompartmentIdInSubtree() Default is false.
List<ListAlertsRequest.Field>	getField() Specifies a subset of fields to be returned in the response.
String	getId() A filter to return alert by it’s OCID.
Integer	getLimit() For list pagination.
String	getOpcRequestId() Unique identifier for the request.
String	getPage() For list pagination.
String	getScimQuery() The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339.
ListAlertsRequest.SortBy	getSortBy() The field to sort by.
ListAlertsRequest.SortOrder	getSortOrder() The sort order to use, either ascending (ASC) or descending (DESC).
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListAlertsRequest.Builder	toBuilder() Return an instance of ListAlertsRequest.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

ListAlertsRequest

public ListAlertsRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

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

getId

public String getId()

A filter to return alert by it’s OCID.

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.

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.

getOpcRequestId

public String getOpcRequestId()

Unique identifier for the request.

getAccessLevel

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

getSortOrder

public ListAlertsRequest.SortOrder getSortOrder()

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

getSortBy

public ListAlertsRequest.SortBy getSortBy()

The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default.

getScimQuery

public String getScimQuery()

The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

*Example:** | query=(timeCreated ge '2021-06-04T01-00-26') and (targetNames eq 'target_1') query=(featureDetails.userName eq "user") and (targetNames eq "target_1") Supported fields: severity status alertType targetIds targetNames operationTime lifecycleState displayName timeCreated timeUpdated featureDetails.* (* can be any field in nestedStrMap in Feature Attributes in Alert Summary. For example - userName,object,clientHostname,osUserName,clientIPs,clientId,commandText,commandParam,clientProgram,objectType,targetOwner)

getField

public List<ListAlertsRequest.Field> getField()

Specifies a subset of fields to be returned in the response.

toBuilder

public ListAlertsRequest.Builder toBuilder()

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

Returns:

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

builder

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