api

package
v0.9.144 Latest Latest
Warning

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

 Go to latest Published: Mar 7, 2023 License: Apache-2.0 Imports: 3 Imported by: 1

Documentation

Index

Constants

View Source 
const (
	LOGSTORE_PREFIX   = bce.URI_PREFIX + "v1" + bce.URI_PREFIX + "logstore"
	FASTQUERY_PREFIX  = bce.URI_PREFIX + "v1" + bce.URI_PREFIX + "fastquery"
	LOGSHIPPER_PREFIX = bce.URI_PREFIX + "v1" + bce.URI_PREFIX + "logshipper"
)

Variables

This section is empty.

Functions

func BulkDeleteLogShipper added in v0.9.83 

func BulkDeleteLogShipper(cli bce.Client, body *bce.Body) error

BulkDeleteLogShipper - bulk delete logShipper by id

PARAMS:

  • cli: the client agent which can perform sending request
  • body: bulkDeleteLogShipper parameters body

RETURNS:

  • error: nil if success otherwise the specific error

func BulkSetLogShipperStatus added in v0.9.83 

func BulkSetLogShipperStatus(cli bce.Client, body *bce.Body) error

BulkSetLogShipperStatus - bulk set logShipper status by id

PARAMS:

  • cli: the client agent which can perform sending request
  • body: bulkSetLogShipperStatus parameters body

RETURNS:

  • error: nil if success otherwise the specific error

func CreateFastQuery 

func CreateFastQuery(cli bce.Client, body *bce.Body) error

CreateFastQuery - create a fastQuery

PARAMS:

  • cli: the client agent which can perform sending request
  • body: the fastQuery body

RETURNS:

  • error: nil if success otherwise the specific error

func CreateIndex 

func CreateIndex(cli bce.Client, logStoreName string, body *bce.Body) error

CreateIndex - create index for logStore

PARAMS:

  • cli: the client agent which can perform sending request
  • logStoreName: logStore needs to be indexed
  • body: index mappings body

RETURNS:

  • error: nil if success otherwise the specific error

func CreateLogShipper added in v0.9.83 

func CreateLogShipper(cli bce.Client, body *bce.Body) (string, error)

CreateLogShipper - create logShipper

PARAMS:

  • cli: the client agent which can perform sending request
  • body: logShipper parameters body

RETURNS:

  • string: snowflake base64 id for logShipper, empty string if creation fail
  • error: nil if success otherwise the specific error

func CreateLogStore 

func CreateLogStore(cli bce.Client, body *bce.Body) error

CreateLogStore - create logStore

PARAMS:

  • cli: the client agent which can perform sending request
  • body: logStore parameters body

RETURNS:

  • error: nil if success otherwise the specific error

func DeleteFastQuery 

func DeleteFastQuery(cli bce.Client, fastQueryName string) error

DeleteFastQuery - delete specific fastQuery

PARAMS:

  • cli: the client agent which can perform sending request
  • fastQueryName: fastQuery name to delete

RETURNS:

  • error: nil if success otherwise the specific error

func DeleteIndex 

func DeleteIndex(cli bce.Client, logStoreName string) error

DeleteIndex - delete index for logStore

PARAMS:

  • cli: the client agent which can perform sending request
  • logStoreName: logStore to be deleted

RETURNS:

  • error: nil if success otherwise the specific error

func DeleteLogStore 

func DeleteLogStore(cli bce.Client, logStore string) error

DeleteLogStore - delete logStore

PARAMS:

  • cli: the client agent which can perform sending request
  • logStore: logStore to delete

RETURNS:

  • error: nil if success otherwise the specific error

func DeleteSingleLogShipper added in v0.9.83 

func DeleteSingleLogShipper(cli bce.Client, logShipperID string) error

DeleteSingleLogShipper - delete logShipper by id

PARAMS:

  • cli: the client agent which can perform sending request
  • logShipperID: logShipper to delete

RETURNS:

  • error: nil if success otherwise the specific error

func PushLogRecord 

func PushLogRecord(cli bce.Client, logStore string, body *bce.Body) error

PushLogRecord - push logRecords into logStore

