Class ListCatalogsRequest

Inheritance

object

ListCatalogsRequest

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 ListCatalogsRequest : IOciRequest

Examples

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

Properties

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment where you want to list resources.

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. The match is not case sensitive.

LifecycleState

Declaration

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

Property Value

Type	Description
LifecycleState?	A filter to return only resources that match the specified lifecycle state. The 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.

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 ListCatalogsRequest.SortByEnum? SortBy { get; set; }

Property Value

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

Property Value

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

Implements

IOciRequest