Table of Contents

Class ElasticsearchUpdateException

Namespace
Excalibur.Data.ElasticSearch.Exceptions
Assembly
Excalibur.Data.ElasticSearch.dll

Represents an exception that is thrown when an Elasticsearch update operation fails.

public sealed class ElasticsearchUpdateException : ApiException, ISerializable
Inheritance
ElasticsearchUpdateException
Implements
Inherited Members

Remarks

This exception provides detailed information about the failed update operation, including the document ID, document type, and API call details.

Constructors

ElasticsearchUpdateException()

Initializes a new instance of the ApiException class with a default error message.

public ElasticsearchUpdateException()

ElasticsearchUpdateException(int, string?, Exception?)

Initializes a new instance of the ApiException class with a specified status code, error message, and inner exception.

public ElasticsearchUpdateException(int statusCode, string? message, Exception? innerException)

Parameters

statusCode int

The HTTP status code associated with the exception.

message string

The error message describing the exception. If null, a default message is used.

innerException Exception

The exception that caused the current exception.

Exceptions

ArgumentOutOfRangeException

Thrown if the statusCode is outside the valid range (100-599).

ElasticsearchUpdateException(string)

Initializes a new instance of the ApiException class with a specified error message.

public ElasticsearchUpdateException(string message)

Parameters

message string

The error message describing the exception.

ElasticsearchUpdateException(string, Exception?)

Initializes a new instance of the ApiException class with a specified error message and an inner exception that caused this exception.

public ElasticsearchUpdateException(string message, Exception? innerException)

Parameters

message string

The error message describing the exception.

innerException Exception

The exception that caused the current exception.

ElasticsearchUpdateException(string, Type?, string, Exception?)

Initializes a new instance of the ElasticsearchUpdateException class with the specified details.

public ElasticsearchUpdateException(string documentId, Type? documentType, string apiCallDetails, Exception? innerException = null)

Parameters

documentId string

The ID of the document that failed to update.

documentType Type

The type of the document involved in the update operation.

apiCallDetails string

Details about the API call that failed.

innerException Exception

The inner exception that caused this exception, if any.

Exceptions

ArgumentException

Thrown if documentId or apiCallDetails is null, empty, or whitespace.

ArgumentNullException

Thrown if documentType is null.

Properties

ApiCallDetails

Gets details about the API call that failed.

public string ApiCallDetails { get; }

Property Value

string

Details about the API call that failed.

DocumentId

Gets the ID of the document that failed to update.

public string DocumentId { get; }

Property Value

string

The ID of the document that failed to update.

DocumentType

Gets the type of the document that failed to update.

public Type? DocumentType { get; }

Property Value

Type

The type of the document that failed to update.