PARAMS:

  • cli: the client agent which can perform sending request
  • logStore: target logStore to store logRecords
  • body: logRecord body

RETURNS:

  • error: nil if success otherwise the specific error

func SetSingleLogShipperStatus added in v0.9.83 

func SetSingleLogShipperStatus(cli bce.Client, logShipperID string, body *bce.Body) error

SetSingleLogShipperStatus - set logShipper status by id

PARAMS:

  • cli: the client agent which can perform sending request
  • logShipperID: logShipper to set
  • body: setSingleLogShipperStatus parameters body

RETURNS:

  • error: nil if success otherwise the specific error

func UpdateFastQuery 

func UpdateFastQuery(cli bce.Client, body *bce.Body, fastQueryName string) error

UpdateFastQuery - update specific fastQuery info

PARAMS:

  • cli: the client agent which can perform sending request
  • body: update fastQuery body
  • fastQueryName: fastQuery to update

RETURNS:

  • error: nil if success otherwise the specific error

func UpdateIndex 

func UpdateIndex(cli bce.Client, logStoreName string, body *bce.Body) error

UpdateIndex - update index info

PARAMS:

  • cli: the client agent which can perform sending request
  • logStoreName: logStore needs to be updated
  • body: index mappings body

RETURNS:

  • error: nil if success otherwise the specific error

func UpdateLogShipper added in v0.9.83 

func UpdateLogShipper(cli bce.Client, body *bce.Body, logShipperID string) error

UpdateLogShipper - update logShipper name and destConfig

PARAMS:

  • cli: the client agent which can perform sending request
  • logShipperID: logShipperID to update
  • body: logShipper parameters body

RETURNS:

  • error: nil if success otherwise the specific error

func UpdateLogStore 

func UpdateLogStore(cli bce.Client, logStore string, body *bce.Body) error

UpdateLogStore - update logStore retention

PARAMS:

  • cli: the client agent which can perform sending request
  • logStore: logStore to update
  • body: logStore parameters body

RETURNS:

  • error: nil if success otherwise the specific error

Types

type BulkDeleteShipperCondition added in v0.9.83 

type BulkDeleteShipperCondition struct {
	LogShipperIDs []string `json:"logShipperIDs"`
}

type BulkSetShipperStatusCondition added in v0.9.83 

type BulkSetShipperStatusCondition struct {
	LogShipperIDs []string `json:"logShipperIDs"`
	DesiredStatus string   `json:"desiredStatus"`
}

type CreateFastQueryBody 

type CreateFastQueryBody struct {
	FastQueryName string `json:"fastQueryName"`
	Query         string `json:"query"`
	Description   string `json:"description"`
	LogStoreName  string `json:"logStoreName"`
	LogStreamName string `json:"logStreamName"`
}

type CreateLogShipperBody added in v0.9.83 

type CreateLogShipperBody struct {
	LogShipperName string             `json:"logShipperName"`
	LogStoreName   string             `json:"logStoreName"`
	StartTime      string             `json:"startTime"`
	DestType       string             `json:"destType"`
	DestConfig     *ShipperDestConfig `json:"destConfig"`
}

type CreateLogShipperResponse added in v0.9.83 

type CreateLogShipperResponse struct {
	LogShipperID string `json:"logShipperID"`
}

type DataSetScanInfo 

type DataSetScanInfo struct {
	IsTruncated     bool        `json:"isTruncated"`
	TruncatedReason string      `json:"truncatedReason"`
	Statistics      *Statistics `json:"statistics"`
}

type DateTime 

type DateTime string

type FastQuery 

type FastQuery struct {
	CreationDateTime DateTime `json:"creationDateTime"`
	LastModifiedTime DateTime `json:"lastModifiedTime"`
	FastQueryName    string   `json:"fastQueryName"`
	Description      string   `json:"description"`
	Query            string   `json:"query"`
	LogStoreName     string   `json:"logStoreName"`
	LogStreamName    string   `json:"logStreamName"`
}

func DescribeFastQuery 

func DescribeFastQuery(cli bce.Client, fastQueryName string) (*FastQuery, error)

