InfluxDB2\Model\ScraperTargetRequest Class Reference

Inheritance diagram for InfluxDB2\Model\ScraperTargetRequest:

Public Member Functions
	getModelName ()
	getTypeAllowableValues ()
	__construct (array $data=null)
	listInvalidProperties ()
	valid ()
	getName ()
	setName ($name)
	getType ()
	setType ($type)
	getUrl ()
	setUrl ($url)
	getOrgId ()
	setOrgId ($org_id)
	getBucketId ()
	setBucketId ($bucket_id)
	getAllowInsecure ()
	setAllowInsecure ($allow_insecure)
	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
const	TYPE_PROMETHEUS = 'prometheus'

Protected Attributes
	$container = []

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

Constructor & Destructor Documentation

__construct()

InfluxDB2\Model\ScraperTargetRequest::__construct

(

array

$data = null

)

Constructor

Parameters

mixed[]

$data

Associated array of property values initializing the model

Reimplemented in InfluxDB2\Model\ScraperTargetResponse.

Member Function Documentation

__toString()

InfluxDB2\Model\ScraperTargetRequest::__toString

(

)

Gets the string presentation of the object

Returns

string

Reimplemented in InfluxDB2\Model\ScraperTargetResponse.

attributeMap()

static InfluxDB2\Model\ScraperTargetRequest::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.

Reimplemented in InfluxDB2\Model\ScraperTargetResponse.

getAllowInsecure()

InfluxDB2\Model\ScraperTargetRequest::getAllowInsecure

(

)

Gets allow_insecure

Returns

bool|null

getBucketId()

InfluxDB2\Model\ScraperTargetRequest::getBucketId

(

)

Gets bucket_id

Returns

string|null

getModelName()

InfluxDB2\Model\ScraperTargetRequest::getModelName

(

)

The original name of the model.

Returns

string

Implements InfluxDB2\Model\ModelInterface.

Reimplemented in InfluxDB2\Model\ScraperTargetResponse.

getName()

InfluxDB2\Model\ScraperTargetRequest::getName

(

)

Gets name

Returns

string|null

getOrgId()

InfluxDB2\Model\ScraperTargetRequest::getOrgId

(

)

Gets org_id

Returns

string|null

getters()

static InfluxDB2\Model\ScraperTargetRequest::getters ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

Reimplemented in InfluxDB2\Model\ScraperTargetResponse.

getType()

InfluxDB2\Model\ScraperTargetRequest::getType

(

)

Gets type

Returns

string|null

getTypeAllowableValues()

InfluxDB2\Model\ScraperTargetRequest::getTypeAllowableValues

(

)

Gets allowable values of the enum

Returns

string[]

getUrl()

InfluxDB2\Model\ScraperTargetRequest::getUrl

(

)

Gets url

Returns

string|null

listInvalidProperties()

InfluxDB2\Model\ScraperTargetRequest::listInvalidProperties

(

)

Show all the invalid properties with reasons.

Returns

array invalid properties with reasons

Implements InfluxDB2\Model\ModelInterface.

Reimplemented in InfluxDB2\Model\ScraperTargetResponse.

offsetExists()

InfluxDB2\Model\ScraperTargetRequest::offsetExists

(

$offset

)

Returns true if offset exists. False otherwise.

Parameters

integer

$offset

Offset

Returns

boolean

Reimplemented in InfluxDB2\Model\ScraperTargetResponse.

offsetGet()

InfluxDB2\Model\ScraperTargetRequest::offsetGet

(

$offset

)

Gets offset.

Parameters

integer

$offset

Offset

Returns

mixed

Reimplemented in InfluxDB2\Model\ScraperTargetResponse.

offsetSet()

InfluxDB2\Model\ScraperTargetRequest::offsetSet	(		$offset,
			$value )

Sets value based on offset.

Parameters

integer	$offset	Offset
mixed	$value	Value to be set

Returns

void

Reimplemented in InfluxDB2\Model\ScraperTargetResponse.

