Class ListReplicasRequest
Implements
Inherited Members
Namespace: Oci.MysqlService.Requests
Assembly: OCI.DotNetSDK.Mysql.dll
Syntax
public class ListReplicasRequest : IOciRequest
Examples
Click here to see an example of how to use ListReplicas 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. |
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. |
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 ReplicaSummary.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
ReplicaSummary.LifecycleStateEnum? | The LifecycleState of the read replica. |
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 |
ReplicaId
Declaration
[HttpConverter(TargetEnum.Query, "replicaId")]
public string ReplicaId { get; set; }
Property Value
Type | Description |
---|---|
string | The read replica OCID. |
SortBy
Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListReplicasRequest.SortByEnum? SortBy { get; set; }
Property Value
Type | Description |
---|---|
ListReplicasRequest.SortByEnum? | The field to sort by. You can sort by one field only. By default, the Time field is sorted in descending order and the Display Name field in ascending order. |
SortOrder
Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListReplicasRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
ListReplicasRequest.SortOrderEnum? | The sort order to use (ASC or DESC). |