cli

Documentation

Index

• func CreateAction(portClient *PortClient, action port.Action) (*port.Action, error)
• func CreateBlueprint(portClient *PortClient, blueprint port.Blueprint) (*port.Blueprint, error)
• func DeleteAction(portClient *PortClient, actionIdentifier string) error
• func DeleteBlueprint(portClient *PortClient, blueprintIdentifier string) error
• func GetAction(portClient *PortClient, actionIdentifier string) (*port.Action, error)
• func GetBlueprint(portClient *PortClient, blueprintIdentifier string) (*port.Blueprint, error)
• func PatchBlueprint(portClient *PortClient, blueprint port.Blueprint) (*port.Blueprint, error)
• func UpdateAction(portClient *PortClient, action port.Action) (*port.Action, error)
• 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) CreateIntegration(i *port.Integration) (*port.Integration, error)
  • func (c *PortClient) CreatePage(p port.Page) error
  • func (c *PortClient) CreateScorecard(blueprintIdentifier string, scorecard port.Scorecard) (*port.Scorecard, error)
  • func (c *PortClient) DeleteEntity(ctx context.Context, id string, blueprint string, deleteDependents bool) error
  • func (c *PortClient) DeleteIntegration(stateKey string) error
  • func (c *PortClient) DeletePage(identifier string) error
  • func (c *PortClient) DeleteStaleEntities(ctx context.Context, stateKey string, ...) error
  • func (c *PortClient) GetEntityIdentifierKey(portEntity *port.Entity) string
  • func (c *PortClient) GetIntegration(stateKey string) (*port.Integration, error)
  • func (c *PortClient) GetKafkaCredentials() (*port.OrgKafkaCredentials, error)
  • func (c *PortClient) GetOrgId() (string, error)
  • func (c *PortClient) GetPage(identifier string) (*port.Page, error)
  • func (c *PortClient) PatchIntegration(stateKey string, integration *port.Integration) error
  • 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)

Functions

func CreateAction

func CreateAction(portClient *PortClient, action port.Action) (*port.Action, error)

func CreateBlueprint

func CreateBlueprint(portClient *PortClient, blueprint port.Blueprint) (*port.Blueprint, error)

func DeleteAction

func DeleteAction(portClient *PortClient, actionIdentifier string) error

func DeleteBlueprint

func DeleteBlueprint(portClient *PortClient, blueprintIdentifier string) error

func GetAction

func GetAction(portClient *PortClient, actionIdentifier string) (*port.Action, error)

func GetBlueprint

func GetBlueprint(portClient *PortClient, blueprintIdentifier string) (*port.Blueprint, error)

func PatchBlueprint

func PatchBlueprint(portClient *PortClient, blueprint port.Blueprint) (*port.Blueprint, error)

func UpdateAction

func UpdateAction(portClient *PortClient, action port.Action) (*port.Action, 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) CreateIntegration

func (c *PortClient) CreateIntegration(i *port.Integration) (*port.Integration, error)

func (*PortClient) CreatePage

func (c *PortClient) CreatePage(p port.Page) error

func (*PortClient) CreateScorecard

func (c *PortClient) CreateScorecard(blueprintIdentifier string, scorecard port.Scorecard) (*port.Scorecard, error)

func (*PortClient) DeleteEntity

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

func (*PortClient) DeleteIntegration

func (c *PortClient) DeleteIntegration(stateKey string) error

func (*PortClient) DeletePage

func (c *PortClient) DeletePage(identifier string) 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) GetIntegration

func (c *PortClient) GetIntegration(stateKey string) (*port.Integration, error)

func (*PortClient) GetKafkaCredentials

func (c *PortClient) GetKafkaCredentials() (*port.OrgKafkaCredentials, error)

func (*PortClient) GetOrgId

func (c *PortClient) GetOrgId() (string, error)

func (*PortClient) GetPage

func (c *PortClient) GetPage(identifier string) (*port.Page, error)

func (*PortClient) PatchIntegration

func (c *PortClient) PatchIntegration(stateKey string, integration *port.Integration) error

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)