Class ListLookupsRequest

Inheritance
object
ListLookupsRequest
Implements
Inherited Members
Namespace: Oci.LoganalyticsService.Requests
Assembly: OCI.DotNetSDK.Loganalytics.dll
Syntax
public class ListLookupsRequest : IOciRequest
Examples

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

Properties

Categories

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

A comma-separated list of categories used for filtering

CompartmentId

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

The compartment id

IsHideSpecial

Declaration
[HttpConverter(TargetEnum.Query, "isHideSpecial")]
public bool? IsHideSpecial { get; set; }
Property Value
Type Description
bool?

A flag indicating whether or not to return OMC annotated or hidden lookups.

IsSystem

Declaration
[HttpConverter(TargetEnum.Query, "isSystem")]
public ListLookupsRequest.IsSystemEnum? IsSystem { get; set; }
Property Value
Type Description
ListLookupsRequest.IsSystemEnum?

The system value used for filtering. Only items with the specified system value will be returned. Valid values are built in, custom (for user defined items), or all (for all items, regardless of system value).

Limit

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

The maximum number of items to return.

LookupDisplayText

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

The lookup text used for filtering. Only lookups with the specified name or description will be returned.

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

sort by field

SortOrder

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

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

Status

Declaration
[HttpConverter(TargetEnum.Query, "status")]
public ListLookupsRequest.StatusEnum? Status { get; set; }
Property Value
Type Description
ListLookupsRequest.StatusEnum?

The lookup status used for filtering when fetching a list of lookups.

Type

Declaration
[Required(ErrorMessage = "Type is required.")]
[HttpConverter(TargetEnum.Query, "type")]
public ListLookupsRequest.TypeEnum? Type { get; set; }
Property Value
Type Description
ListLookupsRequest.TypeEnum?

The lookup type. Valid values are Lookup, Dictionary or Module.
Remarks

Required

Implements