com.oracle.bmc.nosql.model

Class IndexKey

java.lang.Object

com.oracle.bmc.nosql.model.IndexKey

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190828")
public final class IndexKey
extends Object

Specifies a single key in a secondary index.
Note: Objects should always be created or deserialized using the IndexKey.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the IndexKey.Builder, which maintain a set of all explicitly set fields called __explicitlySet__. The hashCode() and equals(Object) methods are implemented to take __explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndexKey.Builder

Constructor Summary

Constructors

Constructor and Description
IndexKey(String columnName, String jsonPath, String jsonFieldType) Deprecated.

Method Summary

Modifier and Type	Method and Description
static IndexKey.Builder	builder() Create a new builder.
boolean	equals(Object o)
Set<String>	get__explicitlySet__()
String	getColumnName() The name of a column to be included as an index key.
String	getJsonFieldType() If the specified column is of type JSON, jsonFieldType contains the type of the field indicated by jsonPath.
String	getJsonPath() If the specified column is of type JSON, jsonPath contains a dotted path indicating the field within the JSON object that will be the index key.
int	hashCode()
IndexKey.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexKey

@ConstructorProperties(value={"columnName","jsonPath","jsonFieldType"})
 @Deprecated
public IndexKey(String columnName,
                                                                                                     String jsonPath,
                                                                                                     String jsonFieldType)

Deprecated.

Method Detail

builder

public static IndexKey.Builder builder()

Create a new builder.

toBuilder

public IndexKey.Builder toBuilder()

getColumnName

public String getColumnName()

The name of a column to be included as an index key.

getJsonPath

public String getJsonPath()

If the specified column is of type JSON, jsonPath contains a dotted path indicating the field within the JSON object that will be the index key.

getJsonFieldType

public String getJsonFieldType()

If the specified column is of type JSON, jsonFieldType contains the type of the field indicated by jsonPath.

get__explicitlySet__

public Set<String> get__explicitlySet__()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object