com.oracle.bmc.loganalytics.requests

Class ListSourcesRequest.Builder

java.lang.Object

com.oracle.bmc.loganalytics.requests.ListSourcesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListSourcesRequest,Void>

Enclosing class:

ListSourcesRequest

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ListSourcesRequest	build() Build the instance of ListSourcesRequest as configured by this builder
ListSourcesRequest	buildWithoutInvocationCallback() Build the instance of ListSourcesRequest as configured by this builder
ListSourcesRequest.Builder	categories(String categories) A comma-separated list of categories used for filtering
ListSourcesRequest.Builder	compartmentId(String compartmentId) The ID of the compartment in which to list resources.
ListSourcesRequest.Builder	copy(ListSourcesRequest o) Copy method to populate the builder with values from the given instance.
ListSourcesRequest.Builder	entityType(String entityType) A filter to return only sources associated with entities of the specified type.
ListSourcesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
ListSourcesRequest.Builder	isAutoAssociated(Boolean isAutoAssociated) An auto-associate flag used for filtering.
ListSourcesRequest.Builder	isSimplified(Boolean isSimplified) A flag specifying whether or not to return all source information, or a subset of the information about each source.
ListSourcesRequest.Builder	isSystem(ListSourcesRequest.IsSystem isSystem) The system value used for filtering.
ListSourcesRequest.Builder	limit(Integer limit) The maximum number of items to return.
ListSourcesRequest.Builder	name(String name) A filter to return only log analytics entities whose name matches the entire name given.
ListSourcesRequest.Builder	namespaceName(String namespaceName) The Logging Analytics namespace used for the request.
ListSourcesRequest.Builder	opcRequestId(String opcRequestId) The client request ID for tracing.
ListSourcesRequest.Builder	page(String page) The page token representing the page at which to start retrieving results.
ListSourcesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListSourcesRequest.Builder	sortBy(ListSourcesRequest.SortBy sortBy) The attribute used to sort the returned sources
ListSourcesRequest.Builder	sortOrder(ListSourcesRequest.SortOrder sortOrder) The sort order to use, either ascending (ASC) or descending (DESC).
ListSourcesRequest.Builder	sourceDisplayText(String sourceDisplayText) The source display text used for filtering.
ListSourcesRequest.Builder	sourceType(String sourceType) The source type.

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 ListSourcesRequest.Builder namespaceName(String namespaceName)

The Logging Analytics namespace used for the request.

Parameters:

namespaceName - the value to set

Returns:

this builder instance

compartmentId

public ListSourcesRequest.Builder compartmentId(String compartmentId)

The ID of the compartment in which to list resources.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

entityType

public ListSourcesRequest.Builder entityType(String entityType)

A filter to return only sources associated with entities of the specified type. The match is case-insensitive.

Parameters:

entityType - the value to set

Returns:

this builder instance

sourceDisplayText

public ListSourcesRequest.Builder sourceDisplayText(String sourceDisplayText)

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

Parameters:

sourceDisplayText - the value to set

Returns:

this builder instance

isSystem

public ListSourcesRequest.Builder isSystem(ListSourcesRequest.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

isAutoAssociated

public ListSourcesRequest.Builder isAutoAssociated(Boolean isAutoAssociated)

An auto-associate flag used for filtering. Only sources which are marked for automatic association will be returned.

Parameters:

isAutoAssociated - the value to set

Returns:

this builder instance

sortOrder

public ListSourcesRequest.Builder sortOrder(ListSourcesRequest.SortOrder sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListSourcesRequest.Builder sortBy(ListSourcesRequest.SortBy sortBy)

The attribute used to sort the returned sources

Parameters:

sortBy - the value to set

Returns:

this builder instance

limit

public ListSourcesRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListSourcesRequest.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

name

public ListSourcesRequest.Builder name(String name)

A filter to return only log analytics entities whose name matches the entire name given. The match is case-insensitive.

Parameters:

name - the value to set

Returns:

this builder instance

sourceType

public ListSourcesRequest.Builder sourceType(String sourceType)

The source type.

Parameters:

sourceType - the value to set

Returns:

this builder instance

categories

public ListSourcesRequest.Builder categories(String categories)

A comma-separated list of categories used for filtering

Parameters:

categories - the value to set

Returns:

this builder instance

isSimplified

public ListSourcesRequest.Builder isSimplified(Boolean isSimplified)

A flag specifying whether or not to return all source information, or a subset of the information about each source. A value of true will return only the source unique identifier and the source name. A value of false will return all source information (such as author, updated date, system flag, etc.)

Parameters:

isSimplified - the value to set

Returns:

this builder instance

opcRequestId

public ListSourcesRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

public ListSourcesRequest.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 ListSourcesRequest.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 ListSourcesRequest.Builder copy(ListSourcesRequest o)

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

Specified by:

copy in interface BmcRequest.Builder<ListSourcesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListSourcesRequest build()

Build the instance of ListSourcesRequest 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<ListSourcesRequest,Void>

Returns:

instance of ListSourcesRequest

buildWithoutInvocationCallback

public ListSourcesRequest buildWithoutInvocationCallback()

Build the instance of ListSourcesRequest 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 ListSourcesRequest