Show / Hide Table of Contents

Class UsersRequest

Inheritance
object
UsersRequest
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.DatacatalogService.Requests
Assembly: OCI.DotNetSDK.Datacatalog.dll
Syntax
public class UsersRequest : IOciRequest
Examples

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

Properties

CatalogId

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

Unique catalog identifier.

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.

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 UsersRequest.SortByEnum? SortBy { get; set; }
Property Value
Type Description
UsersRequest.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 UsersRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type Description
UsersRequest.SortOrderEnum?

The sort order to use, either 'asc' or 'desc'.

Implements

IOciRequest
In this article
Back to top