DescribeFastQuery - get specific fastQuery info

PARAMS:

  • cli: the client agent which can perform sending request
  • fastQueryName: fastQuery name to get

RETURNS:

  • *FastQuery: target fastQuery info
  • error: nil if success otherwise the specific error

type Histogram 

type Histogram struct {
	Interval      int      `json:"interval"`
	StartDateTime DateTime `json:"startDatetime"`
	EndDateTime   DateTime `json:"endDateTime"`
	Counts        []int    `json:"counts"`
}

type IndexFields 

type IndexFields struct {
	FullText bool                `json:"fulltext"`
	Fields   map[string]LogField `json:"fields"`
}

func DescribeIndex 

func DescribeIndex(cli bce.Client, logStoreName string) (*IndexFields, error)

DescribeIndex - get specific logStore index info

PARAMS:

  • cli: the client agent which can perform sending request
  • logStoreName: logStore needs to be get

RETURNS:

  • *IndexFields: index mappings info
  • error: nil if success otherwise the specific error

type ListFastQueryResult 

type ListFastQueryResult struct {
	Order      string      `json:"order"`
	OrderBy    string      `json:"orderBy"`
	PageNo     int         `json:"pageNo"`
	PageSize   int         `json:"pageSize"`
	TotalCount int         `json:"totalCount"`
	Result     []FastQuery `json:"result"`
}

func ListFastQuery 

func ListFastQuery(cli bce.Client, args *QueryConditions) (*ListFastQueryResult, error)

ListFastQuery - get all fastQuery info

PARAMS:

  • cli: the client agent which can perform sending request
  • args: query args to get pattern-match fastQuery

RETURNS:

  • *ListFastQueryResult: pattern-match fastQuery result
  • error: nil if success otherwise the specific error

type ListLogShipperCondition added in v0.9.83 

type ListLogShipperCondition struct {
	LogShipperID   string `json:"logShipperID"`
	LogShipperName string `json:"logShipperName"`
	LogStoreName   string `json:"logStoreName"`
	DestType       string `json:"destType"`
	Status         string `json:"status"`
	Order          string `json:"order"`
	OrderBy        string `json:"orderBy"`
	PageNo         int    `json:"pageNo"`
	PageSize       int    `json:"pageSize"`
}

type ListLogStoreResult 

type ListLogStoreResult struct {
	Order      string     `json:"order"`
	OrderBy    string     `json:"orderBy"`
	PageNo     int        `json:"pageNo"`
	PageSize   int        `json:"pageSize"`
	TotalCount int        `json:"totalCount"`
	Result     []LogStore `json:"result"`
}

func ListLogStore 

func ListLogStore(cli bce.Client, args *QueryConditions) (*ListLogStoreResult, error)

ListLogStore - get all pattern-match logStore info

PARAMS:

  • cli: the client agent which can perform sending request
  • args: conditions logStore should match

RETURNS:

  • *ListLogStoreResult: logStore result set
  • error: nil if success otherwise the specific error

type ListLogStreamResult 

type ListLogStreamResult struct {
	Order      string      `json:"order"`
	OrderBy    string      `json:"orderBy"`
	PageNumber int         `json:"pageNo"`
	PageSize   int         `json:"pageSize"`
	TotalCount int         `json:"totalCount"`
	Result     []LogStream `json:"result"`
}

func ListLogStream 

func ListLogStream(cli bce.Client, logStore string, args *QueryConditions) (*ListLogStreamResult, error)

ListLogStream - get all pattern-match logStream in logStore

PARAMS:

  • cli: the client agent which can perform sending request
  • logStore: logStore to parse
  • args: conditions logStream should match

RETURNS:

  • *ListLogStreamResult: pattern-match logStream result set
  • error: nil if success otherwise the specific error

type ListShipperRecordCondition added in v0.9.83 

type ListShipperRecordCondition struct {
	SinceHours int `json:"sinceHours"`
	PageNo     int `json:"pageNo"`
	PageSize   int `json:"pageSize"`
}

type ListShipperRecordResult added in v0.9.83 

