Show / Hide Table of Contents

Class ListCategoriesRequest

Inheritance
object
ListCategoriesRequest
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.LoganalyticsService.Requests
Assembly: OCI.DotNetSDK.Loganalytics.dll
Syntax
public class ListCategoriesRequest : IOciRequest
Examples

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

Properties

CategoryDisplayText

Declaration
[HttpConverter(TargetEnum.Query, "categoryDisplayText")]
public string CategoryDisplayText { get; set; }
Property Value
Type Description
string

The category display text used for filtering. Only categories matching the specified display name or description will be returned.

CategoryType

Declaration
[HttpConverter(TargetEnum.Query, "categoryType")]
public string CategoryType { get; set; }
Property Value
Type Description
string

A comma-separated list of category types used for filtering. Only categories of the specified types will be returned.

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 log analytics entities whose name matches the entire name given. The match is case-insensitive.

NamespaceName

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

The Logging Analytics namespace used for the request.

Remarks

Required

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

The attribute used to sort the returned categories

SortOrder

Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListCategoriesRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type Description
ListCategoriesRequest.SortOrderEnum?

The sort order to use, either ascending (ASC) or descending (DESC).

Implements

IOciRequest
In this article
Back to top