PyContentLocation

class PyContentLocation(content_location)

Bases: object

Structure representing a logical location of a content item on a Tableau site. For example, for workbooks this represents the project path and the workbook name.

• Parameters: content_location (ContentLocation)

__init__(content_location)

Creates a new PyContentLocation object.

Args: : content_location: A ContentLocation object.

Returns: None.

• Parameters: content_location (ContentLocation)
• Return type: None

Methods

__init__(content_location)	Creates a new PyContentLocation object.
append(name)	Creates a new ContentLocation with a new path segment appended.
for_username(domain, username)	Creates a new ContentLocation value with the standard user/group name separator.
from_path(content_location_path, path_separator)	Creates a new ContentLocation value from a string.
parent()	Creates a new ContentLocation with the last path segment removed.
rename(new_name)	Creates a new ContentLocation with the last path segment replaced.

Attributes

is_empty	Gets whether this location reprents an empty path.
name	Gets the non-pathed name of the location.
path	Gets the full path of the location.
path_segments	Gets the individual segments of the location path.
path_separator	Gets the separator to use between segments in the location path.

append(name)

Creates a new ContentLocation with a new path segment appended.

Args: : name: The name to append to the path.

Returns: The new ContentLocation with the appended path.

• Parameters: name (str)
• Return type: Self

classmethod for_username(domain, username)

Creates a new ContentLocation value with the standard user/group name separator.

Args: : domain: The user/group domain. username: The user/group name.

Returns: The newly created ContentLocation.

• Parameters:
  • domain (str)
  • username (str)
• Return type: Self

classmethod from_path(content_location_path, path_separator)

Creates a new ContentLocation value from a string.

Args: : content_location_path: The full path of the location. path_separator: The separator to use between segments in the location path.

Returns: The newly created ContentLocation.

• Parameters:
  • content_location_path (str)
  • path_separator (str)
• Return type: Self

property is_empty : bool

Gets whether this location reprents an empty path.

property name : str

Gets the non-pathed name of the location.

parent()

Creates a new ContentLocation with the last path segment removed.

Returns: The new ContentLocation with the parent path.

• Return type: Self

property path : str

Gets the full path of the location.

property path_segments : Sequence[str]

Gets the individual segments of the location path.

property path_separator : str

Gets the separator to use between segments in the location path.

rename(new_name)

Creates a new ContentLocation with the last path segment replaced.

Args: : new_name: The new name to replace the last path segment with.

Returns: The renamed ContentLocation.

• Parameters: new_name (str)
• Return type: Self