Package com.oracle.bmc.datacatalog.requests

Class SearchCriteriaRequest.Builder

java.lang.Object

com.oracle.bmc.datacatalog.requests.SearchCriteriaRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<SearchCriteriaRequest,SearchCriteria>

Enclosing class:

SearchCriteriaRequest

public static class SearchCriteriaRequest.Builder
extends Object
implements BmcRequest.Builder<SearchCriteriaRequest,SearchCriteria>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SearchCriteriaRequest.Builder	body$(SearchCriteria body)	Alternative setter for the body parameter.
SearchCriteriaRequest	build()	Build the instance of SearchCriteriaRequest as configured by this builder
SearchCriteriaRequest	buildWithoutInvocationCallback()	Build the instance of SearchCriteriaRequest as configured by this builder
SearchCriteriaRequest.Builder	catalogId(String catalogId)	Unique catalog identifier.
SearchCriteriaRequest.Builder	copy(SearchCriteriaRequest o)	Copy method to populate the builder with values from the given instance.
SearchCriteriaRequest.Builder	displayName(String displayName)	A filter to return only resources that match the entire display name given.
SearchCriteriaRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
SearchCriteriaRequest.Builder	lifecycleState(LifecycleState lifecycleState)	A filter to return only resources that match the specified lifecycle state.
SearchCriteriaRequest.Builder	limit(Integer limit)	The maximum number of items to return.
SearchCriteriaRequest.Builder	name(String name)	Immutable resource name.
SearchCriteriaRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
SearchCriteriaRequest.Builder	page(String page)	The page token representing the page at which to start retrieving results.
SearchCriteriaRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
SearchCriteriaRequest.Builder	searchCriteriaDetails(SearchCriteria searchCriteriaDetails)	The information used to create an extended search results.
SearchCriteriaRequest.Builder	sortBy(SearchCriteriaRequest.SortBy sortBy)	The field to sort by.
SearchCriteriaRequest.Builder	sortOrder(SearchCriteriaRequest.SortOrder sortOrder)	The sort order to use, either ‘asc’ or ‘desc’.
SearchCriteriaRequest.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

Constructor Detail

Builder

public Builder()

Method Detail

catalogId

public SearchCriteriaRequest.Builder catalogId(String catalogId)

Unique catalog identifier.

Parameters:

catalogId - the value to set

Returns:

this builder instance

searchCriteriaDetails

public SearchCriteriaRequest.Builder searchCriteriaDetails(SearchCriteria searchCriteriaDetails)

The information used to create an extended search results.

Parameters:

searchCriteriaDetails - the value to set

Returns:

this builder instance

displayName

public SearchCriteriaRequest.Builder displayName(String displayName)

A filter to return only resources that match the entire display name given.

The match is not case sensitive.

Parameters:

displayName - the value to set

Returns:

this builder instance

name

public SearchCriteriaRequest.Builder name(String name)

Immutable resource name.

Parameters:

name - the value to set

Returns:

this builder instance

lifecycleState

public SearchCriteriaRequest.Builder lifecycleState(LifecycleState lifecycleState)

A filter to return only resources that match the specified lifecycle state.

The value is case insensitive.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

timeout

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

sortBy

public SearchCriteriaRequest.Builder sortBy(SearchCriteriaRequest.SortBy sortBy)

The field to sort by.

Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public SearchCriteriaRequest.Builder sortOrder(SearchCriteriaRequest.SortOrder sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

limit

public SearchCriteriaRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public SearchCriteriaRequest.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 SearchCriteriaRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<SearchCriteriaRequest,SearchCriteria>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public SearchCriteriaRequest build()

Build the instance of SearchCriteriaRequest 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<SearchCriteriaRequest,SearchCriteria>

Returns:

instance of SearchCriteriaRequest

body$

public SearchCriteriaRequest.Builder body$(SearchCriteria body)

Alternative setter for the body parameter.

Specified by:

body$ in interface BmcRequest.Builder<SearchCriteriaRequest,SearchCriteria>

Parameters:

body - the body parameter

Returns:

this builder instance

buildWithoutInvocationCallback

public SearchCriteriaRequest buildWithoutInvocationCallback()

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