com.oracle.bmc.loganalytics.requests

Class QueryRequest.Builder

java.lang.Object

com.oracle.bmc.loganalytics.requests.QueryRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<QueryRequest,QueryDetails>

Enclosing class:

QueryRequest

public static class QueryRequest.Builder
extends Object
implements BmcRequest.Builder<QueryRequest,QueryDetails>

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
QueryRequest.Builder	body$(QueryDetails body) Alternative setter for the body parameter.
QueryRequest	build() Build the instance of QueryRequest as configured by this builder
QueryRequest	buildWithoutInvocationCallback() Build the instance of QueryRequest as configured by this builder
QueryRequest.Builder	copy(QueryRequest o) Copy method to populate the builder with values from the given instance.
QueryRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
QueryRequest.Builder	limit(Integer limit) Maximum number of results to return in this request.
QueryRequest.Builder	namespaceName(String namespaceName) The Logging Analytics namespace used for the request.
QueryRequest.Builder	opcRequestId(String opcRequestId) The client request ID for tracing.
QueryRequest.Builder	page(String page) The page token representing the page at which to start retrieving results.
QueryRequest.Builder	queryDetails(QueryDetails queryDetails) Query to be executed.
QueryRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

namespaceName

public QueryRequest.Builder namespaceName(String namespaceName)

The Logging Analytics namespace used for the request.

Parameters:

namespaceName - the value to set

Returns:

this builder instance

queryDetails

public QueryRequest.Builder queryDetails(QueryDetails queryDetails)

Query to be executed.

Parameters:

queryDetails - the value to set

Returns:

this builder instance

page

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

opcRequestId

public QueryRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

limit

public QueryRequest.Builder limit(Integer limit)

Maximum number of results to return in this request. Note a limit=-1 returns all results from pageId onwards up to maxtotalCount.

Parameters:

limit - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<QueryRequest,QueryDetails>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public QueryRequest build()

Build the instance of QueryRequest 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<QueryRequest,QueryDetails>

Returns:

instance of QueryRequest

body$

public QueryRequest.Builder body$(QueryDetails body)

Alternative setter for the body parameter.

Specified by:

body$ in interface BmcRequest.Builder<QueryRequest,QueryDetails>

Parameters:

body - the body parameter

Returns:

this builder instance

buildWithoutInvocationCallback

public QueryRequest buildWithoutInvocationCallback()

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