Class ListSqlCollectionsRequest
- java.lang.Object
-
- com.oracle.bmc.requests.BmcRequest<Void>
-
- com.oracle.bmc.datasafe.requests.ListSqlCollectionsRequest
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20181201") public class ListSqlCollectionsRequest extends BmcRequest<Void>Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/datasafe/ListSqlCollectionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSqlCollectionsRequest.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classListSqlCollectionsRequest.AccessLevelValid values are RESTRICTED and ACCESSIBLE.static classListSqlCollectionsRequest.Builderstatic classListSqlCollectionsRequest.SortByThe field used for sorting.static classListSqlCollectionsRequest.SortOrderThe sort order to use, either ascending (ASC) or descending (DESC).
-
Constructor Summary
Constructors Constructor Description ListSqlCollectionsRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListSqlCollectionsRequest.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’.ListSqlCollectionsRequest.AccessLevelgetAccessLevel()Valid values are RESTRICTED and ACCESSIBLE.StringgetCompartmentId()A filter to return only resources that match the specified compartment OCID.BooleangetCompartmentIdInSubtree()Default is false.StringgetDbUserName()A filter to return only items that match the specified user name.StringgetDisplayName()A filter to return only resources that match the specified display name.SqlCollectionLifecycleStategetLifecycleState()The current state of the SQL collection.IntegergetLimit()For list pagination.StringgetOpcRequestId()Unique identifier for the request.StringgetPage()For list pagination.ListSqlCollectionsRequest.SortBygetSortBy()The field used for sorting.ListSqlCollectionsRequest.SortOrdergetSortOrder()The sort order to use, either ascending (ASC) or descending (DESC).StringgetSqlCollectionId()An optional filter to return only resources that match the specified OCID of the SQL collection resource.StringgetTargetDatabaseGroupId()A filter to return the target database group that matches the specified OCID.StringgetTargetId()A filter to return only items related to a specific target OCID.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.ListSqlCollectionsRequest.BuildertoBuilder()Return an instance ofListSqlCollectionsRequest.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.
-
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 ListSqlCollectionsRequest.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.
-
getDisplayName
public String getDisplayName()
A filter to return only resources that match the specified display name.
-
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.
-
getLifecycleState
public SqlCollectionLifecycleState getLifecycleState()
The current state of the SQL collection.
-
getSqlCollectionId
public String getSqlCollectionId()
An optional filter to return only resources that match the specified OCID of the SQL collection resource.
-
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
-
getTargetId
public String getTargetId()
A filter to return only items related to a specific target OCID.
-
getTargetDatabaseGroupId
public String getTargetDatabaseGroupId()
A filter to return the target database group that matches the specified OCID.
-
getDbUserName
public String getDbUserName()
A filter to return only items that match the specified user name.
-
getSortOrder
public ListSqlCollectionsRequest.SortOrder getSortOrder()
The sort order to use, either ascending (ASC) or descending (DESC).
-
getSortBy
public ListSqlCollectionsRequest.SortBy getSortBy()
The field used for sorting.Only one sorting parameter order (sortOrder) can be specified. The DISPLAYNAME sort order is case sensitive.
-
getOpcRequestId
public String getOpcRequestId()
Unique identifier for the request.
-
toBuilder
public ListSqlCollectionsRequest.Builder toBuilder()
Return an instance ofListSqlCollectionsRequest.Builderthat allows you to modify request properties.- Returns:
- instance of
ListSqlCollectionsRequest.Builderthat allows you to modify request properties.
-
builder
public static ListSqlCollectionsRequest.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>
-
-