CosmosEndToEndOperationLatencyPolicyConfigBuilder Class

Package:
com.azure.cosmos
Maven Artifact:
com.azure:azure-cosmos:4.80.0
  • java.lang.Object
    • com.azure.cosmos.CosmosEndToEndOperationLatencyPolicyConfigBuilder

public class CosmosEndToEndOperationLatencyPolicyConfigBuilder

Builder for CosmosEndToEndOperationLatencyPolicyConfig

Constructor Summary

Constructor Description
CosmosEndToEndOperationLatencyPolicyConfigBuilder(Duration endToEndOperationTimeout)

Create a builder for CosmosEndToEndOperationLatencyPolicyConfig with end to end operation timeout

Method Summary

Modifier and Type Method and Description
CosmosEndToEndOperationLatencyPolicyConfigBuilder availabilityStrategy(AvailabilityStrategy availabilityStrategy)

Sets the availability strategy to be used for the policy.
CosmosEndToEndOperationLatencyPolicyConfig build()

Builds CosmosEndToEndOperationLatencyPolicyConfig with specified properties
CosmosEndToEndOperationLatencyPolicyConfigBuilder enable(boolean isEnabled)

Enables or disables the policy.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CosmosEndToEndOperationLatencyPolicyConfigBuilder

public CosmosEndToEndOperationLatencyPolicyConfigBuilder(Duration endToEndOperationTimeout)

Create a builder for CosmosEndToEndOperationLatencyPolicyConfig with end to end operation timeout

Parameters:

endToEndOperationTimeout - the timeout for request cancellation in Duration. Setting very low timeouts can cause the request to never succeed.

Method Details

availabilityStrategy

public CosmosEndToEndOperationLatencyPolicyConfigBuilder availabilityStrategy(AvailabilityStrategy availabilityStrategy)

Sets the availability strategy to be used for the policy.

Parameters:

availabilityStrategy - the availability strategy to be used for the policy

Returns:

current CosmosEndToEndOperationConfigBuilder

build

public CosmosEndToEndOperationLatencyPolicyConfig build()

Builds CosmosEndToEndOperationLatencyPolicyConfig with specified properties

Returns:

enable

public CosmosEndToEndOperationLatencyPolicyConfigBuilder enable(boolean isEnabled)

Enables or disables the policy. It defaults to enable. OperationCancelledException

Parameters:

isEnabled - flag to enable or disable the policy

Returns:

current CosmosEndToEndOperationConfigBuilder

Applies to