type ListShipperRecordResult struct {
	TotalCount int                `json:"totalCount"`
	Result     []LogShipperRecord `json:"result"`
}

func ListLogShipperRecord added in v0.9.83 

func ListLogShipperRecord(cli bce.Client, logShipperID string, args *ListShipperRecordCondition) (*ListShipperRecordResult, error)

ListLogShipperRecord - get logShipper's execution records

PARAMS:

  • cli: the client agent which can perform sending request
  • logShipperID: logShipper to get
  • args: conditions records should match

RETURNS:

  • *ListShipperRecordResult: logShipper records result set
  • error: nil if success otherwise the specific error

type ListShipperResult added in v0.9.83 

type ListShipperResult struct {
	TotalCount int              `json:"totalCount"`
	Result     []ShipperSummary `json:"result"`
}

func ListLogShipper added in v0.9.83 

func ListLogShipper(cli bce.Client, args *ListLogShipperCondition) (*ListShipperResult, error)

ListLogShipper - get all pattern-match logShipper info

PARAMS:

  • cli: the client agent which can perform sending request
  • args: conditions logShipper should match

RETURNS:

  • *ListShipperResult: logShipper result set
  • error: nil if success otherwise the specific error

type LogField 

type LogField struct {
	Type   string              `json:"type"`
	Fields map[string]LogField `json:"fields,omitempty"`
}

type LogRecord 

type LogRecord struct {
	Message   string `json:"message"`
	Timestamp int64  `json:"timestamp"`
	Sequence  int    `json:"sequence"`
}

type LogShipper added in v0.9.83 

type LogShipper struct {
	Status         string             `json:"status"`
	LogShipperName string             `json:"logShipperName"`
	LogStoreName   string             `json:"logStoreName"`
	StartTime      string             `json:"startTime"`
	DestType       string             `json:"destType"`
	DestConfig     *ShipperDestConfig `json:"destConfig"`
}

func GetLogShipper added in v0.9.83 

func GetLogShipper(cli bce.Client, logShipperID string) (*LogShipper, error)

GetLogShipper - get logShipper info

PARAMS:

  • cli: the client agent which can perform sending request
  • logShipperID: logShipper to get

RETURNS:

  • *LogShipper: logShipper info
  • error: nil if success otherwise the specific error

type LogShipperRecord added in v0.9.83 

type LogShipperRecord struct {
	StartTime     string `json:"startTime"`
	EndTime       string `json:"endTime"`
	FinishedCount int    `json:"finishedCount"`
}

type LogStore 

type LogStore struct {
	CreationDateTime DateTime `json:"creationDateTime"`
	LastModifiedTime DateTime `json:"lastModifiedTime"`
	LogStoreName     string   `json:"logStoreName"`
	Retention        int      `json:"retention"`
}

func DescribeLogStore 

func DescribeLogStore(cli bce.Client, logStore string) (*LogStore, error)

DescribeLogStore - get logStore info

PARAMS:

  • cli: the client agent which can perform sending request
  • logStore: logStore to get

RETURNS:

  • *LogStore: logStore info
  • error: nil if success otherwise the specific error

type LogStream 

type LogStream struct {
	CreationDateTime DateTime `json:"creationDateTime"`
	LogStreamName    string   `json:"logStreamName"`
}

type PullLogRecordArgs 

type PullLogRecordArgs struct {
	LogStreamName string   `json:"logStreamName"`
	StartDateTime DateTime `json:"startDatetime"`
	EndDateTime   DateTime `json:"endDateTime"`
	Limit         int      `json:"limit"`
	Marker        string   `json:"marker"`
}

type PullLogRecordResult 

type PullLogRecordResult struct {
	Result      []LogRecord `json:"result"`
	IsTruncated bool        `json:"isTruncated"`
	Marker      string      `json:"marker"`
	NextMarker  string      `json:"nextMarker"`
}

func PullLogRecord 

func PullLogRecord(cli bce.Client, logStore string, args *PullLogRecordArgs) (*PullLogRecordResult, error)

PullLogRecord - get logRecords from logStore

PARAMS:

  • cli: the client agent which can perform sending request
  • logStore: target logStore to get logRecords
  • args: pull logRecords limitation args

