Documentation
¶
Overview ¶
Retrieves information of all service credentials for a service account.
Index ¶
- Variables
- type GetServiceCredentials
- func (r GetServiceCredentials) Do(providedCtx context.Context) (*Response, error)
- func (r *GetServiceCredentials) Header(key, value string) *GetServiceCredentials
- func (r *GetServiceCredentials) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r GetServiceCredentials) IsSuccess(providedCtx context.Context) (bool, error)
- func (r GetServiceCredentials) Perform(providedCtx context.Context) (*http.Response, error)
- type NewGetServiceCredentials
- type Response
Constants ¶
This section is empty.
Variables ¶
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 GetServiceCredentials ¶
type GetServiceCredentials struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetServiceCredentials
Retrieves information of all service credentials for a service account.
func (GetServiceCredentials) Do ¶
func (r GetServiceCredentials) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a getservicecredentials.Response
func (*GetServiceCredentials) Header ¶
func (r *GetServiceCredentials) Header(key, value string) *GetServiceCredentials
Header set a key, value pair in the GetServiceCredentials headers map.
func (*GetServiceCredentials) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (GetServiceCredentials) IsSuccess ¶
func (r GetServiceCredentials) 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.
type NewGetServiceCredentials ¶
type NewGetServiceCredentials func(namespace, service string) *GetServiceCredentials
NewGetServiceCredentials type alias for index.
func NewGetServiceCredentialsFunc ¶
func NewGetServiceCredentialsFunc(tp elastictransport.Interface) NewGetServiceCredentials
NewGetServiceCredentialsFunc returns a new instance of GetServiceCredentials with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Response ¶ added in v8.7.0
type Response struct {
Count int `json:"count"`
// NodesCredentials Contains service account credentials collected from all nodes of the cluster
NodesCredentials types.NodesCredentials `json:"nodes_credentials"`
ServiceAccount string `json:"service_account"`
Tokens map[string]types.Metadata `json:"tokens"`
}
Response holds the response body struct for the package getservicecredentials
Source Files