Class ListSessionsRequest

Inheritance

object

ListSessionsRequest

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

Assembly: OCI.DotNetSDK.Bastion.dll

Syntax

public class ListSessionsRequest : IOciRequest

Examples

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

Properties

BastionId

Declaration

[Required(ErrorMessage = "BastionId is required.")]
[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 sessions.

Remarks

Required

DisplayName

Declaration

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

Property Value

Type	Description
string	A filter to return only resources that match the entire display name given.

Limit

Declaration

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

Property Value

Type	Description
int?	The maximum number of items to return.

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.

SessionId

Declaration

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

Property Value

Type	Description
string	The unique identifier (OCID) of the session in which to list resources.

SessionLifecycleState

Declaration

[HttpConverter(TargetEnum.Query, "sessionLifecycleState")]
public SessionLifecycleState? SessionLifecycleState { get; set; }

Property Value

Type	Description
SessionLifecycleState?	A filter to return only resources their lifecycleState matches the given lifecycleState.

SortBy

Declaration

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

Property Value

Type	Description
ListSessionsRequest.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 SortOrder? SortOrder { get; set; }

Property Value

Type	Description
SortOrder?	The sort order to use, either 'asc' or 'desc'.

Implements

IOciRequest