lib/api/research/research_models/enrichment_run.go

// Code generated by go-swagger; DO NOT EDIT.

// (c) 2012-2020 by Taxnexus, Inc.
// All rights reserved worldwide.
// Proprietary product; unlicensed use is not allowed

package research_models

import (
	"context"
	"encoding/json"
	stderrors "errors"
	"strconv"

	"github.com/go-openapi/errors"
	"github.com/go-openapi/strfmt"
	"github.com/go-openapi/swag/jsonutils"
	"github.com/go-openapi/swag/typeutils"
	"github.com/go-openapi/validate"
)

// EnrichmentRun Durable source-backed research evidence; it never represents an authoritative subject write or publication
//
// swagger:model EnrichmentRun
type EnrichmentRun struct {

	// base version
	// Required: true
	// Format: date-time
	BaseVersion *strfmt.DateTime `json:"BaseVersion"`

	// candidates
	// Required: true
	// Max Items: 16
	Candidates []*EnrichmentCandidate `json:"Candidates"`

	// completed date
	// Format: date-time
	CompletedDate strfmt.DateTime `json:"CompletedDate,omitempty"`

	// created date
	// Required: true
	// Format: date-time
	CreatedDate *strfmt.DateTime `json:"CreatedDate"`

	// failure code
	// Max Length: 80
	FailureCode string `json:"FailureCode,omitempty"`

	// ID
	// Required: true
	// Format: uuid
	ID *strfmt.UUID `json:"ID"`

	// model
	// Required: true
	// Max Length: 80
	Model *string `json:"Model"`

	// prompt version
	// Required: true
	// Max Length: 80
	PromptVersion *string `json:"PromptVersion"`

	// provider
	// Required: true
	// Max Length: 40
	Provider *string `json:"Provider"`

	// provider response ID
	// Max Length: 120
	ProviderResponseID string `json:"ProviderResponseID,omitempty"`

	// requested by ID
	// Required: true
	// Format: uuid
	RequestedByID *strfmt.UUID `json:"RequestedByID"`

	// started date
	// Required: true
	// Format: date-time
	StartedDate *strfmt.DateTime `json:"StartedDate"`

	// status
	// Required: true
	// Enum: ["running","completed","failed"]
	Status *string `json:"Status"`

	// subject ID
	// Required: true
	// Format: uuid
	SubjectID *strfmt.UUID `json:"SubjectID"`

	// subject type
	// Required: true
	// Enum: ["account","company_product","company_service"]
	SubjectType *string `json:"SubjectType"`

	// tenant ID
	// Required: true
	// Format: uuid
	TenantID *strfmt.UUID `json:"TenantID"`
}

// Validate validates this enrichment run
func (m *EnrichmentRun) Validate(formats strfmt.Registry) error {
	var res []error

	if err := m.validateBaseVersion(formats); err != nil {
		res = append(res, err)
	}

	if err := m.validateCandidates(formats); err != nil {
		res = append(res, err)
	}

	if err := m.validateCompletedDate(formats); err != nil {
		res = append(res, err)
	}

	if err := m.validateCreatedDate(formats); err != nil {
		res = append(res, err)
	}

	if err := m.validateFailureCode(formats); err != nil {
		res = append(res, err)
	}

	if err := m.validateID(formats); err != nil {
		res = append(res, err)
	}

	if err := m.validateModel(formats); err != nil {
		res = append(res, err)
	}

	if err := m.validatePromptVersion(formats); err != nil {
		res = append(res, err)
	}

	if err := m.validateProvider(formats); err != nil {
		res = append(res, err)
	}

	if err := m.validateProviderResponseID(formats); err != nil {
		res = append(res, err)
	}

	if err := m.validateRequestedByID(formats); err != nil {
		res = append(res, err)
	}

	if err := m.validateStartedDate(formats); err != nil {
		res = append(res, err)
	}

	if err := m.validateStatus(formats); err != nil {
		res = append(res, err)
	}

	if err := m.validateSubjectID(formats); err != nil {
		res = append(res, err)
	}

	if err := m.validateSubjectType(formats); err != nil {
		res = append(res, err)
	}

	if err := m.validateTenantID(formats); err != nil {
		res = append(res, err)
	}

	if len(res) > 0 {
		return errors.CompositeValidationError(res...)
	}
	return nil
}

func (m *EnrichmentRun) validateBaseVersion(formats strfmt.Registry) error {

	if err := validate.Required("BaseVersion", "body", m.BaseVersion); err != nil {
		return err
	}

	if err := validate.FormatOf("BaseVersion", "body", "date-time", m.BaseVersion.String(), formats); err != nil {
		return err
	}

	return nil
}

