Class SearchCriteriaRequest

Inheritance

object

SearchCriteriaRequest

Implements

IOciRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatacatalogService.Requests

Assembly: OCI.DotNetSDK.Datacatalog.dll

Syntax

public class SearchCriteriaRequest : IOciRequest

Examples

Click here to see an example of how to use SearchCriteria request.

Properties

CatalogId

Declaration

[Required(ErrorMessage = "CatalogId is required.")]
[HttpConverter(TargetEnum.Path, "catalogId")]
public string CatalogId { get; set; }

Property Value

Type	Description
string	Unique catalog identifier.

Remarks

Required

DisplayName

Declaration

[HttpConverter(TargetEnum.Query, "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A filter to return only resources that match the entire display name given. The match is not case sensitive.

LifecycleState

Declaration

[HttpConverter(TargetEnum.Query, "lifecycleState")]
public LifecycleState? LifecycleState { get; set; }

Property Value

Type	Description
LifecycleState?	A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

Limit

Declaration

[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }

Property Value

Type	Description
int?	The maximum number of items to return.

Name

Declaration

[HttpConverter(TargetEnum.Query, "name")]
public string Name { get; set; }

Property Value

Type	Description
string	Immutable resource name.

OpcRequestId

Declaration

[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }

Property Value

Type	Description
string	The client request ID for tracing.

Page

Declaration

[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }

Property Value

Type	Description
string	The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

SearchCriteriaDetails

Declaration

[HttpConverter(TargetEnum.Body)]
public SearchCriteria SearchCriteriaDetails { get; set; }

Property Value

Type	Description
SearchCriteria	The information used to create an extended search results.

SortBy

Declaration

[HttpConverter(TargetEnum.Query, "sortBy")]
public SearchCriteriaRequest.SortByEnum? SortBy { get; set; }

Property Value

Type	Description
SearchCriteriaRequest.SortByEnum?	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.

SortOrder

Declaration

[HttpConverter(TargetEnum.Query, "sortOrder")]
public SearchCriteriaRequest.SortOrderEnum? SortOrder { get; set; }

Property Value

Type	Description
SearchCriteriaRequest.SortOrderEnum?	The sort order to use, either 'asc' or 'desc'.

Timeout

Declaration

[HttpConverter(TargetEnum.Query, "timeout")]
public string Timeout { get; set; }

Property Value

Type	Description
string	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.

Implements

IOciRequest