postsecret

package
v8.13.1 Latest Latest
Warning

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

Go to latest
Published: Apr 11, 2024 License: Apache-2.0 Imports: 9 Imported by: 1

Documentation

Overview

Creates a secret stored by Fleet.

Index

Constants

This section is empty.

Variables

View Source
var ErrBuildPath = errors.New("cannot build path, check for missing path parameters")

ErrBuildPath is returned in case of missing parameters within the build of the request.

Functions

This section is empty.

Types

type NewPostSecret

type NewPostSecret func() *PostSecret

NewPostSecret type alias for index.

func NewPostSecretFunc

func NewPostSecretFunc(tp elastictransport.Interface) NewPostSecret

NewPostSecretFunc returns a new instance of PostSecret with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type PostSecret

type PostSecret struct {
	// contains filtered or unexported fields
}

func New

Creates a secret stored by Fleet.

func (PostSecret) Do

func (r PostSecret) Do(ctx context.Context) (bool, error)

Do runs the request through the transport, handle the response and returns a postsecret.Response

func (*PostSecret) Header

func (r *PostSecret) Header(key, value string) *PostSecret

Header set a key, value pair in the PostSecret headers map.

func (*PostSecret) HttpRequest

func (r *PostSecret) HttpRequest(ctx context.Context) (*http.Request, error)

HttpRequest returns the http.Request object built from the given parameters.

func (PostSecret) IsSuccess

func (r PostSecret) IsSuccess(providedCtx context.Context) (bool, error)

IsSuccess allows to run a query with a context and retrieve the result as a boolean. This only exists for endpoints without a request payload and allows for quick control flow.

func (PostSecret) Perform

func (r PostSecret) Perform(providedCtx context.Context) (*http.Response, error)

Perform runs the http.Request through the provided transport and returns an http.Response.

Jump to

Keyboard shortcuts

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