Class ListAlertPoliciesRequest
- java.lang.Object
-
- com.oracle.bmc.requests.BmcRequest<Void>
-
- com.oracle.bmc.datasafe.requests.ListAlertPoliciesRequest
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20181201") public class ListAlertPoliciesRequest extends BmcRequest<Void>
Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.74.2/datasafe/ListAlertPoliciesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAlertPoliciesRequest.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ListAlertPoliciesRequest.AccessLevel
Valid values are RESTRICTED and ACCESSIBLE.static class
ListAlertPoliciesRequest.Builder
static class
ListAlertPoliciesRequest.SortBy
The field to sort by.static class
ListAlertPoliciesRequest.SortOrder
The sort order to use, either ascending (ASC) or descending (DESC).
-
Constructor Summary
Constructors Constructor Description ListAlertPoliciesRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListAlertPoliciesRequest.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’.ListAlertPoliciesRequest.AccessLevel
getAccessLevel()
Valid values are RESTRICTED and ACCESSIBLE.String
getAlertPolicyId()
A filter to return policy by it’s OCID.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.Boolean
getIsUserDefined()
An optional filter to return only alert policies that are user-defined or not.AlertPolicyLifecycleState
getLifecycleState()
An optional filter to return only alert policies that have the given life-cycle state.Integer
getLimit()
For list pagination.String
getOpcRequestId()
Unique identifier for the request.String
getPage()
For list pagination.ListAlertPoliciesRequest.SortBy
getSortBy()
The field to sort by.ListAlertPoliciesRequest.SortOrder
getSortOrder()
The sort order to use, either ascending (ASC) or descending (DESC).Date
getTimeCreatedGreaterThanOrEqualTo()
A filter to return only the resources that were created after the specified date and time, as defined by RFC3339.Date
getTimeCreatedLessThan()
Search for resources that were created before a specific date.AlertPolicyType
getType()
An optional filter to return only alert policies of a certain type.int
hashCode()
Uses getInvocationCallback and getRetryConfiguration to generate a hash.ListAlertPoliciesRequest.Builder
toBuilder()
Return an instance ofListAlertPoliciesRequest.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
-
-
-
-
Method Detail
-
getCompartmentId
public String getCompartmentId()
A filter to return only resources that match the specified compartment OCID.
-
getAlertPolicyId
public String getAlertPolicyId()
A filter to return policy by it’s OCID.
-
getType
public AlertPolicyType getType()
An optional filter to return only alert policies of a certain type.
-
getIsUserDefined
public Boolean getIsUserDefined()
An optional filter to return only alert policies that are user-defined or not.
-
getDisplayName
public String getDisplayName()
A filter to return only resources that match the specified display name.
-
getLifecycleState
public AlertPolicyLifecycleState getLifecycleState()
An optional filter to return only alert policies that have the given life-cycle state.
-
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.
-
getSortOrder
public ListAlertPoliciesRequest.SortOrder getSortOrder()
The sort order to use, either ascending (ASC) or descending (DESC).
-
getSortBy
public ListAlertPoliciesRequest.SortBy getSortBy()
The field to sort by.Only one sort parameter may be provided.
-
getOpcRequestId
public String getOpcRequestId()
Unique identifier for the request.
-
getTimeCreatedGreaterThanOrEqualTo
public Date getTimeCreatedGreaterThanOrEqualTo()
A filter to return only the resources that were created after the specified date and time, as defined by RFC3339.Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.
*Example:** 2016-12-19T16:39:57.600Z
-
getTimeCreatedLessThan
public Date getTimeCreatedLessThan()
Search for resources that were created before a specific date.Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in “YYYY-MM-ddThh:mmZ” format with a Z offset, as defined by RFC 3339.
*Example:** 2016-12-19T16:39:57.600Z
-
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 ListAlertPoliciesRequest.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.
-
toBuilder
public ListAlertPoliciesRequest.Builder toBuilder()
Return an instance ofListAlertPoliciesRequest.Builder
that allows you to modify request properties.- Returns:
- instance of
ListAlertPoliciesRequest.Builder
that allows you to modify request properties.
-
builder
public static ListAlertPoliciesRequest.Builder builder()
Return a new builder for this request object.- Returns:
- builder for the request 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 classBmcRequest<Void>
-
hashCode
public int hashCode()
Description copied from class:BmcRequest
Uses getInvocationCallback and getRetryConfiguration to generate a hash.- Overrides:
hashCode
in classBmcRequest<Void>
-
-