cli

Documentation

Index

• type Option
  • func WithClientID(clientID string) Option
  • func WithClientSecret(clientSecret string) Option
  • func WithCreateMissingRelatedEntities(createMissingRelatedEntities bool) Option
  • func WithDeleteDependents(deleteDependents bool) Option
  • func WithHeader(key, val string) Option
• type PortClient
  • func New(baseURL string, opts ...Option) (*PortClient, error)
  • func (c *PortClient) Authenticate(ctx context.Context, clientID, clientSecret string) (string, error)
  • func (c *PortClient) CreateEntity(ctx context.Context, e *port.Entity, runID string, ...) (*port.Entity, error)
  • func (c *PortClient) DeleteEntity(ctx context.Context, id string, blueprint string, deleteDependents bool) error
  • func (c *PortClient) DeleteStaleEntities(ctx context.Context, stateKey string, ...) error
  • func (c *PortClient) GetEntityIdentifierKey(portEntity *port.Entity) string
  • func (c *PortClient) ReadEntity(ctx context.Context, id string, blueprint string) (*port.Entity, error)
  • func (c *PortClient) SearchEntities(ctx context.Context, body port.SearchBody) ([]port.Entity, error)

Types

type Option

type Option func(*PortClient)

func WithClientID

func WithClientID(clientID string) Option

func WithClientSecret

func WithClientSecret(clientSecret string) Option

func WithCreateMissingRelatedEntities

func WithCreateMissingRelatedEntities(createMissingRelatedEntities bool) Option

func WithDeleteDependents

func WithDeleteDependents(deleteDependents bool) Option

func WithHeader

func WithHeader(key, val string) Option

type PortClient

type PortClient struct {
	Client                       *resty.Client
	ClientID                     string
	ClientSecret                 string
	DeleteDependents             bool
	CreateMissingRelatedEntities bool
}

func New

func New(baseURL string, opts ...Option) (*PortClient, error)

func (*PortClient) Authenticate

func (c *PortClient) Authenticate(ctx context.Context, clientID, clientSecret string) (string, error)

func (*PortClient) CreateEntity

func (c *PortClient) CreateEntity(ctx context.Context, e *port.Entity, runID string, createMissingRelatedEntities bool) (*port.Entity, error)

func (*PortClient) DeleteEntity

func (c *PortClient) DeleteEntity(ctx context.Context, id string, blueprint string, deleteDependents bool) error

func (*PortClient) DeleteStaleEntities

func (c *PortClient) DeleteStaleEntities(ctx context.Context, stateKey string, existingEntitiesSet map[string]interface{}) error

func (*PortClient) GetEntityIdentifierKey

func (c *PortClient) GetEntityIdentifierKey(portEntity *port.Entity) string

func (*PortClient) ReadEntity

func (c *PortClient) ReadEntity(ctx context.Context, id string, blueprint string) (*port.Entity, error)

func (*PortClient) SearchEntities

func (c *PortClient) SearchEntities(ctx context.Context, body port.SearchBody) ([]port.Entity, error)