models

package
v1.32.21 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 3, 2025 License: BSD-3-Clause Imports: 8 Imported by: 138

Documentation

Index

Constants

View Source 
const (

	// BackupConfigCompressionLevelDefaultCompression captures enum value "DefaultCompression"
	BackupConfigCompressionLevelDefaultCompression string = "DefaultCompression"

	// BackupConfigCompressionLevelBestSpeed captures enum value "BestSpeed"
	BackupConfigCompressionLevelBestSpeed string = "BestSpeed"

	// BackupConfigCompressionLevelBestCompression captures enum value "BestCompression"
	BackupConfigCompressionLevelBestCompression string = "BestCompression"

	// BackupConfigCompressionLevelZstdDefaultCompression captures enum value "ZstdDefaultCompression"
	BackupConfigCompressionLevelZstdDefaultCompression string = "ZstdDefaultCompression"

	// BackupConfigCompressionLevelZstdBestSpeed captures enum value "ZstdBestSpeed"
	BackupConfigCompressionLevelZstdBestSpeed string = "ZstdBestSpeed"

	// BackupConfigCompressionLevelZstdBestCompression captures enum value "ZstdBestCompression"
	BackupConfigCompressionLevelZstdBestCompression string = "ZstdBestCompression"

	// BackupConfigCompressionLevelNoCompression captures enum value "NoCompression"
	BackupConfigCompressionLevelNoCompression string = "NoCompression"
)
View Source 
const (

	// BackupCreateResponseStatusSTARTED captures enum value "STARTED"
	BackupCreateResponseStatusSTARTED string = "STARTED"

	// BackupCreateResponseStatusTRANSFERRING captures enum value "TRANSFERRING"
	BackupCreateResponseStatusTRANSFERRING string = "TRANSFERRING"

	// BackupCreateResponseStatusTRANSFERRED captures enum value "TRANSFERRED"
	BackupCreateResponseStatusTRANSFERRED string = "TRANSFERRED"

	// BackupCreateResponseStatusSUCCESS captures enum value "SUCCESS"
	BackupCreateResponseStatusSUCCESS string = "SUCCESS"

	// BackupCreateResponseStatusFAILED captures enum value "FAILED"
	BackupCreateResponseStatusFAILED string = "FAILED"

	// BackupCreateResponseStatusCANCELED captures enum value "CANCELED"
	BackupCreateResponseStatusCANCELED string = "CANCELED"
)
View Source 
const (

	// BackupCreateStatusResponseStatusSTARTED captures enum value "STARTED"
	BackupCreateStatusResponseStatusSTARTED string = "STARTED"

	// BackupCreateStatusResponseStatusTRANSFERRING captures enum value "TRANSFERRING"
	BackupCreateStatusResponseStatusTRANSFERRING string = "TRANSFERRING"

	// BackupCreateStatusResponseStatusTRANSFERRED captures enum value "TRANSFERRED"
	BackupCreateStatusResponseStatusTRANSFERRED string = "TRANSFERRED"

	// BackupCreateStatusResponseStatusSUCCESS captures enum value "SUCCESS"
	BackupCreateStatusResponseStatusSUCCESS string = "SUCCESS"

	// BackupCreateStatusResponseStatusFAILED captures enum value "FAILED"
	BackupCreateStatusResponseStatusFAILED string = "FAILED"

	// BackupCreateStatusResponseStatusCANCELED captures enum value "CANCELED"
	BackupCreateStatusResponseStatusCANCELED string = "CANCELED"
)
View Source 
const (

	// BackupListResponseItems0StatusSTARTED captures enum value "STARTED"
	BackupListResponseItems0StatusSTARTED string = "STARTED"

	// BackupListResponseItems0StatusTRANSFERRING captures enum value "TRANSFERRING"
	BackupListResponseItems0StatusTRANSFERRING string = "TRANSFERRING"

	// BackupListResponseItems0StatusTRANSFERRED captures enum value "TRANSFERRED"
	BackupListResponseItems0StatusTRANSFERRED string = "TRANSFERRED"

	// BackupListResponseItems0StatusSUCCESS captures enum value "SUCCESS"
	BackupListResponseItems0StatusSUCCESS string = "SUCCESS"

	// BackupListResponseItems0StatusFAILED captures enum value "FAILED"
	BackupListResponseItems0StatusFAILED string = "FAILED"

	// BackupListResponseItems0StatusCANCELED captures enum value "CANCELED"
	BackupListResponseItems0StatusCANCELED string = "CANCELED"
)
View Source 
const (

	// BackupRestoreResponseStatusSTARTED captures enum value "STARTED"
	BackupRestoreResponseStatusSTARTED string = "STARTED"

	// BackupRestoreResponseStatusTRANSFERRING captures enum value "TRANSFERRING"
	BackupRestoreResponseStatusTRANSFERRING string = "TRANSFERRING"

	// BackupRestoreResponseStatusTRANSFERRED captures enum value "TRANSFERRED"
	BackupRestoreResponseStatusTRANSFERRED string = "TRANSFERRED"

	// BackupRestoreResponseStatusSUCCESS captures enum value "SUCCESS"
	BackupRestoreResponseStatusSUCCESS string = "SUCCESS"

	// BackupRestoreResponseStatusFAILED captures enum value "FAILED"
	BackupRestoreResponseStatusFAILED string = "FAILED"

	// BackupRestoreResponseStatusCANCELED captures enum value "CANCELED"
	BackupRestoreResponseStatusCANCELED string = "CANCELED"
)
View Source 
const (

	// BackupRestoreStatusResponseStatusSTARTED captures enum value "STARTED"
	BackupRestoreStatusResponseStatusSTARTED string = "STARTED"

	// BackupRestoreStatusResponseStatusTRANSFERRING captures enum value "TRANSFERRING"
	BackupRestoreStatusResponseStatusTRANSFERRING string = "TRANSFERRING"

	// BackupRestoreStatusResponseStatusTRANSFERRED captures enum value "TRANSFERRED"
	BackupRestoreStatusResponseStatusTRANSFERRED string = "TRANSFERRED"

	// BackupRestoreStatusResponseStatusSUCCESS captures enum value "SUCCESS"
	BackupRestoreStatusResponseStatusSUCCESS string = "SUCCESS"

	// BackupRestoreStatusResponseStatusFAILED captures enum value "FAILED"
	BackupRestoreStatusResponseStatusFAILED string = "FAILED"

	// BackupRestoreStatusResponseStatusCANCELED captures enum value "CANCELED"
	BackupRestoreStatusResponseStatusCANCELED string = "CANCELED"
)
View Source 
const (

	// BatchDeleteResponseResultsObjectsItems0StatusSUCCESS captures enum value "SUCCESS"
	BatchDeleteResponseResultsObjectsItems0StatusSUCCESS string = "SUCCESS"

	// BatchDeleteResponseResultsObjectsItems0StatusDRYRUN captures enum value "DRYRUN"
	BatchDeleteResponseResultsObjectsItems0StatusDRYRUN string = "DRYRUN"

	// BatchDeleteResponseResultsObjectsItems0StatusFAILED captures enum value "FAILED"
	BatchDeleteResponseResultsObjectsItems0StatusFAILED string = "FAILED"
)
View Source 
const (

	// BatchReferenceResponseAO1ResultStatusSUCCESS captures enum value "SUCCESS"
	BatchReferenceResponseAO1ResultStatusSUCCESS string = "SUCCESS"

	// BatchReferenceResponseAO1ResultStatusFAILED captures enum value "FAILED"
	BatchReferenceResponseAO1ResultStatusFAILED string = "FAILED"
)
View Source 
const (

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

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

	// ClassificationStatusFailed captures enum value "failed"
	ClassificationStatusFailed string = "failed"
)
View Source 
const (

	// DBUserInfoDbUserTypeDbUser captures enum value "db_user"
	DBUserInfoDbUserTypeDbUser string = "db_user"

	// DBUserInfoDbUserTypeDbEnvUser captures enum value "db_env_user"
	DBUserInfoDbUserTypeDbEnvUser string = "db_env_user"
)
View Source 
const (

	// NestedPropertyTokenizationWord captures enum value "word"
	NestedPropertyTokenizationWord string = "word"

	// NestedPropertyTokenizationLowercase captures enum value "lowercase"
	NestedPropertyTokenizationLowercase string = "lowercase"

	// NestedPropertyTokenizationWhitespace captures enum value "whitespace"
	NestedPropertyTokenizationWhitespace string = "whitespace"

	// NestedPropertyTokenizationField captures enum value "field"
	NestedPropertyTokenizationField string = "field"

	// NestedPropertyTokenizationTrigram captures enum value "trigram"
	NestedPropertyTokenizationTrigram string = "trigram"

	// NestedPropertyTokenizationGse captures enum value "gse"
	NestedPropertyTokenizationGse string = "gse"

	// NestedPropertyTokenizationKagomeKr captures enum value "kagome_kr"
	NestedPropertyTokenizationKagomeKr string = "kagome_kr"

	// NestedPropertyTokenizationKagomeJa captures enum value "kagome_ja"
	NestedPropertyTokenizationKagomeJa string = "kagome_ja"

	// NestedPropertyTokenizationGseCh captures enum value "gse_ch"
	NestedPropertyTokenizationGseCh string = "gse_ch"
)
View Source 
const (

	// NodeStatusStatusHEALTHY captures enum value "HEALTHY"
	NodeStatusStatusHEALTHY string = "HEALTHY"

	// NodeStatusStatusUNHEALTHY captures enum value "UNHEALTHY"
	NodeStatusStatusUNHEALTHY string = "UNHEALTHY"

	// NodeStatusStatusUNAVAILABLE captures enum value "UNAVAILABLE"
	NodeStatusStatusUNAVAILABLE string = "UNAVAILABLE"

	// NodeStatusStatusTIMEOUT captures enum value "TIMEOUT"
	NodeStatusStatusTIMEOUT string = "TIMEOUT"
)
View Source 
const (

	// ObjectsGetResponseAO2ResultStatusSUCCESS captures enum value "SUCCESS"
	ObjectsGetResponseAO2ResultStatusSUCCESS string = "SUCCESS"

	// ObjectsGetResponseAO2ResultStatusFAILED captures enum value "FAILED"
	ObjectsGetResponseAO2ResultStatusFAILED string = "FAILED"
)
View Source 
const (

	// PatchDocumentActionOpAdd captures enum value "add"
	PatchDocumentActionOpAdd string = "add"

	// PatchDocumentActionOpRemove captures enum value "remove"
	PatchDocumentActionOpRemove string = "remove"

	// PatchDocumentActionOpReplace captures enum value "replace"
	PatchDocumentActionOpReplace string = "replace"

	// PatchDocumentActionOpMove captures enum value "move"
	PatchDocumentActionOpMove string = "move"

	// PatchDocumentActionOpCopy captures enum value "copy"
	PatchDocumentActionOpCopy string = "copy"

	// PatchDocumentActionOpTest captures enum value "test"
	PatchDocumentActionOpTest string = "test"
)
View Source 
const (

	// PatchDocumentObjectOpAdd captures enum value "add"
	PatchDocumentObjectOpAdd string = "add"

	// PatchDocumentObjectOpRemove captures enum value "remove"
	PatchDocumentObjectOpRemove string = "remove"

	// PatchDocumentObjectOpReplace captures enum value "replace"
	PatchDocumentObjectOpReplace string = "replace"

	// PatchDocumentObjectOpMove captures enum value "move"
	PatchDocumentObjectOpMove string = "move"

	// PatchDocumentObjectOpCopy captures enum value "copy"
	PatchDocumentObjectOpCopy string = "copy"

	// PatchDocumentObjectOpTest captures enum value "test"
	PatchDocumentObjectOpTest string = "test"
)
View Source 
const (

	// PermissionActionManageBackups captures enum value "manage_backups"
	PermissionActionManageBackups string = "manage_backups"

	// PermissionActionReadCluster captures enum value "read_cluster"
	PermissionActionReadCluster string = "read_cluster"

	// PermissionActionCreateData captures enum value "create_data"
	PermissionActionCreateData string = "create_data"

	// PermissionActionReadData captures enum value "read_data"
	PermissionActionReadData string = "read_data"

	// PermissionActionUpdateData captures enum value "update_data"
	PermissionActionUpdateData string = "update_data"

	// PermissionActionDeleteData captures enum value "delete_data"
	PermissionActionDeleteData string = "delete_data"

	// PermissionActionReadNodes captures enum value "read_nodes"
	PermissionActionReadNodes string = "read_nodes"

	// PermissionActionCreateRoles captures enum value "create_roles"
	PermissionActionCreateRoles string = "create_roles"

	// PermissionActionReadRoles captures enum value "read_roles"
	PermissionActionReadRoles string = "read_roles"

	// PermissionActionUpdateRoles captures enum value "update_roles"
	PermissionActionUpdateRoles string = "update_roles"

	// PermissionActionDeleteRoles captures enum value "delete_roles"
	PermissionActionDeleteRoles string = "delete_roles"

	// PermissionActionCreateCollections captures enum value "create_collections"
	PermissionActionCreateCollections string = "create_collections"

	// PermissionActionReadCollections captures enum value "read_collections"
	PermissionActionReadCollections string = "read_collections"

	// PermissionActionUpdateCollections captures enum value "update_collections"
	PermissionActionUpdateCollections string = "update_collections"

	// PermissionActionDeleteCollections captures enum value "delete_collections"
	PermissionActionDeleteCollections string = "delete_collections"

	// PermissionActionAssignAndRevokeUsers captures enum value "assign_and_revoke_users"
	PermissionActionAssignAndRevokeUsers string = "assign_and_revoke_users"

	// PermissionActionCreateUsers captures enum value "create_users"
	PermissionActionCreateUsers string = "create_users"

	// PermissionActionReadUsers captures enum value "read_users"
	PermissionActionReadUsers string = "read_users"

	// PermissionActionUpdateUsers captures enum value "update_users"
	PermissionActionUpdateUsers string = "update_users"

	// PermissionActionDeleteUsers captures enum value "delete_users"
	PermissionActionDeleteUsers string = "delete_users"

	// PermissionActionCreateTenants captures enum value "create_tenants"
	PermissionActionCreateTenants string = "create_tenants"

	// PermissionActionReadTenants captures enum value "read_tenants"
	PermissionActionReadTenants string = "read_tenants"

	// PermissionActionUpdateTenants captures enum value "update_tenants"
	PermissionActionUpdateTenants string = "update_tenants"

	// PermissionActionDeleteTenants captures enum value "delete_tenants"
	PermissionActionDeleteTenants string = "delete_tenants"

	// PermissionActionCreateReplicate captures enum value "create_replicate"
	PermissionActionCreateReplicate string = "create_replicate"

	// PermissionActionReadReplicate captures enum value "read_replicate"
	PermissionActionReadReplicate string = "read_replicate"

	// PermissionActionUpdateReplicate captures enum value "update_replicate"
	PermissionActionUpdateReplicate string = "update_replicate"

	// PermissionActionDeleteReplicate captures enum value "delete_replicate"
	PermissionActionDeleteReplicate string = "delete_replicate"

	// PermissionActionCreateAliases captures enum value "create_aliases"
	PermissionActionCreateAliases string = "create_aliases"

	// PermissionActionReadAliases captures enum value "read_aliases"
	PermissionActionReadAliases string = "read_aliases"

	// PermissionActionUpdateAliases captures enum value "update_aliases"
	PermissionActionUpdateAliases string = "update_aliases"

	// PermissionActionDeleteAliases captures enum value "delete_aliases"
	PermissionActionDeleteAliases string = "delete_aliases"

	// PermissionActionAssignAndRevokeGroups captures enum value "assign_and_revoke_groups"
	PermissionActionAssignAndRevokeGroups string = "assign_and_revoke_groups"

	// PermissionActionReadGroups captures enum value "read_groups"
	PermissionActionReadGroups string = "read_groups"
)
View Source 
const (

	// PermissionNodesVerbosityVerbose captures enum value "verbose"
	PermissionNodesVerbosityVerbose string = "verbose"

	// PermissionNodesVerbosityMinimal captures enum value "minimal"
	PermissionNodesVerbosityMinimal string = "minimal"
)
View Source 
const (

	// PermissionRolesScopeAll captures enum value "all"
	PermissionRolesScopeAll string = "all"

	// PermissionRolesScopeMatch captures enum value "match"
	PermissionRolesScopeMatch string = "match"
)
View Source 
const (

	// PropertyTokenizationWord captures enum value "word"
	PropertyTokenizationWord string = "word"

	// PropertyTokenizationLowercase captures enum value "lowercase"
	PropertyTokenizationLowercase string = "lowercase"

	// PropertyTokenizationWhitespace captures enum value "whitespace"
	PropertyTokenizationWhitespace string = "whitespace"

	// PropertyTokenizationField captures enum value "field"
	PropertyTokenizationField string = "field"

	// PropertyTokenizationTrigram captures enum value "trigram"
	PropertyTokenizationTrigram string = "trigram"

	// PropertyTokenizationGse captures enum value "gse"
	PropertyTokenizationGse string = "gse"

	// PropertyTokenizationKagomeKr captures enum value "kagome_kr"
	PropertyTokenizationKagomeKr string = "kagome_kr"

	// PropertyTokenizationKagomeJa captures enum value "kagome_ja"
	PropertyTokenizationKagomeJa string = "kagome_ja"

	// PropertyTokenizationGseCh captures enum value "gse_ch"
	PropertyTokenizationGseCh string = "gse_ch"
)
View Source 
const (

	// ReplicationConfigDeletionStrategyNoAutomatedResolution captures enum value "NoAutomatedResolution"
	ReplicationConfigDeletionStrategyNoAutomatedResolution string = "NoAutomatedResolution"

	// ReplicationConfigDeletionStrategyDeleteOnConflict captures enum value "DeleteOnConflict"
	ReplicationConfigDeletionStrategyDeleteOnConflict string = "DeleteOnConflict"

	// ReplicationConfigDeletionStrategyTimeBasedResolution captures enum value "TimeBasedResolution"
	ReplicationConfigDeletionStrategyTimeBasedResolution string = "TimeBasedResolution"
)
View Source 
const (

	// ReplicationReplicateDetailsReplicaResponseTypeCOPY captures enum value "COPY"
	ReplicationReplicateDetailsReplicaResponseTypeCOPY string = "COPY"

	// ReplicationReplicateDetailsReplicaResponseTypeMOVE captures enum value "MOVE"
	ReplicationReplicateDetailsReplicaResponseTypeMOVE string = "MOVE"
)
View Source 
const (

	// ReplicationReplicateDetailsReplicaStatusStateREGISTERED captures enum value "REGISTERED"
	ReplicationReplicateDetailsReplicaStatusStateREGISTERED string = "REGISTERED"

	// ReplicationReplicateDetailsReplicaStatusStateHYDRATING captures enum value "HYDRATING"
	ReplicationReplicateDetailsReplicaStatusStateHYDRATING string = "HYDRATING"

	// ReplicationReplicateDetailsReplicaStatusStateFINALIZING captures enum value "FINALIZING"
	ReplicationReplicateDetailsReplicaStatusStateFINALIZING string = "FINALIZING"

	// ReplicationReplicateDetailsReplicaStatusStateDEHYDRATING captures enum value "DEHYDRATING"
	ReplicationReplicateDetailsReplicaStatusStateDEHYDRATING string = "DEHYDRATING"

	// ReplicationReplicateDetailsReplicaStatusStateREADY captures enum value "READY"
	ReplicationReplicateDetailsReplicaStatusStateREADY string = "READY"

	// ReplicationReplicateDetailsReplicaStatusStateCANCELLED captures enum value "CANCELLED"
	ReplicationReplicateDetailsReplicaStatusStateCANCELLED string = "CANCELLED"
)
View Source 
const (

	// ReplicationReplicateReplicaRequestTypeCOPY captures enum value "COPY"
	ReplicationReplicateReplicaRequestTypeCOPY string = "COPY"

	// ReplicationReplicateReplicaRequestTypeMOVE captures enum value "MOVE"
	ReplicationReplicateReplicaRequestTypeMOVE string = "MOVE"
)
View Source 
const (

	// RestoreConfigRolesOptionsNoRestore captures enum value "noRestore"
	RestoreConfigRolesOptionsNoRestore string = "noRestore"

	// RestoreConfigRolesOptionsAll captures enum value "all"
	RestoreConfigRolesOptionsAll string = "all"
)
View Source 
const (

	// RestoreConfigUsersOptionsNoRestore captures enum value "noRestore"
	RestoreConfigUsersOptionsNoRestore string = "noRestore"

	// RestoreConfigUsersOptionsAll captures enum value "all"
	RestoreConfigUsersOptionsAll string = "all"
)
View Source 
const (

	// StatisticsStatusHEALTHY captures enum value "HEALTHY"
	StatisticsStatusHEALTHY string = "HEALTHY"

	// StatisticsStatusUNHEALTHY captures enum value "UNHEALTHY"
	StatisticsStatusUNHEALTHY string = "UNHEALTHY"

	// StatisticsStatusUNAVAILABLE captures enum value "UNAVAILABLE"
	StatisticsStatusUNAVAILABLE string = "UNAVAILABLE"

	// StatisticsStatusTIMEOUT captures enum value "TIMEOUT"
	StatisticsStatusTIMEOUT string = "TIMEOUT"
)
View Source 
const (

	// TenantActivityStatusACTIVE captures enum value "ACTIVE"
	TenantActivityStatusACTIVE string = "ACTIVE"

	// TenantActivityStatusINACTIVE captures enum value "INACTIVE"
	TenantActivityStatusINACTIVE string = "INACTIVE"

	// TenantActivityStatusOFFLOADED captures enum value "OFFLOADED"
	TenantActivityStatusOFFLOADED string = "OFFLOADED"

	// TenantActivityStatusOFFLOADING captures enum value "OFFLOADING"
	TenantActivityStatusOFFLOADING string = "OFFLOADING"

	// TenantActivityStatusONLOADING captures enum value "ONLOADING"
	TenantActivityStatusONLOADING string = "ONLOADING"

	// TenantActivityStatusHOT captures enum value "HOT"
	TenantActivityStatusHOT string = "HOT"

	// TenantActivityStatusCOLD captures enum value "COLD"
	TenantActivityStatusCOLD string = "COLD"

	// TenantActivityStatusFROZEN captures enum value "FROZEN"
	TenantActivityStatusFROZEN string = "FROZEN"

	// TenantActivityStatusFREEZING captures enum value "FREEZING"
	TenantActivityStatusFREEZING string = "FREEZING"

	// TenantActivityStatusUNFREEZING captures enum value "UNFREEZING"
	TenantActivityStatusUNFREEZING string = "UNFREEZING"
)
View Source 
const (

	// WhereFilterOperatorAnd captures enum value "And"
	WhereFilterOperatorAnd string = "And"

	// WhereFilterOperatorOr captures enum value "Or"
	WhereFilterOperatorOr string = "Or"

	// WhereFilterOperatorEqual captures enum value "Equal"
	WhereFilterOperatorEqual string = "Equal"

	// WhereFilterOperatorLike captures enum value "Like"
	WhereFilterOperatorLike string = "Like"

	// WhereFilterOperatorNotEqual captures enum value "NotEqual"
	WhereFilterOperatorNotEqual string = "NotEqual"

	// WhereFilterOperatorGreaterThan captures enum value "GreaterThan"
	WhereFilterOperatorGreaterThan string = "GreaterThan"

	// WhereFilterOperatorGreaterThanEqual captures enum value "GreaterThanEqual"
	WhereFilterOperatorGreaterThanEqual string = "GreaterThanEqual"

	// WhereFilterOperatorLessThan captures enum value "LessThan"
	WhereFilterOperatorLessThan string = "LessThan"

	// WhereFilterOperatorLessThanEqual captures enum value "LessThanEqual"
	WhereFilterOperatorLessThanEqual string = "LessThanEqual"

	// WhereFilterOperatorWithinGeoRange captures enum value "WithinGeoRange"
	WhereFilterOperatorWithinGeoRange string = "WithinGeoRange"

	// WhereFilterOperatorIsNull captures enum value "IsNull"
	WhereFilterOperatorIsNull string = "IsNull"

	// WhereFilterOperatorContainsAny captures enum value "ContainsAny"
	WhereFilterOperatorContainsAny string = "ContainsAny"

	// WhereFilterOperatorContainsAll captures enum value "ContainsAll"
	WhereFilterOperatorContainsAll string = "ContainsAll"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AdditionalProperties 

type AdditionalProperties map[string]interface{}

AdditionalProperties (Response only) Additional meta information about a single object.

swagger:model AdditionalProperties

func (AdditionalProperties) ContextValidate added in v1.18.0 

func (m AdditionalProperties) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this additional properties based on context it is used

func (AdditionalProperties) Validate 

func (m AdditionalProperties) Validate(formats strfmt.Registry) error

Validate validates this additional properties

type Alias added in v1.32.0 

type Alias struct {

	// The unique name of the alias that serves as an alternative identifier for the collection.
	Alias string `json:"alias,omitempty"`

	// The name of the collection (class) to which this alias is mapped.
	Class string `json:"class,omitempty"`
}

Alias Represents the mapping between an alias name and a collection. An alias provides an alternative name for accessing a collection.

swagger:model Alias

func (*Alias) ContextValidate added in v1.32.0 

func (m *Alias) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this alias based on context it is used

func (*Alias) MarshalBinary added in v1.32.0 

func (m *Alias) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Alias) UnmarshalBinary added in v1.32.0 

