domain

package
v2.14.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 12, 2024 License: MIT Imports: 12 Imported by: 61

README

Generated types and API client

oss.ymlmust be periodically synced with latest changes and types and client must be re-generated to maintain full compatibility with the latest InfluxDB release

Install oapi generator

git clone git@github.com:bonitoo-io/oapi-codegen.git cd oapi-codegen git checkout feat/template_helpers go install ./cmd/oapi-codegen/oapi-codegen.go

Download latest swagger

wget https://raw.githubusercontent.com/influxdata/openapi/master/contracts/oss.yml cd domain

Generate

Generate types

oapi-codegen -generate types -exclude-tags Checks -o types.gen.go -package domain -templates .\templates oss.yml

Generate client

oapi-codegen -generate client -exclude-tags Checks -o client.gen.go -package domain -templates .\templates oss.yml

Documentation

Overview

Package domain provides primitives to interact with the openapi HTTP API.

Code generated by version DO NOT EDIT.

Package domain provides primitives to interact with the openapi HTTP API.

Code generated by version DO NOT EDIT.

Package domain provides primitives to interact with the openapi HTTP API.

Code generated by version DO NOT EDIT.

Package domain provides primitives to interact with the openapi HTTP API.

Code generated by version DO NOT EDIT.

Index

Constants

View Source 
const (
	BasicAuthenticationScopes = "BasicAuthentication.Scopes"
	TokenAuthenticationScopes = "TokenAuthentication.Scopes"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ASTResponse 

type ASTResponse struct {
	// Represents a complete package source tree.
	Ast *Package `json:"ast,omitempty"`
}

Contains the AST for the supplied Flux query

type AddResourceMemberRequestBody 

type AddResourceMemberRequestBody struct {
	// The ID of the user to add to the resource.
	Id string `json:"id"`

	// The name of the user to add to the resource.
	Name *string `json:"name,omitempty"`
}

AddResourceMemberRequestBody defines model for AddResourceMemberRequestBody.

type After added in v2.1.0 

type After string

After defines model for After.

type AnalyzeQueryResponse 

type AnalyzeQueryResponse struct {
	Errors *[]struct {
		Character *int    `json:"character,omitempty"`
		Column    *int    `json:"column,omitempty"`
		Line      *int    `json:"line,omitempty"`
		Message   *string `json:"message,omitempty"`
	} `json:"errors,omitempty"`
}

AnalyzeQueryResponse defines model for AnalyzeQueryResponse.

type ArrayExpression 

type ArrayExpression struct {
	// Elements of the array
	Elements *[]Expression `json:"elements,omitempty"`

	// Type of AST node
	Type *NodeType `json:"type,omitempty"`
}

Used to create and directly specify the elements of an array object

type Authorization 

type Authorization struct {
	// Embedded struct due to allOf(#/components/schemas/AuthorizationUpdateRequest)
	AuthorizationUpdateRequest `yaml:",inline"`
	// Embedded fields due to inline allOf schema
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	Id        *string    `json:"id,omitempty"`
	Links     *struct {
		// URI of resource.
		Self *Link `json:"self,omitempty"`

		// URI of resource.
		User *Link `json:"user,omitempty"`
	} `json:"links,omitempty"`

	// The name of the organization that the token is scoped to.
	Org *string `json:"org,omitempty"`

	// The ID of the organization.
	OrgID *string `json:"orgID,omitempty"`

	// A list of permissions for an authorization.
	// An authorization must have at least one permission.
	Permissions *[]Permission `json:"permissions,omitempty"`

	// The API token for authenticating InfluxDB API and CLI requests.
	Token     *string    `json:"token,omitempty"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`

	// The name of the user that created and owns the token.
	User *string `json:"user,omitempty"`

	// The ID of the user that created and owns the token.
	UserID *string `json:"userID,omitempty"`
}

Authorization defines model for Authorization.

type AuthorizationError added in v2.11.0 

type AuthorizationError struct {
	// The HTTP status code description. Default is `unauthorized`.
	Code *AuthorizationErrorCode `json:"code,omitempty"`

	// A human-readable message that may contain detail about the error.
	Message *string `json:"message,omitempty"`
}

AuthorizationError defines model for AuthorizationError.

type AuthorizationErrorCode added in v2.11.0 

type AuthorizationErrorCode string

The HTTP status code description. Default is `unauthorized`. 

const (
	AuthorizationErrorCodeUnauthorized AuthorizationErrorCode = "unauthorized"
)

Defines values for AuthorizationErrorCode.

type AuthorizationPostRequest added in v2.5.0 

type AuthorizationPostRequest struct {
	// Embedded struct due to allOf(#/components/schemas/AuthorizationUpdateRequest)
	AuthorizationUpdateRequest `yaml:",inline"`
	// Embedded fields due to inline allOf schema
	// The ID of the organization that owns the authorization.
	OrgID *string `json:"orgID,omitempty"`

	// A list of permissions for an authorization.
	// An authorization must have at least one permission.
	Permissions *[]Permission `json:"permissions,omitempty"`

	// The ID of the user that the authorization is scoped to.
	UserID *string `json:"userID,omitempty"`
}

AuthorizationPostRequest defines model for AuthorizationPostRequest.

type AuthorizationUpdateRequest 

type AuthorizationUpdateRequest struct {
	// A description of the token.
	Description *string `json:"description,omitempty"`

	// Status of the token. If `inactive`, requests using the token will be rejected.
	Status *AuthorizationUpdateRequestStatus `json:"status,omitempty"`
}

AuthorizationUpdateRequest defines model for AuthorizationUpdateRequest.

type AuthorizationUpdateRequestStatus 

type AuthorizationUpdateRequestStatus string

Status of the token. If `inactive`, requests using the token will be rejected. 

const (
	AuthorizationUpdateRequestStatusActive AuthorizationUpdateRequestStatus = "active"

	AuthorizationUpdateRequestStatusInactive AuthorizationUpdateRequestStatus = "inactive"
)

Defines values for AuthorizationUpdateRequestStatus.

type Authorizations 

type Authorizations struct {
	Authorizations *[]Authorization `json:"authorizations,omitempty"`

	// URI pointers for additional paged results.
	Links *Links `json:"links,omitempty"`
}

Authorizations defines model for Authorizations.

type Axes 

type Axes struct {
	// Axis used in a visualization.
	X Axis `json:"x"`

	// Axis used in a visualization.
	Y Axis `json:"y"`
}

The viewport for a View's visualizations

type Axis 

type Axis struct {
	// Radix for formatting axis values.
	Base *AxisBase `json:"base,omitempty"`

	// The extents of the axis in the form [lower, upper]. Clients determine whether bounds are inclusive or exclusive of their limits.
	Bounds *[]string `json:"bounds,omitempty"`

	// Description of the axis.
	Label *string `json:"label,omitempty"`

	// Label prefix for formatting axis values.
	Prefix *string `json:"prefix,omitempty"`

	// Scale is the axis formatting scale. Supported: "log", "linear"
	Scale *AxisScale `json:"scale,omitempty"`

	// Label suffix for formatting axis values.
	Suffix *string `json:"suffix,omitempty"`
}

Axis used in a visualization.

type AxisBase 

type AxisBase string

Radix for formatting axis values. 

const (
	AxisBaseEmpty AxisBase = ""

	AxisBaseN10 AxisBase = "10"

	AxisBaseN2 AxisBase = "2"
)

Defines values for AxisBase.

type AxisScale 

type AxisScale string

Scale is the axis formatting scale. Supported: "log", "linear" 

const (
	AxisScaleLinear AxisScale = "linear"

	AxisScaleLog AxisScale = "log"
)

Defines values for AxisScale.

type BadRequestError added in v2.11.0 

type BadRequestError Error

BadRequestError defines model for BadRequestError.

type BadStatement 

type BadStatement struct {
	// Raw source text
	Text *string `json:"text,omitempty"`

	// Type of AST node
	Type *NodeType `json:"type,omitempty"`
}

A placeholder for statements for which no correct statement nodes can be created

type BandViewProperties added in v2.1.0 

type BandViewProperties struct {
	AdaptiveZoomHide *bool `json:"adaptiveZoomHide,omitempty"`

	// The viewport for a View's visualizations
	Axes Axes `json:"axes"`

	// Colors define color encoding of data into a visualization
	Colors                     []DashboardColor                  `json:"colors"`
	GenerateXAxisTicks         *[]string                         `json:"generateXAxisTicks,omitempty"`
	GenerateYAxisTicks         *[]string                         `json:"generateYAxisTicks,omitempty"`
	Geom                       XYGeom                            `json:"geom"`
	HoverDimension             *BandViewPropertiesHoverDimension `json:"hoverDimension,omitempty"`
	LegendColorizeRows         *bool                             `json:"legendColorizeRows,omitempty"`
	LegendHide                 *bool                             `json:"legendHide,omitempty"`
	LegendOpacity              *float32                          `json:"legendOpacity,omitempty"`
	LegendOrientationThreshold *int                              `json:"legendOrientationThreshold,omitempty"`
	LowerColumn                *string                           `json:"lowerColumn,omitempty"`
	MainColumn                 *string                           `json:"mainColumn,omitempty"`
	Note                       string                            `json:"note"`
	Queries                    []DashboardQuery                  `json:"queries"`
	Shape                      BandViewPropertiesShape           `json:"shape"`

	// If true, will display note when empty
	ShowNoteWhenEmpty bool `json:"showNoteWhenEmpty"`

	// StaticLegend represents the options specific to the static legend
	StaticLegend *StaticLegend          `json:"staticLegend,omitempty"`
	TimeFormat   *string                `json:"timeFormat,omitempty"`
	Type         BandViewPropertiesType `json:"type"`
	UpperColumn  *string                `json:"upperColumn,omitempty"`
	XColumn      *string                `json:"xColumn,omitempty"`
	XTickStart   *float32               `json:"xTickStart,omitempty"`
	XTickStep    *float32               `json:"xTickStep,omitempty"`
	XTotalTicks  *int                   `json:"xTotalTicks,omitempty"`
	YColumn      *string                `json:"yColumn,omitempty"`
	YTickStart   *float32               `json:"yTickStart,omitempty"`
	YTickStep    *float32               `json:"yTickStep,omitempty"`
	YTotalTicks  *int                   `json:"yTotalTicks,omitempty"`
}

BandViewProperties defines model for BandViewProperties.

type BandViewPropertiesHoverDimension added in v2.1.0 

type BandViewPropertiesHoverDimension string

BandViewPropertiesHoverDimension defines model for BandViewProperties.HoverDimension. 

const (
	BandViewPropertiesHoverDimensionAuto BandViewPropertiesHoverDimension = "auto"

	BandViewPropertiesHoverDimensionX BandViewPropertiesHoverDimension = "x"

	BandViewPropertiesHoverDimensionXy BandViewPropertiesHoverDimension = "xy"

	BandViewPropertiesHoverDimensionY BandViewPropertiesHoverDimension = "y"
)

Defines values for BandViewPropertiesHoverDimension.

type BandViewPropertiesShape added in v2.1.0 

type BandViewPropertiesShape string

BandViewPropertiesShape defines model for BandViewProperties.Shape. 

const (
	BandViewPropertiesShapeChronografV2 BandViewPropertiesShape = "chronograf-v2"
)

Defines values for BandViewPropertiesShape.

type BandViewPropertiesType added in v2.1.0 

type BandViewPropertiesType string

BandViewPropertiesType defines model for BandViewProperties.Type. 

const (
	BandViewPropertiesTypeBand BandViewPropertiesType = "band"
)

Defines values for BandViewPropertiesType.

type BinaryExpression 

type BinaryExpression struct {
	Left     *Expression `json:"left,omitempty"`
	Operator *string     `json:"operator,omitempty"`
	Right    *Expression `json:"right,omitempty"`

	// Type of AST node
	Type *NodeType `json:"type,omitempty"`
}

uses binary operators to act on two operands in an expression

type Block 

type Block struct {
	// Block body
	Body *[]Statement `json:"body,omitempty"`

	// Type of AST node
	Type *NodeType `json:"type,omitempty"`
}

A set of statements

type BooleanLiteral 

type BooleanLiteral struct {
	// Type of AST node
	Type  *NodeType `json:"type,omitempty"`
	Value *bool     `json:"value,omitempty"`
}

Represents boolean values

type Bucket 

type Bucket struct {
	CreatedAt   *time.Time `json:"createdAt,omitempty"`
	Description *string    `json:"description,omitempty"`
	Id          *string    `json:"id,omitempty"`
	Labels      *Labels    `json:"labels,omitempty"`
	Links       *struct {
		// URI of resource.
		Labels *Link `json:"labels,omitempty"`

		// URI of resource.
		Members *Link `json:"members,omitempty"`

		// URI of resource.
		Org *Link `json:"org,omitempty"`

		// URI of resource.
		Owners *Link `json:"owners,omitempty"`

		// URI of resource.
		Self *Link `json:"self,omitempty"`

		// URI of resource.
		Write *Link `json:"write,omitempty"`
	} `json:"links,omitempty"`
	Name  string  `json:"name"`
	OrgID *string `json:"orgID,omitempty"`

	// Retention rules to expire or retain data.
	// #### InfluxDB Cloud
	//
	// - `retentionRules` is required.
	//
	// #### InfluxDB OSS
	//
	// - `retentionRules` isn't required.
	RetentionRules RetentionRules `json:"retentionRules"`
	Rp             *string        `json:"rp,omitempty"`
	SchemaType     *SchemaType    `json:"schemaType,omitempty"`
	Type           *BucketType    `json:"type,omitempty"`
	UpdatedAt      *time.Time     `json:"updatedAt,omitempty"`
}

Bucket defines model for Bucket.

type BucketMetadataManifest added in v2.5.0 

type BucketMetadataManifest struct {
	BucketID               string                   `json:"bucketID"`
	BucketName             string                   `json:"bucketName"`
	DefaultRetentionPolicy string                   `json:"defaultRetentionPolicy"`
	Description            *string                  `json:"description,omitempty"`
	OrganizationID         string                   `json:"organizationID"`
	OrganizationName       string                   `json:"organizationName"`
	RetentionPolicies      RetentionPolicyManifests `json:"retentionPolicies"`
}

BucketMetadataManifest defines model for BucketMetadataManifest.

type BucketMetadataManifests added in v2.5.0 

type BucketMetadataManifests []BucketMetadataManifest

BucketMetadataManifests defines model for BucketMetadataManifests.

type BucketShardMapping added in v2.5.0 

type BucketShardMapping struct {
	NewId int64 `json:"newId"`
	OldId int64 `json:"oldId"`
}

BucketShardMapping defines model for BucketShardMapping.

type BucketShardMappings added in v2.5.0 

type BucketShardMappings []BucketShardMapping

BucketShardMappings defines model for BucketShardMappings.

type BucketType 

type BucketType string

BucketType defines model for Bucket.Type. 

const (
	BucketTypeSystem BucketType = "system"

	BucketTypeUser BucketType = "user"
)

Defines values for BucketType.

type Buckets 

type Buckets struct {
	Buckets *[]Bucket `json:"buckets,omitempty"`

	// URI pointers for additional paged results.
	Links *Links `json:"links,omitempty"`
}

Buckets defines model for Buckets.

type BuilderAggregateFunctionType 

type BuilderAggregateFunctionType string

BuilderAggregateFunctionType defines model for BuilderAggregateFunctionType. 

const (
	BuilderAggregateFunctionTypeFilter BuilderAggregateFunctionType = "filter"

	BuilderAggregateFunctionTypeGroup BuilderAggregateFunctionType = "group"
)

Defines values for BuilderAggregateFunctionType.

type BuilderConfig 

type BuilderConfig struct {
	AggregateWindow *struct {
		FillValues *bool   `json:"fillValues,omitempty"`
		Period     *string `json:"period,omitempty"`
	} `json:"aggregateWindow,omitempty"`
	Buckets   *[]string               `json:"buckets,omitempty"`
	Functions *[]BuilderFunctionsType `json:"functions,omitempty"`
	Tags      *[]BuilderTagsType      `json:"tags,omitempty"`
}

BuilderConfig defines model for BuilderConfig.

type BuilderFunctionsType 

type BuilderFunctionsType struct {
	Name *string `json:"name,omitempty"`
}

BuilderFunctionsType defines model for BuilderFunctionsType.

type BuilderTagsType 

type BuilderTagsType struct {
	AggregateFunctionType *BuilderAggregateFunctionType `json:"aggregateFunctionType,omitempty"`
	Key                   *string                       `json:"key,omitempty"`
	Values                *[]string                     `json:"values,omitempty"`
}

BuilderTagsType defines model for BuilderTagsType.

type BuiltinStatement 

type BuiltinStatement struct {
	// A valid Flux identifier
	Id *Identifier `json:"id,omitempty"`

	// Type of AST node
	Type *NodeType `json:"type,omitempty"`
}

Declares a builtin identifier and its type

type CallExpression 

type CallExpression struct {
	// Function arguments
	Arguments *[]Expression `json:"arguments,omitempty"`
	Callee    *Expression   `json:"callee,omitempty"`

	// Type of AST node
	Type *NodeType `json:"type,omitempty"`
}

Represents a function call

type Cell 

type Cell struct {
	H     *int32  `json:"h,omitempty"`
	Id    *string `json:"id,omitempty"`
	Links *struct {
		Self *string `json:"self,omitempty"`
		View *string `json:"view,omitempty"`
	} `json:"links,omitempty"`

	// The reference to a view from the views API.
	ViewID *string `json:"viewID,omitempty"`
	W      *int32  `json:"w,omitempty"`
	X      *int32  `json:"x,omitempty"`
	Y      *int32  `json:"y,omitempty"`
}

Cell defines model for Cell.

type CellUpdate 

type CellUpdate struct {
	H *int32 `json:"h,omitempty"`
	W *int32 `json:"w,omitempty"`
	X *int32 `json:"x,omitempty"`
	Y *int32 `json:"y,omitempty"`
}

CellUpdate defines model for CellUpdate.

type CellWithViewProperties 

type CellWithViewProperties struct {
	// Embedded struct due to allOf(#/components/schemas/Cell)
	Cell `yaml:",inline"`
	// Embedded fields due to inline allOf schema
	Name       *string         `json:"name,omitempty"`
	Properties *ViewProperties `json:"properties,omitempty"`
}

CellWithViewProperties defines model for CellWithViewProperties.

type Cells 

type Cells []Cell

Cells defines model for Cells.

type CellsWithViewProperties 

type CellsWithViewProperties []CellWithViewProperties

CellsWithViewProperties defines model for CellsWithViewProperties.

type Check 

type Check interface {
	Type() string
}

Check defines model for Check.

type CheckBase 

type CheckBase struct {
	CreatedAt *time.Time `json:"createdAt,omitempty"`

	// An optional description of the check.
	Description   *string                 `json:"description,omitempty"`
	Id            *string                 `json:"id,omitempty"`
	Labels        *Labels                 `json:"labels,omitempty"`
	LastRunError  *string                 `json:"lastRunError,omitempty"`
	LastRunStatus *CheckBaseLastRunStatus `json:"lastRunStatus,omitempty"`

	// A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run.
	LatestCompleted *time.Time `json:"latestCompleted,omitempty"`
	Links           *struct {
		// URI of resource.
		Labels *Link `json:"labels,omitempty"`

		// URI of resource.
		Members *Link `json:"members,omitempty"`

		// URI of resource.
		Owners *Link `json:"owners,omitempty"`

		// URI of resource.
		Query *Link `json:"query,omitempty"`

		// URI of resource.
		Self *Link `json:"self,omitempty"`
	} `json:"links,omitempty"`
	Name string `json:"name"`

	// The ID of the organization that owns this check.
	OrgID string `json:"orgID"`

	// The ID of creator used to create this check.
	OwnerID *string        `json:"ownerID,omitempty"`
	Query   DashboardQuery `json:"query"`

	// `inactive` cancels scheduled runs and prevents manual runs of the task.
	Status TaskStatusType `json:"status"`

	// The ID of the task associated with this check.
	TaskID    *string    `json:"taskID,omitempty"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
}

CheckBase defines model for CheckBase.

type CheckBaseExtend added in v2.14.0 

type CheckBaseExtend struct {
	CheckBase
	// Embedded fields due to inline allOf schema
	// Check repetition interval.
	Every *string `json:"every,omitempty"`

	// Duration to delay after the schedule, before executing check.
	Offset *string `json:"offset,omitempty"`

	// The template used to generate and write a status message.
	StatusMessageTemplate *string `json:"statusMessageTemplate,omitempty"`

	// List of tags to write to each status.
	Tags *[]struct {
		Key   *string `json:"key,omitempty"`
		Value *string `json:"value,omitempty"`
	} `json:"tags,omitempty"`
}

type CheckBaseLastRunStatus 

type CheckBaseLastRunStatus string

CheckBaseLastRunStatus defines model for CheckBase.LastRunStatus. 

const (
	CheckBaseLastRunStatusCanceled CheckBaseLastRunStatus = "canceled"

	CheckBaseLastRunStatusFailed CheckBaseLastRunStatus = "failed"

	CheckBaseLastRunStatusSuccess CheckBaseLastRunStatus = "success"
)

Defines values for CheckBaseLastRunStatus.

type CheckPatch 

type CheckPatch struct {
	Description *string           `json:"description,omitempty"`
	Name        *string           `json:"name,omitempty"`
	Status      *CheckPatchStatus `json:"status,omitempty"`
}

CheckPatch defines model for CheckPatch.

type CheckPatchStatus 

type CheckPatchStatus string

CheckPatchStatus defines model for CheckPatch.Status. 

const (
	CheckPatchStatusActive CheckPatchStatus = "active"

	CheckPatchStatusInactive CheckPatchStatus = "inactive"
)

Defines values for CheckPatchStatus.

type CheckStatusLevel 

type CheckStatusLevel string

The state to record if check matches a criteria. 

const (
	CheckStatusLevelCRIT CheckStatusLevel = "CRIT"

	CheckStatusLevelINFO CheckStatusLevel = "INFO"

	CheckStatusLevelOK CheckStatusLevel = "OK"

	CheckStatusLevelUNKNOWN CheckStatusLevel = "UNKNOWN"

	CheckStatusLevelWARN CheckStatusLevel = "WARN"
)

Defines values for CheckStatusLevel.

type CheckViewProperties 

type CheckViewProperties struct {
	AdaptiveZoomHide *bool  `json:"adaptiveZoomHide,omitempty"`
	Check            *Check `json:"check,omitempty"`
	CheckID          string `json:"checkID"`

	// Colors define color encoding of data into a visualization
	Colors                     []DashboardColor         `json:"colors"`
	LegendColorizeRows         *bool                    `json:"legendColorizeRows,omitempty"`
	LegendHide                 *bool                    `json:"legendHide,omitempty"`
	LegendOpacity              *float32                 `json:"legendOpacity,omitempty"`
	LegendOrientationThreshold *int                     `json:"legendOrientationThreshold,omitempty"`
	Queries                    []DashboardQuery         `json:"queries"`
	Shape                      CheckViewPropertiesShape `json:"shape"`
	Type                       CheckViewPropertiesType  `json:"type"`
}

CheckViewProperties defines model for CheckViewProperties.

type CheckViewPropertiesShape 

type CheckViewPropertiesShape string

CheckViewPropertiesShape defines model for CheckViewProperties.Shape. 

const (
	CheckViewPropertiesShapeChronografV2 CheckViewPropertiesShape = "chronograf-v2"
)

Defines values for CheckViewPropertiesShape.

type CheckViewPropertiesType 

type CheckViewPropertiesType string

CheckViewPropertiesType defines model for CheckViewProperties.Type. 

const (
	CheckViewPropertiesTypeCheck CheckViewPropertiesType = "check"
)

Defines values for CheckViewPropertiesType.

type Checks 

type Checks struct {
	Checks *[]Check `json:"checks,omitempty"`

	// URI pointers for additional paged results.
	Links *Links `json:"links,omitempty"`
}

Checks defines model for Checks.

type Client 

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Server + /api/v2/
	APIEndpoint string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HTTPRequestDoer
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient 

func NewClient(server string, doer HTTPRequestDoer) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) CreateCheck 

func (c *Client) CreateCheck(ctx context.Context, params *CreateCheckAllParams) (Check, error)

CreateCheck calls the POST on /checks Add new check

func (*Client) CreateNotificationEndpoint 

func (c *Client) CreateNotificationEndpoint(ctx context.Context, params *CreateNotificationEndpointAllParams) (*NotificationEndpoint, error)

CreateNotificationEndpoint calls the POST on /notificationEndpoints Add a notification endpoint

func (*Client) CreateNotificationRule 

func (c *Client) CreateNotificationRule(ctx context.Context, params *CreateNotificationRuleAllParams) (*NotificationRule, error)

CreateNotificationRule calls the POST on /notificationRules Add a notification rule

func (*Client) CreateStack 

func (c *Client) CreateStack(ctx context.Context, params *CreateStackAllParams) (*Stack, error)

CreateStack calls the POST on /stacks Create a stack

func (*Client) DeleteAuthorizationsID 

func (c *Client) DeleteAuthorizationsID(ctx context.Context, params *DeleteAuthorizationsIDAllParams) error

DeleteAuthorizationsID calls the DELETE on /authorizations/{authID} Delete an authorization

func (*Client) DeleteBucketsID 

func (c *Client) DeleteBucketsID(ctx context.Context, params *DeleteBucketsIDAllParams) error

DeleteBucketsID calls the DELETE on /buckets/{bucketID} Delete a bucket

func (*Client) DeleteBucketsIDLabelsID 

func (c *Client) DeleteBucketsIDLabelsID(ctx context.Context, params *DeleteBucketsIDLabelsIDAllParams) error

DeleteBucketsIDLabelsID calls the DELETE on /buckets/{bucketID}/labels/{labelID} Delete a label from a bucket

func (*Client) DeleteBucketsIDMembersID 

func (c *Client) DeleteBucketsIDMembersID(ctx context.Context, params *DeleteBucketsIDMembersIDAllParams) error

DeleteBucketsIDMembersID calls the DELETE on /buckets/{bucketID}/members/{userID} Remove a member from a bucket

func (*Client) DeleteBucketsIDOwnersID 

func (c *Client) DeleteBucketsIDOwnersID(ctx context.Context, params *DeleteBucketsIDOwnersIDAllParams) error

DeleteBucketsIDOwnersID calls the DELETE on /buckets/{bucketID}/owners/{userID} Remove an owner from a bucket

func (*Client) DeleteChecksID 

func (c *Client) DeleteChecksID(ctx context.Context, params *DeleteChecksIDAllParams) error

DeleteChecksID calls the DELETE on /checks/{checkID} Delete a check

func (*Client) DeleteChecksIDLabelsID 

func (c *Client) DeleteChecksIDLabelsID(ctx context.Context, params *DeleteChecksIDLabelsIDAllParams) error

DeleteChecksIDLabelsID calls the DELETE on /checks/{checkID}/labels/{labelID} Delete label from a check

func (*Client) DeleteDBRPID 

func (c *Client) DeleteDBRPID(ctx context.Context, params *DeleteDBRPIDAllParams) error

DeleteDBRPID calls the DELETE on /dbrps/{dbrpID} Delete a database retention policy

func (*Client) DeleteDashboardsID 

func (c *Client) DeleteDashboardsID(ctx context.Context, params *DeleteDashboardsIDAllParams) error

DeleteDashboardsID calls the DELETE on /dashboards/{dashboardID} Delete a dashboard

func (*Client) DeleteDashboardsIDCellsID 

func (c *Client) DeleteDashboardsIDCellsID(ctx context.Context, params *DeleteDashboardsIDCellsIDAllParams) error

DeleteDashboardsIDCellsID calls the DELETE on /dashboards/{dashboardID}/cells/{cellID} Delete a dashboard cell

func (*Client) DeleteDashboardsIDLabelsID 

func (c *Client) DeleteDashboardsIDLabelsID(ctx context.Context, params *DeleteDashboardsIDLabelsIDAllParams) error

DeleteDashboardsIDLabelsID calls the DELETE on /dashboards/{dashboardID}/labels/{labelID} Delete a label from a dashboard

func (*Client) DeleteDashboardsIDMembersID 

func (c *Client) DeleteDashboardsIDMembersID(ctx context.Context, params *DeleteDashboardsIDMembersIDAllParams) error

DeleteDashboardsIDMembersID calls the DELETE on /dashboards/{dashboardID}/members/{userID} Remove a member from a dashboard

func (*Client) DeleteDashboardsIDOwnersID 

func (c *Client) DeleteDashboardsIDOwnersID(ctx context.Context, params *DeleteDashboardsIDOwnersIDAllParams) error

DeleteDashboardsIDOwnersID calls the DELETE on /dashboards/{dashboardID}/owners/{userID} Remove an owner from a dashboard

func (*Client) DeleteLabelsID 

func (c *Client) DeleteLabelsID(ctx context.Context, params *DeleteLabelsIDAllParams) error

DeleteLabelsID calls the DELETE on /labels/{labelID} Delete a label

func (*Client) DeleteNotificationEndpointsID 

func (c *Client) DeleteNotificationEndpointsID(ctx context.Context, params *DeleteNotificationEndpointsIDAllParams) error

DeleteNotificationEndpointsID calls the DELETE on /notificationEndpoints/{endpointID} Delete a notification endpoint

func (*Client) DeleteNotificationEndpointsIDLabelsID 

func (c *Client) DeleteNotificationEndpointsIDLabelsID(ctx context.Context, params *DeleteNotificationEndpointsIDLabelsIDAllParams) error

DeleteNotificationEndpointsIDLabelsID calls the DELETE on /notificationEndpoints/{endpointID}/labels/{labelID} Delete a label from a notification endpoint

func (*Client) DeleteNotificationRulesID 

func (c *Client) DeleteNotificationRulesID(ctx context.Context, params *DeleteNotificationRulesIDAllParams) error

DeleteNotificationRulesID calls the DELETE on /notificationRules/{ruleID} Delete a notification rule

func (*Client) DeleteNotificationRulesIDLabelsID 

func (c *Client) DeleteNotificationRulesIDLabelsID(ctx context.Context, params *DeleteNotificationRulesIDLabelsIDAllParams) error

DeleteNotificationRulesIDLabelsID calls the DELETE on /notificationRules/{ruleID}/labels/{labelID} Delete label from a notification rule

func (*Client) DeleteOrgsID 

func (c *Client) DeleteOrgsID(ctx context.Context, params *DeleteOrgsIDAllParams) error

DeleteOrgsID calls the DELETE on /orgs/{orgID} Delete an organization

func (*Client) DeleteOrgsIDMembersID 

func (c *Client) DeleteOrgsIDMembersID(ctx context.Context, params *DeleteOrgsIDMembersIDAllParams) error

DeleteOrgsIDMembersID calls the DELETE on /orgs/{orgID}/members/{userID} Remove a member from an organization

func (*Client) DeleteOrgsIDOwnersID 

func (c *Client) DeleteOrgsIDOwnersID(ctx context.Context, params *DeleteOrgsIDOwnersIDAllParams) error

DeleteOrgsIDOwnersID calls the DELETE on /orgs/{orgID}/owners/{userID} Remove an owner from an organization

func (*Client) DeleteOrgsIDSecretsID added in v2.6.0 

func (c *Client) DeleteOrgsIDSecretsID(ctx context.Context, params *DeleteOrgsIDSecretsIDAllParams) error

DeleteOrgsIDSecretsID calls the DELETE on /orgs/{orgID}/secrets/{secretID} Delete a secret from an organization

func (*Client) DeleteRemoteConnectionByID added in v2.8.0 

func (c *Client) DeleteRemoteConnectionByID(ctx context.Context, params *DeleteRemoteConnectionByIDAllParams) error

DeleteRemoteConnectionByID calls the DELETE on /remotes/{remoteID} Delete a remote connection

func (*Client) DeleteReplicationByID added in v2.8.0 

func (c *Client) DeleteReplicationByID(ctx context.Context, params *DeleteReplicationByIDAllParams) error

DeleteReplicationByID calls the DELETE on /replications/{replicationID} Delete a replication

func (*Client) DeleteScrapersID 

func (c *Client) DeleteScrapersID(ctx context.Context, params *DeleteScrapersIDAllParams) error

DeleteScrapersID calls the DELETE on /scrapers/{scraperTargetID} Delete a scraper target

func (*Client) DeleteScrapersIDLabelsID 

func (c *Client) DeleteScrapersIDLabelsID(ctx context.Context, params *DeleteScrapersIDLabelsIDAllParams) error

DeleteScrapersIDLabelsID calls the DELETE on /scrapers/{scraperTargetID}/labels/{labelID} Delete a label from a scraper target

func (*Client) DeleteScrapersIDMembersID 

func (c *Client) DeleteScrapersIDMembersID(ctx context.Context, params *DeleteScrapersIDMembersIDAllParams) error

DeleteScrapersIDMembersID calls the DELETE on /scrapers/{scraperTargetID}/members/{userID} Remove a member from a scraper target

func (*Client) DeleteScrapersIDOwnersID 

func (c *Client) DeleteScrapersIDOwnersID(ctx context.Context, params *DeleteScrapersIDOwnersIDAllParams) error

DeleteScrapersIDOwnersID calls the DELETE on /scrapers/{scraperTargetID}/owners/{userID} Remove an owner from a scraper target

func (*Client) DeleteSourcesID 

func (c *Client) DeleteSourcesID(ctx context.Context, params *DeleteSourcesIDAllParams) error

DeleteSourcesID calls the DELETE on /sources/{sourceID} Delete a source

func (*Client) DeleteStack 

func (c *Client) DeleteStack(ctx context.Context, params *DeleteStackAllParams) error

DeleteStack calls the DELETE on /stacks/{stack_id} Delete a stack and associated resources

func (*Client) DeleteTasksID 

func (c *Client) DeleteTasksID(ctx context.Context, params *DeleteTasksIDAllParams) error

DeleteTasksID calls the DELETE on /tasks/{taskID} Delete a task

func (*Client) DeleteTasksIDLabelsID 

func (c *Client) DeleteTasksIDLabelsID(ctx context.Context, params *DeleteTasksIDLabelsIDAllParams) error

DeleteTasksIDLabelsID calls the DELETE on /tasks/{taskID}/labels/{labelID} Delete a label from a task

func (*Client) DeleteTasksIDMembersID 

func (c *Client) DeleteTasksIDMembersID(ctx context.Context, params *DeleteTasksIDMembersIDAllParams) error

DeleteTasksIDMembersID calls the DELETE on /tasks/{taskID}/members/{userID} Remove a member from a task

func (*Client) DeleteTasksIDOwnersID 

func (c *Client) DeleteTasksIDOwnersID(ctx context.Context, params *DeleteTasksIDOwnersIDAllParams) error

DeleteTasksIDOwnersID calls the DELETE on /tasks/{taskID}/owners/{userID} Remove an owner from a task

func (*Client) DeleteTasksIDRunsID 

func (c *Client) DeleteTasksIDRunsID(ctx context.Context, params *DeleteTasksIDRunsIDAllParams) error

DeleteTasksIDRunsID calls the DELETE on /tasks/{taskID}/runs/{runID} Cancel a running task

func (*Client) DeleteTelegrafsID 

func (c *Client) DeleteTelegrafsID(ctx context.Context, params *DeleteTelegrafsIDAllParams) error

DeleteTelegrafsID calls the DELETE on /telegrafs/{telegrafID} Delete a Telegraf configuration

func (*Client) DeleteTelegrafsIDLabelsID 

func (c *Client) DeleteTelegrafsIDLabelsID(ctx context.Context, params *DeleteTelegrafsIDLabelsIDAllParams) error

DeleteTelegrafsIDLabelsID calls the DELETE on /telegrafs/{telegrafID}/labels/{labelID} Delete a label from a Telegraf config

func (*Client) DeleteTelegrafsIDMembersID 

func (c *Client) DeleteTelegrafsIDMembersID(ctx context.Context, params *DeleteTelegrafsIDMembersIDAllParams) error

DeleteTelegrafsIDMembersID calls the DELETE on /telegrafs/{telegrafID}/members/{userID} Remove a member from a Telegraf config

func (*Client) DeleteTelegrafsIDOwnersID 

func (c *Client) DeleteTelegrafsIDOwnersID(ctx context.Context, params *DeleteTelegrafsIDOwnersIDAllParams) error

DeleteTelegrafsIDOwnersID calls the DELETE on /telegrafs/{telegrafID}/owners/{userID} Remove an owner from a Telegraf config

func (*Client) DeleteUsersID 

func (c *Client) DeleteUsersID(ctx context.Context, params *DeleteUsersIDAllParams) error

DeleteUsersID calls the DELETE on /users/{userID} Delete a user

func (*Client) DeleteVariablesID 

func (c *Client) DeleteVariablesID(ctx context.Context, params *DeleteVariablesIDAllParams) error

DeleteVariablesID calls the DELETE on /variables/{variableID} Delete a variable

func (*Client) DeleteVariablesIDLabelsID 

func (c *Client) DeleteVariablesIDLabelsID(ctx context.Context, params *DeleteVariablesIDLabelsIDAllParams) error

DeleteVariablesIDLabelsID calls the DELETE on /variables/{variableID}/labels/{labelID} Delete a label from a variable

func (*Client) ExportTemplate 

func (c *Client) ExportTemplate(ctx context.Context, params *ExportTemplateAllParams) (*Template, error)

ExportTemplate calls the POST on /templates/export Export a new template

func (*Client) GetAuthorizations 

func (c *Client) GetAuthorizations(ctx context.Context, params *GetAuthorizationsParams) (*Authorizations, error)

GetAuthorizations calls the GET on /authorizations List authorizations

func (*Client) GetAuthorizationsID 

func (c *Client) GetAuthorizationsID(ctx context.Context, params *GetAuthorizationsIDAllParams) (*Authorization, error)

GetAuthorizationsID calls the GET on /authorizations/{authID} Retrieve an authorization

func (*Client) GetBuckets 

func (c *Client) GetBuckets(ctx context.Context, params *GetBucketsParams) (*Buckets, error)

GetBuckets calls the GET on /buckets List buckets

func (*Client) GetBucketsID 

func (c *Client) GetBucketsID(ctx context.Context, params *GetBucketsIDAllParams) (*Bucket, error)

GetBucketsID calls the GET on /buckets/{bucketID} Retrieve a bucket

func (*Client) GetBucketsIDLabels 

func (c *Client) GetBucketsIDLabels(ctx context.Context, params *GetBucketsIDLabelsAllParams) (*LabelsResponse, error)

GetBucketsIDLabels calls the GET on /buckets/{bucketID}/labels List all labels for a bucket

func (*Client) GetBucketsIDMembers 

func (c *Client) GetBucketsIDMembers(ctx context.Context, params *GetBucketsIDMembersAllParams) (*ResourceMembers, error)

GetBucketsIDMembers calls the GET on /buckets/{bucketID}/members List all users with member privileges for a bucket

func (*Client) GetBucketsIDOwners 

func (c *Client) GetBucketsIDOwners(ctx context.Context, params *GetBucketsIDOwnersAllParams) (*ResourceOwners, error)

GetBucketsIDOwners calls the GET on /buckets/{bucketID}/owners List all owners of a bucket

func (*Client) GetChecks 

func (c *Client) GetChecks(ctx context.Context, params *GetChecksParams) (*Checks, error)

GetChecks calls the GET on /checks List all checks

func (*Client) GetChecksID 

func (c *Client) GetChecksID(ctx context.Context, params *GetChecksIDAllParams) (Check, error)

GetChecksID calls the GET on /checks/{checkID} Retrieve a check

func (*Client) GetChecksIDLabels 

func (c *Client) GetChecksIDLabels(ctx context.Context, params *GetChecksIDLabelsAllParams) (*LabelsResponse, error)

GetChecksIDLabels calls the GET on /checks/{checkID}/labels List all labels for a check

func (*Client) GetChecksIDQuery 

func (c *Client) GetChecksIDQuery(ctx context.Context, params *GetChecksIDQueryAllParams) (*FluxResponse, error)

GetChecksIDQuery calls the GET on /checks/{checkID}/query Retrieve a check query

func (*Client) GetConfig added in v2.8.0 

func (c *Client) GetConfig(ctx context.Context, params *GetConfigParams) (*Config, error)

GetConfig calls the GET on /config Retrieve runtime configuration

func (*Client) GetDBRPs 

func (c *Client) GetDBRPs(ctx context.Context, params *GetDBRPsParams) (*DBRPs, error)

GetDBRPs calls the GET on /dbrps List database retention policy mappings

func (*Client) GetDBRPsID 

func (c *Client) GetDBRPsID(ctx context.Context, params *GetDBRPsIDAllParams) (*DBRPGet, error)

GetDBRPsID calls the GET on /dbrps/{dbrpID} Retrieve a database retention policy mapping

func (*Client) GetDashboards 

func (c *Client) GetDashboards(ctx context.Context, params *GetDashboardsParams) (*Dashboards, error)

GetDashboards calls the GET on /dashboards List all dashboards

func (*Client) GetDashboardsIDCellsIDView 

func (c *Client) GetDashboardsIDCellsIDView(ctx context.Context, params *GetDashboardsIDCellsIDViewAllParams) (*View, error)

GetDashboardsIDCellsIDView calls the GET on /dashboards/{dashboardID}/cells/{cellID}/view Retrieve the view for a cell

func (*Client) GetDashboardsIDLabels 

func (c *Client) GetDashboardsIDLabels(ctx context.Context, params *GetDashboardsIDLabelsAllParams) (*LabelsResponse, error)

GetDashboardsIDLabels calls the GET on /dashboards/{dashboardID}/labels List all labels for a dashboard

func (*Client) GetDashboardsIDMembers 

func (c *Client) GetDashboardsIDMembers(ctx context.Context, params *GetDashboardsIDMembersAllParams) (*ResourceMembers, error)

GetDashboardsIDMembers calls the GET on /dashboards/{dashboardID}/members List all dashboard members

func (*Client) GetDashboardsIDOwners 

func (c *Client) GetDashboardsIDOwners(ctx context.Context, params *GetDashboardsIDOwnersAllParams) (*ResourceOwners, error)

GetDashboardsIDOwners calls the GET on /dashboards/{dashboardID}/owners List all dashboard owners

func (*Client) GetFlags 

func (c *Client) GetFlags(ctx context.Context, params *GetFlagsParams) (*Flags, error)

GetFlags calls the GET on /flags Return the feature flags for the currently authenticated user

func (*Client) GetHealth 

func (c *Client) GetHealth(ctx context.Context, params *GetHealthParams) (*HealthCheck, error)

GetHealth calls the GET on /health Retrieve the health of the instance

func (*Client) GetLabels 

func (c *Client) GetLabels(ctx context.Context, params *GetLabelsParams) (*LabelsResponse, error)

GetLabels calls the GET on /labels List all labels

func (*Client) GetLabelsID 

func (c *Client) GetLabelsID(ctx context.Context, params *GetLabelsIDAllParams) (*LabelResponse, error)

GetLabelsID calls the GET on /labels/{labelID} Retrieve a label

func (*Client) GetMe 

func (c *Client) GetMe(ctx context.Context, params *GetMeParams) (*UserResponse, error)

GetMe calls the GET on /me Retrieve the currently authenticated user

func (*Client) GetNotificationEndpoints 

func (c *Client) GetNotificationEndpoints(ctx context.Context, params *GetNotificationEndpointsParams) (*NotificationEndpoints, error)

GetNotificationEndpoints calls the GET on /notificationEndpoints List all notification endpoints

func (*Client) GetNotificationEndpointsID 

func (c *Client) GetNotificationEndpointsID(ctx context.Context, params *GetNotificationEndpointsIDAllParams) (*NotificationEndpoint, error)

GetNotificationEndpointsID calls the GET on /notificationEndpoints/{endpointID} Retrieve a notification endpoint

func (*Client) GetNotificationEndpointsIDLabels 

func (c *Client) GetNotificationEndpointsIDLabels(ctx context.Context, params *GetNotificationEndpointsIDLabelsAllParams) (*LabelsResponse, error)

GetNotificationEndpointsIDLabels calls the GET on /notificationEndpoints/{endpointID}/labels List all labels for a notification endpoint

func (*Client) GetNotificationRules 

func (c *Client) GetNotificationRules(ctx context.Context, params *GetNotificationRulesParams) (*NotificationRules, error)

GetNotificationRules calls the GET on /notificationRules List all notification rules

func (*Client) GetNotificationRulesID 

func (c *Client) GetNotificationRulesID(ctx context.Context, params *GetNotificationRulesIDAllParams) (*NotificationRule, error)

GetNotificationRulesID calls the GET on /notificationRules/{ruleID} Retrieve a notification rule

func (*Client) GetNotificationRulesIDLabels 

func (c *Client) GetNotificationRulesIDLabels(ctx context.Context, params *GetNotificationRulesIDLabelsAllParams) (*LabelsResponse, error)

GetNotificationRulesIDLabels calls the GET on /notificationRules/{ruleID}/labels List all labels for a notification rule

func (*Client) GetNotificationRulesIDQuery 

func (c *Client) GetNotificationRulesIDQuery(ctx context.Context, params *GetNotificationRulesIDQueryAllParams) (*FluxResponse, error)

GetNotificationRulesIDQuery calls the GET on /notificationRules/{ruleID}/query Retrieve a notification rule query

func (*Client) GetOrgs 

func (c *Client) GetOrgs(ctx context.Context, params *GetOrgsParams) (*Organizations, error)

GetOrgs calls the GET on /orgs List organizations

func (*Client) GetOrgsID 

func (c *Client) GetOrgsID(ctx context.Context, params *GetOrgsIDAllParams) (*Organization, error)

GetOrgsID calls the GET on /orgs/{orgID} Retrieve an organization

func (*Client) GetOrgsIDMembers 

func (c *Client) GetOrgsIDMembers(ctx context.Context, params *GetOrgsIDMembersAllParams) (*ResourceMembers, error)

GetOrgsIDMembers calls the GET on /orgs/{orgID}/members List all members of an organization

func (*Client) GetOrgsIDOwners 

func (c *Client) GetOrgsIDOwners(ctx context.Context, params *GetOrgsIDOwnersAllParams) (*ResourceOwners, error)

GetOrgsIDOwners calls the GET on /orgs/{orgID}/owners List all owners of an organization

func (*Client) GetOrgsIDSecrets 

func (c *Client) GetOrgsIDSecrets(ctx context.Context, params *GetOrgsIDSecretsAllParams) (*SecretKeysResponse, error)

GetOrgsIDSecrets calls the GET on /orgs/{orgID}/secrets List all secret keys for an organization

func (*Client) GetPing added in v2.5.0 

func (c *Client) GetPing(ctx context.Context) error

GetPing calls the GET on /ping Get the status and version of the instance

func (*Client) GetQuerySuggestions 

func (c *Client) GetQuerySuggestions(ctx context.Context, params *GetQuerySuggestionsParams) (*FluxSuggestions, error)

GetQuerySuggestions calls the GET on /query/suggestions Retrieve Flux query suggestions

func (*Client) GetQuerySuggestionsName 

func (c *Client) GetQuerySuggestionsName(ctx context.Context, params *GetQuerySuggestionsNameAllParams) (*FluxSuggestion, error)

GetQuerySuggestionsName calls the GET on /query/suggestions/{name} Retrieve a query suggestion for a branching suggestion

func (*Client) GetReady 

func (c *Client) GetReady(ctx context.Context, params *GetReadyParams) (*Ready, error)

GetReady calls the GET on /ready Get the readiness of an instance at startup

func (*Client) GetRemoteConnectionByID added in v2.8.0 

func (c *Client) GetRemoteConnectionByID(ctx context.Context, params *GetRemoteConnectionByIDAllParams) (*RemoteConnection, error)

GetRemoteConnectionByID calls the GET on /remotes/{remoteID} Retrieve a remote connection

func (*Client) GetRemoteConnections added in v2.8.0 

func (c *Client) GetRemoteConnections(ctx context.Context, params *GetRemoteConnectionsParams) (*RemoteConnections, error)

GetRemoteConnections calls the GET on /remotes List all remote connections

func (*Client) GetReplicationByID added in v2.8.0 

func (c *Client) GetReplicationByID(ctx context.Context, params *GetReplicationByIDAllParams) (*Replication, error)

GetReplicationByID calls the GET on /replications/{replicationID} Retrieve a replication

func (*Client) GetReplications added in v2.8.0 

func (c *Client) GetReplications(ctx context.Context, params *GetReplicationsParams) (*Replications, error)

GetReplications calls the GET on /replications List all replications

func (*Client) GetResources added in v2.6.0 

func (c *Client) GetResources(ctx context.Context, params *GetResourcesParams) (*[]string, error)

GetResources calls the GET on /resources List all known resources

func (*Client) GetScrapers 

func (c *Client) GetScrapers(ctx context.Context, params *GetScrapersParams) (*ScraperTargetResponses, error)

GetScrapers calls the GET on /scrapers List all scraper targets

func (*Client) GetScrapersID 

func (c *Client) GetScrapersID(ctx context.Context, params *GetScrapersIDAllParams) (*ScraperTargetResponse, error)

GetScrapersID calls the GET on /scrapers/{scraperTargetID} Retrieve a scraper target

func (*Client) GetScrapersIDLabels 

func (c *Client) GetScrapersIDLabels(ctx context.Context, params *GetScrapersIDLabelsAllParams) (*LabelsResponse, error)

GetScrapersIDLabels calls the GET on /scrapers/{scraperTargetID}/labels List all labels for a scraper target

func (*Client) GetScrapersIDMembers 

func (c *Client) GetScrapersIDMembers(ctx context.Context, params *GetScrapersIDMembersAllParams) (*ResourceMembers, error)

GetScrapersIDMembers calls the GET on /scrapers/{scraperTargetID}/members List all users with member privileges for a scraper target

func (*Client) GetScrapersIDOwners 

func (c *Client) GetScrapersIDOwners(ctx context.Context, params *GetScrapersIDOwnersAllParams) (*ResourceOwners, error)

GetScrapersIDOwners calls the GET on /scrapers/{scraperTargetID}/owners List all owners of a scraper target

func (*Client) GetSetup 

func (c *Client) GetSetup(ctx context.Context, params *GetSetupParams) (*IsOnboarding, error)

GetSetup calls the GET on /setup Check if database has default user, org, bucket

func (*Client) GetSources 

func (c *Client) GetSources(ctx context.Context, params *GetSourcesParams) (*Sources, error)

GetSources calls the GET on /sources List all sources

func (*Client) GetSourcesID 

func (c *Client) GetSourcesID(ctx context.Context, params *GetSourcesIDAllParams) (*Source, error)

GetSourcesID calls the GET on /sources/{sourceID} Retrieve a source

func (*Client) GetSourcesIDBuckets 

func (c *Client) GetSourcesIDBuckets(ctx context.Context, params *GetSourcesIDBucketsAllParams) (*Buckets, error)

GetSourcesIDBuckets calls the GET on /sources/{sourceID}/buckets Get buckets in a source

func (*Client) GetSourcesIDHealth 

func (c *Client) GetSourcesIDHealth(ctx context.Context, params *GetSourcesIDHealthAllParams) (*HealthCheck, error)

GetSourcesIDHealth calls the GET on /sources/{sourceID}/health Get the health of a source

func (*Client) GetTasks 

func (c *Client) GetTasks(ctx context.Context, params *GetTasksParams) (*Tasks, error)

GetTasks calls the GET on /tasks List tasks

func (*Client) GetTasksID 

func (c *Client) GetTasksID(ctx context.Context, params *GetTasksIDAllParams) (*Task, error)

GetTasksID calls the GET on /tasks/{taskID} Retrieve a task

func (*Client) GetTasksIDLabels 

func (c *Client) GetTasksIDLabels(ctx context.Context, params *GetTasksIDLabelsAllParams) (*LabelsResponse, error)

GetTasksIDLabels calls the GET on /tasks/{taskID}/labels List labels for a task

func (*Client) GetTasksIDLogs 

func (c *Client) GetTasksIDLogs(ctx context.Context, params *GetTasksIDLogsAllParams) (*Logs, error)

GetTasksIDLogs calls the GET on /tasks/{taskID}/logs Retrieve all logs for a task

func (*Client) GetTasksIDMembers 

func (c *Client) GetTasksIDMembers(ctx context.Context, params *GetTasksIDMembersAllParams) (*ResourceMembers, error)

GetTasksIDMembers calls the GET on /tasks/{taskID}/members List all task members

func (*Client) GetTasksIDOwners 

func (c *Client) GetTasksIDOwners(ctx context.Context, params *GetTasksIDOwnersAllParams) (*ResourceOwners, error)

GetTasksIDOwners calls the GET on /tasks/{taskID}/owners List all owners of a task

func (*Client) GetTasksIDRuns 

func (c *Client) GetTasksIDRuns(ctx context.Context, params *GetTasksIDRunsAllParams) (*Runs, error)

GetTasksIDRuns calls the GET on /tasks/{taskID}/runs List runs for a task

func (*Client) GetTasksIDRunsID 

func (c *Client) GetTasksIDRunsID(ctx context.Context, params *GetTasksIDRunsIDAllParams) (*Run, error)

GetTasksIDRunsID calls the GET on /tasks/{taskID}/runs/{runID} Retrieve a run for a task.

func (*Client) GetTasksIDRunsIDLogs 

func (c *Client) GetTasksIDRunsIDLogs(ctx context.Context, params *GetTasksIDRunsIDLogsAllParams) (*Logs, error)

GetTasksIDRunsIDLogs calls the GET on /tasks/{taskID}/runs/{runID}/logs Retrieve all logs for a run

func (*Client) GetTelegrafPlugins 

func (c *Client) GetTelegrafPlugins(ctx context.Context, params *GetTelegrafPluginsParams) (*TelegrafPlugins, error)

GetTelegrafPlugins calls the GET on /telegraf/plugins List all Telegraf plugins

func (*Client) GetTelegrafs 

func (c *Client) GetTelegrafs(ctx context.Context, params *GetTelegrafsParams) (*Telegrafs, error)

GetTelegrafs calls the GET on /telegrafs List all Telegraf configurations

func (*Client) GetTelegrafsID 

func (c *Client) GetTelegrafsID(ctx context.Context, params *GetTelegrafsIDAllParams) (*Telegraf, error)

GetTelegrafsID calls the GET on /telegrafs/{telegrafID} Retrieve a Telegraf configuration

func (*Client) GetTelegrafsIDLabels 

func (c *Client) GetTelegrafsIDLabels(ctx context.Context, params *GetTelegrafsIDLabelsAllParams) (*LabelsResponse, error)

GetTelegrafsIDLabels calls the GET on /telegrafs/{telegrafID}/labels List all labels for a Telegraf config

func (*Client) GetTelegrafsIDMembers 

func (c *Client) GetTelegrafsIDMembers(ctx context.Context, params *GetTelegrafsIDMembersAllParams) (*ResourceMembers, error)

GetTelegrafsIDMembers calls the GET on /telegrafs/{telegrafID}/members List all users with member privileges for a Telegraf config

func (*Client) GetTelegrafsIDOwners 

func (c *Client) GetTelegrafsIDOwners(ctx context.Context, params *GetTelegrafsIDOwnersAllParams) (*ResourceOwners, error)

GetTelegrafsIDOwners calls the GET on /telegrafs/{telegrafID}/owners List all owners of a Telegraf configuration

func (*Client) GetUsers 

func (c *Client) GetUsers(ctx context.Context, params *GetUsersParams) (*Users, error)

GetUsers calls the GET on /users List users

func (*Client) GetUsersID 

func (c *Client) GetUsersID(ctx context.Context, params *GetUsersIDAllParams) (*UserResponse, error)

GetUsersID calls the GET on /users/{userID} Retrieve a user

func (*Client) GetVariables 

func (c *Client) GetVariables(ctx context.Context, params *GetVariablesParams) (*Variables, error)

GetVariables calls the GET on /variables List all variables

func (*Client) GetVariablesID 

func (c *Client) GetVariablesID(ctx context.Context, params *GetVariablesIDAllParams) (*Variable, error)

GetVariablesID calls the GET on /variables/{variableID} Retrieve a variable

func (*Client) GetVariablesIDLabels 

func (c *Client) GetVariablesIDLabels(ctx context.Context, params *GetVariablesIDLabelsAllParams) (*LabelsResponse, error)

GetVariablesIDLabels calls the GET on /variables/{variableID}/labels List all labels for a variable

func (*Client) HeadPing added in v2.5.0 

func (c *Client) HeadPing(ctx context.Context) error

HeadPing calls the HEAD on /ping Get the status and version of the instance

func (*Client) ListStacks 

func (c *Client) ListStacks(ctx context.Context, params *ListStacksParams) (*struct {
	Stacks *[]Stack `json:"stacks,omitempty"`
}, error)

ListStacks calls the GET on /stacks List installed stacks

func (*Client) PatchAuthorizationsID 

func (c *Client) PatchAuthorizationsID(ctx context.Context, params *PatchAuthorizationsIDAllParams) (*Authorization, error)

PatchAuthorizationsID calls the PATCH on /authorizations/{authID} Update an authorization to be active or inactive

func (*Client) PatchBucketsID 

func (c *Client) PatchBucketsID(ctx context.Context, params *PatchBucketsIDAllParams) (*Bucket, error)

PatchBucketsID calls the PATCH on /buckets/{bucketID} Update a bucket

func (*Client) PatchChecksID 

func (c *Client) PatchChecksID(ctx context.Context, params *PatchChecksIDAllParams) (Check, error)

PatchChecksID calls the PATCH on /checks/{checkID} Update a check

func (*Client) PatchDBRPID 

func (c *Client) PatchDBRPID(ctx context.Context, params *PatchDBRPIDAllParams) (*DBRPGet, error)

PatchDBRPID calls the PATCH on /dbrps/{dbrpID} Update a database retention policy mapping

func (*Client) PatchDashboardsID 

func (c *Client) PatchDashboardsID(ctx context.Context, params *PatchDashboardsIDAllParams) (*Dashboard, error)

PatchDashboardsID calls the PATCH on /dashboards/{dashboardID} Update a dashboard

func (*Client) PatchDashboardsIDCellsID 

func (c *Client) PatchDashboardsIDCellsID(ctx context.Context, params *PatchDashboardsIDCellsIDAllParams) (*Cell, error)

PatchDashboardsIDCellsID calls the PATCH on /dashboards/{dashboardID}/cells/{cellID} Update the non-positional information related to a cell

func (*Client) PatchDashboardsIDCellsIDView 

func (c *Client) PatchDashboardsIDCellsIDView(ctx context.Context, params *PatchDashboardsIDCellsIDViewAllParams) (*View, error)

PatchDashboardsIDCellsIDView calls the PATCH on /dashboards/{dashboardID}/cells/{cellID}/view Update the view for a cell

func (*Client) PatchLabelsID 

func (c *Client) PatchLabelsID(ctx context.Context, params *PatchLabelsIDAllParams) (*LabelResponse, error)

PatchLabelsID calls the PATCH on /labels/{labelID} Update a label

func (*Client) PatchNotificationEndpointsID 

func (c *Client) PatchNotificationEndpointsID(ctx context.Context, params *PatchNotificationEndpointsIDAllParams) (*NotificationEndpoint, error)

PatchNotificationEndpointsID calls the PATCH on /notificationEndpoints/{endpointID} Update a notification endpoint

func (*Client) PatchNotificationRulesID 

func (c *Client) PatchNotificationRulesID(ctx context.Context, params *PatchNotificationRulesIDAllParams) (*NotificationRule, error)

PatchNotificationRulesID calls the PATCH on /notificationRules/{ruleID} Update a notification rule

func (*Client) PatchOrgsID 

func (c *Client) PatchOrgsID(ctx context.Context, params *PatchOrgsIDAllParams) (*Organization, error)

PatchOrgsID calls the PATCH on /orgs/{orgID} Update an organization

func (*Client) PatchOrgsIDSecrets 

func (c *Client) PatchOrgsIDSecrets(ctx context.Context, params *PatchOrgsIDSecretsAllParams) error

PatchOrgsIDSecrets calls the PATCH on /orgs/{orgID}/secrets Update secrets in an organization

func (*Client) PatchRemoteConnectionByID added in v2.8.0 

func (c *Client) PatchRemoteConnectionByID(ctx context.Context, params *PatchRemoteConnectionByIDAllParams) (*RemoteConnection, error)

PatchRemoteConnectionByID calls the PATCH on /remotes/{remoteID} Update a remote connection

func (*Client) PatchReplicationByID added in v2.8.0 

func (c *Client) PatchReplicationByID(ctx context.Context, params *PatchReplicationByIDAllParams) (*Replication, error)

PatchReplicationByID calls the PATCH on /replications/{replicationID} Update a replication

func (*Client) PatchScrapersID 

func (c *Client) PatchScrapersID(ctx context.Context, params *PatchScrapersIDAllParams) (*ScraperTargetResponse, error)

PatchScrapersID calls the PATCH on /scrapers/{scraperTargetID} Update a scraper target

func (*Client) PatchSourcesID 

func (c *Client) PatchSourcesID(ctx context.Context, params *PatchSourcesIDAllParams) (*Source, error)

PatchSourcesID calls the PATCH on /sources/{sourceID} Update a Source

func (*Client) PatchTasksID 

func (c *Client) PatchTasksID(ctx context.Context, params *PatchTasksIDAllParams) (*Task, error)

PatchTasksID calls the PATCH on /tasks/{taskID} Update a task

func (*Client) PatchUsersID 

func (c *Client) PatchUsersID(ctx context.Context, params *PatchUsersIDAllParams) (*UserResponse, error)

PatchUsersID calls the PATCH on /users/{userID} Update a user

func (*Client) PatchVariablesID 

func (c *Client) PatchVariablesID(ctx context.Context, params *PatchVariablesIDAllParams) (*Variable, error)

PatchVariablesID calls the PATCH on /variables/{variableID} Update a variable

func (*Client) PostAuthorizations 

func (c *Client) PostAuthorizations(ctx context.Context, params *PostAuthorizationsAllParams) (*Authorization, error)

PostAuthorizations calls the POST on /authorizations Create an authorization

func (*Client) PostBuckets 

func (c *Client) PostBuckets(ctx context.Context, params *PostBucketsAllParams) (*Bucket, error)

PostBuckets calls the POST on /buckets Create a bucket

func (*Client) PostBucketsIDLabels 

func (c *Client) PostBucketsIDLabels(ctx context.Context, params *PostBucketsIDLabelsAllParams) (*LabelResponse, error)

PostBucketsIDLabels calls the POST on /buckets/{bucketID}/labels Add a label to a bucket

func (*Client) PostBucketsIDMembers 

func (c *Client) PostBucketsIDMembers(ctx context.Context, params *PostBucketsIDMembersAllParams) (*ResourceMember, error)

PostBucketsIDMembers calls the POST on /buckets/{bucketID}/members Add a member to a bucket

func (*Client) PostBucketsIDOwners 

func (c *Client) PostBucketsIDOwners(ctx context.Context, params *PostBucketsIDOwnersAllParams) (*ResourceOwner, error)

PostBucketsIDOwners calls the POST on /buckets/{bucketID}/owners Add an owner to a bucket

func (*Client) PostChecksIDLabels 

func (c *Client) PostChecksIDLabels(ctx context.Context, params *PostChecksIDLabelsAllParams) (*LabelResponse, error)

PostChecksIDLabels calls the POST on /checks/{checkID}/labels Add a label to a check

func (*Client) PostDBRP 

func (c *Client) PostDBRP(ctx context.Context, params *PostDBRPAllParams) (*DBRP, error)

PostDBRP calls the POST on /dbrps Add a database retention policy mapping

func (*Client) PostDashboardsIDCells 

func (c *Client) PostDashboardsIDCells(ctx context.Context, params *PostDashboardsIDCellsAllParams) (*Cell, error)

PostDashboardsIDCells calls the POST on /dashboards/{dashboardID}/cells Create a dashboard cell

func (*Client) PostDashboardsIDLabels 

func (c *Client) PostDashboardsIDLabels(ctx context.Context, params *PostDashboardsIDLabelsAllParams) (*LabelResponse, error)

PostDashboardsIDLabels calls the POST on /dashboards/{dashboardID}/labels Add a label to a dashboard

func (*Client) PostDashboardsIDMembers 

func (c *Client) PostDashboardsIDMembers(ctx context.Context, params *PostDashboardsIDMembersAllParams) (*ResourceMember, error)

PostDashboardsIDMembers calls the POST on /dashboards/{dashboardID}/members Add a member to a dashboard

func (*Client) PostDashboardsIDOwners 

func (c *Client) PostDashboardsIDOwners(ctx context.Context, params *PostDashboardsIDOwnersAllParams) (*ResourceOwner, error)

PostDashboardsIDOwners calls the POST on /dashboards/{dashboardID}/owners Add an owner to a dashboard

func (*Client) PostDelete 

func (c *Client) PostDelete(ctx context.Context, params *PostDeleteAllParams) error

PostDelete calls the POST on /delete Delete data

func (*Client) PostLabels 

func (c *Client) PostLabels(ctx context.Context, params *PostLabelsAllParams) (*LabelResponse, error)

PostLabels calls the POST on /labels Create a label

func (*Client) PostNotificationEndpointIDLabels 

func (c *Client) PostNotificationEndpointIDLabels(ctx context.Context, params *PostNotificationEndpointIDLabelsAllParams) (*LabelResponse, error)

PostNotificationEndpointIDLabels calls the POST on /notificationEndpoints/{endpointID}/labels Add a label to a notification endpoint

func (*Client) PostNotificationRuleIDLabels 

func (c *Client) PostNotificationRuleIDLabels(ctx context.Context, params *PostNotificationRuleIDLabelsAllParams) (*LabelResponse, error)

PostNotificationRuleIDLabels calls the POST on /notificationRules/{ruleID}/labels Add a label to a notification rule

func (*Client) PostOrgs 

func (c *Client) PostOrgs(ctx context.Context, params *PostOrgsAllParams) (*Organization, error)

PostOrgs calls the POST on /orgs Create an organization

func (*Client) PostOrgsIDMembers 

func (c *Client) PostOrgsIDMembers(ctx context.Context, params *PostOrgsIDMembersAllParams) (*ResourceMember, error)

PostOrgsIDMembers calls the POST on /orgs/{orgID}/members Add a member to an organization

func (*Client) PostOrgsIDOwners 

func (c *Client) PostOrgsIDOwners(ctx context.Context, params *PostOrgsIDOwnersAllParams) (*ResourceOwner, error)

PostOrgsIDOwners calls the POST on /orgs/{orgID}/owners Add an owner to an organization

func (*Client) PostOrgsIDSecrets 

func (c *Client) PostOrgsIDSecrets(ctx context.Context, params *PostOrgsIDSecretsAllParams) error

PostOrgsIDSecrets calls the POST on /orgs/{orgID}/secrets/delete Delete secrets from an organization

func (*Client) PostQueryAnalyze 

func (c *Client) PostQueryAnalyze(ctx context.Context, params *PostQueryAnalyzeAllParams) (*AnalyzeQueryResponse, error)

PostQueryAnalyze calls the POST on /query/analyze Analyze a Flux query

func (*Client) PostQueryAst 

func (c *Client) PostQueryAst(ctx context.Context, params *PostQueryAstAllParams) (*ASTResponse, error)

PostQueryAst calls the POST on /query/ast Generate a query Abstract Syntax Tree (AST)

func (*Client) PostRemoteConnection added in v2.8.0 

func (c *Client) PostRemoteConnection(ctx context.Context, params *PostRemoteConnectionAllParams) (*RemoteConnection, error)

PostRemoteConnection calls the POST on /remotes Register a new remote connection

func (*Client) PostReplication added in v2.8.0 

func (c *Client) PostReplication(ctx context.Context, params *PostReplicationAllParams) (*Replication, error)

PostReplication calls the POST on /replications Register a new replication

func (*Client) PostRestoreBucketMetadata added in v2.5.0 

func (c *Client) PostRestoreBucketMetadata(ctx context.Context, params *PostRestoreBucketMetadataAllParams) (*RestoredBucketMappings, error)

PostRestoreBucketMetadata calls the POST on /restore/bucketMetadata Create a new bucket pre-seeded with shard info from a backup.

func (*Client) PostScrapers 

func (c *Client) PostScrapers(ctx context.Context, params *PostScrapersAllParams) (*ScraperTargetResponse, error)

PostScrapers calls the POST on /scrapers Create a scraper target

func (*Client) PostScrapersIDLabels 

func (c *Client) PostScrapersIDLabels(ctx context.Context, params *PostScrapersIDLabelsAllParams) (*LabelResponse, error)

PostScrapersIDLabels calls the POST on /scrapers/{scraperTargetID}/labels Add a label to a scraper target

func (*Client) PostScrapersIDMembers 

func (c *Client) PostScrapersIDMembers(ctx context.Context, params *PostScrapersIDMembersAllParams) (*ResourceMember, error)

PostScrapersIDMembers calls the POST on /scrapers/{scraperTargetID}/members Add a member to a scraper target

func (*Client) PostScrapersIDOwners 

func (c *Client) PostScrapersIDOwners(ctx context.Context, params *PostScrapersIDOwnersAllParams) (*ResourceOwner, error)

PostScrapersIDOwners calls the POST on /scrapers/{scraperTargetID}/owners Add an owner to a scraper target

func (*Client) PostSetup 

func (c *Client) PostSetup(ctx context.Context, params *PostSetupAllParams) (*OnboardingResponse, error)

PostSetup calls the POST on /setup Set up initial user, org and bucket

func (*Client) PostSignin 

func (c *Client) PostSignin(ctx context.Context, params *PostSigninParams) error

PostSignin calls the POST on /signin Create a user session.

func (*Client) PostSignout 

func (c *Client) PostSignout(ctx context.Context, params *PostSignoutParams) error

PostSignout calls the POST on /signout Expire the current UI session

func (*Client) PostSources 

func (c *Client) PostSources(ctx context.Context, params *PostSourcesAllParams) (*Source, error)

PostSources calls the POST on /sources Create a source

func (*Client) PostTasks 

func (c *Client) PostTasks(ctx context.Context, params *PostTasksAllParams) (*Task, error)

PostTasks calls the POST on /tasks Create a task

func (*Client) PostTasksIDLabels 

func (c *Client) PostTasksIDLabels(ctx context.Context, params *PostTasksIDLabelsAllParams) (*LabelResponse, error)

PostTasksIDLabels calls the POST on /tasks/{taskID}/labels Add a label to a task

func (*Client) PostTasksIDMembers 

func (c *Client) PostTasksIDMembers(ctx context.Context, params *PostTasksIDMembersAllParams) (*ResourceMember, error)

PostTasksIDMembers calls the POST on /tasks/{taskID}/members Add a member to a task

func (*Client) PostTasksIDOwners 

func (c *Client) PostTasksIDOwners(ctx context.Context, params *PostTasksIDOwnersAllParams) (*ResourceOwner, error)

PostTasksIDOwners calls the POST on /tasks/{taskID}/owners Add an owner for a task

func (*Client) PostTasksIDRuns 

func (c *Client) PostTasksIDRuns(ctx context.Context, params *PostTasksIDRunsAllParams) (*Run, error)

PostTasksIDRuns calls the POST on /tasks/{taskID}/runs Start a task run, overriding the schedule

func (*Client) PostTasksIDRunsIDRetry 

func (c *Client) PostTasksIDRunsIDRetry(ctx context.Context, params *PostTasksIDRunsIDRetryAllParams) (*Run, error)

PostTasksIDRunsIDRetry calls the POST on /tasks/{taskID}/runs/{runID}/retry Retry a task run

func (*Client) PostTelegrafs 

func (c *Client) PostTelegrafs(ctx context.Context, params *PostTelegrafsAllParams) (*Telegraf, error)

PostTelegrafs calls the POST on /telegrafs Create a Telegraf configuration

func (*Client) PostTelegrafsIDLabels 

func (c *Client) PostTelegrafsIDLabels(ctx context.Context, params *PostTelegrafsIDLabelsAllParams) (*LabelResponse, error)

PostTelegrafsIDLabels calls the POST on /telegrafs/{telegrafID}/labels Add a label to a Telegraf config

func (*Client) PostTelegrafsIDMembers 

func (c *Client) PostTelegrafsIDMembers(ctx context.Context, params *PostTelegrafsIDMembersAllParams) (*ResourceMember, error)

PostTelegrafsIDMembers calls the POST on /telegrafs/{telegrafID}/members Add a member to a Telegraf config

func (*Client) PostTelegrafsIDOwners 

func (c *Client) PostTelegrafsIDOwners(ctx context.Context, params *PostTelegrafsIDOwnersAllParams) (*ResourceOwner, error)

PostTelegrafsIDOwners calls the POST on /telegrafs/{telegrafID}/owners Add an owner to a Telegraf configuration

func (*Client) PostUsers 

func (c *Client) PostUsers(ctx context.Context, params *PostUsersAllParams) (*UserResponse, error)

PostUsers calls the POST on /users Create a user

func (*Client) PostUsersIDPassword 

func (c *Client) PostUsersIDPassword(ctx context.Context, params *PostUsersIDPasswordAllParams) error

PostUsersIDPassword calls the POST on /users/{userID}/password Update a password

func (*Client) PostValidateReplicationByID added in v2.8.0 

func (c *Client) PostValidateReplicationByID(ctx context.Context, params *PostValidateReplicationByIDAllParams) error

PostValidateReplicationByID calls the POST on /replications/{replicationID}/validate Validate a replication

func (*Client) PostVariables 

func (c *Client) PostVariables(ctx context.Context, params *PostVariablesAllParams) (*Variable, error)

PostVariables calls the POST on /variables Create a variable

func (*Client) PostVariablesIDLabels 

func (c *Client) PostVariablesIDLabels(ctx context.Context, params *PostVariablesIDLabelsAllParams) (*LabelResponse, error)

PostVariablesIDLabels calls the POST on /variables/{variableID}/labels Add a label to a variable

func (*Client) PutChecksID 

func (c *Client) PutChecksID(ctx context.Context, params *PutChecksIDAllParams) (Check, error)

PutChecksID calls the PUT on /checks/{checkID} Update a check

func (*Client) PutDashboardsIDCells 

func (c *Client) PutDashboardsIDCells(ctx context.Context, params *PutDashboardsIDCellsAllParams) (*Dashboard, error)

PutDashboardsIDCells calls the PUT on /dashboards/{dashboardID}/cells Replace cells in a dashboard

func (*Client) PutMePassword 

func (c *Client) PutMePassword(ctx context.Context, params *PutMePasswordAllParams) error

PutMePassword calls the PUT on /me/password Update a password

func (*Client) PutNotificationEndpointsID 

func (c *Client) PutNotificationEndpointsID(ctx context.Context, params *PutNotificationEndpointsIDAllParams) (*NotificationEndpoint, error)

PutNotificationEndpointsID calls the PUT on /notificationEndpoints/{endpointID} Update a notification endpoint

func (*Client) PutNotificationRulesID 

func (c *Client) PutNotificationRulesID(ctx context.Context, params *PutNotificationRulesIDAllParams) (*NotificationRule, error)

PutNotificationRulesID calls the PUT on /notificationRules/{ruleID} Update a notification rule

func (*Client) PutTelegrafsID 

func (c *Client) PutTelegrafsID(ctx context.Context, params *PutTelegrafsIDAllParams) (*Telegraf, error)

PutTelegrafsID calls the PUT on /telegrafs/{telegrafID} Update a Telegraf configuration

func (*Client) PutVariablesID 

func (c *Client) PutVariablesID(ctx context.Context, params *PutVariablesIDAllParams) (*Variable, error)

PutVariablesID calls the PUT on /variables/{variableID} Replace a variable

func (*Client) ReadStack 

func (c *Client) ReadStack(ctx context.Context, params *ReadStackAllParams) (*Stack, error)

ReadStack calls the GET on /stacks/{stack_id} Retrieve a stack

func (*Client) UninstallStack 

func (c *Client) UninstallStack(ctx context.Context, params *UninstallStackAllParams) (*Stack, error)

UninstallStack calls the POST on /stacks/{stack_id}/uninstall Uninstall a stack

func (*Client) UpdateStack 

func (c *Client) UpdateStack(ctx context.Context, params *UpdateStackAllParams) (*Stack, error)

UpdateStack calls the PATCH on /stacks/{stack_id} Update a stack

type ColorMapping added in v2.8.0 

type ColorMapping struct {
	AdditionalProperties map[string]string `json:"-"`
}

A color mapping is an object that maps time series data to a UI color scheme to allow the UI to render graphs consistent colors across reloads.

func (ColorMapping) Get added in v2.8.0 

func (a ColorMapping) Get(fieldName string) (value string, found bool)

Getter for additional properties for ColorMapping. Returns the specified element and whether it was found

func (ColorMapping) MarshalJSON added in v2.8.0 

func (a ColorMapping) MarshalJSON() ([]byte, error)

Override default JSON handling for ColorMapping to handle AdditionalProperties

func (*ColorMapping) Set added in v2.8.0 

func (a *ColorMapping) Set(fieldName string, value string)

Setter for additional properties for ColorMapping

func (*ColorMapping) UnmarshalJSON added in v2.8.0 

func (a *ColorMapping) UnmarshalJSON(b []byte) error

Override default JSON handling for ColorMapping to handle AdditionalProperties

type ConditionalExpression 

type ConditionalExpression struct {
	Alternate  *Expression `json:"alternate,omitempty"`
	Consequent *Expression `json:"consequent,omitempty"`
	Test       *Expression `json:"test,omitempty"`

	// Type of AST node
	Type *NodeType `json:"type,omitempty"`
}

Selects one of two expressions, `Alternate` or `Consequent`, depending on a third boolean expression, `Test`

type Config added in v2.8.0 

type Config struct {
	Config *map[string]interface{} `json:"config,omitempty"`
}

Config defines model for Config.

type ConstantVariableProperties 

type ConstantVariableProperties struct {
	Type   *ConstantVariablePropertiesType `json:"type,omitempty"`
	Values *[]string                       `json:"values,omitempty"`
}

ConstantVariableProperties defines model for ConstantVariableProperties.

type ConstantVariablePropertiesType 

type ConstantVariablePropertiesType string

ConstantVariablePropertiesType defines model for ConstantVariableProperties.Type. 

const (
	ConstantVariablePropertiesTypeConstant ConstantVariablePropertiesType = "constant"
)

Defines values for ConstantVariablePropertiesType.

type CreateCell 

type CreateCell struct {
	H    *int32  `json:"h,omitempty"`
	Name *string `json:"name,omitempty"`

	// Makes a copy of the provided view.
	UsingView *string `json:"usingView,omitempty"`
	W         *int32  `json:"w,omitempty"`
	X         *int32  `json:"x,omitempty"`
	Y         *int32  `json:"y,omitempty"`
}

CreateCell defines model for CreateCell.

type CreateCheckAllParams added in v2.11.0 

type CreateCheckAllParams struct {
	Body CreateCheckJSONRequestBody
}

CreateCheckAllParams defines type for all parameters for CreateCheck.

type CreateCheckJSONBody 

type CreateCheckJSONBody Check

CreateCheckJSONBody defines parameters for CreateCheck.

type CreateCheckJSONRequestBody 

type CreateCheckJSONRequestBody CreateCheckJSONBody

CreateCheckJSONRequestBody defines body for CreateCheck for application/json ContentType.

type CreateDashboardRequest 

type CreateDashboardRequest struct {
	// The user-facing description of the dashboard.
	Description *string `json:"description,omitempty"`

	// The user-facing name of the dashboard.
	Name string `json:"name"`

	// The ID of the organization that owns the dashboard.
	OrgID string `json:"orgID"`
}

CreateDashboardRequest defines model for CreateDashboardRequest.

type CreateNotificationEndpointAllParams added in v2.11.0 

type CreateNotificationEndpointAllParams struct {
	Body CreateNotificationEndpointJSONRequestBody
}

CreateNotificationEndpointAllParams defines type for all parameters for CreateNotificationEndpoint.

type CreateNotificationEndpointJSONBody 

type CreateNotificationEndpointJSONBody PostNotificationEndpoint

CreateNotificationEndpointJSONBody defines parameters for CreateNotificationEndpoint.

type CreateNotificationEndpointJSONRequestBody 

type CreateNotificationEndpointJSONRequestBody CreateNotificationEndpointJSONBody

CreateNotificationEndpointJSONRequestBody defines body for CreateNotificationEndpoint for application/json ContentType.

type CreateNotificationRuleAllParams added in v2.11.0 

type CreateNotificationRuleAllParams struct {
	Body CreateNotificationRuleJSONRequestBody
}

CreateNotificationRuleAllParams defines type for all parameters for CreateNotificationRule.

type CreateNotificationRuleJSONBody 

type CreateNotificationRuleJSONBody PostNotificationRule

CreateNotificationRuleJSONBody defines parameters for CreateNotificationRule.

type CreateNotificationRuleJSONRequestBody 

type CreateNotificationRuleJSONRequestBody CreateNotificationRuleJSONBody

CreateNotificationRuleJSONRequestBody defines body for CreateNotificationRule for application/json ContentType.

type CreateStackAllParams added in v2.11.0 

type CreateStackAllParams struct {
	Body CreateStackJSONRequestBody
}

CreateStackAllParams defines type for all parameters for CreateStack.

type CreateStackJSONBody 

type CreateStackJSONBody struct {
	Description *string   `json:"description,omitempty"`
	Name        *string   `json:"name,omitempty"`
	OrgID       *string   `json:"orgID,omitempty"`
	Urls        *[]string `json:"urls,omitempty"`
}

CreateStackJSONBody defines parameters for CreateStack.

type CreateStackJSONRequestBody 

type CreateStackJSONRequestBody CreateStackJSONBody

CreateStackJSONRequestBody defines body for CreateStack for application/json ContentType.

type CustomCheck 

type CustomCheck struct {
	// Embedded struct due to allOf(#/components/schemas/CheckBase)
	CheckBase
}

CustomCheck defines model for CustomCheck.

func (CustomCheck) MarshalJSON added in v2.14.0 

func (c CustomCheck) MarshalJSON() ([]byte, error)

MarshalJSON implement json.Marshaler interface.

func (CustomCheck) Type 

func (c CustomCheck) Type() string

type CustomCheckType 

type CustomCheckType string

CustomCheckType defines model for CustomCheck.Type. 

const (
	CustomCheckTypeCustom CustomCheckType = "custom"
)

Defines values for CustomCheckType.

type DBRP 

type DBRP struct {
	// The ID of the bucket used as the target for the translation.
	BucketID string `json:"bucketID"`

	// InfluxDB v1 database
	Database string `json:"database"`

	// Mapping represents the default retention policy for the database specified.
	Default bool `json:"default"`

	// The ID of the DBRP mapping.
	Id string `json:"id"`

	// URI pointers for additional paged results.
	Links *Links `json:"links,omitempty"`

	// The ID of the organization.
	OrgID string `json:"orgID"`

	// InfluxDB v1 retention policy
	RetentionPolicy string `json:"retention_policy"`

	// Indicates an autogenerated, virtual mapping based on the bucket name. Currently only available in OSS.
	Virtual *bool `json:"virtual,omitempty"`
}

DBRP defines model for DBRP.

type DBRPCreate added in v2.5.0 

type DBRPCreate struct {
	// The ID of the bucket used as the target for the translation.
	BucketID string `json:"bucketID"`

	// InfluxDB v1 database
	Database string `json:"database"`

	// Mapping represents the default retention policy for the database specified.
	Default *bool `json:"default,omitempty"`

	// The name of the organization that owns this mapping.
	Org *string `json:"org,omitempty"`

	// The ID of the organization.
	OrgID *string `json:"orgID,omitempty"`

	// InfluxDB v1 retention policy
	RetentionPolicy string `json:"retention_policy"`
}

DBRPCreate defines model for DBRPCreate.

type DBRPGet added in v2.5.0 

type DBRPGet struct {
	Content *DBRP `json:"content,omitempty"`
}

DBRPGet defines model for DBRPGet.

type DBRPUpdate 

type DBRPUpdate struct {
	Default *bool `json:"default,omitempty"`

	// InfluxDB v1 retention policy
	RetentionPolicy *string `json:"retention_policy,omitempty"`
}

DBRPUpdate defines model for DBRPUpdate.

type DBRPs 

type DBRPs struct {
	Content *[]DBRP `json:"content,omitempty"`
}

DBRPs defines model for DBRPs.

type Dashboard 

type Dashboard struct {
	// Embedded struct due to allOf(#/components/schemas/CreateDashboardRequest)
	CreateDashboardRequest `yaml:",inline"`
	// Embedded fields due to inline allOf schema
	Cells  *Cells  `json:"cells,omitempty"`
	Id     *string `json:"id,omitempty"`
	Labels *Labels `json:"labels,omitempty"`
	Links  *struct {
		// URI of resource.
		Cells *Link `json:"cells,omitempty"`

		// URI of resource.
		Labels *Link `json:"labels,omitempty"`

		// URI of resource.
		Members *Link `json:"members,omitempty"`

		// URI of resource.
		Org *Link `json:"org,omitempty"`

		// URI of resource.
		Owners *Link `json:"owners,omitempty"`

		// URI of resource.
		Self *Link `json:"self,omitempty"`
	} `json:"links,omitempty"`
	Meta *struct {
		CreatedAt *time.Time `json:"createdAt,omitempty"`
		UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	} `json:"meta,omitempty"`
}

Dashboard defines model for Dashboard.

type DashboardColor 

type DashboardColor struct {
	// The hex number of the color
	Hex string `json:"hex"`

	// The unique ID of the view color.
	Id string `json:"id"`

	// The user-facing name of the hex color.
	Name string `json:"name"`

	// Type is how the color is used.
	Type DashboardColorType `json:"type"`

	// The data value mapped to this color.
	Value float32 `json:"value"`
}

Defines an encoding of data value into color space.

type DashboardColorType 

type DashboardColorType string

Type is how the color is used. 

const (
	DashboardColorTypeBackground DashboardColorType = "background"

	DashboardColorTypeMax DashboardColorType = "max"

	DashboardColorTypeMin DashboardColorType = "min"

	DashboardColorTypeScale DashboardColorType = "scale"

	DashboardColorTypeText DashboardColorType = "text"

	DashboardColorTypeThreshold DashboardColorType = "threshold"
)

Defines values for DashboardColorType.

type DashboardQuery 

type DashboardQuery struct {
	BuilderConfig *BuilderConfig `json:"builderConfig,omitempty"`
	EditMode      *QueryEditMode `json:"editMode,omitempty"`
	Name          *string        `json:"name,omitempty"`

	// The text of the Flux query.
	Text *string `json:"text,omitempty"`
}

DashboardQuery defines model for DashboardQuery.

type DashboardWithViewProperties 

type DashboardWithViewProperties struct {
	// Embedded struct due to allOf(#/components/schemas/CreateDashboardRequest)
	CreateDashboardRequest `yaml:",inline"`
	// Embedded fields due to inline allOf schema
	Cells  *CellsWithViewProperties `json:"cells,omitempty"`
	Id     *string                  `json:"id,omitempty"`
	Labels *Labels                  `json:"labels,omitempty"`
	Links  *struct {
		// URI of resource.
		Cells *Link `json:"cells,omitempty"`

		// URI of resource.
		Labels *Link `json:"labels,omitempty"`

		// URI of resource.
		Members *Link `json:"members,omitempty"`

		// URI of resource.
		Org *Link `json:"org,omitempty"`

		// URI of resource.
		Owners *Link `json:"owners,omitempty"`

		// URI of resource.
		Self *Link `json:"self,omitempty"`
	} `json:"links,omitempty"`
	Meta *struct {
		CreatedAt *time.Time `json:"createdAt,omitempty"`
		UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	} `json:"meta,omitempty"`
}

DashboardWithViewProperties defines model for DashboardWithViewProperties.

type Dashboards 

type Dashboards struct {
	Dashboards *[]Dashboard `json:"dashboards,omitempty"`

	// URI pointers for additional paged results.
	Links *Links `json:"links,omitempty"`
}

Dashboards defines model for Dashboards.

type DateTimeLiteral 

type DateTimeLiteral struct {
	// Type of AST node
	Type  *NodeType  `json:"type,omitempty"`
	Value *time.Time `json:"value,omitempty"`
}

Represents an instant in time with nanosecond precision in [RFC3339Nano date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339nano-timestamp).

type DeadmanCheck 

type DeadmanCheck struct {
	CheckBaseExtend
	// The state to record if check matches a criteria.
	Level *CheckStatusLevel `json:"level,omitempty"`

	// If only zero values reported since time, trigger an alert
	ReportZero *bool `json:"reportZero,omitempty"`

	// String duration for time that a series is considered stale and should not trigger deadman.
	StaleTime *string `json:"staleTime,omitempty"`

	// String duration before deadman triggers.
	TimeSince *string `json:"timeSince,omitempty"`
}

DeadmanCheck defines model for DeadmanCheck.

func (DeadmanCheck) MarshalJSON added in v2.14.0 

func (d DeadmanCheck) MarshalJSON() ([]byte, error)

MarshalJSON implement json.Marshaler interface.

func (DeadmanCheck) Type 

func (d DeadmanCheck) Type() string

type DeadmanCheckType 

type DeadmanCheckType string

DeadmanCheckType defines model for DeadmanCheck.Type. 

const (
	DeadmanCheckTypeDeadman DeadmanCheckType = "deadman"
)

Defines values for DeadmanCheckType.

type DecimalPlaces 

type DecimalPlaces struct {
	// The number of digits after decimal to display
	Digits *int32 `json:"digits,omitempty"`

	// Indicates whether decimal point setting should be enforced
	IsEnforced *bool `json:"isEnforced,omitempty"`
}

Indicates whether decimal places should be enforced, and how many digits it should show.

type DeleteAuthorizationsIDAllParams added in v2.11.0 

type DeleteAuthorizationsIDAllParams struct {
	DeleteAuthorizationsIDParams

	AuthID string
}

DeleteAuthorizationsIDAllParams defines type for all parameters for DeleteAuthorizationsID.

type DeleteAuthorizationsIDParams 

type DeleteAuthorizationsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteAuthorizationsIDParams defines parameters for DeleteAuthorizationsID.

type DeleteBucketsIDAllParams added in v2.11.0 

type DeleteBucketsIDAllParams struct {
	DeleteBucketsIDParams

	BucketID string
}

DeleteBucketsIDAllParams defines type for all parameters for DeleteBucketsID.

type DeleteBucketsIDLabelsIDAllParams added in v2.11.0 

type DeleteBucketsIDLabelsIDAllParams struct {
	DeleteBucketsIDLabelsIDParams

	BucketID string

	LabelID string
}

DeleteBucketsIDLabelsIDAllParams defines type for all parameters for DeleteBucketsIDLabelsID.

type DeleteBucketsIDLabelsIDParams 

type DeleteBucketsIDLabelsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteBucketsIDLabelsIDParams defines parameters for DeleteBucketsIDLabelsID.

type DeleteBucketsIDMembersIDAllParams added in v2.11.0 

type DeleteBucketsIDMembersIDAllParams struct {
	DeleteBucketsIDMembersIDParams

	BucketID string

	UserID string
}

DeleteBucketsIDMembersIDAllParams defines type for all parameters for DeleteBucketsIDMembersID.

type DeleteBucketsIDMembersIDParams 

type DeleteBucketsIDMembersIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteBucketsIDMembersIDParams defines parameters for DeleteBucketsIDMembersID.

type DeleteBucketsIDOwnersIDAllParams added in v2.11.0 

type DeleteBucketsIDOwnersIDAllParams struct {
	DeleteBucketsIDOwnersIDParams

	BucketID string

	UserID string
}

DeleteBucketsIDOwnersIDAllParams defines type for all parameters for DeleteBucketsIDOwnersID.

type DeleteBucketsIDOwnersIDParams 

type DeleteBucketsIDOwnersIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteBucketsIDOwnersIDParams defines parameters for DeleteBucketsIDOwnersID.

type DeleteBucketsIDParams 

type DeleteBucketsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteBucketsIDParams defines parameters for DeleteBucketsID.

type DeleteChecksIDAllParams added in v2.11.0 

type DeleteChecksIDAllParams struct {
	DeleteChecksIDParams

	CheckID string
}

DeleteChecksIDAllParams defines type for all parameters for DeleteChecksID.

type DeleteChecksIDLabelsIDAllParams added in v2.11.0 

type DeleteChecksIDLabelsIDAllParams struct {
	DeleteChecksIDLabelsIDParams

	CheckID string

	LabelID string
}

DeleteChecksIDLabelsIDAllParams defines type for all parameters for DeleteChecksIDLabelsID.

type DeleteChecksIDLabelsIDParams 

type DeleteChecksIDLabelsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteChecksIDLabelsIDParams defines parameters for DeleteChecksIDLabelsID.

type DeleteChecksIDParams 

type DeleteChecksIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteChecksIDParams defines parameters for DeleteChecksID.

type DeleteDBRPIDAllParams added in v2.11.0 

type DeleteDBRPIDAllParams struct {
	DeleteDBRPIDParams

	DbrpID string
}

DeleteDBRPIDAllParams defines type for all parameters for DeleteDBRPID.

type DeleteDBRPIDParams 

type DeleteDBRPIDParams struct {
	// Specifies the organization ID of the mapping
	OrgID *string `json:"orgID,omitempty"`

	// Specifies the organization name of the mapping
	Org *string `json:"org,omitempty"`

	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteDBRPIDParams defines parameters for DeleteDBRPID.

type DeleteDashboardsIDAllParams added in v2.11.0 

type DeleteDashboardsIDAllParams struct {
	DeleteDashboardsIDParams

	DashboardID string
}

DeleteDashboardsIDAllParams defines type for all parameters for DeleteDashboardsID.

type DeleteDashboardsIDCellsIDAllParams added in v2.11.0 

type DeleteDashboardsIDCellsIDAllParams struct {
	DeleteDashboardsIDCellsIDParams

	DashboardID string

	CellID string
}

DeleteDashboardsIDCellsIDAllParams defines type for all parameters for DeleteDashboardsIDCellsID.

type DeleteDashboardsIDCellsIDParams 

type DeleteDashboardsIDCellsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteDashboardsIDCellsIDParams defines parameters for DeleteDashboardsIDCellsID.

type DeleteDashboardsIDLabelsIDAllParams added in v2.11.0 

type DeleteDashboardsIDLabelsIDAllParams struct {
	DeleteDashboardsIDLabelsIDParams

	DashboardID string

	LabelID string
}

DeleteDashboardsIDLabelsIDAllParams defines type for all parameters for DeleteDashboardsIDLabelsID.

type DeleteDashboardsIDLabelsIDParams 

type DeleteDashboardsIDLabelsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteDashboardsIDLabelsIDParams defines parameters for DeleteDashboardsIDLabelsID.

type DeleteDashboardsIDMembersIDAllParams added in v2.11.0 

type DeleteDashboardsIDMembersIDAllParams struct {
	DeleteDashboardsIDMembersIDParams

	DashboardID string

	UserID string
}

DeleteDashboardsIDMembersIDAllParams defines type for all parameters for DeleteDashboardsIDMembersID.

type DeleteDashboardsIDMembersIDParams 

type DeleteDashboardsIDMembersIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteDashboardsIDMembersIDParams defines parameters for DeleteDashboardsIDMembersID.

type DeleteDashboardsIDOwnersIDAllParams added in v2.11.0 

type DeleteDashboardsIDOwnersIDAllParams struct {
	DeleteDashboardsIDOwnersIDParams

	DashboardID string

	UserID string
}

DeleteDashboardsIDOwnersIDAllParams defines type for all parameters for DeleteDashboardsIDOwnersID.

type DeleteDashboardsIDOwnersIDParams 

type DeleteDashboardsIDOwnersIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteDashboardsIDOwnersIDParams defines parameters for DeleteDashboardsIDOwnersID.

type DeleteDashboardsIDParams 

type DeleteDashboardsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteDashboardsIDParams defines parameters for DeleteDashboardsID.

type DeleteLabelsIDAllParams added in v2.11.0 

type DeleteLabelsIDAllParams struct {
	DeleteLabelsIDParams

	LabelID string
}

DeleteLabelsIDAllParams defines type for all parameters for DeleteLabelsID.

type DeleteLabelsIDParams 

type DeleteLabelsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteLabelsIDParams defines parameters for DeleteLabelsID.

type DeleteNotificationEndpointsIDAllParams added in v2.11.0 

type DeleteNotificationEndpointsIDAllParams struct {
	DeleteNotificationEndpointsIDParams

	EndpointID string
}

DeleteNotificationEndpointsIDAllParams defines type for all parameters for DeleteNotificationEndpointsID.

type DeleteNotificationEndpointsIDLabelsIDAllParams added in v2.11.0 

type DeleteNotificationEndpointsIDLabelsIDAllParams struct {
	DeleteNotificationEndpointsIDLabelsIDParams

	EndpointID string

	LabelID string
}

DeleteNotificationEndpointsIDLabelsIDAllParams defines type for all parameters for DeleteNotificationEndpointsIDLabelsID.

type DeleteNotificationEndpointsIDLabelsIDParams 

type DeleteNotificationEndpointsIDLabelsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteNotificationEndpointsIDLabelsIDParams defines parameters for DeleteNotificationEndpointsIDLabelsID.

type DeleteNotificationEndpointsIDParams 

type DeleteNotificationEndpointsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteNotificationEndpointsIDParams defines parameters for DeleteNotificationEndpointsID.

type DeleteNotificationRulesIDAllParams added in v2.11.0 

type DeleteNotificationRulesIDAllParams struct {
	DeleteNotificationRulesIDParams

	RuleID string
}

DeleteNotificationRulesIDAllParams defines type for all parameters for DeleteNotificationRulesID.

type DeleteNotificationRulesIDLabelsIDAllParams added in v2.11.0 

type DeleteNotificationRulesIDLabelsIDAllParams struct {
	DeleteNotificationRulesIDLabelsIDParams

	RuleID string

	LabelID string
}

DeleteNotificationRulesIDLabelsIDAllParams defines type for all parameters for DeleteNotificationRulesIDLabelsID.

type DeleteNotificationRulesIDLabelsIDParams 

type DeleteNotificationRulesIDLabelsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteNotificationRulesIDLabelsIDParams defines parameters for DeleteNotificationRulesIDLabelsID.

type DeleteNotificationRulesIDParams 

type DeleteNotificationRulesIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteNotificationRulesIDParams defines parameters for DeleteNotificationRulesID.

type DeleteOrgsIDAllParams added in v2.11.0 

type DeleteOrgsIDAllParams struct {
	DeleteOrgsIDParams

	OrgID string
}

DeleteOrgsIDAllParams defines type for all parameters for DeleteOrgsID.

type DeleteOrgsIDMembersIDAllParams added in v2.11.0 

type DeleteOrgsIDMembersIDAllParams struct {
	DeleteOrgsIDMembersIDParams

	OrgID string

	UserID string
}

DeleteOrgsIDMembersIDAllParams defines type for all parameters for DeleteOrgsIDMembersID.

type DeleteOrgsIDMembersIDParams 

type DeleteOrgsIDMembersIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteOrgsIDMembersIDParams defines parameters for DeleteOrgsIDMembersID.

type DeleteOrgsIDOwnersIDAllParams added in v2.11.0 

type DeleteOrgsIDOwnersIDAllParams struct {
	DeleteOrgsIDOwnersIDParams

	OrgID string

	UserID string
}

DeleteOrgsIDOwnersIDAllParams defines type for all parameters for DeleteOrgsIDOwnersID.

type DeleteOrgsIDOwnersIDParams 

type DeleteOrgsIDOwnersIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteOrgsIDOwnersIDParams defines parameters for DeleteOrgsIDOwnersID.

type DeleteOrgsIDParams 

type DeleteOrgsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteOrgsIDParams defines parameters for DeleteOrgsID.

type DeleteOrgsIDSecretsIDAllParams added in v2.11.0 

type DeleteOrgsIDSecretsIDAllParams struct {
	DeleteOrgsIDSecretsIDParams

	OrgID string

	SecretID string
}

DeleteOrgsIDSecretsIDAllParams defines type for all parameters for DeleteOrgsIDSecretsID.

type DeleteOrgsIDSecretsIDParams added in v2.6.0 

type DeleteOrgsIDSecretsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteOrgsIDSecretsIDParams defines parameters for DeleteOrgsIDSecretsID.

type DeletePredicateRequest 

type DeletePredicateRequest struct {
	// An expression in [delete predicate syntax](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/delete-predicate/).
	Predicate *string `json:"predicate,omitempty"`

	// A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)).
	// The earliest time to delete from.
	Start time.Time `json:"start"`

	// A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)).
	// The latest time to delete from.
	Stop time.Time `json:"stop"`
}

The delete predicate request.

type DeleteRemoteConnectionByIDAllParams added in v2.11.0 

type DeleteRemoteConnectionByIDAllParams struct {
	DeleteRemoteConnectionByIDParams

	RemoteID string
}

DeleteRemoteConnectionByIDAllParams defines type for all parameters for DeleteRemoteConnectionByID.

type DeleteRemoteConnectionByIDParams added in v2.8.0 

type DeleteRemoteConnectionByIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteRemoteConnectionByIDParams defines parameters for DeleteRemoteConnectionByID.

type DeleteReplicationByIDAllParams added in v2.11.0 

type DeleteReplicationByIDAllParams struct {
	DeleteReplicationByIDParams

	ReplicationID string
}

DeleteReplicationByIDAllParams defines type for all parameters for DeleteReplicationByID.

type DeleteReplicationByIDParams added in v2.8.0 

type DeleteReplicationByIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteReplicationByIDParams defines parameters for DeleteReplicationByID.

type DeleteScrapersIDAllParams added in v2.11.0 

type DeleteScrapersIDAllParams struct {
	DeleteScrapersIDParams

	ScraperTargetID string
}

DeleteScrapersIDAllParams defines type for all parameters for DeleteScrapersID.

type DeleteScrapersIDLabelsIDAllParams added in v2.11.0 

type DeleteScrapersIDLabelsIDAllParams struct {
	DeleteScrapersIDLabelsIDParams

	ScraperTargetID string

	LabelID string
}

DeleteScrapersIDLabelsIDAllParams defines type for all parameters for DeleteScrapersIDLabelsID.

type DeleteScrapersIDLabelsIDParams 

type DeleteScrapersIDLabelsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteScrapersIDLabelsIDParams defines parameters for DeleteScrapersIDLabelsID.

type DeleteScrapersIDMembersIDAllParams added in v2.11.0 

type DeleteScrapersIDMembersIDAllParams struct {
	DeleteScrapersIDMembersIDParams

	ScraperTargetID string

	UserID string
}

DeleteScrapersIDMembersIDAllParams defines type for all parameters for DeleteScrapersIDMembersID.

type DeleteScrapersIDMembersIDParams 

type DeleteScrapersIDMembersIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteScrapersIDMembersIDParams defines parameters for DeleteScrapersIDMembersID.

type DeleteScrapersIDOwnersIDAllParams added in v2.11.0 

type DeleteScrapersIDOwnersIDAllParams struct {
	DeleteScrapersIDOwnersIDParams

	ScraperTargetID string

	UserID string
}

DeleteScrapersIDOwnersIDAllParams defines type for all parameters for DeleteScrapersIDOwnersID.

type DeleteScrapersIDOwnersIDParams 

type DeleteScrapersIDOwnersIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteScrapersIDOwnersIDParams defines parameters for DeleteScrapersIDOwnersID.

type DeleteScrapersIDParams 

type DeleteScrapersIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteScrapersIDParams defines parameters for DeleteScrapersID.

type DeleteSourcesIDAllParams added in v2.11.0 

type DeleteSourcesIDAllParams struct {
	DeleteSourcesIDParams

	SourceID string
}

DeleteSourcesIDAllParams defines type for all parameters for DeleteSourcesID.

type DeleteSourcesIDParams 

type DeleteSourcesIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteSourcesIDParams defines parameters for DeleteSourcesID.

type DeleteStackAllParams added in v2.11.0 

type DeleteStackAllParams struct {
	DeleteStackParams

	StackId string
}

DeleteStackAllParams defines type for all parameters for DeleteStack.

type DeleteStackParams 

type DeleteStackParams struct {
	// The identifier of the organization.
	OrgID string `json:"orgID"`
}

DeleteStackParams defines parameters for DeleteStack.

type DeleteTasksIDAllParams added in v2.11.0 

type DeleteTasksIDAllParams struct {
	DeleteTasksIDParams

	TaskID string
}

DeleteTasksIDAllParams defines type for all parameters for DeleteTasksID.

type DeleteTasksIDLabelsIDAllParams added in v2.11.0 

type DeleteTasksIDLabelsIDAllParams struct {
	DeleteTasksIDLabelsIDParams

	TaskID string

	LabelID string
}

DeleteTasksIDLabelsIDAllParams defines type for all parameters for DeleteTasksIDLabelsID.

type DeleteTasksIDLabelsIDParams 

type DeleteTasksIDLabelsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteTasksIDLabelsIDParams defines parameters for DeleteTasksIDLabelsID.

type DeleteTasksIDMembersIDAllParams added in v2.11.0 

type DeleteTasksIDMembersIDAllParams struct {
	DeleteTasksIDMembersIDParams

	TaskID string

	UserID string
}

DeleteTasksIDMembersIDAllParams defines type for all parameters for DeleteTasksIDMembersID.

type DeleteTasksIDMembersIDParams 

type DeleteTasksIDMembersIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteTasksIDMembersIDParams defines parameters for DeleteTasksIDMembersID.

type DeleteTasksIDOwnersIDAllParams added in v2.11.0 

type DeleteTasksIDOwnersIDAllParams struct {
	DeleteTasksIDOwnersIDParams

	TaskID string

	UserID string
}

DeleteTasksIDOwnersIDAllParams defines type for all parameters for DeleteTasksIDOwnersID.

type DeleteTasksIDOwnersIDParams 

type DeleteTasksIDOwnersIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteTasksIDOwnersIDParams defines parameters for DeleteTasksIDOwnersID.

type DeleteTasksIDParams 

type DeleteTasksIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteTasksIDParams defines parameters for DeleteTasksID.

type DeleteTasksIDRunsIDAllParams added in v2.11.0 

type DeleteTasksIDRunsIDAllParams struct {
	DeleteTasksIDRunsIDParams

	TaskID string

	RunID string
}

DeleteTasksIDRunsIDAllParams defines type for all parameters for DeleteTasksIDRunsID.

type DeleteTasksIDRunsIDParams 

type DeleteTasksIDRunsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteTasksIDRunsIDParams defines parameters for DeleteTasksIDRunsID.

type DeleteTelegrafsIDAllParams added in v2.11.0 

type DeleteTelegrafsIDAllParams struct {
	DeleteTelegrafsIDParams

	TelegrafID string
}

DeleteTelegrafsIDAllParams defines type for all parameters for DeleteTelegrafsID.

type DeleteTelegrafsIDLabelsIDAllParams added in v2.11.0 

type DeleteTelegrafsIDLabelsIDAllParams struct {
	DeleteTelegrafsIDLabelsIDParams

	TelegrafID string

	LabelID string
}

DeleteTelegrafsIDLabelsIDAllParams defines type for all parameters for DeleteTelegrafsIDLabelsID.

type DeleteTelegrafsIDLabelsIDParams 

type DeleteTelegrafsIDLabelsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteTelegrafsIDLabelsIDParams defines parameters for DeleteTelegrafsIDLabelsID.

type DeleteTelegrafsIDMembersIDAllParams added in v2.11.0 

type DeleteTelegrafsIDMembersIDAllParams struct {
	DeleteTelegrafsIDMembersIDParams

	TelegrafID string

	UserID string
}

DeleteTelegrafsIDMembersIDAllParams defines type for all parameters for DeleteTelegrafsIDMembersID.

type DeleteTelegrafsIDMembersIDParams 

type DeleteTelegrafsIDMembersIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteTelegrafsIDMembersIDParams defines parameters for DeleteTelegrafsIDMembersID.

type DeleteTelegrafsIDOwnersIDAllParams added in v2.11.0 

type DeleteTelegrafsIDOwnersIDAllParams struct {
	DeleteTelegrafsIDOwnersIDParams

	TelegrafID string

	UserID string
}

DeleteTelegrafsIDOwnersIDAllParams defines type for all parameters for DeleteTelegrafsIDOwnersID.

type DeleteTelegrafsIDOwnersIDParams 

type DeleteTelegrafsIDOwnersIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteTelegrafsIDOwnersIDParams defines parameters for DeleteTelegrafsIDOwnersID.

type DeleteTelegrafsIDParams 

type DeleteTelegrafsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteTelegrafsIDParams defines parameters for DeleteTelegrafsID.

type DeleteUsersIDAllParams added in v2.11.0 

type DeleteUsersIDAllParams struct {
	DeleteUsersIDParams

	UserID string
}

DeleteUsersIDAllParams defines type for all parameters for DeleteUsersID.

type DeleteUsersIDParams 

type DeleteUsersIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteUsersIDParams defines parameters for DeleteUsersID.

type DeleteVariablesIDAllParams added in v2.11.0 

type DeleteVariablesIDAllParams struct {
	DeleteVariablesIDParams

	VariableID string
}

DeleteVariablesIDAllParams defines type for all parameters for DeleteVariablesID.

type DeleteVariablesIDLabelsIDAllParams added in v2.11.0 

type DeleteVariablesIDLabelsIDAllParams struct {
	DeleteVariablesIDLabelsIDParams

	VariableID string

	LabelID string
}

DeleteVariablesIDLabelsIDAllParams defines type for all parameters for DeleteVariablesIDLabelsID.

type DeleteVariablesIDLabelsIDParams 

type DeleteVariablesIDLabelsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteVariablesIDLabelsIDParams defines parameters for DeleteVariablesIDLabelsID.

type DeleteVariablesIDParams 

type DeleteVariablesIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

DeleteVariablesIDParams defines parameters for DeleteVariablesID.

type Descending 

type Descending bool

Descending defines model for Descending.

type Dialect 

type Dialect struct {
	// Annotation rows to include in the results.
	// An _annotation_ is metadata associated with an object (column) in the data model.
	//
	// #### Related guides
	//
	// - See [Annotated CSV annotations](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/annotated-csv/#annotations) for examples and more information.
	//
	// For more information about **annotations** in tabular data,
	// see [W3 metadata vocabulary for tabular data](https://www.w3.org/TR/2015/REC-tabular-data-model-20151217/#columns).
	Annotations *[]DialectAnnotations `json:"annotations,omitempty"`

	// The character prefixed to comment strings. Default is a number sign (`#`).
	CommentPrefix *string `json:"commentPrefix,omitempty"`

	// The format for timestamps in results.
	// Default is [`RFC3339` date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp).
	// To include nanoseconds in timestamps, use `RFC3339Nano`.
	//
	// #### Example formatted date/time values
	//
	// | Format      | Value                       |
	// |:------------|:----------------------------|
	// | `RFC3339`    | `"2006-01-02T15:04:05Z07:00"` |
	// | `RFC3339Nano` | `"2006-01-02T15:04:05.999999999Z07:00"` |
	DateTimeFormat *DialectDateTimeFormat `json:"dateTimeFormat,omitempty"`

	// The separator used between cells. Default is a comma (`,`).
	Delimiter *string `json:"delimiter,omitempty"`

	// If true, the results contain a header row.
	Header *bool `json:"header,omitempty"`
}

Options for tabular data output. Default output is [annotated CSV](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/annotated-csv/#csv-response-format) with headers.

For more information about tabular data **dialect**, see [W3 metadata vocabulary for tabular data](https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions).

type DialectAnnotations 

type DialectAnnotations string

DialectAnnotations defines model for Dialect.Annotations. 

const (
	DialectAnnotationsDatatype DialectAnnotations = "datatype"

	DialectAnnotationsDefault DialectAnnotations = "default"

	DialectAnnotationsGroup DialectAnnotations = "group"
)

Defines values for DialectAnnotations.

type DialectDateTimeFormat 

type DialectDateTimeFormat string

The format for timestamps in results. Default is [`RFC3339` date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp). To include nanoseconds in timestamps, use `RFC3339Nano`.

#### Example formatted date/time values

| Format | Value | |:------------|:----------------------------| | `RFC3339` | `"2006-01-02T15:04:05Z07:00"` | | `RFC3339Nano` | `"2006-01-02T15:04:05.999999999Z07:00"` | 

const (
	DialectDateTimeFormatRFC3339 DialectDateTimeFormat = "RFC3339"

	DialectDateTimeFormatRFC3339Nano DialectDateTimeFormat = "RFC3339Nano"
)

Defines values for DialectDateTimeFormat.

type DictExpression added in v2.3.0 

type DictExpression struct {
	// Elements of the dictionary
	Elements *[]DictItem `json:"elements,omitempty"`

	// Type of AST node
	Type *NodeType `json:"type,omitempty"`
}

Used to create and directly specify the elements of a dictionary

type DictItem added in v2.3.0 

type DictItem struct {
	Key *Expression `json:"key,omitempty"`

	// Type of AST node
	Type *NodeType   `json:"type,omitempty"`
	Val  *Expression `json:"val,omitempty"`
}

A key-value pair in a dictionary.

type Duration 

type Duration struct {
	Magnitude *int `json:"magnitude,omitempty"`

	// Type of AST node
	Type *NodeType `json:"type,omitempty"`
	Unit *string   `json:"unit,omitempty"`
}

A pair consisting of length of time and the unit of time measured. It is the atomic unit from which all duration literals are composed.

type DurationLiteral 

type DurationLiteral struct {
	// Type of AST node
	Type *NodeType `json:"type,omitempty"`

	// Duration values
	Values *[]Duration `json:"values,omitempty"`
}

Represents the elapsed time between two instants as an int64 nanosecond count with syntax of golang's time.Duration

type Error 

type Error struct {
	// code is the machine-readable error code.
	Code ErrorCode `json:"code"`

	// Stack of errors that occurred during processing of the request. Useful for debugging.
	Err *string `json:"err,omitempty"`

	// Human-readable message.
	Message *string `json:"message,omitempty"`

	// Describes the logical code operation when the error occurred. Useful for debugging.
	Op *string `json:"op,omitempty"`
}

Error defines model for Error.

func (*Error) Error added in v2.11.0 

func (e *Error) Error() error

type ErrorCode 

type ErrorCode string

code is the machine-readable error code. 

const (
	ErrorCodeConflict ErrorCode = "conflict"

	ErrorCodeEmptyValue ErrorCode = "empty value"

	ErrorCodeForbidden ErrorCode = "forbidden"

	ErrorCodeInternalError ErrorCode = "internal error"

	ErrorCodeInvalid ErrorCode = "invalid"

	ErrorCodeMethodNotAllowed ErrorCode = "method not allowed"

	ErrorCodeNotFound ErrorCode = "not found"

	ErrorCodeRequestTooLarge ErrorCode = "request too large"

	ErrorCodeTooManyRequests ErrorCode = "too many requests"

	ErrorCodeUnauthorized ErrorCode = "unauthorized"

	ErrorCodeUnavailable ErrorCode = "unavailable"

	ErrorCodeUnprocessableEntity ErrorCode = "unprocessable entity"

	ErrorCodeUnsupportedMediaType ErrorCode = "unsupported media type"
)

Defines values for ErrorCode.

type ExportTemplateAllParams added in v2.11.0 

type ExportTemplateAllParams struct {
	Body ExportTemplateJSONRequestBody
}

ExportTemplateAllParams defines type for all parameters for ExportTemplate.

type ExportTemplateJSONBody 

type ExportTemplateJSONBody interface{}

ExportTemplateJSONBody defines parameters for ExportTemplate.

type ExportTemplateJSONRequestBody 

type ExportTemplateJSONRequestBody ExportTemplateJSONBody

ExportTemplateJSONRequestBody defines body for ExportTemplate for application/json ContentType.

type Expression 

type Expression interface{}

Expression defines model for Expression.

type ExpressionStatement 

type ExpressionStatement struct {
	Expression *Expression `json:"expression,omitempty"`

	// Type of AST node
	Type *NodeType `json:"type,omitempty"`
}

May consist of an expression that doesn't return a value and is executed solely for its side-effects

type Field 

type Field struct {
	// Alias overrides the field name in the returned response.  Applies only if type is `func`
	Alias *string `json:"alias,omitempty"`

	// Args are the arguments to the function
	Args *[]Field `json:"args,omitempty"`

	// `type` describes the field type. `func` is a function. `field` is a field reference.
	Type *FieldType `json:"type,omitempty"`

	// value is the value of the field.  Meaning of the value is implied by the `type` key
	Value *string `json:"value,omitempty"`
}

Field defines model for Field.

type FieldType 

type FieldType string

`type` describes the field type. `func` is a function. `field` is a field reference. 

const (
	FieldTypeField FieldType = "field"

	FieldTypeFunc FieldType = "func"

	FieldTypeInteger FieldType = "integer"

	FieldTypeNumber FieldType = "number"

	FieldTypeRegex FieldType = "regex"

	FieldTypeWildcard FieldType = "wildcard"
)

Defines values for FieldType.

type File 

type File struct {
	// List of Flux statements
	Body *[]Statement `json:"body,omitempty"`

	// A list of package imports
	Imports *[]ImportDeclaration `json:"imports,omitempty"`

	// The name of the file.
	Name *string `json:"name,omitempty"`

	// Defines a package identifier
	Package *PackageClause `json:"package,omitempty"`

	// Type of AST node
	Type *NodeType `json:"type,omitempty"`
}

Represents a source from a single file

type Flags 

type Flags struct {
	AdditionalProperties map[string]interface{} `json:"-"`
}

Flags defines model for Flags.

func (Flags) Get 

func (a Flags) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for Flags. Returns the specified element and whether it was found

func (Flags) MarshalJSON 

func (a Flags) MarshalJSON() ([]byte, error)

Override default JSON handling for Flags to handle AdditionalProperties

func (*Flags) Set 

func (a *Flags) Set(fieldName string, value interface{})

Setter for additional properties for Flags

func (*Flags) UnmarshalJSON 

func (a *Flags) UnmarshalJSON(b []byte) error

Override default JSON handling for Flags to handle AdditionalProperties

type FloatLiteral 

type FloatLiteral struct {
	// Type of AST node
	Type  *NodeType `json:"type,omitempty"`
	Value *float32  `json:"value,omitempty"`
}

Represents floating point numbers according to the double representations defined by the IEEE-754-1985

type FluxResponse 

type FluxResponse struct {
	Flux *string `json:"flux,omitempty"`
}

Rendered flux that backs the check or notification.

type FluxSuggestion 

type FluxSuggestion struct {
	Name   *string                `json:"name,omitempty"`
	Params *FluxSuggestion_Params `json:"params,omitempty"`
}

FluxSuggestion defines model for FluxSuggestion.

type FluxSuggestion_Params 

type FluxSuggestion_Params struct {
	AdditionalProperties map[string]string `json:"-"`
}

FluxSuggestion_Params defines model for FluxSuggestion.Params.

func (FluxSuggestion_Params) Get 

func (a FluxSuggestion_Params) Get(fieldName string) (value string, found bool)

Getter for additional properties for FluxSuggestion_Params. Returns the specified element and whether it was found

func (FluxSuggestion_Params) MarshalJSON 

func (a FluxSuggestion_Params) MarshalJSON() ([]byte, error)

Override default JSON handling for FluxSuggestion_Params to handle AdditionalProperties

func (*FluxSuggestion_Params) Set 

func (a *FluxSuggestion_Params) Set(fieldName string, value string)

Setter for additional properties for FluxSuggestion_Params

func (*FluxSuggestion_Params) UnmarshalJSON 

func (a *FluxSuggestion_Params) UnmarshalJSON(b []byte) error

Override default JSON handling for FluxSuggestion_Params to handle AdditionalProperties

type FluxSuggestions 

type FluxSuggestions struct {
	Funcs *[]FluxSuggestion `json:"funcs,omitempty"`
}

FluxSuggestions defines model for FluxSuggestions.

type FunctionExpression 

type FunctionExpression struct {
	Body *Node `json:"body,omitempty"`

	// Function parameters
	Params *[]Property `json:"params,omitempty"`

	// Type of AST node
	Type *NodeType `json:"type,omitempty"`
}

Function expression

type GaugeViewProperties 

type GaugeViewProperties struct {
	// Colors define color encoding of data into a visualization
	Colors []DashboardColor `json:"colors"`

	// Indicates whether decimal places should be enforced, and how many digits it should show.
	DecimalPlaces DecimalPlaces            `json:"decimalPlaces"`
	Note          string                   `json:"note"`
	Prefix        string                   `json:"prefix"`
	Queries       []DashboardQuery         `json:"queries"`
	Shape         GaugeViewPropertiesShape `json:"shape"`

	// If true, will display note when empty
	ShowNoteWhenEmpty bool                    `json:"showNoteWhenEmpty"`
	Suffix            string                  `json:"suffix"`
	TickPrefix        string                  `json:"tickPrefix"`
	TickSuffix        string                  `json:"tickSuffix"`
	Type              GaugeViewPropertiesType `json:"type"`
}

GaugeViewProperties defines model for GaugeViewProperties.

type GaugeViewPropertiesShape 

type GaugeViewPropertiesShape string

GaugeViewPropertiesShape defines model for GaugeViewProperties.Shape. 

const (
	GaugeViewPropertiesShapeChronografV2 GaugeViewPropertiesShape = "chronograf-v2"
)

Defines values for GaugeViewPropertiesShape.

type GaugeViewPropertiesType 

type GaugeViewPropertiesType string

GaugeViewPropertiesType defines model for GaugeViewProperties.Type. 

const (
	GaugeViewPropertiesTypeGauge GaugeViewPropertiesType = "gauge"
)

Defines values for GaugeViewPropertiesType.

type GeneralServerError added in v2.11.0 

type GeneralServerError Error

GeneralServerError defines model for GeneralServerError.

type GeoCircleViewLayer added in v2.3.0 

type GeoCircleViewLayer struct {
	// Embedded struct due to allOf(#/components/schemas/GeoViewLayerProperties)
	GeoViewLayerProperties `yaml:",inline"`
	// Embedded fields due to inline allOf schema
	// Axis used in a visualization.
	ColorDimension Axis `json:"colorDimension"`

	// Circle color field
	ColorField string `json:"colorField"`

	// Colors define color encoding of data into a visualization
	Colors []DashboardColor `json:"colors"`

	// Interpolate circle color based on displayed value
	InterpolateColors *bool `json:"interpolateColors,omitempty"`

	// Maximum radius size in pixels
	Radius *int `json:"radius,omitempty"`

	// Axis used in a visualization.
	RadiusDimension Axis `json:"radiusDimension"`

	// Radius field
	RadiusField string `json:"radiusField"`
}

GeoCircleViewLayer defines model for GeoCircleViewLayer.

type GeoHeatMapViewLayer added in v2.3.0 

type GeoHeatMapViewLayer struct {
	// Embedded struct due to allOf(#/components/schemas/GeoViewLayerProperties)
	GeoViewLayerProperties `yaml:",inline"`
	// Embedded fields due to inline allOf schema
	// Blur for heatmap points
	Blur int `json:"blur"`

	// Colors define color encoding of data into a visualization
	Colors []DashboardColor `json:"colors"`

	// Axis used in a visualization.
	IntensityDimension Axis `json:"intensityDimension"`

	// Intensity field
	IntensityField string `json:"intensityField"`

	// Radius size in pixels
	Radius int `json:"radius"`
}

GeoHeatMapViewLayer defines model for GeoHeatMapViewLayer.

type GeoPointMapViewLayer added in v2.3.0 

type GeoPointMapViewLayer struct {
	// Embedded struct due to allOf(#/components/schemas/GeoViewLayerProperties)
	GeoViewLayerProperties `yaml:",inline"`
	// Embedded fields due to inline allOf schema
	// Axis used in a visualization.
	ColorDimension Axis `json:"colorDimension"`

	// Marker color field
	ColorField string `json:"colorField"`

	// Colors define color encoding of data into a visualization
	Colors []DashboardColor `json:"colors"`

	// Cluster close markers together
	IsClustered *bool `json:"isClustered,omitempty"`

	// An array for which columns to display in tooltip
	TooltipColumns *[]string `json:"tooltipColumns,omitempty"`
}

GeoPointMapViewLayer defines model for GeoPointMapViewLayer.

type GeoTrackMapViewLayer added in v2.3.0 

type GeoTrackMapViewLayer struct {
	// Embedded struct due to allOf(#/components/schemas/GeoViewLayerProperties)
	GeoViewLayerProperties `yaml:",inline"`
}

GeoTrackMapViewLayer defines model for GeoTrackMapViewLayer.

type GeoViewLayer added in v2.3.0 

type GeoViewLayer interface{}

GeoViewLayer defines model for GeoViewLayer.

type GeoViewLayerProperties added in v2.3.0 

type GeoViewLayerProperties struct {
	Type GeoViewLayerPropertiesType `json:"type"`
}

GeoViewLayerProperties defines model for GeoViewLayerProperties.

type GeoViewLayerPropertiesType added in v2.3.0 

type GeoViewLayerPropertiesType string

GeoViewLayerPropertiesType defines model for GeoViewLayerProperties.Type. 

const (
	GeoViewLayerPropertiesTypeCircleMap GeoViewLayerPropertiesType = "circleMap"

	GeoViewLayerPropertiesTypeHeatmap GeoViewLayerPropertiesType = "heatmap"

	GeoViewLayerPropertiesTypePointMap GeoViewLayerPropertiesType = "pointMap"

	GeoViewLayerPropertiesTypeTrackMap GeoViewLayerPropertiesType = "trackMap"
)

Defines values for GeoViewLayerPropertiesType.

type GeoViewProperties added in v2.3.0 

type GeoViewProperties struct {
	// If true, map zoom and pan controls are enabled on the dashboard view
	AllowPanAndZoom bool `json:"allowPanAndZoom"`

	// Coordinates of the center of the map
	Center struct {
		// Latitude of the center of the map
		Lat float64 `json:"lat"`

		// Longitude of the center of the map
		Lon float64 `json:"lon"`
	} `json:"center"`

	// Colors define color encoding of data into a visualization
	Colors *[]DashboardColor `json:"colors,omitempty"`

	// If true, search results get automatically regroupped so that lon,lat and value are treated as columns
	DetectCoordinateFields bool `json:"detectCoordinateFields"`

	// Object type to define lat/lon columns
	LatLonColumns *LatLonColumns `json:"latLonColumns,omitempty"`

	// List of individual layers shown in the map
	Layers []GeoViewLayer `json:"layers"`

	// Define map type - regular, satellite etc.
	MapStyle *string          `json:"mapStyle,omitempty"`
	Note     string           `json:"note"`
	Queries  []DashboardQuery `json:"queries"`

	// String to define the column
	S2Column *string                `json:"s2Column,omitempty"`
	Shape    GeoViewPropertiesShape `json:"shape"`

	// If true, will display note when empty
	ShowNoteWhenEmpty bool                  `json:"showNoteWhenEmpty"`
	Type              GeoViewPropertiesType `json:"type"`

	// If true, S2 column is used to calculate lat/lon
	UseS2CellID *bool `json:"useS2CellID,omitempty"`

	// Zoom level used for initial display of the map
	Zoom float64 `json:"zoom"`
}

GeoViewProperties defines model for GeoViewProperties.

type GeoViewPropertiesShape added in v2.3.0 

type GeoViewPropertiesShape string

GeoViewPropertiesShape defines model for GeoViewProperties.Shape. 

const (
	GeoViewPropertiesShapeChronografV2 GeoViewPropertiesShape = "chronograf-v2"
)

Defines values for GeoViewPropertiesShape.

type GeoViewPropertiesType added in v2.3.0 

type GeoViewPropertiesType string

GeoViewPropertiesType defines model for GeoViewProperties.Type. 

const (
	GeoViewPropertiesTypeGeo GeoViewPropertiesType = "geo"
)

Defines values for GeoViewPropertiesType.

type GetAuthorizationsIDAllParams added in v2.11.0 

type GetAuthorizationsIDAllParams struct {
	GetAuthorizationsIDParams

	AuthID string
}

GetAuthorizationsIDAllParams defines type for all parameters for GetAuthorizationsID.

type GetAuthorizationsIDParams 

type GetAuthorizationsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetAuthorizationsIDParams defines parameters for GetAuthorizationsID.

type GetAuthorizationsParams 

type GetAuthorizationsParams struct {
	// A user ID.
	// Only returns authorizations scoped to this user.
	UserID *string `json:"userID,omitempty"`

	// A user name.
	// Only returns authorizations scoped to this user.
	User *string `json:"user,omitempty"`

	// An organization ID. Only returns authorizations that belong to this organization.
	OrgID *string `json:"orgID,omitempty"`

	// An organization name.
	// Only returns authorizations that belong to this organization.
	Org *string `json:"org,omitempty"`

	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetAuthorizationsParams defines parameters for GetAuthorizations.

type GetBucketsIDAllParams added in v2.11.0 

type GetBucketsIDAllParams struct {
	GetBucketsIDParams

	BucketID string
}

GetBucketsIDAllParams defines type for all parameters for GetBucketsID.

type GetBucketsIDLabelsAllParams added in v2.11.0 

type GetBucketsIDLabelsAllParams struct {
	GetBucketsIDLabelsParams

	BucketID string
}

GetBucketsIDLabelsAllParams defines type for all parameters for GetBucketsIDLabels.

type GetBucketsIDLabelsParams 

type GetBucketsIDLabelsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetBucketsIDLabelsParams defines parameters for GetBucketsIDLabels.

type GetBucketsIDMembersAllParams added in v2.11.0 

type GetBucketsIDMembersAllParams struct {
	GetBucketsIDMembersParams

	BucketID string
}

GetBucketsIDMembersAllParams defines type for all parameters for GetBucketsIDMembers.

type GetBucketsIDMembersParams 

type GetBucketsIDMembersParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetBucketsIDMembersParams defines parameters for GetBucketsIDMembers.

type GetBucketsIDOwnersAllParams added in v2.11.0 

type GetBucketsIDOwnersAllParams struct {
	GetBucketsIDOwnersParams

	BucketID string
}

GetBucketsIDOwnersAllParams defines type for all parameters for GetBucketsIDOwners.

type GetBucketsIDOwnersParams 

type GetBucketsIDOwnersParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetBucketsIDOwnersParams defines parameters for GetBucketsIDOwners.

type GetBucketsIDParams 

type GetBucketsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetBucketsIDParams defines parameters for GetBucketsID.

type GetBucketsParams 

type GetBucketsParams struct {
	// The offset for pagination.
	// The number of records to skip.
	Offset *Offset `json:"offset,omitempty"`

	// Limits the number of records returned. Default is `20`.
	Limit *Limit `json:"limit,omitempty"`

	// Resource ID to seek from. Results are not inclusive of this ID. Use `after` instead of `offset`.
	After *After `json:"after,omitempty"`

	// Organization name.
	// The name of the organization.
	//
	// #### InfluxDB Cloud
	//
	//  - Doesn't use `org` or `orgID`.
	//  - Creates a bucket in the organization associated with the authorization (API token).
	//
	//  #### InfluxDB OSS
	//
	//  - Accepts either `org` or `orgID`.
	//  - InfluxDB creates the bucket within this organization.
	Org *string `json:"org,omitempty"`

	// Organization ID.
	// The organization ID.
	//
	// #### InfluxDB Cloud
	//
	//  - Doesn't use `org` or `orgID`.
	//  - Creates a bucket in the organization associated with the authorization (API token).
	//
	//  #### InfluxDB OSS
	//
	//  - Accepts either `org` or `orgID`.
	//  - InfluxDB creates the bucket within this organization.
	OrgID *string `json:"orgID,omitempty"`

	// Bucket name.
	// Only returns buckets with this specific name.
	Name *string `json:"name,omitempty"`

	// Bucket ID.
	// Only returns the bucket with this ID.
	Id *string `json:"id,omitempty"`

	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetBucketsParams defines parameters for GetBuckets.

type GetChecksIDAllParams added in v2.11.0 

type GetChecksIDAllParams struct {
	GetChecksIDParams

	CheckID string
}

GetChecksIDAllParams defines type for all parameters for GetChecksID.

type GetChecksIDLabelsAllParams added in v2.11.0 

type GetChecksIDLabelsAllParams struct {
	GetChecksIDLabelsParams

	CheckID string
}

GetChecksIDLabelsAllParams defines type for all parameters for GetChecksIDLabels.

type GetChecksIDLabelsParams 

type GetChecksIDLabelsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetChecksIDLabelsParams defines parameters for GetChecksIDLabels.

type GetChecksIDParams 

type GetChecksIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetChecksIDParams defines parameters for GetChecksID.

type GetChecksIDQueryAllParams added in v2.11.0 

type GetChecksIDQueryAllParams struct {
	GetChecksIDQueryParams

	CheckID string
}

GetChecksIDQueryAllParams defines type for all parameters for GetChecksIDQuery.

type GetChecksIDQueryParams 

type GetChecksIDQueryParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetChecksIDQueryParams defines parameters for GetChecksIDQuery.

type GetChecksParams 

type GetChecksParams struct {
	// The offset for pagination.
	// The number of records to skip.
	Offset *Offset `json:"offset,omitempty"`

	// Limits the number of records returned. Default is `20`.
	Limit *Limit `json:"limit,omitempty"`

	// Only show checks that belong to a specific organization ID.
	OrgID string `json:"orgID"`

	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetChecksParams defines parameters for GetChecks.

type GetConfigParams added in v2.8.0 

type GetConfigParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetConfigParams defines parameters for GetConfig.

type GetDBRPsIDAllParams added in v2.11.0 

type GetDBRPsIDAllParams struct {
	GetDBRPsIDParams

	DbrpID string
}

GetDBRPsIDAllParams defines type for all parameters for GetDBRPsID.

type GetDBRPsIDParams 

type GetDBRPsIDParams struct {
	// Specifies the organization ID of the mapping
	OrgID *string `json:"orgID,omitempty"`

	// Specifies the organization name of the mapping
	Org *string `json:"org,omitempty"`

	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetDBRPsIDParams defines parameters for GetDBRPsID.

type GetDBRPsParams 

type GetDBRPsParams struct {
	// Specifies the organization ID to filter on
	OrgID *string `json:"orgID,omitempty"`

	// Specifies the organization name to filter on
	Org *string `json:"org,omitempty"`

	// Specifies the mapping ID to filter on
	Id *string `json:"id,omitempty"`

	// Specifies the bucket ID to filter on
	BucketID *string `json:"bucketID,omitempty"`

	// Specifies filtering on default
	Default *bool `json:"default,omitempty"`

	// Specifies the database to filter on
	Db *string `json:"db,omitempty"`

	// Specifies the retention policy to filter on
	Rp *string `json:"rp,omitempty"`

	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetDBRPsParams defines parameters for GetDBRPs.

type GetDashboardsIDCellsIDViewAllParams added in v2.11.0 

type GetDashboardsIDCellsIDViewAllParams struct {
	GetDashboardsIDCellsIDViewParams

	DashboardID string

	CellID string
}

GetDashboardsIDCellsIDViewAllParams defines type for all parameters for GetDashboardsIDCellsIDView.

type GetDashboardsIDCellsIDViewParams 

type GetDashboardsIDCellsIDViewParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetDashboardsIDCellsIDViewParams defines parameters for GetDashboardsIDCellsIDView.

type GetDashboardsIDLabelsAllParams added in v2.11.0 

type GetDashboardsIDLabelsAllParams struct {
	GetDashboardsIDLabelsParams

	DashboardID string
}

GetDashboardsIDLabelsAllParams defines type for all parameters for GetDashboardsIDLabels.

type GetDashboardsIDLabelsParams 

type GetDashboardsIDLabelsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetDashboardsIDLabelsParams defines parameters for GetDashboardsIDLabels.

type GetDashboardsIDMembersAllParams added in v2.11.0 

type GetDashboardsIDMembersAllParams struct {
	GetDashboardsIDMembersParams

	DashboardID string
}

GetDashboardsIDMembersAllParams defines type for all parameters for GetDashboardsIDMembers.

type GetDashboardsIDMembersParams 

type GetDashboardsIDMembersParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetDashboardsIDMembersParams defines parameters for GetDashboardsIDMembers.

type GetDashboardsIDOwnersAllParams added in v2.11.0 

type GetDashboardsIDOwnersAllParams struct {
	GetDashboardsIDOwnersParams

	DashboardID string
}

GetDashboardsIDOwnersAllParams defines type for all parameters for GetDashboardsIDOwners.

type GetDashboardsIDOwnersParams 

type GetDashboardsIDOwnersParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetDashboardsIDOwnersParams defines parameters for GetDashboardsIDOwners.

type GetDashboardsParams 

type GetDashboardsParams struct {
	// The offset for pagination.
	// The number of records to skip.
	Offset *Offset `json:"offset,omitempty"`

	// Limits the number of records returned. Default is `20`.
	Limit      *Limit      `json:"limit,omitempty"`
	Descending *Descending `json:"descending,omitempty"`

	// A user identifier. Returns only dashboards where this user has the `owner` role.
	Owner *string `json:"owner,omitempty"`

	// The column to sort by.
	SortBy *GetDashboardsParamsSortBy `json:"sortBy,omitempty"`

	// A list of dashboard identifiers. Returns only the listed dashboards. If both `id` and `owner` are specified, only `id` is used.
	Id *[]string `json:"id,omitempty"`

	// The identifier of the organization.
	OrgID *string `json:"orgID,omitempty"`

	// The name of the organization.
	Org *string `json:"org,omitempty"`

	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetDashboardsParams defines parameters for GetDashboards.

type GetDashboardsParamsSortBy 

type GetDashboardsParamsSortBy string

GetDashboardsParamsSortBy defines parameters for GetDashboards.

type GetFlagsParams 

type GetFlagsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetFlagsParams defines parameters for GetFlags.

type GetHealthParams 

type GetHealthParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetHealthParams defines parameters for GetHealth.

type GetLabelsIDAllParams added in v2.11.0 

type GetLabelsIDAllParams struct {
	GetLabelsIDParams

	LabelID string
}

GetLabelsIDAllParams defines type for all parameters for GetLabelsID.

type GetLabelsIDParams 

type GetLabelsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetLabelsIDParams defines parameters for GetLabelsID.

type GetLabelsParams 

type GetLabelsParams struct {
	// The organization ID.
	OrgID *string `json:"orgID,omitempty"`

	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetLabelsParams defines parameters for GetLabels.

type GetMeParams 

type GetMeParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetMeParams defines parameters for GetMe.

type GetNotificationEndpointsIDAllParams added in v2.11.0 

type GetNotificationEndpointsIDAllParams struct {
	GetNotificationEndpointsIDParams

	EndpointID string
}

GetNotificationEndpointsIDAllParams defines type for all parameters for GetNotificationEndpointsID.

type GetNotificationEndpointsIDLabelsAllParams added in v2.11.0 

type GetNotificationEndpointsIDLabelsAllParams struct {
	GetNotificationEndpointsIDLabelsParams

	EndpointID string
}

GetNotificationEndpointsIDLabelsAllParams defines type for all parameters for GetNotificationEndpointsIDLabels.

type GetNotificationEndpointsIDLabelsParams 

type GetNotificationEndpointsIDLabelsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetNotificationEndpointsIDLabelsParams defines parameters for GetNotificationEndpointsIDLabels.

type GetNotificationEndpointsIDParams 

type GetNotificationEndpointsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetNotificationEndpointsIDParams defines parameters for GetNotificationEndpointsID.

type GetNotificationEndpointsParams 

type GetNotificationEndpointsParams struct {
	// The offset for pagination.
	// The number of records to skip.
	Offset *Offset `json:"offset,omitempty"`

	// Limits the number of records returned. Default is `20`.
	Limit *Limit `json:"limit,omitempty"`

	// Only show notification endpoints that belong to specific organization ID.
	OrgID string `json:"orgID"`

	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetNotificationEndpointsParams defines parameters for GetNotificationEndpoints.

type GetNotificationRulesIDAllParams added in v2.11.0 

type GetNotificationRulesIDAllParams struct {
	GetNotificationRulesIDParams

	RuleID string
}

GetNotificationRulesIDAllParams defines type for all parameters for GetNotificationRulesID.

type GetNotificationRulesIDLabelsAllParams added in v2.11.0 

type GetNotificationRulesIDLabelsAllParams struct {
	GetNotificationRulesIDLabelsParams

	RuleID string
}

GetNotificationRulesIDLabelsAllParams defines type for all parameters for GetNotificationRulesIDLabels.

type GetNotificationRulesIDLabelsParams 

type GetNotificationRulesIDLabelsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetNotificationRulesIDLabelsParams defines parameters for GetNotificationRulesIDLabels.

type GetNotificationRulesIDParams 

type GetNotificationRulesIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetNotificationRulesIDParams defines parameters for GetNotificationRulesID.

type GetNotificationRulesIDQueryAllParams added in v2.11.0 

type GetNotificationRulesIDQueryAllParams struct {
	GetNotificationRulesIDQueryParams

	RuleID string
}

GetNotificationRulesIDQueryAllParams defines type for all parameters for GetNotificationRulesIDQuery.

type GetNotificationRulesIDQueryParams 

type GetNotificationRulesIDQueryParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetNotificationRulesIDQueryParams defines parameters for GetNotificationRulesIDQuery.

type GetNotificationRulesParams 

type GetNotificationRulesParams struct {
	// The offset for pagination.
	// The number of records to skip.
	Offset *Offset `json:"offset,omitempty"`

	// Limits the number of records returned. Default is `20`.
	Limit *Limit `json:"limit,omitempty"`

	// Only show notification rules that belong to a specific organization ID.
	OrgID string `json:"orgID"`

	// Only show notifications that belong to the specific check ID.
	CheckID *string `json:"checkID,omitempty"`

	// Only return notification rules that "would match" statuses which contain the tag key value pairs provided.
	Tag *string `json:"tag,omitempty"`

	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetNotificationRulesParams defines parameters for GetNotificationRules.

type GetOrgsIDAllParams added in v2.11.0 

type GetOrgsIDAllParams struct {
	GetOrgsIDParams

	OrgID string
}

GetOrgsIDAllParams defines type for all parameters for GetOrgsID.

type GetOrgsIDMembersAllParams added in v2.11.0 

type GetOrgsIDMembersAllParams struct {
	GetOrgsIDMembersParams

	OrgID string
}

GetOrgsIDMembersAllParams defines type for all parameters for GetOrgsIDMembers.

type GetOrgsIDMembersParams 

type GetOrgsIDMembersParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetOrgsIDMembersParams defines parameters for GetOrgsIDMembers.

type GetOrgsIDOwnersAllParams added in v2.11.0 

type GetOrgsIDOwnersAllParams struct {
	GetOrgsIDOwnersParams

	OrgID string
}

GetOrgsIDOwnersAllParams defines type for all parameters for GetOrgsIDOwners.

type GetOrgsIDOwnersParams 

type GetOrgsIDOwnersParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetOrgsIDOwnersParams defines parameters for GetOrgsIDOwners.

type GetOrgsIDParams 

type GetOrgsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetOrgsIDParams defines parameters for GetOrgsID.

type GetOrgsIDSecretsAllParams added in v2.11.0 

type GetOrgsIDSecretsAllParams struct {
	GetOrgsIDSecretsParams

	OrgID string
}

GetOrgsIDSecretsAllParams defines type for all parameters for GetOrgsIDSecrets.

type GetOrgsIDSecretsParams 

type GetOrgsIDSecretsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetOrgsIDSecretsParams defines parameters for GetOrgsIDSecrets.

type GetOrgsParams 

type GetOrgsParams struct {
	// The offset for pagination.
	// The number of records to skip.
	Offset *Offset `json:"offset,omitempty"`

	// Limits the number of records returned. Default is `20`.
	Limit      *Limit      `json:"limit,omitempty"`
	Descending *Descending `json:"descending,omitempty"`

	// An organization name.
	// Only returns organizations with this name.
	Org *string `json:"org,omitempty"`

	// An organization ID.
	// Only returns the organization with this ID.
	OrgID *string `json:"orgID,omitempty"`

	// A user ID.
	// Only returns organizations where this user is a member or owner.
	UserID *string `json:"userID,omitempty"`

	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetOrgsParams defines parameters for GetOrgs.

type GetQuerySuggestionsNameAllParams added in v2.11.0 

type GetQuerySuggestionsNameAllParams struct {
	GetQuerySuggestionsNameParams

	Name string
}

GetQuerySuggestionsNameAllParams defines type for all parameters for GetQuerySuggestionsName.

type GetQuerySuggestionsNameParams 

type GetQuerySuggestionsNameParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetQuerySuggestionsNameParams defines parameters for GetQuerySuggestionsName.

type GetQuerySuggestionsParams 

type GetQuerySuggestionsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetQuerySuggestionsParams defines parameters for GetQuerySuggestions.

type GetReadyParams 

type GetReadyParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetReadyParams defines parameters for GetReady.

type GetRemoteConnectionByIDAllParams added in v2.11.0 

type GetRemoteConnectionByIDAllParams struct {
	GetRemoteConnectionByIDParams

	RemoteID string
}

GetRemoteConnectionByIDAllParams defines type for all parameters for GetRemoteConnectionByID.

type GetRemoteConnectionByIDParams added in v2.8.0 

type GetRemoteConnectionByIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetRemoteConnectionByIDParams defines parameters for GetRemoteConnectionByID.

type GetRemoteConnectionsParams added in v2.8.0 

type GetRemoteConnectionsParams struct {
	// The organization ID.
	OrgID     string  `json:"orgID"`
	Name      *string `json:"name,omitempty"`
	RemoteURL *string `json:"remoteURL,omitempty"`

	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetRemoteConnectionsParams defines parameters for GetRemoteConnections.

type GetReplicationByIDAllParams added in v2.11.0 

type GetReplicationByIDAllParams struct {
	GetReplicationByIDParams

	ReplicationID string
}

GetReplicationByIDAllParams defines type for all parameters for GetReplicationByID.

type GetReplicationByIDParams added in v2.8.0 

type GetReplicationByIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetReplicationByIDParams defines parameters for GetReplicationByID.

type GetReplicationsParams added in v2.8.0 

type GetReplicationsParams struct {
	// The organization ID.
	OrgID         string  `json:"orgID"`
	Name          *string `json:"name,omitempty"`
	RemoteID      *string `json:"remoteID,omitempty"`
	LocalBucketID *string `json:"localBucketID,omitempty"`

	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetReplicationsParams defines parameters for GetReplications.

type GetResourcesParams added in v2.6.0 

type GetResourcesParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetResourcesParams defines parameters for GetResources.

type GetScrapersIDAllParams added in v2.11.0 

type GetScrapersIDAllParams struct {
	GetScrapersIDParams

	ScraperTargetID string
}

GetScrapersIDAllParams defines type for all parameters for GetScrapersID.

type GetScrapersIDLabelsAllParams added in v2.11.0 

type GetScrapersIDLabelsAllParams struct {
	GetScrapersIDLabelsParams

	ScraperTargetID string
}

GetScrapersIDLabelsAllParams defines type for all parameters for GetScrapersIDLabels.

type GetScrapersIDLabelsParams 

type GetScrapersIDLabelsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetScrapersIDLabelsParams defines parameters for GetScrapersIDLabels.

type GetScrapersIDMembersAllParams added in v2.11.0 

type GetScrapersIDMembersAllParams struct {
	GetScrapersIDMembersParams

	ScraperTargetID string
}

GetScrapersIDMembersAllParams defines type for all parameters for GetScrapersIDMembers.

type GetScrapersIDMembersParams 

type GetScrapersIDMembersParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetScrapersIDMembersParams defines parameters for GetScrapersIDMembers.

type GetScrapersIDOwnersAllParams added in v2.11.0 

type GetScrapersIDOwnersAllParams struct {
	GetScrapersIDOwnersParams

	ScraperTargetID string
}

GetScrapersIDOwnersAllParams defines type for all parameters for GetScrapersIDOwners.

type GetScrapersIDOwnersParams 

type GetScrapersIDOwnersParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetScrapersIDOwnersParams defines parameters for GetScrapersIDOwners.

type GetScrapersIDParams 

type GetScrapersIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetScrapersIDParams defines parameters for GetScrapersID.

type GetScrapersParams 

type GetScrapersParams struct {
	// Specifies the name of the scraper target.
	Name *string `json:"name,omitempty"`

	// List of scraper target IDs to return. If both `id` and `owner` are specified, only `id` is used.
	Id *[]string `json:"id,omitempty"`

	// Specifies the organization ID of the scraper target.
	OrgID *string `json:"orgID,omitempty"`

	// Specifies the organization name of the scraper target.
	Org *string `json:"org,omitempty"`

	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetScrapersParams defines parameters for GetScrapers.

type GetSetupParams 

type GetSetupParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetSetupParams defines parameters for GetSetup.

type GetSourcesIDAllParams added in v2.11.0 

type GetSourcesIDAllParams struct {
	GetSourcesIDParams

	SourceID string
}

GetSourcesIDAllParams defines type for all parameters for GetSourcesID.

type GetSourcesIDBucketsAllParams added in v2.11.0 

type GetSourcesIDBucketsAllParams struct {
	GetSourcesIDBucketsParams

	SourceID string
}

GetSourcesIDBucketsAllParams defines type for all parameters for GetSourcesIDBuckets.

type GetSourcesIDBucketsParams 

type GetSourcesIDBucketsParams struct {
	// The name of the organization.
	Org *string `json:"org,omitempty"`

	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetSourcesIDBucketsParams defines parameters for GetSourcesIDBuckets.

type GetSourcesIDHealthAllParams added in v2.11.0 

type GetSourcesIDHealthAllParams struct {
	GetSourcesIDHealthParams

	SourceID string
}

GetSourcesIDHealthAllParams defines type for all parameters for GetSourcesIDHealth.

type GetSourcesIDHealthParams 

type GetSourcesIDHealthParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetSourcesIDHealthParams defines parameters for GetSourcesIDHealth.

type GetSourcesIDParams 

type GetSourcesIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetSourcesIDParams defines parameters for GetSourcesID.

type GetSourcesParams 

type GetSourcesParams struct {
	// The name of the organization.
	Org *string `json:"org,omitempty"`

	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetSourcesParams defines parameters for GetSources.

type GetTasksIDAllParams added in v2.11.0 

type GetTasksIDAllParams struct {
	GetTasksIDParams

	TaskID string
}

GetTasksIDAllParams defines type for all parameters for GetTasksID.

type GetTasksIDLabelsAllParams added in v2.11.0 

type GetTasksIDLabelsAllParams struct {
	GetTasksIDLabelsParams

	TaskID string
}

GetTasksIDLabelsAllParams defines type for all parameters for GetTasksIDLabels.

type GetTasksIDLabelsParams 

type GetTasksIDLabelsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetTasksIDLabelsParams defines parameters for GetTasksIDLabels.

type GetTasksIDLogsAllParams added in v2.11.0 

type GetTasksIDLogsAllParams struct {
	GetTasksIDLogsParams

	TaskID string
}

GetTasksIDLogsAllParams defines type for all parameters for GetTasksIDLogs.

type GetTasksIDLogsParams 

type GetTasksIDLogsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetTasksIDLogsParams defines parameters for GetTasksIDLogs.

type GetTasksIDMembersAllParams added in v2.11.0 

type GetTasksIDMembersAllParams struct {
	GetTasksIDMembersParams

	TaskID string
}

GetTasksIDMembersAllParams defines type for all parameters for GetTasksIDMembers.

type GetTasksIDMembersParams 

type GetTasksIDMembersParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetTasksIDMembersParams defines parameters for GetTasksIDMembers.

type GetTasksIDOwnersAllParams added in v2.11.0 

type GetTasksIDOwnersAllParams struct {
	GetTasksIDOwnersParams

	TaskID string
}

GetTasksIDOwnersAllParams defines type for all parameters for GetTasksIDOwners.

type GetTasksIDOwnersParams 

type GetTasksIDOwnersParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetTasksIDOwnersParams defines parameters for GetTasksIDOwners.

type GetTasksIDParams 

type GetTasksIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetTasksIDParams defines parameters for GetTasksID.

type GetTasksIDRunsAllParams added in v2.11.0 

type GetTasksIDRunsAllParams struct {
	GetTasksIDRunsParams

	TaskID string
}

GetTasksIDRunsAllParams defines type for all parameters for GetTasksIDRuns.

type GetTasksIDRunsIDAllParams added in v2.11.0 

type GetTasksIDRunsIDAllParams struct {
	GetTasksIDRunsIDParams

	TaskID string

	RunID string
}

GetTasksIDRunsIDAllParams defines type for all parameters for GetTasksIDRunsID.

type GetTasksIDRunsIDLogsAllParams added in v2.11.0 

type GetTasksIDRunsIDLogsAllParams struct {
	GetTasksIDRunsIDLogsParams

	TaskID string

	RunID string
}

GetTasksIDRunsIDLogsAllParams defines type for all parameters for GetTasksIDRunsIDLogs.

type GetTasksIDRunsIDLogsParams 

type GetTasksIDRunsIDLogsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetTasksIDRunsIDLogsParams defines parameters for GetTasksIDRunsIDLogs.

type GetTasksIDRunsIDParams 

type GetTasksIDRunsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetTasksIDRunsIDParams defines parameters for GetTasksIDRunsID.

type GetTasksIDRunsParams 

type GetTasksIDRunsParams struct {
	// A task run ID. Only returns runs created after this run.
	After *string `json:"after,omitempty"`

	// Limits the number of task runs returned. Default is `100`.
	Limit *int `json:"limit,omitempty"`

	// A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)).
	// Only returns runs scheduled after this time.
	AfterTime *time.Time `json:"afterTime,omitempty"`

	// A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)).
	// Only returns runs scheduled before this time.
	BeforeTime *time.Time `json:"beforeTime,omitempty"`

	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetTasksIDRunsParams defines parameters for GetTasksIDRuns.

type GetTasksParams 

type GetTasksParams struct {
	// Task name.
	// Only returns tasks with this name.
	// Different tasks may have the same name.
	Name *string `json:"name,omitempty"`

	// Task ID.
	// Only returns tasks created after this task.
	After *string `json:"after,omitempty"`

	// User ID.
	// Only returns tasks owned by this user.
	User *string `json:"user,omitempty"`

	// Organization name.
	// Only returns tasks owned by this organization.
	Org *string `json:"org,omitempty"`

	// Organization ID.
	// Only returns tasks owned by this organization.
	OrgID *string `json:"orgID,omitempty"`

	// Task status (`active` or `inactive`).
	// Only returns tasks with this status.
	Status *GetTasksParamsStatus `json:"status,omitempty"`

	// Limits the number of tasks returned.
	// The minimum is `1`, the maximum is `500`, and the default is `100`.
	Limit *int `json:"limit,omitempty"`

	// Task type (`basic` or `system`).
	//
	// The default (`system`) response contains all the metadata properties for tasks.
	// To reduce the payload size, pass `basic` to omit some task properties (`flux`, `createdAt`, `updatedAt`) from the response.
	Type *GetTasksParamsType `json:"type,omitempty"`

	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetTasksParams defines parameters for GetTasks.

type GetTasksParamsStatus 

type GetTasksParamsStatus string

GetTasksParamsStatus defines parameters for GetTasks.

type GetTasksParamsType added in v2.6.0 

type GetTasksParamsType string

GetTasksParamsType defines parameters for GetTasks.

type GetTelegrafPluginsParams 

type GetTelegrafPluginsParams struct {
	// The type of plugin desired.
	Type *string `json:"type,omitempty"`

	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetTelegrafPluginsParams defines parameters for GetTelegrafPlugins.

type GetTelegrafsIDAllParams added in v2.11.0 

type GetTelegrafsIDAllParams struct {
	GetTelegrafsIDParams

	TelegrafID string
}

GetTelegrafsIDAllParams defines type for all parameters for GetTelegrafsID.

type GetTelegrafsIDLabelsAllParams added in v2.11.0 

type GetTelegrafsIDLabelsAllParams struct {
	GetTelegrafsIDLabelsParams

	TelegrafID string
}

GetTelegrafsIDLabelsAllParams defines type for all parameters for GetTelegrafsIDLabels.

type GetTelegrafsIDLabelsParams 

type GetTelegrafsIDLabelsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetTelegrafsIDLabelsParams defines parameters for GetTelegrafsIDLabels.

type GetTelegrafsIDMembersAllParams added in v2.11.0 

type GetTelegrafsIDMembersAllParams struct {
	GetTelegrafsIDMembersParams

	TelegrafID string
}

GetTelegrafsIDMembersAllParams defines type for all parameters for GetTelegrafsIDMembers.

type GetTelegrafsIDMembersParams 

type GetTelegrafsIDMembersParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetTelegrafsIDMembersParams defines parameters for GetTelegrafsIDMembers.

type GetTelegrafsIDOwnersAllParams added in v2.11.0 

type GetTelegrafsIDOwnersAllParams struct {
	GetTelegrafsIDOwnersParams

	TelegrafID string
}

GetTelegrafsIDOwnersAllParams defines type for all parameters for GetTelegrafsIDOwners.

type GetTelegrafsIDOwnersParams 

type GetTelegrafsIDOwnersParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetTelegrafsIDOwnersParams defines parameters for GetTelegrafsIDOwners.

type GetTelegrafsIDParams 

type GetTelegrafsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan                  `json:"Zap-Trace-Span,omitempty"`
	Accept       *GetTelegrafsIDParamsAccept `json:"Accept,omitempty"`
}

GetTelegrafsIDParams defines parameters for GetTelegrafsID.

type GetTelegrafsIDParamsAccept 

type GetTelegrafsIDParamsAccept string

GetTelegrafsIDParamsAccept defines parameters for GetTelegrafsID.

type GetTelegrafsParams 

type GetTelegrafsParams struct {
	// The organization ID the Telegraf config belongs to.
	OrgID *string `json:"orgID,omitempty"`

	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetTelegrafsParams defines parameters for GetTelegrafs.

type GetUsersIDAllParams added in v2.11.0 

type GetUsersIDAllParams struct {
	GetUsersIDParams

	UserID string
}

GetUsersIDAllParams defines type for all parameters for GetUsersID.

type GetUsersIDParams 

type GetUsersIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetUsersIDParams defines parameters for GetUsersID.

type GetUsersParams 

type GetUsersParams struct {
	// The offset for pagination.
	// The number of records to skip.
	Offset *Offset `json:"offset,omitempty"`

	// Limits the number of records returned. Default is `20`.
	Limit *Limit `json:"limit,omitempty"`

	// Resource ID to seek from. Results are not inclusive of this ID. Use `after` instead of `offset`.
	After *After  `json:"after,omitempty"`
	Name  *string `json:"name,omitempty"`
	Id    *string `json:"id,omitempty"`

	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetUsersParams defines parameters for GetUsers.

type GetVariablesIDAllParams added in v2.11.0 

type GetVariablesIDAllParams struct {
	GetVariablesIDParams

	VariableID string
}

GetVariablesIDAllParams defines type for all parameters for GetVariablesID.

type GetVariablesIDLabelsAllParams added in v2.11.0 

type GetVariablesIDLabelsAllParams struct {
	GetVariablesIDLabelsParams

	VariableID string
}

GetVariablesIDLabelsAllParams defines type for all parameters for GetVariablesIDLabels.

type GetVariablesIDLabelsParams 

type GetVariablesIDLabelsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetVariablesIDLabelsParams defines parameters for GetVariablesIDLabels.

type GetVariablesIDParams 

type GetVariablesIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetVariablesIDParams defines parameters for GetVariablesID.

type GetVariablesParams 

type GetVariablesParams struct {
	// The name of the organization.
	Org *string `json:"org,omitempty"`

	// The organization ID.
	OrgID *string `json:"orgID,omitempty"`

	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

GetVariablesParams defines parameters for GetVariables.

type GreaterThreshold 

type GreaterThreshold struct {
	// Embedded struct due to allOf(#/components/schemas/ThresholdBase)
	ThresholdBase
	// Embedded fields due to inline allOf schema
	Typ   GreaterThresholdType `json:"type"`
	Value float32              `json:"value"`
}

GreaterThreshold defines model for GreaterThreshold.

func (GreaterThreshold) MarshalJSON added in v2.14.0 

func (t GreaterThreshold) MarshalJSON() ([]byte, error)

MarshalJSON implement json.Marshaler interface.

func (GreaterThreshold) Type 

func (t GreaterThreshold) Type() string

type GreaterThresholdType 

type GreaterThresholdType string

GreaterThresholdType defines model for GreaterThreshold.Type. 

const (
	GreaterThresholdTypeGreater GreaterThresholdType = "greater"
)

Defines values for GreaterThresholdType.

type HTTPNotificationEndpoint 

type HTTPNotificationEndpoint struct {
	// Embedded struct due to allOf(#/components/schemas/NotificationEndpointBase)
	NotificationEndpointBase `yaml:",inline"`
	// Embedded fields due to inline allOf schema
	AuthMethod      HTTPNotificationEndpointAuthMethod `json:"authMethod"`
	ContentTemplate *string                            `json:"contentTemplate,omitempty"`

	// Customized headers.
	Headers  *HTTPNotificationEndpoint_Headers `json:"headers,omitempty"`
	Method   HTTPNotificationEndpointMethod    `json:"method"`
	Password *string                           `json:"password,omitempty"`
	Token    *string                           `json:"token,omitempty"`
	Url      string                            `json:"url"`
	Username *string                           `json:"username,omitempty"`
}

HTTPNotificationEndpoint defines model for HTTPNotificationEndpoint.

type HTTPNotificationEndpointAuthMethod 

type HTTPNotificationEndpointAuthMethod string

HTTPNotificationEndpointAuthMethod defines model for HTTPNotificationEndpoint.AuthMethod. 

const (
	HTTPNotificationEndpointAuthMethodBasic HTTPNotificationEndpointAuthMethod = "basic"

	HTTPNotificationEndpointAuthMethodBearer HTTPNotificationEndpointAuthMethod = "bearer"

	HTTPNotificationEndpointAuthMethodNone HTTPNotificationEndpointAuthMethod = "none"
)

Defines values for HTTPNotificationEndpointAuthMethod.

type HTTPNotificationEndpointMethod 

type HTTPNotificationEndpointMethod string

HTTPNotificationEndpointMethod defines model for HTTPNotificationEndpoint.Method. 

const (
	HTTPNotificationEndpointMethodGET HTTPNotificationEndpointMethod = "GET"

	HTTPNotificationEndpointMethodPOST HTTPNotificationEndpointMethod = "POST"

	HTTPNotificationEndpointMethodPUT HTTPNotificationEndpointMethod = "PUT"
)

Defines values for HTTPNotificationEndpointMethod.

type HTTPNotificationEndpoint_Headers 

type HTTPNotificationEndpoint_Headers struct {
	AdditionalProperties map[string]string `json:"-"`
}

Customized headers.

func (HTTPNotificationEndpoint_Headers) Get 

func (a HTTPNotificationEndpoint_Headers) Get(fieldName string) (value string, found bool)

Getter for additional properties for HTTPNotificationEndpoint_Headers. Returns the specified element and whether it was found

func (HTTPNotificationEndpoint_Headers) MarshalJSON 

func (a HTTPNotificationEndpoint_Headers) MarshalJSON() ([]byte, error)

Override default JSON handling for HTTPNotificationEndpoint_Headers to handle AdditionalProperties

func (*HTTPNotificationEndpoint_Headers) Set 

func (a *HTTPNotificationEndpoint_Headers) Set(fieldName string, value string)

Setter for additional properties for HTTPNotificationEndpoint_Headers

func (*HTTPNotificationEndpoint_Headers) UnmarshalJSON 

func (a *HTTPNotificationEndpoint_Headers) UnmarshalJSON(b []byte) error

Override default JSON handling for HTTPNotificationEndpoint_Headers to handle AdditionalProperties

type HTTPNotificationRule 

type HTTPNotificationRule struct {
	// Embedded struct due to allOf(#/components/schemas/NotificationRuleBase)
	NotificationRuleBase `yaml:",inline"`
	// Embedded struct due to allOf(#/components/schemas/HTTPNotificationRuleBase)
	HTTPNotificationRuleBase `yaml:",inline"`
}

HTTPNotificationRule defines model for HTTPNotificationRule.

type HTTPNotificationRuleBase 

type HTTPNotificationRuleBase struct {
	Type HTTPNotificationRuleBaseType `json:"type"`
	Url  *string                      `json:"url,omitempty"`
}

HTTPNotificationRuleBase defines model for HTTPNotificationRuleBase.

type HTTPNotificationRuleBaseType 

type HTTPNotificationRuleBaseType string

HTTPNotificationRuleBaseType defines model for HTTPNotificationRuleBase.Type. 

const (
	HTTPNotificationRuleBaseTypeHttp HTTPNotificationRuleBaseType = "http"
)

Defines values for HTTPNotificationRuleBaseType.

type HTTPRequestDoer added in v2.11.0 

type HTTPRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type HealthCheck 

type HealthCheck struct {
	Checks  *[]HealthCheck    `json:"checks,omitempty"`
	Commit  *string           `json:"commit,omitempty"`
	Message *string           `json:"message,omitempty"`
	Name    string            `json:"name"`
	Status  HealthCheckStatus `json:"status"`
	Version *string           `json:"version,omitempty"`
}

HealthCheck defines model for HealthCheck.

type HealthCheckStatus 

type HealthCheckStatus string

HealthCheckStatus defines model for HealthCheck.Status. 

const (
	HealthCheckStatusFail HealthCheckStatus = "fail"

	HealthCheckStatusPass HealthCheckStatus = "pass"
)

Defines values for HealthCheckStatus.

type HeatmapViewProperties 

type HeatmapViewProperties struct {
	AdaptiveZoomHide *bool   `json:"adaptiveZoomHide,omitempty"`
	BinSize          float32 `json:"binSize"`

	// Colors define color encoding of data into a visualization
	Colors                     []string                   `json:"colors"`
	GenerateXAxisTicks         *[]string                  `json:"generateXAxisTicks,omitempty"`
	GenerateYAxisTicks         *[]string                  `json:"generateYAxisTicks,omitempty"`
	LegendColorizeRows         *bool                      `json:"legendColorizeRows,omitempty"`
	LegendHide                 *bool                      `json:"legendHide,omitempty"`
	LegendOpacity              *float32                   `json:"legendOpacity,omitempty"`
	LegendOrientationThreshold *int                       `json:"legendOrientationThreshold,omitempty"`
	Note                       string                     `json:"note"`
	Queries                    []DashboardQuery           `json:"queries"`
	Shape                      HeatmapViewPropertiesShape `json:"shape"`

	// If true, will display note when empty
	ShowNoteWhenEmpty bool                      `json:"showNoteWhenEmpty"`
	TimeFormat        *string                   `json:"timeFormat,omitempty"`
	Type              HeatmapViewPropertiesType `json:"type"`
	XAxisLabel        string                    `json:"xAxisLabel"`
	XColumn           string                    `json:"xColumn"`
	XDomain           []float32                 `json:"xDomain"`
	XPrefix           string                    `json:"xPrefix"`
	XSuffix           string                    `json:"xSuffix"`
	XTickStart        *float32                  `json:"xTickStart,omitempty"`
	XTickStep         *float32                  `json:"xTickStep,omitempty"`
	XTotalTicks       *int                      `json:"xTotalTicks,omitempty"`
	YAxisLabel        string                    `json:"yAxisLabel"`
	YColumn           string                    `json:"yColumn"`
	YDomain           []float32                 `json:"yDomain"`
	YPrefix           string                    `json:"yPrefix"`
	YSuffix           string                    `json:"ySuffix"`
	YTickStart        *float32                  `json:"yTickStart,omitempty"`
	YTickStep         *float32                  `json:"yTickStep,omitempty"`
	YTotalTicks       *int                      `json:"yTotalTicks,omitempty"`
}

HeatmapViewProperties defines model for HeatmapViewProperties.

type HeatmapViewPropertiesShape 

type HeatmapViewPropertiesShape string

HeatmapViewPropertiesShape defines model for HeatmapViewProperties.Shape. 

const (
	HeatmapViewPropertiesShapeChronografV2 HeatmapViewPropertiesShape = "chronograf-v2"
)

Defines values for HeatmapViewPropertiesShape.

type HeatmapViewPropertiesType 

type HeatmapViewPropertiesType string

HeatmapViewPropertiesType defines model for HeatmapViewProperties.Type. 

const (
	HeatmapViewPropertiesTypeHeatmap HeatmapViewPropertiesType = "heatmap"
)

Defines values for HeatmapViewPropertiesType.

type HistogramViewProperties 

type HistogramViewProperties struct {
	BinCount int `json:"binCount"`

	// Colors define color encoding of data into a visualization
	Colors                     []DashboardColor                `json:"colors"`
	FillColumns                []string                        `json:"fillColumns"`
	LegendColorizeRows         *bool                           `json:"legendColorizeRows,omitempty"`
	LegendHide                 *bool                           `json:"legendHide,omitempty"`
	LegendOpacity              *float32                        `json:"legendOpacity,omitempty"`
	LegendOrientationThreshold *int                            `json:"legendOrientationThreshold,omitempty"`
	Note                       string                          `json:"note"`
	Position                   HistogramViewPropertiesPosition `json:"position"`
	Queries                    []DashboardQuery                `json:"queries"`
	Shape                      HistogramViewPropertiesShape    `json:"shape"`

	// If true, will display note when empty
	ShowNoteWhenEmpty bool                        `json:"showNoteWhenEmpty"`
	Type              HistogramViewPropertiesType `json:"type"`
	XAxisLabel        string                      `json:"xAxisLabel"`
	XColumn           string                      `json:"xColumn"`
	XDomain           []float32                   `json:"xDomain"`
}

HistogramViewProperties defines model for HistogramViewProperties.

type HistogramViewPropertiesPosition 

type HistogramViewPropertiesPosition string

HistogramViewPropertiesPosition defines model for HistogramViewProperties.Position. 

const (
	HistogramViewPropertiesPositionOverlaid HistogramViewPropertiesPosition = "overlaid"

	HistogramViewPropertiesPositionStacked HistogramViewPropertiesPosition = "stacked"
)

Defines values for HistogramViewPropertiesPosition.

type HistogramViewPropertiesShape 

type HistogramViewPropertiesShape string

HistogramViewPropertiesShape defines model for HistogramViewProperties.Shape. 

const (
	HistogramViewPropertiesShapeChronografV2 HistogramViewPropertiesShape = "chronograf-v2"
)

Defines values for HistogramViewPropertiesShape.

type HistogramViewPropertiesType 

type HistogramViewPropertiesType string

HistogramViewPropertiesType defines model for HistogramViewProperties.Type. 

const (
	HistogramViewPropertiesTypeHistogram HistogramViewPropertiesType = "histogram"
)

Defines values for HistogramViewPropertiesType.

type Identifier 

type Identifier struct {
	Name *string `json:"name,omitempty"`

	// Type of AST node
	Type *NodeType `json:"type,omitempty"`
}

A valid Flux identifier

type ImportDeclaration 

type ImportDeclaration struct {
	// A valid Flux identifier
	As *Identifier `json:"as,omitempty"`

	// Expressions begin and end with double quote marks
	Path *StringLiteral `json:"path,omitempty"`

	// Type of AST node
	Type *NodeType `json:"type,omitempty"`
}

Declares a package import

type IndexExpression 

type IndexExpression struct {
	Array *Expression `json:"array,omitempty"`
	Index *Expression `json:"index,omitempty"`

	// Type of AST node
	Type *NodeType `json:"type,omitempty"`
}

Represents indexing into an array

type IntegerLiteral 

type IntegerLiteral struct {
	// Type of AST node
	Type  *NodeType `json:"type,omitempty"`
	Value *string   `json:"value,omitempty"`
}

Represents integer numbers

type InternalServerError added in v2.11.0 

type InternalServerError Error

InternalServerError defines model for InternalServerError.

type IsOnboarding 

type IsOnboarding struct {
	// If `true`, the InfluxDB instance hasn't had initial setup;
	// `false` otherwise.
	Allowed *bool `json:"allowed,omitempty"`
}

IsOnboarding defines model for IsOnboarding.

type Label 

type Label struct {
	Id    *string `json:"id,omitempty"`
	Name  *string `json:"name,omitempty"`
	OrgID *string `json:"orgID,omitempty"`

	// Key-value pairs associated with this label.
	// To remove a property, send an update with an empty value (`""`) for the key.
	Properties *Label_Properties `json:"properties,omitempty"`
}

Label defines model for Label.

type LabelCreateRequest 

type LabelCreateRequest struct {
	Name  string `json:"name"`
	OrgID string `json:"orgID"`

	// Key-value pairs associated with this label.
	//
	// To remove a property, send an update with an empty value (`""`) for the key.
	Properties *LabelCreateRequest_Properties `json:"properties,omitempty"`
}

LabelCreateRequest defines model for LabelCreateRequest.

type LabelCreateRequest_Properties 

type LabelCreateRequest_Properties struct {
	AdditionalProperties map[string]string `json:"-"`
}

Key-value pairs associated with this label.

To remove a property, send an update with an empty value (`""`) for the key.

func (LabelCreateRequest_Properties) Get 

func (a LabelCreateRequest_Properties) Get(fieldName string) (value string, found bool)

Getter for additional properties for LabelCreateRequest_Properties. Returns the specified element and whether it was found

func (LabelCreateRequest_Properties) MarshalJSON 

func (a LabelCreateRequest_Properties) MarshalJSON() ([]byte, error)

Override default JSON handling for LabelCreateRequest_Properties to handle AdditionalProperties

func (*LabelCreateRequest_Properties) Set 

func (a *LabelCreateRequest_Properties) Set(fieldName string, value string)

Setter for additional properties for LabelCreateRequest_Properties

func (*LabelCreateRequest_Properties) UnmarshalJSON 

func (a *LabelCreateRequest_Properties) UnmarshalJSON(b []byte) error

Override default JSON handling for LabelCreateRequest_Properties to handle AdditionalProperties

type LabelMapping 

type LabelMapping struct {
	// Label ID.
	// The ID of the label to attach.
	LabelID *string `json:"labelID,omitempty"`
}

LabelMapping defines model for LabelMapping.

type LabelResponse 

type LabelResponse struct {
	Label *Label `json:"label,omitempty"`

	// URI pointers for additional paged results.
	Links *Links `json:"links,omitempty"`
}

LabelResponse defines model for LabelResponse.

type LabelUpdate 

type LabelUpdate struct {
	Name       *string                 `json:"name,omitempty"`
	Properties *LabelUpdate_Properties `json:"properties,omitempty"`
}

LabelUpdate defines model for LabelUpdate.

type LabelUpdate_Properties 

type LabelUpdate_Properties struct {
	AdditionalProperties map[string]string `json:"-"`
}

LabelUpdate_Properties defines model for LabelUpdate.Properties.

func (LabelUpdate_Properties) Get 

func (a LabelUpdate_Properties) Get(fieldName string) (value string, found bool)

Getter for additional properties for LabelUpdate_Properties. Returns the specified element and whether it was found

func (LabelUpdate_Properties) MarshalJSON 

func (a LabelUpdate_Properties) MarshalJSON() ([]byte, error)

Override default JSON handling for LabelUpdate_Properties to handle AdditionalProperties

func (*LabelUpdate_Properties) Set 

func (a *LabelUpdate_Properties) Set(fieldName string, value string)

Setter for additional properties for LabelUpdate_Properties

func (*LabelUpdate_Properties) UnmarshalJSON 

func (a *LabelUpdate_Properties) UnmarshalJSON(b []byte) error

Override default JSON handling for LabelUpdate_Properties to handle AdditionalProperties

type Label_Properties 

type Label_Properties struct {
	AdditionalProperties map[string]string `json:"-"`
}

Key-value pairs associated with this label. To remove a property, send an update with an empty value (`""`) for the key.

func (Label_Properties) Get 

func (a Label_Properties) Get(fieldName string) (value string, found bool)

Getter for additional properties for Label_Properties. Returns the specified element and whether it was found

func (Label_Properties) MarshalJSON 

func (a Label_Properties) MarshalJSON() ([]byte, error)

Override default JSON handling for Label_Properties to handle AdditionalProperties

func (*Label_Properties) Set 

func (a *Label_Properties) Set(fieldName string, value string)

Setter for additional properties for Label_Properties

func (*Label_Properties) UnmarshalJSON 

func (a *Label_Properties) UnmarshalJSON(b []byte) error

Override default JSON handling for Label_Properties to handle AdditionalProperties

type Labels 

type Labels []Label

Labels defines model for Labels.

type LabelsResponse 

type LabelsResponse struct {
	Labels *Labels `json:"labels,omitempty"`

	// URI pointers for additional paged results.
	Links *Links `json:"links,omitempty"`
}

LabelsResponse defines model for LabelsResponse.

type LanguageRequest 

type LanguageRequest struct {
	// The Flux query script to be analyzed.
	Query string `json:"query"`
}

Flux query to be analyzed.

type LatLonColumn added in v2.5.0 

type LatLonColumn struct {
	// Column to look up Lat/Lon
	Column string `json:"column"`

	// Key to determine whether the column is tag/field
	Key string `json:"key"`
}

Object type for key and column definitions

type LatLonColumns added in v2.5.0 

type LatLonColumns struct {
	// Object type for key and column definitions
	Lat LatLonColumn `json:"lat"`

	// Object type for key and column definitions
	Lon LatLonColumn `json:"lon"`
}

Object type to define lat/lon columns

type LesserThreshold 

type LesserThreshold struct {
	// Embedded struct due to allOf(#/components/schemas/ThresholdBase)
	ThresholdBase
	// Embedded fields due to inline allOf schema
	Typ   LesserThresholdType `json:"type"`
	Value float32             `json:"value"`
}

LesserThreshold defines model for LesserThreshold.

func (LesserThreshold) MarshalJSON added in v2.14.0 

func (t LesserThreshold) MarshalJSON() ([]byte, error)

MarshalJSON implement json.Marshaler interface.

func (LesserThreshold) Type 

func (t LesserThreshold) Type() string

type LesserThresholdType 

type LesserThresholdType string

LesserThresholdType defines model for LesserThreshold.Type. 

const (
	LesserThresholdTypeLesser LesserThresholdType = "lesser"
)

Defines values for LesserThresholdType.

type Limit 

type Limit int

Limit defines model for Limit.

type LinePlusSingleStatProperties 

type LinePlusSingleStatProperties struct {
	AdaptiveZoomHide *bool `json:"adaptiveZoomHide,omitempty"`

	// The viewport for a View's visualizations
	Axes Axes `json:"axes"`

	// Colors define color encoding of data into a visualization
	Colors []DashboardColor `json:"colors"`

	// Indicates whether decimal places should be enforced, and how many digits it should show.
	DecimalPlaces              DecimalPlaces                               `json:"decimalPlaces"`
	GenerateXAxisTicks         *[]string                                   `json:"generateXAxisTicks,omitempty"`
	GenerateYAxisTicks         *[]string                                   `json:"generateYAxisTicks,omitempty"`
	HoverDimension             *LinePlusSingleStatPropertiesHoverDimension `json:"hoverDimension,omitempty"`
	LegendColorizeRows         *bool                                       `json:"legendColorizeRows,omitempty"`
	LegendHide                 *bool                                       `json:"legendHide,omitempty"`
	LegendOpacity              *float32                                    `json:"legendOpacity,omitempty"`
	LegendOrientationThreshold *int                                        `json:"legendOrientationThreshold,omitempty"`
	Note                       string                                      `json:"note"`
	Position                   LinePlusSingleStatPropertiesPosition        `json:"position"`
	Prefix                     string                                      `json:"prefix"`
	Queries                    []DashboardQuery                            `json:"queries"`
	ShadeBelow                 *bool                                       `json:"shadeBelow,omitempty"`
	Shape                      LinePlusSingleStatPropertiesShape           `json:"shape"`

	// If true, will display note when empty
	ShowNoteWhenEmpty bool `json:"showNoteWhenEmpty"`

	// StaticLegend represents the options specific to the static legend
	StaticLegend *StaticLegend                    `json:"staticLegend,omitempty"`
	Suffix       string                           `json:"suffix"`
	TimeFormat   *string                          `json:"timeFormat,omitempty"`
	Type         LinePlusSingleStatPropertiesType `json:"type"`
	XColumn      *string                          `json:"xColumn,omitempty"`
	XTickStart   *float32                         `json:"xTickStart,omitempty"`
	XTickStep    *float32                         `json:"xTickStep,omitempty"`
	XTotalTicks  *int                             `json:"xTotalTicks,omitempty"`
	YColumn      *string                          `json:"yColumn,omitempty"`
	YTickStart   *float32                         `json:"yTickStart,omitempty"`
	YTickStep    *float32                         `json:"yTickStep,omitempty"`
	YTotalTicks  *int                             `json:"yTotalTicks,omitempty"`
}

LinePlusSingleStatProperties defines model for LinePlusSingleStatProperties.

type LinePlusSingleStatPropertiesHoverDimension 

type LinePlusSingleStatPropertiesHoverDimension string

LinePlusSingleStatPropertiesHoverDimension defines model for LinePlusSingleStatProperties.HoverDimension. 

const (
	LinePlusSingleStatPropertiesHoverDimensionAuto LinePlusSingleStatPropertiesHoverDimension = "auto"

	LinePlusSingleStatPropertiesHoverDimensionX LinePlusSingleStatPropertiesHoverDimension = "x"

	LinePlusSingleStatPropertiesHoverDimensionXy LinePlusSingleStatPropertiesHoverDimension = "xy"

	LinePlusSingleStatPropertiesHoverDimensionY LinePlusSingleStatPropertiesHoverDimension = "y"
)

Defines values for LinePlusSingleStatPropertiesHoverDimension.

type LinePlusSingleStatPropertiesPosition 

type LinePlusSingleStatPropertiesPosition string

LinePlusSingleStatPropertiesPosition defines model for LinePlusSingleStatProperties.Position. 

const (
	LinePlusSingleStatPropertiesPositionOverlaid LinePlusSingleStatPropertiesPosition = "overlaid"

	LinePlusSingleStatPropertiesPositionStacked LinePlusSingleStatPropertiesPosition = "stacked"
)

Defines values for LinePlusSingleStatPropertiesPosition.

type LinePlusSingleStatPropertiesShape 

type LinePlusSingleStatPropertiesShape string

LinePlusSingleStatPropertiesShape defines model for LinePlusSingleStatProperties.Shape. 

const (
	LinePlusSingleStatPropertiesShapeChronografV2 LinePlusSingleStatPropertiesShape = "chronograf-v2"
)

Defines values for LinePlusSingleStatPropertiesShape.

type LinePlusSingleStatPropertiesType 

type LinePlusSingleStatPropertiesType string

LinePlusSingleStatPropertiesType defines model for LinePlusSingleStatProperties.Type. 

const (
	LinePlusSingleStatPropertiesTypeLinePlusSingleStat LinePlusSingleStatPropertiesType = "line-plus-single-stat"
)

Defines values for LinePlusSingleStatPropertiesType.

type LineProtocolError 

type LineProtocolError struct {
	// Code is the machine-readable error code.
	Code LineProtocolErrorCode `json:"code"`

	// Stack of errors that occurred during processing of the request. Useful for debugging.
	Err *string `json:"err,omitempty"`

	// First line in the request body that contains malformed data.
	Line *int32 `json:"line,omitempty"`

	// Human-readable message.
	Message *string `json:"message,omitempty"`

	// Describes the logical code operation when the error occurred. Useful for debugging.
	Op *string `json:"op,omitempty"`
}

LineProtocolError defines model for LineProtocolError.

type LineProtocolErrorCode 

type LineProtocolErrorCode string

Code is the machine-readable error code. 

const (
	LineProtocolErrorCodeConflict LineProtocolErrorCode = "conflict"

	LineProtocolErrorCodeEmptyValue LineProtocolErrorCode = "empty value"

	LineProtocolErrorCodeInternalError LineProtocolErrorCode = "internal error"

	LineProtocolErrorCodeInvalid LineProtocolErrorCode = "invalid"

	LineProtocolErrorCodeNotFound LineProtocolErrorCode = "not found"

	LineProtocolErrorCodeUnavailable LineProtocolErrorCode = "unavailable"
)

Defines values for LineProtocolErrorCode.

type LineProtocolLengthError 

type LineProtocolLengthError struct {
	// Code is the machine-readable error code.
	Code LineProtocolLengthErrorCode `json:"code"`

	// Human-readable message.
	Message string `json:"message"`
}

LineProtocolLengthError defines model for LineProtocolLengthError.

type LineProtocolLengthErrorCode 

type LineProtocolLengthErrorCode string

Code is the machine-readable error code. 

const (
	LineProtocolLengthErrorCodeInvalid LineProtocolLengthErrorCode = "invalid"
)

Defines values for LineProtocolLengthErrorCode. 

type Link string

URI of resource. 

type Links struct {
	// URI of resource.
	Next *Link `json:"next,omitempty"`

	// URI of resource.
	Prev *Link `json:"prev,omitempty"`

	// URI of resource.
	Self Link `json:"self"`
}

URI pointers for additional paged results.

type ListStacksParams 

type ListStacksParams struct {
	// The ID of the organization that owns the stacks.
	// Only returns stacks owned by this organization.
	//
	// #### InfluxDB Cloud
	//
	// - Doesn't require this parameter;
	//   InfluxDB only returns resources allowed by the API token.
	OrgID string `json:"orgID"`

	// The stack name.
	// Finds stack `events` with this name and returns the stacks.
	//
	// Repeatable.
	// To filter for more than one stack name,
	// repeat this parameter with each name--for example:
	//
	// - `http://localhost:8086/api/v2/stacks?&orgID=INFLUX_ORG_ID&name=project-stack-0&name=project-stack-1`
	Name *string `json:"name,omitempty"`

	// The stack ID.
	// Only returns stacks with this ID.
	//
	// Repeatable.
	// To filter for more than one stack ID,
	// repeat this parameter with each ID--for example:
	//
	// - `http://localhost:8086/api/v2/stacks?&orgID=INFLUX_ORG_ID&stackID=09bd87cd33be3000&stackID=09bef35081fe3000`
	StackID *string `json:"stackID,omitempty"`
}

ListStacksParams defines parameters for ListStacks.

type LogEvent 

type LogEvent struct {
	// A description of the event that occurred.
	Message *string `json:"message,omitempty"`

	// The ID of the task run that generated the event.
	RunID *string `json:"runID,omitempty"`

	// The time ([RFC3339Nano date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339nano-timestamp)) that the event occurred.
	Time *time.Time `json:"time,omitempty"`
}

LogEvent defines model for LogEvent.

type LogicalExpression 

type LogicalExpression struct {
	Left     *Expression `json:"left,omitempty"`
	Operator *string     `json:"operator,omitempty"`
	Right    *Expression `json:"right,omitempty"`

	// Type of AST node
	Type *NodeType `json:"type,omitempty"`
}

Represents the rule conditions that collectively evaluate to either true or false

type Logs 

type Logs struct {
	Events *[]LogEvent `json:"events,omitempty"`
}

Logs defines model for Logs.

type MapVariableProperties 

type MapVariableProperties struct {
	Type   *MapVariablePropertiesType    `json:"type,omitempty"`
	Values *MapVariableProperties_Values `json:"values,omitempty"`
}

MapVariableProperties defines model for MapVariableProperties.

type MapVariablePropertiesType 

type MapVariablePropertiesType string

MapVariablePropertiesType defines model for MapVariableProperties.Type. 

const (
	MapVariablePropertiesTypeMap MapVariablePropertiesType = "map"
)

Defines values for MapVariablePropertiesType.

type MapVariableProperties_Values 

type MapVariableProperties_Values struct {
	AdditionalProperties map[string]string `json:"-"`
}

MapVariableProperties_Values defines model for MapVariableProperties.Values.

func (MapVariableProperties_Values) Get 

func (a MapVariableProperties_Values) Get(fieldName string) (value string, found bool)

Getter for additional properties for MapVariableProperties_Values. Returns the specified element and whether it was found

func (MapVariableProperties_Values) MarshalJSON 

func (a MapVariableProperties_Values) MarshalJSON() ([]byte, error)

Override default JSON handling for MapVariableProperties_Values to handle AdditionalProperties

func (*MapVariableProperties_Values) Set 

func (a *MapVariableProperties_Values) Set(fieldName string, value string)

Setter for additional properties for MapVariableProperties_Values

func (*MapVariableProperties_Values) UnmarshalJSON 

func (a *MapVariableProperties_Values) UnmarshalJSON(b []byte) error

Override default JSON handling for MapVariableProperties_Values to handle AdditionalProperties

type MarkdownViewProperties 

type MarkdownViewProperties struct {
	Note  string                      `json:"note"`
	Shape MarkdownViewPropertiesShape `json:"shape"`
	Type  MarkdownViewPropertiesType  `json:"type"`
}

MarkdownViewProperties defines model for MarkdownViewProperties.

type MarkdownViewPropertiesShape 

type MarkdownViewPropertiesShape string

MarkdownViewPropertiesShape defines model for MarkdownViewProperties.Shape. 

const (
	MarkdownViewPropertiesShapeChronografV2 MarkdownViewPropertiesShape = "chronograf-v2"
)

Defines values for MarkdownViewPropertiesShape.

type MarkdownViewPropertiesType 

type MarkdownViewPropertiesType string

MarkdownViewPropertiesType defines model for MarkdownViewProperties.Type. 

const (
	MarkdownViewPropertiesTypeMarkdown MarkdownViewPropertiesType = "markdown"
)

Defines values for MarkdownViewPropertiesType.

type MemberAssignment 

type MemberAssignment struct {
	Init *Expression `json:"init,omitempty"`

	// Represents accessing a property of an object
	Member *MemberExpression `json:"member,omitempty"`

	// Type of AST node
	Type *NodeType `json:"type,omitempty"`
}

Object property assignment

type MemberExpression 

type MemberExpression struct {
	Object   *Expression  `json:"object,omitempty"`
	Property *PropertyKey `json:"property,omitempty"`

	// Type of AST node
	Type *NodeType `json:"type,omitempty"`
}

Represents accessing a property of an object

type MetadataBackup added in v2.5.0 

type MetadataBackup struct {
	Buckets BucketMetadataManifests `json:"buckets"`
	Kv      string                  `json:"kv"`
	Sql     string                  `json:"sql"`
}

MetadataBackup defines model for MetadataBackup.

type MosaicViewProperties 

type MosaicViewProperties struct {
	// Colors define color encoding of data into a visualization
	Colors                     []string                            `json:"colors"`
	FillColumns                []string                            `json:"fillColumns"`
	GenerateXAxisTicks         *[]string                           `json:"generateXAxisTicks,omitempty"`
	HoverDimension             *MosaicViewPropertiesHoverDimension `json:"hoverDimension,omitempty"`
	LegendColorizeRows         *bool                               `json:"legendColorizeRows,omitempty"`
	LegendHide                 *bool                               `json:"legendHide,omitempty"`
	LegendOpacity              *float32                            `json:"legendOpacity,omitempty"`
	LegendOrientationThreshold *int                                `json:"legendOrientationThreshold,omitempty"`
	Note                       string                              `json:"note"`
	Queries                    []DashboardQuery                    `json:"queries"`
	Shape                      MosaicViewPropertiesShape           `json:"shape"`

	// If true, will display note when empty
	ShowNoteWhenEmpty     bool                     `json:"showNoteWhenEmpty"`
	TimeFormat            *string                  `json:"timeFormat,omitempty"`
	Type                  MosaicViewPropertiesType `json:"type"`
	XAxisLabel            string                   `json:"xAxisLabel"`
	XColumn               string                   `json:"xColumn"`
	XDomain               []float32                `json:"xDomain"`
	XPrefix               string                   `json:"xPrefix"`
	XSuffix               string                   `json:"xSuffix"`
	XTickStart            *float32                 `json:"xTickStart,omitempty"`
	XTickStep             *float32                 `json:"xTickStep,omitempty"`
	XTotalTicks           *int                     `json:"xTotalTicks,omitempty"`
	YAxisLabel            string                   `json:"yAxisLabel"`
	YDomain               []float32                `json:"yDomain"`
	YLabelColumnSeparator *string                  `json:"yLabelColumnSeparator,omitempty"`
	YLabelColumns         *[]string                `json:"yLabelColumns,omitempty"`
	YPrefix               string                   `json:"yPrefix"`
	YSeriesColumns        []string                 `json:"ySeriesColumns"`
	YSuffix               string                   `json:"ySuffix"`
}

MosaicViewProperties defines model for MosaicViewProperties.

type MosaicViewPropertiesHoverDimension added in v2.3.0 

type MosaicViewPropertiesHoverDimension string

MosaicViewPropertiesHoverDimension defines model for MosaicViewProperties.HoverDimension. 

const (
	MosaicViewPropertiesHoverDimensionAuto MosaicViewPropertiesHoverDimension = "auto"

	MosaicViewPropertiesHoverDimensionX MosaicViewPropertiesHoverDimension = "x"

	MosaicViewPropertiesHoverDimensionXy MosaicViewPropertiesHoverDimension = "xy"

	MosaicViewPropertiesHoverDimensionY MosaicViewPropertiesHoverDimension = "y"
)

Defines values for MosaicViewPropertiesHoverDimension.

type MosaicViewPropertiesShape 

type MosaicViewPropertiesShape string

MosaicViewPropertiesShape defines model for MosaicViewProperties.Shape. 

const (
	MosaicViewPropertiesShapeChronografV2 MosaicViewPropertiesShape = "chronograf-v2"
)

Defines values for MosaicViewPropertiesShape.

type MosaicViewPropertiesType 

type MosaicViewPropertiesType string

MosaicViewPropertiesType defines model for MosaicViewProperties.Type. 

const (
	MosaicViewPropertiesTypeMosaic MosaicViewPropertiesType = "mosaic"
)

Defines values for MosaicViewPropertiesType.

type Node 

type Node interface{}

Node defines model for Node.

type NodeType 

type NodeType string

Type of AST node

type NotificationEndpoint 

type NotificationEndpoint struct {
	// Embedded struct due to allOf(#/components/schemas/NotificationEndpointDiscriminator)
	NotificationEndpointDiscriminator `yaml:",inline"`
}

NotificationEndpoint defines model for NotificationEndpoint.

type NotificationEndpointBase 

type NotificationEndpointBase struct {
	CreatedAt *time.Time `json:"createdAt,omitempty"`

	// An optional description of the notification endpoint.
	Description *string `json:"description,omitempty"`
	Id          *string `json:"id,omitempty"`
	Labels      *Labels `json:"labels,omitempty"`
	Links       *struct {
		// URI of resource.
		Labels *Link `json:"labels,omitempty"`

		// URI of resource.
		Members *Link `json:"members,omitempty"`

		// URI of resource.
		Owners *Link `json:"owners,omitempty"`

		// URI of resource.
		Self *Link `json:"self,omitempty"`
	} `json:"links,omitempty"`
	Name  string  `json:"name"`
	OrgID *string `json:"orgID,omitempty"`

	// The status of the endpoint.
	Status    *NotificationEndpointBaseStatus `json:"status,omitempty"`
	Type      NotificationEndpointType        `json:"type"`
	UpdatedAt *time.Time                      `json:"updatedAt,omitempty"`
	UserID    *string                         `json:"userID,omitempty"`
}

NotificationEndpointBase defines model for NotificationEndpointBase.

type NotificationEndpointBaseStatus 

type NotificationEndpointBaseStatus string

The status of the endpoint. 

const (
	NotificationEndpointBaseStatusActive NotificationEndpointBaseStatus = "active"

	NotificationEndpointBaseStatusInactive NotificationEndpointBaseStatus = "inactive"
)

Defines values for NotificationEndpointBaseStatus.

type NotificationEndpointDiscriminator added in v2.5.0 

type NotificationEndpointDiscriminator interface{}

NotificationEndpointDiscriminator defines model for NotificationEndpointDiscriminator.

type NotificationEndpointType 

type NotificationEndpointType string

NotificationEndpointType defines model for NotificationEndpointType. 

const (
	NotificationEndpointTypeHttp NotificationEndpointType = "http"

	NotificationEndpointTypePagerduty NotificationEndpointType = "pagerduty"

	NotificationEndpointTypeSlack NotificationEndpointType = "slack"

	NotificationEndpointTypeTelegram NotificationEndpointType = "telegram"
)

Defines values for NotificationEndpointType.

type NotificationEndpointUpdate 

type NotificationEndpointUpdate struct {
	Description *string                           `json:"description,omitempty"`
	Name        *string                           `json:"name,omitempty"`
	Status      *NotificationEndpointUpdateStatus `json:"status,omitempty"`
}

NotificationEndpointUpdate defines model for NotificationEndpointUpdate.

type NotificationEndpointUpdateStatus 

type NotificationEndpointUpdateStatus string

NotificationEndpointUpdateStatus defines model for NotificationEndpointUpdate.Status. 

const (
	NotificationEndpointUpdateStatusActive NotificationEndpointUpdateStatus = "active"

	NotificationEndpointUpdateStatusInactive NotificationEndpointUpdateStatus = "inactive"
)

Defines values for NotificationEndpointUpdateStatus.

type NotificationEndpoints 

type NotificationEndpoints struct {
	// URI pointers for additional paged results.
	Links                 *Links                  `json:"links,omitempty"`
	NotificationEndpoints *[]NotificationEndpoint `json:"notificationEndpoints,omitempty"`
}

NotificationEndpoints defines model for NotificationEndpoints.

type NotificationRule 

type NotificationRule struct {
	// Embedded struct due to allOf(#/components/schemas/NotificationRuleDiscriminator)
	NotificationRuleDiscriminator `yaml:",inline"`
}

NotificationRule defines model for NotificationRule.

type NotificationRuleBase 

type NotificationRuleBase struct {
	CreatedAt *time.Time `json:"createdAt,omitempty"`

	// An optional description of the notification rule.
	Description *string `json:"description,omitempty"`
	EndpointID  string  `json:"endpointID"`

	// The notification repetition interval.
	Every         *string                            `json:"every,omitempty"`
	Id            *string                            `json:"id,omitempty"`
	Labels        *Labels                            `json:"labels,omitempty"`
	LastRunError  *string                            `json:"lastRunError,omitempty"`
	LastRunStatus *NotificationRuleBaseLastRunStatus `json:"lastRunStatus,omitempty"`

	// A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run.
	LatestCompleted *time.Time `json:"latestCompleted,omitempty"`

	// Don't notify me more than <limit> times every <limitEvery> seconds. If set, limitEvery cannot be empty.
	Limit *int `json:"limit,omitempty"`

	// Don't notify me more than <limit> times every <limitEvery> seconds. If set, limit cannot be empty.
	LimitEvery *int `json:"limitEvery,omitempty"`
	Links      *struct {
		// URI of resource.
		Labels *Link `json:"labels,omitempty"`

		// URI of resource.
		Members *Link `json:"members,omitempty"`

		// URI of resource.
		Owners *Link `json:"owners,omitempty"`

		// URI of resource.
		Query *Link `json:"query,omitempty"`

		// URI of resource.
		Self *Link `json:"self,omitempty"`
	} `json:"links,omitempty"`

	// Human-readable name describing the notification rule.
	Name string `json:"name"`

	// Duration to delay after the schedule, before executing check.
	Offset *string `json:"offset,omitempty"`

	// The ID of the organization that owns this notification rule.
	OrgID string `json:"orgID"`

	// The ID of creator used to create this notification rule.
	OwnerID     *string `json:"ownerID,omitempty"`
	RunbookLink *string `json:"runbookLink,omitempty"`
	SleepUntil  *string `json:"sleepUntil,omitempty"`

	// `inactive` cancels scheduled runs and prevents manual runs of the task.
	Status TaskStatusType `json:"status"`

	// List of status rules the notification rule attempts to match.
	StatusRules []StatusRule `json:"statusRules"`

	// List of tag rules the notification rule attempts to match.
	TagRules *[]TagRule `json:"tagRules,omitempty"`

	// The ID of the task associated with this notification rule.
	TaskID    *string    `json:"taskID,omitempty"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
}

NotificationRuleBase defines model for NotificationRuleBase.

type NotificationRuleBaseLastRunStatus 

type NotificationRuleBaseLastRunStatus string

NotificationRuleBaseLastRunStatus defines model for NotificationRuleBase.LastRunStatus. 

const (
	NotificationRuleBaseLastRunStatusCanceled NotificationRuleBaseLastRunStatus = "canceled"

	NotificationRuleBaseLastRunStatusFailed NotificationRuleBaseLastRunStatus = "failed"

	NotificationRuleBaseLastRunStatusSuccess NotificationRuleBaseLastRunStatus = "success"
)

Defines values for NotificationRuleBaseLastRunStatus.

type NotificationRuleDiscriminator 

type NotificationRuleDiscriminator interface{}

NotificationRuleDiscriminator defines model for NotificationRuleDiscriminator.

type NotificationRuleUpdate 

type NotificationRuleUpdate struct {
	Description *string                       `json:"description,omitempty"`
	Name        *string                       `json:"name,omitempty"`
	Status      *NotificationRuleUpdateStatus `json:"status,omitempty"`
}

NotificationRuleUpdate defines model for NotificationRuleUpdate.

type NotificationRuleUpdateStatus 

type NotificationRuleUpdateStatus string

NotificationRuleUpdateStatus defines model for NotificationRuleUpdate.Status. 

const (
	NotificationRuleUpdateStatusActive NotificationRuleUpdateStatus = "active"

	NotificationRuleUpdateStatusInactive NotificationRuleUpdateStatus = "inactive"
)

Defines values for NotificationRuleUpdateStatus.

type NotificationRules 

type NotificationRules struct {
	// URI pointers for additional paged results.
	Links             *Links              `json:"links,omitempty"`
	NotificationRules *[]NotificationRule `json:"notificationRules,omitempty"`
}

NotificationRules defines model for NotificationRules.

type ObjectExpression 

type ObjectExpression struct {
	// Object properties
	Properties *[]Property `json:"properties,omitempty"`

	// Type of AST node
	Type *NodeType `json:"type,omitempty"`
}

Allows the declaration of an anonymous object within a declaration

type Offset 

type Offset int

Offset defines model for Offset.

type OnboardingRequest 

type OnboardingRequest struct {
	Bucket   string  `json:"bucket"`
	Org      string  `json:"org"`
	Password *string `json:"password,omitempty"`

	// 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`
	RetentionPeriodHrs     *int   `json:"retentionPeriodHrs,omitempty"`
	RetentionPeriodSeconds *int64 `json:"retentionPeriodSeconds,omitempty"`

	// Authentication token to set on the initial user. If not specified, the server will generate a token.
	Token    *string `json:"token,omitempty"`
	Username string  `json:"username"`
}

OnboardingRequest defines model for OnboardingRequest.

type OnboardingResponse 

type OnboardingResponse struct {
	Auth   *Authorization `json:"auth,omitempty"`
	Bucket *Bucket        `json:"bucket,omitempty"`
	Org    *Organization  `json:"org,omitempty"`
	User   *UserResponse  `json:"user,omitempty"`
}

OnboardingResponse defines model for OnboardingResponse.

type OptionStatement 

type OptionStatement struct {
	Assignment *interface{} `json:"assignment,omitempty"`

	// Type of AST node
	Type *NodeType `json:"type,omitempty"`
}

A single variable declaration

type Organization 

type Organization struct {
	CreatedAt   *time.Time `json:"createdAt,omitempty"`
	Description *string    `json:"description,omitempty"`
	Id          *string    `json:"id,omitempty"`
	Links       *struct {
		// URI of resource.
		Buckets *Link `json:"buckets,omitempty"`

		// URI of resource.
		Dashboards *Link `json:"dashboards,omitempty"`

		// URI of resource.
		Labels *Link `json:"labels,omitempty"`

		// URI of resource.
		Members *Link `json:"members,omitempty"`

		// URI of resource.
		Owners *Link `json:"owners,omitempty"`

		// URI of resource.
		Secrets *Link `json:"secrets,omitempty"`

		// URI of resource.
		Self *Link `json:"self,omitempty"`

		// URI of resource.
		Tasks *Link `json:"tasks,omitempty"`
	} `json:"links,omitempty"`
	Name string `json:"name"`

	// If inactive the organization is inactive.
	Status    *OrganizationStatus `json:"status,omitempty"`
	UpdatedAt *time.Time          `json:"updatedAt,omitempty"`
}

Organization defines model for Organization.

type OrganizationStatus 

type OrganizationStatus string

If inactive the organization is inactive. 

const (
	OrganizationStatusActive OrganizationStatus = "active"

	OrganizationStatusInactive OrganizationStatus = "inactive"
)

Defines values for OrganizationStatus.

type Organizations 

type Organizations struct {
	// URI pointers for additional paged results.
	Links *Links          `json:"links,omitempty"`
	Orgs  *[]Organization `json:"orgs,omitempty"`
}

Organizations defines model for Organizations.

type Package 

type Package struct {
	// Package files
	Files *[]File `json:"files,omitempty"`

	// Package name
	Package *string `json:"package,omitempty"`

	// Package import path
	Path *string `json:"path,omitempty"`

	// Type of AST node
	Type *NodeType `json:"type,omitempty"`
}

Represents a complete package source tree.

type PackageClause 

type PackageClause struct {
	// A valid Flux identifier
	Name *Identifier `json:"name,omitempty"`

	// Type of AST node
	Type *NodeType `json:"type,omitempty"`
}

Defines a package identifier

type PagerDutyNotificationEndpoint 

type PagerDutyNotificationEndpoint struct {
	// Embedded struct due to allOf(#/components/schemas/NotificationEndpointBase)
	NotificationEndpointBase `yaml:",inline"`
	// Embedded fields due to inline allOf schema
	ClientURL  *string `json:"clientURL,omitempty"`
	RoutingKey string  `json:"routingKey"`
}

PagerDutyNotificationEndpoint defines model for PagerDutyNotificationEndpoint.

type PagerDutyNotificationRule 

type PagerDutyNotificationRule struct {
	// Embedded struct due to allOf(#/components/schemas/NotificationRuleBase)
	NotificationRuleBase `yaml:",inline"`
	// Embedded struct due to allOf(#/components/schemas/PagerDutyNotificationRuleBase)
	PagerDutyNotificationRuleBase `yaml:",inline"`
}

PagerDutyNotificationRule defines model for PagerDutyNotificationRule.

type PagerDutyNotificationRuleBase 

type PagerDutyNotificationRuleBase struct {
	MessageTemplate string                            `json:"messageTemplate"`
	Type            PagerDutyNotificationRuleBaseType `json:"type"`
}

PagerDutyNotificationRuleBase defines model for PagerDutyNotificationRuleBase.

type PagerDutyNotificationRuleBaseType 

type PagerDutyNotificationRuleBaseType string

PagerDutyNotificationRuleBaseType defines model for PagerDutyNotificationRuleBase.Type. 

const (
	PagerDutyNotificationRuleBaseTypePagerduty PagerDutyNotificationRuleBaseType = "pagerduty"
)

Defines values for PagerDutyNotificationRuleBaseType.

type ParenExpression 

type ParenExpression struct {
	Expression *Expression `json:"expression,omitempty"`

	// Type of AST node
	Type *NodeType `json:"type,omitempty"`
}

Represents an expression wrapped in parenthesis

type PasswordResetBody 

type PasswordResetBody struct {
	Password string `json:"password"`
}

PasswordResetBody defines model for PasswordResetBody.

type PatchAuthorizationsIDAllParams added in v2.11.0 

type PatchAuthorizationsIDAllParams struct {
	PatchAuthorizationsIDParams

	AuthID string

	Body PatchAuthorizationsIDJSONRequestBody
}

PatchAuthorizationsIDAllParams defines type for all parameters for PatchAuthorizationsID.

type PatchAuthorizationsIDJSONBody 

type PatchAuthorizationsIDJSONBody AuthorizationUpdateRequest

PatchAuthorizationsIDJSONBody defines parameters for PatchAuthorizationsID.

type PatchAuthorizationsIDJSONRequestBody 

type PatchAuthorizationsIDJSONRequestBody PatchAuthorizationsIDJSONBody

PatchAuthorizationsIDJSONRequestBody defines body for PatchAuthorizationsID for application/json ContentType.

type PatchAuthorizationsIDParams 

type PatchAuthorizationsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PatchAuthorizationsIDParams defines parameters for PatchAuthorizationsID.

type PatchBucketRequest added in v2.5.0 

type PatchBucketRequest struct {
	// A description of the bucket.
	Description *string `json:"description,omitempty"`

	// The name of the bucket.
	Name *string `json:"name,omitempty"`

	// Updates to rules to expire or retain data. No rules means no updates.
	RetentionRules *PatchRetentionRules `json:"retentionRules,omitempty"`
}

An object that contains updated bucket properties to apply.

type PatchBucketsIDAllParams added in v2.11.0 

type PatchBucketsIDAllParams struct {
	PatchBucketsIDParams

	BucketID string

	Body PatchBucketsIDJSONRequestBody
}

PatchBucketsIDAllParams defines type for all parameters for PatchBucketsID.

type PatchBucketsIDJSONBody 

type PatchBucketsIDJSONBody PatchBucketRequest

PatchBucketsIDJSONBody defines parameters for PatchBucketsID.

type PatchBucketsIDJSONRequestBody 

type PatchBucketsIDJSONRequestBody PatchBucketsIDJSONBody

PatchBucketsIDJSONRequestBody defines body for PatchBucketsID for application/json ContentType.

type PatchBucketsIDParams 

type PatchBucketsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PatchBucketsIDParams defines parameters for PatchBucketsID.

type PatchChecksIDAllParams added in v2.11.0 

type PatchChecksIDAllParams struct {
	PatchChecksIDParams

	CheckID string

	Body PatchChecksIDJSONRequestBody
}

PatchChecksIDAllParams defines type for all parameters for PatchChecksID.

type PatchChecksIDJSONBody 

type PatchChecksIDJSONBody CheckPatch

PatchChecksIDJSONBody defines parameters for PatchChecksID.

type PatchChecksIDJSONRequestBody 

type PatchChecksIDJSONRequestBody PatchChecksIDJSONBody

PatchChecksIDJSONRequestBody defines body for PatchChecksID for application/json ContentType.

type PatchChecksIDParams 

type PatchChecksIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PatchChecksIDParams defines parameters for PatchChecksID.

type PatchDBRPIDAllParams added in v2.11.0 

type PatchDBRPIDAllParams struct {
	PatchDBRPIDParams

	DbrpID string

	Body PatchDBRPIDJSONRequestBody
}

PatchDBRPIDAllParams defines type for all parameters for PatchDBRPID.

type PatchDBRPIDJSONBody 

type PatchDBRPIDJSONBody DBRPUpdate

PatchDBRPIDJSONBody defines parameters for PatchDBRPID.

type PatchDBRPIDJSONRequestBody 

type PatchDBRPIDJSONRequestBody PatchDBRPIDJSONBody

PatchDBRPIDJSONRequestBody defines body for PatchDBRPID for application/json ContentType.

type PatchDBRPIDParams 

type PatchDBRPIDParams struct {
	// Specifies the organization ID of the mapping
	OrgID *string `json:"orgID,omitempty"`

	// Specifies the organization name of the mapping
	Org *string `json:"org,omitempty"`

	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PatchDBRPIDParams defines parameters for PatchDBRPID.

type PatchDashboardsIDAllParams added in v2.11.0 

type PatchDashboardsIDAllParams struct {
	PatchDashboardsIDParams

	DashboardID string

	Body PatchDashboardsIDJSONRequestBody
}

PatchDashboardsIDAllParams defines type for all parameters for PatchDashboardsID.

type PatchDashboardsIDCellsIDAllParams added in v2.11.0 

type PatchDashboardsIDCellsIDAllParams struct {
	PatchDashboardsIDCellsIDParams

	DashboardID string

	CellID string

	Body PatchDashboardsIDCellsIDJSONRequestBody
}

PatchDashboardsIDCellsIDAllParams defines type for all parameters for PatchDashboardsIDCellsID.

type PatchDashboardsIDCellsIDJSONBody 

type PatchDashboardsIDCellsIDJSONBody CellUpdate

PatchDashboardsIDCellsIDJSONBody defines parameters for PatchDashboardsIDCellsID.

type PatchDashboardsIDCellsIDJSONRequestBody 

type PatchDashboardsIDCellsIDJSONRequestBody PatchDashboardsIDCellsIDJSONBody

PatchDashboardsIDCellsIDJSONRequestBody defines body for PatchDashboardsIDCellsID for application/json ContentType.

type PatchDashboardsIDCellsIDParams 

type PatchDashboardsIDCellsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PatchDashboardsIDCellsIDParams defines parameters for PatchDashboardsIDCellsID.

type PatchDashboardsIDCellsIDViewAllParams added in v2.11.0 

type PatchDashboardsIDCellsIDViewAllParams struct {
	PatchDashboardsIDCellsIDViewParams

	DashboardID string

	CellID string

	Body PatchDashboardsIDCellsIDViewJSONRequestBody
}

PatchDashboardsIDCellsIDViewAllParams defines type for all parameters for PatchDashboardsIDCellsIDView.

type PatchDashboardsIDCellsIDViewJSONBody 

type PatchDashboardsIDCellsIDViewJSONBody View

PatchDashboardsIDCellsIDViewJSONBody defines parameters for PatchDashboardsIDCellsIDView.

type PatchDashboardsIDCellsIDViewJSONRequestBody 

type PatchDashboardsIDCellsIDViewJSONRequestBody PatchDashboardsIDCellsIDViewJSONBody

PatchDashboardsIDCellsIDViewJSONRequestBody defines body for PatchDashboardsIDCellsIDView for application/json ContentType.

type PatchDashboardsIDCellsIDViewParams 

type PatchDashboardsIDCellsIDViewParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PatchDashboardsIDCellsIDViewParams defines parameters for PatchDashboardsIDCellsIDView.

type PatchDashboardsIDJSONBody 

type PatchDashboardsIDJSONBody struct {
	Cells *CellWithViewProperties `json:"cells,omitempty"`

	// optional, when provided will replace the description
	Description *string `json:"description,omitempty"`

	// optional, when provided will replace the name
	Name *string `json:"name,omitempty"`
}

PatchDashboardsIDJSONBody defines parameters for PatchDashboardsID.

type PatchDashboardsIDJSONRequestBody 

type PatchDashboardsIDJSONRequestBody PatchDashboardsIDJSONBody

PatchDashboardsIDJSONRequestBody defines body for PatchDashboardsID for application/json ContentType.

type PatchDashboardsIDParams 

type PatchDashboardsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PatchDashboardsIDParams defines parameters for PatchDashboardsID.

type PatchLabelsIDAllParams added in v2.11.0 

type PatchLabelsIDAllParams struct {
	PatchLabelsIDParams

	LabelID string

	Body PatchLabelsIDJSONRequestBody
}

PatchLabelsIDAllParams defines type for all parameters for PatchLabelsID.

type PatchLabelsIDJSONBody 

type PatchLabelsIDJSONBody LabelUpdate

PatchLabelsIDJSONBody defines parameters for PatchLabelsID.

type PatchLabelsIDJSONRequestBody 

type PatchLabelsIDJSONRequestBody PatchLabelsIDJSONBody

PatchLabelsIDJSONRequestBody defines body for PatchLabelsID for application/json ContentType.

type PatchLabelsIDParams 

type PatchLabelsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PatchLabelsIDParams defines parameters for PatchLabelsID.

type PatchNotificationEndpointsIDAllParams added in v2.11.0 

type PatchNotificationEndpointsIDAllParams struct {
	PatchNotificationEndpointsIDParams

	EndpointID string

	Body PatchNotificationEndpointsIDJSONRequestBody
}

PatchNotificationEndpointsIDAllParams defines type for all parameters for PatchNotificationEndpointsID.

type PatchNotificationEndpointsIDJSONBody 

type PatchNotificationEndpointsIDJSONBody NotificationEndpointUpdate

PatchNotificationEndpointsIDJSONBody defines parameters for PatchNotificationEndpointsID.

type PatchNotificationEndpointsIDJSONRequestBody 

type PatchNotificationEndpointsIDJSONRequestBody PatchNotificationEndpointsIDJSONBody

PatchNotificationEndpointsIDJSONRequestBody defines body for PatchNotificationEndpointsID for application/json ContentType.

type PatchNotificationEndpointsIDParams 

type PatchNotificationEndpointsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PatchNotificationEndpointsIDParams defines parameters for PatchNotificationEndpointsID.

type PatchNotificationRulesIDAllParams added in v2.11.0 

type PatchNotificationRulesIDAllParams struct {
	PatchNotificationRulesIDParams

	RuleID string

	Body PatchNotificationRulesIDJSONRequestBody
}

PatchNotificationRulesIDAllParams defines type for all parameters for PatchNotificationRulesID.

type PatchNotificationRulesIDJSONBody 

type PatchNotificationRulesIDJSONBody NotificationRuleUpdate

PatchNotificationRulesIDJSONBody defines parameters for PatchNotificationRulesID.

type PatchNotificationRulesIDJSONRequestBody 

type PatchNotificationRulesIDJSONRequestBody PatchNotificationRulesIDJSONBody

PatchNotificationRulesIDJSONRequestBody defines body for PatchNotificationRulesID for application/json ContentType.

type PatchNotificationRulesIDParams 

type PatchNotificationRulesIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PatchNotificationRulesIDParams defines parameters for PatchNotificationRulesID.

type PatchOrganizationRequest added in v2.5.0 

type PatchOrganizationRequest struct {
	// New description to set on the organization
	Description *string `json:"description,omitempty"`

	// New name to set on the organization
	Name *string `json:"name,omitempty"`
}

PatchOrganizationRequest defines model for PatchOrganizationRequest.

type PatchOrgsIDAllParams added in v2.11.0 

type PatchOrgsIDAllParams struct {
	PatchOrgsIDParams

	OrgID string

	Body PatchOrgsIDJSONRequestBody
}

PatchOrgsIDAllParams defines type for all parameters for PatchOrgsID.

type PatchOrgsIDJSONBody 

type PatchOrgsIDJSONBody PatchOrganizationRequest

PatchOrgsIDJSONBody defines parameters for PatchOrgsID.

type PatchOrgsIDJSONRequestBody 

type PatchOrgsIDJSONRequestBody PatchOrgsIDJSONBody

PatchOrgsIDJSONRequestBody defines body for PatchOrgsID for application/json ContentType.

type PatchOrgsIDParams 

type PatchOrgsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PatchOrgsIDParams defines parameters for PatchOrgsID.

type PatchOrgsIDSecretsAllParams added in v2.11.0 

type PatchOrgsIDSecretsAllParams struct {
	PatchOrgsIDSecretsParams

	OrgID string

	Body PatchOrgsIDSecretsJSONRequestBody
}

PatchOrgsIDSecretsAllParams defines type for all parameters for PatchOrgsIDSecrets.

type PatchOrgsIDSecretsJSONBody 

type PatchOrgsIDSecretsJSONBody Secrets

PatchOrgsIDSecretsJSONBody defines parameters for PatchOrgsIDSecrets.

type PatchOrgsIDSecretsJSONRequestBody 

type PatchOrgsIDSecretsJSONRequestBody PatchOrgsIDSecretsJSONBody

PatchOrgsIDSecretsJSONRequestBody defines body for PatchOrgsIDSecrets for application/json ContentType.

type PatchOrgsIDSecretsParams 

type PatchOrgsIDSecretsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PatchOrgsIDSecretsParams defines parameters for PatchOrgsIDSecrets.

type PatchRemoteConnectionByIDAllParams added in v2.11.0 

type PatchRemoteConnectionByIDAllParams struct {
	PatchRemoteConnectionByIDParams

	RemoteID string

	Body PatchRemoteConnectionByIDJSONRequestBody
}

PatchRemoteConnectionByIDAllParams defines type for all parameters for PatchRemoteConnectionByID.

type PatchRemoteConnectionByIDJSONBody added in v2.8.0 

type PatchRemoteConnectionByIDJSONBody RemoteConnectionUpdateRequest

PatchRemoteConnectionByIDJSONBody defines parameters for PatchRemoteConnectionByID.

type PatchRemoteConnectionByIDJSONRequestBody added in v2.8.0 

type PatchRemoteConnectionByIDJSONRequestBody PatchRemoteConnectionByIDJSONBody

PatchRemoteConnectionByIDJSONRequestBody defines body for PatchRemoteConnectionByID for application/json ContentType.

type PatchRemoteConnectionByIDParams added in v2.8.0 

type PatchRemoteConnectionByIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PatchRemoteConnectionByIDParams defines parameters for PatchRemoteConnectionByID.

type PatchReplicationByIDAllParams added in v2.11.0 

type PatchReplicationByIDAllParams struct {
	PatchReplicationByIDParams

	ReplicationID string

	Body PatchReplicationByIDJSONRequestBody
}

PatchReplicationByIDAllParams defines type for all parameters for PatchReplicationByID.

type PatchReplicationByIDJSONBody added in v2.8.0 

type PatchReplicationByIDJSONBody ReplicationUpdateRequest

PatchReplicationByIDJSONBody defines parameters for PatchReplicationByID.

type PatchReplicationByIDJSONRequestBody added in v2.8.0 

type PatchReplicationByIDJSONRequestBody PatchReplicationByIDJSONBody

PatchReplicationByIDJSONRequestBody defines body for PatchReplicationByID for application/json ContentType.

type PatchReplicationByIDParams added in v2.8.0 

type PatchReplicationByIDParams struct {
	// If true, validate the updated information, but don't save it.
	Validate *bool `json:"validate,omitempty"`

	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PatchReplicationByIDParams defines parameters for PatchReplicationByID.

type PatchRetentionRule added in v2.5.0 

type PatchRetentionRule struct {
	// The number of seconds to keep data.
	// Default duration is `2592000` (30 days).
	// `0` represents infinite retention.
	EverySeconds int64 `json:"everySeconds"`

	// The [shard group duration](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#shard).
	// The number of seconds that each shard group covers.
	//
	// #### InfluxDB Cloud
	//
	// - Doesn't use `shardGroupDurationsSeconds`.
	//
	// #### InfluxDB OSS
	//
	// - Default value depends on the [bucket retention period](https://docs.influxdata.com/influxdb/v2.3/reference/internals/shards/#shard-group-duration).
	//
	// #### Related guides
	//
	// - InfluxDB [shards and shard groups](https://docs.influxdata.com/influxdb/v2.3/reference/internals/shards/)
	ShardGroupDurationSeconds *int64                  `json:"shardGroupDurationSeconds,omitempty"`
	Type                      *PatchRetentionRuleType `json:"type,omitempty"`
}

PatchRetentionRule defines model for PatchRetentionRule.

type PatchRetentionRuleType added in v2.5.0 

type PatchRetentionRuleType string

PatchRetentionRuleType defines model for PatchRetentionRule.Type. 

const (
	PatchRetentionRuleTypeExpire PatchRetentionRuleType = "expire"
)

Defines values for PatchRetentionRuleType.

type PatchRetentionRules added in v2.5.0 

type PatchRetentionRules []PatchRetentionRule

Updates to rules to expire or retain data. No rules means no updates.

type PatchScrapersIDAllParams added in v2.11.0 

type PatchScrapersIDAllParams struct {
	PatchScrapersIDParams

	ScraperTargetID string

	Body PatchScrapersIDJSONRequestBody
}

PatchScrapersIDAllParams defines type for all parameters for PatchScrapersID.

type PatchScrapersIDJSONBody 

type PatchScrapersIDJSONBody ScraperTargetRequest

PatchScrapersIDJSONBody defines parameters for PatchScrapersID.

type PatchScrapersIDJSONRequestBody 

type PatchScrapersIDJSONRequestBody PatchScrapersIDJSONBody

PatchScrapersIDJSONRequestBody defines body for PatchScrapersID for application/json ContentType.

type PatchScrapersIDParams 

type PatchScrapersIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PatchScrapersIDParams defines parameters for PatchScrapersID.

type PatchSourcesIDAllParams added in v2.11.0 

type PatchSourcesIDAllParams struct {
	PatchSourcesIDParams

	SourceID string

	Body PatchSourcesIDJSONRequestBody
}

PatchSourcesIDAllParams defines type for all parameters for PatchSourcesID.

type PatchSourcesIDJSONBody 

type PatchSourcesIDJSONBody Source

PatchSourcesIDJSONBody defines parameters for PatchSourcesID.

type PatchSourcesIDJSONRequestBody 

type PatchSourcesIDJSONRequestBody PatchSourcesIDJSONBody

PatchSourcesIDJSONRequestBody defines body for PatchSourcesID for application/json ContentType.

type PatchSourcesIDParams 

type PatchSourcesIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PatchSourcesIDParams defines parameters for PatchSourcesID.

type PatchTasksIDAllParams added in v2.11.0 

type PatchTasksIDAllParams struct {
	PatchTasksIDParams

	TaskID string

	Body PatchTasksIDJSONRequestBody
}

PatchTasksIDAllParams defines type for all parameters for PatchTasksID.

type PatchTasksIDJSONBody 

type PatchTasksIDJSONBody TaskUpdateRequest

PatchTasksIDJSONBody defines parameters for PatchTasksID.

type PatchTasksIDJSONRequestBody 

type PatchTasksIDJSONRequestBody PatchTasksIDJSONBody

PatchTasksIDJSONRequestBody defines body for PatchTasksID for application/json ContentType.

type PatchTasksIDParams 

type PatchTasksIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PatchTasksIDParams defines parameters for PatchTasksID.

type PatchUsersIDAllParams added in v2.11.0 

type PatchUsersIDAllParams struct {
	PatchUsersIDParams

	UserID string

	Body PatchUsersIDJSONRequestBody
}

PatchUsersIDAllParams defines type for all parameters for PatchUsersID.

type PatchUsersIDJSONBody 

type PatchUsersIDJSONBody User

PatchUsersIDJSONBody defines parameters for PatchUsersID.

type PatchUsersIDJSONRequestBody 

type PatchUsersIDJSONRequestBody PatchUsersIDJSONBody

PatchUsersIDJSONRequestBody defines body for PatchUsersID for application/json ContentType.

type PatchUsersIDParams 

type PatchUsersIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PatchUsersIDParams defines parameters for PatchUsersID.

type PatchVariablesIDAllParams added in v2.11.0 

type PatchVariablesIDAllParams struct {
	PatchVariablesIDParams

	VariableID string

	Body PatchVariablesIDJSONRequestBody
}

PatchVariablesIDAllParams defines type for all parameters for PatchVariablesID.

type PatchVariablesIDJSONBody 

type PatchVariablesIDJSONBody Variable

PatchVariablesIDJSONBody defines parameters for PatchVariablesID.

type PatchVariablesIDJSONRequestBody 

type PatchVariablesIDJSONRequestBody PatchVariablesIDJSONBody

PatchVariablesIDJSONRequestBody defines body for PatchVariablesID for application/json ContentType.

type PatchVariablesIDParams 

type PatchVariablesIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PatchVariablesIDParams defines parameters for PatchVariablesID.

type Permission 

type Permission struct {
	Action   PermissionAction `json:"action"`
	Resource Resource         `json:"resource"`
}

Permission defines model for Permission.

type PermissionAction 

type PermissionAction string

PermissionAction defines model for Permission.Action. 

const (
	PermissionActionRead PermissionAction = "read"

	PermissionActionWrite PermissionAction = "write"
)

Defines values for PermissionAction.

type PipeExpression 

type PipeExpression struct {
	Argument *Expression `json:"argument,omitempty"`

	// Represents a function call
	Call *CallExpression `json:"call,omitempty"`

	// Type of AST node
	Type *NodeType `json:"type,omitempty"`
}

Call expression with pipe argument

type PipeLiteral 

type PipeLiteral struct {
	// Type of AST node
	Type *NodeType `json:"type,omitempty"`
}

Represents a specialized literal value, indicating the left hand value of a pipe expression

type PostAuthorizationsAllParams added in v2.11.0 

type PostAuthorizationsAllParams struct {
	PostAuthorizationsParams

	Body PostAuthorizationsJSONRequestBody
}

PostAuthorizationsAllParams defines type for all parameters for PostAuthorizations.

type PostAuthorizationsJSONBody 

type PostAuthorizationsJSONBody AuthorizationPostRequest

PostAuthorizationsJSONBody defines parameters for PostAuthorizations.

type PostAuthorizationsJSONRequestBody 

type PostAuthorizationsJSONRequestBody PostAuthorizationsJSONBody

PostAuthorizationsJSONRequestBody defines body for PostAuthorizations for application/json ContentType.

type PostAuthorizationsParams 

type PostAuthorizationsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostAuthorizationsParams defines parameters for PostAuthorizations.

type PostBucketRequest 

type PostBucketRequest struct {
	// A description of the bucket.
	Description *string `json:"description,omitempty"`

	// The name of the bucket.
	Name string `json:"name"`

	// Organization ID.
	// The ID of the organization.
	OrgID string `json:"orgID"`

	// Retention rules to expire or retain data.
	// #### InfluxDB Cloud
	//
	// - `retentionRules` is required.
	//
	// #### InfluxDB OSS
	//
	// - `retentionRules` isn't required.
	RetentionRules *RetentionRules `json:"retentionRules,omitempty"`

	// Retention policy is an InfluxDB 1.x concept that represents the duration
	// of time that each data point in the retention policy persists. Use `rp`
	// for compatibility with InfluxDB 1.x.
	// The InfluxDB 2.x and Cloud equivalent is
	// [retention period](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#retention-period).
	Rp         *string     `json:"rp,omitempty"`
	SchemaType *SchemaType `json:"schemaType,omitempty"`
}

PostBucketRequest defines model for PostBucketRequest.

type PostBucketsAllParams added in v2.11.0 

type PostBucketsAllParams struct {
	PostBucketsParams

	Body PostBucketsJSONRequestBody
}

PostBucketsAllParams defines type for all parameters for PostBuckets.

type PostBucketsIDLabelsAllParams added in v2.11.0 

type PostBucketsIDLabelsAllParams struct {
	PostBucketsIDLabelsParams

	BucketID string

	Body PostBucketsIDLabelsJSONRequestBody
}

PostBucketsIDLabelsAllParams defines type for all parameters for PostBucketsIDLabels.

type PostBucketsIDLabelsJSONBody 

type PostBucketsIDLabelsJSONBody LabelMapping

PostBucketsIDLabelsJSONBody defines parameters for PostBucketsIDLabels.

type PostBucketsIDLabelsJSONRequestBody 

type PostBucketsIDLabelsJSONRequestBody PostBucketsIDLabelsJSONBody

PostBucketsIDLabelsJSONRequestBody defines body for PostBucketsIDLabels for application/json ContentType.

type PostBucketsIDLabelsParams 

type PostBucketsIDLabelsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostBucketsIDLabelsParams defines parameters for PostBucketsIDLabels.

type PostBucketsIDMembersAllParams added in v2.11.0 

type PostBucketsIDMembersAllParams struct {
	PostBucketsIDMembersParams

	BucketID string

	Body PostBucketsIDMembersJSONRequestBody
}

PostBucketsIDMembersAllParams defines type for all parameters for PostBucketsIDMembers.

type PostBucketsIDMembersJSONBody 

type PostBucketsIDMembersJSONBody AddResourceMemberRequestBody

PostBucketsIDMembersJSONBody defines parameters for PostBucketsIDMembers.

type PostBucketsIDMembersJSONRequestBody 

type PostBucketsIDMembersJSONRequestBody PostBucketsIDMembersJSONBody

PostBucketsIDMembersJSONRequestBody defines body for PostBucketsIDMembers for application/json ContentType.

type PostBucketsIDMembersParams 

type PostBucketsIDMembersParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostBucketsIDMembersParams defines parameters for PostBucketsIDMembers.

type PostBucketsIDOwnersAllParams added in v2.11.0 

type PostBucketsIDOwnersAllParams struct {
	PostBucketsIDOwnersParams

	BucketID string

	Body PostBucketsIDOwnersJSONRequestBody
}

PostBucketsIDOwnersAllParams defines type for all parameters for PostBucketsIDOwners.

type PostBucketsIDOwnersJSONBody 

type PostBucketsIDOwnersJSONBody AddResourceMemberRequestBody

PostBucketsIDOwnersJSONBody defines parameters for PostBucketsIDOwners.

type PostBucketsIDOwnersJSONRequestBody 

type PostBucketsIDOwnersJSONRequestBody PostBucketsIDOwnersJSONBody

PostBucketsIDOwnersJSONRequestBody defines body for PostBucketsIDOwners for application/json ContentType.

type PostBucketsIDOwnersParams 

type PostBucketsIDOwnersParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostBucketsIDOwnersParams defines parameters for PostBucketsIDOwners.

type PostBucketsJSONBody 

type PostBucketsJSONBody PostBucketRequest

PostBucketsJSONBody defines parameters for PostBuckets.

type PostBucketsJSONRequestBody 

type PostBucketsJSONRequestBody PostBucketsJSONBody

PostBucketsJSONRequestBody defines body for PostBuckets for application/json ContentType.

type PostBucketsParams 

type PostBucketsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostBucketsParams defines parameters for PostBuckets.

type PostChecksIDLabelsAllParams added in v2.11.0 

type PostChecksIDLabelsAllParams struct {
	PostChecksIDLabelsParams

	CheckID string

	Body PostChecksIDLabelsJSONRequestBody
}

PostChecksIDLabelsAllParams defines type for all parameters for PostChecksIDLabels.

type PostChecksIDLabelsJSONBody 

type PostChecksIDLabelsJSONBody LabelMapping

PostChecksIDLabelsJSONBody defines parameters for PostChecksIDLabels.

type PostChecksIDLabelsJSONRequestBody 

type PostChecksIDLabelsJSONRequestBody PostChecksIDLabelsJSONBody

PostChecksIDLabelsJSONRequestBody defines body for PostChecksIDLabels for application/json ContentType.

type PostChecksIDLabelsParams 

type PostChecksIDLabelsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostChecksIDLabelsParams defines parameters for PostChecksIDLabels.

type PostDBRPAllParams added in v2.11.0 

type PostDBRPAllParams struct {
	PostDBRPParams

	Body PostDBRPJSONRequestBody
}

PostDBRPAllParams defines type for all parameters for PostDBRP.

type PostDBRPJSONBody 

type PostDBRPJSONBody DBRPCreate

PostDBRPJSONBody defines parameters for PostDBRP.

type PostDBRPJSONRequestBody 

type PostDBRPJSONRequestBody PostDBRPJSONBody

PostDBRPJSONRequestBody defines body for PostDBRP for application/json ContentType.

type PostDBRPParams 

type PostDBRPParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostDBRPParams defines parameters for PostDBRP.

type PostDashboardsIDCellsAllParams added in v2.11.0 

type PostDashboardsIDCellsAllParams struct {
	PostDashboardsIDCellsParams

	DashboardID string

	Body PostDashboardsIDCellsJSONRequestBody
}

PostDashboardsIDCellsAllParams defines type for all parameters for PostDashboardsIDCells.

type PostDashboardsIDCellsJSONBody 

type PostDashboardsIDCellsJSONBody CreateCell

PostDashboardsIDCellsJSONBody defines parameters for PostDashboardsIDCells.

type PostDashboardsIDCellsJSONRequestBody 

type PostDashboardsIDCellsJSONRequestBody PostDashboardsIDCellsJSONBody

PostDashboardsIDCellsJSONRequestBody defines body for PostDashboardsIDCells for application/json ContentType.

type PostDashboardsIDCellsParams 

type PostDashboardsIDCellsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostDashboardsIDCellsParams defines parameters for PostDashboardsIDCells.

type PostDashboardsIDLabelsAllParams added in v2.11.0 

type PostDashboardsIDLabelsAllParams struct {
	PostDashboardsIDLabelsParams

	DashboardID string

	Body PostDashboardsIDLabelsJSONRequestBody
}

PostDashboardsIDLabelsAllParams defines type for all parameters for PostDashboardsIDLabels.

type PostDashboardsIDLabelsJSONBody 

type PostDashboardsIDLabelsJSONBody LabelMapping

PostDashboardsIDLabelsJSONBody defines parameters for PostDashboardsIDLabels.

type PostDashboardsIDLabelsJSONRequestBody 

type PostDashboardsIDLabelsJSONRequestBody PostDashboardsIDLabelsJSONBody

PostDashboardsIDLabelsJSONRequestBody defines body for PostDashboardsIDLabels for application/json ContentType.

type PostDashboardsIDLabelsParams 

type PostDashboardsIDLabelsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostDashboardsIDLabelsParams defines parameters for PostDashboardsIDLabels.

type PostDashboardsIDMembersAllParams added in v2.11.0 

type PostDashboardsIDMembersAllParams struct {
	PostDashboardsIDMembersParams

	DashboardID string

	Body PostDashboardsIDMembersJSONRequestBody
}

PostDashboardsIDMembersAllParams defines type for all parameters for PostDashboardsIDMembers.

type PostDashboardsIDMembersJSONBody 

type PostDashboardsIDMembersJSONBody AddResourceMemberRequestBody

PostDashboardsIDMembersJSONBody defines parameters for PostDashboardsIDMembers.

type PostDashboardsIDMembersJSONRequestBody 

type PostDashboardsIDMembersJSONRequestBody PostDashboardsIDMembersJSONBody

PostDashboardsIDMembersJSONRequestBody defines body for PostDashboardsIDMembers for application/json ContentType.

type PostDashboardsIDMembersParams 

type PostDashboardsIDMembersParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostDashboardsIDMembersParams defines parameters for PostDashboardsIDMembers.

type PostDashboardsIDOwnersAllParams added in v2.11.0 

type PostDashboardsIDOwnersAllParams struct {
	PostDashboardsIDOwnersParams

	DashboardID string

	Body PostDashboardsIDOwnersJSONRequestBody
}

PostDashboardsIDOwnersAllParams defines type for all parameters for PostDashboardsIDOwners.

type PostDashboardsIDOwnersJSONBody 

type PostDashboardsIDOwnersJSONBody AddResourceMemberRequestBody

PostDashboardsIDOwnersJSONBody defines parameters for PostDashboardsIDOwners.

type PostDashboardsIDOwnersJSONRequestBody 

type PostDashboardsIDOwnersJSONRequestBody PostDashboardsIDOwnersJSONBody

PostDashboardsIDOwnersJSONRequestBody defines body for PostDashboardsIDOwners for application/json ContentType.

type PostDashboardsIDOwnersParams 

type PostDashboardsIDOwnersParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostDashboardsIDOwnersParams defines parameters for PostDashboardsIDOwners.

type PostDeleteAllParams added in v2.11.0 

type PostDeleteAllParams struct {
	PostDeleteParams

	Body PostDeleteJSONRequestBody
}

PostDeleteAllParams defines type for all parameters for PostDelete.

type PostDeleteJSONBody 

type PostDeleteJSONBody DeletePredicateRequest

PostDeleteJSONBody defines parameters for PostDelete.

type PostDeleteJSONRequestBody 

type PostDeleteJSONRequestBody PostDeleteJSONBody

PostDeleteJSONRequestBody defines body for PostDelete for application/json ContentType.

type PostDeleteParams 

type PostDeleteParams struct {
	// The organization to delete data from.
	// If you pass both `orgID` and `org`, they must both be valid.
	//
	// #### InfluxDB Cloud
	//
	// - Doesn't require `org` or `orgID`.
	// - Deletes data from the bucket in the organization associated with the authorization (API token).
	//
	// #### InfluxDB OSS
	//
	// - Requires either `org` or `orgID`.
	Org *string `json:"org,omitempty"`

	// The name or ID of the bucket to delete data from.
	// If you pass both `bucket` and `bucketID`, `bucketID` takes precedence.
	Bucket *string `json:"bucket,omitempty"`

	// The ID of the organization to delete data from.
	// If you pass both `orgID` and `org`, they must both be valid.
	//
	// #### InfluxDB Cloud
	//
	// - Doesn't require `org` or `orgID`.
	// - Deletes data from the bucket in the organization associated with the authorization (API token).
	//
	// #### InfluxDB OSS
	//
	// - Requires either `org` or `orgID`.
	OrgID *string `json:"orgID,omitempty"`

	// The ID of the bucket to delete data from.
	// If you pass both `bucket` and `bucketID`, `bucketID` takes precedence.
	BucketID *string `json:"bucketID,omitempty"`

	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostDeleteParams defines parameters for PostDelete.

type PostLabelsAllParams added in v2.11.0 

type PostLabelsAllParams struct {
	Body PostLabelsJSONRequestBody
}

PostLabelsAllParams defines type for all parameters for PostLabels.

type PostLabelsJSONBody 

type PostLabelsJSONBody LabelCreateRequest

PostLabelsJSONBody defines parameters for PostLabels.

type PostLabelsJSONRequestBody 

type PostLabelsJSONRequestBody PostLabelsJSONBody

PostLabelsJSONRequestBody defines body for PostLabels for application/json ContentType.

type PostNotificationEndpoint 

type PostNotificationEndpoint struct {
	// Embedded struct due to allOf(#/components/schemas/NotificationEndpointDiscriminator)
	NotificationEndpointDiscriminator `yaml:",inline"`
}

PostNotificationEndpoint defines model for PostNotificationEndpoint.

type PostNotificationEndpointIDLabelsAllParams added in v2.11.0 

type PostNotificationEndpointIDLabelsAllParams struct {
	PostNotificationEndpointIDLabelsParams

	EndpointID string

	Body PostNotificationEndpointIDLabelsJSONRequestBody
}

PostNotificationEndpointIDLabelsAllParams defines type for all parameters for PostNotificationEndpointIDLabels.

type PostNotificationEndpointIDLabelsJSONBody 

type PostNotificationEndpointIDLabelsJSONBody LabelMapping

PostNotificationEndpointIDLabelsJSONBody defines parameters for PostNotificationEndpointIDLabels.

type PostNotificationEndpointIDLabelsJSONRequestBody 

type PostNotificationEndpointIDLabelsJSONRequestBody PostNotificationEndpointIDLabelsJSONBody

PostNotificationEndpointIDLabelsJSONRequestBody defines body for PostNotificationEndpointIDLabels for application/json ContentType.

type PostNotificationEndpointIDLabelsParams 

type PostNotificationEndpointIDLabelsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostNotificationEndpointIDLabelsParams defines parameters for PostNotificationEndpointIDLabels.

type PostNotificationRule 

type PostNotificationRule struct {
	// Embedded struct due to allOf(#/components/schemas/NotificationRuleDiscriminator)
	NotificationRuleDiscriminator `yaml:",inline"`
}

PostNotificationRule defines model for PostNotificationRule.

type PostNotificationRuleIDLabelsAllParams added in v2.11.0 

type PostNotificationRuleIDLabelsAllParams struct {
	PostNotificationRuleIDLabelsParams

	RuleID string

	Body PostNotificationRuleIDLabelsJSONRequestBody
}

PostNotificationRuleIDLabelsAllParams defines type for all parameters for PostNotificationRuleIDLabels.

type PostNotificationRuleIDLabelsJSONBody 

type PostNotificationRuleIDLabelsJSONBody LabelMapping

PostNotificationRuleIDLabelsJSONBody defines parameters for PostNotificationRuleIDLabels.

type PostNotificationRuleIDLabelsJSONRequestBody 

type PostNotificationRuleIDLabelsJSONRequestBody PostNotificationRuleIDLabelsJSONBody

PostNotificationRuleIDLabelsJSONRequestBody defines body for PostNotificationRuleIDLabels for application/json ContentType.

type PostNotificationRuleIDLabelsParams 

type PostNotificationRuleIDLabelsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostNotificationRuleIDLabelsParams defines parameters for PostNotificationRuleIDLabels.

type PostOrganizationRequest added in v2.5.0 

type PostOrganizationRequest struct {
	Description *string `json:"description,omitempty"`
	Name        string  `json:"name"`
}

PostOrganizationRequest defines model for PostOrganizationRequest.

type PostOrgsAllParams added in v2.11.0 

type PostOrgsAllParams struct {
	PostOrgsParams

	Body PostOrgsJSONRequestBody
}

PostOrgsAllParams defines type for all parameters for PostOrgs.

type PostOrgsIDMembersAllParams added in v2.11.0 

type PostOrgsIDMembersAllParams struct {
	PostOrgsIDMembersParams

	OrgID string

	Body PostOrgsIDMembersJSONRequestBody
}

PostOrgsIDMembersAllParams defines type for all parameters for PostOrgsIDMembers.

type PostOrgsIDMembersJSONBody 

type PostOrgsIDMembersJSONBody AddResourceMemberRequestBody

PostOrgsIDMembersJSONBody defines parameters for PostOrgsIDMembers.

type PostOrgsIDMembersJSONRequestBody 

type PostOrgsIDMembersJSONRequestBody PostOrgsIDMembersJSONBody

PostOrgsIDMembersJSONRequestBody defines body for PostOrgsIDMembers for application/json ContentType.

type PostOrgsIDMembersParams 

type PostOrgsIDMembersParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostOrgsIDMembersParams defines parameters for PostOrgsIDMembers.

type PostOrgsIDOwnersAllParams added in v2.11.0 

type PostOrgsIDOwnersAllParams struct {
	PostOrgsIDOwnersParams

	OrgID string

	Body PostOrgsIDOwnersJSONRequestBody
}

PostOrgsIDOwnersAllParams defines type for all parameters for PostOrgsIDOwners.

type PostOrgsIDOwnersJSONBody 

type PostOrgsIDOwnersJSONBody AddResourceMemberRequestBody

PostOrgsIDOwnersJSONBody defines parameters for PostOrgsIDOwners.

type PostOrgsIDOwnersJSONRequestBody 

type PostOrgsIDOwnersJSONRequestBody PostOrgsIDOwnersJSONBody

PostOrgsIDOwnersJSONRequestBody defines body for PostOrgsIDOwners for application/json ContentType.

type PostOrgsIDOwnersParams 

type PostOrgsIDOwnersParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostOrgsIDOwnersParams defines parameters for PostOrgsIDOwners.

type PostOrgsIDSecretsAllParams added in v2.11.0 

type PostOrgsIDSecretsAllParams struct {
	PostOrgsIDSecretsParams

	OrgID string

	Body PostOrgsIDSecretsJSONRequestBody
}

PostOrgsIDSecretsAllParams defines type for all parameters for PostOrgsIDSecrets.

type PostOrgsIDSecretsJSONBody 

type PostOrgsIDSecretsJSONBody SecretKeys

PostOrgsIDSecretsJSONBody defines parameters for PostOrgsIDSecrets.

type PostOrgsIDSecretsJSONRequestBody 

type PostOrgsIDSecretsJSONRequestBody PostOrgsIDSecretsJSONBody

PostOrgsIDSecretsJSONRequestBody defines body for PostOrgsIDSecrets for application/json ContentType.

type PostOrgsIDSecretsParams 

type PostOrgsIDSecretsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostOrgsIDSecretsParams defines parameters for PostOrgsIDSecrets.

type PostOrgsJSONBody 

type PostOrgsJSONBody PostOrganizationRequest

PostOrgsJSONBody defines parameters for PostOrgs.

type PostOrgsJSONRequestBody 

type PostOrgsJSONRequestBody PostOrgsJSONBody

PostOrgsJSONRequestBody defines body for PostOrgs for application/json ContentType.

type PostOrgsParams 

type PostOrgsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostOrgsParams defines parameters for PostOrgs.

type PostQueryAnalyzeAllParams added in v2.11.0 

type PostQueryAnalyzeAllParams struct {
	PostQueryAnalyzeParams

	Body PostQueryAnalyzeJSONRequestBody
}

PostQueryAnalyzeAllParams defines type for all parameters for PostQueryAnalyze.

type PostQueryAnalyzeJSONBody 

type PostQueryAnalyzeJSONBody Query

PostQueryAnalyzeJSONBody defines parameters for PostQueryAnalyze.

type PostQueryAnalyzeJSONRequestBody 

type PostQueryAnalyzeJSONRequestBody PostQueryAnalyzeJSONBody

PostQueryAnalyzeJSONRequestBody defines body for PostQueryAnalyze for application/json ContentType.

type PostQueryAnalyzeParams 

type PostQueryAnalyzeParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan                         `json:"Zap-Trace-Span,omitempty"`
	ContentType  *PostQueryAnalyzeParamsContentType `json:"Content-Type,omitempty"`
}

PostQueryAnalyzeParams defines parameters for PostQueryAnalyze.

type PostQueryAnalyzeParamsContentType 

type PostQueryAnalyzeParamsContentType string

PostQueryAnalyzeParamsContentType defines parameters for PostQueryAnalyze.

type PostQueryAstAllParams added in v2.11.0 

type PostQueryAstAllParams struct {
	PostQueryAstParams

	Body PostQueryAstJSONRequestBody
}

PostQueryAstAllParams defines type for all parameters for PostQueryAst.

type PostQueryAstJSONBody 

type PostQueryAstJSONBody LanguageRequest

PostQueryAstJSONBody defines parameters for PostQueryAst.

type PostQueryAstJSONRequestBody 

type PostQueryAstJSONRequestBody PostQueryAstJSONBody

PostQueryAstJSONRequestBody defines body for PostQueryAst for application/json ContentType.

type PostQueryAstParams 

type PostQueryAstParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan                     `json:"Zap-Trace-Span,omitempty"`
	ContentType  *PostQueryAstParamsContentType `json:"Content-Type,omitempty"`
}

PostQueryAstParams defines parameters for PostQueryAst.

type PostQueryAstParamsContentType 

type PostQueryAstParamsContentType string

PostQueryAstParamsContentType defines parameters for PostQueryAst.

type PostRemoteConnectionAllParams added in v2.11.0 

type PostRemoteConnectionAllParams struct {
	Body PostRemoteConnectionJSONRequestBody
}

PostRemoteConnectionAllParams defines type for all parameters for PostRemoteConnection.

type PostRemoteConnectionJSONBody added in v2.8.0 

type PostRemoteConnectionJSONBody RemoteConnectionCreationRequest

PostRemoteConnectionJSONBody defines parameters for PostRemoteConnection.

type PostRemoteConnectionJSONRequestBody added in v2.8.0 

type PostRemoteConnectionJSONRequestBody PostRemoteConnectionJSONBody

PostRemoteConnectionJSONRequestBody defines body for PostRemoteConnection for application/json ContentType.

type PostReplicationAllParams added in v2.11.0 

type PostReplicationAllParams struct {
	PostReplicationParams

	Body PostReplicationJSONRequestBody
}

PostReplicationAllParams defines type for all parameters for PostReplication.

type PostReplicationJSONBody added in v2.8.0 

type PostReplicationJSONBody ReplicationCreationRequest

PostReplicationJSONBody defines parameters for PostReplication.

type PostReplicationJSONRequestBody added in v2.8.0 

type PostReplicationJSONRequestBody PostReplicationJSONBody

PostReplicationJSONRequestBody defines body for PostReplication for application/json ContentType.

type PostReplicationParams added in v2.8.0 

type PostReplicationParams struct {
	// If true, validate the replication, but don't save it.
	Validate *bool `json:"validate,omitempty"`

	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostReplicationParams defines parameters for PostReplication.

type PostRestoreBucketMetadataAllParams added in v2.11.0 

type PostRestoreBucketMetadataAllParams struct {
	PostRestoreBucketMetadataParams

	Body PostRestoreBucketMetadataJSONRequestBody
}

PostRestoreBucketMetadataAllParams defines type for all parameters for PostRestoreBucketMetadata.

type PostRestoreBucketMetadataJSONBody added in v2.5.0 

type PostRestoreBucketMetadataJSONBody BucketMetadataManifest

PostRestoreBucketMetadataJSONBody defines parameters for PostRestoreBucketMetadata.

type PostRestoreBucketMetadataJSONRequestBody added in v2.5.0 

type PostRestoreBucketMetadataJSONRequestBody PostRestoreBucketMetadataJSONBody

PostRestoreBucketMetadataJSONRequestBody defines body for PostRestoreBucketMetadata for application/json ContentType.

type PostRestoreBucketMetadataParams added in v2.5.0 

type PostRestoreBucketMetadataParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostRestoreBucketMetadataParams defines parameters for PostRestoreBucketMetadata.

type PostScrapersAllParams added in v2.11.0 

type PostScrapersAllParams struct {
	PostScrapersParams

	Body PostScrapersJSONRequestBody
}

PostScrapersAllParams defines type for all parameters for PostScrapers.

type PostScrapersIDLabelsAllParams added in v2.11.0 

type PostScrapersIDLabelsAllParams struct {
	PostScrapersIDLabelsParams

	ScraperTargetID string

	Body PostScrapersIDLabelsJSONRequestBody
}

PostScrapersIDLabelsAllParams defines type for all parameters for PostScrapersIDLabels.

type PostScrapersIDLabelsJSONBody 

type PostScrapersIDLabelsJSONBody LabelMapping

PostScrapersIDLabelsJSONBody defines parameters for PostScrapersIDLabels.

type PostScrapersIDLabelsJSONRequestBody 

type PostScrapersIDLabelsJSONRequestBody PostScrapersIDLabelsJSONBody

PostScrapersIDLabelsJSONRequestBody defines body for PostScrapersIDLabels for application/json ContentType.

type PostScrapersIDLabelsParams 

type PostScrapersIDLabelsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostScrapersIDLabelsParams defines parameters for PostScrapersIDLabels.

type PostScrapersIDMembersAllParams added in v2.11.0 

type PostScrapersIDMembersAllParams struct {
	PostScrapersIDMembersParams

	ScraperTargetID string

	Body PostScrapersIDMembersJSONRequestBody
}

PostScrapersIDMembersAllParams defines type for all parameters for PostScrapersIDMembers.

type PostScrapersIDMembersJSONBody 

type PostScrapersIDMembersJSONBody AddResourceMemberRequestBody

PostScrapersIDMembersJSONBody defines parameters for PostScrapersIDMembers.

type PostScrapersIDMembersJSONRequestBody 

type PostScrapersIDMembersJSONRequestBody PostScrapersIDMembersJSONBody

PostScrapersIDMembersJSONRequestBody defines body for PostScrapersIDMembers for application/json ContentType.

type PostScrapersIDMembersParams 

type PostScrapersIDMembersParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostScrapersIDMembersParams defines parameters for PostScrapersIDMembers.

type PostScrapersIDOwnersAllParams added in v2.11.0 

type PostScrapersIDOwnersAllParams struct {
	PostScrapersIDOwnersParams

	ScraperTargetID string

	Body PostScrapersIDOwnersJSONRequestBody
}

PostScrapersIDOwnersAllParams defines type for all parameters for PostScrapersIDOwners.

type PostScrapersIDOwnersJSONBody 

type PostScrapersIDOwnersJSONBody AddResourceMemberRequestBody

PostScrapersIDOwnersJSONBody defines parameters for PostScrapersIDOwners.

type PostScrapersIDOwnersJSONRequestBody 

type PostScrapersIDOwnersJSONRequestBody PostScrapersIDOwnersJSONBody

PostScrapersIDOwnersJSONRequestBody defines body for PostScrapersIDOwners for application/json ContentType.

type PostScrapersIDOwnersParams 

type PostScrapersIDOwnersParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostScrapersIDOwnersParams defines parameters for PostScrapersIDOwners.

type PostScrapersJSONBody 

type PostScrapersJSONBody ScraperTargetRequest

PostScrapersJSONBody defines parameters for PostScrapers.

type PostScrapersJSONRequestBody 

type PostScrapersJSONRequestBody PostScrapersJSONBody

PostScrapersJSONRequestBody defines body for PostScrapers for application/json ContentType.

type PostScrapersParams 

type PostScrapersParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostScrapersParams defines parameters for PostScrapers.

type PostSetupAllParams added in v2.11.0 

type PostSetupAllParams struct {
	PostSetupParams

	Body PostSetupJSONRequestBody
}

PostSetupAllParams defines type for all parameters for PostSetup.

type PostSetupJSONBody 

type PostSetupJSONBody OnboardingRequest

PostSetupJSONBody defines parameters for PostSetup.

type PostSetupJSONRequestBody 

type PostSetupJSONRequestBody PostSetupJSONBody

PostSetupJSONRequestBody defines body for PostSetup for application/json ContentType.

type PostSetupParams 

type PostSetupParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostSetupParams defines parameters for PostSetup.

type PostSigninParams 

type PostSigninParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostSigninParams defines parameters for PostSignin.

type PostSignoutParams 

type PostSignoutParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostSignoutParams defines parameters for PostSignout.

type PostSourcesAllParams added in v2.11.0 

type PostSourcesAllParams struct {
	PostSourcesParams

	Body PostSourcesJSONRequestBody
}

PostSourcesAllParams defines type for all parameters for PostSources.

type PostSourcesJSONBody 

type PostSourcesJSONBody Source

PostSourcesJSONBody defines parameters for PostSources.

type PostSourcesJSONRequestBody 

type PostSourcesJSONRequestBody PostSourcesJSONBody

PostSourcesJSONRequestBody defines body for PostSources for application/json ContentType.

type PostSourcesParams 

type PostSourcesParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostSourcesParams defines parameters for PostSources.

type PostTasksAllParams added in v2.11.0 

type PostTasksAllParams struct {
	PostTasksParams

	Body PostTasksJSONRequestBody
}

PostTasksAllParams defines type for all parameters for PostTasks.

type PostTasksIDLabelsAllParams added in v2.11.0 

type PostTasksIDLabelsAllParams struct {
	PostTasksIDLabelsParams

	TaskID string

	Body PostTasksIDLabelsJSONRequestBody
}

PostTasksIDLabelsAllParams defines type for all parameters for PostTasksIDLabels.

type PostTasksIDLabelsJSONBody 

type PostTasksIDLabelsJSONBody LabelMapping

PostTasksIDLabelsJSONBody defines parameters for PostTasksIDLabels.

type PostTasksIDLabelsJSONRequestBody 

type PostTasksIDLabelsJSONRequestBody PostTasksIDLabelsJSONBody

PostTasksIDLabelsJSONRequestBody defines body for PostTasksIDLabels for application/json ContentType.

type PostTasksIDLabelsParams 

type PostTasksIDLabelsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostTasksIDLabelsParams defines parameters for PostTasksIDLabels.

type PostTasksIDMembersAllParams added in v2.11.0 

type PostTasksIDMembersAllParams struct {
	PostTasksIDMembersParams

	TaskID string

	Body PostTasksIDMembersJSONRequestBody
}

PostTasksIDMembersAllParams defines type for all parameters for PostTasksIDMembers.

type PostTasksIDMembersJSONBody 

type PostTasksIDMembersJSONBody AddResourceMemberRequestBody

PostTasksIDMembersJSONBody defines parameters for PostTasksIDMembers.

type PostTasksIDMembersJSONRequestBody 

type PostTasksIDMembersJSONRequestBody PostTasksIDMembersJSONBody

PostTasksIDMembersJSONRequestBody defines body for PostTasksIDMembers for application/json ContentType.

type PostTasksIDMembersParams 

type PostTasksIDMembersParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostTasksIDMembersParams defines parameters for PostTasksIDMembers.

type PostTasksIDOwnersAllParams added in v2.11.0 

type PostTasksIDOwnersAllParams struct {
	PostTasksIDOwnersParams

	TaskID string

	Body PostTasksIDOwnersJSONRequestBody
}

PostTasksIDOwnersAllParams defines type for all parameters for PostTasksIDOwners.

type PostTasksIDOwnersJSONBody 

type PostTasksIDOwnersJSONBody AddResourceMemberRequestBody

PostTasksIDOwnersJSONBody defines parameters for PostTasksIDOwners.

type PostTasksIDOwnersJSONRequestBody 

type PostTasksIDOwnersJSONRequestBody PostTasksIDOwnersJSONBody

PostTasksIDOwnersJSONRequestBody defines body for PostTasksIDOwners for application/json ContentType.

type PostTasksIDOwnersParams 

type PostTasksIDOwnersParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostTasksIDOwnersParams defines parameters for PostTasksIDOwners.

type PostTasksIDRunsAllParams added in v2.11.0 

type PostTasksIDRunsAllParams struct {
	PostTasksIDRunsParams

	TaskID string

	Body PostTasksIDRunsJSONRequestBody
}

PostTasksIDRunsAllParams defines type for all parameters for PostTasksIDRuns.

type PostTasksIDRunsIDRetryAllParams added in v2.11.0 

type PostTasksIDRunsIDRetryAllParams struct {
	PostTasksIDRunsIDRetryParams

	TaskID string

	RunID string

	Body PostTasksIDRunsIDRetryJSONRequestBody
}

PostTasksIDRunsIDRetryAllParams defines type for all parameters for PostTasksIDRunsIDRetry.

type PostTasksIDRunsIDRetryJSONBody added in v2.11.0 

type PostTasksIDRunsIDRetryJSONBody map[string]interface{}

PostTasksIDRunsIDRetryJSONBody defines parameters for PostTasksIDRunsIDRetry.

type PostTasksIDRunsIDRetryJSONRequestBody added in v2.11.0 

type PostTasksIDRunsIDRetryJSONRequestBody PostTasksIDRunsIDRetryJSONBody

PostTasksIDRunsIDRetryJSONRequestBody defines body for PostTasksIDRunsIDRetry for application/json ContentType.

type PostTasksIDRunsIDRetryParams 

type PostTasksIDRunsIDRetryParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostTasksIDRunsIDRetryParams defines parameters for PostTasksIDRunsIDRetry.

type PostTasksIDRunsJSONBody 

type PostTasksIDRunsJSONBody RunManually

PostTasksIDRunsJSONBody defines parameters for PostTasksIDRuns.

type PostTasksIDRunsJSONRequestBody 

type PostTasksIDRunsJSONRequestBody PostTasksIDRunsJSONBody

PostTasksIDRunsJSONRequestBody defines body for PostTasksIDRuns for application/json ContentType.

type PostTasksIDRunsParams 

type PostTasksIDRunsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostTasksIDRunsParams defines parameters for PostTasksIDRuns.

type PostTasksJSONBody 

type PostTasksJSONBody TaskCreateRequest

PostTasksJSONBody defines parameters for PostTasks.

type PostTasksJSONRequestBody 

type PostTasksJSONRequestBody PostTasksJSONBody

PostTasksJSONRequestBody defines body for PostTasks for application/json ContentType.

type PostTasksParams 

type PostTasksParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostTasksParams defines parameters for PostTasks.

type PostTelegrafsAllParams added in v2.11.0 

type PostTelegrafsAllParams struct {
	PostTelegrafsParams

	Body PostTelegrafsJSONRequestBody
}

PostTelegrafsAllParams defines type for all parameters for PostTelegrafs.

type PostTelegrafsIDLabelsAllParams added in v2.11.0 

type PostTelegrafsIDLabelsAllParams struct {
	PostTelegrafsIDLabelsParams

	TelegrafID string

	Body PostTelegrafsIDLabelsJSONRequestBody
}

PostTelegrafsIDLabelsAllParams defines type for all parameters for PostTelegrafsIDLabels.

type PostTelegrafsIDLabelsJSONBody 

type PostTelegrafsIDLabelsJSONBody LabelMapping

PostTelegrafsIDLabelsJSONBody defines parameters for PostTelegrafsIDLabels.

type PostTelegrafsIDLabelsJSONRequestBody 

type PostTelegrafsIDLabelsJSONRequestBody PostTelegrafsIDLabelsJSONBody

PostTelegrafsIDLabelsJSONRequestBody defines body for PostTelegrafsIDLabels for application/json ContentType.

type PostTelegrafsIDLabelsParams 

type PostTelegrafsIDLabelsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostTelegrafsIDLabelsParams defines parameters for PostTelegrafsIDLabels.

type PostTelegrafsIDMembersAllParams added in v2.11.0 

type PostTelegrafsIDMembersAllParams struct {
	PostTelegrafsIDMembersParams

	TelegrafID string

	Body PostTelegrafsIDMembersJSONRequestBody
}

PostTelegrafsIDMembersAllParams defines type for all parameters for PostTelegrafsIDMembers.

type PostTelegrafsIDMembersJSONBody 

type PostTelegrafsIDMembersJSONBody AddResourceMemberRequestBody

PostTelegrafsIDMembersJSONBody defines parameters for PostTelegrafsIDMembers.

type PostTelegrafsIDMembersJSONRequestBody 

type PostTelegrafsIDMembersJSONRequestBody PostTelegrafsIDMembersJSONBody

PostTelegrafsIDMembersJSONRequestBody defines body for PostTelegrafsIDMembers for application/json ContentType.

type PostTelegrafsIDMembersParams 

type PostTelegrafsIDMembersParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostTelegrafsIDMembersParams defines parameters for PostTelegrafsIDMembers.

type PostTelegrafsIDOwnersAllParams added in v2.11.0 

type PostTelegrafsIDOwnersAllParams struct {
	PostTelegrafsIDOwnersParams

	TelegrafID string

	Body PostTelegrafsIDOwnersJSONRequestBody
}

PostTelegrafsIDOwnersAllParams defines type for all parameters for PostTelegrafsIDOwners.

type PostTelegrafsIDOwnersJSONBody 

type PostTelegrafsIDOwnersJSONBody AddResourceMemberRequestBody

PostTelegrafsIDOwnersJSONBody defines parameters for PostTelegrafsIDOwners.

type PostTelegrafsIDOwnersJSONRequestBody 

type PostTelegrafsIDOwnersJSONRequestBody PostTelegrafsIDOwnersJSONBody

PostTelegrafsIDOwnersJSONRequestBody defines body for PostTelegrafsIDOwners for application/json ContentType.

type PostTelegrafsIDOwnersParams 

type PostTelegrafsIDOwnersParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostTelegrafsIDOwnersParams defines parameters for PostTelegrafsIDOwners.

type PostTelegrafsJSONBody 

type PostTelegrafsJSONBody TelegrafPluginRequest

PostTelegrafsJSONBody defines parameters for PostTelegrafs.

type PostTelegrafsJSONRequestBody 

type PostTelegrafsJSONRequestBody PostTelegrafsJSONBody

PostTelegrafsJSONRequestBody defines body for PostTelegrafs for application/json ContentType.

type PostTelegrafsParams 

type PostTelegrafsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostTelegrafsParams defines parameters for PostTelegrafs.

type PostUsersAllParams added in v2.11.0 

type PostUsersAllParams struct {
	PostUsersParams

	Body PostUsersJSONRequestBody
}

PostUsersAllParams defines type for all parameters for PostUsers.

type PostUsersIDPasswordAllParams added in v2.11.0 

type PostUsersIDPasswordAllParams struct {
	PostUsersIDPasswordParams

	UserID string

	Body PostUsersIDPasswordJSONRequestBody
}

PostUsersIDPasswordAllParams defines type for all parameters for PostUsersIDPassword.

type PostUsersIDPasswordJSONBody 

type PostUsersIDPasswordJSONBody PasswordResetBody

PostUsersIDPasswordJSONBody defines parameters for PostUsersIDPassword.

type PostUsersIDPasswordJSONRequestBody 

type PostUsersIDPasswordJSONRequestBody PostUsersIDPasswordJSONBody

PostUsersIDPasswordJSONRequestBody defines body for PostUsersIDPassword for application/json ContentType.

type PostUsersIDPasswordParams 

type PostUsersIDPasswordParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostUsersIDPasswordParams defines parameters for PostUsersIDPassword.

type PostUsersJSONBody 

type PostUsersJSONBody User

PostUsersJSONBody defines parameters for PostUsers.

type PostUsersJSONRequestBody 

type PostUsersJSONRequestBody PostUsersJSONBody

PostUsersJSONRequestBody defines body for PostUsers for application/json ContentType.

type PostUsersParams 

type PostUsersParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostUsersParams defines parameters for PostUsers.

type PostValidateReplicationByIDAllParams added in v2.11.0 

type PostValidateReplicationByIDAllParams struct {
	PostValidateReplicationByIDParams

	ReplicationID string
}

PostValidateReplicationByIDAllParams defines type for all parameters for PostValidateReplicationByID.

type PostValidateReplicationByIDParams added in v2.8.0 

type PostValidateReplicationByIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostValidateReplicationByIDParams defines parameters for PostValidateReplicationByID.

type PostVariablesAllParams added in v2.11.0 

type PostVariablesAllParams struct {
	PostVariablesParams

	Body PostVariablesJSONRequestBody
}

PostVariablesAllParams defines type for all parameters for PostVariables.

type PostVariablesIDLabelsAllParams added in v2.11.0 

type PostVariablesIDLabelsAllParams struct {
	PostVariablesIDLabelsParams

	VariableID string

	Body PostVariablesIDLabelsJSONRequestBody
}

PostVariablesIDLabelsAllParams defines type for all parameters for PostVariablesIDLabels.

type PostVariablesIDLabelsJSONBody 

type PostVariablesIDLabelsJSONBody LabelMapping

PostVariablesIDLabelsJSONBody defines parameters for PostVariablesIDLabels.

type PostVariablesIDLabelsJSONRequestBody 

type PostVariablesIDLabelsJSONRequestBody PostVariablesIDLabelsJSONBody

PostVariablesIDLabelsJSONRequestBody defines body for PostVariablesIDLabels for application/json ContentType.

type PostVariablesIDLabelsParams 

type PostVariablesIDLabelsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostVariablesIDLabelsParams defines parameters for PostVariablesIDLabels.

type PostVariablesJSONBody 

type PostVariablesJSONBody Variable

PostVariablesJSONBody defines parameters for PostVariables.

type PostVariablesJSONRequestBody 

type PostVariablesJSONRequestBody PostVariablesJSONBody

PostVariablesJSONRequestBody defines body for PostVariables for application/json ContentType.

type PostVariablesParams 

type PostVariablesParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PostVariablesParams defines parameters for PostVariables.

type Property 

type Property struct {
	Key *PropertyKey `json:"key,omitempty"`

	// Type of AST node
	Type  *NodeType   `json:"type,omitempty"`
	Value *Expression `json:"value,omitempty"`
}

The value associated with a key

type PropertyKey 

type PropertyKey interface{}

PropertyKey defines model for PropertyKey.

type PutChecksIDAllParams added in v2.11.0 

type PutChecksIDAllParams struct {
	PutChecksIDParams

	CheckID string

	Body PutChecksIDJSONRequestBody
}

PutChecksIDAllParams defines type for all parameters for PutChecksID.

type PutChecksIDJSONBody 

type PutChecksIDJSONBody Check

PutChecksIDJSONBody defines parameters for PutChecksID.

type PutChecksIDJSONRequestBody 

type PutChecksIDJSONRequestBody PutChecksIDJSONBody

PutChecksIDJSONRequestBody defines body for PutChecksID for application/json ContentType.

type PutChecksIDParams 

type PutChecksIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PutChecksIDParams defines parameters for PutChecksID.

type PutDashboardsIDCellsAllParams added in v2.11.0 

type PutDashboardsIDCellsAllParams struct {
	PutDashboardsIDCellsParams

	DashboardID string

	Body PutDashboardsIDCellsJSONRequestBody
}

PutDashboardsIDCellsAllParams defines type for all parameters for PutDashboardsIDCells.

type PutDashboardsIDCellsJSONBody 

type PutDashboardsIDCellsJSONBody Cells

PutDashboardsIDCellsJSONBody defines parameters for PutDashboardsIDCells.

type PutDashboardsIDCellsJSONRequestBody 

type PutDashboardsIDCellsJSONRequestBody PutDashboardsIDCellsJSONBody

PutDashboardsIDCellsJSONRequestBody defines body for PutDashboardsIDCells for application/json ContentType.

type PutDashboardsIDCellsParams 

type PutDashboardsIDCellsParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PutDashboardsIDCellsParams defines parameters for PutDashboardsIDCells.

type PutMePasswordAllParams added in v2.11.0 

type PutMePasswordAllParams struct {
	PutMePasswordParams

	Body PutMePasswordJSONRequestBody
}

PutMePasswordAllParams defines type for all parameters for PutMePassword.

type PutMePasswordJSONBody 

type PutMePasswordJSONBody PasswordResetBody

PutMePasswordJSONBody defines parameters for PutMePassword.

type PutMePasswordJSONRequestBody 

type PutMePasswordJSONRequestBody PutMePasswordJSONBody

PutMePasswordJSONRequestBody defines body for PutMePassword for application/json ContentType.

type PutMePasswordParams 

type PutMePasswordParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PutMePasswordParams defines parameters for PutMePassword.

type PutNotificationEndpointsIDAllParams added in v2.11.0 

type PutNotificationEndpointsIDAllParams struct {
	PutNotificationEndpointsIDParams

	EndpointID string

	Body PutNotificationEndpointsIDJSONRequestBody
}

PutNotificationEndpointsIDAllParams defines type for all parameters for PutNotificationEndpointsID.

type PutNotificationEndpointsIDJSONBody 

type PutNotificationEndpointsIDJSONBody NotificationEndpoint

PutNotificationEndpointsIDJSONBody defines parameters for PutNotificationEndpointsID.

type PutNotificationEndpointsIDJSONRequestBody 

type PutNotificationEndpointsIDJSONRequestBody PutNotificationEndpointsIDJSONBody

PutNotificationEndpointsIDJSONRequestBody defines body for PutNotificationEndpointsID for application/json ContentType.

type PutNotificationEndpointsIDParams 

type PutNotificationEndpointsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PutNotificationEndpointsIDParams defines parameters for PutNotificationEndpointsID.

type PutNotificationRulesIDAllParams added in v2.11.0 

type PutNotificationRulesIDAllParams struct {
	PutNotificationRulesIDParams

	RuleID string

	Body PutNotificationRulesIDJSONRequestBody
}

PutNotificationRulesIDAllParams defines type for all parameters for PutNotificationRulesID.

type PutNotificationRulesIDJSONBody 

type PutNotificationRulesIDJSONBody NotificationRule

PutNotificationRulesIDJSONBody defines parameters for PutNotificationRulesID.

type PutNotificationRulesIDJSONRequestBody 

type PutNotificationRulesIDJSONRequestBody PutNotificationRulesIDJSONBody

PutNotificationRulesIDJSONRequestBody defines body for PutNotificationRulesID for application/json ContentType.

type PutNotificationRulesIDParams 

type PutNotificationRulesIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PutNotificationRulesIDParams defines parameters for PutNotificationRulesID.

type PutTelegrafsIDAllParams added in v2.11.0 

type PutTelegrafsIDAllParams struct {
	PutTelegrafsIDParams

	TelegrafID string

	Body PutTelegrafsIDJSONRequestBody
}

PutTelegrafsIDAllParams defines type for all parameters for PutTelegrafsID.

type PutTelegrafsIDJSONBody 

type PutTelegrafsIDJSONBody TelegrafPluginRequest

PutTelegrafsIDJSONBody defines parameters for PutTelegrafsID.

type PutTelegrafsIDJSONRequestBody 

type PutTelegrafsIDJSONRequestBody PutTelegrafsIDJSONBody

PutTelegrafsIDJSONRequestBody defines body for PutTelegrafsID for application/json ContentType.

type PutTelegrafsIDParams 

type PutTelegrafsIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PutTelegrafsIDParams defines parameters for PutTelegrafsID.

type PutVariablesIDAllParams added in v2.11.0 

type PutVariablesIDAllParams struct {
	PutVariablesIDParams

	VariableID string

	Body PutVariablesIDJSONRequestBody
}

PutVariablesIDAllParams defines type for all parameters for PutVariablesID.

type PutVariablesIDJSONBody 

type PutVariablesIDJSONBody Variable

PutVariablesIDJSONBody defines parameters for PutVariablesID.

type PutVariablesIDJSONRequestBody 

type PutVariablesIDJSONRequestBody PutVariablesIDJSONBody

PutVariablesIDJSONRequestBody defines body for PutVariablesID for application/json ContentType.

type PutVariablesIDParams 

type PutVariablesIDParams struct {
	// OpenTracing span context
	ZapTraceSpan *TraceSpan `json:"Zap-Trace-Span,omitempty"`
}

PutVariablesIDParams defines parameters for PutVariablesID.

type Query 

type Query struct {
	// Options for tabular data output.
	// Default output is [annotated CSV](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/annotated-csv/#csv-response-format) with headers.
	//
	// For more information about tabular data **dialect**,
	// see [W3 metadata vocabulary for tabular data](https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions).
	Dialect *Dialect `json:"dialect,omitempty"`

	// Represents a source from a single file
	Extern *File `json:"extern,omitempty"`

	// Specifies the time that should be reported as `now` in the query.
	// Default is the server `now` time.
	Now *time.Time `json:"now,omitempty"`

	// Key-value pairs passed as parameters during query execution.
	//
	// To use parameters in your query, pass a _`query`_ with `params` references (in dot notation)--for example:
	//
	// “`json
	//   query: "from(bucket: params.mybucket) |> range(start: params.rangeStart) |> limit(n:1)"
	// “`
	//
	// and pass _`params`_ with the key-value pairs--for example:
	//
	// “`json
	//   params: {
	//     "mybucket": "environment",
	//     "rangeStart": "-30d"
	//   }
	// “`
	//
	// During query execution, InfluxDB passes _`params`_ to your script and substitutes the values.
	//
	// #### Limitations
	//
	// - If you use _`params`_, you can't use _`extern`_.
	Params *Query_Params `json:"params,omitempty"`

	// The query script to execute.
	Query string `json:"query"`

	// The type of query. Must be "flux".
	Type *QueryType `json:"type,omitempty"`
}

Query InfluxDB with the Flux language

type QueryEditMode 

type QueryEditMode string

QueryEditMode defines model for QueryEditMode. 

const (
	QueryEditModeAdvanced QueryEditMode = "advanced"

	QueryEditModeBuilder QueryEditMode = "builder"
)

Defines values for QueryEditMode.

type QueryType 

type QueryType string

The type of query. Must be "flux". 

const (
	QueryTypeFlux QueryType = "flux"
)

Defines values for QueryType.

type QueryVariableProperties 

type QueryVariableProperties struct {
	Type   *QueryVariablePropertiesType `json:"type,omitempty"`
	Values *struct {
		Language *string `json:"language,omitempty"`
		Query    *string `json:"query,omitempty"`
	} `json:"values,omitempty"`
}

QueryVariableProperties defines model for QueryVariableProperties.

type QueryVariablePropertiesType 

type QueryVariablePropertiesType string

QueryVariablePropertiesType defines model for QueryVariableProperties.Type. 

const (
	QueryVariablePropertiesTypeQuery QueryVariablePropertiesType = "query"
)

Defines values for QueryVariablePropertiesType.

type Query_Params added in v2.5.0 

type Query_Params struct {
	AdditionalProperties map[string]interface{} `json:"-"`
}

Key-value pairs passed as parameters during query execution.

To use parameters in your query, pass a _`query`_ with `params` references (in dot notation)--for example:

```json 

query: "from(bucket: params.mybucket) |> range(start: params.rangeStart) |> limit(n:1)"

```

and pass _`params`_ with the key-value pairs--for example:

```json 

params: {
  "mybucket": "environment",
  "rangeStart": "-30d"
}

```

During query execution, InfluxDB passes _`params`_ to your script and substitutes the values.

#### Limitations

- If you use _`params`_, you can't use _`extern`_.

func (Query_Params) Get added in v2.5.0 

func (a Query_Params) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for Query_Params. Returns the specified element and whether it was found

func (Query_Params) MarshalJSON added in v2.5.0 

func (a Query_Params) MarshalJSON() ([]byte, error)

Override default JSON handling for Query_Params to handle AdditionalProperties

func (*Query_Params) Set added in v2.5.0 

func (a *Query_Params) Set(fieldName string, value interface{})

Setter for additional properties for Query_Params

func (*Query_Params) UnmarshalJSON added in v2.5.0 

func (a *Query_Params) UnmarshalJSON(b []byte) error

Override default JSON handling for Query_Params to handle AdditionalProperties

type RangeThreshold 

type RangeThreshold struct {
	// Embedded struct due to allOf(#/components/schemas/ThresholdBase)
	ThresholdBase
	// Embedded fields due to inline allOf schema
	Max    float32            `json:"max"`
	Min    float32            `json:"min"`
	Typ    RangeThresholdType `json:"type"`
	Within bool               `json:"within"`
}

RangeThreshold defines model for RangeThreshold.

func (RangeThreshold) MarshalJSON added in v2.14.0 

func (r RangeThreshold) MarshalJSON() ([]byte, error)

MarshalJSON implement json.Marshaler interface.

func (RangeThreshold) Type 

func (r RangeThreshold) Type() string

type RangeThresholdType 

type RangeThresholdType string

RangeThresholdType defines model for RangeThreshold.Type. 

const (
	RangeThresholdTypeRange RangeThresholdType = "range"
)

Defines values for RangeThresholdType.

type ReadStackAllParams added in v2.11.0 

type ReadStackAllParams struct {
	StackId string
}

ReadStackAllParams defines type for all parameters for ReadStack.

type Ready 

type Ready struct {
	Started *time.Time   `json:"started,omitempty"`
	Status  *ReadyStatus `json:"status,omitempty"`
	Up      *string      `json:"up,omitempty"`
}

Ready defines model for Ready.

type ReadyStatus 

type ReadyStatus string

ReadyStatus defines model for Ready.Status. 

const (
	ReadyStatusReady ReadyStatus = "ready"
)

Defines values for ReadyStatus.

type RegexpLiteral 

type RegexpLiteral struct {
	// Type of AST node
	Type  *NodeType `json:"type,omitempty"`
	Value *string   `json:"value,omitempty"`
}

Expressions begin and end with `/` and are regular expressions with syntax accepted by RE2

type RemoteConnection added in v2.8.0 

type RemoteConnection struct {
	AllowInsecureTLS bool    `json:"allowInsecureTLS"`
	Description      *string `json:"description,omitempty"`
	Id               string  `json:"id"`
	Name             string  `json:"name"`
	OrgID            string  `json:"orgID"`
	RemoteOrgID      string  `json:"remoteOrgID"`
	RemoteURL        string  `json:"remoteURL"`
}

RemoteConnection defines model for RemoteConnection.

type RemoteConnectionCreationRequest added in v2.8.0 

type RemoteConnectionCreationRequest struct {
	AllowInsecureTLS bool    `json:"allowInsecureTLS"`
	Description      *string `json:"description,omitempty"`
	Name             string  `json:"name"`
	OrgID            string  `json:"orgID"`
	RemoteAPIToken   string  `json:"remoteAPIToken"`
	RemoteOrgID      string  `json:"remoteOrgID"`
	RemoteURL        string  `json:"remoteURL"`
}

RemoteConnectionCreationRequest defines model for RemoteConnectionCreationRequest.

type RemoteConnectionUpdateRequest added in v2.8.0 

type RemoteConnectionUpdateRequest struct {
	AllowInsecureTLS *bool   `json:"allowInsecureTLS,omitempty"`
	Description      *string `json:"description,omitempty"`
	Name             *string `json:"name,omitempty"`
	RemoteAPIToken   *string `json:"remoteAPIToken,omitempty"`
	RemoteOrgID      *string `json:"remoteOrgID,omitempty"`
	RemoteURL        *string `json:"remoteURL,omitempty"`
}

RemoteConnectionUpdateRequest defines model for RemoteConnectionUpdateRequest.

type RemoteConnections added in v2.8.0 

type RemoteConnections struct {
	Remotes *[]RemoteConnection `json:"remotes,omitempty"`
}

RemoteConnections defines model for RemoteConnections.

type RenamableField 

type RenamableField struct {
	// The name that a field is renamed to by the user.
	DisplayName *string `json:"displayName,omitempty"`

	// The calculated name of a field.
	InternalName *string `json:"internalName,omitempty"`

	// Indicates whether this field should be visible on the table.
	Visible *bool `json:"visible,omitempty"`
}

Describes a field that can be renamed and made visible or invisible.

type Replication added in v2.8.0 

type Replication struct {
	CurrentQueueSizeBytes int64   `json:"currentQueueSizeBytes"`
	Description           *string `json:"description,omitempty"`
	DropNonRetryableData  *bool   `json:"dropNonRetryableData,omitempty"`
	Id                    string  `json:"id"`
	LatestErrorMessage    *string `json:"latestErrorMessage,omitempty"`
	LatestResponseCode    *int    `json:"latestResponseCode,omitempty"`
	LocalBucketID         string  `json:"localBucketID"`
	MaxQueueSizeBytes     int64   `json:"maxQueueSizeBytes"`
	Name                  string  `json:"name"`
	OrgID                 string  `json:"orgID"`
	RemoteBucketID        *string `json:"remoteBucketID,omitempty"`
	RemoteBucketName      *string `json:"remoteBucketName,omitempty"`
	RemoteID              string  `json:"remoteID"`
}

Replication defines model for Replication.

type ReplicationCreationRequest added in v2.8.0 

type ReplicationCreationRequest struct {
	Description          *string `json:"description,omitempty"`
	DropNonRetryableData *bool   `json:"dropNonRetryableData,omitempty"`
	LocalBucketID        string  `json:"localBucketID"`
	MaxAgeSeconds        int64   `json:"maxAgeSeconds"`
	MaxQueueSizeBytes    int64   `json:"maxQueueSizeBytes"`
	Name                 string  `json:"name"`
	OrgID                string  `json:"orgID"`
	RemoteBucketID       *string `json:"remoteBucketID,omitempty"`
	RemoteBucketName     *string `json:"remoteBucketName,omitempty"`
	RemoteID             string  `json:"remoteID"`
}

ReplicationCreationRequest defines model for ReplicationCreationRequest.

type ReplicationUpdateRequest added in v2.8.0 

type ReplicationUpdateRequest struct {
	Description          *string `json:"description,omitempty"`
	DropNonRetryableData *bool   `json:"dropNonRetryableData,omitempty"`
	MaxAgeSeconds        *int64  `json:"maxAgeSeconds,omitempty"`
	MaxQueueSizeBytes    *int64  `json:"maxQueueSizeBytes,omitempty"`
	Name                 *string `json:"name,omitempty"`
	RemoteBucketID       *string `json:"remoteBucketID,omitempty"`
	RemoteBucketName     *string `json:"remoteBucketName,omitempty"`
	RemoteID             *string `json:"remoteID,omitempty"`
}

ReplicationUpdateRequest defines model for ReplicationUpdateRequest.

type Replications added in v2.8.0 

type Replications struct {
	Replications *[]Replication `json:"replications,omitempty"`
}

Replications defines model for Replications.

type Resource 

type Resource struct {
	// The ID of a specific resource.
	// In a `permission`, applies the permission to only the resource with this ID.
	Id *string `json:"id,omitempty"`

	// Optional: A name for the resource.
	// Not all resource types have a name field.
	Name *string `json:"name,omitempty"`

	// Optional: The name of the organization with `orgID`.
	Org *string `json:"org,omitempty"`

	// The ID of the organization that owns the resource.
	// In a `permission`, applies the permission to all resources of `type` owned by this organization.
	OrgID *string `json:"orgID,omitempty"`

	// The type of resource.
	// In a `permission`, applies the permission to all resources of this type.
	Type ResourceType `json:"type"`
}

Resource defines model for Resource.

type ResourceMember 

type ResourceMember struct {
	// Embedded struct due to allOf(#/components/schemas/UserResponse)
	UserResponse `yaml:",inline"`
	// Embedded fields due to inline allOf schema
	Role *ResourceMemberRole `json:"role,omitempty"`
}

ResourceMember defines model for ResourceMember.

type ResourceMemberRole 

type ResourceMemberRole string

ResourceMemberRole defines model for ResourceMember.Role. 

const (
	ResourceMemberRoleMember ResourceMemberRole = "member"
)

Defines values for ResourceMemberRole.

type ResourceMembers 

type ResourceMembers struct {
	Links *struct {
		Self *string `json:"self,omitempty"`
	} `json:"links,omitempty"`
	Users *[]ResourceMember `json:"users,omitempty"`
}

ResourceMembers defines model for ResourceMembers.

type ResourceNotFoundError added in v2.11.0 

type ResourceNotFoundError Error

ResourceNotFoundError defines model for ResourceNotFoundError.

type ResourceOwner 

type ResourceOwner struct {
	// Embedded struct due to allOf(#/components/schemas/UserResponse)
	UserResponse `yaml:",inline"`
	// Embedded fields due to inline allOf schema
	Role *ResourceOwnerRole `json:"role,omitempty"`
}

ResourceOwner defines model for ResourceOwner.

type ResourceOwnerRole 

type ResourceOwnerRole string

ResourceOwnerRole defines model for ResourceOwner.Role. 

const (
	ResourceOwnerRoleOwner ResourceOwnerRole = "owner"
)

Defines values for ResourceOwnerRole.

type ResourceOwners 

type ResourceOwners struct {
	Links *struct {
		Self *string `json:"self,omitempty"`
	} `json:"links,omitempty"`
	Users *[]ResourceOwner `json:"users,omitempty"`
}

ResourceOwners defines model for ResourceOwners.

type ResourceType 

type ResourceType string

The type of resource. In a `permission`, applies the permission to all resources of this type. 

const (
	ResourceTypeAnnotations ResourceType = "annotations"

	ResourceTypeAuthorizations ResourceType = "authorizations"

	ResourceTypeBuckets ResourceType = "buckets"

	ResourceTypeChecks ResourceType = "checks"

	ResourceTypeDashboards ResourceType = "dashboards"

	ResourceTypeDbrp ResourceType = "dbrp"

	ResourceTypeDocuments ResourceType = "documents"

	ResourceTypeInstance ResourceType = "instance"

	ResourceTypeLabels ResourceType = "labels"

	ResourceTypeNotebooks ResourceType = "notebooks"

	ResourceTypeNotificationEndpoints ResourceType = "notificationEndpoints"

	ResourceTypeNotificationRules ResourceType = "notificationRules"

	ResourceTypeOrgs ResourceType = "orgs"

	ResourceTypeRemotes ResourceType = "remotes"

	ResourceTypeReplications ResourceType = "replications"

	ResourceTypeScrapers ResourceType = "scrapers"

	ResourceTypeSecrets ResourceType = "secrets"

	ResourceTypeSources ResourceType = "sources"

	ResourceTypeTasks ResourceType = "tasks"

	ResourceTypeTelegrafs ResourceType = "telegrafs"

	ResourceTypeUsers ResourceType = "users"

	ResourceTypeVariables ResourceType = "variables"

	ResourceTypeViews ResourceType = "views"
)

Defines values for ResourceType.

type RestoredBucketMappings added in v2.5.0 

type RestoredBucketMappings struct {
	// New ID of the restored bucket
	Id            string              `json:"id"`
	Name          string              `json:"name"`
	ShardMappings BucketShardMappings `json:"shardMappings"`
}

RestoredBucketMappings defines model for RestoredBucketMappings.

type RetentionPolicyManifest added in v2.5.0 

type RetentionPolicyManifest struct {
	Duration           int64                 `json:"duration"`
	Name               string                `json:"name"`
	ReplicaN           int                   `json:"replicaN"`
	ShardGroupDuration int64                 `json:"shardGroupDuration"`
	ShardGroups        ShardGroupManifests   `json:"shardGroups"`
	Subscriptions      SubscriptionManifests `json:"subscriptions"`
}

RetentionPolicyManifest defines model for RetentionPolicyManifest.

type RetentionPolicyManifests added in v2.5.0 

type RetentionPolicyManifests []RetentionPolicyManifest

RetentionPolicyManifests defines model for RetentionPolicyManifests.

type RetentionRule 

type RetentionRule struct {
	// The duration in seconds for how long data will be kept in the database.
	// The default duration is 2592000 (30 days).
	// 0 represents infinite retention.
	EverySeconds int64 `json:"everySeconds"`

	// The shard group duration.
	// The duration or interval (in seconds) that each shard group covers.
	//
	// #### InfluxDB Cloud
	//
	// - Does not use `shardGroupDurationsSeconds`.
	//
	// #### InfluxDB OSS
	//
	// - Default value depends on the
	// [bucket retention period](https://docs.influxdata.com/influxdb/v2.3/v2.3/reference/internals/shards/#shard-group-duration).
	ShardGroupDurationSeconds *int64             `json:"shardGroupDurationSeconds,omitempty"`
	Type                      *RetentionRuleType `json:"type,omitempty"`
}

RetentionRule defines model for RetentionRule.

type RetentionRuleType 

type RetentionRuleType string

RetentionRuleType defines model for RetentionRule.Type. 

const (
	RetentionRuleTypeExpire RetentionRuleType = "expire"
)

Defines values for RetentionRuleType.

type RetentionRules 

type RetentionRules []RetentionRule

Retention rules to expire or retain data. #### InfluxDB Cloud

- `retentionRules` is required.

#### InfluxDB OSS

- `retentionRules` isn't required.

type ReturnStatement 

type ReturnStatement struct {
	Argument *Expression `json:"argument,omitempty"`

	// Type of AST node
	Type *NodeType `json:"type,omitempty"`
}

Defines an expression to return

type Routes 

type Routes struct {
	Authorizations *string `json:"authorizations,omitempty"`
	Buckets        *string `json:"buckets,omitempty"`
	Dashboards     *string `json:"dashboards,omitempty"`
	External       *struct {
		StatusFeed *string `json:"statusFeed,omitempty"`
	} `json:"external,omitempty"`
	Flags *string `json:"flags,omitempty"`
	Me    *string `json:"me,omitempty"`
	Orgs  *string `json:"orgs,omitempty"`
	Query *struct {
		Analyze     *string `json:"analyze,omitempty"`
		Ast         *string `json:"ast,omitempty"`
		Self        *string `json:"self,omitempty"`
		Suggestions *string `json:"suggestions,omitempty"`
	} `json:"query,omitempty"`
	Setup   *string `json:"setup,omitempty"`
	Signin  *string `json:"signin,omitempty"`
	Signout *string `json:"signout,omitempty"`
	Sources *string `json:"sources,omitempty"`
	System  *struct {
		Debug   *string `json:"debug,omitempty"`
		Health  *string `json:"health,omitempty"`
		Metrics *string `json:"metrics,omitempty"`
	} `json:"system,omitempty"`
	Tasks     *string `json:"tasks,omitempty"`
	Telegrafs *string `json:"telegrafs,omitempty"`
	Users     *string `json:"users,omitempty"`
	Variables *string `json:"variables,omitempty"`
	Write     *string `json:"write,omitempty"`
}

Routes defines model for Routes.

type RuleStatusLevel 

type RuleStatusLevel string

The state to record if check matches a criteria. 

const (
	RuleStatusLevelANY RuleStatusLevel = "ANY"

	RuleStatusLevelCRIT RuleStatusLevel = "CRIT"

	RuleStatusLevelINFO RuleStatusLevel = "INFO"

	RuleStatusLevelOK RuleStatusLevel = "OK"

	RuleStatusLevelUNKNOWN RuleStatusLevel = "UNKNOWN"

	RuleStatusLevelWARN RuleStatusLevel = "WARN"
)

Defines values for RuleStatusLevel.

type Run 

type Run struct {
	// The time ([RFC3339Nano date/time format](https://go.dev/src/time/format.go)) the run finished executing.
	FinishedAt *time.Time `json:"finishedAt,omitempty"`

	// Flux used for the task
	Flux  *string `json:"flux,omitempty"`
	Id    *string `json:"id,omitempty"`
	Links *struct {
		Retry *string `json:"retry,omitempty"`
		Self  *string `json:"self,omitempty"`
		Task  *string `json:"task,omitempty"`
	} `json:"links,omitempty"`

	// An array of logs associated with the run.
	Log *[]LogEvent `json:"log,omitempty"`

	// The time ([RFC3339Nano date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339nano-timestamp)) the run was manually requested.
	RequestedAt *time.Time `json:"requestedAt,omitempty"`

	// The time [RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp) used for the run's `now` option.
	ScheduledFor *time.Time `json:"scheduledFor,omitempty"`

	// The time ([RFC3339Nano date/time format](https://go.dev/src/time/format.go)) the run started executing.
	StartedAt *time.Time `json:"startedAt,omitempty"`
	Status    *RunStatus `json:"status,omitempty"`
	TaskID    *string    `json:"taskID,omitempty"`
}

Run defines model for Run.

type RunManually 

type RunManually struct {
	// The time [RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)
	// used for the run's `now` option.
	// Default is the server _now_ time.
	ScheduledFor *time.Time `json:"scheduledFor"`
}

RunManually defines model for RunManually.

type RunStatus 

type RunStatus string

RunStatus defines model for Run.Status. 

const (
	RunStatusCanceled RunStatus = "canceled"

	RunStatusFailed RunStatus = "failed"

	RunStatusScheduled RunStatus = "scheduled"

	RunStatusStarted RunStatus = "started"

	RunStatusSuccess RunStatus = "success"
)

Defines values for RunStatus.

type Runs 

type Runs struct {
	// URI pointers for additional paged results.
	Links *Links `json:"links,omitempty"`
	Runs  *[]Run `json:"runs,omitempty"`
}

Runs defines model for Runs.

type SMTPNotificationRule 

type SMTPNotificationRule struct {
	// Embedded struct due to allOf(#/components/schemas/NotificationRuleBase)
	NotificationRuleBase `yaml:",inline"`
	// Embedded struct due to allOf(#/components/schemas/SMTPNotificationRuleBase)
	SMTPNotificationRuleBase `yaml:",inline"`
}

SMTPNotificationRule defines model for SMTPNotificationRule.

type SMTPNotificationRuleBase 

type SMTPNotificationRuleBase struct {
	BodyTemplate    *string                      `json:"bodyTemplate,omitempty"`
	SubjectTemplate string                       `json:"subjectTemplate"`
	To              string                       `json:"to"`
	Type            SMTPNotificationRuleBaseType `json:"type"`
}

SMTPNotificationRuleBase defines model for SMTPNotificationRuleBase.

type SMTPNotificationRuleBaseType 

type SMTPNotificationRuleBaseType string

SMTPNotificationRuleBaseType defines model for SMTPNotificationRuleBase.Type. 

const (
	SMTPNotificationRuleBaseTypeSmtp SMTPNotificationRuleBaseType = "smtp"
)

Defines values for SMTPNotificationRuleBaseType.

type ScatterViewProperties 

type ScatterViewProperties struct {
	AdaptiveZoomHide *bool `json:"adaptiveZoomHide,omitempty"`

	// Colors define color encoding of data into a visualization
	Colors                     []string                   `json:"colors"`
	FillColumns                []string                   `json:"fillColumns"`
	GenerateXAxisTicks         *[]string                  `json:"generateXAxisTicks,omitempty"`
	GenerateYAxisTicks         *[]string                  `json:"generateYAxisTicks,omitempty"`
	LegendColorizeRows         *bool                      `json:"legendColorizeRows,omitempty"`
	LegendHide                 *bool                      `json:"legendHide,omitempty"`
	LegendOpacity              *float32                   `json:"legendOpacity,omitempty"`
	LegendOrientationThreshold *int                       `json:"legendOrientationThreshold,omitempty"`
	Note                       string                     `json:"note"`
	Queries                    []DashboardQuery           `json:"queries"`
	Shape                      ScatterViewPropertiesShape `json:"shape"`

	// If true, will display note when empty
	ShowNoteWhenEmpty bool                      `json:"showNoteWhenEmpty"`
	SymbolColumns     []string                  `json:"symbolColumns"`
	TimeFormat        *string                   `json:"timeFormat,omitempty"`
	Type              ScatterViewPropertiesType `json:"type"`
	XAxisLabel        string                    `json:"xAxisLabel"`
	XColumn           string                    `json:"xColumn"`
	XDomain           []float32                 `json:"xDomain"`
	XPrefix           string                    `json:"xPrefix"`
	XSuffix           string                    `json:"xSuffix"`
	XTickStart        *float32                  `json:"xTickStart,omitempty"`
	XTickStep         *float32                  `json:"xTickStep,omitempty"`
	XTotalTicks       *int                      `json:"xTotalTicks,omitempty"`
	YAxisLabel        string                    `json:"yAxisLabel"`
	YColumn           string                    `json:"yColumn"`
	YDomain           []float32                 `json:"yDomain"`
	YPrefix           string                    `json:"yPrefix"`
	YSuffix           string                    `json:"ySuffix"`
	YTickStart        *float32                  `json:"yTickStart,omitempty"`
	YTickStep         *float32                  `json:"yTickStep,omitempty"`
	YTotalTicks       *int                      `json:"yTotalTicks,omitempty"`
}

ScatterViewProperties defines model for ScatterViewProperties.

type ScatterViewPropertiesShape 

type ScatterViewPropertiesShape string

ScatterViewPropertiesShape defines model for ScatterViewProperties.Shape. 

const (
	ScatterViewPropertiesShapeChronografV2 ScatterViewPropertiesShape = "chronograf-v2"
)

Defines values for ScatterViewPropertiesShape.

type ScatterViewPropertiesType 

type ScatterViewPropertiesType string

ScatterViewPropertiesType defines model for ScatterViewProperties.Type. 

const (
	ScatterViewPropertiesTypeScatter ScatterViewPropertiesType = "scatter"
)

Defines values for ScatterViewPropertiesType.

type SchemaType added in v2.5.0 

type SchemaType string

SchemaType defines model for SchemaType. 

const (
	SchemaTypeExplicit SchemaType = "explicit"

	SchemaTypeImplicit SchemaType = "implicit"
)

Defines values for SchemaType.

type ScraperTargetRequest 

type ScraperTargetRequest struct {
	// Skip TLS verification on endpoint.
	AllowInsecure *bool `json:"allowInsecure,omitempty"`

	// The ID of the bucket to write to.
	BucketID *string `json:"bucketID,omitempty"`

	// The name of the scraper target.
	Name *string `json:"name,omitempty"`

	// The organization ID.
	OrgID *string `json:"orgID,omitempty"`

	// The type of the metrics to be parsed.
	Type *ScraperTargetRequestType `json:"type,omitempty"`

	// The URL of the metrics endpoint.
	Url *string `json:"url,omitempty"`
}

ScraperTargetRequest defines model for ScraperTargetRequest.

type ScraperTargetRequestType 

type ScraperTargetRequestType string

The type of the metrics to be parsed. 

const (
	ScraperTargetRequestTypePrometheus ScraperTargetRequestType = "prometheus"
)

Defines values for ScraperTargetRequestType.

type ScraperTargetResponse 

type ScraperTargetResponse struct {
	// Embedded struct due to allOf(#/components/schemas/ScraperTargetRequest)
	ScraperTargetRequest `yaml:",inline"`
	// Embedded fields due to inline allOf schema
	// The bucket name.
	Bucket *string `json:"bucket,omitempty"`
	Id     *string `json:"id,omitempty"`
	Links  *struct {
		// URI of resource.
		Bucket *Link `json:"bucket,omitempty"`

		// URI of resource.
		Members *Link `json:"members,omitempty"`

		// URI of resource.
		Organization *Link `json:"organization,omitempty"`

		// URI of resource.
		Owners *Link `json:"owners,omitempty"`

		// URI of resource.
		Self *Link `json:"self,omitempty"`
	} `json:"links,omitempty"`

	// The name of the organization.
	Org *string `json:"org,omitempty"`
}

ScraperTargetResponse defines model for ScraperTargetResponse.

type ScraperTargetResponses 

type ScraperTargetResponses struct {
	Configurations *[]ScraperTargetResponse `json:"configurations,omitempty"`
}

ScraperTargetResponses defines model for ScraperTargetResponses.

type SecretKeys 

type SecretKeys struct {
	Secrets *[]string `json:"secrets,omitempty"`
}

SecretKeys defines model for SecretKeys.

type SecretKeysResponse 

type SecretKeysResponse struct {
	// Embedded struct due to allOf(#/components/schemas/SecretKeys)
	SecretKeys `yaml:",inline"`
	// Embedded fields due to inline allOf schema
	Links *struct {
		Org  *string `json:"org,omitempty"`
		Self *string `json:"self,omitempty"`
	} `json:"links,omitempty"`
}

SecretKeysResponse defines model for SecretKeysResponse.

type Secrets 

type Secrets struct {
	AdditionalProperties map[string]string `json:"-"`
}

Secrets defines model for Secrets.

func (Secrets) Get 

func (a Secrets) Get(fieldName string) (value string, found bool)

Getter for additional properties for Secrets. Returns the specified element and whether it was found

func (Secrets) MarshalJSON 

func (a Secrets) MarshalJSON() ([]byte, error)

Override default JSON handling for Secrets to handle AdditionalProperties

func (*Secrets) Set 

func (a *Secrets) Set(fieldName string, value string)

Setter for additional properties for Secrets

func (*Secrets) UnmarshalJSON 

func (a *Secrets) UnmarshalJSON(b []byte) error

Override default JSON handling for Secrets to handle AdditionalProperties

type ShardGroupManifest added in v2.5.0 

type ShardGroupManifest struct {
	DeletedAt   *time.Time     `json:"deletedAt,omitempty"`
	EndTime     time.Time      `json:"endTime"`
	Id          int64          `json:"id"`
	Shards      ShardManifests `json:"shards"`
	StartTime   time.Time      `json:"startTime"`
	TruncatedAt *time.Time     `json:"truncatedAt,omitempty"`
}

ShardGroupManifest defines model for ShardGroupManifest.

type ShardGroupManifests added in v2.5.0 

type ShardGroupManifests []ShardGroupManifest

ShardGroupManifests defines model for ShardGroupManifests.

type ShardManifest added in v2.5.0 

type ShardManifest struct {
	Id          int64       `json:"id"`
	ShardOwners ShardOwners `json:"shardOwners"`
}

ShardManifest defines model for ShardManifest.

type ShardManifests added in v2.5.0 

type ShardManifests []ShardManifest

ShardManifests defines model for ShardManifests.

type ShardOwner added in v2.5.0 

type ShardOwner struct {
	// The ID of the node that owns the shard.
	NodeID int64 `json:"nodeID"`
}

ShardOwner defines model for ShardOwner.

type ShardOwners added in v2.5.0 

type ShardOwners []ShardOwner

ShardOwners defines model for ShardOwners.

type SimpleTableViewProperties added in v2.6.0 

type SimpleTableViewProperties struct {
	Note    string                         `json:"note"`
	Queries []DashboardQuery               `json:"queries"`
	Shape   SimpleTableViewPropertiesShape `json:"shape"`
	ShowAll bool                           `json:"showAll"`

	// If true, will display note when empty
	ShowNoteWhenEmpty bool                          `json:"showNoteWhenEmpty"`
	Type              SimpleTableViewPropertiesType `json:"type"`
}

SimpleTableViewProperties defines model for SimpleTableViewProperties.

type SimpleTableViewPropertiesShape added in v2.6.0 

type SimpleTableViewPropertiesShape string

SimpleTableViewPropertiesShape defines model for SimpleTableViewProperties.Shape. 

const (
	SimpleTableViewPropertiesShapeChronografV2 SimpleTableViewPropertiesShape = "chronograf-v2"
)

Defines values for SimpleTableViewPropertiesShape.

type SimpleTableViewPropertiesType added in v2.6.0 

type SimpleTableViewPropertiesType string

SimpleTableViewPropertiesType defines model for SimpleTableViewProperties.Type. 

const (
	SimpleTableViewPropertiesTypeSimpleTable SimpleTableViewPropertiesType = "simple-table"
)

Defines values for SimpleTableViewPropertiesType.

type SingleStatViewProperties 

type SingleStatViewProperties struct {
	// Colors define color encoding of data into a visualization
	Colors []DashboardColor `json:"colors"`

	// Indicates whether decimal places should be enforced, and how many digits it should show.
	DecimalPlaces DecimalPlaces                 `json:"decimalPlaces"`
	Note          string                        `json:"note"`
	Prefix        string                        `json:"prefix"`
	Queries       []DashboardQuery              `json:"queries"`
	Shape         SingleStatViewPropertiesShape `json:"shape"`

	// If true, will display note when empty
	ShowNoteWhenEmpty bool `json:"showNoteWhenEmpty"`

	// StaticLegend represents the options specific to the static legend
	StaticLegend *StaticLegend                `json:"staticLegend,omitempty"`
	Suffix       string                       `json:"suffix"`
	TickPrefix   string                       `json:"tickPrefix"`
	TickSuffix   string                       `json:"tickSuffix"`
	Type         SingleStatViewPropertiesType `json:"type"`
}

SingleStatViewProperties defines model for SingleStatViewProperties.

type SingleStatViewPropertiesShape 

type SingleStatViewPropertiesShape string

SingleStatViewPropertiesShape defines model for SingleStatViewProperties.Shape. 

const (
	SingleStatViewPropertiesShapeChronografV2 SingleStatViewPropertiesShape = "chronograf-v2"
)

Defines values for SingleStatViewPropertiesShape.

type SingleStatViewPropertiesType 

type SingleStatViewPropertiesType string

SingleStatViewPropertiesType defines model for SingleStatViewProperties.Type. 

const (
	SingleStatViewPropertiesTypeSingleStat SingleStatViewPropertiesType = "single-stat"
)

Defines values for SingleStatViewPropertiesType.

type SlackNotificationEndpoint 

type SlackNotificationEndpoint struct {
	// Embedded struct due to allOf(#/components/schemas/NotificationEndpointBase)
	NotificationEndpointBase `yaml:",inline"`
	// Embedded fields due to inline allOf schema
	// Specifies the API token string. Specify either `URL` or `Token`.
	Token *string `json:"token,omitempty"`

	// Specifies the URL of the Slack endpoint. Specify either `URL` or `Token`.
	Url *string `json:"url,omitempty"`
}

SlackNotificationEndpoint defines model for SlackNotificationEndpoint.

type SlackNotificationRule 

type SlackNotificationRule struct {
	// Embedded struct due to allOf(#/components/schemas/NotificationRuleBase)
	NotificationRuleBase `yaml:",inline"`
	// Embedded struct due to allOf(#/components/schemas/SlackNotificationRuleBase)
	SlackNotificationRuleBase `yaml:",inline"`
}

SlackNotificationRule defines model for SlackNotificationRule.

type SlackNotificationRuleBase 

type SlackNotificationRuleBase struct {
	Channel         *string                       `json:"channel,omitempty"`
	MessageTemplate string                        `json:"messageTemplate"`
	Type            SlackNotificationRuleBaseType `json:"type"`
}

SlackNotificationRuleBase defines model for SlackNotificationRuleBase.

type SlackNotificationRuleBaseType 

type SlackNotificationRuleBaseType string

SlackNotificationRuleBaseType defines model for SlackNotificationRuleBase.Type. 

const (
	SlackNotificationRuleBaseTypeSlack SlackNotificationRuleBaseType = "slack"
)

Defines values for SlackNotificationRuleBaseType.

type Source 

type Source struct {
	Default            *bool              `json:"default,omitempty"`
	DefaultRP          *string            `json:"defaultRP,omitempty"`
	Id                 *string            `json:"id,omitempty"`
	InsecureSkipVerify *bool              `json:"insecureSkipVerify,omitempty"`
	Languages          *[]SourceLanguages `json:"languages,omitempty"`
	Links              *struct {
		Buckets *string `json:"buckets,omitempty"`
		Health  *string `json:"health,omitempty"`
		Query   *string `json:"query,omitempty"`
		Self    *string `json:"self,omitempty"`
	} `json:"links,omitempty"`
	MetaUrl      *string     `json:"metaUrl,omitempty"`
	Name         *string     `json:"name,omitempty"`
	OrgID        *string     `json:"orgID,omitempty"`
	Password     *string     `json:"password,omitempty"`
	SharedSecret *string     `json:"sharedSecret,omitempty"`
	Telegraf     *string     `json:"telegraf,omitempty"`
	Token        *string     `json:"token,omitempty"`
	Type         *SourceType `json:"type,omitempty"`
	Url          *string     `json:"url,omitempty"`
	Username     *string     `json:"username,omitempty"`
}

Source defines model for Source.

type SourceLanguages 

type SourceLanguages string

SourceLanguages defines model for Source.Languages. 

const (
	SourceLanguagesFlux SourceLanguages = "flux"

	SourceLanguagesInfluxql SourceLanguages = "influxql"
)

Defines values for SourceLanguages.

type SourceType 

type SourceType string

SourceType defines model for Source.Type. 

const (
	SourceTypeSelf SourceType = "self"

	SourceTypeV1 SourceType = "v1"

	SourceTypeV2 SourceType = "v2"
)

Defines values for SourceType.

type Sources 

type Sources struct {
	Links *struct {
		Self *string `json:"self,omitempty"`
	} `json:"links,omitempty"`
	Sources *[]Source `json:"sources,omitempty"`
}

Sources defines model for Sources.

type Stack 

type Stack struct {
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	Events    *[]struct {
		Description *string `json:"description,omitempty"`
		EventType   *string `json:"eventType,omitempty"`
		Name        *string `json:"name,omitempty"`
		Resources   *[]struct {
			ApiVersion   *string `json:"apiVersion,omitempty"`
			Associations *[]struct {
				Kind     *TemplateKind `json:"kind,omitempty"`
				MetaName *string       `json:"metaName,omitempty"`
			} `json:"associations,omitempty"`
			Kind  *TemplateKind `json:"kind,omitempty"`
			Links *struct {
				Self *string `json:"self,omitempty"`
			} `json:"links,omitempty"`
			ResourceID       *string `json:"resourceID,omitempty"`
			TemplateMetaName *string `json:"templateMetaName,omitempty"`
		} `json:"resources,omitempty"`
		Sources   *[]string  `json:"sources,omitempty"`
		UpdatedAt *time.Time `json:"updatedAt,omitempty"`
		Urls      *[]string  `json:"urls,omitempty"`
	} `json:"events,omitempty"`
	Id    *string `json:"id,omitempty"`
	OrgID *string `json:"orgID,omitempty"`
}

Stack defines model for Stack.

type Statement 

type Statement interface{}

Statement defines model for Statement.

type StaticLegend added in v2.5.0 

type StaticLegend struct {
	ColorizeRows         *bool    `json:"colorizeRows,omitempty"`
	HeightRatio          *float32 `json:"heightRatio,omitempty"`
	Opacity              *float32 `json:"opacity,omitempty"`
	OrientationThreshold *int     `json:"orientationThreshold,omitempty"`
	Show                 *bool    `json:"show,omitempty"`
	ValueAxis            *string  `json:"valueAxis,omitempty"`
	WidthRatio           *float32 `json:"widthRatio,omitempty"`
}

StaticLegend represents the options specific to the static legend

type StatusRule 

type StatusRule struct {
	Count *int `json:"count,omitempty"`

	// The state to record if check matches a criteria.
	CurrentLevel *RuleStatusLevel `json:"currentLevel,omitempty"`
	Period       *string          `json:"period,omitempty"`

	// The state to record if check matches a criteria.
	PreviousLevel *RuleStatusLevel `json:"previousLevel,omitempty"`
}

StatusRule defines model for StatusRule.

type StringLiteral 

type StringLiteral struct {
	// Type of AST node
	Type  *NodeType `json:"type,omitempty"`
	Value *string   `json:"value,omitempty"`
}

Expressions begin and end with double quote marks

type SubscriptionManifest added in v2.5.0 

type SubscriptionManifest struct {
	Destinations []string `json:"destinations"`
	Mode         string   `json:"mode"`
	Name         string   `json:"name"`
}

SubscriptionManifest defines model for SubscriptionManifest.

type SubscriptionManifests added in v2.5.0 

type SubscriptionManifests []SubscriptionManifest

SubscriptionManifests defines model for SubscriptionManifests.

type TableViewProperties 

type TableViewProperties struct {
	// Colors define color encoding of data into a visualization
	Colors []DashboardColor `json:"colors"`

	// Indicates whether decimal places should be enforced, and how many digits it should show.
	DecimalPlaces DecimalPlaces `json:"decimalPlaces"`

	// fieldOptions represent the fields retrieved by the query with customization options
	FieldOptions []RenamableField         `json:"fieldOptions"`
	Note         string                   `json:"note"`
	Queries      []DashboardQuery         `json:"queries"`
	Shape        TableViewPropertiesShape `json:"shape"`

	// If true, will display note when empty
	ShowNoteWhenEmpty bool `json:"showNoteWhenEmpty"`
	TableOptions      struct {
		// fixFirstColumn indicates whether the first column of the table should be locked
		FixFirstColumn *bool `json:"fixFirstColumn,omitempty"`

		// Describes a field that can be renamed and made visible or invisible.
		SortBy *RenamableField `json:"sortBy,omitempty"`

		// verticalTimeAxis describes the orientation of the table by indicating whether the time axis will be displayed vertically
		VerticalTimeAxis *bool `json:"verticalTimeAxis,omitempty"`

		// Wrapping describes the text wrapping style to be used in table views
		Wrapping *TableViewPropertiesTableOptionsWrapping `json:"wrapping,omitempty"`
	} `json:"tableOptions"`

	// timeFormat describes the display format for time values according to moment.js date formatting
	TimeFormat string                  `json:"timeFormat"`
	Type       TableViewPropertiesType `json:"type"`
}

TableViewProperties defines model for TableViewProperties.

type TableViewPropertiesShape 

type TableViewPropertiesShape string

TableViewPropertiesShape defines model for TableViewProperties.Shape. 

const (
	TableViewPropertiesShapeChronografV2 TableViewPropertiesShape = "chronograf-v2"
)

Defines values for TableViewPropertiesShape.

type TableViewPropertiesTableOptionsWrapping 

type TableViewPropertiesTableOptionsWrapping string

Wrapping describes the text wrapping style to be used in table views 

const (
	TableViewPropertiesTableOptionsWrappingSingleLine TableViewPropertiesTableOptionsWrapping = "single-line"

	TableViewPropertiesTableOptionsWrappingTruncate TableViewPropertiesTableOptionsWrapping = "truncate"

	TableViewPropertiesTableOptionsWrappingWrap TableViewPropertiesTableOptionsWrapping = "wrap"
)

Defines values for TableViewPropertiesTableOptionsWrapping.

type TableViewPropertiesType 

type TableViewPropertiesType string

TableViewPropertiesType defines model for TableViewProperties.Type. 

const (
	TableViewPropertiesTypeTable TableViewPropertiesType = "table"
)

Defines values for TableViewPropertiesType.

type TagRule 

type TagRule struct {
	Key      *string          `json:"key,omitempty"`
	Operator *TagRuleOperator `json:"operator,omitempty"`
	Value    *string          `json:"value,omitempty"`
}

TagRule defines model for TagRule.

type TagRuleOperator 

type TagRuleOperator string

TagRuleOperator defines model for TagRule.Operator. 

const (
	TagRuleOperatorEqual TagRuleOperator = "equal"

	TagRuleOperatorEqualregex TagRuleOperator = "equalregex"

	TagRuleOperatorNotequal TagRuleOperator = "notequal"

	TagRuleOperatorNotequalregex TagRuleOperator = "notequalregex"
)

Defines values for TagRuleOperator.

type Task 

type Task struct {
	// The ID of the authorization used when the task communicates with the query engine.
	AuthorizationID *string    `json:"authorizationID,omitempty"`
	CreatedAt       *time.Time `json:"createdAt,omitempty"`

	// [Cron expression](https://en.wikipedia.org/wiki/Cron#Overview) that defines the schedule on which the task runs. InfluxDB bases cron runs on the system time.
	Cron *string `json:"cron,omitempty"`

	// The description of the task.
	Description *string `json:"description,omitempty"`

	// An interval ([duration literal](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals))) at which the task runs. `every` also determines when the task first runs, depending on the specified time.
	Every *string `json:"every,omitempty"`

	// The Flux script that the task runs.
	Flux          string             `json:"flux"`
	Id            string             `json:"id"`
	Labels        *Labels            `json:"labels,omitempty"`
	LastRunError  *string            `json:"lastRunError,omitempty"`
	LastRunStatus *TaskLastRunStatus `json:"lastRunStatus,omitempty"`

	// A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/flux/v0.x/data-types/basic/time/#time-syntax)) of the latest scheduled and completed run.
	LatestCompleted *time.Time `json:"latestCompleted,omitempty"`
	Links           *struct {
		// URI of resource.
		Labels *Link `json:"labels,omitempty"`

		// URI of resource.
		Logs *Link `json:"logs,omitempty"`

		// URI of resource.
		Members *Link `json:"members,omitempty"`

		// URI of resource.
		Owners *Link `json:"owners,omitempty"`

		// URI of resource.
		Runs *Link `json:"runs,omitempty"`

		// URI of resource.
		Self *Link `json:"self,omitempty"`
	} `json:"links,omitempty"`

	// The name of the task.
	Name string `json:"name"`

	// A [duration](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals) to delay execution of the task after the scheduled time has elapsed. `0` removes the offset.
	Offset *string `json:"offset,omitempty"`

	// The name of the organization that owns the task.
	Org *string `json:"org,omitempty"`

	// The ID of the organization that owns the task.
	OrgID string `json:"orgID"`

	// The ID of the user who owns the Task.
	OwnerID *string `json:"ownerID,omitempty"`

	// `inactive` cancels scheduled runs and prevents manual runs of the task.
	Status    *TaskStatusType `json:"status,omitempty"`
	UpdatedAt *time.Time      `json:"updatedAt,omitempty"`
}

Task defines model for Task.

type TaskCreateRequest 

type TaskCreateRequest struct {
	// An optional description of the task.
	Description *string `json:"description,omitempty"`

	// The Flux script to run for this task.
	Flux string `json:"flux"`

	// The name of the organization that owns this Task.
	Org *string `json:"org,omitempty"`

	// The ID of the organization that owns this Task.
	OrgID *string `json:"orgID,omitempty"`

	// `inactive` cancels scheduled runs and prevents manual runs of the task.
	Status *TaskStatusType `json:"status,omitempty"`
}

TaskCreateRequest defines model for TaskCreateRequest.

type TaskLastRunStatus 

type TaskLastRunStatus string

TaskLastRunStatus defines model for Task.LastRunStatus. 

const (
	TaskLastRunStatusCanceled TaskLastRunStatus = "canceled"

	TaskLastRunStatusFailed TaskLastRunStatus = "failed"

	TaskLastRunStatusSuccess TaskLastRunStatus = "success"
)

Defines values for TaskLastRunStatus.

type TaskStatusType 

type TaskStatusType string

`inactive` cancels scheduled runs and prevents manual runs of the task. 

const (
	TaskStatusTypeActive TaskStatusType = "active"

	TaskStatusTypeInactive TaskStatusType = "inactive"
)

Defines values for TaskStatusType.

type TaskUpdateRequest 

type TaskUpdateRequest struct {
	// Update the 'cron' option in the flux script.
	Cron *string `json:"cron,omitempty"`

	// Update the description of the task.
	Description *string `json:"description,omitempty"`

	// Update the 'every' option in the flux script.
	Every *string `json:"every,omitempty"`

	// The Flux script that the task runs.
	Flux *string `json:"flux,omitempty"`

	// Update the 'name' option in the flux script.
	Name *string `json:"name,omitempty"`

	// Update the 'offset' option in the flux script.
	Offset *string `json:"offset,omitempty"`

	// `inactive` cancels scheduled runs and prevents manual runs of the task.
	Status *TaskStatusType `json:"status,omitempty"`
}

TaskUpdateRequest defines model for TaskUpdateRequest.

type Tasks 

type Tasks struct {
	// URI pointers for additional paged results.
	Links *Links  `json:"links,omitempty"`
	Tasks *[]Task `json:"tasks,omitempty"`
}

Tasks defines model for Tasks.

type Telegraf 

type Telegraf struct {
	// Embedded struct due to allOf(#/components/schemas/TelegrafRequest)
	TelegrafRequest `yaml:",inline"`
	// Embedded fields due to inline allOf schema
	Id     *string `json:"id,omitempty"`
	Labels *Labels `json:"labels,omitempty"`
	Links  *struct {
		// URI of resource.
		Labels *Link `json:"labels,omitempty"`

		// URI of resource.
		Members *Link `json:"members,omitempty"`

		// URI of resource.
		Owners *Link `json:"owners,omitempty"`

		// URI of resource.
		Self *Link `json:"self,omitempty"`
	} `json:"links,omitempty"`
}

Telegraf defines model for Telegraf.

type TelegrafPlugin 

type TelegrafPlugin struct {
	Config      *string `json:"config,omitempty"`
	Description *string `json:"description,omitempty"`
	Name        *string `json:"name,omitempty"`
	Type        *string `json:"type,omitempty"`
}

TelegrafPlugin defines model for TelegrafPlugin.

type TelegrafPluginRequest added in v2.8.0 

type TelegrafPluginRequest struct {
	Config      *string `json:"config,omitempty"`
	Description *string `json:"description,omitempty"`
	Metadata    *struct {
		Buckets *[]string `json:"buckets,omitempty"`
	} `json:"metadata,omitempty"`
	Name    *string `json:"name,omitempty"`
	OrgID   *string `json:"orgID,omitempty"`
	Plugins *[]struct {
		Alias       *string `json:"alias,omitempty"`
		Config      *string `json:"config,omitempty"`
		Description *string `json:"description,omitempty"`
		Name        *string `json:"name,omitempty"`
		Type        *string `json:"type,omitempty"`
	} `json:"plugins,omitempty"`
}

TelegrafPluginRequest defines model for TelegrafPluginRequest.

type TelegrafPlugins 

type TelegrafPlugins struct {
	Os      *string           `json:"os,omitempty"`
	Plugins *[]TelegrafPlugin `json:"plugins,omitempty"`
	Version *string           `json:"version,omitempty"`
}

TelegrafPlugins defines model for TelegrafPlugins.

type TelegrafRequest 

type TelegrafRequest struct {
	Config      *string `json:"config,omitempty"`
	Description *string `json:"description,omitempty"`
	Metadata    *struct {
		Buckets *[]string `json:"buckets,omitempty"`
	} `json:"metadata,omitempty"`
	Name  *string `json:"name,omitempty"`
	OrgID *string `json:"orgID,omitempty"`
}

TelegrafRequest defines model for TelegrafRequest.

type Telegrafs 

type Telegrafs struct {
	Configurations *[]Telegraf `json:"configurations,omitempty"`
}

Telegrafs defines model for Telegrafs.

type TelegramNotificationEndpoint added in v2.1.0 

type TelegramNotificationEndpoint struct {
	// Embedded struct due to allOf(#/components/schemas/NotificationEndpointBase)
	NotificationEndpointBase `yaml:",inline"`
	// Embedded fields due to inline allOf schema
	// The ID of the telegram channel; a chat_id in https://core.telegram.org/bots/api#sendmessage .
	Channel string `json:"channel"`

	// Specifies the Telegram bot token. See https://core.telegram.org/bots#creating-a-new-bot .
	Token string `json:"token"`
}

TelegramNotificationEndpoint defines model for TelegramNotificationEndpoint.

type TelegramNotificationRule added in v2.1.0 

type TelegramNotificationRule struct {
	// Embedded struct due to allOf(#/components/schemas/NotificationRuleBase)
	NotificationRuleBase `yaml:",inline"`
	// Embedded struct due to allOf(#/components/schemas/TelegramNotificationRuleBase)
	TelegramNotificationRuleBase `yaml:",inline"`
}

TelegramNotificationRule defines model for TelegramNotificationRule.

type TelegramNotificationRuleBase added in v2.1.0 

type TelegramNotificationRuleBase struct {
	// Disables preview of web links in the sent messages when "true". Defaults to "false".
	DisableWebPagePreview *bool `json:"disableWebPagePreview,omitempty"`

	// The message template as a flux interpolated string.
	MessageTemplate string `json:"messageTemplate"`

	// Parse mode of the message text per https://core.telegram.org/bots/api#formatting-options. Defaults to "MarkdownV2".
	ParseMode *TelegramNotificationRuleBaseParseMode `json:"parseMode,omitempty"`

	// The discriminator between other types of notification rules is "telegram".
	Type TelegramNotificationRuleBaseType `json:"type"`
}

TelegramNotificationRuleBase defines model for TelegramNotificationRuleBase.

type TelegramNotificationRuleBaseParseMode added in v2.1.0 

type TelegramNotificationRuleBaseParseMode string

Parse mode of the message text per https://core.telegram.org/bots/api#formatting-options. Defaults to "MarkdownV2". 

const (
	TelegramNotificationRuleBaseParseModeHTML TelegramNotificationRuleBaseParseMode = "HTML"

	TelegramNotificationRuleBaseParseModeMarkdown TelegramNotificationRuleBaseParseMode = "Markdown"

	TelegramNotificationRuleBaseParseModeMarkdownV2 TelegramNotificationRuleBaseParseMode = "MarkdownV2"
)

Defines values for TelegramNotificationRuleBaseParseMode.

type TelegramNotificationRuleBaseType added in v2.1.0 

type TelegramNotificationRuleBaseType string

The discriminator between other types of notification rules is "telegram". 

const (
	TelegramNotificationRuleBaseTypeTelegram TelegramNotificationRuleBaseType = "telegram"
)

Defines values for TelegramNotificationRuleBaseType.

type Template 

type Template []struct {
	ApiVersion *string       `json:"apiVersion,omitempty"`
	Kind       *TemplateKind `json:"kind,omitempty"`

	// Metadata properties used for the resource when the template is applied.
	Metadata *struct {
		Name *string `json:"name,omitempty"`
	} `json:"metadata,omitempty"`

	// Configuration properties used for the resource when the template is applied.
	// Key-value pairs map to the specification for the resource.
	//
	// The following code samples show `spec` configurations for template resources:
	//
	// - A bucket:
	//
	//   “`json
	//   { "spec": {
	//       "name": "iot_center",
	//       "retentionRules": [{
	//           "everySeconds": 2.592e+06,
	//           "type": "expire"
	//         }]
	//     }
	//   }
	//   “`
	//
	// - A variable:
	//
	//   “`json
	//   { "spec": {
	//       "language": "flux",
	//       "name": "Node_Service",
	//       "query": "import \"influxdata/influxdb/v1\"\r\nv1.tagValues(bucket: \"iot_center\",
	//           tag: \"service\")",
	//       "type": "query"
	//     }
	//   }
	//   “`
	Spec *map[string]interface{} `json:"spec,omitempty"`
}

Template defines model for Template.

type TemplateApply 

type TemplateApply struct {
	// A 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`.
	Actions *[]interface{} `json:"actions,omitempty"`

	// Only 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.
	DryRun *bool `json:"dryRun,omitempty"`

	// 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](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/use/#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](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/create/#include-user-definable-resource-names).
	EnvRefs *TemplateApply_EnvRefs `json:"envRefs,omitempty"`

	// Organization 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](https://docs.influxdata.com/influxdb/v2.3/organizations/view-orgs/).
	OrgID *string `json:"orgID,omitempty"`

	// A 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.
	Remotes *[]struct {
		ContentType *string `json:"contentType,omitempty"`
		Url         string  `json:"url"`
	} `json:"remotes,omitempty"`

	// 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](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/use/#pass-secrets-when-installing-a-template)
	Secrets *TemplateApply_Secrets `json:"secrets,omitempty"`

	// ID 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](#operation/ListStacks) to list stacks.
	//
	// #### Related guides
	//
	// - [Stacks](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/stacks/)
	// - [View stacks](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/stacks/view/)
	StackID *string `json:"stackID,omitempty"`

	// A template object to apply.
	// A template object has a `contents` property
	// with an array of InfluxDB resource configurations.
	//
	// Pass `template` to apply only one template object.
	// If you use `template`, you can't use the `templates` parameter.
	// If you want to apply multiple template objects, use `templates` instead.
	Template *struct {
		ContentType *string   `json:"contentType,omitempty"`
		Contents    *Template `json:"contents,omitempty"`
		Sources     *[]string `json:"sources,omitempty"`
	} `json:"template,omitempty"`

	// A 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.
	Templates *[]struct {
		ContentType *string   `json:"contentType,omitempty"`
		Contents    *Template `json:"contents,omitempty"`
		Sources     *[]string `json:"sources,omitempty"`
	} `json:"templates,omitempty"`
}

TemplateApply defines model for TemplateApply.

type TemplateApply_EnvRefs 

type TemplateApply_EnvRefs struct {
	AdditionalProperties map[string]interface{} `json:"-"`
}

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](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/use/#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](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/create/#include-user-definable-resource-names).

func (TemplateApply_EnvRefs) Get 

func (a TemplateApply_EnvRefs) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for TemplateApply_EnvRefs. Returns the specified element and whether it was found

func (TemplateApply_EnvRefs) MarshalJSON 

func (a TemplateApply_EnvRefs) MarshalJSON() ([]byte, error)

Override default JSON handling for TemplateApply_EnvRefs to handle AdditionalProperties

func (*TemplateApply_EnvRefs) Set 

func (a *TemplateApply_EnvRefs) Set(fieldName string, value interface{})

Setter for additional properties for TemplateApply_EnvRefs

func (*TemplateApply_EnvRefs) UnmarshalJSON 

func (a *TemplateApply_EnvRefs) UnmarshalJSON(b []byte) error

Override default JSON handling for TemplateApply_EnvRefs to handle AdditionalProperties

type TemplateApply_Secrets 

type TemplateApply_Secrets struct {
	AdditionalProperties map[string]string `json:"-"`
}

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](https://docs.influxdata.com/influxdb/v2.3/influxdb-templates/use/#pass-secrets-when-installing-a-template)

func (TemplateApply_Secrets) Get 

func (a TemplateApply_Secrets) Get(fieldName string) (value string, found bool)

Getter for additional properties for TemplateApply_Secrets. Returns the specified element and whether it was found

func (TemplateApply_Secrets) MarshalJSON 

func (a TemplateApply_Secrets) MarshalJSON() ([]byte, error)

Override default JSON handling for TemplateApply_Secrets to handle AdditionalProperties

func (*TemplateApply_Secrets) Set 

func (a *TemplateApply_Secrets) Set(fieldName string, value string)

Setter for additional properties for TemplateApply_Secrets

func (*TemplateApply_Secrets) UnmarshalJSON 

func (a *TemplateApply_Secrets) UnmarshalJSON(b []byte) error

Override default JSON handling for TemplateApply_Secrets to handle AdditionalProperties

type TemplateChart 

type TemplateChart struct {
	Height     *int            `json:"height,omitempty"`
	Properties *ViewProperties `json:"properties,omitempty"`
	Width      *int            `json:"width,omitempty"`
	XPos       *int            `json:"xPos,omitempty"`
	YPos       *int            `json:"yPos,omitempty"`
}

TemplateChart defines model for TemplateChart.

type TemplateEnvReferences 

type TemplateEnvReferences []struct {
	// Default value that will be provided for the reference when no value is provided
	DefaultValue *interface{} `json:"defaultValue"`

	// Key identified as environment reference and is the key identified in the template
	EnvRefKey string `json:"envRefKey"`

	// Field the environment reference corresponds too
	ResourceField string `json:"resourceField"`

	// Value provided to fulfill reference
	Value *interface{} `json:"value"`
}

TemplateEnvReferences defines model for TemplateEnvReferences.

type TemplateExportByID added in v2.3.0 

type TemplateExportByID struct {
	OrgIDs *[]struct {
		OrgID           *string `json:"orgID,omitempty"`
		ResourceFilters *struct {
			ByLabel        *[]string       `json:"byLabel,omitempty"`
			ByResourceKind *[]TemplateKind `json:"byResourceKind,omitempty"`
		} `json:"resourceFilters,omitempty"`
	} `json:"orgIDs,omitempty"`
	Resources *[]struct {
		Id   string       `json:"id"`
		Kind TemplateKind `json:"kind"`

		// if defined with id, name is used for resource exported by id. if defined independently, resources strictly matching name are exported
		Name *string `json:"name,omitempty"`
	} `json:"resources,omitempty"`
	StackID *string `json:"stackID,omitempty"`
}

TemplateExportByID defines model for TemplateExportByID.

type TemplateExportByName added in v2.3.0 

type TemplateExportByName struct {
	OrgIDs *[]struct {
		OrgID           *string `json:"orgID,omitempty"`
		ResourceFilters *struct {
			ByLabel        *[]string       `json:"byLabel,omitempty"`
			ByResourceKind *[]TemplateKind `json:"byResourceKind,omitempty"`
		} `json:"resourceFilters,omitempty"`
	} `json:"orgIDs,omitempty"`
	Resources *[]struct {
		Kind TemplateKind `json:"kind"`
		Name string       `json:"name"`
	} `json:"resources,omitempty"`
	StackID *string `json:"stackID,omitempty"`
}

TemplateExportByName defines model for TemplateExportByName.

type TemplateKind 

type TemplateKind string

TemplateKind defines model for TemplateKind. 

const (
	TemplateKindBucket TemplateKind = "Bucket"

	TemplateKindCheck TemplateKind = "Check"

	TemplateKindCheckDeadman TemplateKind = "CheckDeadman"

	TemplateKindCheckThreshold TemplateKind = "CheckThreshold"

	TemplateKindDashboard TemplateKind = "Dashboard"

	TemplateKindLabel TemplateKind = "Label"

	TemplateKindNotificationEndpoint TemplateKind = "NotificationEndpoint"

	TemplateKindNotificationEndpointHTTP TemplateKind = "NotificationEndpointHTTP"

	TemplateKindNotificationEndpointPagerDuty TemplateKind = "NotificationEndpointPagerDuty"

	TemplateKindNotificationEndpointSlack TemplateKind = "NotificationEndpointSlack"

	TemplateKindNotificationRule TemplateKind = "NotificationRule"

	TemplateKindTask TemplateKind = "Task"

	TemplateKindTelegraf TemplateKind = "Telegraf"

	TemplateKindVariable TemplateKind = "Variable"
)

Defines values for TemplateKind.

type TemplateSummary 

type TemplateSummary struct {
	Diff *struct {
		Buckets *[]struct {
			Id   *string       `json:"id,omitempty"`
			Kind *TemplateKind `json:"kind,omitempty"`
			New  *struct {
				Description *string `json:"description,omitempty"`
				Name        *string `json:"name,omitempty"`

				// Retention rules to expire or retain data.
				// #### InfluxDB Cloud
				//
				// - `retentionRules` is required.
				//
				// #### InfluxDB OSS
				//
				// - `retentionRules` isn't required.
				RetentionRules *RetentionRules `json:"retentionRules,omitempty"`
			} `json:"new,omitempty"`
			Old *struct {
				Description *string `json:"description,omitempty"`
				Name        *string `json:"name,omitempty"`

				// Retention rules to expire or retain data.
				// #### InfluxDB Cloud
				//
				// - `retentionRules` is required.
				//
				// #### InfluxDB OSS
				//
				// - `retentionRules` isn't required.
				RetentionRules *RetentionRules `json:"retentionRules,omitempty"`
			} `json:"old,omitempty"`
			StateStatus      *string `json:"stateStatus,omitempty"`
			TemplateMetaName *string `json:"templateMetaName,omitempty"`
		} `json:"buckets,omitempty"`
		Checks *[]struct {
			Id               *string       `json:"id,omitempty"`
			Kind             *TemplateKind `json:"kind,omitempty"`
			New              *Check        `json:"new,omitempty"`
			Old              *Check        `json:"old,omitempty"`
			StateStatus      *string       `json:"stateStatus,omitempty"`
			TemplateMetaName *string       `json:"templateMetaName,omitempty"`
		} `json:"checks,omitempty"`
		Dashboards *[]struct {
			Id   *string       `json:"id,omitempty"`
			Kind *TemplateKind `json:"kind,omitempty"`
			New  *struct {
				Charts      *[]TemplateChart `json:"charts,omitempty"`
				Description *string          `json:"description,omitempty"`
				Name        *string          `json:"name,omitempty"`
			} `json:"new,omitempty"`
			Old *struct {
				Charts      *[]TemplateChart `json:"charts,omitempty"`
				Description *string          `json:"description,omitempty"`
				Name        *string          `json:"name,omitempty"`
			} `json:"old,omitempty"`
			StateStatus      *string `json:"stateStatus,omitempty"`
			TemplateMetaName *string `json:"templateMetaName,omitempty"`
		} `json:"dashboards,omitempty"`
		LabelMappings *[]struct {
			LabelID                  *string `json:"labelID,omitempty"`
			LabelName                *string `json:"labelName,omitempty"`
			LabelTemplateMetaName    *string `json:"labelTemplateMetaName,omitempty"`
			ResourceID               *string `json:"resourceID,omitempty"`
			ResourceName             *string `json:"resourceName,omitempty"`
			ResourceTemplateMetaName *string `json:"resourceTemplateMetaName,omitempty"`
			ResourceType             *string `json:"resourceType,omitempty"`
			Status                   *string `json:"status,omitempty"`
		} `json:"labelMappings,omitempty"`
		Labels *[]struct {
			Id   *string       `json:"id,omitempty"`
			Kind *TemplateKind `json:"kind,omitempty"`
			New  *struct {
				Color       *string `json:"color,omitempty"`
				Description *string `json:"description,omitempty"`
				Name        *string `json:"name,omitempty"`
			} `json:"new,omitempty"`
			Old *struct {
				Color       *string `json:"color,omitempty"`
				Description *string `json:"description,omitempty"`
				Name        *string `json:"name,omitempty"`
			} `json:"old,omitempty"`
			StateStatus      *string `json:"stateStatus,omitempty"`
			TemplateMetaName *string `json:"templateMetaName,omitempty"`
		} `json:"labels,omitempty"`
		NotificationEndpoints *[]struct {
			Id               *string                            `json:"id,omitempty"`
			Kind             *TemplateKind                      `json:"kind,omitempty"`
			New              *NotificationEndpointDiscriminator `json:"new,omitempty"`
			Old              *NotificationEndpointDiscriminator `json:"old,omitempty"`
			StateStatus      *string                            `json:"stateStatus,omitempty"`
			TemplateMetaName *string                            `json:"templateMetaName,omitempty"`
		} `json:"notificationEndpoints,omitempty"`
		NotificationRules *[]struct {
			Id   *string       `json:"id,omitempty"`
			Kind *TemplateKind `json:"kind,omitempty"`
			New  *struct {
				Description     *string `json:"description,omitempty"`
				EndpointID      *string `json:"endpointID,omitempty"`
				EndpointName    *string `json:"endpointName,omitempty"`
				EndpointType    *string `json:"endpointType,omitempty"`
				Every           *string `json:"every,omitempty"`
				MessageTemplate *string `json:"messageTemplate,omitempty"`
				Name            *string `json:"name,omitempty"`
				Offset          *string `json:"offset,omitempty"`
				Status          *string `json:"status,omitempty"`
				StatusRules     *[]struct {
					CurrentLevel  *string `json:"currentLevel,omitempty"`
					PreviousLevel *string `json:"previousLevel,omitempty"`
				} `json:"statusRules,omitempty"`
				TagRules *[]struct {
					Key      *string `json:"key,omitempty"`
					Operator *string `json:"operator,omitempty"`
					Value    *string `json:"value,omitempty"`
				} `json:"tagRules,omitempty"`
			} `json:"new,omitempty"`
			Old *struct {
				Description     *string `json:"description,omitempty"`
				EndpointID      *string `json:"endpointID,omitempty"`
				EndpointName    *string `json:"endpointName,omitempty"`
				EndpointType    *string `json:"endpointType,omitempty"`
				Every           *string `json:"every,omitempty"`
				MessageTemplate *string `json:"messageTemplate,omitempty"`
				Name            *string `json:"name,omitempty"`
				Offset          *string `json:"offset,omitempty"`
				Status          *string `json:"status,omitempty"`
				StatusRules     *[]struct {
					CurrentLevel  *string `json:"currentLevel,omitempty"`
					PreviousLevel *string `json:"previousLevel,omitempty"`
				} `json:"statusRules,omitempty"`
				TagRules *[]struct {
					Key      *string `json:"key,omitempty"`
					Operator *string `json:"operator,omitempty"`
					Value    *string `json:"value,omitempty"`
				} `json:"tagRules,omitempty"`
			} `json:"old,omitempty"`
			StateStatus      *string `json:"stateStatus,omitempty"`
			TemplateMetaName *string `json:"templateMetaName,omitempty"`
		} `json:"notificationRules,omitempty"`
		Tasks *[]struct {
			Id   *string       `json:"id,omitempty"`
			Kind *TemplateKind `json:"kind,omitempty"`
			New  *struct {
				Cron        *string `json:"cron,omitempty"`
				Description *string `json:"description,omitempty"`
				Every       *string `json:"every,omitempty"`
				Name        *string `json:"name,omitempty"`
				Offset      *string `json:"offset,omitempty"`
				Query       *string `json:"query,omitempty"`
				Status      *string `json:"status,omitempty"`
			} `json:"new,omitempty"`
			Old *struct {
				Cron        *string `json:"cron,omitempty"`
				Description *string `json:"description,omitempty"`
				Every       *string `json:"every,omitempty"`
				Name        *string `json:"name,omitempty"`
				Offset      *string `json:"offset,omitempty"`
				Query       *string `json:"query,omitempty"`
				Status      *string `json:"status,omitempty"`
			} `json:"old,omitempty"`
			StateStatus      *string `json:"stateStatus,omitempty"`
			TemplateMetaName *string `json:"templateMetaName,omitempty"`
		} `json:"tasks,omitempty"`
		TelegrafConfigs *[]struct {
			Id               *string          `json:"id,omitempty"`
			Kind             *TemplateKind    `json:"kind,omitempty"`
			New              *TelegrafRequest `json:"new,omitempty"`
			Old              *TelegrafRequest `json:"old,omitempty"`
			StateStatus      *string          `json:"stateStatus,omitempty"`
			TemplateMetaName *string          `json:"templateMetaName,omitempty"`
		} `json:"telegrafConfigs,omitempty"`
		Variables *[]struct {
			Id   *string       `json:"id,omitempty"`
			Kind *TemplateKind `json:"kind,omitempty"`
			New  *struct {
				Args        *VariableProperties `json:"args,omitempty"`
				Description *string             `json:"description,omitempty"`
				Name        *string             `json:"name,omitempty"`
			} `json:"new,omitempty"`
			Old *struct {
				Args        *VariableProperties `json:"args,omitempty"`
				Description *string             `json:"description,omitempty"`
				Name        *string             `json:"name,omitempty"`
			} `json:"old,omitempty"`
			StateStatus      *string `json:"stateStatus,omitempty"`
			TemplateMetaName *string `json:"templateMetaName,omitempty"`
		} `json:"variables,omitempty"`
	} `json:"diff,omitempty"`
	Errors *[]struct {
		Fields  *[]string     `json:"fields,omitempty"`
		Indexes *[]int        `json:"indexes,omitempty"`
		Kind    *TemplateKind `json:"kind,omitempty"`
		Reason  *string       `json:"reason,omitempty"`
	} `json:"errors,omitempty"`
	Sources *[]string `json:"sources,omitempty"`
	StackID *string   `json:"stackID,omitempty"`
	Summary *struct {
		Buckets *[]struct {
			Description       *string                 `json:"description,omitempty"`
			EnvReferences     *TemplateEnvReferences  `json:"envReferences,omitempty"`
			Id                *string                 `json:"id,omitempty"`
			Kind              *TemplateKind           `json:"kind,omitempty"`
			LabelAssociations *[]TemplateSummaryLabel `json:"labelAssociations,omitempty"`
			Name              *string                 `json:"name,omitempty"`
			OrgID             *string                 `json:"orgID,omitempty"`
			RetentionPeriod   *int                    `json:"retentionPeriod,omitempty"`
			TemplateMetaName  *string                 `json:"templateMetaName,omitempty"`
		} `json:"buckets,omitempty"`
		Checks *[]struct {
			// Embedded struct due to allOf(#/components/schemas/CheckDiscriminator)
			Check
			// Embedded fields due to inline allOf schema
			EnvReferences     *TemplateEnvReferences  `json:"envReferences,omitempty"`
			Kind              *TemplateKind           `json:"kind,omitempty"`
			LabelAssociations *[]TemplateSummaryLabel `json:"labelAssociations,omitempty"`
			TemplateMetaName  *string                 `json:"templateMetaName,omitempty"`
		} `json:"checks,omitempty"`
		Dashboards *[]struct {
			Charts            *[]TemplateChart        `json:"charts,omitempty"`
			Description       *string                 `json:"description,omitempty"`
			EnvReferences     *TemplateEnvReferences  `json:"envReferences,omitempty"`
			Id                *string                 `json:"id,omitempty"`
			Kind              *TemplateKind           `json:"kind,omitempty"`
			LabelAssociations *[]TemplateSummaryLabel `json:"labelAssociations,omitempty"`
			Name              *string                 `json:"name,omitempty"`
			OrgID             *string                 `json:"orgID,omitempty"`
			TemplateMetaName  *string                 `json:"templateMetaName,omitempty"`
		} `json:"dashboards,omitempty"`
		LabelMappings *[]struct {
			LabelID                  *string `json:"labelID,omitempty"`
			LabelName                *string `json:"labelName,omitempty"`
			LabelTemplateMetaName    *string `json:"labelTemplateMetaName,omitempty"`
			ResourceID               *string `json:"resourceID,omitempty"`
			ResourceName             *string `json:"resourceName,omitempty"`
			ResourceTemplateMetaName *string `json:"resourceTemplateMetaName,omitempty"`
			ResourceType             *string `json:"resourceType,omitempty"`
			Status                   *string `json:"status,omitempty"`
		} `json:"labelMappings,omitempty"`
		Labels                *[]TemplateSummaryLabel `json:"labels,omitempty"`
		MissingEnvRefs        *[]string               `json:"missingEnvRefs,omitempty"`
		MissingSecrets        *[]string               `json:"missingSecrets,omitempty"`
		NotificationEndpoints *[]struct {
			// Embedded struct due to allOf(#/components/schemas/NotificationEndpointDiscriminator)
			NotificationEndpointDiscriminator `yaml:",inline"`
			// Embedded fields due to inline allOf schema
			EnvReferences     *TemplateEnvReferences  `json:"envReferences,omitempty"`
			Kind              *TemplateKind           `json:"kind,omitempty"`
			LabelAssociations *[]TemplateSummaryLabel `json:"labelAssociations,omitempty"`
			TemplateMetaName  *string                 `json:"templateMetaName,omitempty"`
		} `json:"notificationEndpoints,omitempty"`
		NotificationRules *[]struct {
			Description              *string                 `json:"description,omitempty"`
			EndpointID               *string                 `json:"endpointID,omitempty"`
			EndpointTemplateMetaName *string                 `json:"endpointTemplateMetaName,omitempty"`
			EndpointType             *string                 `json:"endpointType,omitempty"`
			EnvReferences            *TemplateEnvReferences  `json:"envReferences,omitempty"`
			Every                    *string                 `json:"every,omitempty"`
			Kind                     *TemplateKind           `json:"kind,omitempty"`
			LabelAssociations        *[]TemplateSummaryLabel `json:"labelAssociations,omitempty"`
			MessageTemplate          *string                 `json:"messageTemplate,omitempty"`
			Name                     *string                 `json:"name,omitempty"`
			Offset                   *string                 `json:"offset,omitempty"`
			Status                   *string                 `json:"status,omitempty"`
			StatusRules              *[]struct {
				CurrentLevel  *string `json:"currentLevel,omitempty"`
				PreviousLevel *string `json:"previousLevel,omitempty"`
			} `json:"statusRules,omitempty"`
			TagRules *[]struct {
				Key      *string `json:"key,omitempty"`
				Operator *string `json:"operator,omitempty"`
				Value    *string `json:"value,omitempty"`
			} `json:"tagRules,omitempty"`
			TemplateMetaName *string `json:"templateMetaName,omitempty"`
		} `json:"notificationRules,omitempty"`
		Tasks *[]struct {
			Cron             *string                `json:"cron,omitempty"`
			Description      *string                `json:"description,omitempty"`
			EnvReferences    *TemplateEnvReferences `json:"envReferences,omitempty"`
			Every            *string                `json:"every,omitempty"`
			Id               *string                `json:"id,omitempty"`
			Kind             *TemplateKind          `json:"kind,omitempty"`
			Name             *string                `json:"name,omitempty"`
			Offset           *string                `json:"offset,omitempty"`
			Query            *string                `json:"query,omitempty"`
			Status           *string                `json:"status,omitempty"`
			TemplateMetaName *string                `json:"templateMetaName,omitempty"`
		} `json:"tasks,omitempty"`
		TelegrafConfigs *[]struct {
			// Embedded struct due to allOf(#/components/schemas/TelegrafRequest)
			TelegrafRequest `yaml:",inline"`
			// Embedded fields due to inline allOf schema
			EnvReferences     *TemplateEnvReferences  `json:"envReferences,omitempty"`
			Kind              *TemplateKind           `json:"kind,omitempty"`
			LabelAssociations *[]TemplateSummaryLabel `json:"labelAssociations,omitempty"`
			TemplateMetaName  *string                 `json:"templateMetaName,omitempty"`
		} `json:"telegrafConfigs,omitempty"`
		Variables *[]struct {
			Arguments         *VariableProperties     `json:"arguments,omitempty"`
			Description       *string                 `json:"description,omitempty"`
			EnvReferences     *TemplateEnvReferences  `json:"envReferences,omitempty"`
			Id                *string                 `json:"id,omitempty"`
			Kind              *TemplateKind           `json:"kind,omitempty"`
			LabelAssociations *[]TemplateSummaryLabel `json:"labelAssociations,omitempty"`
			Name              *string                 `json:"name,omitempty"`
			OrgID             *string                 `json:"orgID,omitempty"`
			TemplateMetaName  *string                 `json:"templateMetaName,omitempty"`
		} `json:"variables,omitempty"`
	} `json:"summary,omitempty"`
}

TemplateSummary defines model for TemplateSummary.

type TemplateSummaryLabel 

type TemplateSummaryLabel struct {
	EnvReferences *TemplateEnvReferences `json:"envReferences,omitempty"`
	Id            *string                `json:"id,omitempty"`
	Kind          *TemplateKind          `json:"kind,omitempty"`
	Name          *string                `json:"name,omitempty"`
	OrgID         *string                `json:"orgID,omitempty"`
	Properties    *struct {
		Color       *string `json:"color,omitempty"`
		Description *string `json:"description,omitempty"`
	} `json:"properties,omitempty"`
	TemplateMetaName *string `json:"templateMetaName,omitempty"`
}

TemplateSummaryLabel defines model for TemplateSummaryLabel.

type TestStatement 

type TestStatement struct {
	// Represents the declaration of a variable
	Assignment *VariableAssignment `json:"assignment,omitempty"`

	// Type of AST node
	Type *NodeType `json:"type,omitempty"`
}

Declares a Flux test case

type Threshold 

type Threshold interface {
	Type() string
}

Threshold defines model for Threshold.

type ThresholdBase 

type ThresholdBase struct {
	// If true, only alert if all values meet threshold.
	AllValues *bool `json:"allValues,omitempty"`

	// The state to record if check matches a criteria.
	Level *CheckStatusLevel `json:"level,omitempty"`
}

ThresholdBase defines model for ThresholdBase.

type ThresholdCheck 

type ThresholdCheck struct {
	// Embedded struct due to allOf(#/components/schemas/CheckBase)
	CheckBaseExtend
	Thresholds *[]Threshold `json:"thresholds,omitempty"`
}

ThresholdCheck defines model for ThresholdCheck.

func (*ThresholdCheck) MarshalJSON added in v2.14.0 

func (t *ThresholdCheck) MarshalJSON() ([]byte, error)

MarshalJSON implement json.Marshaler interface.

func (ThresholdCheck) Type 

func (t ThresholdCheck) Type() string

func (*ThresholdCheck) UnmarshalJSON added in v2.14.0 

func (t *ThresholdCheck) UnmarshalJSON(b []byte) error

UnmarshalJSON implement json.Unmarshaler interface.

type ThresholdCheckType 

type ThresholdCheckType string

ThresholdCheckType defines model for ThresholdCheck.Type. 

const (
	ThresholdCheckTypeThreshold ThresholdCheckType = "threshold"
)

Defines values for ThresholdCheckType.

type TraceSpan 

type TraceSpan string

TraceSpan defines model for TraceSpan.

type UnaryExpression 

type UnaryExpression struct {
	Argument *Expression `json:"argument,omitempty"`
	Operator *string     `json:"operator,omitempty"`

	// Type of AST node
	Type *NodeType `json:"type,omitempty"`
}

Uses operators to act on a single operand in an expression

type UninstallStackAllParams added in v2.11.0 

type UninstallStackAllParams struct {
	StackId string
}

UninstallStackAllParams defines type for all parameters for UninstallStack.

type UnsignedIntegerLiteral 

type UnsignedIntegerLiteral struct {
	// Type of AST node
	Type  *NodeType `json:"type,omitempty"`
	Value *string   `json:"value,omitempty"`
}

Represents integer numbers

type UpdateStackAllParams added in v2.11.0 

type UpdateStackAllParams struct {
	StackId string

	Body UpdateStackJSONRequestBody
}

UpdateStackAllParams defines type for all parameters for UpdateStack.

type UpdateStackJSONBody 

type UpdateStackJSONBody struct {
	AdditionalResources *[]struct {
		Kind             string  `json:"kind"`
		ResourceID       string  `json:"resourceID"`
		TemplateMetaName *string `json:"templateMetaName,omitempty"`
	} `json:"additionalResources,omitempty"`
	Description  *string   `json:"description"`
	Name         *string   `json:"name"`
	TemplateURLs *[]string `json:"templateURLs"`
}

UpdateStackJSONBody defines parameters for UpdateStack.

type UpdateStackJSONRequestBody 

type UpdateStackJSONRequestBody UpdateStackJSONBody

UpdateStackJSONRequestBody defines body for UpdateStack for application/json ContentType.

type User 

type User struct {
	Id      *string `json:"id,omitempty"`
	Name    string  `json:"name"`
	OauthID *string `json:"oauthID,omitempty"`

	// If inactive the user is inactive.
	Status *UserStatus `json:"status,omitempty"`
}

User defines model for User.

type UserResponse added in v2.5.0 

type UserResponse struct {
	// The ID of the user.
	Id    *string `json:"id,omitempty"`
	Links *struct {
		Self *string `json:"self,omitempty"`
	} `json:"links,omitempty"`

	// The name of the user.
	Name string `json:"name"`

	// The status of a user. An inactive user won't have access to resources.
	Status *UserResponseStatus `json:"status,omitempty"`
}

UserResponse defines model for UserResponse.

type UserResponseStatus added in v2.5.0 

type UserResponseStatus string

The status of a user. An inactive user won't have access to resources. 

const (
	UserResponseStatusActive UserResponseStatus = "active"

	UserResponseStatusInactive UserResponseStatus = "inactive"
)

Defines values for UserResponseStatus.

type UserStatus 

type UserStatus string

If inactive the user is inactive. 

const (
	UserStatusActive UserStatus = "active"

	UserStatusInactive UserStatus = "inactive"
)

Defines values for UserStatus.

type Users 

type Users struct {
	Links *struct {
		Self *string `json:"self,omitempty"`
	} `json:"links,omitempty"`
	Users *[]UserResponse `json:"users,omitempty"`
}

Users defines model for Users.

type Variable 

type Variable struct {
	Arguments   VariableProperties `json:"arguments"`
	CreatedAt   *time.Time         `json:"createdAt,omitempty"`
	Description *string            `json:"description,omitempty"`
	Id          *string            `json:"id,omitempty"`
	Labels      *Labels            `json:"labels,omitempty"`
	Links       *struct {
		Labels *string `json:"labels,omitempty"`
		Org    *string `json:"org,omitempty"`
		Self   *string `json:"self,omitempty"`
	} `json:"links,omitempty"`
	Name      string     `json:"name"`
	OrgID     string     `json:"orgID"`
	Selected  *[]string  `json:"selected,omitempty"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
}

Variable defines model for Variable.

type VariableAssignment 

type VariableAssignment struct {
	// A valid Flux identifier
	Id   *Identifier `json:"id,omitempty"`
	Init *Expression `json:"init,omitempty"`

	// Type of AST node
	Type *NodeType `json:"type,omitempty"`
}

Represents the declaration of a variable

type VariableProperties 

type VariableProperties interface{}

VariableProperties defines model for VariableProperties.

type Variables 

type Variables struct {
	Variables *[]Variable `json:"variables,omitempty"`
}

Variables defines model for Variables.

type View 

type View struct {
	Id    *string `json:"id,omitempty"`
	Links *struct {
		Self *string `json:"self,omitempty"`
	} `json:"links,omitempty"`
	Name       string         `json:"name"`
	Properties ViewProperties `json:"properties"`
}

View defines model for View.

type ViewProperties 

type ViewProperties interface{}

ViewProperties defines model for ViewProperties.

type WritePrecision 

type WritePrecision string

WritePrecision defines model for WritePrecision. 

const (
	WritePrecisionMs WritePrecision = "ms"

	WritePrecisionNs WritePrecision = "ns"

	WritePrecisionS WritePrecision = "s"

	WritePrecisionUs WritePrecision = "us"
)

Defines values for WritePrecision.

type XYGeom 

type XYGeom string

XYGeom defines model for XYGeom. 

const (
	XYGeomBar XYGeom = "bar"

	XYGeomLine XYGeom = "line"

	XYGeomMonotoneX XYGeom = "monotoneX"

	XYGeomStacked XYGeom = "stacked"

	XYGeomStep XYGeom = "step"

	XYGeomStepAfter XYGeom = "stepAfter"

	XYGeomStepBefore XYGeom = "stepBefore"
)

Defines values for XYGeom.

type XYViewProperties 

type XYViewProperties struct {
	AdaptiveZoomHide *bool `json:"adaptiveZoomHide,omitempty"`

	// The viewport for a View's visualizations
	Axes Axes `json:"axes"`

	// A color mapping is an object that maps time series data to a UI color scheme to allow the UI to render graphs consistent colors across reloads.
	ColorMapping *ColorMapping `json:"colorMapping,omitempty"`

	// Colors define color encoding of data into a visualization
	Colors                     []DashboardColor                `json:"colors"`
	GenerateXAxisTicks         *[]string                       `json:"generateXAxisTicks,omitempty"`
	GenerateYAxisTicks         *[]string                       `json:"generateYAxisTicks,omitempty"`
	Geom                       XYGeom                          `json:"geom"`
	HoverDimension             *XYViewPropertiesHoverDimension `json:"hoverDimension,omitempty"`
	LegendColorizeRows         *bool                           `json:"legendColorizeRows,omitempty"`
	LegendHide                 *bool                           `json:"legendHide,omitempty"`
	LegendOpacity              *float32                        `json:"legendOpacity,omitempty"`
	LegendOrientationThreshold *int                            `json:"legendOrientationThreshold,omitempty"`
	Note                       string                          `json:"note"`
	Position                   XYViewPropertiesPosition        `json:"position"`
	Queries                    []DashboardQuery                `json:"queries"`
	ShadeBelow                 *bool                           `json:"shadeBelow,omitempty"`
	Shape                      XYViewPropertiesShape           `json:"shape"`

	// If true, will display note when empty
	ShowNoteWhenEmpty bool `json:"showNoteWhenEmpty"`

	// StaticLegend represents the options specific to the static legend
	StaticLegend *StaticLegend        `json:"staticLegend,omitempty"`
	TimeFormat   *string              `json:"timeFormat,omitempty"`
	Type         XYViewPropertiesType `json:"type"`
	XColumn      *string              `json:"xColumn,omitempty"`
	XTickStart   *float32             `json:"xTickStart,omitempty"`
	XTickStep    *float32             `json:"xTickStep,omitempty"`
	XTotalTicks  *int                 `json:"xTotalTicks,omitempty"`
	YColumn      *string              `json:"yColumn,omitempty"`
	YTickStart   *float32             `json:"yTickStart,omitempty"`
	YTickStep    *float32             `json:"yTickStep,omitempty"`
	YTotalTicks  *int                 `json:"yTotalTicks,omitempty"`
}

XYViewProperties defines model for XYViewProperties.

type XYViewPropertiesHoverDimension 

type XYViewPropertiesHoverDimension string

XYViewPropertiesHoverDimension defines model for XYViewProperties.HoverDimension. 

const (
	XYViewPropertiesHoverDimensionAuto XYViewPropertiesHoverDimension = "auto"

	XYViewPropertiesHoverDimensionX XYViewPropertiesHoverDimension = "x"

	XYViewPropertiesHoverDimensionXy XYViewPropertiesHoverDimension = "xy"

	XYViewPropertiesHoverDimensionY XYViewPropertiesHoverDimension = "y"
)

Defines values for XYViewPropertiesHoverDimension.

type XYViewPropertiesPosition 

type XYViewPropertiesPosition string

XYViewPropertiesPosition defines model for XYViewProperties.Position. 

const (
	XYViewPropertiesPositionOverlaid XYViewPropertiesPosition = "overlaid"

	XYViewPropertiesPositionStacked XYViewPropertiesPosition = "stacked"
)

Defines values for XYViewPropertiesPosition.

type XYViewPropertiesShape 

type XYViewPropertiesShape string

XYViewPropertiesShape defines model for XYViewProperties.Shape. 

const (
	XYViewPropertiesShapeChronografV2 XYViewPropertiesShape = "chronograf-v2"
)

Defines values for XYViewPropertiesShape.

type XYViewPropertiesType 

type XYViewPropertiesType string

XYViewPropertiesType defines model for XYViewProperties.Type. 

const (
	XYViewPropertiesTypeXy XYViewPropertiesType = "xy"
)

Defines values for XYViewPropertiesType.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.