// Licensed to the LF AI & Data foundation under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package entity

import "github.com/milvus-io/milvus-proto/go-api/v3/milvuspb"

// RefreshExternalCollectionState represents the state of a refresh external collection job.
type RefreshExternalCollectionState milvuspb.RefreshExternalCollectionState

const (
	RefreshStatePending    RefreshExternalCollectionState = RefreshExternalCollectionState(milvuspb.RefreshExternalCollectionState_RefreshPending)
	RefreshStateInProgress RefreshExternalCollectionState = RefreshExternalCollectionState(milvuspb.RefreshExternalCollectionState_RefreshInProgress)
	RefreshStateCompleted  RefreshExternalCollectionState = RefreshExternalCollectionState(milvuspb.RefreshExternalCollectionState_RefreshCompleted)
	RefreshStateFailed     RefreshExternalCollectionState = RefreshExternalCollectionState(milvuspb.RefreshExternalCollectionState_RefreshFailed)
)

// String returns the string representation of the state.
func (s RefreshExternalCollectionState) String() string {
	return milvuspb.RefreshExternalCollectionState(s).String()
}

// RefreshExternalCollectionJobInfo contains information about a refresh external collection job.
type RefreshExternalCollectionJobInfo struct {
	JobID          int64
	CollectionName string
	State          RefreshExternalCollectionState
	Progress       int64
	Reason         string
	ExternalSource string
	ExternalSpec   string
	StartTime      int64
	EndTime        int64
}
