Package com.oracle.bmc.logging.requests

Class ListLogsRequest.Builder

java.lang.Object

com.oracle.bmc.logging.requests.ListLogsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListLogsRequest,Void>

Enclosing class:

ListLogsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListLogsRequest	build()	Build the instance of ListLogsRequest as configured by this builder
ListLogsRequest	buildWithoutInvocationCallback()	Build the instance of ListLogsRequest as configured by this builder
ListLogsRequest.Builder	copy(ListLogsRequest o)	Copy method to populate the builder with values from the given instance.
ListLogsRequest.Builder	displayName(String displayName)	Resource name.
ListLogsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListLogsRequest.Builder	lifecycleState(LogLifecycleState lifecycleState)	Lifecycle state of the log object
ListLogsRequest.Builder	limit(Integer limit)	When setting the page limit, specifies the maximum number of unfiltered records that can be fetched from the data store in one request.
ListLogsRequest.Builder	logGroupId(String logGroupId)	OCID of a log group to work with.
ListLogsRequest.Builder	logType(ListLogsRequest.LogType logType)	The logType that the log object is for, whether custom or service.
ListLogsRequest.Builder	opcRequestId(String opcRequestId)	Unique Oracle-assigned identifier for the request.
ListLogsRequest.Builder	page(String page)	For list pagination.
ListLogsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListLogsRequest.Builder	sortBy(ListLogsRequest.SortBy sortBy)	The field to sort by (one column only).
ListLogsRequest.Builder	sortOrder(ListLogsRequest.SortOrder sortOrder)	The sort order to use, whether ‘asc’ or ‘desc’.
ListLogsRequest.Builder	sourceResource(String sourceResource)	Log object resource, which is a field of LogSummary.Configuration.Source.
ListLogsRequest.Builder	sourceService(String sourceService)	Service that created the log object, which is a field of LogSummary.Configuration.Source.

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

logGroupId

public ListLogsRequest.Builder logGroupId(String logGroupId)

OCID of a log group to work with.

Parameters:

logGroupId - the value to set

Returns:

this builder instance

logType

public ListLogsRequest.Builder logType(ListLogsRequest.LogType logType)

The logType that the log object is for, whether custom or service.

Parameters:

logType - the value to set

Returns:

this builder instance

sourceService

public ListLogsRequest.Builder sourceService(String sourceService)

Service that created the log object, which is a field of LogSummary.Configuration.Source.

Parameters:

sourceService - the value to set

Returns:

this builder instance

sourceResource

public ListLogsRequest.Builder sourceResource(String sourceResource)

Log object resource, which is a field of LogSummary.Configuration.Source.

Parameters:

sourceResource - the value to set

Returns:

this builder instance

displayName

public ListLogsRequest.Builder displayName(String displayName)

Resource name.

Parameters:

displayName - the value to set

Returns:

this builder instance

lifecycleState

public ListLogsRequest.Builder lifecycleState(LogLifecycleState lifecycleState)

Lifecycle state of the log object

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

page

public ListLogsRequest.Builder page(String page)

For list pagination.

The value of the opc-next-page or opc-previous-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

Parameters:

page - the value to set

Returns:

this builder instance

limit

public ListLogsRequest.Builder limit(Integer limit)

When setting the page limit, specifies the maximum number of unfiltered records that can be fetched from the data store in one request.

Filtering happens after the records are retrieved. Subsequent pages might include results that match the query criteria.

Parameters:

limit - the value to set

Returns:

this builder instance

sortBy

public ListLogsRequest.Builder sortBy(ListLogsRequest.SortBy sortBy)

The field to sort by (one column only).

Default sort order is ascending exception of timeCreated and timeLastModified columns (descending).

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListLogsRequest.Builder sortOrder(ListLogsRequest.SortOrder sortOrder)

The sort order to use, whether ‘asc’ or ‘desc’.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

opcRequestId

public ListLogsRequest.Builder opcRequestId(String opcRequestId)

Unique Oracle-assigned identifier for the request.

If you need to contact Oracle about a particular request, please provide the request ID.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListLogsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListLogsRequest build()

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

Returns:

instance of ListLogsRequest

buildWithoutInvocationCallback

public ListLogsRequest buildWithoutInvocationCallback()

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