RETURNS:

  • *PullLogRecordResult: pull logRecord result set
  • error: nil if success otherwise the specific error

type PushLogRecordBody 

type PushLogRecordBody struct {
	LogStreamName string      `json:"logStreamName"`
	Type          string      `json:"type"`
	LogRecords    []LogRecord `json:"logRecords"`
}

type QueryConditions 

type QueryConditions struct {
	NamePattern string `json:"namePattern"`
	Order       string `json:"order"`
	OrderBy     string `json:"orderBy"`
	PageNo      int    `json:"pageNo"`
	PageSize    int    `json:"pageSize"`
}

type QueryLogRecordArgs 

type QueryLogRecordArgs struct {
	LogStreamName string   `json:"logStreamName"`
	Query         string   `json:"query"`
	StartDateTime DateTime `json:"startDatetime"`
	EndDateTime   DateTime `json:"endDateTime"`
	Limit         int      `json:"limit"`
}

type QueryLogResult 

type QueryLogResult struct {
	ResultSet       *ResultSet       `json:"resultSet"`
	DataSetScanInfo *DataSetScanInfo `json:"dataScanInfo"`
}

func QueryLogRecord 

func QueryLogRecord(cli bce.Client, logStore string, args *QueryLogRecordArgs) (*QueryLogResult, error)

QueryLogRecord - retrieve logRecords from logStore

PARAMS:

  • cli: the client agent which can perform sending request
  • logStore: target logStore to retrieve logRecords
  • args: query logRecords conditions args

RETURNS:

  • *QueryLogResult: query logRecord result set
  • error: nil if success otherwise the specific error

type ResultSet 

type ResultSet struct {
	Columns         []string        `json:"columns"`
	Rows            [][]interface{} `json:"rows"`
	IsTruncated     bool            `json:"isTruncated"`
	TruncatedReason string          `json:"truncatedReason"`
}

type SetSingleShipperStatusCondition added in v0.9.83 

type SetSingleShipperStatusCondition struct {
	DesiredStatus string `json:"desiredStatus"`
}

type ShipperDestConfig added in v0.9.83 

type ShipperDestConfig struct {
	BOSPath                  string `json:"BOSPath"`
	PartitionFormatTS        string `json:"partitionFormatTS"`
	PartitionFormatLogStream bool   `json:"partitionFormatLogStream"`
	MaxObjectSize            int64  `json:"maxObjectSize"`
	CompressType             string `json:"compressType"`
	DeliverInterval          int64  `json:"deliverInterval"`
	StorageFormat            string `json:"storageFormat"`
	CsvHeadline              bool   `json:"csvHeadline"`
	CsvDelimiter             string `json:"csvDelimiter"`
	CsvQuote                 string `json:"csvQuote"`
	NullIdentifier           string `json:"nullIdentifier"`
	SelectedColumnName       string `json:"selectedColumnName"`
	SelectedColumnType       string `json:"selectedColumnType"`
}

type ShipperSummary added in v0.9.83 

type ShipperSummary struct {
	LogShipperID   string `json:"logShipperID"`
	LogShipperName string `json:"logShipperName"`
	LogStoreName   string `json:"logStoreName"`
	DestType       string `json:"destType"`
	Status         string `json:"status"`
	ErrMessage     string `json:"errMessage"`
	CreateDateTime string `json:"createDateTime"`
}

type Statistics 

type Statistics struct {
	ExecutionTimeInMs int        `json:"executionTimeInMs"`
	ScanCount         int        `json:"scanCount"`
	Histogram         *Histogram `json:"histogram"`
}

type UpdateFastQueryBody 

type UpdateFastQueryBody struct {
	Query         string `json:"query"`
	Description   string `json:"description"`
	LogStoreName  string `json:"logStoreName"`
	LogStreamName string `json:"logStreamName"`
}

type UpdateLogShipperBody added in v0.9.83 

type UpdateLogShipperBody struct {
	LogShipperName string             `json:"logShipperName"`
	DestConfig     *ShipperDestConfig `json:"destConfig"`
}

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.