Show / Hide Table of Contents

Class GetIndexRequest

Inheritance
object
GetIndexRequest
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 GetIndexRequest : IOciRequest
Examples

Click here to see an example of how to use GetIndex 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.

IndexName

Declaration
[Required(ErrorMessage = "IndexName is required.")]
[HttpConverter(TargetEnum.Path, "indexName")]
public string IndexName { get; set; }
Property Value
Type Description
string

The name of a table's index.

Remarks

Required

OpcRequestId

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

The client request ID for tracing.

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
In this article
Back to top