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) GetSourceFilterList(params *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
- type CreateSourceFilterResponse
- type GetSourceFilterDefaultSettingsParams
- type GetSourceFilterDefaultSettingsResponse
- type GetSourceFilterListParams
- type GetSourceFilterListResponse
- type GetSourceFilterParams
- type GetSourceFilterResponse
- type RemoveSourceFilterParams
- type RemoveSourceFilterResponse
- type SetSourceFilterEnabledParams
- type SetSourceFilterEnabledResponse
- type SetSourceFilterIndexParams
- type SetSourceFilterIndexResponse
- type SetSourceFilterNameParams
- type SetSourceFilterNameResponse
- type SetSourceFilterSettingsParams
- type SetSourceFilterSettingsResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
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) GetSourceFilterList ¶
func (c *Client) GetSourceFilterList(params *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]interface{} `json:"filterSettings,omitempty"`
// Name of the source to add the filter to
SourceName string `json:"sourceName,omitempty"`
}
Represents the request body for the CreateSourceFilter request.
func (*CreateSourceFilterParams) GetRequestName ¶
func (o *CreateSourceFilterParams) GetRequestName() string
Returns the associated request.
type CreateSourceFilterResponse ¶
type CreateSourceFilterResponse struct{}
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 (*GetSourceFilterDefaultSettingsParams) GetRequestName ¶
func (o *GetSourceFilterDefaultSettingsParams) GetRequestName() string
Returns the associated request.
type GetSourceFilterDefaultSettingsResponse ¶
type GetSourceFilterDefaultSettingsResponse struct {
// Object of default settings for the filter kind
DefaultFilterSettings map[string]interface{} `json:"defaultFilterSettings,omitempty"`
}
Represents the response body for the GetSourceFilterDefaultSettings request.
type GetSourceFilterListParams ¶
type GetSourceFilterListParams struct {
// Name of the source
SourceName string `json:"sourceName,omitempty"`
}
Represents the request body for the GetSourceFilterList request.
func (*GetSourceFilterListParams) GetRequestName ¶
func (o *GetSourceFilterListParams) GetRequestName() string
Returns the associated request.
type GetSourceFilterListResponse ¶
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"`
}
Represents the request body for the GetSourceFilter request.
func (*GetSourceFilterParams) GetRequestName ¶
func (o *GetSourceFilterParams) GetRequestName() string
Returns the associated request.
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 float64 `json:"filterIndex,omitempty"`
// The kind of filter
FilterKind string `json:"filterKind,omitempty"`
// Settings object associated with the filter
FilterSettings map[string]interface{} `json:"filterSettings,omitempty"`
}
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"`
}
Represents the request body for the RemoveSourceFilter request.
func (*RemoveSourceFilterParams) GetRequestName ¶
func (o *RemoveSourceFilterParams) GetRequestName() string
Returns the associated request.
type RemoveSourceFilterResponse ¶
type RemoveSourceFilterResponse struct{}
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"`
}
Represents the request body for the SetSourceFilterEnabled request.
func (*SetSourceFilterEnabledParams) GetRequestName ¶
func (o *SetSourceFilterEnabledParams) GetRequestName() string
Returns the associated request.
type SetSourceFilterEnabledResponse ¶
type SetSourceFilterEnabledResponse struct{}
Represents the response body for the SetSourceFilterEnabled request.
type SetSourceFilterIndexParams ¶
type SetSourceFilterIndexParams struct {
// New index position of the filter
FilterIndex float64 `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"`
}
Represents the request body for the SetSourceFilterIndex request.
func (*SetSourceFilterIndexParams) GetRequestName ¶
func (o *SetSourceFilterIndexParams) GetRequestName() string
Returns the associated request.
type SetSourceFilterIndexResponse ¶
type SetSourceFilterIndexResponse struct{}
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"`
}
Represents the request body for the SetSourceFilterName request.
func (*SetSourceFilterNameParams) GetRequestName ¶
func (o *SetSourceFilterNameParams) GetRequestName() string
Returns the associated request.
type SetSourceFilterNameResponse ¶
type SetSourceFilterNameResponse struct{}
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]interface{} `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"`
}
Represents the request body for the SetSourceFilterSettings request.
func (*SetSourceFilterSettingsParams) GetRequestName ¶
func (o *SetSourceFilterSettingsParams) GetRequestName() string
Returns the associated request.
type SetSourceFilterSettingsResponse ¶
type SetSourceFilterSettingsResponse struct{}
Represents the response body for the SetSourceFilterSettings request.
Source Files
¶
- xx_generated.createsourcefilter.go
- xx_generated.getsourcefilter.go
- xx_generated.getsourcefilterdefaultsettings.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