Class ListNodeBackupsRequest
Implements
Inherited Members
Namespace: Oci.BdsService.Requests
Assembly: OCI.DotNetSDK.Bds.dll
Syntax
public class ListNodeBackupsRequest : IOciRequest
Examples
Click here to see an example of how to use ListNodeBackups request.
Properties
BdsInstanceId
Declaration
[Required(ErrorMessage = "BdsInstanceId is required.")]
[HttpConverter(TargetEnum.Path, "bdsInstanceId")]
public string BdsInstanceId { get; set; }
Property Value
| Type | Description |
|---|---|
| string | The OCID of the cluster. |
Remarks
Required
DisplayName
Declaration
[HttpConverter(TargetEnum.Query, "displayName")]
public string DisplayName { get; set; }
Property Value
| Type | Description |
|---|---|
| string | The display name belonged to the node backup. |
LifecycleState
Declaration
[HttpConverter(TargetEnum.Query, "lifecycleState")]
public NodeBackup.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
| Type | Description |
|---|---|
| NodeBackup.LifecycleStateEnum? | The state of the Node's Backup. |
Limit
Declaration
[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }
Property Value
| Type | Description |
|---|---|
| int? | The maximum number of items to return. |
NodeHostName
Declaration
[HttpConverter(TargetEnum.Query, "nodeHostName")]
public string NodeHostName { get; set; }
Property Value
| Type | Description |
|---|---|
| string | The node host name belonged to a node that has a node backup. |
OpcRequestId
Declaration
[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }
Property Value
| Type | Description |
|---|---|
| string | The client request ID for tracing. |
Page
Declaration
[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }
Property Value
| Type | Description |
|---|---|
| string | The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. |
SortBy
Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListNodeBackupsRequest.SortByEnum? SortBy { get; set; }
Property Value
| Type | Description |
|---|---|
| ListNodeBackupsRequest.SortByEnum? | The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. |
SortOrder
Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public SortOrders? SortOrder { get; set; }
Property Value
| Type | Description |
|---|---|
| SortOrders? | The sort order to use, either 'asc' or 'desc'. |