volcobserve

package
v1.0.110 Latest Latest
Warning

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

 Go to latest Published: Nov 6, 2023 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package volcobserveiface provides an interface to enable mocking the VOLC_OBSERVE service client for testing your code.

It is important to note that this interface will have breaking changes when the service model is updated and adds new API operations, paginators, and waiters.

Index

Constants

View Source 
const (
	ServiceName = "volc_observe" // Name of service.
	EndpointsID = ServiceName    // ID to lookup a service endpoint with.
	ServiceID   = "volc_observe" // ServiceID is a unique identifer of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type DataForGetMetricDataOutput added in v1.0.48 

type DataForGetMetricDataOutput struct {
	DescriptionCN *string `type:"string"`

	DescriptionEN *string `type:"string"`

	EndTime *int64 `type:"integer"`

	MetricDataResults []*MetricDataResultForGetMetricDataOutput `type:"list"`

	MetricName *string `type:"string"`

	Namespace *string `type:"string"`

	Period *string `type:"string"`

	StartTime *int64 `type:"integer"`

	Unit *string `type:"string"`
	// contains filtered or unexported fields
}

func (DataForGetMetricDataOutput) GoString added in v1.0.48 

func (s DataForGetMetricDataOutput) GoString() string

GoString returns the string representation

func (*DataForGetMetricDataOutput) SetDescriptionCN added in v1.0.48 

func (s *DataForGetMetricDataOutput) SetDescriptionCN(v string) *DataForGetMetricDataOutput

SetDescriptionCN sets the DescriptionCN field's value.

func (*DataForGetMetricDataOutput) SetDescriptionEN added in v1.0.48 

func (s *DataForGetMetricDataOutput) SetDescriptionEN(v string) *DataForGetMetricDataOutput

SetDescriptionEN sets the DescriptionEN field's value.

func (*DataForGetMetricDataOutput) SetEndTime added in v1.0.48 

func (s *DataForGetMetricDataOutput) SetEndTime(v int64) *DataForGetMetricDataOutput

SetEndTime sets the EndTime field's value.

func (*DataForGetMetricDataOutput) SetMetricDataResults added in v1.0.48 

func (s *DataForGetMetricDataOutput) SetMetricDataResults(v []*MetricDataResultForGetMetricDataOutput) *DataForGetMetricDataOutput

SetMetricDataResults sets the MetricDataResults field's value.

func (*DataForGetMetricDataOutput) SetMetricName added in v1.0.48 

func (s *DataForGetMetricDataOutput) SetMetricName(v string) *DataForGetMetricDataOutput

SetMetricName sets the MetricName field's value.

func (*DataForGetMetricDataOutput) SetNamespace added in v1.0.48 

func (s *DataForGetMetricDataOutput) SetNamespace(v string) *DataForGetMetricDataOutput

SetNamespace sets the Namespace field's value.

func (*DataForGetMetricDataOutput) SetPeriod added in v1.0.48 

func (s *DataForGetMetricDataOutput) SetPeriod(v string) *DataForGetMetricDataOutput

SetPeriod sets the Period field's value.

func (*DataForGetMetricDataOutput) SetStartTime added in v1.0.48 

func (s *DataForGetMetricDataOutput) SetStartTime(v int64) *DataForGetMetricDataOutput

SetStartTime sets the StartTime field's value.

func (*DataForGetMetricDataOutput) SetUnit added in v1.0.48 

func (s *DataForGetMetricDataOutput) SetUnit(v string) *DataForGetMetricDataOutput

SetUnit sets the Unit field's value.

func (DataForGetMetricDataOutput) String added in v1.0.48 

func (s DataForGetMetricDataOutput) String() string

String returns the string representation

type DataForGetTopDataOutput added in v1.0.89 

type DataForGetTopDataOutput struct {
	Asc *bool `type:"boolean"`

	OrderByMetricName *string `type:"string"`

	TopDataResults []*TopDataResultForGetTopDataOutput `type:"list"`
	// contains filtered or unexported fields
}

func (DataForGetTopDataOutput) GoString added in v1.0.89 

func (s DataForGetTopDataOutput) GoString() string

GoString returns the string representation

func (*DataForGetTopDataOutput) SetAsc added in v1.0.89 

func (s *DataForGetTopDataOutput) SetAsc(v bool) *DataForGetTopDataOutput

SetAsc sets the Asc field's value.

func (*DataForGetTopDataOutput) SetOrderByMetricName added in v1.0.89 

func (s *DataForGetTopDataOutput) SetOrderByMetricName(v string) *DataForGetTopDataOutput

SetOrderByMetricName sets the OrderByMetricName field's value.

func (*DataForGetTopDataOutput) SetTopDataResults added in v1.0.89 

func (s *DataForGetTopDataOutput) SetTopDataResults(v []*TopDataResultForGetTopDataOutput) *DataForGetTopDataOutput

SetTopDataResults sets the TopDataResults field's value.

func (DataForGetTopDataOutput) String added in v1.0.89 

func (s DataForGetTopDataOutput) String() string

String returns the string representation

type DataPointForGetMetricDataOutput added in v1.0.48 

type DataPointForGetMetricDataOutput struct {
	Timestamp *int64 `type:"integer"`

	Value *float64 `type:"double"`
	// contains filtered or unexported fields
}

func (DataPointForGetMetricDataOutput) GoString added in v1.0.48 

func (s DataPointForGetMetricDataOutput) GoString() string

GoString returns the string representation

func (*DataPointForGetMetricDataOutput) SetTimestamp added in v1.0.48 

func (s *DataPointForGetMetricDataOutput) SetTimestamp(v int64) *DataPointForGetMetricDataOutput

SetTimestamp sets the Timestamp field's value.

func (*DataPointForGetMetricDataOutput) SetValue added in v1.0.48 

func (s *DataPointForGetMetricDataOutput) SetValue(v float64) *DataPointForGetMetricDataOutput

SetValue sets the Value field's value.

func (DataPointForGetMetricDataOutput) String added in v1.0.48 

func (s DataPointForGetMetricDataOutput) String() string

String returns the string representation

type DimensionForGetMetricDataInput added in v1.0.48 

type DimensionForGetMetricDataInput struct {
	Name *string `type:"string"`

	Value *string `type:"string"`
	// contains filtered or unexported fields
}

func (DimensionForGetMetricDataInput) GoString added in v1.0.48 

func (s DimensionForGetMetricDataInput) GoString() string

GoString returns the string representation

func (*DimensionForGetMetricDataInput) SetName added in v1.0.48 

func (s *DimensionForGetMetricDataInput) SetName(v string) *DimensionForGetMetricDataInput

SetName sets the Name field's value.

func (*DimensionForGetMetricDataInput) SetValue added in v1.0.48 

func (s *DimensionForGetMetricDataInput) SetValue(v string) *DimensionForGetMetricDataInput

SetValue sets the Value field's value.

func (DimensionForGetMetricDataInput) String added in v1.0.48 

func (s DimensionForGetMetricDataInput) String() string

String returns the string representation

type DimensionForGetMetricDataOutput added in v1.0.48 

type DimensionForGetMetricDataOutput struct {
	Name *string `type:"string"`

	Value *string `type:"string"`
	// contains filtered or unexported fields
}

func (DimensionForGetMetricDataOutput) GoString added in v1.0.48 

func (s DimensionForGetMetricDataOutput) GoString() string

GoString returns the string representation

func (*DimensionForGetMetricDataOutput) SetName added in v1.0.48 

func (s *DimensionForGetMetricDataOutput) SetName(v string) *DimensionForGetMetricDataOutput

SetName sets the Name field's value.

func (*DimensionForGetMetricDataOutput) SetValue added in v1.0.48 

func (s *DimensionForGetMetricDataOutput) SetValue(v string) *DimensionForGetMetricDataOutput

SetValue sets the Value field's value.

func (DimensionForGetMetricDataOutput) String added in v1.0.48 

func (s DimensionForGetMetricDataOutput) String() string

String returns the string representation

type DimensionForGetTopDataInput added in v1.0.89 

type DimensionForGetTopDataInput struct {
	Name *string `type:"string"`

	Value *string `type:"string"`
	// contains filtered or unexported fields
}

func (DimensionForGetTopDataInput) GoString added in v1.0.89 

func (s DimensionForGetTopDataInput) GoString() string

GoString returns the string representation

func (*DimensionForGetTopDataInput) SetName added in v1.0.89 

func (s *DimensionForGetTopDataInput) SetName(v string) *DimensionForGetTopDataInput

SetName sets the Name field's value.

func (*DimensionForGetTopDataInput) SetValue added in v1.0.89 

func (s *DimensionForGetTopDataInput) SetValue(v string) *DimensionForGetTopDataInput

SetValue sets the Value field's value.

func (DimensionForGetTopDataInput) String added in v1.0.89 

func (s DimensionForGetTopDataInput) String() string

String returns the string representation

type GetMetricDataInput added in v1.0.48 

type GetMetricDataInput struct {
	EndTime *int64 `type:"integer"`

	GroupBy []*string `type:"list"`

	Instances []*InstanceForGetMetricDataInput `type:"list"`

	MetricName *string `type:"string"`

	Namespace *string `type:"string"`

	Period *string `type:"string"`

	StartTime *int64 `type:"integer"`

	SubNamespace *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetMetricDataInput) GoString added in v1.0.48 

func (s GetMetricDataInput) GoString() string

GoString returns the string representation

func (*GetMetricDataInput) SetEndTime added in v1.0.48 

func (s *GetMetricDataInput) SetEndTime(v int64) *GetMetricDataInput

SetEndTime sets the EndTime field's value.

func (*GetMetricDataInput) SetGroupBy added in v1.0.97 

func (s *GetMetricDataInput) SetGroupBy(v []*string) *GetMetricDataInput

SetGroupBy sets the GroupBy field's value.

func (*GetMetricDataInput) SetInstances added in v1.0.48 

func (s *GetMetricDataInput) SetInstances(v []*InstanceForGetMetricDataInput) *GetMetricDataInput

SetInstances sets the Instances field's value.

func (*GetMetricDataInput) SetMetricName added in v1.0.48 

func (s *GetMetricDataInput) SetMetricName(v string) *GetMetricDataInput

SetMetricName sets the MetricName field's value.

func (*GetMetricDataInput) SetNamespace added in v1.0.48 

func (s *GetMetricDataInput) SetNamespace(v string) *GetMetricDataInput

SetNamespace sets the Namespace field's value.

func (*GetMetricDataInput) SetPeriod added in v1.0.48 

func (s *GetMetricDataInput) SetPeriod(v string) *GetMetricDataInput

SetPeriod sets the Period field's value.

func (*GetMetricDataInput) SetStartTime added in v1.0.48 

func (s *GetMetricDataInput) SetStartTime(v int64) *GetMetricDataInput

SetStartTime sets the StartTime field's value.

func (*GetMetricDataInput) SetSubNamespace added in v1.0.48 

func (s *GetMetricDataInput) SetSubNamespace(v string) *GetMetricDataInput

SetSubNamespace sets the SubNamespace field's value.

func (GetMetricDataInput) String added in v1.0.48 

func (s GetMetricDataInput) String() string

String returns the string representation

type GetMetricDataOutput added in v1.0.48 

type GetMetricDataOutput struct {
	Metadata *response.ResponseMetadata

	Data *DataForGetMetricDataOutput `type:"structure"`
	// contains filtered or unexported fields
}

func (GetMetricDataOutput) GoString added in v1.0.48 

func (s GetMetricDataOutput) GoString() string

GoString returns the string representation

func (*GetMetricDataOutput) SetData added in v1.0.48 

func (s *GetMetricDataOutput) SetData(v *DataForGetMetricDataOutput) *GetMetricDataOutput

SetData sets the Data field's value.

func (GetMetricDataOutput) String added in v1.0.48 

func (s GetMetricDataOutput) String() string

String returns the string representation

type GetTopDataInput added in v1.0.89 

type GetTopDataInput struct {
	Asc *bool `type:"boolean"`

	EndTime *int64 `type:"integer"`

	GroupBy []*string `type:"list"`

	Instances []*InstanceForGetTopDataInput `type:"list"`

	MetricNames []*string `type:"list"`

	Namespace *string `type:"string"`

	OrderByMetricName *string `type:"string"`

	StartTime *int64 `type:"integer"`

	SubNamespace *string `type:"string"`

	TopN *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (GetTopDataInput) GoString added in v1.0.89 

func (s GetTopDataInput) GoString() string

GoString returns the string representation

func (*GetTopDataInput) SetAsc added in v1.0.89 

func (s *GetTopDataInput) SetAsc(v bool) *GetTopDataInput

SetAsc sets the Asc field's value.

func (*GetTopDataInput) SetEndTime added in v1.0.89 

func (s *GetTopDataInput) SetEndTime(v int64) *GetTopDataInput

SetEndTime sets the EndTime field's value.

func (*GetTopDataInput) SetGroupBy added in v1.0.89 

func (s *GetTopDataInput) SetGroupBy(v []*string) *GetTopDataInput

SetGroupBy sets the GroupBy field's value.

func (*GetTopDataInput) SetInstances added in v1.0.89 

func (s *GetTopDataInput) SetInstances(v []*InstanceForGetTopDataInput) *GetTopDataInput

SetInstances sets the Instances field's value.

func (*GetTopDataInput) SetMetricNames added in v1.0.89 

func (s *GetTopDataInput) SetMetricNames(v []*string) *GetTopDataInput

SetMetricNames sets the MetricNames field's value.

func (*GetTopDataInput) SetNamespace added in v1.0.89 

func (s *GetTopDataInput) SetNamespace(v string) *GetTopDataInput

SetNamespace sets the Namespace field's value.

func (*GetTopDataInput) SetOrderByMetricName added in v1.0.89 

func (s *GetTopDataInput) SetOrderByMetricName(v string) *GetTopDataInput

SetOrderByMetricName sets the OrderByMetricName field's value.

func (*GetTopDataInput) SetStartTime added in v1.0.89 

func (s *GetTopDataInput) SetStartTime(v int64) *GetTopDataInput

SetStartTime sets the StartTime field's value.

func (*GetTopDataInput) SetSubNamespace added in v1.0.89 

func (s *GetTopDataInput) SetSubNamespace(v string) *GetTopDataInput

SetSubNamespace sets the SubNamespace field's value.

func (*GetTopDataInput) SetTopN added in v1.0.89 

func (s *GetTopDataInput) SetTopN(v int64) *GetTopDataInput

SetTopN sets the TopN field's value.

func (GetTopDataInput) String added in v1.0.89 

func (s GetTopDataInput) String() string

String returns the string representation

type GetTopDataOutput added in v1.0.89 

type GetTopDataOutput struct {
	Metadata *response.ResponseMetadata

	Data *DataForGetTopDataOutput `type:"structure"`
	// contains filtered or unexported fields
}

func (GetTopDataOutput) GoString added in v1.0.89 

func (s GetTopDataOutput) GoString() string

GoString returns the string representation

func (*GetTopDataOutput) SetData added in v1.0.89 

func (s *GetTopDataOutput) SetData(v *DataForGetTopDataOutput) *GetTopDataOutput

SetData sets the Data field's value.

func (GetTopDataOutput) String added in v1.0.89 

func (s GetTopDataOutput) String() string

String returns the string representation

type InstanceForGetMetricDataInput added in v1.0.48 

type InstanceForGetMetricDataInput struct {
	Dimensions []*DimensionForGetMetricDataInput `type:"list"`
	// contains filtered or unexported fields
}

func (InstanceForGetMetricDataInput) GoString added in v1.0.48 

func (s InstanceForGetMetricDataInput) GoString() string

GoString returns the string representation

func (*InstanceForGetMetricDataInput) SetDimensions added in v1.0.48 

func (s *InstanceForGetMetricDataInput) SetDimensions(v []*DimensionForGetMetricDataInput) *InstanceForGetMetricDataInput

SetDimensions sets the Dimensions field's value.

func (InstanceForGetMetricDataInput) String added in v1.0.48 

func (s InstanceForGetMetricDataInput) String() string

String returns the string representation

type InstanceForGetTopDataInput added in v1.0.89 

type InstanceForGetTopDataInput struct {
	Dimensions []*DimensionForGetTopDataInput `type:"list"`
	// contains filtered or unexported fields
}

func (InstanceForGetTopDataInput) GoString added in v1.0.89 

func (s InstanceForGetTopDataInput) GoString() string

GoString returns the string representation

func (*InstanceForGetTopDataInput) SetDimensions added in v1.0.89 

func (s *InstanceForGetTopDataInput) SetDimensions(v []*DimensionForGetTopDataInput) *InstanceForGetTopDataInput

SetDimensions sets the Dimensions field's value.

func (InstanceForGetTopDataInput) String added in v1.0.89 

func (s InstanceForGetTopDataInput) String() string

String returns the string representation

type MetricDataResultForGetMetricDataOutput added in v1.0.48 

type MetricDataResultForGetMetricDataOutput struct {
	DataPoints []*DataPointForGetMetricDataOutput `type:"list"`

	Dimensions []*DimensionForGetMetricDataOutput `type:"list"`

	Legend *string `type:"string"`
	// contains filtered or unexported fields
}

func (MetricDataResultForGetMetricDataOutput) GoString added in v1.0.48 

func (s MetricDataResultForGetMetricDataOutput) GoString() string

GoString returns the string representation

func (*MetricDataResultForGetMetricDataOutput) SetDataPoints added in v1.0.48 

func (s *MetricDataResultForGetMetricDataOutput) SetDataPoints(v []*DataPointForGetMetricDataOutput) *MetricDataResultForGetMetricDataOutput

SetDataPoints sets the DataPoints field's value.

func (*MetricDataResultForGetMetricDataOutput) SetDimensions added in v1.0.48 

func (s *MetricDataResultForGetMetricDataOutput) SetDimensions(v []*DimensionForGetMetricDataOutput) *MetricDataResultForGetMetricDataOutput

SetDimensions sets the Dimensions field's value.

func (*MetricDataResultForGetMetricDataOutput) SetLegend added in v1.0.48 

func (s *MetricDataResultForGetMetricDataOutput) SetLegend(v string) *MetricDataResultForGetMetricDataOutput

SetLegend sets the Legend field's value.

func (MetricDataResultForGetMetricDataOutput) String added in v1.0.48 

func (s MetricDataResultForGetMetricDataOutput) String() string

String returns the string representation

type TopDataResultForGetTopDataOutput added in v1.0.89 

type TopDataResultForGetTopDataOutput struct {
	GroupKeys map[string]*interface{} `type:"map"`

	MetricData map[string]*interface{} `type:"map"`
	// contains filtered or unexported fields
}

func (TopDataResultForGetTopDataOutput) GoString added in v1.0.89 

func (s TopDataResultForGetTopDataOutput) GoString() string

GoString returns the string representation

func (*TopDataResultForGetTopDataOutput) SetGroupKeys added in v1.0.89 

func (s *TopDataResultForGetTopDataOutput) SetGroupKeys(v map[string]*interface{}) *TopDataResultForGetTopDataOutput

SetGroupKeys sets the GroupKeys field's value.

func (*TopDataResultForGetTopDataOutput) SetMetricData added in v1.0.89 

func (s *TopDataResultForGetTopDataOutput) SetMetricData(v map[string]*interface{}) *TopDataResultForGetTopDataOutput

SetMetricData sets the MetricData field's value.

func (TopDataResultForGetTopDataOutput) String added in v1.0.89 

func (s TopDataResultForGetTopDataOutput) String() string

String returns the string representation

type VOLCOBSERVE 

type VOLCOBSERVE struct {
	*client.Client
}

VOLCOBSERVE provides the API operation methods for making requests to VOLC_OBSERVE. See this package's package overview docs for details on the service.

VOLCOBSERVE methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*volcengine.Config) *VOLCOBSERVE

New create int can support ssl or region locate set

func (*VOLCOBSERVE) GetMetricData added in v1.0.48 

func (c *VOLCOBSERVE) GetMetricData(input *GetMetricDataInput) (*GetMetricDataOutput, error)

GetMetricData API operation for VOLC_OBSERVE.

Returns volcengineerr.Error for service API and SDK errors. Use runtime type assertions with volcengineerr.Error's Code and Message methods to get detailed information about the error.

See the VOLCENGINE API reference guide for VOLC_OBSERVE's API operation GetMetricData for usage and error information.

func (*VOLCOBSERVE) GetMetricDataCommon added in v1.0.48 

func (c *VOLCOBSERVE) GetMetricDataCommon(input *map[string]interface{}) (*map[string]interface{}, error)

GetMetricDataCommon API operation for VOLC_OBSERVE.

Returns volcengineerr.Error for service API and SDK errors. Use runtime type assertions with volcengineerr.Error's Code and Message methods to get detailed information about the error.

See the VOLCENGINE API reference guide for VOLC_OBSERVE's API operation GetMetricDataCommon for usage and error information.

func (*VOLCOBSERVE) GetMetricDataCommonRequest added in v1.0.48 

func (c *VOLCOBSERVE) GetMetricDataCommonRequest(input *map[string]interface{}) (req *request.Request, output *map[string]interface{})

GetMetricDataCommonRequest generates a "volcengine/request.Request" representing the client's request for the GetMetricDataCommon operation. The "output" return value will be populated with the GetMetricDataCommon request's response once the request completes successfully.

Use "Send" method on the returned GetMetricDataCommon Request to send the API call to the service. the "output" return value is not valid until after GetMetricDataCommon Send returns without error.

See GetMetricDataCommon for more information on using the GetMetricDataCommon API call, and error handling. 

// Example sending a request using the GetMetricDataCommonRequest method.
req, resp := client.GetMetricDataCommonRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*VOLCOBSERVE) GetMetricDataCommonWithContext added in v1.0.48 

