FleetspaceProperties Class

  • java.lang.Object
    • com.azure.resourcemanager.cosmos.fluent.models.FleetspaceProperties

Implements

public final class FleetspaceProperties
implements JsonSerializable<FleetspaceProperties>

Properties to update Azure Cosmos DB Fleetspace.

Constructor Summary

Constructor Description
FleetspaceProperties()

Creates an instance of FleetspaceProperties class.

Method Summary

Modifier and Type Method and Description
List<String> dataRegions()

Get the dataRegions property: List of data regions assigned to the fleetspace.

FleetspacePropertiesFleetspaceApiKind fleetspaceApiKind()

Get the fleetspaceApiKind property: The kind of API this fleetspace belongs to.

static FleetspaceProperties fromJson(JsonReader jsonReader)

Reads an instance of FleetspaceProperties from the JsonReader.

Status provisioningState()

Get the provisioningState property: A provisioning state of the Fleetspace.

FleetspacePropertiesServiceTier serviceTier()

Get the serviceTier property: Service Tier for the fleetspace.

FleetspacePropertiesThroughputPoolConfiguration throughputPoolConfiguration()

Get the throughputPoolConfiguration property: Configuration for throughput pool in the fleetspace.

JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.

FleetspaceProperties withDataRegions(List<String> dataRegions)

Set the dataRegions property: List of data regions assigned to the fleetspace.

FleetspaceProperties withFleetspaceApiKind(FleetspacePropertiesFleetspaceApiKind fleetspaceApiKind)

Set the fleetspaceApiKind property: The kind of API this fleetspace belongs to.

FleetspaceProperties withProvisioningState(Status provisioningState)

Set the provisioningState property: A provisioning state of the Fleetspace.

FleetspaceProperties withServiceTier(FleetspacePropertiesServiceTier serviceTier)

Set the serviceTier property: Service Tier for the fleetspace.

FleetspaceProperties withThroughputPoolConfiguration(FleetspacePropertiesThroughputPoolConfiguration throughputPoolConfiguration)

Set the throughputPoolConfiguration property: Configuration for throughput pool in the fleetspace.

Methods inherited from java.lang.Object

Constructor Details

FleetspaceProperties

public FleetspaceProperties()

Creates an instance of FleetspaceProperties class.

Method Details

dataRegions

public List<String> dataRegions()

Get the dataRegions property: List of data regions assigned to the fleetspace. Eg [westus2].

Returns:

the dataRegions value.

fleetspaceApiKind

public FleetspacePropertiesFleetspaceApiKind fleetspaceApiKind()

Get the fleetspaceApiKind property: The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL'.

Returns:

the fleetspaceApiKind value.

fromJson

public static FleetspaceProperties fromJson(JsonReader jsonReader)

Reads an instance of FleetspaceProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of FleetspaceProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the FleetspaceProperties.

provisioningState

public Status provisioningState()

Get the provisioningState property: A provisioning state of the Fleetspace.

Returns:

the provisioningState value.

serviceTier

public FleetspacePropertiesServiceTier serviceTier()

Get the serviceTier property: Service Tier for the fleetspace. GeneralPurpose types refers to single write region accounts that can be added to this fleetspace, whereas BusinessCritical refers to multi write region.

Returns:

the serviceTier value.

throughputPoolConfiguration

public FleetspacePropertiesThroughputPoolConfiguration throughputPoolConfiguration()

Get the throughputPoolConfiguration property: Configuration for throughput pool in the fleetspace.

Returns:

the throughputPoolConfiguration value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withDataRegions

public FleetspaceProperties withDataRegions(List<String> dataRegions)

Set the dataRegions property: List of data regions assigned to the fleetspace. Eg [westus2].

Parameters:

dataRegions - the dataRegions value to set.

Returns:

the FleetspaceProperties object itself.

withFleetspaceApiKind

public FleetspaceProperties withFleetspaceApiKind(FleetspacePropertiesFleetspaceApiKind fleetspaceApiKind)

Set the fleetspaceApiKind property: The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL'.

Parameters:

fleetspaceApiKind - the fleetspaceApiKind value to set.

Returns:

the FleetspaceProperties object itself.

withProvisioningState

public FleetspaceProperties withProvisioningState(Status provisioningState)

Set the provisioningState property: A provisioning state of the Fleetspace.

Parameters:

provisioningState - the provisioningState value to set.

Returns:

the FleetspaceProperties object itself.

withServiceTier

public FleetspaceProperties withServiceTier(FleetspacePropertiesServiceTier serviceTier)

Set the serviceTier property: Service Tier for the fleetspace. GeneralPurpose types refers to single write region accounts that can be added to this fleetspace, whereas BusinessCritical refers to multi write region.

Parameters:

serviceTier - the serviceTier value to set.

Returns:

the FleetspaceProperties object itself.

withThroughputPoolConfiguration

public FleetspaceProperties withThroughputPoolConfiguration(FleetspacePropertiesThroughputPoolConfiguration throughputPoolConfiguration)

Set the throughputPoolConfiguration property: Configuration for throughput pool in the fleetspace.

Parameters:

throughputPoolConfiguration - the throughputPoolConfiguration value to set.

Returns:

the FleetspaceProperties object itself.

Applies to