func (m *Alias) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Alias) Validate added in v1.32.0 

func (m *Alias) Validate(formats strfmt.Registry) error

Validate validates this alias

type AliasResponse added in v1.32.0 

type AliasResponse struct {

	// Array of alias objects, each containing an alias-to-collection mapping.
	Aliases []*Alias `json:"aliases"`
}

AliasResponse Response object containing a list of alias mappings.

swagger:model AliasResponse

func (*AliasResponse) ContextValidate added in v1.32.0 

func (m *AliasResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this alias response based on the context it is used

func (*AliasResponse) MarshalBinary added in v1.32.0 

func (m *AliasResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AliasResponse) UnmarshalBinary added in v1.32.0 

func (m *AliasResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AliasResponse) Validate added in v1.32.0 

func (m *AliasResponse) Validate(formats strfmt.Registry) error

Validate validates this alias response

type AsyncReplicationStatus added in v1.31.0 

type AsyncReplicationStatus struct {

	// The number of objects propagated in the most recent iteration.
	ObjectsPropagated uint64 `json:"objectsPropagated,omitempty"`

	// The start time of the most recent iteration.
	StartDiffTimeUnixMillis int64 `json:"startDiffTimeUnixMillis,omitempty"`

	// The target node of the replication, if set, otherwise empty.
	TargetNode string `json:"targetNode,omitempty"`
}

AsyncReplicationStatus The status of the async replication.

swagger:model AsyncReplicationStatus

func (*AsyncReplicationStatus) ContextValidate added in v1.31.0 

func (m *AsyncReplicationStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this async replication status based on context it is used

func (*AsyncReplicationStatus) MarshalBinary added in v1.31.0 

func (m *AsyncReplicationStatus) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AsyncReplicationStatus) UnmarshalBinary added in v1.31.0 

func (m *AsyncReplicationStatus) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AsyncReplicationStatus) Validate added in v1.31.0 

func (m *AsyncReplicationStatus) Validate(formats strfmt.Registry) error

Validate validates this async replication status

type BM25Config 

type BM25Config struct {

	// Calibrates term-weight scaling based on the document length (default: 0.75).
	B float32 `json:"b,omitempty"`

	// Calibrates term-weight scaling based on the term frequency within a document (default: 1.2).
	K1 float32 `json:"k1,omitempty"`
}

BM25Config tuning parameters for the BM25 algorithm

swagger:model BM25Config

func (*BM25Config) ContextValidate added in v1.18.0 

func (m *BM25Config) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this b m25 config based on context it is used

func (*BM25Config) MarshalBinary 

func (m *BM25Config) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BM25Config) UnmarshalBinary 

func (m *BM25Config) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BM25Config) Validate 

func (m *BM25Config) Validate(formats strfmt.Registry) error

Validate validates this b m25 config

type BackupConfig added in v1.24.0 

type BackupConfig struct {

	// Name of the bucket, container, volume, etc
	Bucket string `json:"Bucket,omitempty"`

	// Desired CPU core utilization ranging from 1%-80%
	// Maximum: 80
	// Minimum: 1
	CPUPercentage int64 `json:"CPUPercentage,omitempty"`

	// Deprecated, has no effect.
	ChunkSize int64 `json:"ChunkSize,omitempty"`

	// compression level used by compression algorithm
	// Enum: [DefaultCompression BestSpeed BestCompression ZstdDefaultCompression ZstdBestSpeed ZstdBestCompression NoCompression]
	CompressionLevel string `json:"CompressionLevel,omitempty"`

	// name of the endpoint, e.g. s3.amazonaws.com
	Endpoint string `json:"Endpoint,omitempty"`

	// Path or key within the bucket
	Path string `json:"Path,omitempty"`
}

BackupConfig Backup custom configuration

swagger:model BackupConfig

func (*BackupConfig) ContextValidate added in v1.24.0 

func (m *BackupConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this backup config based on context it is used

func (*BackupConfig) MarshalBinary added in v1.24.0 

func (m *BackupConfig) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BackupConfig) UnmarshalBinary added in v1.24.0 

func (m *BackupConfig) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BackupConfig) Validate added in v1.24.0 

func (m *BackupConfig) Validate(formats strfmt.Registry) error

Validate validates this backup config

type BackupCreateRequest 

type BackupCreateRequest struct {

	// Custom configuration for the backup creation process
	Config *BackupConfig `json:"config,omitempty"`

	// List of collections to exclude from the backup creation process. If not set, all collections are included. Cannot be used together with `include`.
	Exclude []string `json:"exclude"`

	// The ID of the backup (required). Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed.
	ID string `json:"id,omitempty"`

	// List of collections to include in the backup creation process. If not set, all collections are included. Cannot be used together with `exclude`.
	Include []string `json:"include"`
}

BackupCreateRequest Request body for creating a backup of a set of classes

swagger:model BackupCreateRequest

func (*BackupCreateRequest) ContextValidate added in v1.18.0 

func (m *BackupCreateRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this backup create request based on the context it is used

func (*BackupCreateRequest) MarshalBinary 

func (m *BackupCreateRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BackupCreateRequest) UnmarshalBinary 

func (m *BackupCreateRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BackupCreateRequest) Validate 

func (m *BackupCreateRequest) Validate(formats strfmt.Registry) error

Validate validates this backup create request

type BackupCreateResponse 

type BackupCreateResponse struct {

	// Backup backend name e.g. filesystem, gcs, s3.
	Backend string `json:"backend,omitempty"`

	// Name of the bucket, container, volume, etc
	Bucket string `json:"bucket,omitempty"`

	// The list of classes for which the backup creation process was started
	Classes []string `json:"classes"`

	// error message if creation failed
	Error string `json:"error,omitempty"`

	// The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed.
	ID string `json:"id,omitempty"`

	// Path within bucket of backup
	Path string `json:"path,omitempty"`

	// phase of backup creation process
	// Enum: [STARTED TRANSFERRING TRANSFERRED SUCCESS FAILED CANCELED]
	Status *string `json:"status,omitempty"`
}

BackupCreateResponse The definition of a backup create response body

swagger:model BackupCreateResponse

func (*BackupCreateResponse) ContextValidate added in v1.18.0 

func (m *BackupCreateResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this backup create response based on context it is used

func (*BackupCreateResponse) MarshalBinary 

func (m *BackupCreateResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BackupCreateResponse) UnmarshalBinary 

func (m *BackupCreateResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BackupCreateResponse) Validate 

func (m *BackupCreateResponse) Validate(formats strfmt.Registry) error

Validate validates this backup create response

type BackupCreateStatusResponse 

type BackupCreateStatusResponse struct {

	// Backup backend name e.g. filesystem, gcs, s3.
	Backend string `json:"backend,omitempty"`

	// Timestamp when the backup process completed (successfully or with failure)
	// Format: date-time
	CompletedAt strfmt.DateTime `json:"completedAt,omitempty"`

	// error message if creation failed
	Error string `json:"error,omitempty"`

	// The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed.
	ID string `json:"id,omitempty"`

	// destination path of backup files proper to selected backend
	Path string `json:"path,omitempty"`

	// Timestamp when the backup process started
	// Format: date-time
	StartedAt strfmt.DateTime `json:"startedAt,omitempty"`

	// phase of backup creation process
	// Enum: [STARTED TRANSFERRING TRANSFERRED SUCCESS FAILED CANCELED]
	Status *string `json:"status,omitempty"`
}

BackupCreateStatusResponse The definition of a backup create metadata

swagger:model BackupCreateStatusResponse

func (*BackupCreateStatusResponse) ContextValidate added in v1.18.0 

func (m *BackupCreateStatusResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this backup create status response based on context it is used

func (*BackupCreateStatusResponse) MarshalBinary 

func (m *BackupCreateStatusResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BackupCreateStatusResponse) UnmarshalBinary 

func (m *BackupCreateStatusResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BackupCreateStatusResponse) Validate 

func (m *BackupCreateStatusResponse) Validate(formats strfmt.Registry) error

Validate validates this backup create status response

type BackupListResponse added in v1.24.25 

type BackupListResponse []*BackupListResponseItems0

BackupListResponse The definition of a backup create response body

swagger:model BackupListResponse

func (BackupListResponse) ContextValidate added in v1.24.25 

func (m BackupListResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this backup list response based on the context it is used

func (BackupListResponse) Validate added in v1.24.25 

func (m BackupListResponse) Validate(formats strfmt.Registry) error

Validate validates this backup list response

type BackupListResponseItems0 added in v1.24.25 

type BackupListResponseItems0 struct {

	// The list of classes for which the existed backup process
	Classes []string `json:"classes"`

	// Timestamp when the backup process completed (successfully or with failure)
	// Format: date-time
	CompletedAt strfmt.DateTime `json:"completedAt,omitempty"`

	// The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed.
	ID string `json:"id,omitempty"`

	// Size of the backup in Gibs
	Size float64 `json:"size,omitempty"`

	// Timestamp when the backup process started
	// Format: date-time
	StartedAt strfmt.DateTime `json:"startedAt,omitempty"`

	// status of backup process
	// Enum: [STARTED TRANSFERRING TRANSFERRED SUCCESS FAILED CANCELED]
	Status string `json:"status,omitempty"`
}

BackupListResponseItems0 backup list response items0

swagger:model BackupListResponseItems0

func (*BackupListResponseItems0) ContextValidate added in v1.24.25 

func (m *BackupListResponseItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this backup list response items0 based on context it is used

func (*BackupListResponseItems0) MarshalBinary added in v1.24.25 

func (m *BackupListResponseItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BackupListResponseItems0) UnmarshalBinary added in v1.24.25 

func (m *BackupListResponseItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BackupListResponseItems0) Validate added in v1.24.25 

func (m *BackupListResponseItems0) Validate(formats strfmt.Registry) error

Validate validates this backup list response items0

type BackupRestoreRequest 

type BackupRestoreRequest struct {

	// Custom configuration for the backup restoration process
	Config *RestoreConfig `json:"config,omitempty"`

	// List of classes to exclude from the backup restoration process
	Exclude []string `json:"exclude"`

	// List of classes to include in the backup restoration process
	Include []string `json:"include"`

	// Allows overriding the node names stored in the backup with different ones. Useful when restoring backups to a different environment.
	NodeMapping map[string]string `json:"node_mapping,omitempty"`

	// Allows ovewriting the collection alias if there is a conflict
	OverwriteAlias bool `json:"overwriteAlias,omitempty"`
}

BackupRestoreRequest Request body for restoring a backup for a set of classes

swagger:model BackupRestoreRequest

func (*BackupRestoreRequest) ContextValidate added in v1.18.0 

func (m *BackupRestoreRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this backup restore request based on the context it is used

func (*BackupRestoreRequest) MarshalBinary 

func (m *BackupRestoreRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BackupRestoreRequest) UnmarshalBinary 

func (m *BackupRestoreRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BackupRestoreRequest) Validate 

func (m *BackupRestoreRequest) Validate(formats strfmt.Registry) error

Validate validates this backup restore request

type BackupRestoreResponse 

type BackupRestoreResponse struct {

	// Backup backend name e.g. filesystem, gcs, s3.
	Backend string `json:"backend,omitempty"`

	// The list of classes for which the backup restoration process was started
	Classes []string `json:"classes"`

	// error message if restoration failed
	Error string `json:"error,omitempty"`

	// The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed.
	ID string `json:"id,omitempty"`

	// destination path of backup files proper to selected backend
	Path string `json:"path,omitempty"`

	// phase of backup restoration process
	// Enum: [STARTED TRANSFERRING TRANSFERRED SUCCESS FAILED CANCELED]
	Status *string `json:"status,omitempty"`
}

BackupRestoreResponse The definition of a backup restore response body

swagger:model BackupRestoreResponse

func (*BackupRestoreResponse) ContextValidate added in v1.18.0 

func (m *BackupRestoreResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this backup restore response based on context it is used

func (*BackupRestoreResponse) MarshalBinary 

func (m *BackupRestoreResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BackupRestoreResponse) UnmarshalBinary 

func (m *BackupRestoreResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BackupRestoreResponse) Validate 

func (m *BackupRestoreResponse) Validate(formats strfmt.Registry) error

Validate validates this backup restore response

type BackupRestoreStatusResponse 

type BackupRestoreStatusResponse struct {

	// Backup backend name e.g. filesystem, gcs, s3.
	Backend string `json:"backend,omitempty"`

	// error message if restoration failed
	Error string `json:"error,omitempty"`

	// The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed.
	ID string `json:"id,omitempty"`

	// destination path of backup files proper to selected backup backend, contains bucket and path
	Path string `json:"path,omitempty"`

	// phase of backup restoration process
	// Enum: [STARTED TRANSFERRING TRANSFERRED SUCCESS FAILED CANCELED]
	Status *string `json:"status,omitempty"`
}

BackupRestoreStatusResponse The definition of a backup restore metadata

swagger:model BackupRestoreStatusResponse

func (*BackupRestoreStatusResponse) ContextValidate added in v1.18.0 

func (m *BackupRestoreStatusResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this backup restore status response based on context it is used

func (*BackupRestoreStatusResponse) MarshalBinary 

func (m *BackupRestoreStatusResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BackupRestoreStatusResponse) UnmarshalBinary 

func (m *BackupRestoreStatusResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BackupRestoreStatusResponse) Validate 

func (m *BackupRestoreStatusResponse) Validate(formats strfmt.Registry) error

Validate validates this backup restore status response

type BatchDelete 

type BatchDelete struct {

	// Timestamp of deletion in milliseconds since epoch UTC.
	DeletionTimeUnixMilli *int64 `json:"deletionTimeUnixMilli,omitempty"`

	// If true, the call will show which objects would be matched using the specified filter without deleting any objects. <br/><br/>Depending on the configured verbosity, you will either receive a count of affected objects, or a list of IDs.
	DryRun *bool `json:"dryRun,omitempty"`

	// match
	Match *BatchDeleteMatch `json:"match,omitempty"`

	// Controls the verbosity of the output, possible values are: "minimal", "verbose". Defaults to "minimal".
	Output *string `json:"output,omitempty"`
}

BatchDelete batch delete

swagger:model BatchDelete

func (*BatchDelete) ContextValidate added in v1.18.0 

func (m *BatchDelete) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this batch delete based on the context it is used

func (*BatchDelete) MarshalBinary 

func (m *BatchDelete) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BatchDelete) UnmarshalBinary 

func (m *BatchDelete) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BatchDelete) Validate 

func (m *BatchDelete) Validate(formats strfmt.Registry) error

Validate validates this batch delete

type BatchDeleteMatch 

type BatchDeleteMatch struct {

	// Class (name) which objects will be deleted.
	// Example: City
	Class string `json:"class,omitempty"`

	// Filter to limit the objects to be deleted.
	Where *WhereFilter `json:"where,omitempty"`
}

BatchDeleteMatch Outlines how to find the objects to be deleted.

swagger:model BatchDeleteMatch

func (*BatchDeleteMatch) ContextValidate added in v1.18.0 

func (m *BatchDeleteMatch) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this batch delete match based on the context it is used

func (*BatchDeleteMatch) MarshalBinary 

func (m *BatchDeleteMatch) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BatchDeleteMatch) UnmarshalBinary 

func (m *BatchDeleteMatch) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BatchDeleteMatch) Validate 

func (m *BatchDeleteMatch) Validate(formats strfmt.Registry) error

Validate validates this batch delete match

type BatchDeleteResponse 

type BatchDeleteResponse struct {

	// Timestamp of deletion in milliseconds since epoch UTC.
	DeletionTimeUnixMilli *int64 `json:"deletionTimeUnixMilli,omitempty"`

	// If true, objects will not be deleted yet, but merely listed. Defaults to false.
	DryRun *bool `json:"dryRun,omitempty"`

	// match
	Match *BatchDeleteResponseMatch `json:"match,omitempty"`

	// Controls the verbosity of the output, possible values are: "minimal", "verbose". Defaults to "minimal".
	Output *string `json:"output,omitempty"`

	// results
	Results *BatchDeleteResponseResults `json:"results,omitempty"`
}

BatchDeleteResponse Delete Objects response.

swagger:model BatchDeleteResponse

func (*BatchDeleteResponse) ContextValidate added in v1.18.0 

func (m *BatchDeleteResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this batch delete response based on the context it is used

func (*BatchDeleteResponse) MarshalBinary 

func (m *BatchDeleteResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BatchDeleteResponse) UnmarshalBinary 

func (m *BatchDeleteResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BatchDeleteResponse) Validate 

func (m *BatchDeleteResponse) Validate(formats strfmt.Registry) error

Validate validates this batch delete response

type BatchDeleteResponseMatch 

type BatchDeleteResponseMatch struct {

	// Class (name) which objects will be deleted.
	// Example: City
	Class string `json:"class,omitempty"`

	// Filter to limit the objects to be deleted.
	Where *WhereFilter `json:"where,omitempty"`
}

BatchDeleteResponseMatch Outlines how to find the objects to be deleted.

swagger:model BatchDeleteResponseMatch

func (*BatchDeleteResponseMatch) ContextValidate added in v1.18.0 

func (m *BatchDeleteResponseMatch) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this batch delete response match based on the context it is used

func (*BatchDeleteResponseMatch) MarshalBinary 

func (m *BatchDeleteResponseMatch) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BatchDeleteResponseMatch) UnmarshalBinary 

func (m *BatchDeleteResponseMatch) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BatchDeleteResponseMatch) Validate 

func (m *BatchDeleteResponseMatch) Validate(formats strfmt.Registry) error

Validate validates this batch delete response match

type BatchDeleteResponseResults 

type BatchDeleteResponseResults struct {

	// How many objects should have been deleted but could not be deleted.
	Failed int64 `json:"failed"`

	// The most amount of objects that can be deleted in a single query, equals QUERY_MAXIMUM_RESULTS.
	Limit int64 `json:"limit"`

	// How many objects were matched by the filter.
	Matches int64 `json:"matches"`

	// With output set to "minimal" only objects with error occurred will the be described. Successfully deleted objects would be omitted. Output set to "verbose" will list all of the objets with their respective statuses.
	Objects []*BatchDeleteResponseResultsObjectsItems0 `json:"objects"`

	// How many objects were successfully deleted in this round.
	Successful int64 `json:"successful"`
}

BatchDeleteResponseResults batch delete response results

swagger:model BatchDeleteResponseResults

func (*BatchDeleteResponseResults) ContextValidate added in v1.18.0 

func (m *BatchDeleteResponseResults) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this batch delete response results based on the context it is used

func (*BatchDeleteResponseResults) MarshalBinary 

func (m *BatchDeleteResponseResults) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BatchDeleteResponseResults) UnmarshalBinary 

func (m *BatchDeleteResponseResults) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BatchDeleteResponseResults) Validate 

func (m *BatchDeleteResponseResults) Validate(formats strfmt.Registry) error

Validate validates this batch delete response results

type BatchDeleteResponseResultsObjectsItems0 

type BatchDeleteResponseResultsObjectsItems0 struct {

	// errors
	Errors *ErrorResponse `json:"errors,omitempty"`

	// ID of the Object.
	// Format: uuid
	ID strfmt.UUID `json:"id,omitempty"`

	// status
	// Enum: [SUCCESS DRYRUN FAILED]
	Status *string `json:"status,omitempty"`
}

BatchDeleteResponseResultsObjectsItems0 Results for this specific Object.

swagger:model BatchDeleteResponseResultsObjectsItems0

func (*BatchDeleteResponseResultsObjectsItems0) ContextValidate added in v1.18.0 

func (m *BatchDeleteResponseResultsObjectsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this batch delete response results objects items0 based on the context it is used

func (*BatchDeleteResponseResultsObjectsItems0) MarshalBinary 

func (m *BatchDeleteResponseResultsObjectsItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BatchDeleteResponseResultsObjectsItems0) UnmarshalBinary 

func (m *BatchDeleteResponseResultsObjectsItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BatchDeleteResponseResultsObjectsItems0) Validate 

func (m *BatchDeleteResponseResultsObjectsItems0) Validate(formats strfmt.Registry) error

Validate validates this batch delete response results objects items0

type BatchReference 

type BatchReference struct {

	// Long-form beacon-style URI to identify the source of the cross-ref including the property name. Should be in the form of weaviate://localhost/<kinds>/<uuid>/<className>/<propertyName>, where <kinds> must be one of 'objects', 'objects' and <className> and <propertyName> must represent the cross-ref property of source class to be used.
	// Example: weaviate://localhost/Zoo/a5d09582-4239-4702-81c9-92a6e0122bb4/hasAnimals
	// Format: uri
	From strfmt.URI `json:"from,omitempty"`

	// Name of the reference tenant.
	Tenant string `json:"tenant,omitempty"`

	// Short-form URI to point to the cross-ref. Should be in the form of weaviate://localhost/<uuid> for the example of a local cross-ref to an object
	// Example: weaviate://localhost/97525810-a9a5-4eb0-858a-71449aeb007f
	// Format: uri
	To strfmt.URI `json:"to,omitempty"`
}

BatchReference batch reference

swagger:model BatchReference

func (*BatchReference) ContextValidate added in v1.18.0 

func (m *BatchReference) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this batch reference based on context it is used

func (*BatchReference) MarshalBinary 

func (m *BatchReference) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BatchReference) UnmarshalBinary 

func (m *BatchReference) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BatchReference) Validate 