func (c *VOLCOBSERVE) GetMetricDataCommonWithContext(ctx volcengine.Context, input *map[string]interface{}, opts ...request.Option) (*map[string]interface{}, error)

GetMetricDataCommonWithContext is the same as GetMetricDataCommon with the addition of the ability to pass a context and additional request options.

See GetMetricDataCommon for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VOLCOBSERVE) GetMetricDataRequest added in v1.0.48 

func (c *VOLCOBSERVE) GetMetricDataRequest(input *GetMetricDataInput) (req *request.Request, output *GetMetricDataOutput)

GetMetricDataRequest generates a "volcengine/request.Request" representing the client's request for the GetMetricData operation. The "output" return value will be populated with the GetMetricDataCommon request's response once the request completes successfully.

Use "Send" method on the returned GetMetricDataCommon Request to send the API call to the service. the "output" return value is not valid until after GetMetricDataCommon Send returns without error.

See GetMetricData for more information on using the GetMetricData API call, and error handling. 

// Example sending a request using the GetMetricDataRequest method.
req, resp := client.GetMetricDataRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*VOLCOBSERVE) GetMetricDataWithContext added in v1.0.48 

func (c *VOLCOBSERVE) GetMetricDataWithContext(ctx volcengine.Context, input *GetMetricDataInput, opts ...request.Option) (*GetMetricDataOutput, error)

