transport

package

v1.5.0 Latest Latest Go to latest Published: Apr 15, 2024 License: Apache-2.0 Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/chronosphereio/chronoctl-core

Links

Open Source Insights

Documentation ¶

Overview ¶

Package transport provides methods to create an HTTP transport that can communicate with the Chronosphere API.

Index ¶

Constants
func New(config RuntimeConfig) (*httptransport.Runtime, error)
type Component
type RuntimeConfig
type VersionHeaderTransport
- func (v VersionHeaderTransport) RoundTrip(req *http.Request) (*http.Response, error)

Constants ¶

View Source

const (

	// OrgNameEnvVar is the name of the environment variable that can be used to set the
	// Chronosphere organization name.
	OrgNameEnvVar = "CHRONOSPHERE_ORG_NAME"
)

Variables ¶

This section is empty.

Functions ¶

func New ¶

func New(config RuntimeConfig) (*httptransport.Runtime, error)

New creates a new HTTP transport that can communicate with the Chronosphere API.

Types ¶

type Component ¶

type Component string

Component is a value that indicates the part of the CLI that is invoking an API. This is used to set the User-Agent header when making requests to the Chronosphere API.

var (
	// ComponentChronoctl is the value for the stable chronoctl component
	ComponentChronoctl Component = "chrono-ctl"
	// ComponentChronoctlUnstable is the value for the unstable chronoctl component
	ComponentChronoctlUnstable Component = "unstable-chrono-ctl"
)

type RuntimeConfig ¶

type RuntimeConfig struct {
	Component          Component
	OrgName            string
	APIToken           string
	APIUrl             string
	InsecureSkipVerify bool
	AllowHTTP          bool
	DefaultBasePath    string
}

RuntimeConfig is a struct that contains the configuration for creating a new HTTP transport

type VersionHeaderTransport ¶

type VersionHeaderTransport struct {
	Rt http.RoundTripper
	// contains filtered or unexported fields
}

VersionHeaderTransport is a RoundTripper that adds a User-Agent header to all requests.

func (VersionHeaderTransport) RoundTrip ¶

func (v VersionHeaderTransport) RoundTrip(req *http.Request) (*http.Response, error)

RoundTrip implements the RoundTripper interface.

Source Files ¶

View all Source files

transport.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL