Class ListAlertPoliciesRequest.Builder
- java.lang.Object
-
- com.oracle.bmc.datasafe.requests.ListAlertPoliciesRequest.Builder
-
- All Implemented Interfaces:
BmcRequest.Builder<ListAlertPoliciesRequest,Void>
- Enclosing class:
- ListAlertPoliciesRequest
public static class ListAlertPoliciesRequest.Builder extends Object implements BmcRequest.Builder<ListAlertPoliciesRequest,Void>
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListAlertPoliciesRequest.BuilderaccessLevel(ListAlertPoliciesRequest.AccessLevel accessLevel)Valid values are RESTRICTED and ACCESSIBLE.ListAlertPoliciesRequest.BuilderalertPolicyId(String alertPolicyId)A filter to return policy by it’s OCID.ListAlertPoliciesRequestbuild()Build the instance of ListAlertPoliciesRequest as configured by this builderListAlertPoliciesRequestbuildWithoutInvocationCallback()Build the instance of ListAlertPoliciesRequest as configured by this builderListAlertPoliciesRequest.BuildercompartmentId(String compartmentId)A filter to return only resources that match the specified compartment OCID.ListAlertPoliciesRequest.BuildercompartmentIdInSubtree(Boolean compartmentIdInSubtree)Default is false.ListAlertPoliciesRequest.Buildercopy(ListAlertPoliciesRequest o)Copy method to populate the builder with values from the given instance.ListAlertPoliciesRequest.BuilderdisplayName(String displayName)A filter to return only resources that match the specified display name.ListAlertPoliciesRequest.BuilderinvocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)Set the invocation callback for the request to be built.ListAlertPoliciesRequest.BuilderisUserDefined(Boolean isUserDefined)An optional filter to return only alert policies that are user-defined or not.ListAlertPoliciesRequest.BuilderlifecycleState(AlertPolicyLifecycleState lifecycleState)An optional filter to return only alert policies that have the given life-cycle state.ListAlertPoliciesRequest.Builderlimit(Integer limit)For list pagination.ListAlertPoliciesRequest.BuilderopcRequestId(String opcRequestId)Unique identifier for the request.ListAlertPoliciesRequest.Builderpage(String page)For list pagination.ListAlertPoliciesRequest.BuilderretryConfiguration(RetryConfiguration retryConfiguration)Set the retry configuration for the request to be built.ListAlertPoliciesRequest.BuildersortBy(ListAlertPoliciesRequest.SortBy sortBy)The field to sort by.ListAlertPoliciesRequest.BuildersortOrder(ListAlertPoliciesRequest.SortOrder sortOrder)The sort order to use, either ascending (ASC) or descending (DESC).ListAlertPoliciesRequest.BuildertimeCreatedGreaterThanOrEqualTo(Date timeCreatedGreaterThanOrEqualTo)A filter to return only the resources that were created after the specified date and time, as defined by RFC3339.ListAlertPoliciesRequest.BuildertimeCreatedLessThan(Date timeCreatedLessThan)Search for resources that were created before a specific date.ListAlertPoliciesRequest.Buildertype(AlertPolicyType type)An optional filter to return only alert policies of a certain type.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder
body$
-
-
-
-
Method Detail
-
compartmentId
public ListAlertPoliciesRequest.Builder compartmentId(String compartmentId)
A filter to return only resources that match the specified compartment OCID.- Parameters:
compartmentId- the value to set- Returns:
- this builder instance
-
alertPolicyId
public ListAlertPoliciesRequest.Builder alertPolicyId(String alertPolicyId)
A filter to return policy by it’s OCID.- Parameters:
alertPolicyId- the value to set- Returns:
- this builder instance
-
type
public ListAlertPoliciesRequest.Builder type(AlertPolicyType type)
An optional filter to return only alert policies of a certain type.- Parameters:
type- the value to set- Returns:
- this builder instance
-
isUserDefined
public ListAlertPoliciesRequest.Builder isUserDefined(Boolean isUserDefined)
An optional filter to return only alert policies that are user-defined or not.- Parameters:
isUserDefined- the value to set- Returns:
- this builder instance
-
displayName
public ListAlertPoliciesRequest.Builder displayName(String displayName)
A filter to return only resources that match the specified display name.- Parameters:
displayName- the value to set- Returns:
- this builder instance
-
lifecycleState
public ListAlertPoliciesRequest.Builder lifecycleState(AlertPolicyLifecycleState lifecycleState)
An optional filter to return only alert policies that have the given life-cycle state.- Parameters:
lifecycleState- the value to set- Returns:
- this builder instance
-
limit
public ListAlertPoliciesRequest.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.
- Parameters:
limit- the value to set- Returns:
- this builder instance
-
page
public ListAlertPoliciesRequest.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.
- Parameters:
page- the value to set- Returns:
- this builder instance
-
sortOrder
public ListAlertPoliciesRequest.Builder sortOrder(ListAlertPoliciesRequest.SortOrder sortOrder)
The sort order to use, either ascending (ASC) or descending (DESC).- Parameters:
sortOrder- the value to set- Returns:
- this builder instance
-
sortBy
public ListAlertPoliciesRequest.Builder sortBy(ListAlertPoliciesRequest.SortBy sortBy)
The field to sort by.Only one sort parameter may be provided.
- Parameters:
sortBy- the value to set- Returns:
- this builder instance
-
opcRequestId
public ListAlertPoliciesRequest.Builder opcRequestId(String opcRequestId)
Unique identifier for the request.- Parameters:
opcRequestId- the value to set- Returns:
- this builder instance
-
timeCreatedGreaterThanOrEqualTo
public ListAlertPoliciesRequest.Builder timeCreatedGreaterThanOrEqualTo(Date timeCreatedGreaterThanOrEqualTo)
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
- Parameters:
timeCreatedGreaterThanOrEqualTo- the value to set- Returns:
- this builder instance
-
timeCreatedLessThan
public ListAlertPoliciesRequest.Builder timeCreatedLessThan(Date timeCreatedLessThan)
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
- Parameters:
timeCreatedLessThan- the value to set- Returns:
- this builder instance
-
compartmentIdInSubtree
public ListAlertPoliciesRequest.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.
- Parameters:
compartmentIdInSubtree- the value to set- Returns:
- this builder instance
-
accessLevel
public ListAlertPoliciesRequest.Builder accessLevel(ListAlertPoliciesRequest.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.
- Parameters:
accessLevel- the value to set- Returns:
- this builder instance
-
invocationCallback
public ListAlertPoliciesRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
Set the invocation callback for the request to be built.- Parameters:
invocationCallback- the invocation callback to be set for the request- Returns:
- this builder instance
-
retryConfiguration
public ListAlertPoliciesRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.- Parameters:
retryConfiguration- the retry configuration to be used for the request- Returns:
- this builder instance
-
copy
public ListAlertPoliciesRequest.Builder copy(ListAlertPoliciesRequest o)
Copy method to populate the builder with values from the given instance.- Specified by:
copyin interfaceBmcRequest.Builder<ListAlertPoliciesRequest,Void>- Parameters:
o- other request from which to copy values- Returns:
- this builder instance
-
build
public ListAlertPoliciesRequest build()
Build the instance of ListAlertPoliciesRequest as configured by this builderNote that this method takes calls to
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)into account, while the methodbuildWithoutInvocationCallback()does not.This is the preferred method to build an instance.
- Specified by:
buildin interfaceBmcRequest.Builder<ListAlertPoliciesRequest,Void>- Returns:
- instance of ListAlertPoliciesRequest
-
buildWithoutInvocationCallback
public ListAlertPoliciesRequest buildWithoutInvocationCallback()
Build the instance of ListAlertPoliciesRequest as configured by this builderNote that this method does not take calls to
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)into account, while the methodbuild()does- Returns:
- instance of ListAlertPoliciesRequest
-
-