GetMetricDataWithContext is the same as GetMetricData with the addition of the ability to pass a context and additional request options.

See GetMetricData for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. Ifthe context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VOLCOBSERVE) GetTopData added in v1.0.89 

func (c *VOLCOBSERVE) GetTopData(input *GetTopDataInput) (*GetTopDataOutput, error)

GetTopData API operation for VOLC_OBSERVE.

Returns volcengineerr.Error for service API and SDK errors. Use runtime type assertions with volcengineerr.Error's Code and Message methods to get detailed information about the error.

See the VOLCENGINE API reference guide for VOLC_OBSERVE's API operation GetTopData for usage and error information.

func (*VOLCOBSERVE) GetTopDataCommon added in v1.0.89 

func (c *VOLCOBSERVE) GetTopDataCommon(input *map[string]interface{}) (*map[string]interface{}, error)

GetTopDataCommon API operation for VOLC_OBSERVE.

Returns volcengineerr.Error for service API and SDK errors. Use runtime type assertions with volcengineerr.Error's Code and Message methods to get detailed information about the error.

See the VOLCENGINE API reference guide for VOLC_OBSERVE's API operation GetTopDataCommon for usage and error information.

func (*VOLCOBSERVE) GetTopDataCommonRequest added in v1.0.89 

func (c *VOLCOBSERVE) GetTopDataCommonRequest(input *map[string]interface{}) (req *request.Request, output *map[string]interface{})

