InfluxDB PHP Client
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | Static Protected Attributes | List of all members
InfluxDB2\Model\TemplateApply Class Reference
Inheritance diagram for InfluxDB2\Model\TemplateApply:
InfluxDB2\Model\ModelInterface

Public Member Functions

 getModelName ()
 
 __construct (array $data=null)
 
 listInvalidProperties ()
 
 valid ()
 
 getDryRun ()
 
 setDryRun ($dry_run)
 
 getOrgId ()
 
 setOrgId ($org_id)
 
 getStackId ()
 
 setStackId ($stack_id)
 
 getTemplate ()
 
 setTemplate ($template)
 
 getTemplates ()
 
 setTemplates ($templates)
 
 getEnvRefs ()
 
 setEnvRefs ($env_refs)
 
 getSecrets ()
 
 setSecrets ($secrets)
 
 getRemotes ()
 
 setRemotes ($remotes)
 
 getActions ()
 
 setActions ($actions)
 
 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 = 'TemplateApply'
 
static $openAPITypes
 
static $openAPIFormats
 
static $attributeMap
 
static $setters
 
static $getters
 

Constructor & Destructor Documentation

◆ __construct()

InfluxDB2\Model\TemplateApply::__construct ( array $data = null)

Constructor

Parameters
mixed[]$dataAssociated array of property values initializing the model

Member Function Documentation

◆ __toString()

InfluxDB2\Model\TemplateApply::__toString ( )

Gets the string presentation of the object

Returns
string

◆ attributeMap()

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

◆ getActions()

InfluxDB2\Model\TemplateApply::getActions ( )

Gets actions

Returns
object[]|null

◆ getDryRun()

InfluxDB2\Model\TemplateApply::getDryRun ( )

Gets dry_run

Returns
bool|null

◆ getEnvRefs()

InfluxDB2\Model\TemplateApply::getEnvRefs ( )

Gets env_refs

Returns
map[string,object]|null

◆ getModelName()

InfluxDB2\Model\TemplateApply::getModelName ( )

The original name of the model.

Returns
string

Implements InfluxDB2\Model\ModelInterface.

◆ getOrgId()

InfluxDB2\Model\TemplateApply::getOrgId ( )

Gets org_id

Returns
string|null

◆ getRemotes()

InfluxDB2\Model\TemplateApply::getRemotes ( )

Gets remotes

Returns
\InfluxDB2\Model\TemplateApplyRemotes[]|null

◆ getSecrets()

InfluxDB2\Model\TemplateApply::getSecrets ( )

Gets secrets

Returns
map[string,string]|null

◆ getStackId()

InfluxDB2\Model\TemplateApply::getStackId ( )

Gets stack_id

Returns
string|null

◆ getTemplate()

InfluxDB2\Model\TemplateApply::getTemplate ( )

Gets template

Returns
\InfluxDB2\Model\TemplateApplyTemplate|null

◆ getTemplates()

InfluxDB2\Model\TemplateApply::getTemplates ( )

Gets templates

Returns
\InfluxDB2\Model\TemplateApplyTemplates[]|null

◆ getters()

static InfluxDB2\Model\TemplateApply::getters ( )
static

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

Returns
array

Implements InfluxDB2\Model\ModelInterface.

◆ listInvalidProperties()

InfluxDB2\Model\TemplateApply::listInvalidProperties ( )

Show all the invalid properties with reasons.

Returns
array invalid properties with reasons

Implements InfluxDB2\Model\ModelInterface.

◆ offsetExists()

InfluxDB2\Model\TemplateApply::offsetExists ( $offset)

Returns true if offset exists. False otherwise.

Parameters
integer$offsetOffset
Returns
boolean

◆ offsetGet()

InfluxDB2\Model\TemplateApply::offsetGet ( $offset)

Gets offset.

Parameters
integer$offsetOffset
Returns
mixed

◆ offsetSet()

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

Sets value based on offset.

Parameters
integer$offsetOffset
mixed$valueValue to be set
Returns
void

◆ offsetUnset()

InfluxDB2\Model\TemplateApply::offsetUnset ( $offset)

Unsets offset.

Parameters
integer$offsetOffset
Returns
void

◆ openAPIFormats()

static InfluxDB2\Model\TemplateApply::openAPIFormats ( )
static

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

Returns
array

Implements InfluxDB2\Model\ModelInterface.

◆ openAPITypes()

static InfluxDB2\Model\TemplateApply::openAPITypes ( )
static

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

Returns
array

Implements InfluxDB2\Model\ModelInterface.

◆ setActions()

InfluxDB2\Model\TemplateApply::setActions ( $actions)

Sets actions

Parameters
object[] | null$actionsA list of action objects. Actions let you customize how InfluxDB applies templates in the request. You can use the following actions to prevent creating or updating resources: - A skipKind action skips template resources of a specified kind. - A skipResource action skips template resources with a specified metadata.name and kind.
Returns
$this

◆ setDryRun()

InfluxDB2\Model\TemplateApply::setDryRun ( $dry_run)

Sets dry_run

Parameters
bool | null$dry_runOnly applies a dry run of the templates passed in the request. - Validates the template and generates a resource diff and summary. - Doesn't install templates or make changes to the InfluxDB instance.
Returns
$this

◆ setEnvRefs()

InfluxDB2\Model\TemplateApply::setEnvRefs ( $env_refs)

Sets env_refs

