sdk

Mar 29, 2024

Changes in this version

+ func PrintObject(object manifest.Object, out io.Writer, format manifest.ObjectFormat) error

+ func PrintObjects(objects []manifest.Object, out io.Writer, format manifest.ObjectFormat) error

Mar 27, 2024

Changes in this version

type Client

+ func (c *Client) GetUser(ctx context.Context) (string, error)

Dec 21, 2023

Changes in this version

type Client

+ func (c *Client) AuthData() authdata.Versions

+ func (c *Client) Do(req *http.Request) (*http.Response, error)

+ func (c *Client) Objects() objects.Versions

Dec 19, 2023

Changes in this version

type Client

+ func (c *Client) GetDataExportIAMRoleIDs(ctx context.Context) (*models.IAMRoleIDs, error)

+ func (c *Client) GetDirectIAMRoleIDs(ctx context.Context, project, directName string) (*models.IAMRoleIDs, error)

Nov 15, 2023

Changes in this version

type Client

+ func (c *Client) GetAWSIAMRoleAuthExternalIDs(ctx context.Context, directName string) (*v1alpha.AWSIAMRoleAuthExternalIDs, error)

Nov 13, 2023

Changes in this version

type Client

+ func (c *Client) WithDryRun() *Client

Sep 12, 2023

Changes in this version

type Config

+ Organization string

type ContextConfig

+ Organization string

Aug 25, 2023

Changes in this version

+ const APIVersionRegex

+ var ErrInvalidFile = errors.Errorf("valid Nobl9 resource definition must match against the following regex: '%s'", ...)

+ var ErrInvalidObjectSourceType = fmt.Errorf("not a valid ObjectSourceType, try [%s]", ...)

+ var ErrInvalidSourceType = errors.New("invalid ObjectSourceType provided")

+ var ErrIoReaderIsNil = errors.New("io.Reader must no be nil")

+ var ErrNoDefinitionsFound = errors.New("no definitions in input")

+ var ErrNoFilesInPath = errors.Errorf("no Nobl9 resource definition files were found under selected path, %s", ...)

+ var ErrNoFilesMatchingPattern = errors.Errorf("no Nobl9 resource definition files matched the provided path pattern, %s", ...)

+ var ErrSourceTypeReaderPath = errors.New(...)

+ func DecodeObject[T manifest.Object](data []byte) (object T, err error)

+ func DecodeObjects(data []byte) ([]manifest.Object, error)

+ func GetSupportedFileExtensions() []string

+ func ObjectSourceTypeNames() []string

+ func ReadObjects(ctx context.Context, rawSources ...RawObjectSource) ([]manifest.Object, error)

+ func ReadObjectsFromSources(ctx context.Context, sources ...*ObjectSource) ([]manifest.Object, error)

+ type ObjectSource struct

+ Paths []string

+ Raw RawObjectSource

+ Reader io.Reader

+ Type ObjectSourceType

+ func NewObjectSourceReader(r io.Reader, source RawObjectSource) *ObjectSource

+ func ResolveObjectSource(rawSource RawObjectSource) (src *ObjectSource, err error)

+ func ResolveObjectSources(rawSources ...RawObjectSource) ([]*ObjectSource, error)

+ func (o ObjectSource) String() string

+ type ObjectSourceType int

+ const ObjectSourceTypeDirectory

+ const ObjectSourceTypeFile

+ const ObjectSourceTypeGlobPattern

+ const ObjectSourceTypeReader

+ const ObjectSourceTypeURL

+ func ParseObjectSourceType(name string) (ObjectSourceType, error)

+ func (x ObjectSourceType) IsValid() bool

+ func (x ObjectSourceType) String() string

+ type RawObjectSource = string

Aug 23, 2023

Changes in this version

+ const EnvPrefix

+ func GetDefaultConfigPath() (string, error)

type Client

+ Config *Config

+ func (c *Client) GetOrganization(ctx context.Context) (string, error)

+ func (c *Client) SetUserAgent(userAgent string)

+ type Config struct

+ AccessToken string

+ ClientID string

+ ClientSecret string

+ DisableOkta bool

+ FilesPromptEnabled bool

+ FilesPromptThreshold int

+ OktaAuthServer string

+ OktaOrgURL *url.URL

+ Project string

+ Timeout time.Duration

+ URL *url.URL

+ func ReadConfig(options ...ConfigOption) (*Config, error)

+ func (c *Config) GetCurrentContext() string

+ func (c *Config) GetFileConfig() FileConfig

+ func (c *Config) Verify() error

+ type ConfigOption func(conf *Config)

+ func ConfigOptionEnvPrefix(prefix string) ConfigOption

+ func ConfigOptionFilePath(path string) ConfigOption

+ func ConfigOptionNoConfigFile() ConfigOption

+ func ConfigOptionUseContext(context string) ConfigOption

+ func ConfigOptionWithCredentials(clientID, clientSecret string) ConfigOption

+ type ContextConfig struct

+ AccessToken string

