Class ListDbSystemsRequest

Inheritance

object

ListDbSystemsRequest

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 ListDbSystemsRequest : IOciRequest

Examples

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

Properties

AvailabilityDomain

Declaration

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

Property Value

Type	Description
string	A filter to return only resources that match the given availability domain exactly.

BackupId

Declaration

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

Property Value

Type	Description
string	The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.

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

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 entire display name given. The match is not case sensitive.

LifecycleState

Declaration

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

Property Value

Type	Description
DbSystemSummary.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 ListDbSystemsRequest.SortByEnum? SortBy { get; set; }

Property Value

Type	Description
ListDbSystemsRequest.SortByEnum?	The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.

SortOrder

Declaration

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

Property Value

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

Implements

IOciRequest