Class ListSqlCollectionsRequest

Inheritance
object
ListSqlCollectionsRequest
Implements
Inherited Members
Namespace: Oci.DatasafeService.Requests
Assembly: OCI.DotNetSDK.Datasafe.dll
Syntax
public class ListSqlCollectionsRequest : IOciRequest
Examples

Click here to see an example of how to use ListSqlCollections request.

Properties

AccessLevel

Declaration
[HttpConverter(TargetEnum.Query, "accessLevel")]
public ListSqlCollectionsRequest.AccessLevelEnum? AccessLevel { get; set; }
Property Value
Type Description
ListSqlCollectionsRequest.AccessLevelEnum?

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.

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

A filter to return only resources that match the specified compartment OCID.
Remarks

Required

CompartmentIdInSubtree

Declaration
[HttpConverter(TargetEnum.Query, "compartmentIdInSubtree")]
public bool? CompartmentIdInSubtree { get; set; }
Property Value
Type Description
bool?

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.

DbUserName

Declaration
[HttpConverter(TargetEnum.Query, "dbUserName")]
public string DbUserName { get; set; }
Property Value
Type Description
string

A filter to return only items that match the specified user name.

DisplayName

Declaration
[HttpConverter(TargetEnum.Query, "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

A filter to return only resources that match the specified display name.

LifecycleState

Declaration
[HttpConverter(TargetEnum.Query, "lifecycleState")]
public SqlCollectionLifecycleState? LifecycleState { get; set; }
Property Value
Type Description
SqlCollectionLifecycleState?

The current state of the SQL collection.

Limit

Declaration
[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }
Property Value
Type Description
int?

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.

OpcRequestId

Declaration
[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }
Property Value
Type Description
string

Unique identifier for the request.

Page

Declaration
[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }
Property Value
Type Description
string

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.

SortBy

Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListSqlCollectionsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type Description
ListSqlCollectionsRequest.SortByEnum?

The field used for sorting. Only one sorting parameter order (sortOrder) can be specified. The DISPLAYNAME sort order is case sensitive.

SortOrder

Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListSqlCollectionsRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type Description
ListSqlCollectionsRequest.SortOrderEnum?

The sort order to use, either ascending (ASC) or descending (DESC).

SqlCollectionId

Declaration
[HttpConverter(TargetEnum.Query, "sqlCollectionId")]
public string SqlCollectionId { get; set; }
Property Value
Type Description
string

An optional filter to return only resources that match the specified OCID of the SQL collection resource.

TargetDatabaseGroupId

Declaration
[HttpConverter(TargetEnum.Query, "targetDatabaseGroupId")]
public string TargetDatabaseGroupId { get; set; }
Property Value
Type Description
string

A filter to return the target database group that matches the specified OCID.

TargetId

Declaration
[HttpConverter(TargetEnum.Query, "targetId")]
public string TargetId { get; set; }
Property Value
Type Description
string

A filter to return only items related to a specific target OCID.

TimeCreatedGreaterThanOrEqualTo

Declaration
[HttpConverter(TargetEnum.Query, "timeCreatedGreaterThanOrEqualTo")]
public DateTime? TimeCreatedGreaterThanOrEqualTo { get; set; }
Property Value
Type Description
DateTime?

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

TimeCreatedLessThan

Declaration
[HttpConverter(TargetEnum.Query, "timeCreatedLessThan")]
public DateTime? TimeCreatedLessThan { get; set; }
Property Value
Type Description
DateTime?

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

Implements