func (m *BatchReference) Validate(formats strfmt.Registry) error

Validate validates this batch reference

type BatchReferenceResponse 

type BatchReferenceResponse struct {
	BatchReference

	// result
	Result *BatchReferenceResponseAO1Result `json:"result,omitempty"`
}

BatchReferenceResponse batch reference response

swagger:model BatchReferenceResponse

func (*BatchReferenceResponse) ContextValidate added in v1.18.0 

func (m *BatchReferenceResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this batch reference response based on the context it is used

func (*BatchReferenceResponse) MarshalBinary 

func (m *BatchReferenceResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (BatchReferenceResponse) MarshalJSON 

func (m BatchReferenceResponse) MarshalJSON() ([]byte, error)

MarshalJSON marshals this object to a JSON structure

func (*BatchReferenceResponse) UnmarshalBinary 

func (m *BatchReferenceResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BatchReferenceResponse) UnmarshalJSON 

func (m *BatchReferenceResponse) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this object from a JSON structure

func (*BatchReferenceResponse) Validate 

func (m *BatchReferenceResponse) Validate(formats strfmt.Registry) error

Validate validates this batch reference response

type BatchReferenceResponseAO1Result 

type BatchReferenceResponseAO1Result struct {

	// errors
	Errors *ErrorResponse `json:"errors,omitempty"`

	// status
	// Enum: [SUCCESS FAILED]
	Status *string `json:"status,omitempty"`
}

BatchReferenceResponseAO1Result Results for this specific reference.

swagger:model BatchReferenceResponseAO1Result

func (*BatchReferenceResponseAO1Result) ContextValidate added in v1.18.0 

func (m *BatchReferenceResponseAO1Result) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this batch reference response a o1 result based on the context it is used

func (*BatchReferenceResponseAO1Result) MarshalBinary 

func (m *BatchReferenceResponseAO1Result) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BatchReferenceResponseAO1Result) UnmarshalBinary 

func (m *BatchReferenceResponseAO1Result) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BatchReferenceResponseAO1Result) Validate 

func (m *BatchReferenceResponseAO1Result) Validate(formats strfmt.Registry) error

Validate validates this batch reference response a o1 result

type BatchStats added in v1.21.0 

type BatchStats struct {

	// How many objects are currently in the batch queue.
	QueueLength *int64 `json:"queueLength,omitempty"`

	// How many objects are approximately processed from the batch queue per second.
	RatePerSecond int64 `json:"ratePerSecond"`
}

BatchStats The summary of a nodes batch queue congestion status.

swagger:model BatchStats

func (*BatchStats) ContextValidate added in v1.21.0 

func (m *BatchStats) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this batch stats based on context it is used

func (*BatchStats) MarshalBinary added in v1.21.0 

func (m *BatchStats) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BatchStats) UnmarshalBinary added in v1.21.0 

func (m *BatchStats) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BatchStats) Validate added in v1.21.0 

func (m *BatchStats) Validate(formats strfmt.Registry) error

Validate validates this batch stats

type C11yExtension 

type C11yExtension struct {

	// The new concept you want to extend. Must be an all-lowercase single word, or a space delimited compound word. Examples: 'foobarium', 'my custom concept'
	// Example: foobarium
	Concept string `json:"concept,omitempty"`

	// A list of space-delimited words or a sentence describing what the custom concept is about. Avoid using the custom concept itself. An Example definition for the custom concept 'foobarium': would be 'a naturally occurring element which can only be seen by programmers'
	Definition string `json:"definition,omitempty"`

	// Weight of the definition of the new concept where 1='override existing definition entirely' and 0='ignore custom definition'. Note that if the custom concept is not present in the contextionary yet, the weight cannot be less than 1.
	Weight float32 `json:"weight,omitempty"`
}

C11yExtension A resource describing an extension to the contextinoary, containing both the identifier and the definition of the extension

swagger:model C11yExtension

func (*C11yExtension) ContextValidate added in v1.18.0 

func (m *C11yExtension) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this c11y extension based on context it is used

func (*C11yExtension) MarshalBinary 

func (m *C11yExtension) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*C11yExtension) UnmarshalBinary 

func (m *C11yExtension) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*C11yExtension) Validate 

func (m *C11yExtension) Validate(formats strfmt.Registry) error

Validate validates this c11y extension

type C11yNearestNeighbors 

type C11yNearestNeighbors []*C11yNearestNeighborsItems0

C11yNearestNeighbors C11y function to show the nearest neighbors to a word.

swagger:model C11yNearestNeighbors

func (C11yNearestNeighbors) ContextValidate added in v1.18.0 

func (m C11yNearestNeighbors) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this c11y nearest neighbors based on the context it is used

func (C11yNearestNeighbors) Validate 

func (m C11yNearestNeighbors) Validate(formats strfmt.Registry) error

Validate validates this c11y nearest neighbors

type C11yNearestNeighborsItems0 

type C11yNearestNeighborsItems0 struct {

	// distance
	Distance float32 `json:"distance,omitempty"`

	// word
	Word string `json:"word,omitempty"`
}

C11yNearestNeighborsItems0 c11y nearest neighbors items0

swagger:model C11yNearestNeighborsItems0

func (*C11yNearestNeighborsItems0) ContextValidate added in v1.18.0 

func (m *C11yNearestNeighborsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this c11y nearest neighbors items0 based on context it is used

func (*C11yNearestNeighborsItems0) MarshalBinary 

func (m *C11yNearestNeighborsItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*C11yNearestNeighborsItems0) UnmarshalBinary 

func (m *C11yNearestNeighborsItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*C11yNearestNeighborsItems0) Validate 

func (m *C11yNearestNeighborsItems0) Validate(formats strfmt.Registry) error

Validate validates this c11y nearest neighbors items0

type C11yVector 

type C11yVector []float32

C11yVector A vector representation of the object in the Contextionary. If provided at object creation, this wil take precedence over any vectorizer setting.

swagger:model C11yVector

func (C11yVector) ContextValidate added in v1.18.0 

func (m C11yVector) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this c11y vector based on context it is used

func (C11yVector) Validate 

func (m C11yVector) Validate(formats strfmt.Registry) error

Validate validates this c11y vector

type C11yVectorBasedQuestion 

type C11yVectorBasedQuestion []*C11yVectorBasedQuestionItems0

C11yVectorBasedQuestion Receive question based on array of classes, properties and values.

swagger:model C11yVectorBasedQuestion

func (C11yVectorBasedQuestion) ContextValidate added in v1.18.0 

func (m C11yVectorBasedQuestion) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this c11y vector based question based on the context it is used

func (C11yVectorBasedQuestion) Validate 

func (m C11yVectorBasedQuestion) Validate(formats strfmt.Registry) error

Validate validates this c11y vector based question

type C11yVectorBasedQuestionItems0 

type C11yVectorBasedQuestionItems0 struct {

	// Vectorized properties.
	// Max Items: 300
	// Min Items: 300
	ClassProps []*C11yVectorBasedQuestionItems0ClassPropsItems0 `json:"classProps"`

	// Vectorized classname.
	// Max Items: 300
	// Min Items: 300
	ClassVectors []float32 `json:"classVectors"`
}

C11yVectorBasedQuestionItems0 c11y vector based question items0

swagger:model C11yVectorBasedQuestionItems0

func (*C11yVectorBasedQuestionItems0) ContextValidate added in v1.18.0 

func (m *C11yVectorBasedQuestionItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this c11y vector based question items0 based on the context it is used

func (*C11yVectorBasedQuestionItems0) MarshalBinary 

func (m *C11yVectorBasedQuestionItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*C11yVectorBasedQuestionItems0) UnmarshalBinary 

func (m *C11yVectorBasedQuestionItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*C11yVectorBasedQuestionItems0) Validate 

func (m *C11yVectorBasedQuestionItems0) Validate(formats strfmt.Registry) error

Validate validates this c11y vector based question items0

type C11yVectorBasedQuestionItems0ClassPropsItems0 

type C11yVectorBasedQuestionItems0ClassPropsItems0 struct {

	// props vectors
	PropsVectors []float32 `json:"propsVectors"`

	// String with valuename.
	Value string `json:"value,omitempty"`
}

C11yVectorBasedQuestionItems0ClassPropsItems0 c11y vector based question items0 class props items0

swagger:model C11yVectorBasedQuestionItems0ClassPropsItems0

func (*C11yVectorBasedQuestionItems0ClassPropsItems0) ContextValidate added in v1.18.0 

func (m *C11yVectorBasedQuestionItems0ClassPropsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this c11y vector based question items0 class props items0 based on context it is used

func (*C11yVectorBasedQuestionItems0ClassPropsItems0) MarshalBinary 

func (m *C11yVectorBasedQuestionItems0ClassPropsItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*C11yVectorBasedQuestionItems0ClassPropsItems0) UnmarshalBinary 

func (m *C11yVectorBasedQuestionItems0ClassPropsItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*C11yVectorBasedQuestionItems0ClassPropsItems0) Validate 

func (m *C11yVectorBasedQuestionItems0ClassPropsItems0) Validate(formats strfmt.Registry) error

Validate validates this c11y vector based question items0 class props items0

type C11yWordsResponse 

type C11yWordsResponse struct {

	// concatenated word
	ConcatenatedWord *C11yWordsResponseConcatenatedWord `json:"concatenatedWord,omitempty"`

	// Weighted results for per individual word
	IndividualWords []*C11yWordsResponseIndividualWordsItems0 `json:"individualWords"`
}

C11yWordsResponse An array of available words and contexts.

swagger:model C11yWordsResponse

func (*C11yWordsResponse) ContextValidate added in v1.18.0 

func (m *C11yWordsResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this c11y words response based on the context it is used

func (*C11yWordsResponse) MarshalBinary 

func (m *C11yWordsResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*C11yWordsResponse) UnmarshalBinary 

func (m *C11yWordsResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*C11yWordsResponse) Validate 

func (m *C11yWordsResponse) Validate(formats strfmt.Registry) error

Validate validates this c11y words response

type C11yWordsResponseConcatenatedWord 

type C11yWordsResponseConcatenatedWord struct {

	// concatenated nearest neighbors
	ConcatenatedNearestNeighbors C11yNearestNeighbors `json:"concatenatedNearestNeighbors,omitempty"`

	// concatenated vector
	ConcatenatedVector C11yVector `json:"concatenatedVector,omitempty"`

	// concatenated word
	ConcatenatedWord string `json:"concatenatedWord,omitempty"`

	// single words
	SingleWords []string `json:"singleWords"`
}

C11yWordsResponseConcatenatedWord Weighted results for all words

swagger:model C11yWordsResponseConcatenatedWord

func (*C11yWordsResponseConcatenatedWord) ContextValidate added in v1.18.0 

func (m *C11yWordsResponseConcatenatedWord) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this c11y words response concatenated word based on the context it is used

func (*C11yWordsResponseConcatenatedWord) MarshalBinary 

func (m *C11yWordsResponseConcatenatedWord) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*C11yWordsResponseConcatenatedWord) UnmarshalBinary 

func (m *C11yWordsResponseConcatenatedWord) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*C11yWordsResponseConcatenatedWord) Validate 

func (m *C11yWordsResponseConcatenatedWord) Validate(formats strfmt.Registry) error

Validate validates this c11y words response concatenated word

type C11yWordsResponseIndividualWordsItems0 

type C11yWordsResponseIndividualWordsItems0 struct {

	// info
	Info *C11yWordsResponseIndividualWordsItems0Info `json:"info,omitempty"`

	// present
	Present bool `json:"present,omitempty"`

	// word
	Word string `json:"word,omitempty"`
}

C11yWordsResponseIndividualWordsItems0 c11y words response individual words items0

swagger:model C11yWordsResponseIndividualWordsItems0

func (*C11yWordsResponseIndividualWordsItems0) ContextValidate added in v1.18.0 

func (m *C11yWordsResponseIndividualWordsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this c11y words response individual words items0 based on the context it is used

func (*C11yWordsResponseIndividualWordsItems0) MarshalBinary 

func (m *C11yWordsResponseIndividualWordsItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*C11yWordsResponseIndividualWordsItems0) UnmarshalBinary 

func (m *C11yWordsResponseIndividualWordsItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*C11yWordsResponseIndividualWordsItems0) Validate 

func (m *C11yWordsResponseIndividualWordsItems0) Validate(formats strfmt.Registry) error

Validate validates this c11y words response individual words items0

type C11yWordsResponseIndividualWordsItems0Info 

type C11yWordsResponseIndividualWordsItems0Info struct {

	// nearest neighbors
	NearestNeighbors C11yNearestNeighbors `json:"nearestNeighbors,omitempty"`

	// vector
	Vector C11yVector `json:"vector,omitempty"`
}

C11yWordsResponseIndividualWordsItems0Info c11y words response individual words items0 info

swagger:model C11yWordsResponseIndividualWordsItems0Info

func (*C11yWordsResponseIndividualWordsItems0Info) ContextValidate added in v1.18.0 

func (m *C11yWordsResponseIndividualWordsItems0Info) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this c11y words response individual words items0 info based on the context it is used

func (*C11yWordsResponseIndividualWordsItems0Info) MarshalBinary 

func (m *C11yWordsResponseIndividualWordsItems0Info) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*C11yWordsResponseIndividualWordsItems0Info) UnmarshalBinary 

func (m *C11yWordsResponseIndividualWordsItems0Info) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*C11yWordsResponseIndividualWordsItems0Info) Validate 

func (m *C11yWordsResponseIndividualWordsItems0Info) Validate(formats strfmt.Registry) error

Validate validates this c11y words response individual words items0 info

type Class 

type Class struct {

	// Name of the class (a.k.a. 'collection') (required). Multiple words should be concatenated in CamelCase, e.g. `ArticleAuthor`.
	Class string `json:"class,omitempty"`

	// Description of the collection for metadata purposes.
	Description string `json:"description,omitempty"`

	// inverted index config
	InvertedIndexConfig *InvertedIndexConfig `json:"invertedIndexConfig,omitempty"`

	// Configuration specific to modules in a collection context.
	ModuleConfig interface{} `json:"moduleConfig,omitempty"`

	// multi tenancy config
	MultiTenancyConfig *MultiTenancyConfig `json:"multiTenancyConfig,omitempty"`

	// Define properties of the collection.
	Properties []*Property `json:"properties"`

	// replication config
	ReplicationConfig *ReplicationConfig `json:"replicationConfig,omitempty"`

	// Manage how the index should be sharded and distributed in the cluster
	ShardingConfig interface{} `json:"shardingConfig,omitempty"`

	// Configure named vectors. Either use this field or `vectorizer`, `vectorIndexType`, and `vectorIndexConfig` fields. Available from `v1.24.0`.
	VectorConfig map[string]VectorConfig `json:"vectorConfig,omitempty"`

	// Vector-index config, that is specific to the type of index selected in vectorIndexType
	VectorIndexConfig interface{} `json:"vectorIndexConfig,omitempty"`

	// Name of the vector index to use, eg. (HNSW)
	VectorIndexType string `json:"vectorIndexType,omitempty"`

	// Specify how the vectors for this class should be determined. The options are either 'none' - this means you have to import a vector with each object yourself - or the name of a module that provides vectorization capabilities, such as 'text2vec-contextionary'. If left empty, it will use the globally configured default which can itself either be 'none' or a specific module.
	Vectorizer string `json:"vectorizer,omitempty"`
}

Class class

swagger:model Class

func (*Class) ContextValidate added in v1.18.0 

func (m *Class) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this class based on the context it is used

func (*Class) MarshalBinary 

func (m *Class) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Class) UnmarshalBinary 

