models

Documentation

Index

• Variables
• func BusinessAttributeUpdateBehavior(value string) businessAttributeUpdateBehavior
• func MarshalEntity(entity *Entity) ([]byte, error)
• type AtlasAssignmentStatus
• type AtlasClassification
  • func (s AtlasClassification) UnmarshalJson(data []byte) (*AtlasClassification, error)
• type AtlasClassifications
  • func (s AtlasClassifications) UnmarshalJson(data []byte) (*AtlasClassifications, error)
• type AtlasEntityHeader
  • func (s AtlasEntityHeader) UnmarshalJson(data []byte) (*AtlasEntityHeader, error)
• type AtlasEntityWithExtInfo
  • func (s AtlasEntityWithExtInfo) UnmarshalJson(data []byte) (*AtlasEntityWithExtInfo, error)
• type AtlasTermAssignmentHeader
• type AutoCompleteRequest
• type AutoCompleteResult
  • func (a AutoCompleteResult) UnmarshalJson(data []byte) (*AutoCompleteResult, error)
• type AutoCompleteResultValue
• type BrowseRequest
• type BrowseResult
  • func (a BrowseResult) UnmarshalJson(data []byte) (*BrowseResult, error)
• type BrowseResultOwner
• type BrowseResultValue
• type BulkImportResponse
  • func (s BulkImportResponse) UnmarshalJson(data []byte) (*BulkImportResponse, error)
• type ContactSearchResultValue
• type Entity
  • func UnmarshalEntity(data []byte) (*Entity, error)
• type EntityCreateOrUpdateBulkRequest
  • func (s *EntityCreateOrUpdateBulkRequest) MarshalJson() ([]byte, error)
• type EntityCreateOrUpdateRequest
  • func (s *EntityCreateOrUpdateRequest) MarshalJson() ([]byte, error)
• type EntityMutationResponse
  • func (s EntityMutationResponse) UnmarshalJson(data []byte) (*EntityMutationResponse, error)
• type ErrorResponse
  • func (e ErrorResponse) UnmarshalJson(data []byte) (*ErrorResponse, error)
• type ImportInfo
• type QueryAttribute
  • func (q *QueryAttribute) Encode() string
  • func (q *QueryAttribute) EncodeIdx(idx int) string
• type QueryAttributes
  • func (q *QueryAttributes) Encode() string
  • func (q *QueryAttributes) EncodeASC() string
  • func (q *QueryAttributes) ToUrlValues() url.Values
• type QueryParams
  • func (qp *QueryParams) BusinessAttributeUpdateBehavior(value businessAttributeUpdateBehavior)
  • func (qp *QueryParams) Encode(allowedParams map[string]bool) string
  • func (qp *QueryParams) IgnoreRelationships(value string)
  • func (qp *QueryParams) IsOverwrite(value string)
  • func (qp *QueryParams) MinExtInfo(value string)
• type QueryRequest
• type SearchFacetItem
• type SearchFacetItemValue
• type SearchFacetResultValue
• type SearchHighlights
• type SearchResult
  • func (a SearchResult) UnmarshalJson(data []byte) (*SearchResult, error)
• type SearchResultValue
• type Status
• type SuggestRequest
• type SuggestResult
  • func (a SuggestResult) UnmarshalJson(data []byte) (*SuggestResult, error)
• type SuggestResultValue
• type TaxonomySetting
• type TermSearchResultValue
• type TimeBoundary

Variables

var (
	EmptyGuidError       = errors.New("guid is empty")
	ClassificationsError = errors.New("classification is nil")
	NoDataProvidedError  = errors.New("no data provided")
	NoAttributesProvided = errors.New("no attributes provided")
	EmptyTypeNameError   = errors.New("typeName is empty")
)

Functions

func BusinessAttributeUpdateBehavior

func BusinessAttributeUpdateBehavior(value string) businessAttributeUpdateBehavior

func MarshalEntity

func MarshalEntity(entity *Entity) ([]byte, error)

Types

type AtlasAssignmentStatus

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

type AtlasClassification

type AtlasClassification struct {
	Attributes                       map[string]interface{} `json:"attributes,omitempty"`
	EntityGuid                       string                 `json:"entityGuid,omitempty"`
	EntityStatus                     Status                 `json:"entityStatus,omitempty"`
	LastModifiedTS                   string                 `json:"lastModifiedTS,omitempty"`
	RemovePropagationsOnEntityDelete bool                   `json:"removePropagationsOnEntityDelete,omitempty"`
	Source                           string                 `json:"source,omitempty"`
	TypeName                         string                 `json:"typeName,omitempty"`
	ValidityPeriods                  []TimeBoundary         `json:"validityPeriods,omitempty"`
}

