Show / Hide Table of Contents

Class ListHsmPartitionsRequest

Inheritance
object
ListHsmPartitionsRequest
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.KeymanagementService.Requests
Assembly: OCI.DotNetSDK.Keymanagement.dll
Syntax
public class ListHsmPartitionsRequest : IOciRequest
Examples

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

Properties

HsmClusterId

Declaration
[Required(ErrorMessage = "HsmClusterId is required.")]
[HttpConverter(TargetEnum.Path, "hsmClusterId")]
public string HsmClusterId { get; set; }
Property Value
Type Description
string

The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.

Remarks

Required

LifecycleState

Declaration
[HttpConverter(TargetEnum.Query, "lifecycleState")]
public HsmPartition.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
HsmPartition.LifecycleStateEnum?

A filter that returns only resources that match the specified lifecycle state. The state value is case-insensitive.

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.

OpcRequestId

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

Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.

Page

Declaration
[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }
Property Value
Type Description
string

The value of the opc-next-page response header from the previous "List" call.

SortBy

Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListHsmPartitionsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type Description
ListHsmPartitionsRequest.SortByEnum?

The field to sort by. You can specify only one sort order. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending.

SortOrder

Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListHsmPartitionsRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type Description
ListHsmPartitionsRequest.SortOrderEnum?

The sort order to use, either ascending (ASC) or descending (DESC).

Implements

IOciRequest
In this article
Back to top