offsetUnset()

InfluxDB2\Model\ScraperTargetRequest::offsetUnset

(

$offset

)

Unsets offset.

Parameters

integer

$offset

Offset

Returns

void

Reimplemented in InfluxDB2\Model\ScraperTargetResponse.

openAPIFormats()

static InfluxDB2\Model\ScraperTargetRequest::openAPIFormats ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

Reimplemented in InfluxDB2\Model\ScraperTargetResponse.

openAPITypes()

static InfluxDB2\Model\ScraperTargetRequest::openAPITypes ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

Reimplemented in InfluxDB2\Model\ScraperTargetResponse.

setAllowInsecure()

InfluxDB2\Model\ScraperTargetRequest::setAllowInsecure

(

$allow_insecure

)

Sets allow_insecure

Parameters

bool | null

$allow_insecure

Skip TLS verification on endpoint.

Returns

$this

setBucketId()

InfluxDB2\Model\ScraperTargetRequest::setBucketId

(

$bucket_id

)

Sets bucket_id

Parameters

string | null

$bucket_id

The ID of the bucket to write to.

Returns

$this

setName()

InfluxDB2\Model\ScraperTargetRequest::setName

(

$name

)

Sets name

Parameters

string | null

$name

The name of the scraper target.

Returns

$this

setOrgId()

InfluxDB2\Model\ScraperTargetRequest::setOrgId

(

$org_id

)

Sets org_id

Parameters

string | null

$org_id

The organization ID.

Returns

$this

setters()

static InfluxDB2\Model\ScraperTargetRequest::setters ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

Reimplemented in InfluxDB2\Model\ScraperTargetResponse.

setType()

InfluxDB2\Model\ScraperTargetRequest::setType

(

$type

)

Sets type

Parameters

string | null

$type

The type of the metrics to be parsed.

Returns

$this

setUrl()

InfluxDB2\Model\ScraperTargetRequest::setUrl

(

$url

)

Sets url

Parameters

string | null

$url

The URL of the metrics endpoint.

Returns

$this

valid()

InfluxDB2\Model\ScraperTargetRequest::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.

Reimplemented in InfluxDB2\Model\ScraperTargetResponse.

Member Data Documentation

$attributeMap

InfluxDB2\Model\ScraperTargetRequest::$attributeMap

staticprotected

Initial value:

= [
        'name' => 'name',
        'type' => 'type',
        'url' => 'url',
        'org_id' => 'orgID',
        'bucket_id' => 'bucketID',
        'allow_insecure' => 'allowInsecure'
    ]

$getters

InfluxDB2\Model\ScraperTargetRequest::$getters

staticprotected

Initial value:

= [
        'name' => 'getName',
        'type' => 'getType',
        'url' => 'getUrl',
        'org_id' => 'getOrgId',
        'bucket_id' => 'getBucketId',
        'allow_insecure' => 'getAllowInsecure'
    ]

$openAPIFormats

InfluxDB2\Model\ScraperTargetRequest::$openAPIFormats

staticprotected

Initial value:

= [
        'name' => null,
        'type' => null,
        'url' => null,
        'org_id' => null,
        'bucket_id' => null,
        'allow_insecure' => null
    ]

$openAPITypes

InfluxDB2\Model\ScraperTargetRequest::$openAPITypes

staticprotected

Initial value:

= [
        'name' => 'string',
        'type' => 'string',
        'url' => 'string',
        'org_id' => 'string',
        'bucket_id' => 'string',
        'allow_insecure' => 'bool'
    ]

$setters

InfluxDB2\Model\ScraperTargetRequest::$setters

staticprotected

Initial value:

= [
        'name' => 'setName',
        'type' => 'setType',
        'url' => 'setUrl',
        'org_id' => 'setOrgId',
        'bucket_id' => 'setBucketId',
        'allow_insecure' => 'setAllowInsecure'
    ]

---

The documentation for this class was generated from the following file:

• src/InfluxDB2/Model/ScraperTargetRequest.php