com.oracle.bmc.loganalytics.requests

Class ListLabelsRequest.Builder

java.lang.Object

com.oracle.bmc.loganalytics.requests.ListLabelsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListLabelsRequest,Void>

Enclosing class:

ListLabelsRequest

public static class ListLabelsRequest.Builder
extends Object
implements BmcRequest.Builder<ListLabelsRequest,Void>

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ListLabelsRequest	build() Build the instance of ListLabelsRequest as configured by this builder
ListLabelsRequest	buildWithoutInvocationCallback() Build the instance of ListLabelsRequest as configured by this builder
ListLabelsRequest.Builder	copy(ListLabelsRequest o) Copy method to populate the builder with values from the given instance.
ListLabelsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
ListLabelsRequest.Builder	isAliasPop(Boolean isAliasPop) A flag indicating whether or not return the aliases used by each label.
ListLabelsRequest.Builder	isCountPop(Boolean isCountPop) A flag indicating whether or not to count the label usage per source and per rule.
ListLabelsRequest.Builder	isSystem(ListLabelsRequest.IsSystem isSystem) The system value used for filtering.
ListLabelsRequest.Builder	labelDisplayText(String labelDisplayText) The label display text used for filtering.
ListLabelsRequest.Builder	labelName(String labelName) The label name used for filtering.
ListLabelsRequest.Builder	labelPriority(ListLabelsRequest.LabelPriority labelPriority) The label priority used for filtering.
ListLabelsRequest.Builder	labelSortBy(ListLabelsRequest.LabelSortBy labelSortBy) The attribute used to sort the returned labels
ListLabelsRequest.Builder	limit(Integer limit) The maximum number of items to return.
ListLabelsRequest.Builder	namespaceName(String namespaceName) The Logging Analytics namespace used for the request.
ListLabelsRequest.Builder	opcRequestId(String opcRequestId) The client request ID for tracing.
ListLabelsRequest.Builder	page(String page) The page token representing the page at which to start retrieving results.
ListLabelsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListLabelsRequest.Builder	sortOrder(ListLabelsRequest.SortOrder sortOrder) The sort order to use, either ascending (ASC) or descending (DESC).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder

body$

Constructor Detail

Builder

public Builder()

Method Detail

namespaceName

public ListLabelsRequest.Builder namespaceName(String namespaceName)

The Logging Analytics namespace used for the request.

Parameters:

namespaceName - the value to set

Returns:

this builder instance

labelName

public ListLabelsRequest.Builder labelName(String labelName)

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

Parameters:

labelName - the value to set

Returns:

this builder instance

labelDisplayText

public ListLabelsRequest.Builder labelDisplayText(String labelDisplayText)

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

Parameters:

labelDisplayText - the value to set

Returns:

this builder instance

isSystem

public ListLabelsRequest.Builder isSystem(ListLabelsRequest.IsSystem isSystem)

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

Parameters:

isSystem - the value to set

Returns:

this builder instance

labelPriority

public ListLabelsRequest.Builder labelPriority(ListLabelsRequest.LabelPriority labelPriority)

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

Parameters:

labelPriority - the value to set

Returns:

this builder instance

isCountPop

public ListLabelsRequest.Builder isCountPop(Boolean isCountPop)

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

Parameters:

isCountPop - the value to set

Returns:

this builder instance

isAliasPop

public ListLabelsRequest.Builder isAliasPop(Boolean isAliasPop)

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

Parameters:

isAliasPop - the value to set

Returns:

this builder instance

limit

public ListLabelsRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListLabelsRequest.Builder page(String page)

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

Parameters:

page - the value to set

Returns:

this builder instance

sortOrder

public ListLabelsRequest.Builder sortOrder(ListLabelsRequest.SortOrder sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

labelSortBy

public ListLabelsRequest.Builder labelSortBy(ListLabelsRequest.LabelSortBy labelSortBy)

The attribute used to sort the returned labels

Parameters:

labelSortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListLabelsRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

public ListLabelsRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)

Set the invocation callback for the request to be built.

Parameters:

invocationCallback - the invocation callback to be set for the request

Returns:

this builder instance

retryConfiguration

public ListLabelsRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)

Set the retry configuration for the request to be built.

Parameters:

retryConfiguration - the retry configuration to be used for the request

Returns:

this builder instance

copy

public ListLabelsRequest.Builder copy(ListLabelsRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<ListLabelsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListLabelsRequest build()

Build the instance of ListLabelsRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<ListLabelsRequest,Void>

Returns:

instance of ListLabelsRequest

buildWithoutInvocationCallback

public ListLabelsRequest buildWithoutInvocationCallback()

Build the instance of ListLabelsRequest as configured by this builder

Note that this method does not take calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method build() does

Returns:

instance of ListLabelsRequest