GetAnalyticsLinksOptions
in package
Table of Contents
- $dataverseName : string|null
- $linkType : string|null
- $name : string|null
- $timeoutMilliseconds : int|null
- build() : GetAnalyticsLinksOptions
- Static helper to keep code more readable
- dataverseName() : GetAnalyticsLinksOptions
- Customizes the dataverse to restrict links to
- linkType() : GetAnalyticsLinksOptions
- The type of links to restrict returned links to.
- name() : GetAnalyticsLinksOptions
- Sets the name of the link to fetch. If set, then dataverse must also be set.
- timeout() : GetAnalyticsLinksOptions
- Sets the operation timeout in milliseconds.
Properties
$dataverseName
private
string|null
$dataverseName
= null
$linkType
private
string|null
$linkType
= null
$name
private
string|null
$name
= null
$timeoutMilliseconds
private
int|null
$timeoutMilliseconds
= null
Methods
build()
Static helper to keep code more readable
public
static build() : GetAnalyticsLinksOptions
Tags
Return values
GetAnalyticsLinksOptions —dataverseName()
Customizes the dataverse to restrict links to
public
dataverseName(string $dataverseName) : GetAnalyticsLinksOptions
Parameters
- $dataverseName : string
-
The name of the dataverse
Tags
Return values
GetAnalyticsLinksOptions —linkType()
The type of links to restrict returned links to.
public
linkType(string $type) : GetAnalyticsLinksOptions
Parameters
- $type : string
-
the link type, must be value one of 'couchbase', 's3', or 'azureblob'
Tags
Return values
GetAnalyticsLinksOptions —name()
Sets the name of the link to fetch. If set, then dataverse must also be set.
public
name(string $name) : GetAnalyticsLinksOptions
Parameters
- $name : string
-
The name of the link
Tags
Return values
GetAnalyticsLinksOptions —timeout()
Sets the operation timeout in milliseconds.
public
timeout(int $milliseconds) : GetAnalyticsLinksOptions
Parameters
- $milliseconds : int
-
the operation timeout to apply