func (m *EnrichmentRun) validateCandidates(formats strfmt.Registry) error {

	if err := validate.Required("Candidates", "body", m.Candidates); err != nil {
		return err
	}

	iCandidatesSize := int64(len(m.Candidates))

	if err := validate.MaxItems("Candidates", "body", iCandidatesSize, 16); err != nil {
		return err
	}

	for i := 0; i < len(m.Candidates); i++ {
		if typeutils.IsZero(m.Candidates[i]) { // not required
			continue
		}

		if m.Candidates[i] != nil {
			if err := m.Candidates[i].Validate(formats); err != nil {
				ve := new(errors.Validation)
				if stderrors.As(err, &ve) {
					return ve.ValidateName("Candidates" + "." + strconv.Itoa(i))
				}
				ce := new(errors.CompositeError)
				if stderrors.As(err, &ce) {
					return ce.ValidateName("Candidates" + "." + strconv.Itoa(i))
				}

				return err
			}
		}

	}

	return nil
}

func (m *EnrichmentRun) validateCompletedDate(formats strfmt.Registry) error {
	if typeutils.IsZero(m.CompletedDate) { // not required
		return nil
	}

	if err := validate.FormatOf("CompletedDate", "body", "date-time", m.CompletedDate.String(), formats); err != nil {
		return err
	}

	return nil
}

func (m *EnrichmentRun) validateCreatedDate(formats strfmt.Registry) error {

	if err := validate.Required("CreatedDate", "body", m.CreatedDate); err != nil {
		return err
	}

	if err := validate.FormatOf("CreatedDate", "body", "date-time", m.CreatedDate.String(), formats); err != nil {
		return err
	}

	return nil
}

func (m *EnrichmentRun) validateFailureCode(formats strfmt.Registry) error {
	if typeutils.IsZero(m.FailureCode) { // not required
		return nil
	}

	if err := validate.MaxLength("FailureCode", "body", m.FailureCode, 80); err != nil {
		return err
	}

	return nil
}

func (m *EnrichmentRun) validateID(formats strfmt.Registry) error {

	if err := validate.Required("ID", "body", m.ID); err != nil {
		return err
	}

	if err := validate.FormatOf("ID", "body", "uuid", m.ID.String(), formats); err != nil {
		return err
	}

	return nil
}

func (m *EnrichmentRun) validateModel(formats strfmt.Registry) error {

	if err := validate.Required("Model", "body", m.Model); err != nil {
		return err
	}

	if err := validate.MaxLength("Model", "body", *m.Model, 80); err != nil {
		return err
	}

	return nil
}

func (m *EnrichmentRun) validatePromptVersion(formats strfmt.Registry) error {

	if err := validate.Required("PromptVersion", "body", m.PromptVersion); err != nil {
		return err
	}

	if err := validate.MaxLength("PromptVersion", "body", *m.PromptVersion, 80); err != nil {
		return err
	}

	return nil
}

func (m *EnrichmentRun) validateProvider(formats strfmt.Registry) error {

	if err := validate.Required("Provider", "body", m.Provider); err != nil {
		return err
	}

	if err := validate.MaxLength("Provider", "body", *m.Provider, 40); err != nil {
		return err
	}

	return nil
}

func (m *EnrichmentRun) validateProviderResponseID(formats strfmt.Registry) error {
	if typeutils.IsZero(m.ProviderResponseID) { // not required
		return nil
	}

	if err := validate.MaxLength("ProviderResponseID", "body", m.ProviderResponseID, 120); err != nil {
		return err
	}

	return nil
}

func (m *EnrichmentRun) validateRequestedByID(formats strfmt.Registry) error {

	if err := validate.Required("RequestedByID", "body", m.RequestedByID); err != nil {
		return err
	}

	if err := validate.FormatOf("RequestedByID", "body", "uuid", m.RequestedByID.String(), formats); err != nil {
		return err
	}

	return nil
}

func (m *EnrichmentRun) validateStartedDate(formats strfmt.Registry) error {

	if err := validate.Required("StartedDate", "body", m.StartedDate); err != nil {
		return err
	}

	if err := validate.FormatOf("StartedDate", "body", "date-time", m.StartedDate.String(), formats); err != nil {
		return err
	}

	return nil
}

var enrichmentRunTypeStatusPropEnum []any

func init() {
	var res []string
	if err := json.Unmarshal([]byte(`["running","completed","failed"]`), &res); err != nil {
		panic(err)
	}
	for _, v := range res {
		enrichmentRunTypeStatusPropEnum = append(enrichmentRunTypeStatusPropEnum, v)
	}
}