+ ClientID string

+ ClientSecret string

+ DisableOkta *bool

+ OktaAuthServer string

+ OktaOrgURL string

+ Project string

+ Timeout *time.Duration

+ URL string

+ type ContextlessConfig struct

+ DefaultContext string

+ FilesPromptEnabled *bool

+ FilesPromptThreshold *int

+ type FileConfig struct

+ Contexts map[string]ContextConfig

+ func (f *FileConfig) GetPath() string

+ func (f *FileConfig) Load(path string) error

+ func (f *FileConfig) Save(path string) (err error)

Aug 21, 2023

Changes in this version

type Client

+ func (c *Client) CreateRequest(ctx context.Context, method, endpoint, project string, q url.Values, ...) (*http.Request, error)

Aug 11, 2023

Changes in this version

+ var ErrConcurrencyIssue = errors.New("operation failed due to concurrency issue but can be retried")

Jul 17, 2023

Changes in this version

+ var ErrClientBuilderMissingCredentials = errors.New(...)

+ func DefaultOktaAuthServerURL() (*url.URL, error)

+ func OktaAuthServerURL(oktaOrgURL, oktaAuthServer string) (*url.URL, error)

type ClientBuilder

+ func (b *ClientBuilder) WithOktaAuthServerURL(u *url.URL) *ClientBuilder

Jul 5, 2023

Changes in this version

type Kind

+ const KindUserGroup

Jun 22, 2023

Changes in this version

type Kind

+ func ParseKind(name string) (Kind, error)

+ func (x Kind) IsValid() bool

Jun 20, 2023

Changes in this version

+ var ErrInvalidKind = errors.New("invalid object Kind")

type Kind

+ func (k Kind) ToLower() string

Jun 5, 2023

Changes in this version

+ func IsValidKind(kind Kind) bool

+ type Kind string

+ const KindAgent

+ const KindAlert

+ const KindAlertMethod

+ const KindAlertPolicy

+ const KindAlertSilence

+ const KindAnnotation

+ const KindDataExport

+ const KindDirect

+ const KindGroup

+ const KindMetricSource

+ const KindProject

+ const KindRoleBinding

+ const KindSLO

+ const KindSLOErrorBudgetStatus

+ const KindService

+ const KindUsageSummary

+ func KindFromString(s string) Kind

+ func (k Kind) String() string

Apr 25, 2023

Changes in this version

+ const HeaderTraceID

+ func OktaAuthServer(oktaOrgURL, oktaAuthServer string) (*url.URL, error)

+ func OktaKeysEndpoint(authServerURL *url.URL) *url.URL

+ func OktaTokenEndpoint(authServerURL *url.URL) *url.URL

+ type AccessTokenParser interface

+ Parse func(token, clientID string) (jwt.MapClaims, error)

+ type AccessTokenPostRequestHook = func(token string) error

+ type AccessTokenProvider interface

+ RequestAccessToken func(ctx context.Context, clientID, clientSecret string) (token string, err error)

type Client

+ Credentials *Credentials

+ HTTP *http.Client

+ func DefaultClient(clientID, clientSecret, oktaOrgURL, oktaAuthServer, userAgent string) (*Client, error)

+ func (c *Client) GetApiURL() url.URL

+ func (c *Client) GetObjects(ctx context.Context, project string, object Object, ...) ([]AnyJSONObj, error)

+ func (c *Client) GetObjectsWithParams(ctx context.Context, project string, object Object, q url.Values) (response Response, err error)

+ func (c *Client) SetAccessToken(token string) error

+ func (c *Client) SetApiURL(u string) error

+ type ClientBuilder struct

+ func NewClientBuilder(userAgent string) *ClientBuilder

+ func (b *ClientBuilder) Build() (*Client, error)

+ func (b *ClientBuilder) WithApiURL(apiURL string) *ClientBuilder

+ func (b *ClientBuilder) WithCredentials(credentials *Credentials) *ClientBuilder

+ func (b *ClientBuilder) WithDefaultCredentials(oktaOrgURL, oktaAuthServer, clientID, clientSecret string) *ClientBuilder

+ func (b *ClientBuilder) WithHTTPClient(client *http.Client) *ClientBuilder

+ func (b *ClientBuilder) WithOfflineMode() *ClientBuilder

+ func (b *ClientBuilder) WithTimeout(timeout time.Duration) *ClientBuilder

+ type Credentials struct

+ AccessToken string

+ ClientID string

+ ClientSecret string

+ Environment string

+ HTTP *http.Client

+ Organization string

+ PostRequestHook AccessTokenPostRequestHook

+ TokenParser AccessTokenParser

+ TokenProvider AccessTokenProvider

+ func DefaultCredentials(clientID, clientSecret string, authServerURL *url.URL) (*Credentials, error)

+ func (creds *Credentials) RefreshAccessToken(ctx context.Context) (updated bool, err error)

+ func (creds *Credentials) RoundTrip(req *http.Request) (*http.Response, error)

