public static class ListAlertsRequest.Builder extends Object implements BmcRequest.Builder<ListAlertsRequest,Void>
Constructor and Description |
---|
Builder() |
Modifier and Type | Method and Description |
---|---|
ListAlertsRequest.Builder |
accessLevel(ListAlertsRequest.AccessLevel accessLevel)
Valid values are RESTRICTED and ACCESSIBLE.
|
ListAlertsRequest |
build()
Build the instance of ListAlertsRequest as configured by this builder
|
ListAlertsRequest |
buildWithoutInvocationCallback()
Build the instance of ListAlertsRequest as configured by this builder
|
ListAlertsRequest.Builder |
compartmentId(String compartmentId)
A filter to return only resources that match the specified compartment OCID.
|
ListAlertsRequest.Builder |
compartmentIdInSubtree(Boolean compartmentIdInSubtree)
Default is false.
|
ListAlertsRequest.Builder |
copy(ListAlertsRequest o)
Copy method to populate the builder with values from the given instance.
|
ListAlertsRequest.Builder |
field(List<ListAlertsRequest.Field> field)
Specifies a subset of fields to be returned in the response.
|
ListAlertsRequest.Builder |
field(ListAlertsRequest.Field singularValue)
Singular setter.
|
ListAlertsRequest.Builder |
id(String id)
A filter to return alert by it’s OCID.
|
ListAlertsRequest.Builder |
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
Set the invocation callback for the request to be built.
|
ListAlertsRequest.Builder |
limit(Integer limit)
For list pagination.
|
ListAlertsRequest.Builder |
opcRequestId(String opcRequestId)
Unique identifier for the request.
|
ListAlertsRequest.Builder |
page(String page)
For list pagination.
|
ListAlertsRequest.Builder |
retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.
|
ListAlertsRequest.Builder |
scimQuery(String scimQuery)
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.Builder |
sortBy(ListAlertsRequest.SortBy sortBy)
The field to sort by.
|
ListAlertsRequest.Builder |
sortOrder(ListAlertsRequest.SortOrder sortOrder)
The sort order to use, either ascending (ASC) or descending (DESC).
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
body$
public ListAlertsRequest.Builder compartmentId(String compartmentId)
A filter to return only resources that match the specified compartment OCID.
compartmentId
- the value to setpublic ListAlertsRequest.Builder id(String id)
A filter to return alert by it’s OCID.
id
- the value to setpublic ListAlertsRequest.Builder compartmentIdInSubtree(Boolean compartmentIdInSubtree)
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.
compartmentIdInSubtree
- the value to setpublic ListAlertsRequest.Builder limit(Integer limit)
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.
limit
- the value to setpublic ListAlertsRequest.Builder page(String page)
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.
page
- the value to setpublic ListAlertsRequest.Builder opcRequestId(String opcRequestId)
Unique identifier for the request.
opcRequestId
- the value to setpublic ListAlertsRequest.Builder accessLevel(ListAlertsRequest.AccessLevel accessLevel)
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.
accessLevel
- the value to setpublic ListAlertsRequest.Builder sortOrder(ListAlertsRequest.SortOrder sortOrder)
The sort order to use, either ascending (ASC) or descending (DESC).
sortOrder
- the value to setpublic ListAlertsRequest.Builder sortBy(ListAlertsRequest.SortBy sortBy)
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.
sortBy
- the value to setpublic ListAlertsRequest.Builder scimQuery(String scimQuery)
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)
scimQuery
- the value to setpublic ListAlertsRequest.Builder field(List<ListAlertsRequest.Field> field)
Specifies a subset of fields to be returned in the response.
field
- the value to setpublic ListAlertsRequest.Builder field(ListAlertsRequest.Field singularValue)
Singular setter. Specifies a subset of fields to be returned in the response.
singularValue
- the singular value to setpublic ListAlertsRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
Set the invocation callback for the request to be built.
invocationCallback
- the invocation callback to be set for the requestpublic ListAlertsRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.
retryConfiguration
- the retry configuration to be used for the requestpublic ListAlertsRequest.Builder copy(ListAlertsRequest o)
Copy method to populate the builder with values from the given instance.
copy
in interface BmcRequest.Builder<ListAlertsRequest,Void>
o
- other request from which to copy valuespublic ListAlertsRequest build()
Build the instance of ListAlertsRequest as configured by this builder
Note that this method takes calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)
into account,
while the method buildWithoutInvocationCallback()
does not.
This is the preferred method to build an instance.
build
in interface BmcRequest.Builder<ListAlertsRequest,Void>
public ListAlertsRequest buildWithoutInvocationCallback()
Build the instance of ListAlertsRequest as configured by this builder
Note that this method does not take calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)
into account,
while the method build()
does
Copyright © 2016–2024. All rights reserved.