Class ListDatabasesRequest

Inheritance

object

ListDatabasesRequest

Implements

IOciRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatabaseService.Requests

Assembly: OCI.DotNetSDK.Database.dll

Syntax

public class ListDatabasesRequest : IOciRequest

Examples

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

Properties

CompartmentId

Declaration

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

Property Value

Type	Description
string	The compartment OCID.

Remarks

Required

DbHomeId

Declaration

[HttpConverter(TargetEnum.Query, "dbHomeId")]
public string DbHomeId { get; set; }

Property Value

Type	Description
string	A Database Home OCID.

DbName

Declaration

[HttpConverter(TargetEnum.Query, "dbName")]
public string DbName { get; set; }

Property Value

Type	Description
string	A filter to return only resources that match the entire database name given. The match is not case sensitive.

LifecycleState

Declaration

[HttpConverter(TargetEnum.Query, "lifecycleState")]
public DatabaseSummary.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
DatabaseSummary.LifecycleStateEnum?	A filter to return only resources that match the given lifecycle state exactly.

Limit

Declaration

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

Property Value

Type	Description
int?	The maximum number of items to return per page.

Page

Declaration

[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }

Property Value

Type	Description
string	The pagination token to continue listing from.

SortBy

Declaration

[HttpConverter(TargetEnum.Query, "sortBy")]
public ListDatabasesRequest.SortByEnum? SortBy { get; set; }

Property Value

Type	Description
ListDatabasesRequest.SortByEnum?	The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DBNAME is ascending. The DBNAME sort order is case sensitive.

SortOrder

Declaration

[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListDatabasesRequest.SortOrderEnum? SortOrder { get; set; }

Property Value

Type	Description
ListDatabasesRequest.SortOrderEnum?	The sort order to use, either ascending (ASC) or descending (DESC).

SystemId

Declaration

[HttpConverter(TargetEnum.Query, "systemId")]
public string SystemId { get; set; }

Property Value

Type	Description
string	The OCID of the Exadata DB system that you want to filter the database results by. Applies only to Exadata DB systems.

Implements

IOciRequest