+ func (creds *Credentials) SetAccessToken(token string) error

+ func (creds *Credentials) SetAuthorizationHeader(r *http.Request)

+ func (creds *Credentials) SetOfflineMode()

+ type JWTParser struct

+ HTTP *http.Client

+ func NewJWTParser(issuer string, jwkFetchURL *url.URL) (*JWTParser, error)

+ func (a *JWTParser) Parse(token, clientID string) (jwt.MapClaims, error)

+ type OktaClient struct

+ HTTP *http.Client

+ func NewOktaClient(authServerURL *url.URL) *OktaClient

+ func (okta *OktaClient) RequestAccessToken(ctx context.Context, clientID, clientSecret string) (token string, err error)

Apr 19, 2023

Changes in this version

+ const ObjectDefaultURI

+ const ObjectGroupSpecifiedURI

+ func GetObjectSpecifiedURI(o Object) string

+ func HasObjectSpecifiedURI(o Object) bool

+ func ObjectsSpecifiedURIs() map[Object]string

+ func ResolveObjectURI(o Object) string

type Object

+ const ObjectGroup

Mar 29, 2023

Changes in this version

+ const HeaderTruncatedLimitMax

+ const QueryKeyAlertPolicy

+ const QueryKeyObjective

+ const QueryKeyObjectiveValue

+ const QueryKeyResolved

+ const QueryKeyTriggered

type Client

+ func (c *Client) GetObjectWithParams(ctx context.Context, object Object, queryParams ...map[string][]string) (response Response, err error)

+ type Response struct

+ Objects []AnyJSONObj

+ TruncatedMax int

Feb 24, 2023

Changes in this version

type Client

+ func (c *Client) Project() string

+ func (c *Client) SetProject(project string)

Jan 18, 2023

Changes in this version

+ const QueryKeySystemAnnotations

+ const QueryKeyUserAnnotations

Nov 16, 2022

Changes in this version

+ const QueryKeyDryRun

+ const QueryKeyServiceName

Nov 9, 2022

Changes in this version

+ const QueryKeyTextSearch

Jul 28, 2022

Changes in this version

type Object

+ const ObjectAlertSilence

Jul 6, 2022

Changes in this version

type Client

+ func (c *Client) GetAgentCredentials(agentsName string) (M2MAppCredentials, error)

+ type M2MAppCredentials struct

+ ClientID string

+ ClientSecret string

Jul 1, 2022

Changes in this version

+ const DefaultProject

+ const HeaderAuthorization

+ const HeaderClientID

+ const HeaderOrganization

+ const HeaderProject

+ const HeaderUserAgent

+ const ProjectsWildcard

+ const QueryKeyFrom

+ const QueryKeyLabelsFilter

+ const QueryKeyName

+ const QueryKeyPercentiles

+ const QueryKeyPermissionFilter

+ const QueryKeySeries

+ const QueryKeySlo

+ const QueryKeySteps

+ const QueryKeyTime

+ const QueryKeyTimeWindow

+ const QueryKeyTo

+ const QueryServiceName

+ const Timeout

+ func IsObjectAvailable(o Object) bool

+ type AnyJSONObj = map[string]interface

+ func Annotate(object AnyJSONObj, annotations map[string]string, project string, ...) (AnyJSONObj, error)

+ type Client struct

+ func NewClient(ingestURL, intakeURL, organization, project, userAgent string, ...) (Client, error)

+ func NewClientWithTimeout(ingestURL, intakeURL, organization, project, userAgent string, ...) (Client, error)

+ func (c *Client) ApplyObjects(objects []AnyJSONObj) error

+ func (c *Client) DeleteObjects(objects []AnyJSONObj) error

+ func (c *Client) DeleteObjectsByName(object Object, names ...string) error

+ func (c *Client) GetAWSExternalID() (string, error)

+ func (c *Client) GetObject(object Object, timestamp string, filterLabel map[string][]string, ...) ([]AnyJSONObj, error)

+ func (c *Client) Organization() string

+ func (c *Client) PostMetrics(ctx context.Context, points models.Points, accessToken string) error

+ func (c *Client) SetAuth(authorization string)

+ func (c *Client) SetOrganization(organization string)

+ func (c Client) Authorization() string

+ func (c Client) UserAgent() string

+ type Object string

+ const ObjectAgent

+ const ObjectAlert

+ const ObjectAlertMethod

+ const ObjectAlertPolicy

+ const ObjectAnnotation

+ const ObjectDataExport

+ const ObjectDirect

+ const ObjectIntegration

+ const ObjectMetricSource

+ const ObjectProject

+ const ObjectRoleBinding

+ const ObjectSLO

+ const ObjectSLOErrorBudgetStatus

+ const ObjectService

+ const ObjectUsageSummary

+ func ObjectName(apiObject string) Object

+ func (o Object) String() string

+ type Operation int

+ const Get

+ const Reports

+ const TimeSeries

+ func ParseOperation(val string) (Operation, error)

+ func (operation Operation) String() string