Package com.azure.cosmos.models

Class CosmosGlobalSecondaryIndexBuildStatus

java.lang.Object

com.azure.core.util.ExpandableStringEnum<CosmosGlobalSecondaryIndexBuildStatus>

com.azure.cosmos.models.CosmosGlobalSecondaryIndexBuildStatus

All Implemented Interfaces:

com.azure.core.util.ExpandableEnum<String>

@Beta(value=V4_81_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public final class CosmosGlobalSecondaryIndexBuildStatus
extends com.azure.core.util.ExpandableStringEnum<CosmosGlobalSecondaryIndexBuildStatus>

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

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

Field Summary

Fields

Modifier and Type	Field	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	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.
static final CosmosGlobalSecondaryIndexBuildStatus	INITIALIZING	The global secondary index has been created and is initializing.

Constructor Summary

Constructors

Constructor	Description
CosmosGlobalSecondaryIndexBuildStatus()	Deprecated. Use fromString(String) instead.

Method Summary

Modifier and Type	Method	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 class com.azure.core.util.ExpandableStringEnum

equals, fromString, getValue, hashCode, toString, values

Methods inherited from class java.lang.Object

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

Field Details

INITIALIZING

@Beta(value=V4_81_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public static final CosmosGlobalSecondaryIndexBuildStatus INITIALIZING

The global secondary index has been created and is initializing.

INITIAL_BUILD_AFTER_CREATE

@Beta(value=V4_81_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public static final CosmosGlobalSecondaryIndexBuildStatus INITIAL_BUILD_AFTER_CREATE

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

INITIAL_BUILD_AFTER_RESTORE

@Beta(value=V4_81_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public static final CosmosGlobalSecondaryIndexBuildStatus INITIAL_BUILD_AFTER_RESTORE

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

ACTIVE

@Beta(value=V4_81_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public static final CosmosGlobalSecondaryIndexBuildStatus ACTIVE

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

DELETE_IN_PROGRESS

@Beta(value=V4_81_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public static final CosmosGlobalSecondaryIndexBuildStatus DELETE_IN_PROGRESS

The global secondary index is being deleted.

Constructor Details

CosmosGlobalSecondaryIndexBuildStatus

@Beta(value=V4_81_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
@Deprecated
public CosmosGlobalSecondaryIndexBuildStatus()

Deprecated.

Use fromString(String) instead.

Creates a new instance of CosmosGlobalSecondaryIndexBuildStatus without a name.

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

Method Details

fromString

@Beta(value=V4_81_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
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

@Beta(value=V4_81_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public static Collection<CosmosGlobalSecondaryIndexBuildStatus> values()

Gets the known CosmosGlobalSecondaryIndexBuildStatus values declared on this class.

Returns:

the known CosmosGlobalSecondaryIndexBuildStatus values.