InfluxDB2\Model\OnboardingRequest Class Reference

Inheritance diagram for InfluxDB2\Model\OnboardingRequest:

Public Member Functions
	getModelName ()
	__construct (?array $data=null)
	listInvalidProperties ()
	valid ()
	getUsername ()
	setUsername ($username)
	getPassword ()
	setPassword ($password)
	getOrg ()
	setOrg ($org)
	getBucket ()
	setBucket ($bucket)
	getRetentionPeriodSeconds ()
	setRetentionPeriodSeconds ($retention_period_seconds)
	getRetentionPeriodHrs ()
	setRetentionPeriodHrs ($retention_period_hrs)
	getToken ()
	setToken ($token)
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	__toString ()

Static Public Member Functions
static	openAPITypes ()
static	openAPIFormats ()
static	attributeMap ()
static	setters ()
static	getters ()

Public Attributes
const	DISCRIMINATOR = null

Protected Attributes
	$container = []

Static Protected Attributes
static	$openAPIModelName = 'OnboardingRequest'
static	$openAPITypes
static	$openAPIFormats
static	$attributeMap
static	$setters
static	$getters

Constructor & Destructor Documentation

__construct()

InfluxDB2\Model\OnboardingRequest::__construct

(

?array

$data = null

)

Constructor

Parameters

mixed[]

$data

Associated array of property values initializing the model

Member Function Documentation

__toString()

InfluxDB2\Model\OnboardingRequest::__toString

(

)

Gets the string presentation of the object

Returns

string

attributeMap()

static InfluxDB2\Model\OnboardingRequest::attributeMap ( )

static

Array of attributes where the key is the local name, and the value is the original name

Returns

array

Implements InfluxDB2\Model\ModelInterface.

getBucket()

InfluxDB2\Model\OnboardingRequest::getBucket

(

)

Gets bucket

Returns

string

getModelName()

InfluxDB2\Model\OnboardingRequest::getModelName

(

)

The original name of the model.

Returns

string

Implements InfluxDB2\Model\ModelInterface.

getOrg()

InfluxDB2\Model\OnboardingRequest::getOrg

(

)

Gets org

Returns

string

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

Array of attributes to getter functions (for serialization of requests)

Returns

array

Implements InfluxDB2\Model\ModelInterface.

getToken()

InfluxDB2\Model\OnboardingRequest::getToken

(

)

Gets token

Returns

string|null

getUsername()

InfluxDB2\Model\OnboardingRequest::getUsername

(

)

Gets username

Returns

string

listInvalidProperties()

InfluxDB2\Model\OnboardingRequest::listInvalidProperties

(

)

Show all the invalid properties with reasons.

Returns

array invalid properties with reasons

Implements InfluxDB2\Model\ModelInterface.

offsetExists()

InfluxDB2\Model\OnboardingRequest::offsetExists

(

$offset

)

Returns true if offset exists. False otherwise.

Parameters

integer

$offset

Offset

Returns

boolean

offsetGet()

InfluxDB2\Model\OnboardingRequest::offsetGet

(

$offset

)

Gets offset.

Parameters

integer

$offset

Offset

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

integer

$offset

Offset

Returns

void

openAPIFormats()

static InfluxDB2\Model\OnboardingRequest::openAPIFormats ( )

static

Array of property to format mappings. Used for (de)serialization

Returns

array

Implements InfluxDB2\Model\ModelInterface.

openAPITypes()

static InfluxDB2\Model\OnboardingRequest::openAPITypes ( )

static

Array of property to type mappings. Used for (de)serialization

Returns

array

Implements InfluxDB2\Model\ModelInterface.

setBucket()

InfluxDB2\Model\OnboardingRequest::setBucket

(

$bucket

)

Sets bucket

Parameters

string

$bucket

bucket

Returns

$this

setOrg()

InfluxDB2\Model\OnboardingRequest::setOrg

(

$org

)

Sets org

Parameters

string

$org

org

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

Array of attributes to setter functions (for deserialization of responses)

Returns

array

Implements InfluxDB2\Model\ModelInterface.

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

string

$username

username

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.

Member Data Documentation

$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