Package com.oracle.bmc.datacatalog.requests

Class SuggestMatchesRequest.Builder

java.lang.Object

com.oracle.bmc.datacatalog.requests.SuggestMatchesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<SuggestMatchesRequest,Void>

Enclosing class:

SuggestMatchesRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SuggestMatchesRequest	build()	Build the instance of SuggestMatchesRequest as configured by this builder
SuggestMatchesRequest	buildWithoutInvocationCallback()	Build the instance of SuggestMatchesRequest as configured by this builder
SuggestMatchesRequest.Builder	catalogId(String catalogId)	Unique catalog identifier.
SuggestMatchesRequest.Builder	copy(SuggestMatchesRequest o)	Copy method to populate the builder with values from the given instance.
SuggestMatchesRequest.Builder	inputText(String inputText)	Text input string used for computing potential matching suggestions.
SuggestMatchesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
SuggestMatchesRequest.Builder	limit(Integer limit)	Limit for the list of potential matches returned from the Suggest API.
SuggestMatchesRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
SuggestMatchesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
SuggestMatchesRequest.Builder	timeout(String timeout)	A search timeout string (for example, timeout=4000ms), bounding the search request to be executed within the specified time value and bail with the hits accumulated up to that point when expired.

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

catalogId

public SuggestMatchesRequest.Builder catalogId(String catalogId)

Unique catalog identifier.

Parameters:

catalogId - the value to set

Returns:

this builder instance

inputText

public SuggestMatchesRequest.Builder inputText(String inputText)

Text input string used for computing potential matching suggestions.

Parameters:

inputText - the value to set

Returns:

this builder instance

timeout

public SuggestMatchesRequest.Builder timeout(String timeout)

A search timeout string (for example, timeout=4000ms), bounding the search request to be executed within the specified time value and bail with the hits accumulated up to that point when expired.

Defaults to no timeout.

Parameters:

timeout - the value to set

Returns:

this builder instance

limit

public SuggestMatchesRequest.Builder limit(Integer limit)

Limit for the list of potential matches returned from the Suggest API.

If not specified, will default to 10.

Parameters:

limit - the value to set

Returns:

this builder instance

opcRequestId

public SuggestMatchesRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<SuggestMatchesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public SuggestMatchesRequest build()

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

Returns:

instance of SuggestMatchesRequest

buildWithoutInvocationCallback

public SuggestMatchesRequest buildWithoutInvocationCallback()

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