Class ListRegistrationPoliciesRequest
- java.lang.Object
-
- com.oracle.bmc.requests.BmcRequest<Void>
-
- com.oracle.bmc.datasafe.requests.ListRegistrationPoliciesRequest
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20181201") public class ListRegistrationPoliciesRequest extends BmcRequest<Void>Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.97.1/datasafe/ListRegistrationPoliciesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListRegistrationPoliciesRequest.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classListRegistrationPoliciesRequest.AccessLevelValid values are RESTRICTED and ACCESSIBLE.static classListRegistrationPoliciesRequest.Builderstatic classListRegistrationPoliciesRequest.SortByField to sort the registration policies by.static classListRegistrationPoliciesRequest.SortOrderThe sort order to use, either ascending (ASC) or descending (DESC).
-
Constructor Summary
Constructors Constructor Description ListRegistrationPoliciesRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListRegistrationPoliciesRequest.Builderbuilder()Return a new builder for this request object.booleanequals(Object o)Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.ListRegistrationPoliciesRequest.AccessLevelgetAccessLevel()Valid values are RESTRICTED and ACCESSIBLE.StringgetCompartmentId()A filter to return only resources that match the specified compartment OCID.BooleangetCompartmentIdInSubtree()Default is false.StringgetConnectionId()Filter to return the registration policies matching the specified connection ID.PolicyConnectionOption.ConnectionTypegetConnectionType()Filter to return the registration policies matching the specified connectionType i.e ONPREM_CONNECTOR or PRIVATE_ENDPOINT.StringgetDisplayName()A filter to return only resources that match the specified display name.RegistrationPolicy.EnablementLevelgetEnablementLevel()Filter registration policies by resource type.RegistrationPolicy.LifecycleStategetLifecycleState()Filter registration policies by their lifecycle state.IntegergetLimit()For list pagination.StringgetOpcRequestId()Unique identifier for the request.StringgetPage()For list pagination.StringgetRegistrationPolicyId()Filter to return the registration policy matching the specified OCID.StringgetResourceId()Filter to return the registration policy matching the specified resource OCID.ListRegistrationPoliciesRequest.SortBygetSortBy()Field to sort the registration policies by.ListRegistrationPoliciesRequest.SortOrdergetSortOrder()The sort order to use, either ascending (ASC) or descending (DESC).DategetTimeCreatedGreaterThanOrEqualTo()A filter to return only the resources that were created after the specified date and time, as defined by RFC3339.DategetTimeCreatedLessThan()Search for resources that were created before a specific date.inthashCode()Uses getInvocationCallback and getRetryConfiguration to generate a hash.ListRegistrationPoliciesRequest.BuildertoBuilder()Return an instance ofListRegistrationPoliciesRequest.Builderthat allows you to modify request properties.StringtoString()-
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.
-
getDisplayName
public String getDisplayName()
A filter to return only resources that match the specified display name.
-
getSortBy
public ListRegistrationPoliciesRequest.SortBy getSortBy()
Field to sort the registration policies by.Only one sort order (sortOrder) can be specified. Defaults to sorting by timeCreated in descending order
-
getLifecycleState
public RegistrationPolicy.LifecycleState getLifecycleState()
Filter registration policies by their lifecycle state.
-
getEnablementLevel
public RegistrationPolicy.EnablementLevel getEnablementLevel()
Filter registration policies by resource type.
-
getResourceId
public String getResourceId()
Filter to return the registration policy matching the specified resource 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.
-
getAccessLevel
public ListRegistrationPoliciesRequest.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 ListRegistrationPoliciesRequest.SortOrder getSortOrder()
The sort order to use, either ascending (ASC) or descending (DESC).
-
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
-
getOpcRequestId
public String getOpcRequestId()
Unique identifier for the request.
-
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.
-
getRegistrationPolicyId
public String getRegistrationPolicyId()
Filter to return the registration policy matching the specified OCID.
-
getConnectionType
public PolicyConnectionOption.ConnectionType getConnectionType()
Filter to return the registration policies matching the specified connectionType i.e ONPREM_CONNECTOR or PRIVATE_ENDPOINT.
-
getConnectionId
public String getConnectionId()
Filter to return the registration policies matching the specified connection ID.
-
toBuilder
public ListRegistrationPoliciesRequest.Builder toBuilder()
Return an instance ofListRegistrationPoliciesRequest.Builderthat allows you to modify request properties.- Returns:
- instance of
ListRegistrationPoliciesRequest.Builderthat allows you to modify request properties.
-
builder
public static ListRegistrationPoliciesRequest.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:BmcRequestUses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.- Overrides:
equalsin classBmcRequest<Void>
-
hashCode
public int hashCode()
Description copied from class:BmcRequestUses getInvocationCallback and getRetryConfiguration to generate a hash.- Overrides:
hashCodein classBmcRequest<Void>
-
-