CosmosGlobalSecondaryIndexBuildStatus Class

Package:
com.azure.cosmos.models
Maven Artifact:
com.azure:azure-cosmos:4.82.0

public final class CosmosGlobalSecondaryIndexBuildStatus
extends ExpandableStringEnum<CosmosGlobalSecondaryIndexBuildStatus>

Represents the build status of a global secondary index as returned by the Azure Cosmos DB service.

This is an ExpandableStringEnum<T> so that values added by the service in the future are not a breaking change for clients. fromString(String name) will return an instance for any value, including ones not declared as a constant on this class.

Field Summary

Modifier and Type Field and Description
static final CosmosGlobalSecondaryIndexBuildStatus ACTIVE

The global secondary index has been fully built and is actively serving queries.
static final CosmosGlobalSecondaryIndexBuildStatus DELETE_IN_PROGRESS

The global secondary index is being deleted.
static final CosmosGlobalSecondaryIndexBuildStatus INITIALIZING

The global secondary index has been created and is initializing.
static final CosmosGlobalSecondaryIndexBuildStatus INITIAL_BUILD_AFTER_CREATE

The global secondary index is performing its initial build after being created.
static final CosmosGlobalSecondaryIndexBuildStatus INITIAL_BUILD_AFTER_RESTORE

The global secondary index is performing its initial build after the source container was restored.

Constructor Summary

Constructor Description
CosmosGlobalSecondaryIndexBuildStatus()

Deprecated

Creates a new instance of CosmosGlobalSecondaryIndexBuildStatus without a name.

Method Summary

Modifier and Type Method and Description
static CosmosGlobalSecondaryIndexBuildStatus fromString(String name)

Creates or finds a CosmosGlobalSecondaryIndexBuildStatus from its string representation.
static Collection<CosmosGlobalSecondaryIndexBuildStatus> values()

Gets the known CosmosGlobalSecondaryIndexBuildStatus values declared on this class.

Methods inherited from ExpandableStringEnum

<T>fromString <T>values equals getValue hashCode toString

Methods inherited from java.lang.Object

clone finalize getClass notify notifyAll wait wait wait

Field Details

ACTIVE

public static final CosmosGlobalSecondaryIndexBuildStatus ACTIVE

The global secondary index has been fully built and is actively serving queries.

DELETE_IN_PROGRESS

public static final CosmosGlobalSecondaryIndexBuildStatus DELETE_IN_PROGRESS

The global secondary index is being deleted.

INITIALIZING

public static final CosmosGlobalSecondaryIndexBuildStatus INITIALIZING

The global secondary index has been created and is initializing.

INITIAL_BUILD_AFTER_CREATE

public static final CosmosGlobalSecondaryIndexBuildStatus INITIAL_BUILD_AFTER_CREATE

The global secondary index is performing its initial build after being created.

INITIAL_BUILD_AFTER_RESTORE

public static final CosmosGlobalSecondaryIndexBuildStatus INITIAL_BUILD_AFTER_RESTORE

The global secondary index is performing its initial build after the source container was restored.

Constructor Details

CosmosGlobalSecondaryIndexBuildStatus

@Deprecated
public CosmosGlobalSecondaryIndexBuildStatus()

Deprecated

Creates a new instance of CosmosGlobalSecondaryIndexBuildStatus without a name.

Prefer fromString(String name) to obtain instances; this constructor is required by ExpandableStringEnum<T>.

Method Details

fromString

public static CosmosGlobalSecondaryIndexBuildStatus fromString(String name)

Creates or finds a CosmosGlobalSecondaryIndexBuildStatus from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding CosmosGlobalSecondaryIndexBuildStatus, or null when name is null.

values

public static Collection<CosmosGlobalSecondaryIndexBuildStatus> values()

Gets the known CosmosGlobalSecondaryIndexBuildStatus values declared on this class.

Returns:

Applies to