api

Documentation

Overview

Package api provides primitives to interact the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen DO NOT EDIT.

Index

• type Asset
• type AssetDetails
• type AssetMetadata
• type AssetMetadata_ComponentsMetadata
  • func (a AssetMetadata_ComponentsMetadata) Get(fieldName string) (value ComponentMetadata, found bool)
  • func (a AssetMetadata_ComponentsMetadata) MarshalJSON() ([]byte, error)
  • func (a *AssetMetadata_ComponentsMetadata) Set(fieldName string, value ComponentMetadata)
  • func (a *AssetMetadata_ComponentsMetadata) UnmarshalJSON(b []byte) error
• type AssetMetadata_NamedMetadata
  • func (a AssetMetadata_NamedMetadata) Get(fieldName string) (value string, found bool)
  • func (a AssetMetadata_NamedMetadata) MarshalJSON() ([]byte, error)
  • func (a *AssetMetadata_NamedMetadata) Set(fieldName string, value string)
  • func (a *AssetMetadata_NamedMetadata) UnmarshalJSON(b []byte) error
• type AssetSpec
• type ComponentMetadata
• type ComponentMetadata_NamedMetadata
  • func (a ComponentMetadata_NamedMetadata) Get(fieldName string) (value string, found bool)
  • func (a ComponentMetadata_NamedMetadata) MarshalJSON() ([]byte, error)
  • func (a *ComponentMetadata_NamedMetadata) Set(fieldName string, value string)
  • func (a *ComponentMetadata_NamedMetadata) UnmarshalJSON(b []byte) error
• type SecretRef

Types

type Asset

type Asset struct {
	Spec AssetSpec `json:"spec"`
}

Asset defines model for Asset.

type AssetDetails

type AssetDetails struct {

	// Connection information
	Connection externalRef0.Connection `json:"connection"`
	DataFormat *string                 `json:"dataFormat,omitempty"`
}

AssetDetails defines model for AssetDetails.

type AssetMetadata

type AssetMetadata struct {

	// metadata for each component in asset (e.g., column)
	ComponentsMetadata *AssetMetadata_ComponentsMetadata `json:"componentsMetadata,omitempty"`
	Geography          *string                           `json:"geography,omitempty"`
	NamedMetadata      *AssetMetadata_NamedMetadata      `json:"namedMetadata,omitempty"`
	Owner              *string                           `json:"owner,omitempty"`

	// Tags associated with the asset
	Tags *[]string `json:"tags,omitempty"`
}

AssetMetadata defines model for AssetMetadata.

type AssetMetadata_ComponentsMetadata

type AssetMetadata_ComponentsMetadata struct {
	AdditionalProperties map[string]ComponentMetadata `json:"-"`
}

AssetMetadata_ComponentsMetadata defines model for AssetMetadata.ComponentsMetadata.

func (AssetMetadata_ComponentsMetadata) Get

func (a AssetMetadata_ComponentsMetadata) Get(fieldName string) (value ComponentMetadata, found bool)

Getter for additional properties for AssetMetadata_ComponentsMetadata. Returns the specified element and whether it was found

func (AssetMetadata_ComponentsMetadata) MarshalJSON

func (a AssetMetadata_ComponentsMetadata) MarshalJSON() ([]byte, error)

Override default JSON handling for AssetMetadata_ComponentsMetadata to handle AdditionalProperties

func (*AssetMetadata_ComponentsMetadata) Set

func (a *AssetMetadata_ComponentsMetadata) Set(fieldName string, value ComponentMetadata)

Setter for additional properties for AssetMetadata_ComponentsMetadata

func (*AssetMetadata_ComponentsMetadata) UnmarshalJSON

func (a *AssetMetadata_ComponentsMetadata) UnmarshalJSON(b []byte) error

Override default JSON handling for AssetMetadata_ComponentsMetadata to handle AdditionalProperties

type AssetMetadata_NamedMetadata

type AssetMetadata_NamedMetadata struct {
	AdditionalProperties map[string]string `json:"-"`
}

AssetMetadata_NamedMetadata defines model for AssetMetadata.NamedMetadata.

func (AssetMetadata_NamedMetadata) Get

func (a AssetMetadata_NamedMetadata) Get(fieldName string) (value string, found bool)

Getter for additional properties for AssetMetadata_NamedMetadata. Returns the specified element and whether it was found

func (AssetMetadata_NamedMetadata) MarshalJSON

func (a AssetMetadata_NamedMetadata) MarshalJSON() ([]byte, error)

Override default JSON handling for AssetMetadata_NamedMetadata to handle AdditionalProperties

func (*AssetMetadata_NamedMetadata) Set

func (a *AssetMetadata_NamedMetadata) Set(fieldName string, value string)

Setter for additional properties for AssetMetadata_NamedMetadata

func (*AssetMetadata_NamedMetadata) UnmarshalJSON

func (a *AssetMetadata_NamedMetadata) UnmarshalJSON(b []byte) error

Override default JSON handling for AssetMetadata_NamedMetadata to handle AdditionalProperties

type AssetSpec

type AssetSpec struct {

	// Asset details
	AssetDetails  AssetDetails  `json:"assetDetails"`
	AssetMetadata AssetMetadata `json:"assetMetadata"`

	// Reference to a Secret resource holding credentials for this asset
	SecretRef SecretRef `json:"secretRef"`
}

AssetSpec defines model for AssetSpec.

type ComponentMetadata

type ComponentMetadata struct {
	ComponentType *string `json:"componentType,omitempty"`

	// Named terms, that exist in Catalog toxonomy and the values for these terms for columns we will have "SchemaDetails" key, that will include technical schema details for this column TODO: Consider create special field for schema outside of metadata
	NamedMetadata *ComponentMetadata_NamedMetadata `json:"namedMetadata,omitempty"`

	// Tags - can be any free text added to a component (no taxonomy)
	Tags *[]string `json:"tags,omitempty"`
}

ComponentMetadata defines model for ComponentMetadata.

type ComponentMetadata_NamedMetadata

type ComponentMetadata_NamedMetadata struct {
	AdditionalProperties map[string]string `json:"-"`
}

ComponentMetadata_NamedMetadata defines model for ComponentMetadata.NamedMetadata.

func (ComponentMetadata_NamedMetadata) Get

func (a ComponentMetadata_NamedMetadata) Get(fieldName string) (value string, found bool)

Getter for additional properties for ComponentMetadata_NamedMetadata. Returns the specified element and whether it was found

func (ComponentMetadata_NamedMetadata) MarshalJSON

func (a ComponentMetadata_NamedMetadata) MarshalJSON() ([]byte, error)

Override default JSON handling for ComponentMetadata_NamedMetadata to handle AdditionalProperties

func (*ComponentMetadata_NamedMetadata) Set

func (a *ComponentMetadata_NamedMetadata) Set(fieldName string, value string)

Setter for additional properties for ComponentMetadata_NamedMetadata

func (*ComponentMetadata_NamedMetadata) UnmarshalJSON

func (a *ComponentMetadata_NamedMetadata) UnmarshalJSON(b []byte) error

Override default JSON handling for ComponentMetadata_NamedMetadata to handle AdditionalProperties

type SecretRef

type SecretRef struct {

	// Name of the Secret resource (must exist in the same namespace)
	Name string `json:"name"`
}

SecretRef defines model for SecretRef.