Class ListIndexesRequest

Inheritance

object

ListIndexesRequest

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.NosqlService.Requests

Assembly: OCI.DotNetSDK.Nosql.dll

Syntax

public class ListIndexesRequest : IOciRequest

Examples

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

Properties

CompartmentId

Declaration

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

Property Value

Type	Description
string	The ID of a table's compartment. When a table is identified by name, the compartmentId is often needed to provide context for interpreting the name.

LifecycleState

Declaration

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

Property Value

Type	Description
ListIndexesRequest.LifecycleStateEnum?	Filter list by the lifecycle state of the item.

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	A shell-globbing-style (*?[]) filter for names.

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.

SortBy

Declaration

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

Property Value

Type	Description
ListIndexesRequest.SortByEnum?	The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. If no value is specified timeCreated is default.

SortOrder

Declaration

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

Property Value

Type	Description
ListIndexesRequest.SortOrderEnum?	The sort order to use, either 'ASC' or 'DESC'.

TableNameOrId

Declaration

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

Property Value

Type	Description
string	A table name within the compartment, or a table OCID.

Remarks

Required

Implements

IOciRequest