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.MysqlService.Requests

Assembly: OCI.DotNetSDK.Mysql.dll

Syntax

public class ListDbSystemsRequest : IOciRequest

Examples

Click here to see an example of how to use ListDbSystems 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

ConfigurationId

Declaration

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

Property Value

Type	Description
string	The requested Configuration instance.

DatabaseManagement

Declaration

[HttpConverter(TargetEnum.Query, "databaseManagement", CollectionFormatType.Multi)]
public List<ListDbSystemsRequest.DatabaseManagementEnum> DatabaseManagement { get; set; }

Property Value

Type	Description
List<ListDbSystemsRequest.DatabaseManagementEnum>	Filter DB Systems by their Database Management configuration.

DbSystemId

Declaration

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

Property Value

Type	Description
string	The DB System OCID.

DisplayName

Declaration

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

Property Value

Type	Description
string	A filter to return only the resource matching the given display name exactly.

IsHeatWaveClusterAttached

Declaration

[HttpConverter(TargetEnum.Query, "isHeatWaveClusterAttached")]
public bool? IsHeatWaveClusterAttached { get; set; }

Property Value

Type	Description
bool?	If true, return only DB Systems with a HeatWave cluster attached, if false return only DB Systems with no HeatWave cluster attached. If not present, return all DB Systems.

IsUpToDate

Declaration

[HttpConverter(TargetEnum.Query, "isUpToDate")]
public bool? IsUpToDate { get; set; }

Property Value

Type	Description
bool?	Filter instances if they are using the latest revision of the Configuration they are associated with.

LifecycleState

Declaration

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

Property Value

Type	Description
DbSystem.LifecycleStateEnum?	DbSystem Lifecycle State

Limit

Declaration

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

Property Value

Type	Description
int?	The maximum number of items to return in a paginated list call. For information about pagination, see List Pagination.

OpcRequestId

Declaration

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

Property Value

Type	Description
string	Customer-defined unique identifier for the request. If you need to contact Oracle about a specific request, please provide the request ID that you supplied in this header with the request.

Page

Declaration

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

Property Value

Type	Description
string	The value of the opc-next-page or opc-prev-page response header from the previous list call. For information about pagination, see List Pagination.

SortBy

Declaration

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

Property Value

Type	Description
ListDbSystemsRequest.SortByEnum?	The field to sort by. Only one sort order may be provided. Time fields are default ordered as descending. Display name is default ordered as ascending.

SortOrder

Declaration

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

Property Value

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

Implements

IOciRequest