const (

	// EnrichmentRunStatusRunning captures enum value "running"
	EnrichmentRunStatusRunning string = "running"

	// EnrichmentRunStatusCompleted captures enum value "completed"
	EnrichmentRunStatusCompleted string = "completed"

	// EnrichmentRunStatusFailed captures enum value "failed"
	EnrichmentRunStatusFailed string = "failed"
)

// prop value enum
func (m *EnrichmentRun) validateStatusEnum(path, location string, value string) error {
	if err := validate.EnumCase(path, location, value, enrichmentRunTypeStatusPropEnum, true); err != nil {
		return err
	}
	return nil
}

func (m *EnrichmentRun) validateStatus(formats strfmt.Registry) error {

	if err := validate.Required("Status", "body", m.Status); err != nil {
		return err
	}

	// value enum
	if err := m.validateStatusEnum("Status", "body", *m.Status); err != nil {
		return err
	}

	return nil
}

func (m *EnrichmentRun) validateSubjectID(formats strfmt.Registry) error {

	if err := validate.Required("SubjectID", "body", m.SubjectID); err != nil {
		return err
	}

	if err := validate.FormatOf("SubjectID", "body", "uuid", m.SubjectID.String(), formats); err != nil {
		return err
	}

	return nil
}

var enrichmentRunTypeSubjectTypePropEnum []any

func init() {
	var res []string
	if err := json.Unmarshal([]byte(`["account","company_product","company_service"]`), &res); err != nil {
		panic(err)
	}
	for _, v := range res {
		enrichmentRunTypeSubjectTypePropEnum = append(enrichmentRunTypeSubjectTypePropEnum, v)
	}
}

const (

	// EnrichmentRunSubjectTypeAccount captures enum value "account"
	EnrichmentRunSubjectTypeAccount string = "account"

	// EnrichmentRunSubjectTypeCompanyProduct captures enum value "company_product"
	EnrichmentRunSubjectTypeCompanyProduct string = "company_product"

	// EnrichmentRunSubjectTypeCompanyService captures enum value "company_service"
	EnrichmentRunSubjectTypeCompanyService string = "company_service"
)

// prop value enum
func (m *EnrichmentRun) validateSubjectTypeEnum(path, location string, value string) error {
	if err := validate.EnumCase(path, location, value, enrichmentRunTypeSubjectTypePropEnum, true); err != nil {
		return err
	}
	return nil
}

func (m *EnrichmentRun) validateSubjectType(formats strfmt.Registry) error {

	if err := validate.Required("SubjectType", "body", m.SubjectType); err != nil {
		return err
	}

	// value enum
	if err := m.validateSubjectTypeEnum("SubjectType", "body", *m.SubjectType); err != nil {
		return err
	}

	return nil
}

func (m *EnrichmentRun) validateTenantID(formats strfmt.Registry) error {

	if err := validate.Required("TenantID", "body", m.TenantID); err != nil {
		return err
	}

	if err := validate.FormatOf("TenantID", "body", "uuid", m.TenantID.String(), formats); err != nil {
		return err
	}

	return nil
}

// ContextValidate validate this enrichment run based on the context it is used
func (m *EnrichmentRun) ContextValidate(ctx context.Context, formats strfmt.Registry) error {
	var res []error

	if err := m.contextValidateCandidates(ctx, formats); err != nil {
		res = append(res, err)
	}

	if len(res) > 0 {
		return errors.CompositeValidationError(res...)
	}
	return nil
}

func (m *EnrichmentRun) contextValidateCandidates(ctx context.Context, formats strfmt.Registry) error {

	for i := 0; i < len(m.Candidates); i++ {

		if m.Candidates[i] != nil {

			if typeutils.IsZero(m.Candidates[i]) { // not required
				return nil
			}

			if err := m.Candidates[i].ContextValidate(ctx, formats); err != nil {
				ve := new(errors.Validation)
				if stderrors.As(err, &ve) {
					return ve.ValidateName("Candidates" + "." + strconv.Itoa(i))
				}
				ce := new(errors.CompositeError)
				if stderrors.As(err, &ce) {
					return ce.ValidateName("Candidates" + "." + strconv.Itoa(i))
				}

				return err
			}
		}

	}

	return nil
}

// MarshalBinary interface implementation
func (m *EnrichmentRun) MarshalBinary() ([]byte, error) {
	if m == nil {
		return nil, nil
	}
	return jsonutils.WriteJSON(m)
}

// UnmarshalBinary interface implementation
func (m *EnrichmentRun) UnmarshalBinary(b []byte) error {
	var res EnrichmentRun
	if err := jsonutils.ReadJSON(b, &res); err != nil {
		return err
	}
	*m = res
	return nil
}