Class PublishWorkbookOptions

Class for API client workbook publish options.

Inheritance
object
PublishContentWithFileOptions
PublishWorkbookOptions
Implements
Inherited Members
Namespace: Tableau.Migration.Api.Models
Assembly: Tableau.Migration.dll
Syntax
public class PublishWorkbookOptions : PublishContentWithFileOptions, IPublishWorkbookOptions, IPublishFileOptions

Constructors

PublishWorkbookOptions(IPublishableWorkbook, Stream, string)

Creates a new PublishWorkbookOptions instance.

Declaration
public PublishWorkbookOptions(IPublishableWorkbook workbook, Stream file, string fileType = "twbx")
Parameters
Type Name Description
IPublishableWorkbook workbook

The publishable workbook information.
Stream file

The workbook file as a Stream
string fileType

The type of workbook file.

Properties

Description

Gets the description of the workbook.

Declaration
public string Description { get; }
Property Value
Type Description
string

EncryptExtracts

Gets whether to encrypt extracts for the workbook.

Declaration
public bool EncryptExtracts { get; }
Property Value
Type Description
bool

HiddenViewNames

Gets the names of the views that should be hidden.

Declaration
public IEnumerable<string> HiddenViewNames { get; }
Property Value
Type Description
IEnumerable<string>

Name

Gets the name of the workbook.

Declaration
public string Name { get; }
Property Value
Type Description
string

Overwrite

Gets whether or not to overwrite any existing workbook.

Declaration
public bool Overwrite { get; }
Property Value
Type Description
bool

ProjectId

Gets the ID of the project to publish to.

Declaration
public Guid ProjectId { get; }
Property Value
Type Description
Guid

ShowTabs

Gets whether to show tabs for the workbook.

Declaration
public bool ShowTabs { get; }
Property Value
Type Description
bool

SkipConnectionCheck

Gets whether or not to skip the data source connection check.

Declaration
public bool SkipConnectionCheck { get; }
Property Value
Type Description
bool

ThumbnailsUserId

Gets the ID of the user to generate thumbnails as.

Declaration
public Guid? ThumbnailsUserId { get; }
Property Value
Type Description
Guid?

Implements