GetTopDataCommonRequest generates a "volcengine/request.Request" representing the client's request for the GetTopDataCommon operation. The "output" return value will be populated with the GetTopDataCommon request's response once the request completes successfully.

Use "Send" method on the returned GetTopDataCommon Request to send the API call to the service. the "output" return value is not valid until after GetTopDataCommon Send returns without error.

See GetTopDataCommon for more information on using the GetTopDataCommon API call, and error handling. 

// Example sending a request using the GetTopDataCommonRequest method.
req, resp := client.GetTopDataCommonRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*VOLCOBSERVE) GetTopDataCommonWithContext added in v1.0.89 

func (c *VOLCOBSERVE) GetTopDataCommonWithContext(ctx volcengine.Context, input *map[string]interface{}, opts ...request.Option) (*map[string]interface{}, error)

GetTopDataCommonWithContext is the same as GetTopDataCommon with the addition of the ability to pass a context and additional request options.

See GetTopDataCommon for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VOLCOBSERVE) GetTopDataRequest added in v1.0.89 

func (c *VOLCOBSERVE) GetTopDataRequest(input *GetTopDataInput) (req *request.Request, output *GetTopDataOutput)

GetTopDataRequest generates a "volcengine/request.Request" representing the client's request for the GetTopData operation. The "output" return value will be populated with the GetTopDataCommon request's response once the request completes successfully.