func (m *Class) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Class) Validate 

func (m *Class) Validate(formats strfmt.Registry) error

Validate validates this class

type Classification 

type Classification struct {

	// base the text-based classification on these fields (of type text)
	// Example: ["description"]
	BasedOnProperties []string `json:"basedOnProperties"`

	// class (name) which is used in this classification
	// Example: City
	Class string `json:"class,omitempty"`

	// which ref-property to set as part of the classification
	// Example: ["inCountry"]
	ClassifyProperties []string `json:"classifyProperties"`

	// error message if status == failed
	// Example: classify xzy: something went wrong
	Error string `json:"error,omitempty"`

	// filters
	Filters *ClassificationFilters `json:"filters,omitempty"`

	// ID to uniquely identify this classification run
	// Example: ee722219-b8ec-4db1-8f8d-5150bb1a9e0c
	// Format: uuid
	ID strfmt.UUID `json:"id,omitempty"`

	// additional meta information about the classification
	Meta *ClassificationMeta `json:"meta,omitempty"`

	// classification-type specific settings
	Settings interface{} `json:"settings,omitempty"`

	// status of this classification
	// Example: running
	// Enum: [running completed failed]
	Status string `json:"status,omitempty"`

	// which algorithm to use for classifications
	Type string `json:"type,omitempty"`
}

Classification Manage classifications, trigger them and view status of past classifications.

swagger:model Classification

func (*Classification) ContextValidate added in v1.18.0 

func (m *Classification) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this classification based on the context it is used

func (*Classification) MarshalBinary 

func (m *Classification) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Classification) UnmarshalBinary 

func (m *Classification) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Classification) Validate 

func (m *Classification) Validate(formats strfmt.Registry) error

Validate validates this classification

type ClassificationFilters 

type ClassificationFilters struct {

	// limit the objects to be classified
	SourceWhere *WhereFilter `json:"sourceWhere,omitempty"`

	// Limit the possible sources when using an algorithm which doesn't really on training data, e.g. 'contextual'. When using an algorithm with a training set, such as 'knn', limit the training set instead
	TargetWhere *WhereFilter `json:"targetWhere,omitempty"`

	// Limit the training objects to be considered during the classification. Can only be used on types with explicit training sets, such as 'knn'
	TrainingSetWhere *WhereFilter `json:"trainingSetWhere,omitempty"`
}

ClassificationFilters classification filters

swagger:model ClassificationFilters

func (*ClassificationFilters) ContextValidate added in v1.18.0 

func (m *ClassificationFilters) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this classification filters based on the context it is used

func (*ClassificationFilters) MarshalBinary 

func (m *ClassificationFilters) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ClassificationFilters) UnmarshalBinary 

func (m *ClassificationFilters) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ClassificationFilters) Validate 

func (m *ClassificationFilters) Validate(formats strfmt.Registry) error

Validate validates this classification filters

type ClassificationMeta 

type ClassificationMeta struct {

	// time when this classification finished
	// Example: 2017-07-21T17:32:28Z
	// Format: date-time
	Completed strfmt.DateTime `json:"completed,omitempty"`

	// number of objects which were taken into consideration for classification
	// Example: 147
	Count int64 `json:"count,omitempty"`

	// number of objects which could not be classified - see error message for details
	// Example: 7
	CountFailed int64 `json:"countFailed,omitempty"`

	// number of objects successfully classified
	// Example: 140
	CountSucceeded int64 `json:"countSucceeded,omitempty"`

	// time when this classification was started
	// Example: 2017-07-21T17:32:28Z
	// Format: date-time
	Started strfmt.DateTime `json:"started,omitempty"`
}

ClassificationMeta Additional information to a specific classification

swagger:model ClassificationMeta

func (*ClassificationMeta) ContextValidate added in v1.18.0 

func (m *ClassificationMeta) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this classification meta based on context it is used

func (*ClassificationMeta) MarshalBinary 

func (m *ClassificationMeta) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ClassificationMeta) UnmarshalBinary 

func (m *ClassificationMeta) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ClassificationMeta) Validate 

func (m *ClassificationMeta) Validate(formats strfmt.Registry) error

Validate validates this classification meta

type ClusterStatisticsResponse added in v1.25.0 

type ClusterStatisticsResponse struct {

	// statistics
	Statistics []*Statistics `json:"statistics"`

	// synchronized
	Synchronized bool `json:"synchronized"`
}

ClusterStatisticsResponse The cluster statistics of all of the Weaviate nodes

swagger:model ClusterStatisticsResponse

func (*ClusterStatisticsResponse) ContextValidate added in v1.25.0 

func (m *ClusterStatisticsResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this cluster statistics response based on the context it is used

func (*ClusterStatisticsResponse) MarshalBinary added in v1.25.0 

func (m *ClusterStatisticsResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ClusterStatisticsResponse) UnmarshalBinary added in v1.25.0 

func (m *ClusterStatisticsResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ClusterStatisticsResponse) Validate added in v1.25.0 

func (m *ClusterStatisticsResponse) Validate(formats strfmt.Registry) error

Validate validates this cluster statistics response

type DBUserInfo added in v1.30.0 

type DBUserInfo struct {

	// activity status of the returned user
	// Required: true
	Active *bool `json:"active"`

	// First 3 letters of the associated API-key
	// Max Length: 3
	APIKeyFirstLetters string `json:"apiKeyFirstLetters,omitempty"`

	// Date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)
	// Format: date-time
	CreatedAt strfmt.DateTime `json:"createdAt,omitempty"`

	// type of the returned user
	// Required: true
	// Enum: [db_user db_env_user]
	DbUserType *string `json:"dbUserType"`

	// Date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)
	// Format: date-time
	LastUsedAt strfmt.DateTime `json:"lastUsedAt,omitempty"`

	// The role names associated to the user
	// Required: true
	Roles []string `json:"roles"`

	// The user id of the given user
	// Required: true
	UserID *string `json:"userId"`
}

DBUserInfo d b user info

swagger:model DBUserInfo

func (*DBUserInfo) ContextValidate added in v1.30.0 

func (m *DBUserInfo) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this d b user info based on context it is used

func (*DBUserInfo) MarshalBinary added in v1.30.0 

func (m *DBUserInfo) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DBUserInfo) UnmarshalBinary added in v1.30.0 

func (m *DBUserInfo) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DBUserInfo) Validate added in v1.30.0 

func (m *DBUserInfo) Validate(formats strfmt.Registry) error

Validate validates this d b user info

type Deprecation 

type Deprecation struct {

	// Describes which API is effected, usually one of: REST, GraphQL
	APIType string `json:"apiType,omitempty"`

	// The id that uniquely identifies this particular deprecations (mostly used internally)
	ID string `json:"id,omitempty"`

	// The locations within the specified API affected by this deprecation
	Locations []string `json:"locations"`

	// User-required object to not be affected by the (planned) removal
	Mitigation string `json:"mitigation,omitempty"`

	// What this deprecation is about
	Msg string `json:"msg,omitempty"`

	// A best-effort guess of which upcoming version will remove the feature entirely
	PlannedRemovalVersion string `json:"plannedRemovalVersion,omitempty"`

	// If the feature has already been removed, it was removed in this version
	RemovedIn *string `json:"removedIn,omitempty"`

	// If the feature has already been removed, it was removed at this timestamp
	// Format: date-time
	RemovedTime *strfmt.DateTime `json:"removedTime,omitempty"`

	// The deprecation was introduced in this version
	// Format: date-time
	SinceTime strfmt.DateTime `json:"sinceTime,omitempty"`

	// The deprecation was introduced in this version
	SinceVersion string `json:"sinceVersion,omitempty"`

	// Whether the problematic API functionality is deprecated (planned to be removed) or already removed
	Status string `json:"status,omitempty"`
}

Deprecation deprecation

swagger:model Deprecation

func (*Deprecation) ContextValidate added in v1.18.0 

func (m *Deprecation) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this deprecation based on context it is used

func (*Deprecation) MarshalBinary 

func (m *Deprecation) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Deprecation) UnmarshalBinary 

func (m *Deprecation) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Deprecation) Validate 

func (m *Deprecation) Validate(formats strfmt.Registry) error

Validate validates this deprecation

type DistributedTask added in v1.31.0 

type DistributedTask struct {

	// The high level reason why the task failed.
	Error string `json:"error,omitempty"`

	// The time when the task was finished.
	// Format: date-time
	FinishedAt strfmt.DateTime `json:"finishedAt,omitempty"`

	// The nodes that finished the task.
	FinishedNodes []string `json:"finishedNodes"`

	// The ID of the task.
	ID string `json:"id,omitempty"`

	// The payload of the task.
	Payload interface{} `json:"payload,omitempty"`

	// The time when the task was created.
	// Format: date-time
	StartedAt strfmt.DateTime `json:"startedAt,omitempty"`

	// The status of the task.
	Status string `json:"status,omitempty"`

	// The version of the task.
	Version int64 `json:"version,omitempty"`
}

DistributedTask Distributed task metadata.

swagger:model DistributedTask

func (*DistributedTask) ContextValidate added in v1.31.0 

func (m *DistributedTask) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this distributed task based on context it is used

func (*DistributedTask) MarshalBinary added in v1.31.0 

func (m *DistributedTask) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DistributedTask) UnmarshalBinary added in v1.31.0 

func (m *DistributedTask) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DistributedTask) Validate added in v1.31.0 

func (m *DistributedTask) Validate(formats strfmt.Registry) error

Validate validates this distributed task

type DistributedTasks added in v1.31.0 

type DistributedTasks map[string][]DistributedTask

DistributedTasks Active distributed tasks by namespace.

swagger:model DistributedTasks

func (DistributedTasks) ContextValidate added in v1.31.0 

func (m DistributedTasks) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this distributed tasks based on the context it is used

func (DistributedTasks) Validate added in v1.31.0 

func (m DistributedTasks) Validate(formats strfmt.Registry) error

Validate validates this distributed tasks

type ErrorResponse 

type ErrorResponse struct {

	// error
	Error []*ErrorResponseErrorItems0 `json:"error"`
}

ErrorResponse An error response given by Weaviate end-points.

swagger:model ErrorResponse

func (*ErrorResponse) ContextValidate added in v1.18.0 

func (m *ErrorResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this error response based on the context it is used

func (*ErrorResponse) MarshalBinary 

func (m *ErrorResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ErrorResponse) UnmarshalBinary 

func (m *ErrorResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ErrorResponse) Validate 

func (m *ErrorResponse) Validate(formats strfmt.Registry) error

Validate validates this error response

type ErrorResponseErrorItems0 

type ErrorResponseErrorItems0 struct {

	// message
	Message string `json:"message,omitempty"`
}

ErrorResponseErrorItems0 error response error items0

swagger:model ErrorResponseErrorItems0

func (*ErrorResponseErrorItems0) ContextValidate added in v1.18.0 

func (m *ErrorResponseErrorItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this error response error items0 based on context it is used

func (*ErrorResponseErrorItems0) MarshalBinary 

func (m *ErrorResponseErrorItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ErrorResponseErrorItems0) UnmarshalBinary 

func (m *ErrorResponseErrorItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ErrorResponseErrorItems0) Validate 

func (m *ErrorResponseErrorItems0) Validate(formats strfmt.Registry) error

Validate validates this error response error items0

type GeoCoordinates 

type GeoCoordinates struct {

	// The latitude of the point on earth in decimal form
	Latitude *float32 `json:"latitude,omitempty"`

	// The longitude of the point on earth in decimal form
	Longitude *float32 `json:"longitude,omitempty"`
}

GeoCoordinates geo coordinates

swagger:model GeoCoordinates

func (*GeoCoordinates) ContextValidate added in v1.18.0 

func (m *GeoCoordinates) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this geo coordinates based on context it is used

func (*GeoCoordinates) MarshalBinary 

func (m *GeoCoordinates) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GeoCoordinates) UnmarshalBinary 

func (m *GeoCoordinates) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GeoCoordinates) Validate 

func (m *GeoCoordinates) Validate(formats strfmt.Registry) error

Validate validates this geo coordinates

type GraphQLError 

type GraphQLError struct {

	// locations
	Locations []*GraphQLErrorLocationsItems0 `json:"locations"`

	// message
	Message string `json:"message,omitempty"`

	// path
	Path []string `json:"path"`
}

GraphQLError An error response caused by a GraphQL query.

swagger:model GraphQLError

func (*GraphQLError) ContextValidate added in v1.18.0 

func (m *GraphQLError) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this graph q l error based on the context it is used

func (*GraphQLError) MarshalBinary 

func (m *GraphQLError) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GraphQLError) UnmarshalBinary 

func (m *GraphQLError) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GraphQLError) Validate 

func (m *GraphQLError) Validate(formats strfmt.Registry) error

Validate validates this graph q l error

type GraphQLErrorLocationsItems0 

type GraphQLErrorLocationsItems0 struct {

	// column
	Column int64 `json:"column,omitempty"`

	// line
	Line int64 `json:"line,omitempty"`
}

GraphQLErrorLocationsItems0 graph q l error locations items0

swagger:model GraphQLErrorLocationsItems0

func (*GraphQLErrorLocationsItems0) ContextValidate added in v1.18.0 

func (m *GraphQLErrorLocationsItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this graph q l error locations items0 based on context it is used

func (*GraphQLErrorLocationsItems0) MarshalBinary 

func (m *GraphQLErrorLocationsItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GraphQLErrorLocationsItems0) UnmarshalBinary 

func (m *GraphQLErrorLocationsItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GraphQLErrorLocationsItems0) Validate 

func (m *GraphQLErrorLocationsItems0) Validate(formats strfmt.Registry) error

Validate validates this graph q l error locations items0

type GraphQLQueries 

type GraphQLQueries []*GraphQLQuery

GraphQLQueries A list of GraphQL queries.

swagger:model GraphQLQueries

func (GraphQLQueries) ContextValidate added in v1.18.0 

func (m GraphQLQueries) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this graph q l queries based on the context it is used

func (GraphQLQueries) Validate 

func (m GraphQLQueries) Validate(formats strfmt.Registry) error

Validate validates this graph q l queries

type GraphQLQuery 

type GraphQLQuery struct {

	// The name of the operation if multiple exist in the query.
	OperationName string `json:"operationName,omitempty"`

	// Query based on GraphQL syntax.
	Query string `json:"query,omitempty"`

	// Additional variables for the query.
	Variables interface{} `json:"variables,omitempty"`
}

GraphQLQuery GraphQL query based on: http://facebook.github.io/graphql/.

swagger:model GraphQLQuery

func (*GraphQLQuery) ContextValidate added in v1.18.0 

func (m *GraphQLQuery) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this graph q l query based on context it is used

func (*GraphQLQuery) MarshalBinary 

func (m *GraphQLQuery) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GraphQLQuery) UnmarshalBinary 

func (m *GraphQLQuery) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GraphQLQuery) Validate 

func (m *GraphQLQuery) Validate(formats strfmt.Registry) error

Validate validates this graph q l query

type GraphQLResponse 

type GraphQLResponse struct {

	// GraphQL data object.
	Data map[string]JSONObject `json:"data,omitempty"`

	// Array with errors.
	Errors []*GraphQLError `json:"errors,omitempty"`
}

GraphQLResponse GraphQL based response: http://facebook.github.io/graphql/.

swagger:model GraphQLResponse

func (*GraphQLResponse) ContextValidate added in v1.18.0 

func (m *GraphQLResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this graph q l response based on the context it is used

func (*GraphQLResponse) MarshalBinary 

func (m *GraphQLResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GraphQLResponse) UnmarshalBinary 

func (m *GraphQLResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GraphQLResponse) Validate 

func (m *GraphQLResponse) Validate(formats strfmt.Registry) error

Validate validates this graph q l response

type GraphQLResponses 

type GraphQLResponses []*GraphQLResponse

GraphQLResponses A list of GraphQL responses.

swagger:model GraphQLResponses

func (GraphQLResponses) ContextValidate added in v1.18.0 

func (m GraphQLResponses) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this graph q l responses based on the context it is used

func (GraphQLResponses) Validate 

func (m GraphQLResponses) Validate(formats strfmt.Registry) error

Validate validates this graph q l responses

type GroupType added in v1.32.5 

type GroupType string

GroupType If the group contains OIDC or database users.

swagger:model GroupType 

const (

	// GroupTypeOidc captures enum value "oidc"
	GroupTypeOidc GroupType = "oidc"
)

func NewGroupType added in v1.32.5 

func NewGroupType(value GroupType) *GroupType

func (GroupType) ContextValidate added in v1.32.5 

func (m GroupType) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this group type based on context it is used

func (GroupType) Pointer added in v1.32.5 

func (m GroupType) Pointer() *GroupType

Pointer returns a pointer to a freshly-allocated GroupType.

func (GroupType) Validate added in v1.32.5 

func (m GroupType) Validate(formats strfmt.Registry) error

Validate validates this group type

type InvertedIndexConfig 

type InvertedIndexConfig struct {

	// bm25
	Bm25 *BM25Config `json:"bm25,omitempty"`

	// Asynchronous index clean up happens every n seconds
	CleanupIntervalSeconds int64 `json:"cleanupIntervalSeconds,omitempty"`

	// Index each object with the null state (default: 'false').
	IndexNullState bool `json:"indexNullState,omitempty"`

	// Index length of properties (default: 'false').
	IndexPropertyLength bool `json:"indexPropertyLength,omitempty"`

	// Index each object by its internal timestamps (default: 'false').
	IndexTimestamps bool `json:"indexTimestamps,omitempty"`

	// stopwords
	Stopwords *StopwordConfig `json:"stopwords,omitempty"`

	// Using BlockMax WAND for query execution (default: 'false', will be 'true' for new collections created after 1.30).
	UsingBlockMaxWAND bool `json:"usingBlockMaxWAND,omitempty"`
}

InvertedIndexConfig Configure the inverted index built into Weaviate (default: 60).

swagger:model InvertedIndexConfig

func (*InvertedIndexConfig) ContextValidate added in v1.18.0 

func (m *InvertedIndexConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this inverted index config based on the context it is used

func (*InvertedIndexConfig) MarshalBinary 

func (m *InvertedIndexConfig) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*InvertedIndexConfig) UnmarshalBinary 

func (m *InvertedIndexConfig) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*InvertedIndexConfig) Validate 

func (m *InvertedIndexConfig) Validate(formats strfmt.Registry) error

Validate validates this inverted index config

type JSONObject 

type JSONObject interface{}

JSONObject JSON object value.

swagger:model JsonObject 

type Link struct {

	// weaviate documentation about this resource group
	DocumentationHref string `json:"documentationHref,omitempty"`

	// target of the link
	Href string `json:"href,omitempty"`

	// human readable name of the resource group
	Name string `json:"name,omitempty"`

	// relationship if both resources are related, e.g. 'next', 'previous', 'parent', etc.
	Rel string `json:"rel,omitempty"`
}

Link link

swagger:model Link

