AnalyticsIndex
in package
Table of Contents
- $datasetName : string
- $dataverseName : string
- $isPrimary : bool
- $name : string
- __construct() : mixed
- build() : AnalyticsIndex
- Static helper to keep code more readable
- datasetName() : string
- Gets the name of the analytics dataset in which this index exists
- dataverseName() : string
- Gets the name of the dataverse in which this index exists.
- isPrimary() : bool
- Returns true if this index is a primary index.
- name() : string
- Gets the name of this index
Properties
$datasetName
private
string
$datasetName
$dataverseName
private
string
$dataverseName
$isPrimary
private
bool
$isPrimary
$name
private
string
$name
Methods
__construct()
public
__construct(string $name, string $datasetName, string $dataverseName, bool $isPrimary) : mixed
Parameters
- $name : string
- $datasetName : string
- $dataverseName : string
- $isPrimary : bool
Return values
mixed —build()
Static helper to keep code more readable
public
static build(string $name, string $datasetName, string $dataverseName, bool $isPrimary) : AnalyticsIndex
Parameters
- $name : string
- $datasetName : string
- $dataverseName : string
- $isPrimary : bool
Tags
Return values
AnalyticsIndex —datasetName()
Gets the name of the analytics dataset in which this index exists
public
datasetName() : string
Tags
Return values
string —dataverseName()
Gets the name of the dataverse in which this index exists.
public
dataverseName() : string
Tags
Return values
string —isPrimary()
Returns true if this index is a primary index.
public
isPrimary() : bool
Tags
Return values
bool —name()
Gets the name of this index
public
name() : string