Class ListPeersRequest

Inheritance

object

ListPeersRequest

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

Assembly: OCI.DotNetSDK.Blockchain.dll

Syntax

public class ListPeersRequest : IOciRequest

Examples

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

Properties

BlockchainPlatformId

Declaration

[Required(ErrorMessage = "BlockchainPlatformId is required.")]
[HttpConverter(TargetEnum.Path, "blockchainPlatformId")]
public string BlockchainPlatformId { get; set; }

Property Value

Type	Description
string	Unique service identifier.

Remarks

Required

DisplayName

Declaration

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

Property Value

Type	Description
string	A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource

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.

OpcRetryToken

Declaration

[HttpConverter(TargetEnum.Header, "opc-retry-token")]
public string OpcRetryToken { get; set; }

Property Value

Type	Description
string	A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Page

Declaration

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

Property Value

Type	Description
string	The page at which to start retrieving results.

SortBy

Declaration

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

Property Value

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

Property Value

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

Implements

IOciRequest