func (AtlasClassification) UnmarshalJson

func (s AtlasClassification) UnmarshalJson(data []byte) (
	*AtlasClassification,
	error,
)

type AtlasClassifications

type AtlasClassifications struct {
	List       []AtlasClassification `json:"list,omitempty"`
	PageSize   int                   `json:"pageSize,omitempty"`
	SortBy     string                `json:"sortBy,omitempty"`
	SortType   string                `json:"sortType,omitempty"`
	StartIndex int                   `json:"startIndex,omitempty"`
	TotalCount int                   `json:"totalCount,omitempty"`
}

func (AtlasClassifications) UnmarshalJson

func (s AtlasClassifications) UnmarshalJson(data []byte) (
	*AtlasClassifications,
	error,
)

type AtlasEntityHeader

type AtlasEntityHeader struct {
	Attributes          map[string]interface{}      `json:"attributes,omitempty"`
	ClassificationNames []string                    `json:"classificationNames,omitempty"`
	Classifications     []AtlasClassification       `json:"classifications,omitempty"`
	DisplayText         string                      `json:"displayText,omitempty"`
	Guid                string                      `json:"guid,omitempty"`
	IsIncomplete        bool                        `json:"isIncomplete,omitempty"`
	Labels              []string                    `json:"labels,omitempty"`
	LastModifiedTS      string                      `json:"lastModifiedTS,omitempty"`
	MeaningNames        []string                    `json:"meaningNames,omitempty"`
	Meanings            []AtlasTermAssignmentHeader `json:"meanings,omitempty"`
	Status              Status                      `json:"status,omitempty"`
	TypeName            string                      `json:"typeName,omitempty"`
}

func (AtlasEntityHeader) UnmarshalJson

func (s AtlasEntityHeader) UnmarshalJson(data []byte) (
	*AtlasEntityHeader,
	error,
)

type AtlasEntityWithExtInfo

type AtlasEntityWithExtInfo struct {
	Entity           Entity                 `json:"entity,omitempty"`
	ReferredEntities map[string]interface{} `json:"referredEntities,omitempty"`
}

func (AtlasEntityWithExtInfo) UnmarshalJson

func (s AtlasEntityWithExtInfo) UnmarshalJson(data []byte) (
	*AtlasEntityWithExtInfo,
	error,
)

type AtlasTermAssignmentHeader

type AtlasTermAssignmentHeader struct {
	Confidence   int                   `json:"confidence,omitempty"`
	CreatedBy    string                `json:"createdBy,omitempty"`
	Description  string                `json:"description,omitempty"`
	DisplayText  string                `json:"displayText,omitempty"`
	Expression   string                `json:"expression,omitempty"`
	RelationGuid string                `json:"relationGuid,omitempty"`
	Source       string                `json:"source,omitempty"`
	Status       AtlasAssignmentStatus `json:"status,omitempty"`
	Steward      string                `json:"steward,omitempty"`
	TermGuid     string                `json:"termGuid,omitempty"`
}

type AutoCompleteRequest

type AutoCompleteRequest struct {
	Filter   map[string]interface{} `json:"filter,omitempty"`
	KeyWords string                 `json:"keywords,omitempty"`
	Limit    int                    `json:"limit,omitempty"`
}

type AutoCompleteResult

type AutoCompleteResult struct {
	Value AutoCompleteResultValue `json:"value,omitempty"`
}

func (AutoCompleteResult) UnmarshalJson

func (a AutoCompleteResult) UnmarshalJson(data []byte) (
	*AutoCompleteResult,
	error,
)

type AutoCompleteResultValue

type AutoCompleteResultValue struct {
	QueryPlusText string `json:"queryPlusText,omitempty"`
	Text          string `json:"text,omitempty"`
}

type BrowseRequest

type BrowseRequest struct {
	EntityType string `json:"entityType,omitempty"`
	Limit      int    `json:"limit,omitempty"`
	Offset     int    `json:"offset,omitempty"`
	Path       string `json:"path,omitempty"`
}

type BrowseResult

type BrowseResult struct {
	SearchCount int                 `json:"@search.count,omitempty"`
	Value       []BrowseResultValue `json:"value,omitempty"`
}