Use "Send" method on the returned GetTopDataCommon Request to send the API call to the service. the "output" return value is not valid until after GetTopDataCommon Send returns without error.

See GetTopData for more information on using the GetTopData API call, and error handling. 

// Example sending a request using the GetTopDataRequest method.
req, resp := client.GetTopDataRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*VOLCOBSERVE) GetTopDataWithContext added in v1.0.89 

func (c *VOLCOBSERVE) GetTopDataWithContext(ctx volcengine.Context, input *GetTopDataInput, opts ...request.Option) (*GetTopDataOutput, error)

GetTopDataWithContext is the same as GetTopData with the addition of the ability to pass a context and additional request options.

See GetTopData for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. Ifthe context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type VOLCOBSERVEAPI 

type VOLCOBSERVEAPI interface {
	GetMetricDataCommon(*map[string]interface{}) (*map[string]interface{}, error)
	GetMetricDataCommonWithContext(volcengine.Context, *map[string]interface{}, ...request.Option) (*map[string]interface{}, error)
	GetMetricDataCommonRequest(*map[string]interface{}) (*request.Request, *map[string]interface{})

	GetMetricData(*GetMetricDataInput) (*GetMetricDataOutput, error)
	GetMetricDataWithContext(volcengine.Context, *GetMetricDataInput, ...request.Option) (*GetMetricDataOutput, error)
	GetMetricDataRequest(*GetMetricDataInput) (*request.Request, *GetMetricDataOutput)

	GetTopDataCommon(*map[string]interface{}) (*map[string]interface{}, error)
	GetTopDataCommonWithContext(volcengine.Context, *map[string]interface{}, ...request.Option) (*map[string]interface{}, error)
	GetTopDataCommonRequest(*map[string]interface{}) (*request.Request, *map[string]interface{})

	GetTopData(*GetTopDataInput) (*GetTopDataOutput, error)
	GetTopDataWithContext(volcengine.Context, *GetTopDataInput, ...request.Option) (*GetTopDataOutput, error)
	GetTopDataRequest(*GetTopDataInput) (*request.Request, *GetTopDataOutput)
}

VOLCOBSERVEAPI provides an interface to enable mocking the volcobserve.VOLCOBSERVE service client's API operation, 

// volcengine sdk func uses an SDK service client to make a request to
// VOLC_OBSERVE.
func myFunc(svc VOLCOBSERVEAPI) bool {
    // Make svc.GetMetricData request
}

func main() {
    sess := session.New()
    svc := volcobserve.New(sess)

    myFunc(svc)
}

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.