Class RestException

Class representing an error from a Tableau REST API

Inheritance
object
Exception
RestException
Implements
Inherited Members
Namespace: Tableau.Migration.Api.Rest
Assembly: Tableau.Migration.dll
Syntax
public class RestException : Exception, ISerializable, IEquatable<RestException>

Constructors

RestException(HttpMethod?, Uri?, string?, Error, ISharedResourcesLocalizer)

Creates a new RestException instance.

Declaration
public RestException(HttpMethod? httpMethod, Uri? requestUri, string? correlationId, Error error, ISharedResourcesLocalizer sharedResourcesLocalizer)
Parameters
Type Name Description
HttpMethod httpMethod

The http method that generated the current error.
Uri requestUri

The request URI that generated the current error.
string correlationId

The request Correlation ID
Error error

The Error returned from the Tableau API.
ISharedResourcesLocalizer sharedResourcesLocalizer

A string localizer.

Fields

Code

Gets the error code from Tableau API.

Declaration
public readonly string? Code
Field Value
Type Description
string

CorrelationId

Gets the request Correlation ID

Declaration
public readonly string? CorrelationId
Field Value
Type Description
string

Detail

Gets the error detail from Tableau API.

Declaration
public readonly string? Detail
Field Value
Type Description
string

HttpMethod

Gets the request URI from Tableau API.

Declaration
public readonly HttpMethod? HttpMethod
Field Value
Type Description
HttpMethod

RequestUri

Gets the request URI from Tableau API.

Declaration
public readonly Uri? RequestUri
Field Value
Type Description
Uri

Summary

Gets the error summary from Tableau API.

Declaration
public readonly string? Summary
Field Value
Type Description
string

Methods

Equals(object?)

Determines whether the specified object is equal to the current object.

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
object obj

The object to compare with the current object.
Returns
Type Description
bool

true if the specified object is equal to the current object; otherwise, false.
Overrides

Equals(RestException?)

Indicates whether the current object is equal to another object of the same type.

Declaration
public bool Equals(RestException? other)
Parameters
Type Name Description
RestException other

An object to compare with this object.
Returns
Type Description
bool

true if the current object is equal to the other parameter; otherwise, false.

GetHashCode()

Serves as the default hash function.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code for the current object.
Overrides

Implements