Documentation ¶
Index ¶
- Constants
- type Client
- func (c *Client) CreateAWSCloudWatchIntegration(ctx context.Context, acwi *integration.AwsCloudWatchIntegration) (*integration.AwsCloudWatchIntegration, error)
- func (c *Client) CreateAlertMutingRule(ctx context.Context, ...) (*alertmuting.AlertMutingRule, error)
- func (c *Client) CreateAzureIntegration(ctx context.Context, acwi *integration.AzureIntegration) (*integration.AzureIntegration, error)
- func (c *Client) CreateChart(ctx context.Context, chartRequest *chart.CreateUpdateChartRequest) (*chart.Chart, error)
- func (c *Client) CreateDashboard(ctx context.Context, dashboardRequest *dashboard.CreateUpdateDashboardRequest) (*dashboard.Dashboard, error)
- func (c *Client) CreateDashboardGroup(ctx context.Context, ...) (*dashboard_group.DashboardGroup, error)
- func (c *Client) CreateDataLink(ctx context.Context, dataLinkRequest *datalink.CreateUpdateDataLinkRequest) (*datalink.DataLink, error)
- func (c *Client) CreateDetector(ctx context.Context, detectorRequest *detector.CreateUpdateDetectorRequest) (*detector.Detector, error)
- func (c *Client) CreateGCPIntegration(ctx context.Context, gcpi *integration.GCPIntegration) (*integration.GCPIntegration, error)
- func (c *Client) CreateJiraIntegration(ctx context.Context, ji *integration.JiraIntegration) (*integration.JiraIntegration, error)
- func (c *Client) CreateOpsgenieIntegration(ctx context.Context, oi *integration.OpsgenieIntegration) (*integration.OpsgenieIntegration, error)
- func (c *Client) CreateOrgToken(ctx context.Context, tokenRequest *orgtoken.CreateUpdateTokenRequest) (*orgtoken.Token, error)
- func (c *Client) CreatePagerDutyIntegration(ctx context.Context, pdi *integration.PagerDutyIntegration) (*integration.PagerDutyIntegration, error)
- func (c *Client) CreateSessionToken(ctx context.Context, tokenRequest *sessiontoken.CreateTokenRequest) (*sessiontoken.Token, error)
- func (c *Client) CreateSlackIntegration(ctx context.Context, si *integration.SlackIntegration) (*integration.SlackIntegration, error)
- func (c *Client) CreateTeam(ctx context.Context, t *team.CreateUpdateTeamRequest) (*team.Team, error)
- func (c *Client) CreateUpdateTag(ctx context.Context, name string, ...) (*metrics_metadata.Tag, error)
- func (c *Client) CreateVictorOpsIntegration(ctx context.Context, oi *integration.VictorOpsIntegration) (*integration.VictorOpsIntegration, error)
- func (c *Client) CreateWebhookIntegration(ctx context.Context, oi *integration.WebhookIntegration) (*integration.WebhookIntegration, error)
- func (c *Client) DeleteAWSCloudWatchIntegration(ctx context.Context, id string) error
- func (c *Client) DeleteAlertMutingRule(ctx context.Context, name string) error
- func (c *Client) DeleteAzureIntegration(ctx context.Context, id string) error
- func (c *Client) DeleteChart(ctx context.Context, id string) error
- func (c *Client) DeleteDashboard(ctx context.Context, id string) error
- func (c *Client) DeleteDashboardGroup(ctx context.Context, id string) error
- func (c *Client) DeleteDataLink(ctx context.Context, id string) error
- func (c *Client) DeleteDetector(ctx context.Context, id string) error
- func (c *Client) DeleteGCPIntegration(ctx context.Context, id string) error
- func (c *Client) DeleteIntegration(ctx context.Context, id string) error
- func (c *Client) DeleteJiraIntegration(ctx context.Context, id string) error
- func (c *Client) DeleteMember(ctx context.Context, id string) error
- func (c *Client) DeleteOpsgenieIntegration(ctx context.Context, id string) error
- func (c *Client) DeleteOrgToken(ctx context.Context, name string) error
- func (c *Client) DeletePagerDutyIntegration(ctx context.Context, id string) error
- func (c *Client) DeleteSessionToken(ctx context.Context, token string) error
- func (c *Client) DeleteSlackIntegration(ctx context.Context, id string) error
- func (c *Client) DeleteTag(ctx context.Context, id string) error
- func (c *Client) DeleteTeam(ctx context.Context, id string) error
- func (c *Client) DeleteVictorOpsIntegration(ctx context.Context, id string) error
- func (c *Client) DeleteWebhookIntegration(ctx context.Context, id string) error
- func (c *Client) DisableDetector(ctx context.Context, id string, labels []string) error
- func (c *Client) EnableDetector(ctx context.Context, id string, labels []string) error
- func (c *Client) GetAWSCloudWatchIntegration(ctx context.Context, id string) (*integration.AwsCloudWatchIntegration, error)
- func (c *Client) GetAlertMutingRule(ctx context.Context, id string) (*alertmuting.AlertMutingRule, error)
- func (c *Client) GetAzureIntegration(ctx context.Context, id string) (*integration.AzureIntegration, error)
- func (c *Client) GetChart(ctx context.Context, id string) (*chart.Chart, error)
- func (c *Client) GetDashboard(ctx context.Context, id string) (*dashboard.Dashboard, error)
- func (c *Client) GetDashboardGroup(ctx context.Context, id string) (*dashboard_group.DashboardGroup, error)
- func (c *Client) GetDataLink(ctx context.Context, id string) (*datalink.DataLink, error)
- func (c *Client) GetDetector(ctx context.Context, id string) (*detector.Detector, error)
- func (c *Client) GetDetectorEvents(ctx context.Context, id string, from int, to int, offset int, limit int) ([]*detector.Event, error)
- func (c *Client) GetDetectorIncidents(ctx context.Context, id string, offset int, limit int) ([]*detector.Incident, error)
- func (c *Client) GetDimension(ctx context.Context, key string, value string) (*metrics_metadata.Dimension, error)
- func (c *Client) GetGCPIntegration(ctx context.Context, id string) (*integration.GCPIntegration, error)
- func (c *Client) GetIntegration(ctx context.Context, id string) (map[string]interface{}, error)
- func (c *Client) GetJiraIntegration(ctx context.Context, id string) (*integration.JiraIntegration, error)
- func (c *Client) GetMember(ctx context.Context, id string) (*organization.Member, error)
- func (c *Client) GetMetric(ctx context.Context, name string) (*metrics_metadata.Metric, error)
- func (c *Client) GetMetricTimeSeries(ctx context.Context, id string) (*metrics_metadata.MetricTimeSeries, error)
- func (c *Client) GetOpsgenieIntegration(ctx context.Context, id string) (*integration.OpsgenieIntegration, error)
- func (c *Client) GetOrgToken(ctx context.Context, id string) (*orgtoken.Token, error)
- func (c *Client) GetOrganization(ctx context.Context, id string) (*organization.Organization, error)
- func (c *Client) GetOrganizationMembers(ctx context.Context, limit int, query string, offset int, orderBy string) (*organization.MemberSearchResults, error)
- func (c *Client) GetPagerDutyIntegration(ctx context.Context, id string) (*integration.PagerDutyIntegration, error)
- func (c *Client) GetPagerDutyIntegrationByName(ctx context.Context, name string) (*integration.PagerDutyIntegration, error)
- func (c *Client) GetSlackIntegration(ctx context.Context, id string) (*integration.SlackIntegration, error)
- func (c *Client) GetTag(ctx context.Context, name string) (*metrics_metadata.Tag, error)
- func (c *Client) GetTeam(ctx context.Context, id string) (*team.Team, error)
- func (c *Client) GetVictorOpsIntegration(ctx context.Context, id string) (*integration.VictorOpsIntegration, error)
- func (c *Client) GetWebhookIntegration(ctx context.Context, id string) (*integration.WebhookIntegration, error)
- func (c *Client) InviteMember(ctx context.Context, inviteRequest *organization.CreateUpdateMemberRequest) (*organization.Member, error)
- func (c *Client) InviteMembers(ctx context.Context, inviteRequest *organization.InviteMembersRequest) (*organization.InviteMembersRequest, error)
- func (c *Client) LinkDashboardGroupToTeam(ctx context.Context, id string, dashboardGroupID string) error
- func (c *Client) LinkDetectorToTeam(ctx context.Context, id string, detectorID string) error
- func (c *Client) SearchAlertMutingRules(ctx context.Context, include string, limit int, query string, offset int) (*alertmuting.SearchResult, error)
- func (c *Client) SearchCharts(ctx context.Context, limit int, name string, offset int, tags string) (*chart.SearchResult, error)
- func (c *Client) SearchDashboard(ctx context.Context, limit int, name string, offset int, tags string) (*dashboard.SearchResult, error)
- func (c *Client) SearchDashboardGroups(ctx context.Context, limit int, name string, offset int) (*dashboard_group.SearchResult, error)
- func (c *Client) SearchDataLinks(ctx context.Context, limit int, context string, offset int) (*datalink.SearchResults, error)
- func (c *Client) SearchDetectors(ctx context.Context, limit int, name string, offset int, tags string) (*detector.SearchResults, error)
- func (c *Client) SearchDimension(ctx context.Context, query string, orderBy string, limit int, offset int) (*metrics_metadata.DimensionQueryResponseModel, error)
- func (c *Client) SearchMetric(ctx context.Context, query string, orderBy string, limit int, offset int) (*metrics_metadata.RetrieveMetricMetadataResponseModel, error)
- func (c *Client) SearchMetricTimeSeries(ctx context.Context, query string, orderBy string, limit int, offset int) (*metrics_metadata.MetricTimeSeriesRetrieveResponseModel, error)
- func (c *Client) SearchOrgTokens(ctx context.Context, limit int, name string, offset int) (*orgtoken.SearchResults, error)
- func (c *Client) SearchTag(ctx context.Context, query string, orderBy string, limit int, offset int) (*metrics_metadata.TagRetrieveResponseModel, error)
- func (c *Client) SearchTeam(ctx context.Context, limit int, name string, offset int, tags string) (*team.SearchResults, error)
- func (c *Client) SignalFlow(options ...signalflow.ClientParam) (*signalflow.Client, error)
- func (c *Client) UnlinkDashboardGroupFromTeam(ctx context.Context, id string, dashboardGroupID string) error
- func (c *Client) UnlinkDetectorFromTeam(ctx context.Context, id string, detectorID string) error
- func (c *Client) UpdateAWSCloudWatchIntegration(ctx context.Context, id string, acwi *integration.AwsCloudWatchIntegration) (*integration.AwsCloudWatchIntegration, error)
- func (c *Client) UpdateAlertMutingRule(ctx context.Context, id string, ...) (*alertmuting.AlertMutingRule, error)
- func (c *Client) UpdateAzureIntegration(ctx context.Context, id string, acwi *integration.AzureIntegration) (*integration.AzureIntegration, error)
- func (c *Client) UpdateChart(ctx context.Context, id string, chartRequest *chart.CreateUpdateChartRequest) (*chart.Chart, error)
- func (c *Client) UpdateDashboard(ctx context.Context, id string, ...) (*dashboard.Dashboard, error)
- func (c *Client) UpdateDashboardGroup(ctx context.Context, id string, ...) (*dashboard_group.DashboardGroup, error)
- func (c *Client) UpdateDataLink(ctx context.Context, id string, ...) (*datalink.DataLink, error)
- func (c *Client) UpdateDetector(ctx context.Context, id string, ...) (*detector.Detector, error)
- func (c *Client) UpdateDimension(ctx context.Context, key string, value string, dim *metrics_metadata.Dimension) (*metrics_metadata.Dimension, error)
- func (c *Client) UpdateGCPIntegration(ctx context.Context, id string, gcpi *integration.GCPIntegration) (*integration.GCPIntegration, error)
- func (c *Client) UpdateJiraIntegration(ctx context.Context, id string, ji *integration.JiraIntegration) (*integration.JiraIntegration, error)
- func (c *Client) UpdateOpsgenieIntegration(ctx context.Context, id string, oi *integration.OpsgenieIntegration) (*integration.OpsgenieIntegration, error)
- func (c *Client) UpdateOrgToken(ctx context.Context, id string, ...) (*orgtoken.Token, error)
- func (c *Client) UpdatePagerDutyIntegration(ctx context.Context, id string, pdi *integration.PagerDutyIntegration) (*integration.PagerDutyIntegration, error)
- func (c *Client) UpdateSlackIntegration(ctx context.Context, id string, si *integration.SlackIntegration) (*integration.SlackIntegration, error)
- func (c *Client) UpdateTeam(ctx context.Context, id string, t *team.CreateUpdateTeamRequest) (*team.Team, error)
- func (c *Client) UpdateVictorOpsIntegration(ctx context.Context, id string, oi *integration.VictorOpsIntegration) (*integration.VictorOpsIntegration, error)
- func (c *Client) UpdateWebhookIntegration(ctx context.Context, id string, oi *integration.WebhookIntegration) (*integration.WebhookIntegration, error)
- type ClientParam
Constants ¶
const AlertMutingRuleAPIURL = "/v2/alertmuting"
AlertMutingRuleAPIURL is the base URL for interacting with alert muting rules.
const AuthHeaderKey = "X-Sf-Token"
AuthHeaderKey is the HTTP header used to pass along the auth token Note that while HTTP headers are case insensitive this header is case sensitive on the tests for convenience.
const ChartAPIURL = "/v2/chart"
ChartAPIURL is the base URL for interacting with charts.
const DashboardAPIURL = "/v2/dashboard"
DashboardAPIURL is the base URL for interacting with dashboard.
const DashboardGroupAPIURL = "/v2/dashboardgroup"
DashboardGroupAPIURL is the base URL for interacting with dashboard.
const DataLinkAPIURL = "/v2/crosslink"
DataLinkAPIURL is the base URL for interacting with data link.
const DefaultAPIURL = "https://api.signalfx.com"
DefaultAPIURL is the default URL for making API requests
const DetectorAPIURL = "/v2/detector"
DetectorAPIURL is the base URL for interacting with detectors.
const DimensionAPIURL = "/v2/dimension"
DimensionAPIURL is the base URL for interacting with dimensions.
const IntegrationAPIURL = "/v2/integration"
IntegrationAPIURL is the base URL for interacting with intergrations.
const MetricAPIURL = "/v2/metric"
MetricAPIURL is the base URL for interacting with dimensions.
const MetricTimeSeriesAPIURL = "/v2/metrictimeseries"
MetricTimeSeriesAPIURL is the base URL for interacting with dimensions.
const OrganizationAPIURL = "/v2/organization"
OrganizationAPIURL is the base URL for interacting with detectors.
const OrganizationMemberAPIURL = "/v2/organization/member"
const OrganizationMembersAPIURL = "/v2/organization/members"
const SessionTokenAPIURL = "/v2/session"
SessionTokenAPIURL is the base URL for interacting with org tokens.
const TagAPIURL = "/v2/tag"
TagAPIURL is the base URL for interacting with dimensions.
const TeamAPIURL = "/v2/team"
TeamAPIURL is the base URL for interacting with teams.
const TokenAPIURL = "/v2/token"
TokenAPIURL is the base URL for interacting with org tokens.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is a SignalFx API client.
func NewClient ¶
func NewClient(token string, options ...ClientParam) (*Client, error)
NewClient creates a new SignalFx client using the specified token.
func (*Client) CreateAWSCloudWatchIntegration ¶ added in v1.3.0
func (c *Client) CreateAWSCloudWatchIntegration(ctx context.Context, acwi *integration.AwsCloudWatchIntegration) (*integration.AwsCloudWatchIntegration, error)
CreateAWSCloudWatchIntegration creates an AWS CloudWatch integration.
func (*Client) CreateAlertMutingRule ¶ added in v1.6.8
func (c *Client) CreateAlertMutingRule(ctx context.Context, muteRequest *alertmuting.CreateUpdateAlertMutingRuleRequest) (*alertmuting.AlertMutingRule, error)
CreateAlertMutingRule creates an alert muting rule.
func (*Client) CreateAzureIntegration ¶ added in v1.4.0
func (c *Client) CreateAzureIntegration(ctx context.Context, acwi *integration.AzureIntegration) (*integration.AzureIntegration, error)
CreateAzureIntegration creates an Azure integration.
func (*Client) CreateChart ¶
func (c *Client) CreateChart(ctx context.Context, chartRequest *chart.CreateUpdateChartRequest) (*chart.Chart, error)
CreateChart creates a chart.
func (*Client) CreateDashboard ¶
func (c *Client) CreateDashboard(ctx context.Context, dashboardRequest *dashboard.CreateUpdateDashboardRequest) (*dashboard.Dashboard, error)
CreateDashboard creates a dashboard.
func (*Client) CreateDashboardGroup ¶
func (c *Client) CreateDashboardGroup(ctx context.Context, dashboardGroupRequest *dashboard_group.CreateUpdateDashboardGroupRequest, skipImplicitDashboard bool) (*dashboard_group.DashboardGroup, error)
CreateDashboardGroup creates a dashboard.
func (*Client) CreateDataLink ¶ added in v1.6.10
func (c *Client) CreateDataLink(ctx context.Context, dataLinkRequest *datalink.CreateUpdateDataLinkRequest) (*datalink.DataLink, error)
CreateDataLink creates a data link.
func (*Client) CreateDetector ¶
func (c *Client) CreateDetector(ctx context.Context, detectorRequest *detector.CreateUpdateDetectorRequest) (*detector.Detector, error)
CreateDetector creates a detector.
func (*Client) CreateGCPIntegration ¶ added in v1.6.0
func (c *Client) CreateGCPIntegration(ctx context.Context, gcpi *integration.GCPIntegration) (*integration.GCPIntegration, error)
CreateGCPIntegration creates a GCP integration.
func (*Client) CreateJiraIntegration ¶ added in v1.6.5
func (c *Client) CreateJiraIntegration(ctx context.Context, ji *integration.JiraIntegration) (*integration.JiraIntegration, error)
CreateJiraIntegration creates an Jira integration.
func (*Client) CreateOpsgenieIntegration ¶ added in v1.6.0
func (c *Client) CreateOpsgenieIntegration(ctx context.Context, oi *integration.OpsgenieIntegration) (*integration.OpsgenieIntegration, error)
CreateOpsgenieIntegration creates an Opsgenie integration.
func (*Client) CreateOrgToken ¶ added in v1.5.0
func (c *Client) CreateOrgToken(ctx context.Context, tokenRequest *orgtoken.CreateUpdateTokenRequest) (*orgtoken.Token, error)
CreateOrgToken creates a org token.
func (*Client) CreatePagerDutyIntegration ¶ added in v1.6.0
func (c *Client) CreatePagerDutyIntegration(ctx context.Context, pdi *integration.PagerDutyIntegration) (*integration.PagerDutyIntegration, error)
CreatePagerDutyIntegration creates a PagerDuty integration.
func (*Client) CreateSessionToken ¶ added in v1.6.11
func (c *Client) CreateSessionToken(ctx context.Context, tokenRequest *sessiontoken.CreateTokenRequest) (*sessiontoken.Token, error)
CreateOrgToken creates a org token.
func (*Client) CreateSlackIntegration ¶ added in v1.6.0
func (c *Client) CreateSlackIntegration(ctx context.Context, si *integration.SlackIntegration) (*integration.SlackIntegration, error)
CreateSlackIntegration creates a Slack integration.
func (*Client) CreateTeam ¶
func (c *Client) CreateTeam(ctx context.Context, t *team.CreateUpdateTeamRequest) (*team.Team, error)
CreateTeam creates a team.
func (*Client) CreateUpdateTag ¶
func (c *Client) CreateUpdateTag(ctx context.Context, name string, cutr *metrics_metadata.CreateUpdateTagRequest) (*metrics_metadata.Tag, error)
CreateUpdateTag creates or updates a dimension.
func (*Client) CreateVictorOpsIntegration ¶ added in v1.6.2
func (c *Client) CreateVictorOpsIntegration(ctx context.Context, oi *integration.VictorOpsIntegration) (*integration.VictorOpsIntegration, error)
CreateVictorOpsIntegration creates an VictorOps integration.
func (*Client) CreateWebhookIntegration ¶ added in v1.6.19
func (c *Client) CreateWebhookIntegration(ctx context.Context, oi *integration.WebhookIntegration) (*integration.WebhookIntegration, error)
CreateWebhookIntegration creates an Webhook integration.
func (*Client) DeleteAWSCloudWatchIntegration ¶ added in v1.3.0
DeleteAWSCloudWatchIntegration deletes an AWS CloudWatch integration.
func (*Client) DeleteAlertMutingRule ¶ added in v1.6.8
DeleteAlertMutingRule deletes an alert muting rule.
func (*Client) DeleteAzureIntegration ¶ added in v1.4.0
DeleteAzureIntegration deletes an Azure integration.
func (*Client) DeleteChart ¶
DeleteChart deletes a chart.
func (*Client) DeleteDashboard ¶
DeleteDashboard deletes a dashboard.
func (*Client) DeleteDashboardGroup ¶
DeleteDashboardGroup deletes a dashboard.
func (*Client) DeleteDataLink ¶ added in v1.6.10
DeleteDataLink deletes a data link.
func (*Client) DeleteDetector ¶
DeleteDetector deletes a detector.
func (*Client) DeleteGCPIntegration ¶ added in v1.6.0
DeleteGCPIntegration deletes a GCP integration.
func (*Client) DeleteIntegration ¶
DeleteIntegration deletes an integration.
func (*Client) DeleteJiraIntegration ¶ added in v1.6.5
DeleteJiraIntegration deletes an Jira integration.
func (*Client) DeleteMember ¶
DeleteMember deletes a detector.
func (*Client) DeleteOpsgenieIntegration ¶ added in v1.6.0
DeleteOpsgenieIntegration deletes an Opsgenie integration.
func (*Client) DeleteOrgToken ¶ added in v1.5.0
DeleteOrgToken deletes a token.
func (*Client) DeletePagerDutyIntegration ¶ added in v1.6.0
DeletePagerDutyIntegration deletes a PagerDuty integration.
func (*Client) DeleteSessionToken ¶ added in v1.6.11
DeleteOrgToken deletes a token.
func (*Client) DeleteSlackIntegration ¶ added in v1.6.0
DeleteSlackIntegration deletes a Slack integration.
func (*Client) DeleteTeam ¶
DeleteTeam deletes a team.
func (*Client) DeleteVictorOpsIntegration ¶ added in v1.6.2
DeleteVictorOpsIntegration deletes an VictorOps integration.
func (*Client) DeleteWebhookIntegration ¶ added in v1.6.19
DeleteWebhookIntegration deletes an Webhook integration.
func (*Client) DisableDetector ¶
DisableDetector disables a detector.
func (*Client) EnableDetector ¶
EnableDetector enables a detector.
func (*Client) GetAWSCloudWatchIntegration ¶ added in v1.3.0
func (c *Client) GetAWSCloudWatchIntegration(ctx context.Context, id string) (*integration.AwsCloudWatchIntegration, error)
GetAWSCloudWatchIntegration retrieves an AWS CloudWatch integration.
func (*Client) GetAlertMutingRule ¶ added in v1.6.8
func (c *Client) GetAlertMutingRule(ctx context.Context, id string) (*alertmuting.AlertMutingRule, error)
GetAlertMutingRule gets an alert muting rule.
func (*Client) GetAzureIntegration ¶ added in v1.4.0
func (c *Client) GetAzureIntegration(ctx context.Context, id string) (*integration.AzureIntegration, error)
GetAzureIntegration retrieves an Azure integration.
func (*Client) GetDashboard ¶
GetDashboard gets a dashboard.
func (*Client) GetDashboardGroup ¶
func (c *Client) GetDashboardGroup(ctx context.Context, id string) (*dashboard_group.DashboardGroup, error)
GetDashboardGroup gets a dashboard group.
func (*Client) GetDataLink ¶ added in v1.6.10
GetDataLink gets a data link.
func (*Client) GetDetector ¶
GetDetector gets a detector.
func (*Client) GetDetectorEvents ¶ added in v1.6.17
func (c *Client) GetDetectorEvents(ctx context.Context, id string, from int, to int, offset int, limit int) ([]*detector.Event, error)
GetDetectorEvents gets a detector's events.
func (*Client) GetDetectorIncidents ¶ added in v1.6.17
func (c *Client) GetDetectorIncidents(ctx context.Context, id string, offset int, limit int) ([]*detector.Incident, error)
GetDetectorIncidents gets a detector's incidents.
func (*Client) GetDimension ¶
func (c *Client) GetDimension(ctx context.Context, key string, value string) (*metrics_metadata.Dimension, error)
GetDimension gets a dimension.
func (*Client) GetGCPIntegration ¶ added in v1.6.0
func (c *Client) GetGCPIntegration(ctx context.Context, id string) (*integration.GCPIntegration, error)
GetGCPIntegration retrieves a GCP integration.
func (*Client) GetIntegration ¶
GetIntegration gets a integration.
func (*Client) GetJiraIntegration ¶ added in v1.6.5
func (c *Client) GetJiraIntegration(ctx context.Context, id string) (*integration.JiraIntegration, error)
GetJiraIntegration retrieves an Jira integration.
func (*Client) GetMetricTimeSeries ¶
func (c *Client) GetMetricTimeSeries(ctx context.Context, id string) (*metrics_metadata.MetricTimeSeries, error)
GetMetricTimeSeries retrieves a metric time series by id.
func (*Client) GetOpsgenieIntegration ¶ added in v1.6.0
func (c *Client) GetOpsgenieIntegration(ctx context.Context, id string) (*integration.OpsgenieIntegration, error)
GetOpsgenieIntegration retrieves an Opsgenie integration.
func (*Client) GetOrgToken ¶ added in v1.5.0
GetOrgToken gets a token.
func (*Client) GetOrganization ¶
func (c *Client) GetOrganization(ctx context.Context, id string) (*organization.Organization, error)
GetOrganization gets an organization.
func (*Client) GetOrganizationMembers ¶
func (c *Client) GetOrganizationMembers(ctx context.Context, limit int, query string, offset int, orderBy string) (*organization.MemberSearchResults, error)
GetOrganizationMembers gets members for an org, with an optional search.
func (*Client) GetPagerDutyIntegration ¶ added in v1.6.0
func (c *Client) GetPagerDutyIntegration(ctx context.Context, id string) (*integration.PagerDutyIntegration, error)
GetPagerDutyIntegration retrieves a PagerDuty integration.
func (*Client) GetPagerDutyIntegrationByName ¶ added in v1.7.14
func (c *Client) GetPagerDutyIntegrationByName(ctx context.Context, name string) (*integration.PagerDutyIntegration, error)
GetPagerDutyIntegrationByName retrieves a PagerDuty integration by name.
func (*Client) GetSlackIntegration ¶ added in v1.6.0
func (c *Client) GetSlackIntegration(ctx context.Context, id string) (*integration.SlackIntegration, error)
GetSlackIntegration retrieves a Slack integration.
func (*Client) GetVictorOpsIntegration ¶ added in v1.6.2
func (c *Client) GetVictorOpsIntegration(ctx context.Context, id string) (*integration.VictorOpsIntegration, error)
GetVictorOpsIntegration retrieves an VictorOps integration.
func (*Client) GetWebhookIntegration ¶ added in v1.6.19
func (c *Client) GetWebhookIntegration(ctx context.Context, id string) (*integration.WebhookIntegration, error)
GetWebhookIntegration retrieves an Webhook integration.
func (*Client) InviteMember ¶
func (c *Client) InviteMember(ctx context.Context, inviteRequest *organization.CreateUpdateMemberRequest) (*organization.Member, error)
InviteMember invites a member to the organization.
func (*Client) InviteMembers ¶
func (c *Client) InviteMembers(ctx context.Context, inviteRequest *organization.InviteMembersRequest) (*organization.InviteMembersRequest, error)
InviteMembers invites many members to the organization.
func (*Client) LinkDashboardGroupToTeam ¶ added in v1.7.8
func (c *Client) LinkDashboardGroupToTeam(ctx context.Context, id string, dashboardGroupID string) error
LinkDashboardGroupToTeam links a dashboard group to a team.
func (*Client) LinkDetectorToTeam ¶ added in v1.7.8
LinkDetectorToTeam links a detector to a team.
func (*Client) SearchAlertMutingRules ¶ added in v1.6.8
func (c *Client) SearchAlertMutingRules(ctx context.Context, include string, limit int, query string, offset int) (*alertmuting.SearchResult, error)
SearchAlertMutingRules searches for alert muting rules given a query string in `name`.
func (*Client) SearchCharts ¶
func (c *Client) SearchCharts(ctx context.Context, limit int, name string, offset int, tags string) (*chart.SearchResult, error)
SearchCharts searches for charts, given a query string in `name`.
func (*Client) SearchDashboard ¶
func (c *Client) SearchDashboard(ctx context.Context, limit int, name string, offset int, tags string) (*dashboard.SearchResult, error)
SearchDashboard searches for dashboards, given a query string in `name`.
func (*Client) SearchDashboardGroups ¶
func (c *Client) SearchDashboardGroups(ctx context.Context, limit int, name string, offset int) (*dashboard_group.SearchResult, error)
SearchDashboardGroup searches for dashboard groups, given a query string in `name`.
func (*Client) SearchDataLinks ¶ added in v1.6.10
func (c *Client) SearchDataLinks(ctx context.Context, limit int, context string, offset int) (*datalink.SearchResults, error)
SearchDataLinks searches for data links given a query string in `name`.
func (*Client) SearchDetectors ¶
func (c *Client) SearchDetectors(ctx context.Context, limit int, name string, offset int, tags string) (*detector.SearchResults, error)
SearchDetectors searches for detectors, given a query string in `name`.
func (*Client) SearchDimension ¶
func (c *Client) SearchDimension(ctx context.Context, query string, orderBy string, limit int, offset int) (*metrics_metadata.DimensionQueryResponseModel, error)
SearchDimension searches for dimensions, given a query string in `query`.
func (*Client) SearchMetric ¶
func (c *Client) SearchMetric(ctx context.Context, query string, orderBy string, limit int, offset int) (*metrics_metadata.RetrieveMetricMetadataResponseModel, error)
SearchMetric searches for metrics, given a query string in `query`.
func (*Client) SearchMetricTimeSeries ¶
func (c *Client) SearchMetricTimeSeries(ctx context.Context, query string, orderBy string, limit int, offset int) (*metrics_metadata.MetricTimeSeriesRetrieveResponseModel, error)
SearchMetricTimeSeries searches for metric time series, given a query string in `query`.
func (*Client) SearchOrgTokens ¶ added in v1.5.0
func (c *Client) SearchOrgTokens(ctx context.Context, limit int, name string, offset int) (*orgtoken.SearchResults, error)
SearchOrgTokens searches for tokens given a query string in `name`.
func (*Client) SearchTag ¶
func (c *Client) SearchTag(ctx context.Context, query string, orderBy string, limit int, offset int) (*metrics_metadata.TagRetrieveResponseModel, error)
SearchTag searches for tags, given a query string in `query`.
func (*Client) SearchTeam ¶
func (c *Client) SearchTeam(ctx context.Context, limit int, name string, offset int, tags string) (*team.SearchResults, error)
SearchTeam searches for teams, given a query string in `name`.
func (*Client) SignalFlow ¶
func (c *Client) SignalFlow(options ...signalflow.ClientParam) (*signalflow.Client, error)
SignalFlow creates and returns a SignalFlow client that can be used to execute streaming jobs.
func (*Client) UnlinkDashboardGroupFromTeam ¶ added in v1.7.8
func (c *Client) UnlinkDashboardGroupFromTeam(ctx context.Context, id string, dashboardGroupID string) error
UnlinkDashboardGroupFromTeam unlinks a dashboard group from a team.
func (*Client) UnlinkDetectorFromTeam ¶ added in v1.7.8
UnLinkDetectorFromTeam unlinks a detector from a team.
func (*Client) UpdateAWSCloudWatchIntegration ¶ added in v1.3.0
func (c *Client) UpdateAWSCloudWatchIntegration(ctx context.Context, id string, acwi *integration.AwsCloudWatchIntegration) (*integration.AwsCloudWatchIntegration, error)
UpdateAWSCloudWatchIntegration updates an AWS CloudWatch integration.
func (*Client) UpdateAlertMutingRule ¶ added in v1.6.8
func (c *Client) UpdateAlertMutingRule(ctx context.Context, id string, muteRequest *alertmuting.CreateUpdateAlertMutingRuleRequest) (*alertmuting.AlertMutingRule, error)
UpdateAlertMutingRule updates an alert muting rule.
func (*Client) UpdateAzureIntegration ¶ added in v1.4.0
func (c *Client) UpdateAzureIntegration(ctx context.Context, id string, acwi *integration.AzureIntegration) (*integration.AzureIntegration, error)
UpdateAzureIntegration updates an Azure integration.
func (*Client) UpdateChart ¶
func (c *Client) UpdateChart(ctx context.Context, id string, chartRequest *chart.CreateUpdateChartRequest) (*chart.Chart, error)
UpdateChart updates a chart.
func (*Client) UpdateDashboard ¶
func (c *Client) UpdateDashboard(ctx context.Context, id string, dashboardRequest *dashboard.CreateUpdateDashboardRequest) (*dashboard.Dashboard, error)
UpdateDashboard updates a dashboard.
func (*Client) UpdateDashboardGroup ¶
func (c *Client) UpdateDashboardGroup(ctx context.Context, id string, dashboardGroupRequest *dashboard_group.CreateUpdateDashboardGroupRequest) (*dashboard_group.DashboardGroup, error)
UpdateDashboardGroup updates a dashboard group.
func (*Client) UpdateDataLink ¶ added in v1.6.10
func (c *Client) UpdateDataLink(ctx context.Context, id string, dataLinkRequest *datalink.CreateUpdateDataLinkRequest) (*datalink.DataLink, error)
UpdateDataLink updates a data link.
func (*Client) UpdateDetector ¶
func (c *Client) UpdateDetector(ctx context.Context, id string, detectorRequest *detector.CreateUpdateDetectorRequest) (*detector.Detector, error)
UpdateDetector updates a detector.
func (*Client) UpdateDimension ¶
func (c *Client) UpdateDimension(ctx context.Context, key string, value string, dim *metrics_metadata.Dimension) (*metrics_metadata.Dimension, error)
UpdateDimension updates a dimension.
func (*Client) UpdateGCPIntegration ¶ added in v1.6.0
func (c *Client) UpdateGCPIntegration(ctx context.Context, id string, gcpi *integration.GCPIntegration) (*integration.GCPIntegration, error)
UpdateGCPIntegration updates a GCP integration.
func (*Client) UpdateJiraIntegration ¶ added in v1.6.5
func (c *Client) UpdateJiraIntegration(ctx context.Context, id string, ji *integration.JiraIntegration) (*integration.JiraIntegration, error)
UpdateJiraIntegration updates an Jira integration.
func (*Client) UpdateOpsgenieIntegration ¶ added in v1.6.0
func (c *Client) UpdateOpsgenieIntegration(ctx context.Context, id string, oi *integration.OpsgenieIntegration) (*integration.OpsgenieIntegration, error)
UpdateOpsgenieIntegration updates an Opsgenie integration.
func (*Client) UpdateOrgToken ¶ added in v1.5.0
func (c *Client) UpdateOrgToken(ctx context.Context, id string, tokenRequest *orgtoken.CreateUpdateTokenRequest) (*orgtoken.Token, error)
UpdateOrgToken updates a token.
func (*Client) UpdatePagerDutyIntegration ¶ added in v1.6.0
func (c *Client) UpdatePagerDutyIntegration(ctx context.Context, id string, pdi *integration.PagerDutyIntegration) (*integration.PagerDutyIntegration, error)
UpdatePagerDutyIntegration updates a PagerDuty integration.
func (*Client) UpdateSlackIntegration ¶ added in v1.6.0
func (c *Client) UpdateSlackIntegration(ctx context.Context, id string, si *integration.SlackIntegration) (*integration.SlackIntegration, error)
UpdateSlackIntegration updates a Slack integration.
func (*Client) UpdateTeam ¶
func (c *Client) UpdateTeam(ctx context.Context, id string, t *team.CreateUpdateTeamRequest) (*team.Team, error)
UpdateTeam updates a team.
func (*Client) UpdateVictorOpsIntegration ¶ added in v1.6.2
func (c *Client) UpdateVictorOpsIntegration(ctx context.Context, id string, oi *integration.VictorOpsIntegration) (*integration.VictorOpsIntegration, error)
UpdateVictorOpsIntegration updates an VictorOps integration.
func (*Client) UpdateWebhookIntegration ¶ added in v1.6.19
func (c *Client) UpdateWebhookIntegration(ctx context.Context, id string, oi *integration.WebhookIntegration) (*integration.WebhookIntegration, error)
UpdateWebhookIntegration updates an Webhook integration.
type ClientParam ¶
ClientParam is an option for NewClient. Its implementation borrows from Dave Cheney's functional options API (https://dave.cheney.net/2014/10/17/functional-options-for-friendly-apis).
func APIUrl ¶
func APIUrl(apiURL string) ClientParam
APIUrl sets the URL that our client will communicate with, allowing it to be adjusted to another URL for testing or communication with other SignalFx clusters. Example `"https://api.signalfx.com"`.
func HTTPClient ¶
func HTTPClient(httpClient *http.Client) ClientParam
HTTPClient sets the `http.Client` that this API client will use to to communicate. This allows you to replace the client or tune it to your needs.
func UserAgent ¶ added in v1.6.32
func UserAgent(userAgent string) ClientParam
UserAgent sets the UserAgent string to include with the request.
Source Files ¶
- alertmuting.go
- aws_cloudwatch_integration.go
- azure_integration.go
- chart.go
- client.go
- dashboard.go
- dashboardgroup.go
- datalink.go
- detector.go
- gcp_integration.go
- integration.go
- jira_integration.go
- metrics_metadata.go
- opsgenie_integration.go
- organization.go
- orgtoken.go
- pagerduty_integration.go
- sessiontoken.go
- slack_integration.go
- team.go
- victor_ops_integration.go
- webhook_integration.go
Directories ¶
Path | Synopsis |
---|---|
package realm contains helpers for constructing realm-specific urls and config.
|
package realm contains helpers for constructing realm-specific urls and config. |
Package signalflow contains a SignalFx SignalFlow client, which can be used to execute analytics jobs against the SignalFx backend.
|
Package signalflow contains a SignalFx SignalFlow client, which can be used to execute analytics jobs against the SignalFx backend. |
example
package main shows a basic usage pattern of the SiganlFlow client.
|
package main shows a basic usage pattern of the SiganlFlow client. |
Package writer contains a set of components that accept a single type of SignalFx data (e.g.
|
Package writer contains a set of components that accept a single type of SignalFx data (e.g. |