func (BrowseResult) UnmarshalJson

func (a BrowseResult) UnmarshalJson(data []byte) (
	*BrowseResult,
	error,
)

type BrowseResultOwner

type BrowseResultOwner struct {
	ContactType string `json:"contactType,omitempty"`
	DisplayName string `json:"displayName,omitempty"`
	Id          string `json:"id,omitempty"`
	Mail        string `json:"mail,omitempty"`
}

type BrowseResultValue

type BrowseResultValue struct {
	EntityType    string              `json:"entityType,omitempty"`
	Id            string              `json:"id,omitempty"`
	IsLeaf        bool                `json:"isLeaf,omitempty"`
	Name          string              `json:"name,omitempty"`
	Owner         []BrowseResultOwner `json:"owner,omitempty"`
	Path          string              `json:"path,omitempty"`
	QualifiedName string              `json:"qualifiedName,omitempty"`
}

type BulkImportResponse

type BulkImportResponse struct {
	FailedImportInfoList  []ImportInfo `json:"failedImportInfoList,omitempty"`
	SuccessImportInfoList []ImportInfo `json:"successImportInfo,omitempty"`
}

func (BulkImportResponse) UnmarshalJson

func (s BulkImportResponse) UnmarshalJson(data []byte) (
	*BulkImportResponse,
	error,
)

type ContactSearchResultValue

type ContactSearchResultValue struct {
	ContactType string `json:"contactType,omitempty"`
	Id          string `json:"id,omitempty"`
	Info        string `json:"info,omitempty"`
}

type Entity

type Entity struct {
	Attributes             map[string]interface{}      `json:"attributes,omitempty"`
	BusinessAttributes     map[string]interface{}      `json:"businessAttributes,omitempty"`
	Classifications        []AtlasClassification       `json:"classifications,omitempty"`
	CollectionId           string                      `json:"collectionId,omitempty"`
	Contacts               map[string]interface{}      `json:"contacts,omitempty"`
	CreateTime             int                         `json:"createTime ,omitempty"`
	CreatedBy              string                      `json:"createdBy,omitempty"`
	CustomAttributes       map[string]interface{}      `json:"customAttributes,omitempty"`
	Guid                   string                      `json:"guid,omitempty"`
	HomeId                 string                      `json:"homeId ,omitempty"`
	IsIncomplete           bool                        `json:"isIncomplete,omitempty"`
	Labels                 []string                    `json:"labels,omitempty"`
	LastModifiedTS         string                      `json:"lastModifiedTS,omitempty"`
	Meanings               []AtlasTermAssignmentHeader `json:"meanings,omitempty"`
	ProvenanceType         int                         `json:"provenanceType,omitempty"`
	Proxy                  bool                        `json:"proxy,omitempty"`
	RelationshipAttributes map[string]interface{}      `json:"relationshipAttributes optional"`
	Source                 string                      `json:"source,omitempty"`
	Status                 Status                      `json:"status ,omitempty"`
	TypeName               string                      `json:"typeName ,omitempty"`
	UpdateTime             int                         `json:"updateTime,omitempty"`
	UpdatedBy              string                      `json:"updatedBy,omitempty"`
	Version                int                         `json:"version,omitempty"`
}

func UnmarshalEntity

func UnmarshalEntity(data []byte) (*Entity, error)

type EntityCreateOrUpdateBulkRequest

type EntityCreateOrUpdateBulkRequest struct {
	Entity           []Entity               `json:"entity,omitempty"`
	ReferredEntities map[string]interface{} `json:"referredEntities,omitempty"`
}

func (*EntityCreateOrUpdateBulkRequest) MarshalJson

func (s *EntityCreateOrUpdateBulkRequest) MarshalJson() ([]byte, error)

type EntityCreateOrUpdateRequest

type EntityCreateOrUpdateRequest struct {
	Entity           Entity                 `json:"entity,omitempty"`
	ReferredEntities map[string]interface{} `json:"referredEntities,omitempty"`
}

func (*EntityCreateOrUpdateRequest) MarshalJson

func (s *EntityCreateOrUpdateRequest) MarshalJson() ([]byte, error)

type EntityMutationResponse

type EntityMutationResponse struct {
	GuidAssignments       map[string]string      `json:"guidAssignments,omitempty"`
	MutatedEntities       map[string]interface{} `json:"mutatedEntities,omitempty"`
	PartialUpdateEntities []AtlasEntityHeader    `json:"partialUpdateEntities,omitempty"`
}

