Package com.oracle.bmc.apmtraces.requests

Class QueryRequest.Builder

java.lang.Object

com.oracle.bmc.apmtraces.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	Description
Builder()

Method Summary

Modifier and Type	Method	Description
QueryRequest.Builder	apmDomainId(String apmDomainId)	The APM Domain ID for the intended request.
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)	The maximum number of items to return.
QueryRequest.Builder	opcRequestId(String opcRequestId)	Unique Oracle-assigned identifier for the request.
QueryRequest.Builder	page(String page)	The page token representing the page where to start retrieving results.
QueryRequest.Builder	queryDetails(QueryDetails queryDetails)	Request body containing the query to be run against the trace, span, services, background queries and other metric data and to filter and retrieve the results.
QueryRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
QueryRequest.Builder	timeSpanStartedGreaterThanOrEqualTo(Date timeSpanStartedGreaterThanOrEqualTo)	Include spans that have a spanStartTime equal to or greater than this value.
QueryRequest.Builder	timeSpanStartedLessThan(Date timeSpanStartedLessThan)	Include spans that have a spanStartTime less than this value.

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

apmDomainId

public QueryRequest.Builder apmDomainId(String apmDomainId)

The APM Domain ID for the intended request.

Parameters:

apmDomainId - the value to set

Returns:

this builder instance

timeSpanStartedGreaterThanOrEqualTo

public QueryRequest.Builder timeSpanStartedGreaterThanOrEqualTo(Date timeSpanStartedGreaterThanOrEqualTo)

Include spans that have a spanStartTime equal to or greater than this value.

Also, include logs and traces that have startTime greater than this value.

Parameters:

timeSpanStartedGreaterThanOrEqualTo - the value to set

Returns:

this builder instance

timeSpanStartedLessThan

public QueryRequest.Builder timeSpanStartedLessThan(Date timeSpanStartedLessThan)

Include spans that have a spanStartTime less than this value.

Also, include traces that have startTime less than this value and logs that have endTime less than this value.

Parameters:

timeSpanStartedLessThan - the value to set

Returns:

this builder instance

queryDetails

public QueryRequest.Builder queryDetails(QueryDetails queryDetails)

Request body containing the query to be run against the trace, span, services, background queries and other metric data and to filter and retrieve the results.

Parameters:

queryDetails - the value to set

Returns:

this builder instance

opcRequestId

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

limit

public QueryRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public QueryRequest.Builder page(String page)

The page token representing the page where to start retrieving results.

This is usually retrieved from a previous response.

Parameters:

page - 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