Parameters
map[string,object]|null$env_refs An object with key-value pairs that map to environment references in templates. Environment references in templates are envRef objects with an envRef.key property. To substitute a custom environment reference value when applying templates, pass envRefs with the envRef.key and the value. When you apply a template, InfluxDB replaces envRef objects in the template with the values that you provide in the envRefs parameter. For more examples, see how to define environment references. The following template fields may use environment references: - metadata.name - spec.endpointName - spec.associations.name For more information about including environment references in template fields, see how to include user-definable resource names.
Returns
$this

◆ setOrgId()

InfluxDB2\Model\TemplateApply::setOrgId ( $org_id)

Sets org_id

Parameters
string | null$org_idOrganization ID. InfluxDB applies templates to this organization. The organization owns all resources created by the template. To find your organization, see how to view organizations.
Returns
$this

◆ setRemotes()

InfluxDB2\Model\TemplateApply::setRemotes ( $remotes)

Sets remotes

Parameters
\InfluxDB2\Model\TemplateApplyRemotes[] | null$remotesA list of URLs for template files. To apply a template manifest file located at a URL, pass remotes with an array that contains the URL.
Returns
$this

◆ setSecrets()

InfluxDB2\Model\TemplateApply::setSecrets ( $secrets)

Sets secrets

Parameters
map[string,string]|null$secrets An object with key-value pairs that map to secrets in queries. Queries may reference secrets stored in InfluxDB–for example, the following Flux script retrieves POSTGRES_USERNAME and POSTGRES_PASSWORD secrets and then uses them to connect to a PostgreSQL database: js import "sql" import "influxdata/influxdb/secrets" username = secrets.get(key: "POSTGRES_USERNAME") password = secrets.get(key: "POSTGRES_PASSWORD") sql.from( driverName: "postgres", dataSourceName: "postgresql://${username}:${password}@localhost:5432", query: "SELECT * FROM example_table", ) To define secret values in your /api/v2/templates/apply request, pass the secrets parameter with key-value pairs–for example: json { ... "secrets": { "POSTGRES_USERNAME": "pguser", "POSTGRES_PASSWORD": "foo" } ... } InfluxDB stores the key-value pairs as secrets that you can access with secrets.get(). Once stored, you can't view secret values in InfluxDB. #### Related guides - How to pass secrets when installing a template
Returns
$this

◆ setStackId()

InfluxDB2\Model\TemplateApply::setStackId ( $stack_id)

Sets stack_id

Parameters
string | null$stack_idID of the stack to update. To apply templates to an existing stack in the organization, use the stackID parameter. If you apply templates without providing a stack ID, InfluxDB initializes a new stack with all new resources. To find a stack ID, use the InfluxDB `/api/v2/stacks` API endpoint to list stacks. #### Related guides - Stacks - View stacks
Returns
$this

◆ setTemplate()

InfluxDB2\Model\TemplateApply::setTemplate ( $template)

Sets template

Parameters
\InfluxDB2\Model\TemplateApplyTemplate | null$templatetemplate
Returns
$this

◆ setTemplates()

InfluxDB2\Model\TemplateApply::setTemplates ( $templates)

Sets templates

Parameters
\InfluxDB2\Model\TemplateApplyTemplates[] | null$templatesA list of template objects to apply. A template object has a contents property with an array of InfluxDB resource configurations. Use the templates parameter to apply multiple template objects. If you use templates, you can't use the template parameter.
Returns
$this

◆ setters()

static InfluxDB2\Model\TemplateApply::setters ( )
static

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

Returns
array

Implements InfluxDB2\Model\ModelInterface.

◆ valid()

InfluxDB2\Model\TemplateApply::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\TemplateApply::$attributeMap
staticprotected
Initial value:
= [
'dry_run' => 'dryRun',
'org_id' => 'orgID',
'stack_id' => 'stackID',
'template' => 'template',
'templates' => 'templates',
'env_refs' => 'envRefs',
'secrets' => 'secrets',
'remotes' => 'remotes',
'actions' => 'actions'
]

◆ $getters

InfluxDB2\Model\TemplateApply::$getters
staticprotected
Initial value:
= [
'dry_run' => 'getDryRun',
'org_id' => 'getOrgId',
'stack_id' => 'getStackId',
'template' => 'getTemplate',
'templates' => 'getTemplates',
'env_refs' => 'getEnvRefs',
'secrets' => 'getSecrets',
'remotes' => 'getRemotes',
'actions' => 'getActions'
]

◆ $openAPIFormats

InfluxDB2\Model\TemplateApply::$openAPIFormats
staticprotected
Initial value:
= [
'dry_run' => null,
'org_id' => null,
'stack_id' => null,
'template' => null,
'templates' => null,
'env_refs' => null,
'secrets' => null,
'remotes' => null,
'actions' => null
]

◆ $openAPITypes

InfluxDB2\Model\TemplateApply::$openAPITypes
staticprotected
Initial value:
= [
'dry_run' => 'bool',
'org_id' => 'string',
'stack_id' => 'string',
'template' => '\InfluxDB2\Model\TemplateApplyTemplate',
'templates' => '\InfluxDB2\Model\TemplateApplyTemplates[]',
'env_refs' => 'map[string,object]',
'secrets' => 'map[string,string]',
'remotes' => '\InfluxDB2\Model\TemplateApplyRemotes[]',
'actions' => 'object[]'
]

◆ $setters

InfluxDB2\Model\TemplateApply::$setters
staticprotected
Initial value:
= [
'dry_run' => 'setDryRun',
'org_id' => 'setOrgId',
'stack_id' => 'setStackId',
'template' => 'setTemplate',
'templates' => 'setTemplates',
'env_refs' => 'setEnvRefs',
'secrets' => 'setSecrets',
'remotes' => 'setRemotes',
'actions' => 'setActions'
]
The documentation for this class was generated from the following file:
Generated by doxygen 1.10.0