func (EntityMutationResponse) UnmarshalJson

func (s EntityMutationResponse) UnmarshalJson(data []byte) (
	*EntityMutationResponse,
	error,
)

type ErrorResponse

type ErrorResponse struct {
	ErrorCode    string `json:"errorCode,omitempty"`
	ErrorMessage string `json:"errorMessage,omitempty"`
	RequestId    string `json:"requestId,omitempty"`
}

func (ErrorResponse) UnmarshalJson

func (e ErrorResponse) UnmarshalJson(data []byte) (*ErrorResponse, error)

type ImportInfo

type ImportInfo struct {
	ChildObjectName  string `json:"childObjectName,omitempty"`
	ImportStatus     string `json:"importStatus,omitempty"`
	ParentObjectName string `json:"parentObjectName,omitempty"`
	Remarks          string `json:"remarks,omitempty"`
}

type QueryAttribute

type QueryAttribute struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

func (*QueryAttribute) Encode

func (q *QueryAttribute) Encode() string

func (*QueryAttribute) EncodeIdx

func (q *QueryAttribute) EncodeIdx(idx int) string

type QueryAttributes

type QueryAttributes struct {
	TypeName   string `json:"typeName"`
	Attributes []QueryAttribute
}

func (*QueryAttributes) Encode

func (q *QueryAttributes) Encode() string

func (*QueryAttributes) EncodeASC

func (q *QueryAttributes) EncodeASC() string

func (*QueryAttributes) ToUrlValues

func (q *QueryAttributes) ToUrlValues() url.Values

type QueryParams

type QueryParams struct {
	Params map[string]string
}

func (*QueryParams) BusinessAttributeUpdateBehavior

func (qp *QueryParams) BusinessAttributeUpdateBehavior(value businessAttributeUpdateBehavior)

func (*QueryParams) Encode

func (qp *QueryParams) Encode(allowedParams map[string]bool) string

func (*QueryParams) IgnoreRelationships

func (qp *QueryParams) IgnoreRelationships(value string)

func (*QueryParams) IsOverwrite

func (qp *QueryParams) IsOverwrite(value string)

func (*QueryParams) MinExtInfo

func (qp *QueryParams) MinExtInfo(value string)

type QueryRequest

type QueryRequest struct {
	Facets          []SearchFacetItem      `json:"facets,omitempty"`
	Filter          map[string]interface{} `json:"filter,omitempty"`
	KeyWords        string                 `json:"keywords,omitempty"`
	Limit           int                    `json:"limit,omitempty"`
	Offset          int                    `json:"offset,omitempty"`
	OrderBy         []map[string]string    `json:"orderBy,omitempty"`
	TaxonomySetting TaxonomySetting        `json:"taxonomySetting,omitempty"`
}

type SearchFacetItem

type SearchFacetItem struct {
	Count int         `json:"count,omitempty"`
	Facet string      `json:"facet,omitempty"`
	Sort  interface{} `json:"sort,omitempty"`
}

type SearchFacetItemValue

type SearchFacetItemValue struct {
	Count int    `json:"count,omitempty"`
	Value string `json:"value,omitempty"`
}

type SearchFacetResultValue

type SearchFacetResultValue struct {
	AssetType      []SearchFacetItemValue `json:"assetType,omitempty"`
	Classification []SearchFacetItemValue `json:"classification,omitempty"`
	ContactId      []SearchFacetItemValue `json:"contactId,omitempty"`
	ContactType    []SearchFacetItemValue `json:"contactType,omitempty"`
	EntityType     []SearchFacetItemValue `json:"entityType,omitempty"`
	GlossaryType   []SearchFacetItemValue `json:"glossaryType,omitempty"`
	Label          []SearchFacetItemValue `json:"label,omitempty"`
	Term           []SearchFacetItemValue `json:"term,omitempty"`
	TermStatus     []SearchFacetItemValue `json:"termStatus,omitempty"`
	TermTemplate   []SearchFacetItemValue `json:"termTemplate,omitempty"`
}

type SearchHighlights

type SearchHighlights struct {
	Description   []string `json:"description,omitempty"`
	EntityType    []string `json:"entityType,omitempty"`
	Id            []string `json:"id,omitempty"`
	Name          []string `json:"name,omitempty"`
	QualifiedName []string `json:"qualifiedName,omitempty"`
}

type SearchResult

