Show / Hide Table of Contents

Class ListLabelsRequest

Inheritance
object
ListLabelsRequest
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 ListLabelsRequest : IOciRequest
Examples

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

Properties

IsAliasPop

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

A flag indicating whether or not return the aliases used by each label.

IsCountPop

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

A flag indicating whether or not to count the label usage per source and per rule.

IsSystem

Declaration
[HttpConverter(TargetEnum.Query, "isSystem")]
public ListLabelsRequest.IsSystemEnum? IsSystem { get; set; }
Property Value
Type Description
ListLabelsRequest.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).

LabelDisplayText

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

The label display text used for filtering. Only labels with the specified name or description will be returned.

LabelName

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

The label name used for filtering. Only items with, or associated with, the specified label name will be returned.

LabelPriority

Declaration
[HttpConverter(TargetEnum.Query, "labelPriority")]
public ListLabelsRequest.LabelPriorityEnum? LabelPriority { get; set; }
Property Value
Type Description
ListLabelsRequest.LabelPriorityEnum?

The label priority used for filtering. Only labels with the specified priority will be returned.

LabelSortBy

Declaration
[HttpConverter(TargetEnum.Query, "labelSortBy")]
public ListLabelsRequest.LabelSortByEnum? LabelSortBy { get; set; }
Property Value
Type Description
ListLabelsRequest.LabelSortByEnum?

The attribute used to sort the returned labels

Limit

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

The maximum number of items to return.

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.

SortOrder

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

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

Implements

IOciRequest
In this article
Back to top