http

Documentation

Overview

Copyright 2020 BlackRock, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• type HTTPTrigger
  • func NewHTTPTrigger(httpClients map[string]*http.Client, sensor *v1alpha1.Sensor, ...) (*HTTPTrigger, error)
  • func (t *HTTPTrigger) ApplyPolicy(ctx context.Context, resource interface{}) error
  • func (t *HTTPTrigger) ApplyResourceParameters(events map[string]*v1alpha1.Event, resource interface{}) (interface{}, error)
  • func (t *HTTPTrigger) Execute(ctx context.Context, events map[string]*v1alpha1.Event, resource interface{}) (interface{}, error)
  • func (t *HTTPTrigger) FetchResource(ctx context.Context) (interface{}, error)
  • func (t *HTTPTrigger) GetTriggerType() apicommon.TriggerType

Types

type HTTPTrigger

type HTTPTrigger struct {
	// Client is http client.
	Client *http.Client
	// Sensor object
	Sensor *v1alpha1.Sensor
	// Trigger reference
	Trigger *v1alpha1.Trigger
	// Logger to log stuff
	Logger *zap.SugaredLogger
}

HTTPTrigger describes the trigger to invoke HTTP request

func NewHTTPTrigger

func NewHTTPTrigger(httpClients map[string]*http.Client, sensor *v1alpha1.Sensor, trigger *v1alpha1.Trigger, logger *zap.SugaredLogger) (*HTTPTrigger, error)

NewHTTPTrigger returns a new HTTP trigger

func (*HTTPTrigger) ApplyPolicy

func (t *HTTPTrigger) ApplyPolicy(ctx context.Context, resource interface{}) error

ApplyPolicy applies policy on the trigger

func (*HTTPTrigger) ApplyResourceParameters

func (t *HTTPTrigger) ApplyResourceParameters(events map[string]*v1alpha1.Event, resource interface{}) (interface{}, error)

ApplyResourceParameters applies parameters to the trigger resource

func (*HTTPTrigger) Execute

func (t *HTTPTrigger) Execute(ctx context.Context, events map[string]*v1alpha1.Event, resource interface{}) (interface{}, error)

Execute executes the trigger

func (*HTTPTrigger) FetchResource

func (t *HTTPTrigger) FetchResource(ctx context.Context) (interface{}, error)

FetchResource fetches the trigger. As the HTTP trigger simply executes a http request, there is no need to fetch any resource from external source

func (*HTTPTrigger) GetTriggerType

func (t *HTTPTrigger) GetTriggerType() apicommon.TriggerType

GetTriggerType returns the type of the trigger