S3ExternalAnalyticsLink
extends AnalyticsLink
in package
Table of Contents
- $accessKeyID : string
- $dataverseName : string
- $name : string
- $region : string
- $secretAccessKey : string
- $serviceEndpoint : string|null
- $sessionToken : string|null
- __construct() : mixed
- build() : S3ExternalAnalyticsLink
- Static helper to keep code more readable
- dataverseName() : string
- Gets the name of the dataverse to which this link belongs to.
- linkType() : string
- Gets the link type. One of "couchbase", "s3" or "azureblob"
- name() : string
- Gets the name of the link
- setServiceEndpoint() : S3ExternalAnalyticsLink
- Sets AWS S3 service endpoint
- setSessionToken() : S3ExternalAnalyticsLink
- Sets the session token
Properties
$accessKeyID
private
string
$accessKeyID
$dataverseName
private
string
$dataverseName
$name
private
string
$name
$region
private
string
$region
$secretAccessKey
private
string
$secretAccessKey
$serviceEndpoint
private
string|null
$serviceEndpoint
= null
$sessionToken
private
string|null
$sessionToken
= null
Methods
__construct()
public
__construct(string $name, string $dataverseName, string $accessKeyID, string $region, string $secretAccessKey) : mixed
Parameters
- $name : string
- $dataverseName : string
- $accessKeyID : string
- $region : string
- $secretAccessKey : string
Return values
mixed —build()
Static helper to keep code more readable
public
static build(string $name, string $dataverseName, string $accessKeyID, string $region, string $secretAccessKey) : S3ExternalAnalyticsLink
Parameters
- $name : string
- $dataverseName : string
- $accessKeyID : string
- $region : string
- $secretAccessKey : string
Tags
Return values
S3ExternalAnalyticsLink —dataverseName()
Gets the name of the dataverse to which this link belongs to.
public
dataverseName() : string
Tags
Return values
string —linkType()
Gets the link type. One of "couchbase", "s3" or "azureblob"
public
linkType() : string
Tags
Return values
string —name()
Gets the name of the link
public
name() : string
Tags
Return values
string —setServiceEndpoint()
Sets AWS S3 service endpoint
public
setServiceEndpoint(string $serviceEndpoint) : S3ExternalAnalyticsLink
Parameters
- $serviceEndpoint : string
Tags
Return values
S3ExternalAnalyticsLink —setSessionToken()
Sets the session token
public
setSessionToken(string $sessionToken) : S3ExternalAnalyticsLink
Parameters
- $sessionToken : string