Documentation
¶
Index ¶
- type Client
- func (c *Client) CreateSourceFilter(params *CreateSourceFilterParams) (*CreateSourceFilterResponse, error)
- func (c *Client) GetSourceFilter(params *GetSourceFilterParams) (*GetSourceFilterResponse, error)
- func (c *Client) GetSourceFilterDefaultSettings(params *GetSourceFilterDefaultSettingsParams) (*GetSourceFilterDefaultSettingsResponse, error)
- func (c *Client) GetSourceFilterKindList(paramss ...*GetSourceFilterKindListParams) (*GetSourceFilterKindListResponse, error)
- func (c *Client) GetSourceFilterList(paramss ...*GetSourceFilterListParams) (*GetSourceFilterListResponse, error)
- func (c *Client) RemoveSourceFilter(params *RemoveSourceFilterParams) (*RemoveSourceFilterResponse, error)
- func (c *Client) SetSourceFilterEnabled(params *SetSourceFilterEnabledParams) (*SetSourceFilterEnabledResponse, error)
- func (c *Client) SetSourceFilterIndex(params *SetSourceFilterIndexParams) (*SetSourceFilterIndexResponse, error)
- func (c *Client) SetSourceFilterName(params *SetSourceFilterNameParams) (*SetSourceFilterNameResponse, error)
- func (c *Client) SetSourceFilterSettings(params *SetSourceFilterSettingsParams) (*SetSourceFilterSettingsResponse, error)
- type CreateSourceFilterParams
- func (o *CreateSourceFilterParams) GetRequestName() string
- func (o *CreateSourceFilterParams) WithFilterKind(x string) *CreateSourceFilterParams
- func (o *CreateSourceFilterParams) WithFilterName(x string) *CreateSourceFilterParams
- func (o *CreateSourceFilterParams) WithFilterSettings(x map[string]any) *CreateSourceFilterParams
- func (o *CreateSourceFilterParams) WithSourceName(x string) *CreateSourceFilterParams
- func (o *CreateSourceFilterParams) WithSourceUuid(x string) *CreateSourceFilterParams
- type CreateSourceFilterResponse
- type GetSourceFilterDefaultSettingsParams
- type GetSourceFilterDefaultSettingsResponse
- type GetSourceFilterKindListParams
- type GetSourceFilterKindListResponse
- type GetSourceFilterListParams
- type GetSourceFilterListResponse
- type GetSourceFilterParams
- type GetSourceFilterResponse
- type RemoveSourceFilterParams
- func (o *RemoveSourceFilterParams) GetRequestName() string
- func (o *RemoveSourceFilterParams) WithFilterName(x string) *RemoveSourceFilterParams
- func (o *RemoveSourceFilterParams) WithSourceName(x string) *RemoveSourceFilterParams
- func (o *RemoveSourceFilterParams) WithSourceUuid(x string) *RemoveSourceFilterParams
- type RemoveSourceFilterResponse
- type SetSourceFilterEnabledParams
- func (o *SetSourceFilterEnabledParams) GetRequestName() string
- func (o *SetSourceFilterEnabledParams) WithFilterEnabled(x bool) *SetSourceFilterEnabledParams
- func (o *SetSourceFilterEnabledParams) WithFilterName(x string) *SetSourceFilterEnabledParams
- func (o *SetSourceFilterEnabledParams) WithSourceName(x string) *SetSourceFilterEnabledParams
- func (o *SetSourceFilterEnabledParams) WithSourceUuid(x string) *SetSourceFilterEnabledParams
- type SetSourceFilterEnabledResponse
- type SetSourceFilterIndexParams
- func (o *SetSourceFilterIndexParams) GetRequestName() string
- func (o *SetSourceFilterIndexParams) WithFilterIndex(x int) *SetSourceFilterIndexParams
- func (o *SetSourceFilterIndexParams) WithFilterName(x string) *SetSourceFilterIndexParams
- func (o *SetSourceFilterIndexParams) WithSourceName(x string) *SetSourceFilterIndexParams
- func (o *SetSourceFilterIndexParams) WithSourceUuid(x string) *SetSourceFilterIndexParams
- type SetSourceFilterIndexResponse
- type SetSourceFilterNameParams
- func (o *SetSourceFilterNameParams) GetRequestName() string
- func (o *SetSourceFilterNameParams) WithFilterName(x string) *SetSourceFilterNameParams
- func (o *SetSourceFilterNameParams) WithNewFilterName(x string) *SetSourceFilterNameParams
- func (o *SetSourceFilterNameParams) WithSourceName(x string) *SetSourceFilterNameParams
- func (o *SetSourceFilterNameParams) WithSourceUuid(x string) *SetSourceFilterNameParams
- type SetSourceFilterNameResponse
- type SetSourceFilterSettingsParams
- func (o *SetSourceFilterSettingsParams) GetRequestName() string
- func (o *SetSourceFilterSettingsParams) WithFilterName(x string) *SetSourceFilterSettingsParams
- func (o *SetSourceFilterSettingsParams) WithFilterSettings(x map[string]any) *SetSourceFilterSettingsParams
- func (o *SetSourceFilterSettingsParams) WithOverlay(x bool) *SetSourceFilterSettingsParams
- func (o *SetSourceFilterSettingsParams) WithSourceName(x string) *SetSourceFilterSettingsParams
- func (o *SetSourceFilterSettingsParams) WithSourceUuid(x string) *SetSourceFilterSettingsParams
- type SetSourceFilterSettingsResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client represents a client for 'filters' requests.
func (*Client) CreateSourceFilter ¶
func (c *Client) CreateSourceFilter(params *CreateSourceFilterParams) (*CreateSourceFilterResponse, error)
Creates a new filter, adding it to the specified source.
func (*Client) GetSourceFilter ¶
func (c *Client) GetSourceFilter(params *GetSourceFilterParams) (*GetSourceFilterResponse, error)
Gets the info for a specific source filter.
func (*Client) GetSourceFilterDefaultSettings ¶
func (c *Client) GetSourceFilterDefaultSettings( params *GetSourceFilterDefaultSettingsParams, ) (*GetSourceFilterDefaultSettingsResponse, error)
Gets the default settings for a filter kind.
func (*Client) GetSourceFilterKindList ¶
func (c *Client) GetSourceFilterKindList( paramss ...*GetSourceFilterKindListParams, ) (*GetSourceFilterKindListResponse, error)
Gets an array of all available source filter kinds.
Similar to `GetInputKindList`
func (*Client) GetSourceFilterList ¶
func (c *Client) GetSourceFilterList(paramss ...*GetSourceFilterListParams) (*GetSourceFilterListResponse, error)
Gets an array of all of a source's filters.
func (*Client) RemoveSourceFilter ¶
func (c *Client) RemoveSourceFilter(params *RemoveSourceFilterParams) (*RemoveSourceFilterResponse, error)
Removes a filter from a source.
func (*Client) SetSourceFilterEnabled ¶
func (c *Client) SetSourceFilterEnabled(params *SetSourceFilterEnabledParams) (*SetSourceFilterEnabledResponse, error)
Sets the enable state of a source filter.
func (*Client) SetSourceFilterIndex ¶
func (c *Client) SetSourceFilterIndex(params *SetSourceFilterIndexParams) (*SetSourceFilterIndexResponse, error)
Sets the index position of a filter on a source.
func (*Client) SetSourceFilterName ¶
func (c *Client) SetSourceFilterName(params *SetSourceFilterNameParams) (*SetSourceFilterNameResponse, error)
Sets the name of a source filter (rename).
func (*Client) SetSourceFilterSettings ¶
func (c *Client) SetSourceFilterSettings( params *SetSourceFilterSettingsParams, ) (*SetSourceFilterSettingsResponse, error)
Sets the settings of a source filter.
type CreateSourceFilterParams ¶
type CreateSourceFilterParams struct {
// The kind of filter to be created
FilterKind *string `json:"filterKind,omitempty"`
// Name of the new filter to be created
FilterName *string `json:"filterName,omitempty"`
// Settings object to initialize the filter with
FilterSettings map[string]any `json:"filterSettings,omitempty"`
// Name of the source to add the filter to
SourceName *string `json:"sourceName,omitempty"`
// UUID of the source to add the filter to
SourceUuid *string `json:"sourceUuid,omitempty"`
}
Represents the request body for the CreateSourceFilter request.
func NewCreateSourceFilterParams ¶
func NewCreateSourceFilterParams() *CreateSourceFilterParams
func (*CreateSourceFilterParams) GetRequestName ¶
func (o *CreateSourceFilterParams) GetRequestName() string
Returns the associated request.
func (*CreateSourceFilterParams) WithFilterKind ¶
func (o *CreateSourceFilterParams) WithFilterKind(x string) *CreateSourceFilterParams
func (*CreateSourceFilterParams) WithFilterName ¶
func (o *CreateSourceFilterParams) WithFilterName(x string) *CreateSourceFilterParams
func (*CreateSourceFilterParams) WithFilterSettings ¶
func (o *CreateSourceFilterParams) WithFilterSettings(x map[string]any) *CreateSourceFilterParams
func (*CreateSourceFilterParams) WithSourceName ¶
func (o *CreateSourceFilterParams) WithSourceName(x string) *CreateSourceFilterParams
func (*CreateSourceFilterParams) WithSourceUuid ¶
func (o *CreateSourceFilterParams) WithSourceUuid(x string) *CreateSourceFilterParams
type CreateSourceFilterResponse ¶
type CreateSourceFilterResponse struct {
// contains filtered or unexported fields
}
Represents the response body for the CreateSourceFilter request.
type GetSourceFilterDefaultSettingsParams ¶
type GetSourceFilterDefaultSettingsParams struct {
// Filter kind to get the default settings for
FilterKind *string `json:"filterKind,omitempty"`
}
Represents the request body for the GetSourceFilterDefaultSettings request.
func NewGetSourceFilterDefaultSettingsParams ¶
func NewGetSourceFilterDefaultSettingsParams() *GetSourceFilterDefaultSettingsParams
func (*GetSourceFilterDefaultSettingsParams) GetRequestName ¶
func (o *GetSourceFilterDefaultSettingsParams) GetRequestName() string
Returns the associated request.
func (*GetSourceFilterDefaultSettingsParams) WithFilterKind ¶
func (o *GetSourceFilterDefaultSettingsParams) WithFilterKind(x string) *GetSourceFilterDefaultSettingsParams
type GetSourceFilterDefaultSettingsResponse ¶
type GetSourceFilterDefaultSettingsResponse struct {
// Object of default settings for the filter kind
DefaultFilterSettings map[string]any `json:"defaultFilterSettings,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the GetSourceFilterDefaultSettings request.
type GetSourceFilterKindListParams ¶
type GetSourceFilterKindListParams struct{}
Represents the request body for the GetSourceFilterKindList request.
func (*GetSourceFilterKindListParams) GetRequestName ¶
func (o *GetSourceFilterKindListParams) GetRequestName() string
Returns the associated request.
type GetSourceFilterKindListResponse ¶
type GetSourceFilterKindListResponse struct {
// Array of source filter kinds
SourceFilterKinds []string `json:"sourceFilterKinds,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the GetSourceFilterKindList request.
type GetSourceFilterListParams ¶
type GetSourceFilterListParams struct {
// Name of the source
SourceName *string `json:"sourceName,omitempty"`
// UUID of the source
SourceUuid *string `json:"sourceUuid,omitempty"`
}
Represents the request body for the GetSourceFilterList request.
func NewGetSourceFilterListParams ¶
func NewGetSourceFilterListParams() *GetSourceFilterListParams
func (*GetSourceFilterListParams) GetRequestName ¶
func (o *GetSourceFilterListParams) GetRequestName() string
Returns the associated request.
func (*GetSourceFilterListParams) WithSourceName ¶
func (o *GetSourceFilterListParams) WithSourceName(x string) *GetSourceFilterListParams
func (*GetSourceFilterListParams) WithSourceUuid ¶
func (o *GetSourceFilterListParams) WithSourceUuid(x string) *GetSourceFilterListParams
type GetSourceFilterListResponse ¶
type GetSourceFilterListResponse struct {
// Array of filters
Filters []*typedefs.Filter `json:"filters,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the GetSourceFilterList request.
type GetSourceFilterParams ¶
type GetSourceFilterParams struct {
// Name of the filter
FilterName *string `json:"filterName,omitempty"`
// Name of the source
SourceName *string `json:"sourceName,omitempty"`
// UUID of the source
SourceUuid *string `json:"sourceUuid,omitempty"`
}
Represents the request body for the GetSourceFilter request.
func NewGetSourceFilterParams ¶
func NewGetSourceFilterParams() *GetSourceFilterParams
func (*GetSourceFilterParams) GetRequestName ¶
func (o *GetSourceFilterParams) GetRequestName() string
Returns the associated request.
func (*GetSourceFilterParams) WithFilterName ¶
func (o *GetSourceFilterParams) WithFilterName(x string) *GetSourceFilterParams
func (*GetSourceFilterParams) WithSourceName ¶
func (o *GetSourceFilterParams) WithSourceName(x string) *GetSourceFilterParams
func (*GetSourceFilterParams) WithSourceUuid ¶
func (o *GetSourceFilterParams) WithSourceUuid(x string) *GetSourceFilterParams
type GetSourceFilterResponse ¶
type GetSourceFilterResponse struct {
// Whether the filter is enabled
FilterEnabled bool `json:"filterEnabled,omitempty"`
// Index of the filter in the list, beginning at 0
FilterIndex int `json:"filterIndex,omitempty"`
// The kind of filter
FilterKind string `json:"filterKind,omitempty"`
// Settings object associated with the filter
FilterSettings map[string]any `json:"filterSettings,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the GetSourceFilter request.
type RemoveSourceFilterParams ¶
type RemoveSourceFilterParams struct {
// Name of the filter to remove
FilterName *string `json:"filterName,omitempty"`
// Name of the source the filter is on
SourceName *string `json:"sourceName,omitempty"`
// UUID of the source the filter is on
SourceUuid *string `json:"sourceUuid,omitempty"`
}
Represents the request body for the RemoveSourceFilter request.
func NewRemoveSourceFilterParams ¶
func NewRemoveSourceFilterParams() *RemoveSourceFilterParams
func (*RemoveSourceFilterParams) GetRequestName ¶
func (o *RemoveSourceFilterParams) GetRequestName() string
Returns the associated request.
func (*RemoveSourceFilterParams) WithFilterName ¶
func (o *RemoveSourceFilterParams) WithFilterName(x string) *RemoveSourceFilterParams
func (*RemoveSourceFilterParams) WithSourceName ¶
func (o *RemoveSourceFilterParams) WithSourceName(x string) *RemoveSourceFilterParams
func (*RemoveSourceFilterParams) WithSourceUuid ¶
func (o *RemoveSourceFilterParams) WithSourceUuid(x string) *RemoveSourceFilterParams
type RemoveSourceFilterResponse ¶
type RemoveSourceFilterResponse struct {
// contains filtered or unexported fields
}
Represents the response body for the RemoveSourceFilter request.
type SetSourceFilterEnabledParams ¶
type SetSourceFilterEnabledParams struct {
// New enable state of the filter
FilterEnabled *bool `json:"filterEnabled,omitempty"`
// Name of the filter
FilterName *string `json:"filterName,omitempty"`
// Name of the source the filter is on
SourceName *string `json:"sourceName,omitempty"`
// UUID of the source the filter is on
SourceUuid *string `json:"sourceUuid,omitempty"`
}
Represents the request body for the SetSourceFilterEnabled request.
func NewSetSourceFilterEnabledParams ¶
func NewSetSourceFilterEnabledParams() *SetSourceFilterEnabledParams
func (*SetSourceFilterEnabledParams) GetRequestName ¶
func (o *SetSourceFilterEnabledParams) GetRequestName() string
Returns the associated request.
func (*SetSourceFilterEnabledParams) WithFilterEnabled ¶
func (o *SetSourceFilterEnabledParams) WithFilterEnabled(x bool) *SetSourceFilterEnabledParams
func (*SetSourceFilterEnabledParams) WithFilterName ¶
func (o *SetSourceFilterEnabledParams) WithFilterName(x string) *SetSourceFilterEnabledParams
func (*SetSourceFilterEnabledParams) WithSourceName ¶
func (o *SetSourceFilterEnabledParams) WithSourceName(x string) *SetSourceFilterEnabledParams
func (*SetSourceFilterEnabledParams) WithSourceUuid ¶
func (o *SetSourceFilterEnabledParams) WithSourceUuid(x string) *SetSourceFilterEnabledParams
type SetSourceFilterEnabledResponse ¶
type SetSourceFilterEnabledResponse struct {
// contains filtered or unexported fields
}
Represents the response body for the SetSourceFilterEnabled request.
type SetSourceFilterIndexParams ¶
type SetSourceFilterIndexParams struct {
// New index position of the filter
FilterIndex *int `json:"filterIndex,omitempty"`
// Name of the filter
FilterName *string `json:"filterName,omitempty"`
// Name of the source the filter is on
SourceName *string `json:"sourceName,omitempty"`
// UUID of the source the filter is on
SourceUuid *string `json:"sourceUuid,omitempty"`
}
Represents the request body for the SetSourceFilterIndex request.
func NewSetSourceFilterIndexParams ¶
func NewSetSourceFilterIndexParams() *SetSourceFilterIndexParams
func (*SetSourceFilterIndexParams) GetRequestName ¶
func (o *SetSourceFilterIndexParams) GetRequestName() string
Returns the associated request.
func (*SetSourceFilterIndexParams) WithFilterIndex ¶
func (o *SetSourceFilterIndexParams) WithFilterIndex(x int) *SetSourceFilterIndexParams
func (*SetSourceFilterIndexParams) WithFilterName ¶
func (o *SetSourceFilterIndexParams) WithFilterName(x string) *SetSourceFilterIndexParams
func (*SetSourceFilterIndexParams) WithSourceName ¶
func (o *SetSourceFilterIndexParams) WithSourceName(x string) *SetSourceFilterIndexParams
func (*SetSourceFilterIndexParams) WithSourceUuid ¶
func (o *SetSourceFilterIndexParams) WithSourceUuid(x string) *SetSourceFilterIndexParams
type SetSourceFilterIndexResponse ¶
type SetSourceFilterIndexResponse struct {
// contains filtered or unexported fields
}
Represents the response body for the SetSourceFilterIndex request.
type SetSourceFilterNameParams ¶
type SetSourceFilterNameParams struct {
// Current name of the filter
FilterName *string `json:"filterName,omitempty"`
// New name for the filter
NewFilterName *string `json:"newFilterName,omitempty"`
// Name of the source the filter is on
SourceName *string `json:"sourceName,omitempty"`
// UUID of the source the filter is on
SourceUuid *string `json:"sourceUuid,omitempty"`
}
Represents the request body for the SetSourceFilterName request.
func NewSetSourceFilterNameParams ¶
func NewSetSourceFilterNameParams() *SetSourceFilterNameParams
func (*SetSourceFilterNameParams) GetRequestName ¶
func (o *SetSourceFilterNameParams) GetRequestName() string
Returns the associated request.
func (*SetSourceFilterNameParams) WithFilterName ¶
func (o *SetSourceFilterNameParams) WithFilterName(x string) *SetSourceFilterNameParams
func (*SetSourceFilterNameParams) WithNewFilterName ¶
func (o *SetSourceFilterNameParams) WithNewFilterName(x string) *SetSourceFilterNameParams
func (*SetSourceFilterNameParams) WithSourceName ¶
func (o *SetSourceFilterNameParams) WithSourceName(x string) *SetSourceFilterNameParams
func (*SetSourceFilterNameParams) WithSourceUuid ¶
func (o *SetSourceFilterNameParams) WithSourceUuid(x string) *SetSourceFilterNameParams
type SetSourceFilterNameResponse ¶
type SetSourceFilterNameResponse struct {
// contains filtered or unexported fields
}
Represents the response body for the SetSourceFilterName request.
type SetSourceFilterSettingsParams ¶
type SetSourceFilterSettingsParams struct {
// Name of the filter to set the settings of
FilterName *string `json:"filterName,omitempty"`
// Object of settings to apply
FilterSettings map[string]any `json:"filterSettings,omitempty"`
// True == apply the settings on top of existing ones, False == reset the input to its defaults, then apply
// settings.
Overlay *bool `json:"overlay,omitempty"`
// Name of the source the filter is on
SourceName *string `json:"sourceName,omitempty"`
// UUID of the source the filter is on
SourceUuid *string `json:"sourceUuid,omitempty"`
}
Represents the request body for the SetSourceFilterSettings request.
func NewSetSourceFilterSettingsParams ¶
func NewSetSourceFilterSettingsParams() *SetSourceFilterSettingsParams
func (*SetSourceFilterSettingsParams) GetRequestName ¶
func (o *SetSourceFilterSettingsParams) GetRequestName() string
Returns the associated request.
func (*SetSourceFilterSettingsParams) WithFilterName ¶
func (o *SetSourceFilterSettingsParams) WithFilterName(x string) *SetSourceFilterSettingsParams
func (*SetSourceFilterSettingsParams) WithFilterSettings ¶
func (o *SetSourceFilterSettingsParams) WithFilterSettings(x map[string]any) *SetSourceFilterSettingsParams
func (*SetSourceFilterSettingsParams) WithOverlay ¶
func (o *SetSourceFilterSettingsParams) WithOverlay(x bool) *SetSourceFilterSettingsParams
func (*SetSourceFilterSettingsParams) WithSourceName ¶
func (o *SetSourceFilterSettingsParams) WithSourceName(x string) *SetSourceFilterSettingsParams
func (*SetSourceFilterSettingsParams) WithSourceUuid ¶
func (o *SetSourceFilterSettingsParams) WithSourceUuid(x string) *SetSourceFilterSettingsParams
type SetSourceFilterSettingsResponse ¶
type SetSourceFilterSettingsResponse struct {
// contains filtered or unexported fields
}
Represents the response body for the SetSourceFilterSettings request.
Source Files
¶
- xx_generated.createsourcefilter.go
- xx_generated.getsourcefilter.go
- xx_generated.getsourcefilterdefaultsettings.go
- xx_generated.getsourcefilterkindlist.go
- xx_generated.getsourcefilterlist.go
- xx_generated.removesourcefilter.go
- xx_generated.setsourcefilterenabled.go
- xx_generated.setsourcefilterindex.go
- xx_generated.setsourcefiltername.go
- xx_generated.setsourcefiltersettings.go
- zz_generated.client.go