Package com.oracle.bmc.nosql.model

Class Index

java.lang.Object

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

com.oracle.bmc.nosql.model.Index

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

Information about an index.
Note: Objects should always be created or deserialized using the Index.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 Index.Builder, which maintain a set of all explicitly set fields called Index.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Index.Builder
static class	Index.LifecycleState	The state of an index.

Field Summary

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

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
Index(String name, String compartmentId, String tableName, String tableId, List<IndexKey> keys, Index.LifecycleState lifecycleState, String lifecycleDetails)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static Index.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getCompartmentId()	Compartment Identifier.
List<IndexKey>	getKeys()	A set of keys for a secondary index.
String	getLifecycleDetails()	A message describing the current state in more detail.
Index.LifecycleState	getLifecycleState()	The state of an index.
String	getName()	Index name.
String	getTableId()	the OCID of the table to which this index belongs.
String	getTableName()	The name of the table to which this index belongs.
int	hashCode()
Index.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

Index

@Deprecated
@ConstructorProperties({"name","compartmentId","tableName","tableId","keys","lifecycleState","lifecycleDetails"})
public Index(String name,
             String compartmentId,
             String tableName,
             String tableId,
             List<IndexKey> keys,
             Index.LifecycleState lifecycleState,
             String lifecycleDetails)

Deprecated.

Method Detail

builder

public static Index.Builder builder()

Create a new builder.

toBuilder

public Index.Builder toBuilder()

getName

public String getName()

Index name.

Returns:

the value

getCompartmentId

public String getCompartmentId()

Compartment Identifier.

Returns:

the value

getTableName

public String getTableName()

The name of the table to which this index belongs.

Returns:

the value

getTableId

public String getTableId()

the OCID of the table to which this index belongs.

Returns:

the value

getKeys

public List<IndexKey> getKeys()

A set of keys for a secondary index.

Returns:

the value

getLifecycleState

public Index.LifecycleState getLifecycleState()

The state of an index.

Returns:

the value

getLifecycleDetails

public String getLifecycleDetails()

A message describing the current state in more detail.

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