com.oracle.bmc.datasafe.requests

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 here to see how to use ListSqlCollectionsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListSqlCollectionsRequest.AccessLevel Valid values are RESTRICTED and ACCESSIBLE.
static class	ListSqlCollectionsRequest.Builder
static class	ListSqlCollectionsRequest.SortBy The field used for sorting.
static class	ListSqlCollectionsRequest.SortOrder The sort order to use, either ascending (ASC) or descending (DESC).

Constructor Summary

Constructors

Constructor and Description
ListSqlCollectionsRequest()

Method Summary

Modifier and Type	Method and Description
static ListSqlCollectionsRequest.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’.
ListSqlCollectionsRequest.AccessLevel	getAccessLevel() Valid values are RESTRICTED and ACCESSIBLE.
String	getCompartmentId() A filter to return only resources that match the specified compartment OCID.
Boolean	getCompartmentIdInSubtree() Default is false.
String	getDbUserName() A filter to return only items that match the specified user name.
String	getDisplayName() A filter to return only resources that match the specified display name.
SqlCollectionLifecycleState	getLifecycleState() The current state of the SQL collection.
Integer	getLimit() For list pagination.
String	getOpcRequestId() Unique identifier for the request.
String	getPage() For list pagination.
ListSqlCollectionsRequest.SortBy	getSortBy() The field used for sorting.
ListSqlCollectionsRequest.SortOrder	getSortOrder() The sort order to use, either ascending (ASC) or descending (DESC).
String	getSqlCollectionId() An optional filter to return only resources that match the specified OCID of the SQL collection resource.
String	getTargetId() A filter to return only items related to a specific target OCID.
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.
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListSqlCollectionsRequest.Builder	toBuilder() Return an instance of ListSqlCollectionsRequest.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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListSqlCollectionsRequest

public ListSqlCollectionsRequest()

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.

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 of ListSqlCollectionsRequest.Builder that allows you to modify request properties.

Returns:

instance of ListSqlCollectionsRequest.Builder that 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

toString

public String toString()

Overrides:

toString in class 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 class BmcRequest<Void>

hashCode

public int hashCode()

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to generate a hash.

Overrides:

hashCode in class BmcRequest<Void>