Package com.oracle.bmc.datacatalog.requests

Class SearchCriteriaRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<SearchCriteria>

com.oracle.bmc.datacatalog.requests.SearchCriteriaRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190325")
public class SearchCriteriaRequest
extends BmcRequest<SearchCriteria>

Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/datacatalog/SearchCriteriaExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use SearchCriteriaRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchCriteriaRequest.Builder
static class	SearchCriteriaRequest.SortBy	The field to sort by.
static class	SearchCriteriaRequest.SortOrder	The sort order to use, either ‘asc’ or ‘desc’.

Constructor Summary

Constructors

Constructor	Description
SearchCriteriaRequest()

Method Summary

Modifier and Type	Method	Description
static SearchCriteriaRequest.Builder	builder()	Return a new builder for this request object.
boolean	equals(Object o)	Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
SearchCriteria	getBody$()	Alternative accessor for the body parameter.
String	getCatalogId()	Unique catalog identifier.
String	getDisplayName()	A filter to return only resources that match the entire display name given.
LifecycleState	getLifecycleState()	A filter to return only resources that match the specified lifecycle state.
Integer	getLimit()	The maximum number of items to return.
String	getName()	Immutable resource name.
String	getOpcRequestId()	The client request ID for tracing.
String	getPage()	The page token representing the page at which to start retrieving results.
SearchCriteria	getSearchCriteriaDetails()	The information used to create an extended search results.
SearchCriteriaRequest.SortBy	getSortBy()	The field to sort by.
SearchCriteriaRequest.SortOrder	getSortOrder()	The sort order to use, either ‘asc’ or ‘desc’.
String	getTimeout()	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.
int	hashCode()	Uses getInvocationCallback and getRetryConfiguration to generate a hash.
SearchCriteriaRequest.Builder	toBuilder()	Return an instance of SearchCriteriaRequest.Builder that allows you to modify request properties.
String	toString()

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchCriteriaRequest

public SearchCriteriaRequest()

Method Detail

getCatalogId

public String getCatalogId()

Unique catalog identifier.

getSearchCriteriaDetails

public SearchCriteria getSearchCriteriaDetails()

The information used to create an extended search results.

getDisplayName

public String getDisplayName()

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

The match is not case sensitive.

getName

public String getName()

Immutable resource name.

getLifecycleState

public LifecycleState getLifecycleState()

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

The value is case insensitive.

getTimeout

public String getTimeout()

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.

getSortBy

public SearchCriteriaRequest.SortBy getSortBy()

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.

getSortOrder

public SearchCriteriaRequest.SortOrder getSortOrder()

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

getLimit

public Integer getLimit()

The maximum number of items to return.

getPage

public String getPage()

The page token representing the page at which to start retrieving results.

This is usually retrieved from a previous list call.

getOpcRequestId

public String getOpcRequestId()

The client request ID for tracing.

getBody$

public SearchCriteria getBody$()

Alternative accessor for the body parameter.

Overrides:

getBody$ in class BmcRequest<SearchCriteria>

Returns:

body parameter

toBuilder

public SearchCriteriaRequest.Builder toBuilder()

Return an instance of SearchCriteriaRequest.Builder that allows you to modify request properties.

Returns:

instance of SearchCriteriaRequest.Builder that allows you to modify request properties.

builder

public static SearchCriteriaRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.

Overrides:

equals in class BmcRequest<SearchCriteria>

hashCode

public int hashCode()

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to generate a hash.

Overrides:

hashCode in class BmcRequest<SearchCriteria>