com.oracle.bmc.loganalytics.requests

Class ListLabelsRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.loganalytics.requests.ListLabelsRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200601")
public class ListLabelsRequest
extends BmcRequest<Void>

Example: Click here to see how to use ListLabelsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListLabelsRequest.Builder
static class	ListLabelsRequest.IsSystem The system value used for filtering.
static class	ListLabelsRequest.LabelPriority The label priority used for filtering.
static class	ListLabelsRequest.LabelSortBy The attribute used to sort the returned labels
static class	ListLabelsRequest.SortOrder The sort order to use, either ascending (ASC) or descending (DESC).

Constructor Summary

Constructors

Constructor and Description
ListLabelsRequest()

Method Summary

Modifier and Type	Method and Description
static ListLabelsRequest.Builder	builder() Return a new builder for this request object.
boolean	equals(Object o) Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
Boolean	getIsAliasPop() A flag indicating whether or not return the aliases used by each label.
Boolean	getIsCountPop() A flag indicating whether or not to count the label usage per source and per rule.
ListLabelsRequest.IsSystem	getIsSystem() The system value used for filtering.
String	getLabelDisplayText() The label display text used for filtering.
String	getLabelName() The label name used for filtering.
ListLabelsRequest.LabelPriority	getLabelPriority() The label priority used for filtering.
ListLabelsRequest.LabelSortBy	getLabelSortBy() The attribute used to sort the returned labels
Integer	getLimit() The maximum number of items to return.
String	getNamespaceName() The Logging Analytics namespace used for the request.
String	getOpcRequestId() The client request ID for tracing.
String	getPage() The page token representing the page at which to start retrieving results.
ListLabelsRequest.SortOrder	getSortOrder() The sort order to use, either ascending (ASC) or descending (DESC).
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListLabelsRequest.Builder	toBuilder() Return an instance of ListLabelsRequest.Builder that allows you to modify request properties.
String	toString()

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListLabelsRequest

public ListLabelsRequest()

Method Detail

getNamespaceName

public String getNamespaceName()

The Logging Analytics namespace used for the request.

getLabelName

public String getLabelName()

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

getLabelDisplayText

public String getLabelDisplayText()

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

getIsSystem

public ListLabelsRequest.IsSystem getIsSystem()

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).

getLabelPriority

public ListLabelsRequest.LabelPriority getLabelPriority()

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

getIsCountPop

public Boolean getIsCountPop()

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

getIsAliasPop

public Boolean getIsAliasPop()

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

getLimit

public Integer getLimit()

The maximum number of items to return.

getPage

public String getPage()

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

getSortOrder

public ListLabelsRequest.SortOrder getSortOrder()

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

getLabelSortBy

public ListLabelsRequest.LabelSortBy getLabelSortBy()

The attribute used to sort the returned labels

getOpcRequestId

public String getOpcRequestId()

The client request ID for tracing.

toBuilder

public ListLabelsRequest.Builder toBuilder()

Return an instance of ListLabelsRequest.Builder that allows you to modify request properties.

Returns:

instance of ListLabelsRequest.Builder that allows you to modify request properties.

builder

public static ListLabelsRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.

Overrides:

equals in class BmcRequest<Void>

hashCode

public int hashCode()

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to generate a hash.

Overrides:

hashCode in class BmcRequest<Void>