clients

Documentation

Overview

Package clients contains 'smart' clients for the Dynatrace API.

These clients are generally based on those found in package api/clients, but implement logic to ensure the Dynatrace API can be used for configuration-as-code use-cases reliably.

For the underlying clients see package github.com/dynatrace/dynatrace-configuration-as-code-core/api/clients.

In general, whereas the CRUD api/clients make a single API call per operation, the ones in this package make several and react to API responses as needed.

For example, the clients in this package will resolve and follow pagination in their List methods, whereas an api/clients implementation requires/allows the user to handle pagination and make several requests on their own.

Clients implement the following methods:

• Get
• List
• Create
• Update
• Upsert (Create or Update as needed)
• Delete

A clients.Factory simplifies creation of clients.

Index

• Variables
• func Factory() factory

Variables

var ErrAccessTokenMissing = errors.New("no access token provided")

ErrAccessTokenMissing indicates that no access token was provided.

var ErrAccountURLMissing = errors.New("no account API URL provided")

ErrAccountURLMissing indicates that no account API URL was provided.

var ErrClassicURLMissing = errors.New("no classic API URL provided")

ErrClassicURLMissing indicates that no classic API URL was provided.

var ErrOAuthCredentialsMissing = errors.New("no OAuth2 client credentials provided")

ErrOAuthCredentialsMissing indicates that no OAuth2 client credentials were provided.

var ErrPlatformURLMissing = errors.New("no platform API URL provided")

ErrPlatformURLMissing indicates that no platform API URL was provided.

Functions

func Factory

func Factory() factory

Factory creates a factory-like component that is used to create API client instances.