type SearchResult struct {
	SearchCount  int                    `json:"@search.count,omitempty"`
	SearchFacets SearchFacetResultValue `json:"@search.facets,omitempty"`
	Value        []SearchResultValue    `json:"value,omitempty"`
}

func (SearchResult) UnmarshalJson

func (a SearchResult) UnmarshalJson(data []byte) (
	*SearchResult,
	error,
)

type SearchResultValue

type SearchResultValue struct {
	Highlights      []SearchHighlights         `json:"@search.highlights,omitempty"`
	Score           int                        `json:"@search.score,omitempty"`
	AssetType       []string                   `json:"assetType,omitempty"`
	Classification  []string                   `json:"classification,omitempty"`
	Contact         []ContactSearchResultValue `json:"contact,omitempty"`
	CreateTime      int                        `json:"createTime,omitempty"`
	Description     string                     `json:"description,omitempty"`
	Endorsement     string                     `json:"endorsement,omitempty"`
	EntityType      string                     `json:"entityType,omitempty"`
	Glossary        string                     `json:"glossary,omitempty"`
	GlossaryType    string                     `json:"glossaryType,omitempty"`
	Id              string                     `json:"id,omitempty"`
	Label           []string                   `json:"label,omitempty"`
	LongDescription string                     `json:"longDescription,omitempty"`
	Name            string                     `json:"name,omitempty"`
	ObjectType      string                     `json:"objectType,omitempty"`
	Owner           string                     `json:"owner,omitempty"`
	QualifiedName   string                     `json:"qualifiedName,omitempty"`
	Term            []TermSearchResultValue    `json:"term,omitempty"`
	TermStatus      string                     `json:"termStatus,omitempty"`
	TermTemplate    []string                   `json:"termTemplate,omitempty"`
	UpdateTime      int                        `json:"updateTime,omitempty"`
}

type Status

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

type SuggestRequest

type SuggestRequest struct {
	Filter   map[string]interface{} `json:"filter,omitempty"`
	KeyWords string                 `json:"keywords,omitempty"`
	Limit    int                    `json:"limit,omitempty"`
}

type SuggestResult

type SuggestResult struct {
	Value []SuggestResultValue `json:"value"`
}

func (SuggestResult) UnmarshalJson

func (a SuggestResult) UnmarshalJson(data []byte) (
	*SuggestResult,
	error,
)

type SuggestResultValue

type SuggestResultValue struct {
	Score           int                        `json:"@search.score,omitempty"`
	Text            string                     `json:"@search.text,omitempty"`
	AssetType       []string                   `json:"assetType,omitempty"`
	Classification  []string                   `json:"classification,omitempty"`
	Contact         []ContactSearchResultValue `json:"contact,omitempty"`
	CreateTime      int                        `json:"createTime,omitempty"`
	Description     string                     `json:"description,omitempty"`
	Endorsement     string                     `json:"endorsement,omitempty"`
	EntityType      string                     `json:"entityType,omitempty"`
	Glossary        string                     `json:"glossary,omitempty"`
	GlossaryType    string                     `json:"glossaryType,omitempty"`
	Id              string                     `json:"id,omitempty"`
	Label           []string                   `json:"label,omitempty"`
	LongDescription string                     `json:"longDescription,omitempty"`
	Name            string                     `json:"name,omitempty"`
	ObjectType      string                     `json:"objectType,omitempty"`
	Owner           string                     `json:"owner,omitempty"`
	QualifiedName   string                     `json:"qualifiedName,omitempty"`
	Term            []TermSearchResultValue    `json:"term,omitempty"`
	TermStatus      string                     `json:"termStatus,omitempty"`
	TermTemplate    []string                   `json:"termTemplate,omitempty"`
	UpdateTime      int                        `json:"updateTime,omitempty"`
}

type TaxonomySetting

type TaxonomySetting struct {
	AssetTypes []string        `json:"assetTypes,omitempty"`
	Facet      SearchFacetItem `json:"facet,omitempty"`
}

type TermSearchResultValue

type TermSearchResultValue struct {
	GlossaryName string `json:"glossaryName,omitempty"`
	Guid         string `json:"guid,omitempty"`
	Name         string `json:"name,omitempty"`
}

type TimeBoundary

type TimeBoundary struct {
	EndTime   string `json:"endTime,omitempty"`
	StartTime string `json:"startTime,omitempty"`
	TimeZone  string `json:"timeZone,omitempty"`
}