com.oracle.bmc.nosql.model

Class IndexKey

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.nosql.model.IndexKey

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190828")
public final class IndexKey
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

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 ExplicitlySetBmcModel.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take ExplicitlySetBmcModel.__explicitlySet__ into account. The constructor, on the other hand, does not set ExplicitlySetBmcModel.__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)
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()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexKey

@Deprecated
 @ConstructorProperties(value={"columnName","jsonPath","jsonFieldType"})
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.

Returns:

the value

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.

Returns:

the value

getJsonFieldType

public String getJsonFieldType()

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

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel