Class ListBastionsRequest
Implements
Inherited Members
Namespace: Oci.BastionService.Requests
Assembly: OCI.DotNetSDK.Bastion.dll
Syntax
public class ListBastionsRequest : IOciRequest
Examples
Click here to see an example of how to use ListBastions request.
Properties
BastionId
Declaration
[HttpConverter(TargetEnum.Query, "bastionId")]
public string BastionId { get; set; }
Property Value
Type | Description |
---|---|
string | The unique identifier (OCID) of the bastion in which to list resources. |
BastionLifecycleState
Declaration
[HttpConverter(TargetEnum.Query, "bastionLifecycleState")]
public BastionLifecycleState? BastionLifecycleState { get; set; }
Property Value
Type | Description |
---|---|
BastionLifecycleState? | A filter to return only resources their lifecycleState matches the given lifecycleState. |
CompartmentId
Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type | Description |
---|---|
string | The unique identifier (OCID) of the compartment in which to list resources. |
Remarks
Required
Limit
Declaration
[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }
Property Value
Type | Description |
---|---|
int? | The maximum number of items to return. |
Name
Declaration
[HttpConverter(TargetEnum.Query, "name")]
public string Name { get; set; }
Property Value
Type | Description |
---|---|
string | A filter to return only resources that match the entire name given. |
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 ListBastionsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type | Description |
---|---|
ListBastionsRequest.SortByEnum? | The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. If no value is specified timeCreated is default. |
SortOrder
Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public SortOrder? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
SortOrder? | The sort order to use, either 'asc' or 'desc'. |