func (*Link) ContextValidate added in v1.18.0 

func (m *Link) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this link based on context it is used

func (*Link) MarshalBinary 

func (m *Link) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Link) UnmarshalBinary 

func (m *Link) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Link) Validate 

func (m *Link) Validate(formats strfmt.Registry) error

Validate validates this link

type Meta 

type Meta struct {

	// Max message size for GRPC connection in bytes.
	GrpcMaxMessageSize int64 `json:"grpcMaxMessageSize,omitempty"`

	// The url of the host.
	Hostname string `json:"hostname,omitempty"`

	// Module-specific meta information.
	Modules interface{} `json:"modules,omitempty"`

	// The Weaviate server version.
	Version string `json:"version,omitempty"`
}

Meta Contains meta information of the current Weaviate instance.

swagger:model Meta

func (*Meta) ContextValidate added in v1.18.0 

func (m *Meta) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this meta based on context it is used

func (*Meta) MarshalBinary 

func (m *Meta) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Meta) UnmarshalBinary 

func (m *Meta) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Meta) Validate 

func (m *Meta) Validate(formats strfmt.Registry) error

Validate validates this meta

type MultiTenancyConfig added in v1.20.0 

type MultiTenancyConfig struct {

	// Existing tenants should (not) be turned HOT implicitly when they are accessed and in another activity status (default: false).
	AutoTenantActivation bool `json:"autoTenantActivation"`

	// Nonexistent tenants should (not) be created implicitly (default: false).
	AutoTenantCreation bool `json:"autoTenantCreation"`

	// Whether or not multi-tenancy is enabled for this class (default: false).
	Enabled bool `json:"enabled"`
}

MultiTenancyConfig Configuration related to multi-tenancy within a class

swagger:model MultiTenancyConfig

func (*MultiTenancyConfig) ContextValidate added in v1.20.0 

func (m *MultiTenancyConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this multi tenancy config based on context it is used

func (*MultiTenancyConfig) MarshalBinary added in v1.20.0 

func (m *MultiTenancyConfig) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*MultiTenancyConfig) UnmarshalBinary added in v1.20.0 

func (m *MultiTenancyConfig) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*MultiTenancyConfig) Validate added in v1.20.0 

func (m *MultiTenancyConfig) Validate(formats strfmt.Registry) error

Validate validates this multi tenancy config

type MultipleRef 

type MultipleRef []*SingleRef

MultipleRef Multiple instances of references to other objects.

swagger:model MultipleRef

func (MultipleRef) ContextValidate added in v1.18.0 

func (m MultipleRef) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this multiple ref based on the context it is used

func (MultipleRef) Validate 

func (m MultipleRef) Validate(formats strfmt.Registry) error

Validate validates this multiple ref

type NestedProperty added in v1.22.0 

type NestedProperty struct {

	// data type
	DataType []string `json:"dataType"`

	// description
	Description string `json:"description,omitempty"`

	// index filterable
	IndexFilterable *bool `json:"indexFilterable,omitempty"`

	// index range filters
	IndexRangeFilters *bool `json:"indexRangeFilters,omitempty"`

	// index searchable
	IndexSearchable *bool `json:"indexSearchable,omitempty"`

	// name
	Name string `json:"name,omitempty"`

	// The properties of the nested object(s). Applies to object and object[] data types.
	NestedProperties []*NestedProperty `json:"nestedProperties,omitempty"`

	// tokenization
	// Enum: [word lowercase whitespace field trigram gse kagome_kr kagome_ja gse_ch]
	Tokenization string `json:"tokenization,omitempty"`
}

NestedProperty nested property

swagger:model NestedProperty

func (*NestedProperty) ContextValidate added in v1.22.0 

func (m *NestedProperty) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this nested property based on the context it is used

func (*NestedProperty) MarshalBinary added in v1.22.0 

func (m *NestedProperty) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NestedProperty) UnmarshalBinary added in v1.22.0 

func (m *NestedProperty) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NestedProperty) Validate added in v1.22.0 

func (m *NestedProperty) Validate(formats strfmt.Registry) error

Validate validates this nested property

type NodeShardStatus 

type NodeShardStatus struct {

	// The status of the async replication.
	AsyncReplicationStatus []*AsyncReplicationStatus `json:"asyncReplicationStatus"`

	// The name of shard's class.
	Class string `json:"class"`

	// The status of vector compression/quantization.
	Compressed bool `json:"compressed"`

	// The load status of the shard.
	Loaded bool `json:"loaded"`

	// The name of the shard.
	Name string `json:"name"`

	// Number of replicas for the shard.
	NumberOfReplicas int64 `json:"numberOfReplicas,omitempty"`

	// The number of objects in shard.
	ObjectCount int64 `json:"objectCount"`

	// Minimum number of replicas for the shard.
	ReplicationFactor int64 `json:"replicationFactor,omitempty"`

	// The status of the vector indexing process.
	VectorIndexingStatus string `json:"vectorIndexingStatus"`

	// The length of the vector indexing queue.
	VectorQueueLength int64 `json:"vectorQueueLength"`
}

NodeShardStatus The definition of a node shard status response body

swagger:model NodeShardStatus

func (*NodeShardStatus) ContextValidate added in v1.18.0 

func (m *NodeShardStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this node shard status based on the context it is used

func (*NodeShardStatus) MarshalBinary 

func (m *NodeShardStatus) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NodeShardStatus) UnmarshalBinary 

func (m *NodeShardStatus) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NodeShardStatus) Validate 

func (m *NodeShardStatus) Validate(formats strfmt.Registry) error

Validate validates this node shard status

type NodeStats 

type NodeStats struct {

	// The total number of objects in DB.
	ObjectCount int64 `json:"objectCount"`

	// The count of Weaviate's shards. To see this value, set `output` to `verbose`.
	ShardCount int64 `json:"shardCount"`
}

NodeStats The summary of Weaviate's statistics.

swagger:model NodeStats

func (*NodeStats) ContextValidate added in v1.18.0 

func (m *NodeStats) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this node stats based on context it is used

func (*NodeStats) MarshalBinary 

func (m *NodeStats) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NodeStats) UnmarshalBinary 

func (m *NodeStats) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NodeStats) Validate 

func (m *NodeStats) Validate(formats strfmt.Registry) error

Validate validates this node stats

type NodeStatus 

type NodeStatus struct {

	// Weaviate batch statistics.
	BatchStats *BatchStats `json:"batchStats,omitempty"`

	// The gitHash of Weaviate.
	GitHash string `json:"gitHash,omitempty"`

	// The name of the node.
	Name string `json:"name,omitempty"`

	// The list of the shards with it's statistics.
	Shards []*NodeShardStatus `json:"shards"`

	// Weaviate overall statistics.
	Stats *NodeStats `json:"stats,omitempty"`

	// Node's status.
	// Enum: [HEALTHY UNHEALTHY UNAVAILABLE TIMEOUT]
	Status *string `json:"status,omitempty"`

	// The version of Weaviate.
	Version string `json:"version,omitempty"`
}

NodeStatus The definition of a backup node status response body

swagger:model NodeStatus

func (*NodeStatus) ContextValidate added in v1.18.0 

func (m *NodeStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this node status based on the context it is used

func (*NodeStatus) MarshalBinary 

func (m *NodeStatus) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NodeStatus) UnmarshalBinary 

func (m *NodeStatus) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NodeStatus) Validate 

func (m *NodeStatus) Validate(formats strfmt.Registry) error

Validate validates this node status

type NodesStatusResponse 

type NodesStatusResponse struct {

	// nodes
	Nodes []*NodeStatus `json:"nodes"`
}

NodesStatusResponse The status of all of the Weaviate nodes

swagger:model NodesStatusResponse

func (*NodesStatusResponse) ContextValidate added in v1.18.0 

func (m *NodesStatusResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this nodes status response based on the context it is used

func (*NodesStatusResponse) MarshalBinary 

func (m *NodesStatusResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NodesStatusResponse) UnmarshalBinary 

func (m *NodesStatusResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NodesStatusResponse) Validate 

func (m *NodesStatusResponse) Validate(formats strfmt.Registry) error

Validate validates this nodes status response

type Object 

type Object struct {

	// additional
	Additional AdditionalProperties `json:"additional,omitempty"`

	// Class of the Object, defined in the schema.
	Class string `json:"class,omitempty"`

	// (Response only) Timestamp of creation of this object in milliseconds since epoch UTC.
	CreationTimeUnix int64 `json:"creationTimeUnix,omitempty"`

	// ID of the Object.
	// Format: uuid
	ID strfmt.UUID `json:"id,omitempty"`

	// (Response only) Timestamp of the last object update in milliseconds since epoch UTC.
	LastUpdateTimeUnix int64 `json:"lastUpdateTimeUnix,omitempty"`

	// properties
	Properties PropertySchema `json:"properties,omitempty"`

	// Name of the Objects tenant.
	Tenant string `json:"tenant,omitempty"`

	// This field returns vectors associated with the Object. C11yVector, Vector or Vectors values are possible.
	Vector C11yVector `json:"vector,omitempty"`

	// vector weights
	VectorWeights VectorWeights `json:"vectorWeights,omitempty"`

	// This field returns vectors associated with the Object.
	Vectors Vectors `json:"vectors,omitempty"`
}

Object object

swagger:model Object

func (*Object) ContextValidate added in v1.18.0 

func (m *Object) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this object based on the context it is used

func (*Object) MarshalBinary 

func (m *Object) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Object) UnmarshalBinary 

func (m *Object) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Object) Validate 

func (m *Object) Validate(formats strfmt.Registry) error

Validate validates this object

type ObjectsGetResponse 

type ObjectsGetResponse struct {
	Object

	// deprecations
	Deprecations []*Deprecation `json:"deprecations"`

	// result
	Result *ObjectsGetResponseAO2Result `json:"result,omitempty"`
}

ObjectsGetResponse objects get response

swagger:model ObjectsGetResponse

func (*ObjectsGetResponse) ContextValidate added in v1.18.0 

func (m *ObjectsGetResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this objects get response based on the context it is used

func (*ObjectsGetResponse) MarshalBinary 

func (m *ObjectsGetResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (ObjectsGetResponse) MarshalJSON 

func (m ObjectsGetResponse) MarshalJSON() ([]byte, error)

MarshalJSON marshals this object to a JSON structure

func (*ObjectsGetResponse) UnmarshalBinary 

func (m *ObjectsGetResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ObjectsGetResponse) UnmarshalJSON 

func (m *ObjectsGetResponse) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this object from a JSON structure

func (*ObjectsGetResponse) Validate 

func (m *ObjectsGetResponse) Validate(formats strfmt.Registry) error

Validate validates this objects get response

type ObjectsGetResponseAO2Result 

type ObjectsGetResponseAO2Result struct {

	// errors
	Errors *ErrorResponse `json:"errors,omitempty"`

	// status
	// Enum: [SUCCESS FAILED]
	Status *string `json:"status,omitempty"`
}

ObjectsGetResponseAO2Result Results for this specific Object.

swagger:model ObjectsGetResponseAO2Result

func (*ObjectsGetResponseAO2Result) ContextValidate added in v1.18.0 

func (m *ObjectsGetResponseAO2Result) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this objects get response a o2 result based on the context it is used

func (*ObjectsGetResponseAO2Result) MarshalBinary 

func (m *ObjectsGetResponseAO2Result) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ObjectsGetResponseAO2Result) UnmarshalBinary 

func (m *ObjectsGetResponseAO2Result) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ObjectsGetResponseAO2Result) Validate 

func (m *ObjectsGetResponseAO2Result) Validate(formats strfmt.Registry) error

Validate validates this objects get response a o2 result

type ObjectsListResponse 

type ObjectsListResponse struct {

	// deprecations
	Deprecations []*Deprecation `json:"deprecations"`

	// The actual list of Objects.
	Objects []*Object `json:"objects"`

	// The total number of Objects for the query. The number of items in a response may be smaller due to paging.
	TotalResults int64 `json:"totalResults,omitempty"`
}

ObjectsListResponse List of Objects.

swagger:model ObjectsListResponse

func (*ObjectsListResponse) ContextValidate added in v1.18.0 

func (m *ObjectsListResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this objects list response based on the context it is used

func (*ObjectsListResponse) MarshalBinary 

func (m *ObjectsListResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ObjectsListResponse) UnmarshalBinary 

func (m *ObjectsListResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ObjectsListResponse) Validate 

func (m *ObjectsListResponse) Validate(formats strfmt.Registry) error

Validate validates this objects list response

type PatchDocumentAction 

type PatchDocumentAction struct {

	// A string containing a JSON Pointer value.
	From string `json:"from,omitempty"`

	// merge
	Merge *Object `json:"merge,omitempty"`

	// The operation to be performed.
	// Required: true
	// Enum: [add remove replace move copy test]
	Op *string `json:"op"`

	// A JSON-Pointer.
	// Required: true
	Path *string `json:"path"`

	// The value to be used within the operations.
	Value interface{} `json:"value,omitempty"`
}

PatchDocumentAction Either a JSONPatch document as defined by RFC 6902 (from, op, path, value), or a merge document (RFC 7396).

swagger:model PatchDocumentAction

func (*PatchDocumentAction) ContextValidate added in v1.18.0 

func (m *PatchDocumentAction) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this patch document action based on the context it is used

func (*PatchDocumentAction) MarshalBinary 

func (m *PatchDocumentAction) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PatchDocumentAction) UnmarshalBinary 

func (m *PatchDocumentAction) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PatchDocumentAction) Validate 

func (m *PatchDocumentAction) Validate(formats strfmt.Registry) error

Validate validates this patch document action

type PatchDocumentObject 

type PatchDocumentObject struct {

	// A string containing a JSON Pointer value.
	From string `json:"from,omitempty"`

	// merge
	Merge *Object `json:"merge,omitempty"`

	// The operation to be performed.
	// Required: true
	// Enum: [add remove replace move copy test]
	Op *string `json:"op"`

	// A JSON-Pointer.
	// Required: true
	Path *string `json:"path"`

	// The value to be used within the operations.
	Value interface{} `json:"value,omitempty"`
}

PatchDocumentObject Either a JSONPatch document as defined by RFC 6902 (from, op, path, value), or a merge document (RFC 7396).

swagger:model PatchDocumentObject

func (*PatchDocumentObject) ContextValidate added in v1.18.0 

func (m *PatchDocumentObject) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this patch document object based on the context it is used

func (*PatchDocumentObject) MarshalBinary 

func (m *PatchDocumentObject) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PatchDocumentObject) UnmarshalBinary 

func (m *PatchDocumentObject) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PatchDocumentObject) Validate 

func (m *PatchDocumentObject) Validate(formats strfmt.Registry) error

Validate validates this patch document object

type PeerUpdate 

type PeerUpdate struct {

	// The session ID of the peer.
	// Format: uuid
	ID strfmt.UUID `json:"id,omitempty"`

	// Human readable name.
	Name string `json:"name,omitempty"`

	// The latest known hash of the peer's schema.
	SchemaHash string `json:"schemaHash,omitempty"`

	// The location where the peer is exposed to the internet.
	// Format: uri
	URI strfmt.URI `json:"uri,omitempty"`
}

PeerUpdate A single peer in the network.

swagger:model PeerUpdate

func (*PeerUpdate) ContextValidate added in v1.18.0 

func (m *PeerUpdate) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this peer update based on context it is used

func (*PeerUpdate) MarshalBinary 

func (m *PeerUpdate) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PeerUpdate) UnmarshalBinary 

func (m *PeerUpdate) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PeerUpdate) Validate 

func (m *PeerUpdate) Validate(formats strfmt.Registry) error

Validate validates this peer update

type PeerUpdateList 

type PeerUpdateList []*PeerUpdate

PeerUpdateList List of known peers.

swagger:model PeerUpdateList

func (PeerUpdateList) ContextValidate added in v1.18.0 

func (m PeerUpdateList) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this peer update list based on the context it is used

func (PeerUpdateList) Validate 

func (m PeerUpdateList) Validate(formats strfmt.Registry) error

Validate validates this peer update list

type Permission added in v1.28.0 

type Permission struct {

	// allowed actions in weaviate.
	// Required: true
	// Enum: [manage_backups read_cluster create_data read_data update_data delete_data read_nodes create_roles read_roles update_roles delete_roles create_collections read_collections update_collections delete_collections assign_and_revoke_users create_users read_users update_users delete_users create_tenants read_tenants update_tenants delete_tenants create_replicate read_replicate update_replicate delete_replicate create_aliases read_aliases update_aliases delete_aliases assign_and_revoke_groups read_groups]
	Action *string `json:"action"`

	// aliases
	Aliases *PermissionAliases `json:"aliases,omitempty"`

	// backups
	Backups *PermissionBackups `json:"backups,omitempty"`

	// collections
	Collections *PermissionCollections `json:"collections,omitempty"`

	// data
	Data *PermissionData `json:"data,omitempty"`

	// groups
	Groups *PermissionGroups `json:"groups,omitempty"`

	// nodes
	Nodes *PermissionNodes `json:"nodes,omitempty"`

	// replicate
	Replicate *PermissionReplicate `json:"replicate,omitempty"`

	// roles
	Roles *PermissionRoles `json:"roles,omitempty"`

	// tenants
	Tenants *PermissionTenants `json:"tenants,omitempty"`

	// users
	Users *PermissionUsers `json:"users,omitempty"`
}

Permission permissions attached to a role.

swagger:model Permission

func (*Permission) ContextValidate added in v1.28.0 

func (m *Permission) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this permission based on the context it is used

func (*Permission) MarshalBinary added in v1.28.0 

func (m *Permission) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Permission) UnmarshalBinary added in v1.28.0 

func (m *Permission) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Permission) Validate added in v1.28.0 

func (m *Permission) Validate(formats strfmt.Registry) error

Validate validates this permission

type PermissionAliases added in v1.32.0 

type PermissionAliases struct {

	// A string that specifies which aliases this permission applies to. Can be an exact alias name or a regex pattern. The default value `*` applies the permission to all aliases.
	Alias *string `json:"alias,omitempty"`

	// A string that specifies which collections this permission applies to. Can be an exact collection name or a regex pattern. The default value `*` applies the permission to all collections.
	Collection *string `json:"collection,omitempty"`
}

PermissionAliases Resource definition for alias-related actions and permissions. Used to specify which aliases and collections can be accessed or modified.

swagger:model PermissionAliases

func (*PermissionAliases) ContextValidate added in v1.32.0 

func (m *PermissionAliases) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this permission aliases based on context it is used

func (*PermissionAliases) MarshalBinary added in v1.32.0 

func (m *PermissionAliases) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PermissionAliases) UnmarshalBinary added in v1.32.0 

func (m *PermissionAliases) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PermissionAliases) Validate added in v1.32.0 

func (m *PermissionAliases) Validate(formats strfmt.Registry) error

Validate validates this permission aliases

type PermissionBackups added in v1.28.0 

type PermissionBackups struct {

	// string or regex. if a specific collection name, if left empty it will be ALL or *
	Collection *string `json:"collection,omitempty"`
}

PermissionBackups resources applicable for backup actions

swagger:model PermissionBackups

func (*PermissionBackups) ContextValidate added in v1.28.0 

func (m *PermissionBackups) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this permission backups based on context it is used

func (*PermissionBackups) MarshalBinary added in v1.28.0 

func (m *PermissionBackups) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PermissionBackups) UnmarshalBinary added in v1.28.0 

func (m *PermissionBackups) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PermissionBackups) Validate added in v1.28.0 

func (m *PermissionBackups) Validate(formats strfmt.Registry) error

Validate validates this permission backups

type PermissionCollections added in v1.28.0 

type PermissionCollections struct {

	// string or regex. if a specific collection name, if left empty it will be ALL or *
	Collection *string `json:"collection,omitempty"`
}

PermissionCollections resources applicable for collection and/or tenant actions

swagger:model PermissionCollections

func (*PermissionCollections) ContextValidate added in v1.28.0 

func (m *PermissionCollections) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this permission collections based on context it is used

func (*PermissionCollections) MarshalBinary added in v1.28.0 

func (m *PermissionCollections) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PermissionCollections) UnmarshalBinary added in v1.28.0 

func (m *PermissionCollections) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PermissionCollections) Validate added in v1.28.0 

func (m *PermissionCollections) Validate(formats strfmt.Registry) error

Validate validates this permission collections

