|
const | DISCRIMINATOR = null |
|
◆ __construct()
InfluxDB2\Model\OnboardingRequest::__construct |
( |
array | $data = null | ) |
|
Constructor
- Parameters
-
mixed[] | $data | Associated array of property values initializing the model |
◆ __toString()
InfluxDB2\Model\OnboardingRequest::__toString |
( |
| ) |
|
Gets the string presentation of the object
- Returns
- string
◆ attributeMap()
static InfluxDB2\Model\OnboardingRequest::attributeMap |
( |
| ) |
|
|
static |
◆ getBucket()
InfluxDB2\Model\OnboardingRequest::getBucket |
( |
| ) |
|
Gets bucket
- Returns
- string
◆ getModelName()
InfluxDB2\Model\OnboardingRequest::getModelName |
( |
| ) |
|
◆ getOrg()
InfluxDB2\Model\OnboardingRequest::getOrg |
( |
| ) |
|
◆ getPassword()
InfluxDB2\Model\OnboardingRequest::getPassword |
( |
| ) |
|
Gets password
- Returns
- string|null
◆ getRetentionPeriodHrs()
InfluxDB2\Model\OnboardingRequest::getRetentionPeriodHrs |
( |
| ) |
|
Gets retention_period_hrs
- Returns
- int|null
◆ getRetentionPeriodSeconds()
InfluxDB2\Model\OnboardingRequest::getRetentionPeriodSeconds |
( |
| ) |
|
Gets retention_period_seconds
- Returns
- int|null
◆ getters()
static InfluxDB2\Model\OnboardingRequest::getters |
( |
| ) |
|
|
static |
◆ getToken()
InfluxDB2\Model\OnboardingRequest::getToken |
( |
| ) |
|
Gets token
- Returns
- string|null
◆ getUsername()
InfluxDB2\Model\OnboardingRequest::getUsername |
( |
| ) |
|
Gets username
- Returns
- string
◆ listInvalidProperties()
InfluxDB2\Model\OnboardingRequest::listInvalidProperties |
( |
| ) |
|
◆ offsetExists()
InfluxDB2\Model\OnboardingRequest::offsetExists |
( |
| $offset | ) |
|
Returns true if offset exists. False otherwise.
- Parameters
-
- Returns
- boolean
◆ offsetGet()
InfluxDB2\Model\OnboardingRequest::offsetGet |
( |
| $offset | ) |
|
Gets offset.
- Parameters
-
- Returns
- mixed
◆ offsetSet()
InfluxDB2\Model\OnboardingRequest::offsetSet |
( |
| $offset, |
|
|
| $value ) |
Sets value based on offset.
- Parameters
-
integer | $offset | Offset |
mixed | $value | Value to be set |
- Returns
- void
◆ offsetUnset()
InfluxDB2\Model\OnboardingRequest::offsetUnset |
( |
| $offset | ) |
|
Unsets offset.
- Parameters
-
- Returns
- void
◆ openAPIFormats()
static InfluxDB2\Model\OnboardingRequest::openAPIFormats |
( |
| ) |
|
|
static |
◆ openAPITypes()
static InfluxDB2\Model\OnboardingRequest::openAPITypes |
( |
| ) |
|
|
static |
◆ setBucket()
InfluxDB2\Model\OnboardingRequest::setBucket |
( |
| $bucket | ) |
|
Sets bucket
- Parameters
-
- Returns
- $this
◆ setOrg()
InfluxDB2\Model\OnboardingRequest::setOrg |
( |
| $org | ) |
|
Sets org
- Parameters
-
- Returns
- $this
◆ setPassword()
InfluxDB2\Model\OnboardingRequest::setPassword |
( |
| $password | ) |
|
Sets password
- Parameters
-
string | null | $password | password |
- Returns
- $this
◆ setRetentionPeriodHrs()
InfluxDB2\Model\OnboardingRequest::setRetentionPeriodHrs |
( |
| $retention_period_hrs | ) |
|
Sets retention_period_hrs
- Parameters
-
int | null | $retention_period_hrs | Retention period in nanoseconds for the new bucket. This key's name has been misleading since OSS 2.0 GA, please transition to use retentionPeriodSeconds |
- Returns
- $this
◆ setRetentionPeriodSeconds()
InfluxDB2\Model\OnboardingRequest::setRetentionPeriodSeconds |
( |
| $retention_period_seconds | ) |
|
Sets retention_period_seconds
- Parameters
-
int | null | $retention_period_seconds | retention_period_seconds |
- Returns
- $this
◆ setters()
static InfluxDB2\Model\OnboardingRequest::setters |
( |
| ) |
|
|
static |
◆ setToken()
InfluxDB2\Model\OnboardingRequest::setToken |
( |
| $token | ) |
|
Sets token
- Parameters
-
string | null | $token | Authentication token to set on the initial user. If not specified, the server will generate a token. |
- Returns
- $this
◆ setUsername()
InfluxDB2\Model\OnboardingRequest::setUsername |
( |
| $username | ) |
|
Sets username
- Parameters
-
- Returns
- $this
◆ valid()
InfluxDB2\Model\OnboardingRequest::valid |
( |
| ) |
|
Validate all the properties in the model return true if all passed
- Returns
- bool True if all properties are valid
Implements InfluxDB2\Model\ModelInterface.
◆ $attributeMap
InfluxDB2\Model\OnboardingRequest::$attributeMap |
|
staticprotected |
Initial value:= [
'username' => 'username',
'password' => 'password',
'org' => 'org',
'bucket' => 'bucket',
'retention_period_seconds' => 'retentionPeriodSeconds',
'retention_period_hrs' => 'retentionPeriodHrs',
'token' => 'token'
]
◆ $getters
InfluxDB2\Model\OnboardingRequest::$getters |
|
staticprotected |
Initial value:= [
'username' => 'getUsername',
'password' => 'getPassword',
'org' => 'getOrg',
'bucket' => 'getBucket',
'retention_period_seconds' => 'getRetentionPeriodSeconds',
'retention_period_hrs' => 'getRetentionPeriodHrs',
'token' => 'getToken'
]
◆ $openAPIFormats
InfluxDB2\Model\OnboardingRequest::$openAPIFormats |
|
staticprotected |
Initial value:= [
'username' => null,
'password' => null,
'org' => null,
'bucket' => null,
'retention_period_seconds' => 'int64',
'retention_period_hrs' => 'int32',
'token' => null
]
◆ $openAPITypes
InfluxDB2\Model\OnboardingRequest::$openAPITypes |
|
staticprotected |
Initial value:= [
'username' => 'string',
'password' => 'string',
'org' => 'string',
'bucket' => 'string',
'retention_period_seconds' => 'int',
'retention_period_hrs' => 'int',
'token' => 'string'
]
◆ $setters
InfluxDB2\Model\OnboardingRequest::$setters |
|
staticprotected |
Initial value:= [
'username' => 'setUsername',
'password' => 'setPassword',
'org' => 'setOrg',
'bucket' => 'setBucket',
'retention_period_seconds' => 'setRetentionPeriodSeconds',
'retention_period_hrs' => 'setRetentionPeriodHrs',
'token' => 'setToken'
]
The documentation for this class was generated from the following file:
- src/InfluxDB2/Model/OnboardingRequest.php