com.oracle.bmc.nosql.model

Class CreateIndexDetails

java.lang.Object

com.oracle.bmc.http.internal.ExplicitlySetBmcModel

com.oracle.bmc.nosql.model.CreateIndexDetails

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

Specifications for the new index.
Note: Objects should always be created or deserialized using the CreateIndexDetails.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 CreateIndexDetails.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	CreateIndexDetails.Builder

Constructor Summary

Constructors

Constructor and Description
CreateIndexDetails(String name, String compartmentId, List<IndexKey> keys, Boolean isIfNotExists) Deprecated.

Method Summary

Modifier and Type	Method and Description
static CreateIndexDetails.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getCompartmentId() The OCID of the table’s compartment.
Boolean	getIsIfNotExists() If true, the operation completes successfully even when the index exists.
List<IndexKey>	getKeys() A set of keys for a secondary index.
String	getName() Index name.
int	hashCode()
CreateIndexDetails.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

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

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateIndexDetails

@Deprecated
 @ConstructorProperties(value={"name","compartmentId","keys","isIfNotExists"})
public CreateIndexDetails(String name,
                                                                                                                     String compartmentId,
                                                                                                                     List<IndexKey> keys,
                                                                                                                     Boolean isIfNotExists)

Deprecated.

Method Detail

builder

public static CreateIndexDetails.Builder builder()

Create a new builder.

toBuilder

public CreateIndexDetails.Builder toBuilder()

getName

public String getName()

Index name.

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID of the table’s compartment. Required if the tableNameOrId path parameter is a table name. Optional if tableNameOrId is an OCID. If tableNameOrId is an OCID, and compartmentId is supplied, the latter must match the identified table’s compartmentId.

Returns:

the value

getKeys

public List<IndexKey> getKeys()

A set of keys for a secondary index.

Returns:

the value

getIsIfNotExists

public Boolean getIsIfNotExists()

If true, the operation completes successfully even when the index exists. Otherwise, an attempt to create an index that already exists will return an error.

Returns:

the value

toString

public String toString()

Overrides:

toString in class 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 ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class ExplicitlySetBmcModel