type PermissionData added in v1.28.0 

type PermissionData struct {

	// string or regex. if a specific collection name, if left empty it will be ALL or *
	Collection *string `json:"collection,omitempty"`

	// string or regex. if a specific object ID, if left empty it will be ALL or *
	Object *string `json:"object,omitempty"`

	// string or regex. if a specific tenant name, if left empty it will be ALL or *
	Tenant *string `json:"tenant,omitempty"`
}

PermissionData resources applicable for data actions

swagger:model PermissionData

func (*PermissionData) ContextValidate added in v1.28.0 

func (m *PermissionData) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this permission data based on context it is used

func (*PermissionData) MarshalBinary added in v1.28.0 

func (m *PermissionData) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PermissionData) UnmarshalBinary added in v1.28.0 

func (m *PermissionData) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PermissionData) Validate added in v1.28.0 

func (m *PermissionData) Validate(formats strfmt.Registry) error

Validate validates this permission data

type PermissionGroups added in v1.32.5 

type PermissionGroups struct {

	// A string that specifies which groups this permission applies to. Can be an exact group name or a regex pattern. The default value `*` applies the permission to all groups.
	Group *string `json:"group,omitempty"`

	// group type
	GroupType GroupType `json:"groupType,omitempty"`
}

PermissionGroups Resources applicable for group actions.

swagger:model PermissionGroups

func (*PermissionGroups) ContextValidate added in v1.32.5 

func (m *PermissionGroups) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this permission groups based on the context it is used

func (*PermissionGroups) MarshalBinary added in v1.32.5 

func (m *PermissionGroups) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PermissionGroups) UnmarshalBinary added in v1.32.5 

func (m *PermissionGroups) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PermissionGroups) Validate added in v1.32.5 

func (m *PermissionGroups) Validate(formats strfmt.Registry) error

Validate validates this permission groups

type PermissionNodes added in v1.28.0 

type PermissionNodes struct {

	// string or regex. if a specific collection name, if left empty it will be ALL or *
	Collection *string `json:"collection,omitempty"`

	// whether to allow (verbose) returning shards and stats data in the response
	// Enum: [verbose minimal]
	Verbosity *string `json:"verbosity,omitempty"`
}

PermissionNodes resources applicable for cluster actions

swagger:model PermissionNodes

func (*PermissionNodes) ContextValidate added in v1.28.0 

func (m *PermissionNodes) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this permission nodes based on context it is used

func (*PermissionNodes) MarshalBinary added in v1.28.0 

func (m *PermissionNodes) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PermissionNodes) UnmarshalBinary added in v1.28.0 

func (m *PermissionNodes) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PermissionNodes) Validate added in v1.28.0 

func (m *PermissionNodes) Validate(formats strfmt.Registry) error

Validate validates this permission nodes

type PermissionReplicate added in v1.31.0 

type PermissionReplicate struct {

	// string or regex. if a specific collection name, if left empty it will be ALL or *
	Collection *string `json:"collection,omitempty"`

	// string or regex. if a specific shard name, if left empty it will be ALL or *
	Shard *string `json:"shard,omitempty"`
}

PermissionReplicate resources applicable for replicate actions

swagger:model PermissionReplicate

func (*PermissionReplicate) ContextValidate added in v1.31.0 

func (m *PermissionReplicate) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this permission replicate based on context it is used

func (*PermissionReplicate) MarshalBinary added in v1.31.0 

func (m *PermissionReplicate) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PermissionReplicate) UnmarshalBinary added in v1.31.0 

func (m *PermissionReplicate) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PermissionReplicate) Validate added in v1.31.0 

func (m *PermissionReplicate) Validate(formats strfmt.Registry) error

Validate validates this permission replicate

type PermissionRoles added in v1.28.0 

type PermissionRoles struct {

	// string or regex. if a specific role name, if left empty it will be ALL or *
	Role *string `json:"role,omitempty"`

	// set the scope for the manage role permission
	// Enum: [all match]
	Scope *string `json:"scope,omitempty"`
}

PermissionRoles resources applicable for role actions

swagger:model PermissionRoles

func (*PermissionRoles) ContextValidate added in v1.28.0 

func (m *PermissionRoles) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this permission roles based on context it is used

func (*PermissionRoles) MarshalBinary added in v1.28.0 

func (m *PermissionRoles) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PermissionRoles) UnmarshalBinary added in v1.28.0 

func (m *PermissionRoles) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PermissionRoles) Validate added in v1.28.0 

func (m *PermissionRoles) Validate(formats strfmt.Registry) error

Validate validates this permission roles

type PermissionTenants added in v1.28.3 

type PermissionTenants struct {

	// string or regex. if a specific collection name, if left empty it will be ALL or *
	Collection *string `json:"collection,omitempty"`

	// string or regex. if a specific tenant name, if left empty it will be ALL or *
	Tenant *string `json:"tenant,omitempty"`
}

PermissionTenants resources applicable for tenant actions

swagger:model PermissionTenants

func (*PermissionTenants) ContextValidate added in v1.28.3 

func (m *PermissionTenants) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this permission tenants based on context it is used

func (*PermissionTenants) MarshalBinary added in v1.28.3 

func (m *PermissionTenants) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PermissionTenants) UnmarshalBinary added in v1.28.3 

func (m *PermissionTenants) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PermissionTenants) Validate added in v1.28.3 

func (m *PermissionTenants) Validate(formats strfmt.Registry) error

Validate validates this permission tenants

type PermissionUsers added in v1.28.5 

type PermissionUsers struct {

	// string or regex. if a specific name, if left empty it will be ALL or *
	Users *string `json:"users,omitempty"`
}

PermissionUsers resources applicable for user actions

swagger:model PermissionUsers

func (*PermissionUsers) ContextValidate added in v1.28.5 

func (m *PermissionUsers) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this permission users based on context it is used

func (*PermissionUsers) MarshalBinary added in v1.28.5 

func (m *PermissionUsers) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PermissionUsers) UnmarshalBinary added in v1.28.5 

func (m *PermissionUsers) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PermissionUsers) Validate added in v1.28.5 

func (m *PermissionUsers) Validate(formats strfmt.Registry) error

Validate validates this permission users

type PhoneNumber 

type PhoneNumber struct {

	// Read-only. The numerical country code (e.g. 49)
	CountryCode uint64 `json:"countryCode,omitempty"`

	// Optional. The ISO 3166-1 alpha-2 country code. This is used to figure out the correct countryCode and international format if only a national number (e.g. 0123 4567) is provided
	DefaultCountry string `json:"defaultCountry,omitempty"`

	// The raw input as the phone number is present in your raw data set. It will be parsed into the standardized formats if valid.
	Input string `json:"input,omitempty"`

	// Read-only. Parsed result in the international format (e.g. +49 123 ...)
	InternationalFormatted string `json:"internationalFormatted,omitempty"`

	// Read-only. The numerical representation of the national part
	National uint64 `json:"national,omitempty"`

	// Read-only. Parsed result in the national format (e.g. 0123 456789)
	NationalFormatted string `json:"nationalFormatted,omitempty"`

	// Read-only. Indicates whether the parsed number is a valid phone number
	Valid bool `json:"valid,omitempty"`
}

PhoneNumber phone number

swagger:model PhoneNumber

func (*PhoneNumber) ContextValidate added in v1.18.0 

func (m *PhoneNumber) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this phone number based on context it is used

func (*PhoneNumber) MarshalBinary 

func (m *PhoneNumber) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PhoneNumber) UnmarshalBinary 

func (m *PhoneNumber) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PhoneNumber) Validate 

func (m *PhoneNumber) Validate(formats strfmt.Registry) error

Validate validates this phone number

type Principal 

type Principal struct {

	// groups
	Groups []string `json:"groups"`

	// user type
	UserType UserTypeInput `json:"userType,omitempty"`

	// The username that was extracted either from the authentication information
	Username string `json:"username,omitempty"`
}

Principal principal

swagger:model Principal

func (*Principal) ContextValidate added in v1.18.0 

func (m *Principal) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this principal based on the context it is used

func (*Principal) MarshalBinary 

func (m *Principal) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Principal) UnmarshalBinary 

func (m *Principal) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Principal) Validate 

func (m *Principal) Validate(formats strfmt.Registry) error

Validate validates this principal

type Property 

type Property struct {

	// Data type of the property (required). If it starts with a capital (for example Person), may be a reference to another type.
	DataType []string `json:"dataType"`

	// Description of the property.
	Description string `json:"description,omitempty"`

	// Whether to include this property in the filterable, Roaring Bitmap index. If `false`, this property cannot be used in `where` filters. <br/><br/>Note: Unrelated to vectorization behavior.
	IndexFilterable *bool `json:"indexFilterable,omitempty"`

	// (Deprecated). Whether to include this property in the inverted index. If `false`, this property cannot be used in `where` filters, `bm25` or `hybrid` search. <br/><br/>Unrelated to vectorization behavior (deprecated as of v1.19; use indexFilterable or/and indexSearchable instead)
	IndexInverted *bool `json:"indexInverted,omitempty"`

	// Whether to include this property in the filterable, range-based Roaring Bitmap index. Provides better performance for range queries compared to filterable index in large datasets. Applicable only to properties of data type int, number, date.
	IndexRangeFilters *bool `json:"indexRangeFilters,omitempty"`

	// Optional. Should this property be indexed in the inverted index. Defaults to true. Applicable only to properties of data type text and text[]. If you choose false, you will not be able to use this property in bm25 or hybrid search. This property has no affect on vectorization decisions done by modules
	IndexSearchable *bool `json:"indexSearchable,omitempty"`

	// Configuration specific to modules this Weaviate instance has installed
	ModuleConfig interface{} `json:"moduleConfig,omitempty"`

	// The name of the property (required). Multiple words should be concatenated in camelCase, e.g. `nameOfAuthor`.
	Name string `json:"name,omitempty"`

	// The properties of the nested object(s). Applies to object and object[] data types.
	NestedProperties []*NestedProperty `json:"nestedProperties,omitempty"`

	// Determines tokenization of the property as separate words or whole field. Optional. Applies to text and text[] data types. Allowed values are `word` (default; splits on any non-alphanumerical, lowercases), `lowercase` (splits on white spaces, lowercases), `whitespace` (splits on white spaces), `field` (trims). Not supported for remaining data types
	// Enum: [word lowercase whitespace field trigram gse kagome_kr kagome_ja gse_ch]
	Tokenization string `json:"tokenization,omitempty"`
}

Property property

swagger:model Property

func (*Property) ContextValidate added in v1.18.0 

func (m *Property) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this property based on the context it is used

func (*Property) MarshalBinary 

func (m *Property) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Property) UnmarshalBinary 

func (m *Property) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Property) Validate 

func (m *Property) Validate(formats strfmt.Registry) error

Validate validates this property

type PropertySchema 

type PropertySchema interface{}

PropertySchema Names and values of an individual property. A returned response may also contain additional metadata, such as from classification or feature projection.

swagger:model PropertySchema

type RaftStatistics added in v1.25.0 

type RaftStatistics struct {

	// applied index
	AppliedIndex string `json:"appliedIndex,omitempty"`

	// commit index
	CommitIndex string `json:"commitIndex,omitempty"`

	// fsm pending
	FsmPending string `json:"fsmPending,omitempty"`

	// last contact
	LastContact string `json:"lastContact,omitempty"`

	// last log index
	LastLogIndex string `json:"lastLogIndex,omitempty"`

	// last log term
	LastLogTerm string `json:"lastLogTerm,omitempty"`

	// last snapshot index
	LastSnapshotIndex string `json:"lastSnapshotIndex,omitempty"`

	// last snapshot term
	LastSnapshotTerm string `json:"lastSnapshotTerm,omitempty"`

	// Weaviate Raft nodes.
	LatestConfiguration interface{} `json:"latestConfiguration,omitempty"`

	// latest configuration index
	LatestConfigurationIndex string `json:"latestConfigurationIndex,omitempty"`

	// num peers
	NumPeers string `json:"numPeers,omitempty"`

	// protocol version
	ProtocolVersion string `json:"protocolVersion,omitempty"`

	// protocol version max
	ProtocolVersionMax string `json:"protocolVersionMax,omitempty"`

	// protocol version min
	ProtocolVersionMin string `json:"protocolVersionMin,omitempty"`

	// snapshot version max
	SnapshotVersionMax string `json:"snapshotVersionMax,omitempty"`

	// snapshot version min
	SnapshotVersionMin string `json:"snapshotVersionMin,omitempty"`

	// state
	State string `json:"state,omitempty"`

	// term
	Term string `json:"term,omitempty"`
}

RaftStatistics The definition of Raft statistics.

swagger:model RaftStatistics

func (*RaftStatistics) ContextValidate added in v1.25.0 

func (m *RaftStatistics) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this raft statistics based on context it is used

func (*RaftStatistics) MarshalBinary added in v1.25.0 

func (m *RaftStatistics) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RaftStatistics) UnmarshalBinary added in v1.25.0 

func (m *RaftStatistics) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RaftStatistics) Validate added in v1.25.0 

func (m *RaftStatistics) Validate(formats strfmt.Registry) error

Validate validates this raft statistics

type ReferenceMetaClassification 

type ReferenceMetaClassification struct {

	// The lowest distance of a neighbor in the losing group. Optional. If k equals the size of the winning group, there is no losing group
	ClosestLosingDistance *float64 `json:"closestLosingDistance,omitempty"`

	// The lowest distance of any neighbor, regardless of whether they were in the winning or losing group
	ClosestOverallDistance float64 `json:"closestOverallDistance,omitempty"`

	// Closest distance of a neighbor from the winning group
	ClosestWinningDistance float64 `json:"closestWinningDistance,omitempty"`

	// size of the losing group, can be 0 if the winning group size equals k
	LosingCount int64 `json:"losingCount,omitempty"`

	// deprecated - do not use, to be removed in 0.23.0
	LosingDistance *float64 `json:"losingDistance,omitempty"`

	// Mean distance of all neighbors from the losing group. Optional. If k equals the size of the winning group, there is no losing group.
	MeanLosingDistance *float64 `json:"meanLosingDistance,omitempty"`

	// Mean distance of all neighbors from the winning group
	MeanWinningDistance float64 `json:"meanWinningDistance,omitempty"`

	// overall neighbors checked as part of the classification. In most cases this will equal k, but could be lower than k - for example if not enough data was present
	OverallCount int64 `json:"overallCount,omitempty"`

	// size of the winning group, a number between 1..k
	WinningCount int64 `json:"winningCount,omitempty"`

	// deprecated - do not use, to be removed in 0.23.0
	WinningDistance float64 `json:"winningDistance,omitempty"`
}

ReferenceMetaClassification This meta field contains additional info about the classified reference property

swagger:model ReferenceMetaClassification

func (*ReferenceMetaClassification) ContextValidate added in v1.18.0 

func (m *ReferenceMetaClassification) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this reference meta classification based on context it is used

func (*ReferenceMetaClassification) MarshalBinary 

func (m *ReferenceMetaClassification) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ReferenceMetaClassification) UnmarshalBinary 

func (m *ReferenceMetaClassification) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ReferenceMetaClassification) Validate 

func (m *ReferenceMetaClassification) Validate(formats strfmt.Registry) error

Validate validates this reference meta classification

type ReplicationConfig 

type ReplicationConfig struct {

	// Enable asynchronous replication (default: false).
	AsyncEnabled bool `json:"asyncEnabled"`

	// Conflict resolution strategy for deleted objects.
	// Enum: [NoAutomatedResolution DeleteOnConflict TimeBasedResolution]
	DeletionStrategy string `json:"deletionStrategy,omitempty"`

	// Number of times a class is replicated (default: 1).
	Factor int64 `json:"factor,omitempty"`
}

ReplicationConfig Configure how replication is executed in a cluster

swagger:model ReplicationConfig

func (*ReplicationConfig) ContextValidate added in v1.18.0 

func (m *ReplicationConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this replication config based on context it is used

func (*ReplicationConfig) MarshalBinary 

func (m *ReplicationConfig) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ReplicationConfig) UnmarshalBinary 

func (m *ReplicationConfig) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ReplicationConfig) Validate 

func (m *ReplicationConfig) Validate(formats strfmt.Registry) error

Validate validates this replication config

type ReplicationDeleteReplicaRequest added in v1.31.0 

type ReplicationDeleteReplicaRequest struct {

	// The name of the collection to which the shard replica belongs.
	// Required: true
	Collection *string `json:"collection"`

	// The name of the Weaviate node from which the shard replica will be deleted.
	// Required: true
	Node *string `json:"node"`

	// The ID of the shard whose replica is to be deleted.
	// Required: true
	Shard *string `json:"shard"`
}

ReplicationDeleteReplicaRequest Specifies the parameters required to permanently delete a specific shard replica from a particular node. This action will remove the replica's data from the node.

swagger:model ReplicationDeleteReplicaRequest

func (*ReplicationDeleteReplicaRequest) ContextValidate added in v1.31.0 

func (m *ReplicationDeleteReplicaRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this replication delete replica request based on context it is used

func (*ReplicationDeleteReplicaRequest) MarshalBinary added in v1.31.0 

func (m *ReplicationDeleteReplicaRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ReplicationDeleteReplicaRequest) UnmarshalBinary added in v1.31.0 

func (m *ReplicationDeleteReplicaRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ReplicationDeleteReplicaRequest) Validate added in v1.31.0 

func (m *ReplicationDeleteReplicaRequest) Validate(formats strfmt.Registry) error

Validate validates this replication delete replica request

type ReplicationDisableReplicaRequest added in v1.31.0 

type ReplicationDisableReplicaRequest struct {

	// The name of the collection to which the shard replica belongs.
	// Required: true
	Collection *string `json:"collection"`

	// The name of the Weaviate node hosting the shard replica that is to be disabled.
	// Required: true
	Node *string `json:"node"`

	// The ID of the shard whose replica is to be disabled.
	// Required: true
	Shard *string `json:"shard"`
}

ReplicationDisableReplicaRequest Specifies the parameters required to mark a specific shard replica as inactive (soft-delete) on a particular node. This action typically prevents the replica from serving requests but does not immediately remove its data.

swagger:model ReplicationDisableReplicaRequest

func (*ReplicationDisableReplicaRequest) ContextValidate added in v1.31.0 

func (m *ReplicationDisableReplicaRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this replication disable replica request based on context it is used

func (*ReplicationDisableReplicaRequest) MarshalBinary added in v1.31.0 

func (m *ReplicationDisableReplicaRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ReplicationDisableReplicaRequest) UnmarshalBinary added in v1.31.0 

func (m *ReplicationDisableReplicaRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ReplicationDisableReplicaRequest) Validate added in v1.31.0 

func (m *ReplicationDisableReplicaRequest) Validate(formats strfmt.Registry) error

Validate validates this replication disable replica request

type ReplicationReplicateDetailsReplicaResponse added in v1.31.0 

type ReplicationReplicateDetailsReplicaResponse struct {

	// The name of the collection to which the shard being replicated belongs.
	// Required: true
	Collection *string `json:"collection"`

	// The unique identifier (ID) of this specific replication operation.
	// Required: true
	// Format: uuid
	ID *strfmt.UUID `json:"id"`

	// Whether the replica operation is scheduled for cancellation.
	ScheduledForCancel bool `json:"scheduledForCancel,omitempty"`

	// Whether the replica operation is scheduled for deletion.
	ScheduledForDelete bool `json:"scheduledForDelete,omitempty"`

	// The name of the shard involved in this replication operation.
	// Required: true
	Shard *string `json:"shard"`

	// The identifier of the node from which the replica is being moved or copied (the source node).
	// Required: true
	SourceNode *string `json:"sourceNode"`

	// An object detailing the current operational state of the replica movement and any errors encountered.
	// Required: true
	Status *ReplicationReplicateDetailsReplicaStatus `json:"status"`

	// An array detailing the historical sequence of statuses the replication operation has transitioned through, if requested and available.
	StatusHistory []*ReplicationReplicateDetailsReplicaStatus `json:"statusHistory"`

	// The identifier of the node to which the replica is being moved or copied (the target node).
	// Required: true
	TargetNode *string `json:"targetNode"`

	// Indicates whether the operation is a 'COPY' (source replica remains) or a 'MOVE' (source replica is removed after successful transfer).
	// Required: true
	// Enum: [COPY MOVE]
	Type *string `json:"type"`

	// Whether the replica operation is uncancelable.
	Uncancelable bool `json:"uncancelable,omitempty"`

	// The UNIX timestamp in ms when the replication operation was initiated. This is an approximate time and so should not be used for precise timing.
	WhenStartedUnixMs int64 `json:"whenStartedUnixMs,omitempty"`
}

ReplicationReplicateDetailsReplicaResponse Provides a comprehensive overview of a specific replication operation, detailing its unique ID, the involved collection, shard, source and target nodes, transfer type, current status, and optionally, its status history.

swagger:model ReplicationReplicateDetailsReplicaResponse

func (*ReplicationReplicateDetailsReplicaResponse) ContextValidate added in v1.31.0 

func (m *ReplicationReplicateDetailsReplicaResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this replication replicate details replica response based on the context it is used

func (*ReplicationReplicateDetailsReplicaResponse) MarshalBinary added in v1.31.0 

func (m *ReplicationReplicateDetailsReplicaResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ReplicationReplicateDetailsReplicaResponse) UnmarshalBinary added in v1.31.0 

func (m *ReplicationReplicateDetailsReplicaResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ReplicationReplicateDetailsReplicaResponse) Validate added in v1.31.0 

func (m *ReplicationReplicateDetailsReplicaResponse) Validate(formats strfmt.Registry) error

Validate validates this replication replicate details replica response

type ReplicationReplicateDetailsReplicaStatus added in v1.31.0 

type ReplicationReplicateDetailsReplicaStatus struct {

	// A list of error messages encountered by this replica during the replication operation, if any.
	Errors []*ReplicationReplicateDetailsReplicaStatusError `json:"errors"`

	// The current operational state of the replica during the replication process.
	// Enum: [REGISTERED HYDRATING FINALIZING DEHYDRATING READY CANCELLED]
	State string `json:"state,omitempty"`

	// The UNIX timestamp in ms when this state was first entered. This is an approximate time and so should not be used for precise timing.
	WhenStartedUnixMs int64 `json:"whenStartedUnixMs,omitempty"`
}

ReplicationReplicateDetailsReplicaStatus Represents the current or historical status of a shard replica involved in a replication operation, including its operational state and any associated errors.

swagger:model ReplicationReplicateDetailsReplicaStatus

func (*ReplicationReplicateDetailsReplicaStatus) ContextValidate added in v1.31.0 

func (m *ReplicationReplicateDetailsReplicaStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this replication replicate details replica status based on the context it is used

func (*ReplicationReplicateDetailsReplicaStatus) MarshalBinary added in v1.31.0 

func (m *ReplicationReplicateDetailsReplicaStatus) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ReplicationReplicateDetailsReplicaStatus) UnmarshalBinary added in v1.31.0 

func (m *ReplicationReplicateDetailsReplicaStatus) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ReplicationReplicateDetailsReplicaStatus) Validate added in v1.31.0 

func (m *ReplicationReplicateDetailsReplicaStatus) Validate(formats strfmt.Registry) error

Validate validates this replication replicate details replica status

type ReplicationReplicateDetailsReplicaStatusError added in v1.32.0 

type ReplicationReplicateDetailsReplicaStatusError struct {

	// A human-readable message describing the error.
	Message string `json:"message,omitempty"`

	// The unix timestamp in ms when the error occurred. This is an approximate time and so should not be used for precise timing.
	WhenErroredUnixMs int64 `json:"whenErroredUnixMs,omitempty"`
}

ReplicationReplicateDetailsReplicaStatusError Represents an error encountered during a replication operation, including its timestamp and a human-readable message.

swagger:model ReplicationReplicateDetailsReplicaStatusError

func (*ReplicationReplicateDetailsReplicaStatusError) ContextValidate added in v1.32.0 

func (m *ReplicationReplicateDetailsReplicaStatusError) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this replication replicate details replica status error based on context it is used

func (*ReplicationReplicateDetailsReplicaStatusError) MarshalBinary added in v1.32.0 

func (m *ReplicationReplicateDetailsReplicaStatusError) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ReplicationReplicateDetailsReplicaStatusError) UnmarshalBinary added in v1.32.0 

func (m *ReplicationReplicateDetailsReplicaStatusError) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ReplicationReplicateDetailsReplicaStatusError) Validate added in v1.32.0 

func (m *ReplicationReplicateDetailsReplicaStatusError) Validate(formats strfmt.Registry) error

Validate validates this replication replicate details replica status error

type ReplicationReplicateForceDeleteRequest added in v1.31.0 

type ReplicationReplicateForceDeleteRequest struct {

	// The name of the collection to which the shard being replicated belongs.
	Collection string `json:"collection,omitempty"`

	// If true, the operation will not actually delete anything but will return the expected outcome of the deletion.
	DryRun *bool `json:"dryRun,omitempty"`

	// The unique identifier (ID) of the replication operation to be forcefully deleted.
	// Format: uuid
	ID strfmt.UUID `json:"id,omitempty"`

	// The name of the target node where the replication operations are registered.
	Node string `json:"node,omitempty"`

	// The identifier of the shard involved in the replication operations.
	Shard string `json:"shard,omitempty"`
}

ReplicationReplicateForceDeleteRequest Specifies the parameters available when force deleting replication operations.

swagger:model ReplicationReplicateForceDeleteRequest

func (*ReplicationReplicateForceDeleteRequest) ContextValidate added in v1.31.0 

func (m *ReplicationReplicateForceDeleteRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this replication replicate force delete request based on context it is used

func (*ReplicationReplicateForceDeleteRequest) MarshalBinary added in v1.31.0 

func (m *ReplicationReplicateForceDeleteRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ReplicationReplicateForceDeleteRequest) UnmarshalBinary added in v1.31.0 

func (m *ReplicationReplicateForceDeleteRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ReplicationReplicateForceDeleteRequest) Validate added in v1.31.0 

func (m *ReplicationReplicateForceDeleteRequest) Validate(formats strfmt.Registry) error

Validate validates this replication replicate force delete request

type ReplicationReplicateForceDeleteResponse added in v1.31.0 

type ReplicationReplicateForceDeleteResponse struct {

	// The unique identifiers (IDs) of the replication operations that were forcefully deleted.
	Deleted []strfmt.UUID `json:"deleted"`

	// Indicates whether the operation was a dry run (true) or an actual deletion (false).
	DryRun bool `json:"dryRun,omitempty"`
}

ReplicationReplicateForceDeleteResponse Provides the UUIDs that were successfully force deleted as part of the replication operation. If dryRun is true, this will return the expected outcome without actually deleting anything.

swagger:model ReplicationReplicateForceDeleteResponse

func (*ReplicationReplicateForceDeleteResponse) ContextValidate added in v1.31.0 

func (m *ReplicationReplicateForceDeleteResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this replication replicate force delete response based on context it is used

func (*ReplicationReplicateForceDeleteResponse) MarshalBinary added in v1.31.0 

func (m *ReplicationReplicateForceDeleteResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ReplicationReplicateForceDeleteResponse) UnmarshalBinary added in v1.31.0 

func (m *ReplicationReplicateForceDeleteResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ReplicationReplicateForceDeleteResponse) Validate added in v1.31.0 

func (m *ReplicationReplicateForceDeleteResponse) Validate(formats strfmt.Registry) error

Validate validates this replication replicate force delete response

type ReplicationReplicateReplicaRequest added in v1.31.0 

type ReplicationReplicateReplicaRequest struct {

	// The name of the collection to which the target shard belongs.
	// Required: true
	Collection *string `json:"collection"`

	// The name of the shard whose replica is to be moved or copied.
	// Required: true
	Shard *string `json:"shard"`

	// The name of the Weaviate node currently hosting the shard replica that needs to be moved or copied.
	// Required: true
	SourceNode *string `json:"sourceNode"`

	// The name of the Weaviate node where the new shard replica will be created as part of the movement or copy operation.
	// Required: true
	TargetNode *string `json:"targetNode"`

	// Specifies the type of replication operation to perform. 'COPY' creates a new replica on the target node while keeping the source replica. 'MOVE' creates a new replica on the target node and then removes the source replica upon successful completion. Defaults to 'COPY' if omitted.
	// Enum: [COPY MOVE]
	Type *string `json:"type,omitempty"`
}

ReplicationReplicateReplicaRequest Specifies the parameters required to initiate a shard replica movement operation between two nodes for a given collection and shard. This request defines the source and target node, the collection and type of transfer.

swagger:model ReplicationReplicateReplicaRequest

func (*ReplicationReplicateReplicaRequest) ContextValidate added in v1.31.0 

func (m *ReplicationReplicateReplicaRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this replication replicate replica request based on context it is used

func (*ReplicationReplicateReplicaRequest) MarshalBinary added in v1.31.0 

func (m *ReplicationReplicateReplicaRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ReplicationReplicateReplicaRequest) UnmarshalBinary added in v1.31.0 

func (m *ReplicationReplicateReplicaRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ReplicationReplicateReplicaRequest) Validate added in v1.31.0 

func (m *ReplicationReplicateReplicaRequest) Validate(formats strfmt.Registry) error

Validate validates this replication replicate replica request

type ReplicationReplicateReplicaResponse added in v1.31.0 

type ReplicationReplicateReplicaResponse struct {

	// The unique identifier (ID) assigned to the registered replication operation.
	// Required: true
	// Format: uuid
	ID *strfmt.UUID `json:"id"`
}

ReplicationReplicateReplicaResponse Contains the unique identifier for a successfully initiated asynchronous replica movement operation. This ID can be used to track the progress of the operation.

swagger:model ReplicationReplicateReplicaResponse

func (*ReplicationReplicateReplicaResponse) ContextValidate added in v1.31.0 

func (m *ReplicationReplicateReplicaResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this replication replicate replica response based on context it is used

func (*ReplicationReplicateReplicaResponse) MarshalBinary added in v1.31.0 

func (m *ReplicationReplicateReplicaResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ReplicationReplicateReplicaResponse) UnmarshalBinary added in v1.31.0 

func (m *ReplicationReplicateReplicaResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ReplicationReplicateReplicaResponse) Validate added in v1.31.0 

func (m *ReplicationReplicateReplicaResponse) Validate(formats strfmt.Registry) error

Validate validates this replication replicate replica response

type ReplicationScaleApplyResponse added in v1.31.20 

type ReplicationScaleApplyResponse struct {

	// The name of the collection associated with this replication scaling plan.
	// Required: true
	Collection string `json:"collection"`

	// List of shard copy operation IDs created during scaling.
	// Required: true
	OperationIds []strfmt.UUID `json:"operationIds"`

	// The unique identifier of the replication scaling plan that generated these operations.
	// Required: true
	// Format: uuid
	PlanID strfmt.UUID `json:"planId"`
}

ReplicationScaleApplyResponse Response for the POST /replication/scale endpoint containing the list of initiated shard copy operation IDs.

swagger:model ReplicationScaleApplyResponse

func (*ReplicationScaleApplyResponse) ContextValidate added in v1.31.20 

func (m *ReplicationScaleApplyResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this replication scale apply response based on context it is used

func (*ReplicationScaleApplyResponse) MarshalBinary added in v1.31.20 

func (m *ReplicationScaleApplyResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ReplicationScaleApplyResponse) UnmarshalBinary added in v1.31.20 

func (m *ReplicationScaleApplyResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ReplicationScaleApplyResponse) Validate added in v1.31.20 

func (m *ReplicationScaleApplyResponse) Validate(formats strfmt.Registry) error

Validate validates this replication scale apply response

type ReplicationScalePlan added in v1.31.20 

type ReplicationScalePlan struct {

	// The name of the collection to which this replication scaling plan applies.
	// Required: true
	Collection string `json:"collection"`

	// A unique identifier for this replication scaling plan, useful for tracking and auditing purposes.
	// Required: true
	// Format: uuid
	PlanID strfmt.UUID `json:"planId"`

	// A mapping of shard names to their corresponding scaling actions. Each key corresponds to a shard name, and its value defines which nodes should be removed and which should be added for that shard. If a source node listed for an addition is also in 'removeNodes' for the same shard, that addition is treated as a move operation. Such a node can appear only once as a source in that shard. Otherwise, if the source node is not being removed, it represents a copy operation and can be referenced multiple times as a source for additions.
	// Required: true
	ShardScaleActions map[string]ReplicationScalePlanShardScaleActionsAnon `json:"shardScaleActions"`
}

ReplicationScalePlan Defines a complete plan for scaling replication within a collection. Each shard entry specifies nodes to remove and nodes to add. Added nodes may either be initialized empty (null) or created by replicating data from a source node specified as a string. If a source node is also marked for removal in the same shard, it represents a move operation and can only be used once as a source for that shard. If a source node is not marked for removal, it represents a copy operation and can be used as the source for multiple additions in that shard. Nodes listed in 'removeNodes' cannot also appear as targets in 'addNodes' for the same shard, and the same node cannot be specified for both addition and removal in a single shard.

swagger:model ReplicationScalePlan

func (*ReplicationScalePlan) ContextValidate added in v1.31.20 

func (m *ReplicationScalePlan) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this replication scale plan based on the context it is used

func (*ReplicationScalePlan) MarshalBinary added in v1.31.20 

func (m *ReplicationScalePlan) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ReplicationScalePlan) UnmarshalBinary added in v1.31.20 

func (m *ReplicationScalePlan) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ReplicationScalePlan) Validate added in v1.31.20 

func (m *ReplicationScalePlan) Validate(formats strfmt.Registry) error

Validate validates this replication scale plan

type ReplicationScalePlanShardScaleActionsAnon added in v1.31.20 

type ReplicationScalePlanShardScaleActionsAnon struct {

	// A mapping of target node identifiers to their addition configuration. Each key represents a target node where a new replica will be added. The value may be null, which means an empty replica will be created, or a string specifying the source node from which shard data will be copied. If the source node is also marked for removal in the same shard, this addition is treated as a move operation, and that source node can only appear once as a source node for that shard. If the source node is not being removed, it can be used as the source for multiple additions (copy operations).
	AddNodes map[string]string `json:"addNodes,omitempty"`

	// List of node identifiers from which replicas of this shard should be removed. Nodes listed here must not appear in 'addNodes' for the same shard, and cannot be used as a source node for any addition in this shard except in the implicit move case, where they appear as both a source and a node to remove.
	RemoveNodes []string `json:"removeNodes"`
}

ReplicationScalePlanShardScaleActionsAnon Scaling actions for a single shard, including which nodes to remove and which to add. Nodes listed in 'removeNodes' cannot appear as targets in 'addNodes' for the same shard. If a source node is also marked for removal, it is treated as a move operation and can only appear once as a source node in that shard. A source node that is not being removed can appear multiple times as a source node for additions in that shard (copy operations).

swagger:model ReplicationScalePlanShardScaleActionsAnon

func (*ReplicationScalePlanShardScaleActionsAnon) ContextValidate added in v1.31.20 

func (m *ReplicationScalePlanShardScaleActionsAnon) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this replication scale plan shard scale actions anon based on context it is used

func (*ReplicationScalePlanShardScaleActionsAnon) MarshalBinary added in v1.31.20 

func (m *ReplicationScalePlanShardScaleActionsAnon) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ReplicationScalePlanShardScaleActionsAnon) UnmarshalBinary added in v1.31.20 

func (m *ReplicationScalePlanShardScaleActionsAnon) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ReplicationScalePlanShardScaleActionsAnon) Validate added in v1.31.20 

func (m *ReplicationScalePlanShardScaleActionsAnon) Validate(formats strfmt.Registry) error

Validate validates this replication scale plan shard scale actions anon

type ReplicationShardReplicas added in v1.31.0 

type ReplicationShardReplicas struct {

	// replicas
	Replicas []string `json:"replicas"`

	// shard
	Shard string `json:"shard,omitempty"`
}

ReplicationShardReplicas Represents a shard and lists the nodes that currently host its replicas.

swagger:model ReplicationShardReplicas

func (*ReplicationShardReplicas) ContextValidate added in v1.31.0 

func (m *ReplicationShardReplicas) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this replication shard replicas based on context it is used

func (*ReplicationShardReplicas) MarshalBinary added in v1.31.0 

func (m *ReplicationShardReplicas) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ReplicationShardReplicas) UnmarshalBinary added in v1.31.0 

func (m *ReplicationShardReplicas) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ReplicationShardReplicas) Validate added in v1.31.0 

func (m *ReplicationShardReplicas) Validate(formats strfmt.Registry) error

Validate validates this replication shard replicas

type ReplicationShardingState added in v1.31.0 

type ReplicationShardingState struct {

	// The name of the collection.
	Collection string `json:"collection,omitempty"`

	// An array detailing each shard within the collection and the nodes hosting its replicas.
	Shards []*ReplicationShardReplicas `json:"shards"`
}

ReplicationShardingState Details the sharding layout for a specific collection, mapping each shard to its set of replicas across the cluster.

swagger:model ReplicationShardingState

func (*ReplicationShardingState) ContextValidate added in v1.31.0 

func (m *ReplicationShardingState) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this replication sharding state based on the context it is used

func (*ReplicationShardingState) MarshalBinary added in v1.31.0 

func (m *ReplicationShardingState) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ReplicationShardingState) UnmarshalBinary added in v1.31.0 

func (m *ReplicationShardingState) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ReplicationShardingState) Validate added in v1.31.0 

func (m *ReplicationShardingState) Validate(formats strfmt.Registry) error

Validate validates this replication sharding state

type ReplicationShardingStateResponse added in v1.31.0 

type ReplicationShardingStateResponse struct {

	// sharding state
	ShardingState *ReplicationShardingState `json:"shardingState,omitempty"`
}

ReplicationShardingStateResponse Provides the detailed sharding state for one or more collections, including the distribution of shards and their replicas across the cluster nodes.

swagger:model ReplicationShardingStateResponse

func (*ReplicationShardingStateResponse) ContextValidate added in v1.31.0 

func (m *ReplicationShardingStateResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this replication sharding state response based on the context it is used

func (*ReplicationShardingStateResponse) MarshalBinary added in v1.31.0 

func (m *ReplicationShardingStateResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ReplicationShardingStateResponse) UnmarshalBinary added in v1.31.0 

func (m *ReplicationShardingStateResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ReplicationShardingStateResponse) Validate added in v1.31.0 

func (m *ReplicationShardingStateResponse) Validate(formats strfmt.Registry) error

Validate validates this replication sharding state response

type RestoreConfig added in v1.24.0 

type RestoreConfig struct {

	// Name of the bucket, container, volume, etc
	Bucket string `json:"Bucket,omitempty"`

	// Desired CPU core utilization ranging from 1%-80%
	// Maximum: 80
	// Minimum: 1
	CPUPercentage int64 `json:"CPUPercentage,omitempty"`

	// name of the endpoint, e.g. s3.amazonaws.com
	Endpoint string `json:"Endpoint,omitempty"`

	// Path within the bucket
	Path string `json:"Path,omitempty"`

	// How roles should be restored
	// Enum: [noRestore all]
	RolesOptions *string `json:"rolesOptions,omitempty"`

	// How users should be restored
	// Enum: [noRestore all]
	UsersOptions *string `json:"usersOptions,omitempty"`
}

RestoreConfig Backup custom configuration

swagger:model RestoreConfig

func (*RestoreConfig) ContextValidate added in v1.24.0 

func (m *RestoreConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this restore config based on context it is used

func (*RestoreConfig) MarshalBinary added in v1.24.0 

func (m *RestoreConfig) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RestoreConfig) UnmarshalBinary added in v1.24.0 

func (m *RestoreConfig) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RestoreConfig) Validate added in v1.24.0 

func (m *RestoreConfig) Validate(formats strfmt.Registry) error

Validate validates this restore config

type Role added in v1.28.0 

type Role struct {

	// role name
	// Required: true
	Name *string `json:"name"`

	// permissions
	// Required: true
	Permissions []*Permission `json:"permissions"`
}

Role role

swagger:model Role

func (*Role) ContextValidate added in v1.28.0 

func (m *Role) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this role based on the context it is used

func (*Role) MarshalBinary added in v1.28.0 

func (m *Role) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Role) UnmarshalBinary added in v1.28.0 

func (m *Role) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Role) Validate added in v1.28.0 

func (m *Role) Validate(formats strfmt.Registry) error

Validate validates this role

type RolesListResponse added in v1.28.0 

type RolesListResponse []*Role

