Struct TableauSiteConnectionConfiguration

Object that describes how to connect to a IApiClient.

Implements

IEquatable<TableauSiteConnectionConfiguration>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

Namespace: Tableau.Migration.Api

Assembly: Tableau.Migration.dll

Syntax

public readonly record struct TableauSiteConnectionConfiguration : IEquatable<TableauSiteConnectionConfiguration>

Constructors

TableauSiteConnectionConfiguration(Uri, string, string, string)

Object that describes how to connect to a IApiClient.

Declaration

public TableauSiteConnectionConfiguration(Uri ServerUrl, string SiteContentUrl, string AccessTokenName, string AccessToken)

Parameters

Type	Name	Description
Uri	ServerUrl	The base URL of the Tableau Server, or the Tableau Cloud URL to connect to.
string	SiteContentUrl	The content URL of the site to connect to. Can be empty string for default site.
string	AccessTokenName	The name of the personal access token to use to sign into the site.
string	AccessToken	The personal access token to use to sign into the site.

Fields

Empty

A TableauSiteConnectionConfiguration with empty values, useful to detect if a value has not yet been configured without using null.

Declaration

public static readonly TableauSiteConnectionConfiguration Empty

Field Value

Type	Description
TableauSiteConnectionConfiguration

Properties

AccessToken

The personal access token to use to sign into the site.

Declaration

[Required]
public string AccessToken { get; init; }

Property Value

Type	Description
string

AccessTokenName

The name of the personal access token to use to sign into the site.

Declaration

[Required]
public string AccessTokenName { get; init; }

Property Value

Type	Description
string

ServerUrl

The base URL of the Tableau Server, or the Tableau Cloud URL to connect to.

Declaration

public Uri ServerUrl { get; init; }

Property Value

Type	Description
Uri

SiteContentUrl

The content URL of the site to connect to. Can be empty string for default site.

Declaration

public string SiteContentUrl { get; init; }

Property Value

Type	Description
string

Methods

Validate()

Validates that the connection configuration has enough information to connect.

Declaration

public IResult Validate()

Returns

Type	Description
IResult	The validation result.

Implements

IEquatable<T>