RolesListResponse list of roles

swagger:model RolesListResponse

func (RolesListResponse) ContextValidate added in v1.28.0 

func (m RolesListResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this roles list response based on the context it is used

func (RolesListResponse) Validate added in v1.28.0 

func (m RolesListResponse) Validate(formats strfmt.Registry) error

Validate validates this roles list response

type Schema 

type Schema struct {

	// Semantic classes that are available.
	Classes []*Class `json:"classes"`

	// Email of the maintainer.
	// Format: email
	Maintainer strfmt.Email `json:"maintainer,omitempty"`

	// Name of the schema.
	Name string `json:"name,omitempty"`
}

Schema Definitions of semantic schemas (also see: https://github.com/weaviate/weaviate-semantic-schemas).

swagger:model Schema

func (*Schema) ContextValidate added in v1.18.0 

func (m *Schema) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this schema based on the context it is used

func (*Schema) MarshalBinary 

func (m *Schema) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Schema) UnmarshalBinary 

func (m *Schema) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Schema) Validate 

func (m *Schema) Validate(formats strfmt.Registry) error

Validate validates this schema

type SchemaClusterStatus added in v1.19.10 

type SchemaClusterStatus struct {

	// Contains the sync check error if one occurred
	Error string `json:"error,omitempty"`

	// True if the cluster is in sync, false if there is an issue (see error).
	Healthy bool `json:"healthy"`

	// Hostname of the coordinating node, i.e. the one that received the cluster. This can be useful information if the error message contains phrases such as 'other nodes agree, but local does not', etc.
	Hostname string `json:"hostname,omitempty"`

	// The cluster check at startup can be ignored (to recover from an out-of-sync situation).
	IgnoreSchemaSync bool `json:"ignoreSchemaSync"`

	// Number of nodes that participated in the sync check
	NodeCount int64 `json:"nodeCount,omitempty"`
}

SchemaClusterStatus Indicates the health of the schema in a cluster.

swagger:model SchemaClusterStatus

func (*SchemaClusterStatus) ContextValidate added in v1.19.10 

func (m *SchemaClusterStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this schema cluster status based on context it is used

func (*SchemaClusterStatus) MarshalBinary added in v1.19.10 

func (m *SchemaClusterStatus) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SchemaClusterStatus) UnmarshalBinary added in v1.19.10 

func (m *SchemaClusterStatus) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SchemaClusterStatus) Validate added in v1.19.10 

func (m *SchemaClusterStatus) Validate(formats strfmt.Registry) error

Validate validates this schema cluster status

type SchemaHistory 

type SchemaHistory interface{}

SchemaHistory This is an open object, with OpenAPI Specification 3.0 this will be more detailed. See Weaviate docs for more info. In the future this will become a key/value OR a SingleRef definition.

swagger:model SchemaHistory

type ShardStatus 

type ShardStatus struct {

	// Status of the shard
	Status string `json:"status,omitempty"`
}

ShardStatus The status of a single shard

swagger:model ShardStatus

func (*ShardStatus) ContextValidate added in v1.18.0 

func (m *ShardStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this shard status based on context it is used

func (*ShardStatus) MarshalBinary 

func (m *ShardStatus) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ShardStatus) UnmarshalBinary 

func (m *ShardStatus) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ShardStatus) Validate 

func (m *ShardStatus) Validate(formats strfmt.Registry) error

Validate validates this shard status

type ShardStatusGetResponse 

type ShardStatusGetResponse struct {

	// Name of the shard
	Name string `json:"name,omitempty"`

	// Status of the shard
	Status string `json:"status,omitempty"`

	// Size of the vector queue of the shard
	VectorQueueSize int64 `json:"vectorQueueSize"`
}

ShardStatusGetResponse Response body of shard status get request

swagger:model ShardStatusGetResponse

func (*ShardStatusGetResponse) ContextValidate added in v1.18.0 

func (m *ShardStatusGetResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this shard status get response based on context it is used

func (*ShardStatusGetResponse) MarshalBinary 

func (m *ShardStatusGetResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ShardStatusGetResponse) UnmarshalBinary 

func (m *ShardStatusGetResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ShardStatusGetResponse) Validate 

func (m *ShardStatusGetResponse) Validate(formats strfmt.Registry) error

Validate validates this shard status get response

type ShardStatusList 

type ShardStatusList []*ShardStatusGetResponse

ShardStatusList The status of all the shards of a Class

swagger:model ShardStatusList

func (ShardStatusList) ContextValidate added in v1.18.0 

func (m ShardStatusList) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this shard status list based on the context it is used

func (ShardStatusList) Validate 

func (m ShardStatusList) Validate(formats strfmt.Registry) error

Validate validates this shard status list

type SingleRef 

type SingleRef struct {

	// If using a direct reference, specify the URI to point to the cross-ref here. Should be in the form of weaviate://localhost/<uuid> for the example of a local cross-ref to an object
	// Format: uri
	Beacon strfmt.URI `json:"beacon,omitempty"`

	// If using a concept reference (rather than a direct reference), specify the desired class name here
	// Format: uri
	Class strfmt.URI `json:"class,omitempty"`

	// Additional Meta information about classifications if the item was part of one
	Classification *ReferenceMetaClassification `json:"classification,omitempty"`

	// If using a direct reference, this read-only fields provides a link to the referenced resource. If 'origin' is globally configured, an absolute URI is shown - a relative URI otherwise.
	// Format: uri
	Href strfmt.URI `json:"href,omitempty"`

	// If using a concept reference (rather than a direct reference), specify the desired properties here
	Schema PropertySchema `json:"schema,omitempty"`
}

SingleRef Either set beacon (direct reference) or set class and schema (concept reference)

swagger:model SingleRef

func (*SingleRef) ContextValidate added in v1.18.0 

func (m *SingleRef) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this single ref based on the context it is used

func (*SingleRef) MarshalBinary 

func (m *SingleRef) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SingleRef) UnmarshalBinary 

func (m *SingleRef) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SingleRef) Validate 

func (m *SingleRef) Validate(formats strfmt.Registry) error

Validate validates this single ref

type Statistics added in v1.25.0 

type Statistics struct {

	// bootstrapped
	Bootstrapped bool `json:"bootstrapped,omitempty"`

	// candidates
	Candidates interface{} `json:"candidates,omitempty"`

	// db loaded
	DbLoaded bool `json:"dbLoaded,omitempty"`

	// initial last applied index
	InitialLastAppliedIndex uint64 `json:"initialLastAppliedIndex,omitempty"`

	// is voter
	IsVoter bool `json:"isVoter,omitempty"`

	// last applied index
	LastAppliedIndex float64 `json:"lastAppliedIndex,omitempty"`

	// leader address
	LeaderAddress interface{} `json:"leaderAddress,omitempty"`

	// leader Id
	LeaderID interface{} `json:"leaderId,omitempty"`

	// The name of the node.
	Name string `json:"name,omitempty"`

	// open
	Open bool `json:"open,omitempty"`

	// Weaviate Raft statistics.
	Raft *RaftStatistics `json:"raft,omitempty"`

	// ready
	Ready bool `json:"ready,omitempty"`

	// Node's status.
	// Enum: [HEALTHY UNHEALTHY UNAVAILABLE TIMEOUT]
	Status *string `json:"status,omitempty"`
}

Statistics The definition of node statistics.

swagger:model Statistics

func (*Statistics) ContextValidate added in v1.25.0 

func (m *Statistics) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this statistics based on the context it is used

func (*Statistics) MarshalBinary added in v1.25.0 

func (m *Statistics) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Statistics) UnmarshalBinary added in v1.25.0 

func (m *Statistics) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Statistics) Validate added in v1.25.0 

func (m *Statistics) Validate(formats strfmt.Registry) error

Validate validates this statistics

type StopwordConfig 

type StopwordConfig struct {

	// Stopwords to be considered additionally (default: []). Can be any array of custom strings.
	Additions []string `json:"additions"`

	// Pre-existing list of common words by language (default: 'en'). Options: ['en', 'none'].
	Preset string `json:"preset,omitempty"`

	// Stopwords to be removed from consideration (default: []). Can be any array of custom strings.
	Removals []string `json:"removals"`
}

StopwordConfig fine-grained control over stopword list usage

swagger:model StopwordConfig

func (*StopwordConfig) ContextValidate added in v1.18.0 

func (m *StopwordConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this stopword config based on context it is used

func (*StopwordConfig) MarshalBinary 

func (m *StopwordConfig) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*StopwordConfig) UnmarshalBinary 

func (m *StopwordConfig) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*StopwordConfig) Validate 

func (m *StopwordConfig) Validate(formats strfmt.Registry) error

Validate validates this stopword config

type Tenant added in v1.20.0 

type Tenant struct {

	// activity status of the tenant's shard. Optional for creating tenant (implicit `ACTIVE`) and required for updating tenant. For creation, allowed values are `ACTIVE` - tenant is fully active and `INACTIVE` - tenant is inactive; no actions can be performed on tenant, tenant's files are stored locally. For updating, `ACTIVE`, `INACTIVE` and also `OFFLOADED` - as INACTIVE, but files are stored on cloud storage. The following values are read-only and are set by the server for internal use: `OFFLOADING` - tenant is transitioning from ACTIVE/INACTIVE to OFFLOADED, `ONLOADING` - tenant is transitioning from OFFLOADED to ACTIVE/INACTIVE. We still accept deprecated names `HOT` (now `ACTIVE`), `COLD` (now `INACTIVE`), `FROZEN` (now `OFFLOADED`), `FREEZING` (now `OFFLOADING`), `UNFREEZING` (now `ONLOADING`).
	// Enum: [ACTIVE INACTIVE OFFLOADED OFFLOADING ONLOADING HOT COLD FROZEN FREEZING UNFREEZING]
	ActivityStatus string `json:"activityStatus,omitempty"`

	// The name of the tenant (required).
	Name string `json:"name,omitempty"`
}

Tenant attributes representing a single tenant within weaviate

swagger:model Tenant

func (*Tenant) ContextValidate added in v1.20.0 

func (m *Tenant) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this tenant based on context it is used

func (*Tenant) MarshalBinary added in v1.20.0 

func (m *Tenant) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Tenant) UnmarshalBinary added in v1.20.0 

func (m *Tenant) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Tenant) Validate added in v1.20.0 

func (m *Tenant) Validate(formats strfmt.Registry) error

Validate validates this tenant

type UserAPIKey added in v1.30.0 

type UserAPIKey struct {

	// The apikey
	// Required: true
	Apikey *string `json:"apikey"`
}

UserAPIKey user Api key

swagger:model UserApiKey

func (*UserAPIKey) ContextValidate added in v1.30.0 

func (m *UserAPIKey) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this user Api key based on context it is used

func (*UserAPIKey) MarshalBinary added in v1.30.0 

func (m *UserAPIKey) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UserAPIKey) UnmarshalBinary added in v1.30.0 

func (m *UserAPIKey) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UserAPIKey) Validate added in v1.30.0 

func (m *UserAPIKey) Validate(formats strfmt.Registry) error

Validate validates this user Api key

type UserOwnInfo added in v1.28.8 

type UserOwnInfo struct {

	// The groups associated to the user
	Groups []string `json:"groups"`

	// roles
	Roles []*Role `json:"roles"`

	// The username associated with the provided key
	// Required: true
	Username *string `json:"username"`
}

UserOwnInfo user own info

swagger:model UserOwnInfo

func (*UserOwnInfo) ContextValidate added in v1.28.8 

func (m *UserOwnInfo) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this user own info based on the context it is used

func (*UserOwnInfo) MarshalBinary added in v1.28.8 

func (m *UserOwnInfo) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UserOwnInfo) UnmarshalBinary added in v1.28.8 

func (m *UserOwnInfo) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UserOwnInfo) Validate added in v1.28.8 

func (m *UserOwnInfo) Validate(formats strfmt.Registry) error

Validate validates this user own info

type UserTypeInput added in v1.30.0 

type UserTypeInput string

UserTypeInput the type of user

swagger:model UserTypeInput 

const (

	// UserTypeInputDb captures enum value "db"
	UserTypeInputDb UserTypeInput = "db"

	// UserTypeInputOidc captures enum value "oidc"
	UserTypeInputOidc UserTypeInput = "oidc"
)

func NewUserTypeInput added in v1.30.0 

func NewUserTypeInput(value UserTypeInput) *UserTypeInput

func (UserTypeInput) ContextValidate added in v1.30.0 

func (m UserTypeInput) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this user type input based on context it is used

func (UserTypeInput) Pointer added in v1.30.0 

func (m UserTypeInput) Pointer() *UserTypeInput

Pointer returns a pointer to a freshly-allocated UserTypeInput.

func (UserTypeInput) Validate added in v1.30.0 

func (m UserTypeInput) Validate(formats strfmt.Registry) error

Validate validates this user type input

type UserTypeOutput added in v1.30.0 

type UserTypeOutput string

UserTypeOutput the type of user

swagger:model UserTypeOutput 

const (

	// UserTypeOutputDbUser captures enum value "db_user"
	UserTypeOutputDbUser UserTypeOutput = "db_user"

	// UserTypeOutputDbEnvUser captures enum value "db_env_user"
	UserTypeOutputDbEnvUser UserTypeOutput = "db_env_user"

	// UserTypeOutputOidc captures enum value "oidc"
	UserTypeOutputOidc UserTypeOutput = "oidc"
)

func NewUserTypeOutput added in v1.30.0 

func NewUserTypeOutput(value UserTypeOutput) *UserTypeOutput

func (UserTypeOutput) ContextValidate added in v1.30.0 

func (m UserTypeOutput) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this user type output based on context it is used

func (UserTypeOutput) Pointer added in v1.30.0 

func (m UserTypeOutput) Pointer() *UserTypeOutput

Pointer returns a pointer to a freshly-allocated UserTypeOutput.

func (UserTypeOutput) Validate added in v1.30.0 

func (m UserTypeOutput) Validate(formats strfmt.Registry) error

Validate validates this user type output

type Vector added in v1.24.0 

type Vector interface{}

Vector A vector representation of the object. If provided at object creation, this wil take precedence over any vectorizer setting.

swagger:model Vector

type VectorConfig added in v1.24.0 

type VectorConfig struct {

	// Vector-index config, that is specific to the type of index selected in vectorIndexType
	VectorIndexConfig interface{} `json:"vectorIndexConfig,omitempty"`

	// Name of the vector index to use, eg. (HNSW)
	VectorIndexType string `json:"vectorIndexType,omitempty"`

	// Configuration of a specific vectorizer used by this vector
	Vectorizer interface{} `json:"vectorizer,omitempty"`
}

VectorConfig vector config

swagger:model VectorConfig

func (*VectorConfig) ContextValidate added in v1.24.0 

func (m *VectorConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this vector config based on context it is used

func (*VectorConfig) MarshalBinary added in v1.24.0 

func (m *VectorConfig) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*VectorConfig) UnmarshalBinary added in v1.24.0 

func (m *VectorConfig) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*VectorConfig) Validate added in v1.24.0 

func (m *VectorConfig) Validate(formats strfmt.Registry) error

Validate validates this vector config

type VectorWeights 

type VectorWeights interface{}

VectorWeights Allow custom overrides of vector weights as math expressions. E.g. "pancake": "7" will set the weight for the word pancake to 7 in the vectorization, whereas "w * 3" would triple the originally calculated word. This is an open object, with OpenAPI Specification 3.0 this will be more detailed. See Weaviate docs for more info. In the future this will become a key/value (string/string) object.

swagger:model VectorWeights

type Vectors added in v1.24.0 

type Vectors map[string]Vector

Vectors A map of named vectors for multi-vector representations.

swagger:model Vectors

func (Vectors) ContextValidate added in v1.24.0 

func (m Vectors) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this vectors based on context it is used

func (*Vectors) UnmarshalJSON added in v1.29.0 

func (v *Vectors) UnmarshalJSON(data []byte) error

UnmarshalJSON custom unmarshalling method

func (Vectors) Validate added in v1.24.0 

func (m Vectors) Validate(formats strfmt.Registry) error

Validate validates this vectors

type WhereFilter 

type WhereFilter struct {

	// combine multiple where filters, requires 'And' or 'Or' operator
	Operands []*WhereFilter `json:"operands"`

	// operator to use
	// Example: GreaterThanEqual
	// Enum: [And Or Equal Like NotEqual GreaterThan GreaterThanEqual LessThan LessThanEqual WithinGeoRange IsNull ContainsAny ContainsAll]
	Operator string `json:"operator,omitempty"`

	// path to the property currently being filtered
	// Example: ["inCity","City","name"]
	Path []string `json:"path"`

	// value as boolean
	// Example: false
	ValueBoolean *bool `json:"valueBoolean,omitempty"`

	// value as boolean
	// Example: [true,false]
	ValueBooleanArray []bool `json:"valueBooleanArray,omitempty"`

	// value as date (as string)
	// Example: TODO
	ValueDate *string `json:"valueDate,omitempty"`

	// value as date (as string)
	// Example: TODO
	ValueDateArray []string `json:"valueDateArray,omitempty"`

	// value as geo coordinates and distance
	ValueGeoRange *WhereFilterGeoRange `json:"valueGeoRange,omitempty"`

	// value as integer
	// Example: 2000
	ValueInt *int64 `json:"valueInt,omitempty"`

	// value as integer
	// Example: [100, 200]
	ValueIntArray []int64 `json:"valueIntArray,omitempty"`

	// value as number/float
	// Example: 3.14
	ValueNumber *float64 `json:"valueNumber,omitempty"`

	// value as number/float
	// Example: [3.14]
	ValueNumberArray []float64 `json:"valueNumberArray,omitempty"`

	// value as text (deprecated as of v1.19; alias for valueText)
	// Example: my search term
	ValueString *string `json:"valueString,omitempty"`

	// value as text (deprecated as of v1.19; alias for valueText)
	// Example: ["my search term"]
	ValueStringArray []string `json:"valueStringArray,omitempty"`

	// value as text
	// Example: my search term
	ValueText *string `json:"valueText,omitempty"`

	// value as text
	// Example: ["my search term"]
	ValueTextArray []string `json:"valueTextArray,omitempty"`
}

WhereFilter Filter search results using a where filter

swagger:model WhereFilter

func (*WhereFilter) ContextValidate added in v1.18.0 

func (m *WhereFilter) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this where filter based on the context it is used

func (*WhereFilter) MarshalBinary 

func (m *WhereFilter) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*WhereFilter) UnmarshalBinary 

func (m *WhereFilter) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*WhereFilter) Validate 

func (m *WhereFilter) Validate(formats strfmt.Registry) error

Validate validates this where filter

type WhereFilterGeoRange 

type WhereFilterGeoRange struct {

	// distance
	Distance *WhereFilterGeoRangeDistance `json:"distance,omitempty"`

	// geo coordinates
	GeoCoordinates *GeoCoordinates `json:"geoCoordinates,omitempty"`
}

WhereFilterGeoRange filter within a distance of a georange

swagger:model WhereFilterGeoRange

func (*WhereFilterGeoRange) ContextValidate added in v1.18.0 

func (m *WhereFilterGeoRange) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this where filter geo range based on the context it is used

func (*WhereFilterGeoRange) MarshalBinary 

func (m *WhereFilterGeoRange) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*WhereFilterGeoRange) UnmarshalBinary 

func (m *WhereFilterGeoRange) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*WhereFilterGeoRange) Validate 

func (m *WhereFilterGeoRange) Validate(formats strfmt.Registry) error

Validate validates this where filter geo range

type WhereFilterGeoRangeDistance 

type WhereFilterGeoRangeDistance struct {

	// max
	Max float64 `json:"max,omitempty"`
}

WhereFilterGeoRangeDistance where filter geo range distance

swagger:model WhereFilterGeoRangeDistance

func (*WhereFilterGeoRangeDistance) ContextValidate added in v1.18.0 

func (m *WhereFilterGeoRangeDistance) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this where filter geo range distance based on context it is used

func (*WhereFilterGeoRangeDistance) MarshalBinary 

func (m *WhereFilterGeoRangeDistance) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*WhereFilterGeoRangeDistance) UnmarshalBinary 

func (m *WhereFilterGeoRangeDistance) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*WhereFilterGeoRangeDistance) Validate 

func (m *WhereFilterGeoRangeDistance) Validate(formats strfmt.Registry) error

Validate validates this where filter geo range distance

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.