api

package
v1.30.2 Latest Latest
Warning

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

Go to latest
Published: Apr 28, 2025 License: BSD-3-Clause Imports: 14 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// NOTE: in case changes happens to the RBAC message, add new version before the RBACLatestCommandPolicyVersion
	// RBACCommandPolicyVersionV0 represents the first version of RBAC commands where it wasn't set and equal 0
	// this version was needed because we did migrate paths of SchemaDomain to limit the collection
	// old "schema/collections/{collection_name}/shards/*" all shards in collection
	// new "schema/collections/{collection_name}/shards/#" limited to collection only
	RBACCommandPolicyVersionV0 = iota

	// this version was needed because we did migrate verbs of RolesDomain to control the scope
	// of Role permissions and default to MATCH scope instead of ALL
	// old verb was (C)|(R)|(U)|(D)
	// new verb was MATCH
	RBACCommandPolicyVersionV1

	// this version was needed because we did flatten manage_roles to C+U+D_roles
	RBACCommandPolicyVersionV2
	// this version was needed because assign_and_revoke_users was saved with verb UPDATE. However with dynamic user
	// management we need a special permission to update users
	RBACCommandPolicyVersionV3

	// RBACLatestCommandPolicyVersion represents the latest version of RBAC commands policies
	// It's used to migrate policy changes. if we end up with a cluster having different version
	// that won't be a problem because the version here is not about the message change but more about
	// the content of the body which will dumbed anyway in RBAC storage.
	RBACLatestCommandPolicyVersion
)
View Source
const (
	RBACAssignRevokeCommandPolicyVersionV0 = iota
	RBACAssignRevokeLatestCommandPolicyVersion
)
View Source
const (
	// NOTE: in case changes happens to the dynamic user message, add new version
	DynUserLatestCommandPolicyVersion = iota
)

Variables

View Source
var (
	ApplyRequest_Type_name = map[int32]string{
		0:  "TYPE_UNSPECIFIED",
		1:  "TYPE_ADD_CLASS",
		2:  "TYPE_UPDATE_CLASS",
		3:  "TYPE_DELETE_CLASS",
		4:  "TYPE_RESTORE_CLASS",
		5:  "TYPE_ADD_PROPERTY",
		10: "TYPE_UPDATE_SHARD_STATUS",
		16: "TYPE_ADD_TENANT",
		17: "TYPE_UPDATE_TENANT",
		18: "TYPE_DELETE_TENANT",
		19: "TYPE_TENANT_PROCESS",
		60: "TYPE_UPSERT_ROLES_PERMISSIONS",
		61: "TYPE_DELETE_ROLES",
		62: "TYPE_REMOVE_PERMISSIONS",
		63: "TYPE_ADD_ROLES_FOR_USER",
		64: "TYPE_REVOKE_ROLES_FOR_USER",
		80: "TYPE_UPSERT_USER",
		81: "TYPE_DELETE_USER",
		82: "TYPE_ROTATE_USER_API_KEY",
		83: "TYPE_SUSPEND_USER",
		84: "TYPE_ACTIVATE_USER",
		99: "TYPE_STORE_SCHEMA_V1",
	}
	ApplyRequest_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED":              0,
		"TYPE_ADD_CLASS":                1,
		"TYPE_UPDATE_CLASS":             2,
		"TYPE_DELETE_CLASS":             3,
		"TYPE_RESTORE_CLASS":            4,
		"TYPE_ADD_PROPERTY":             5,
		"TYPE_UPDATE_SHARD_STATUS":      10,
		"TYPE_ADD_TENANT":               16,
		"TYPE_UPDATE_TENANT":            17,
		"TYPE_DELETE_TENANT":            18,
		"TYPE_TENANT_PROCESS":           19,
		"TYPE_UPSERT_ROLES_PERMISSIONS": 60,
		"TYPE_DELETE_ROLES":             61,
		"TYPE_REMOVE_PERMISSIONS":       62,
		"TYPE_ADD_ROLES_FOR_USER":       63,
		"TYPE_REVOKE_ROLES_FOR_USER":    64,
		"TYPE_UPSERT_USER":              80,
		"TYPE_DELETE_USER":              81,
		"TYPE_ROTATE_USER_API_KEY":      82,
		"TYPE_SUSPEND_USER":             83,
		"TYPE_ACTIVATE_USER":            84,
		"TYPE_STORE_SCHEMA_V1":          99,
	}
)

Enum value maps for ApplyRequest_Type.

View Source
var (
	QueryRequest_Type_name = map[int32]string{
		0:  "TYPE_UNSPECIFIED",
		1:  "TYPE_GET_CLASSES",
		2:  "TYPE_GET_SCHEMA",
		3:  "TYPE_GET_TENANTS",
		4:  "TYPE_GET_SHARD_OWNER",
		5:  "TYPE_GET_TENANTS_SHARDS",
		6:  "TYPE_GET_SHARDING_STATE",
		7:  "TYPE_GET_CLASS_VERSIONS",
		8:  "TYPE_GET_COLLECTIONS_COUNT",
		30: "TYPE_HAS_PERMISSION",
		31: "TYPE_GET_ROLES",
		32: "TYPE_GET_ROLES_FOR_USER",
		33: "TYPE_GET_USERS_FOR_ROLE",
		61: "TYPE_GET_USERS",
		62: "TYPE_USER_IDENTIFIER_EXISTS",
	}
	QueryRequest_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED":            0,
		"TYPE_GET_CLASSES":            1,
		"TYPE_GET_SCHEMA":             2,
		"TYPE_GET_TENANTS":            3,
		"TYPE_GET_SHARD_OWNER":        4,
		"TYPE_GET_TENANTS_SHARDS":     5,
		"TYPE_GET_SHARDING_STATE":     6,
		"TYPE_GET_CLASS_VERSIONS":     7,
		"TYPE_GET_COLLECTIONS_COUNT":  8,
		"TYPE_HAS_PERMISSION":         30,
		"TYPE_GET_ROLES":              31,
		"TYPE_GET_ROLES_FOR_USER":     32,
		"TYPE_GET_USERS_FOR_ROLE":     33,
		"TYPE_GET_USERS":              61,
		"TYPE_USER_IDENTIFIER_EXISTS": 62,
	}
)

Enum value maps for QueryRequest_Type.

View Source
var (
	TenantsProcess_Op_name = map[int32]string{
		0: "OP_UNSPECIFIED",
		1: "OP_START",
		2: "OP_DONE",
		3: "OP_ABORT",
	}
	TenantsProcess_Op_value = map[string]int32{
		"OP_UNSPECIFIED": 0,
		"OP_START":       1,
		"OP_DONE":        2,
		"OP_ABORT":       3,
	}
)

Enum value maps for TenantsProcess_Op.

View Source
var (
	TenantProcessRequest_Action_name = map[int32]string{
		0: "ACTION_UNSPECIFIED",
		1: "ACTION_FREEZING",
		2: "ACTION_UNFREEZING",
	}
	TenantProcessRequest_Action_value = map[string]int32{
		"ACTION_UNSPECIFIED": 0,
		"ACTION_FREEZING":    1,
		"ACTION_UNFREEZING":  2,
	}
)

Enum value maps for TenantProcessRequest_Action.

View Source
var ClusterService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "weaviate.internal.cluster.ClusterService",
	HandlerType: (*ClusterServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "RemovePeer",
			Handler:    _ClusterService_RemovePeer_Handler,
		},
		{
			MethodName: "JoinPeer",
			Handler:    _ClusterService_JoinPeer_Handler,
		},
		{
			MethodName: "NotifyPeer",
			Handler:    _ClusterService_NotifyPeer_Handler,
		},
		{
			MethodName: "Apply",
			Handler:    _ClusterService_Apply_Handler,
		},
		{
			MethodName: "Query",
			Handler:    _ClusterService_Query_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "api/message.proto",
}

ClusterService_ServiceDesc is the grpc.ServiceDesc for ClusterService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source
var File_api_message_proto protoreflect.FileDescriptor

Functions

func RegisterClusterServiceServer

func RegisterClusterServiceServer(s grpc.ServiceRegistrar, srv ClusterServiceServer)

Types

type ActivateUsersRequest added in v1.30.0

type ActivateUsersRequest struct {
	UserId  string
	Version int
}

type AddClassRequest

type AddClassRequest struct {
	Class *models.Class
	State *sharding.State
}

type AddPropertyRequest

type AddPropertyRequest struct {
	Properties []*models.Property
}

type AddRolesForUsersRequest added in v1.28.0

type AddRolesForUsersRequest struct {
	User    string
	Roles   []string
	Version int
}

type AddTenantsRequest

type AddTenantsRequest struct {
	ClusterNodes []string  `protobuf:"bytes,1,rep,name=cluster_nodes,json=clusterNodes,proto3" json:"cluster_nodes,omitempty"`
	Tenants      []*Tenant `protobuf:"bytes,2,rep,name=tenants,proto3" json:"tenants,omitempty"`
	// contains filtered or unexported fields
}

func (*AddTenantsRequest) Descriptor deprecated

func (*AddTenantsRequest) Descriptor() ([]byte, []int)

Deprecated: Use AddTenantsRequest.ProtoReflect.Descriptor instead.

func (*AddTenantsRequest) GetClusterNodes

func (x *AddTenantsRequest) GetClusterNodes() []string

func (*AddTenantsRequest) GetTenants

func (x *AddTenantsRequest) GetTenants() []*Tenant

func (*AddTenantsRequest) ProtoMessage

func (*AddTenantsRequest) ProtoMessage()

func (*AddTenantsRequest) ProtoReflect

func (x *AddTenantsRequest) ProtoReflect() protoreflect.Message

func (*AddTenantsRequest) Reset

func (x *AddTenantsRequest) Reset()

func (*AddTenantsRequest) String

func (x *AddTenantsRequest) String() string

type ApplyRequest

type ApplyRequest struct {
	Type       ApplyRequest_Type `protobuf:"varint,1,opt,name=type,proto3,enum=weaviate.internal.cluster.ApplyRequest_Type" json:"type,omitempty"`
	Class      string            `protobuf:"bytes,2,opt,name=class,proto3" json:"class,omitempty"`
	Version    uint64            `protobuf:"varint,3,opt,name=version,proto3" json:"version,omitempty"`
	SubCommand []byte            `protobuf:"bytes,4,opt,name=sub_command,json=subCommand,proto3" json:"sub_command,omitempty"`
	// contains filtered or unexported fields
}

func (*ApplyRequest) Descriptor deprecated

func (*ApplyRequest) Descriptor() ([]byte, []int)

Deprecated: Use ApplyRequest.ProtoReflect.Descriptor instead.

func (*ApplyRequest) GetClass

func (x *ApplyRequest) GetClass() string

func (*ApplyRequest) GetSubCommand

func (x *ApplyRequest) GetSubCommand() []byte

func (*ApplyRequest) GetType

func (x *ApplyRequest) GetType() ApplyRequest_Type

func (*ApplyRequest) GetVersion

func (x *ApplyRequest) GetVersion() uint64

func (*ApplyRequest) ProtoMessage

func (*ApplyRequest) ProtoMessage()

func (*ApplyRequest) ProtoReflect

func (x *ApplyRequest) ProtoReflect() protoreflect.Message

func (*ApplyRequest) Reset

func (x *ApplyRequest) Reset()

func (*ApplyRequest) String

func (x *ApplyRequest) String() string

type ApplyRequest_Type

type ApplyRequest_Type int32
const (
	ApplyRequest_TYPE_UNSPECIFIED              ApplyRequest_Type = 0
	ApplyRequest_TYPE_ADD_CLASS                ApplyRequest_Type = 1
	ApplyRequest_TYPE_UPDATE_CLASS             ApplyRequest_Type = 2
	ApplyRequest_TYPE_DELETE_CLASS             ApplyRequest_Type = 3
	ApplyRequest_TYPE_RESTORE_CLASS            ApplyRequest_Type = 4
	ApplyRequest_TYPE_ADD_PROPERTY             ApplyRequest_Type = 5
	ApplyRequest_TYPE_UPDATE_SHARD_STATUS      ApplyRequest_Type = 10
	ApplyRequest_TYPE_ADD_TENANT               ApplyRequest_Type = 16
	ApplyRequest_TYPE_UPDATE_TENANT            ApplyRequest_Type = 17
	ApplyRequest_TYPE_DELETE_TENANT            ApplyRequest_Type = 18
	ApplyRequest_TYPE_TENANT_PROCESS           ApplyRequest_Type = 19
	ApplyRequest_TYPE_UPSERT_ROLES_PERMISSIONS ApplyRequest_Type = 60
	ApplyRequest_TYPE_DELETE_ROLES             ApplyRequest_Type = 61
	ApplyRequest_TYPE_REMOVE_PERMISSIONS       ApplyRequest_Type = 62
	ApplyRequest_TYPE_ADD_ROLES_FOR_USER       ApplyRequest_Type = 63
	ApplyRequest_TYPE_REVOKE_ROLES_FOR_USER    ApplyRequest_Type = 64
	ApplyRequest_TYPE_UPSERT_USER              ApplyRequest_Type = 80
	ApplyRequest_TYPE_DELETE_USER              ApplyRequest_Type = 81
	ApplyRequest_TYPE_ROTATE_USER_API_KEY      ApplyRequest_Type = 82
	ApplyRequest_TYPE_SUSPEND_USER             ApplyRequest_Type = 83
	ApplyRequest_TYPE_ACTIVATE_USER            ApplyRequest_Type = 84
	ApplyRequest_TYPE_STORE_SCHEMA_V1          ApplyRequest_Type = 99
)

func (ApplyRequest_Type) Descriptor

func (ApplyRequest_Type) Enum

func (ApplyRequest_Type) EnumDescriptor deprecated

func (ApplyRequest_Type) EnumDescriptor() ([]byte, []int)

Deprecated: Use ApplyRequest_Type.Descriptor instead.

func (ApplyRequest_Type) Number

func (ApplyRequest_Type) String

func (x ApplyRequest_Type) String() string

func (ApplyRequest_Type) Type

type ApplyResponse

type ApplyResponse struct {
	Version uint64 `protobuf:"varint,1,opt,name=version,proto3" json:"version,omitempty"`
	Leader  string `protobuf:"bytes,2,opt,name=leader,proto3" json:"leader,omitempty"`
	// contains filtered or unexported fields
}

func (*ApplyResponse) Descriptor deprecated

func (*ApplyResponse) Descriptor() ([]byte, []int)

Deprecated: Use ApplyResponse.ProtoReflect.Descriptor instead.

func (*ApplyResponse) GetLeader

func (x *ApplyResponse) GetLeader() string

func (*ApplyResponse) GetVersion

func (x *ApplyResponse) GetVersion() uint64

func (*ApplyResponse) ProtoMessage

func (*ApplyResponse) ProtoMessage()

func (*ApplyResponse) ProtoReflect

func (x *ApplyResponse) ProtoReflect() protoreflect.Message

func (*ApplyResponse) Reset

func (x *ApplyResponse) Reset()

func (*ApplyResponse) String

func (x *ApplyResponse) String() string

type ClusterServiceClient

type ClusterServiceClient interface {
	RemovePeer(ctx context.Context, in *RemovePeerRequest, opts ...grpc.CallOption) (*RemovePeerResponse, error)
	JoinPeer(ctx context.Context, in *JoinPeerRequest, opts ...grpc.CallOption) (*JoinPeerResponse, error)
	NotifyPeer(ctx context.Context, in *NotifyPeerRequest, opts ...grpc.CallOption) (*NotifyPeerResponse, error)
	Apply(ctx context.Context, in *ApplyRequest, opts ...grpc.CallOption) (*ApplyResponse, error)
	Query(ctx context.Context, in *QueryRequest, opts ...grpc.CallOption) (*QueryResponse, error)
}

ClusterServiceClient is the client API for ClusterService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

type ClusterServiceServer

ClusterServiceServer is the server API for ClusterService service. All implementations should embed UnimplementedClusterServiceServer for forward compatibility

type CreateRolesRequest added in v1.28.0

type CreateRolesRequest struct {
	Roles        map[string][]authorization.Policy
	RoleCreation bool
	Version      int
}

type CreateUsersRequest added in v1.30.0

type CreateUsersRequest struct {
	UserId             string
	SecureHash         string
	UserIdentifier     string
	ApiKeyFirstLetters string
	CreatedAt          time.Time
	Version            int
}

type DeleteClassRequest

type DeleteClassRequest struct {
	Name string
}

type DeleteRolesRequest added in v1.28.0

type DeleteRolesRequest struct {
	Roles []string
}

type DeleteTenantsRequest

type DeleteTenantsRequest struct {
	Tenants []string `protobuf:"bytes,1,rep,name=tenants,proto3" json:"tenants,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteTenantsRequest) Descriptor deprecated

func (*DeleteTenantsRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteTenantsRequest.ProtoReflect.Descriptor instead.

func (*DeleteTenantsRequest) GetTenants

func (x *DeleteTenantsRequest) GetTenants() []string

func (*DeleteTenantsRequest) ProtoMessage

func (*DeleteTenantsRequest) ProtoMessage()

func (*DeleteTenantsRequest) ProtoReflect

func (x *DeleteTenantsRequest) ProtoReflect() protoreflect.Message

func (*DeleteTenantsRequest) Reset

func (x *DeleteTenantsRequest) Reset()

func (*DeleteTenantsRequest) String

func (x *DeleteTenantsRequest) String() string

type DeleteUsersRequest added in v1.30.0

type DeleteUsersRequest struct {
	UserId  string
	Version int
}

type JoinPeerRequest

type JoinPeerRequest struct {
	Id      string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Address string `protobuf:"bytes,2,opt,name=address,proto3" json:"address,omitempty"`
	Voter   bool   `protobuf:"varint,3,opt,name=voter,proto3" json:"voter,omitempty"`
	// contains filtered or unexported fields
}

func (*JoinPeerRequest) Descriptor deprecated

func (*JoinPeerRequest) Descriptor() ([]byte, []int)

Deprecated: Use JoinPeerRequest.ProtoReflect.Descriptor instead.

func (*JoinPeerRequest) GetAddress

func (x *JoinPeerRequest) GetAddress() string

func (*JoinPeerRequest) GetId

func (x *JoinPeerRequest) GetId() string

func (*JoinPeerRequest) GetVoter

func (x *JoinPeerRequest) GetVoter() bool

func (*JoinPeerRequest) ProtoMessage

func (*JoinPeerRequest) ProtoMessage()

func (*JoinPeerRequest) ProtoReflect

func (x *JoinPeerRequest) ProtoReflect() protoreflect.Message

func (*JoinPeerRequest) Reset

func (x *JoinPeerRequest) Reset()

func (*JoinPeerRequest) String

func (x *JoinPeerRequest) String() string

type JoinPeerResponse

type JoinPeerResponse struct {
	Leader string `protobuf:"bytes,1,opt,name=leader,proto3" json:"leader,omitempty"`
	// contains filtered or unexported fields
}

func (*JoinPeerResponse) Descriptor deprecated

func (*JoinPeerResponse) Descriptor() ([]byte, []int)

Deprecated: Use JoinPeerResponse.ProtoReflect.Descriptor instead.

func (*JoinPeerResponse) GetLeader

func (x *JoinPeerResponse) GetLeader() string

func (*JoinPeerResponse) ProtoMessage

func (*JoinPeerResponse) ProtoMessage()

func (*JoinPeerResponse) ProtoReflect

func (x *JoinPeerResponse) ProtoReflect() protoreflect.Message

func (*JoinPeerResponse) Reset

func (x *JoinPeerResponse) Reset()

func (*JoinPeerResponse) String

func (x *JoinPeerResponse) String() string

type NotifyPeerRequest

type NotifyPeerRequest struct {
	Id      string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Address string `protobuf:"bytes,2,opt,name=address,proto3" json:"address,omitempty"`
	// contains filtered or unexported fields
}

func (*NotifyPeerRequest) Descriptor deprecated

func (*NotifyPeerRequest) Descriptor() ([]byte, []int)

Deprecated: Use NotifyPeerRequest.ProtoReflect.Descriptor instead.

func (*NotifyPeerRequest) GetAddress

func (x *NotifyPeerRequest) GetAddress() string

func (*NotifyPeerRequest) GetId

func (x *NotifyPeerRequest) GetId() string

func (*NotifyPeerRequest) ProtoMessage

func (*NotifyPeerRequest) ProtoMessage()

func (*NotifyPeerRequest) ProtoReflect

func (x *NotifyPeerRequest) ProtoReflect() protoreflect.Message

func (*NotifyPeerRequest) Reset

func (x *NotifyPeerRequest) Reset()

func (*NotifyPeerRequest) String

func (x *NotifyPeerRequest) String() string

type NotifyPeerResponse

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

func (*NotifyPeerResponse) Descriptor deprecated

func (*NotifyPeerResponse) Descriptor() ([]byte, []int)

Deprecated: Use NotifyPeerResponse.ProtoReflect.Descriptor instead.

func (*NotifyPeerResponse) ProtoMessage

func (*NotifyPeerResponse) ProtoMessage()

func (*NotifyPeerResponse) ProtoReflect

func (x *NotifyPeerResponse) ProtoReflect() protoreflect.Message

func (*NotifyPeerResponse) Reset

func (x *NotifyPeerResponse) Reset()

func (*NotifyPeerResponse) String

func (x *NotifyPeerResponse) String() string

type QueryClassVersionsRequest added in v1.27.11

type QueryClassVersionsRequest struct {
	Classes []string
}

type QueryClassVersionsResponse added in v1.27.11

type QueryClassVersionsResponse struct {
	// Classes is a map of class name to the class version
	Classes map[string]uint64
}

type QueryCollectionsCountResponse added in v1.30.0

type QueryCollectionsCountResponse struct {
	Count int
}

type QueryGetRolesForUserRequest added in v1.28.0

type QueryGetRolesForUserRequest struct {
	User     string
	UserType models.UserTypeInput
}

type QueryGetRolesForUserResponse added in v1.28.0

type QueryGetRolesForUserResponse struct {
	Roles map[string][]authorization.Policy
}

type QueryGetRolesRequest added in v1.28.0

type QueryGetRolesRequest struct {
	Roles []string
}

type QueryGetRolesResponse added in v1.28.0

type QueryGetRolesResponse struct {
	Roles map[string][]authorization.Policy
}

type QueryGetUsersForRoleRequest added in v1.28.0

type QueryGetUsersForRoleRequest struct {
	Role     string
	UserType models.UserTypeInput
}

type QueryGetUsersForRoleResponse added in v1.28.0

type QueryGetUsersForRoleResponse struct {
	Users []string
}

type QueryGetUsersRequest added in v1.30.0

type QueryGetUsersRequest struct {
	UserIds []string
}

type QueryGetUsersResponse added in v1.30.0

type QueryGetUsersResponse struct {
	Users map[string]*apikey.User
}

type QueryHasPermissionRequest added in v1.28.0

type QueryHasPermissionRequest struct {
	Role       string
	Permission *authorization.Policy
}

type QueryHasPermissionResponse added in v1.28.0

type QueryHasPermissionResponse struct {
	HasPermission bool
}

type QueryReadOnlyClassResponse

type QueryReadOnlyClassResponse struct {
	Classes map[string]versioned.Class
}

type QueryReadOnlyClassesRequest

type QueryReadOnlyClassesRequest struct {
	Classes []string
}

type QueryRequest

type QueryRequest struct {
	Type       QueryRequest_Type `protobuf:"varint,1,opt,name=type,proto3,enum=weaviate.internal.cluster.QueryRequest_Type" json:"type,omitempty"`
	SubCommand []byte            `protobuf:"bytes,2,opt,name=sub_command,json=subCommand,proto3" json:"sub_command,omitempty"`
	// contains filtered or unexported fields
}

func (*QueryRequest) Descriptor deprecated

func (*QueryRequest) Descriptor() ([]byte, []int)

Deprecated: Use QueryRequest.ProtoReflect.Descriptor instead.

func (*QueryRequest) GetSubCommand

func (x *QueryRequest) GetSubCommand() []byte

func (*QueryRequest) GetType

func (x *QueryRequest) GetType() QueryRequest_Type

func (*QueryRequest) ProtoMessage

func (*QueryRequest) ProtoMessage()

func (*QueryRequest) ProtoReflect

func (x *QueryRequest) ProtoReflect() protoreflect.Message

func (*QueryRequest) Reset

func (x *QueryRequest) Reset()

func (*QueryRequest) String

func (x *QueryRequest) String() string

type QueryRequest_Type

type QueryRequest_Type int32
const (
	QueryRequest_TYPE_UNSPECIFIED            QueryRequest_Type = 0
	QueryRequest_TYPE_GET_CLASSES            QueryRequest_Type = 1
	QueryRequest_TYPE_GET_SCHEMA             QueryRequest_Type = 2
	QueryRequest_TYPE_GET_TENANTS            QueryRequest_Type = 3
	QueryRequest_TYPE_GET_SHARD_OWNER        QueryRequest_Type = 4
	QueryRequest_TYPE_GET_TENANTS_SHARDS     QueryRequest_Type = 5
	QueryRequest_TYPE_GET_SHARDING_STATE     QueryRequest_Type = 6
	QueryRequest_TYPE_GET_CLASS_VERSIONS     QueryRequest_Type = 7
	QueryRequest_TYPE_GET_COLLECTIONS_COUNT  QueryRequest_Type = 8
	QueryRequest_TYPE_HAS_PERMISSION         QueryRequest_Type = 30
	QueryRequest_TYPE_GET_ROLES              QueryRequest_Type = 31
	QueryRequest_TYPE_GET_ROLES_FOR_USER     QueryRequest_Type = 32
	QueryRequest_TYPE_GET_USERS_FOR_ROLE     QueryRequest_Type = 33
	QueryRequest_TYPE_GET_USERS              QueryRequest_Type = 61
	QueryRequest_TYPE_USER_IDENTIFIER_EXISTS QueryRequest_Type = 62
)

func (QueryRequest_Type) Descriptor

func (QueryRequest_Type) Enum

func (QueryRequest_Type) EnumDescriptor deprecated

func (QueryRequest_Type) EnumDescriptor() ([]byte, []int)

Deprecated: Use QueryRequest_Type.Descriptor instead.

func (QueryRequest_Type) Number

func (QueryRequest_Type) String

func (x QueryRequest_Type) String() string

func (QueryRequest_Type) Type

type QueryResponse

type QueryResponse struct {
	Payload []byte `protobuf:"bytes,1,opt,name=payload,proto3" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

func (*QueryResponse) Descriptor deprecated

func (*QueryResponse) Descriptor() ([]byte, []int)

Deprecated: Use QueryResponse.ProtoReflect.Descriptor instead.

func (*QueryResponse) GetPayload

func (x *QueryResponse) GetPayload() []byte

func (*QueryResponse) ProtoMessage

func (*QueryResponse) ProtoMessage()

func (*QueryResponse) ProtoReflect

func (x *QueryResponse) ProtoReflect() protoreflect.Message

func (*QueryResponse) Reset

func (x *QueryResponse) Reset()

func (*QueryResponse) String

func (x *QueryResponse) String() string

type QuerySchemaResponse

type QuerySchemaResponse struct {
	Schema models.Schema
}

type QueryShardOwnerRequest

type QueryShardOwnerRequest struct {
	Class, Shard string
}

type QueryShardOwnerResponse

type QueryShardOwnerResponse struct {
	ShardVersion uint64
	Owner        string
}

type QueryShardingStateRequest

type QueryShardingStateRequest struct {
	Class string
}

type QueryShardingStateResponse

type QueryShardingStateResponse struct {
	State   *sharding.State
	Version uint64
}

type QueryTenantsRequest

type QueryTenantsRequest struct {
	Class   string
	Tenants []string // If empty, all tenants are returned
}

type QueryTenantsResponse

type QueryTenantsResponse struct {
	ShardVersion uint64
	Tenants      []*models.TenantResponse
}

type QueryTenantsShardsRequest

type QueryTenantsShardsRequest struct {
	Class   string
	Tenants []string
}

type QueryTenantsShardsResponse

type QueryTenantsShardsResponse struct {
	TenantsActivityStatus map[string]string // map[tenant]status
	SchemaVersion         uint64
}

type QueryUserIdentifierExistsRequest added in v1.30.0

type QueryUserIdentifierExistsRequest struct {
	UserIdentifier string
}

type QueryUserIdentifierExistsResponse added in v1.30.0

type QueryUserIdentifierExistsResponse struct {
	Exists bool
}

type RemovePeerRequest

type RemovePeerRequest struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*RemovePeerRequest) Descriptor deprecated

func (*RemovePeerRequest) Descriptor() ([]byte, []int)

Deprecated: Use RemovePeerRequest.ProtoReflect.Descriptor instead.

func (*RemovePeerRequest) GetId

func (x *RemovePeerRequest) GetId() string

func (*RemovePeerRequest) ProtoMessage

func (*RemovePeerRequest) ProtoMessage()

func (*RemovePeerRequest) ProtoReflect

func (x *RemovePeerRequest) ProtoReflect() protoreflect.Message

func (*RemovePeerRequest) Reset

func (x *RemovePeerRequest) Reset()

func (*RemovePeerRequest) String

func (x *RemovePeerRequest) String() string

type RemovePeerResponse

type RemovePeerResponse struct {
	Leader string `protobuf:"bytes,1,opt,name=leader,proto3" json:"leader,omitempty"`
	// contains filtered or unexported fields
}

func (*RemovePeerResponse) Descriptor deprecated

func (*RemovePeerResponse) Descriptor() ([]byte, []int)

Deprecated: Use RemovePeerResponse.ProtoReflect.Descriptor instead.

func (*RemovePeerResponse) GetLeader

func (x *RemovePeerResponse) GetLeader() string

func (*RemovePeerResponse) ProtoMessage

func (*RemovePeerResponse) ProtoMessage()

func (*RemovePeerResponse) ProtoReflect

func (x *RemovePeerResponse) ProtoReflect() protoreflect.Message

func (*RemovePeerResponse) Reset

func (x *RemovePeerResponse) Reset()

func (*RemovePeerResponse) String

func (x *RemovePeerResponse) String() string

type RemovePermissionsRequest added in v1.28.0

type RemovePermissionsRequest struct {
	Role        string
	Permissions []*authorization.Policy
	Version     int
}

type RevokeRolesForUserRequest added in v1.28.0

type RevokeRolesForUserRequest struct {
	User    string
	Roles   []string
	Version int
}

type RotateUserApiKeyRequest added in v1.30.0

type RotateUserApiKeyRequest struct {
	UserId             string
	ApiKeyFirstLetters string
	SecureHash         string
	OldIdentifier      string
	NewIdentifier      string
	Version            int
}

type SuspendUserRequest added in v1.30.0

type SuspendUserRequest struct {
	UserId    string
	RevokeKey bool
	Version   int
}

type Tenant

type Tenant struct {
	Name   string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*Tenant) Descriptor deprecated

func (*Tenant) Descriptor() ([]byte, []int)

Deprecated: Use Tenant.ProtoReflect.Descriptor instead.

func (*Tenant) GetName

func (x *Tenant) GetName() string

func (*Tenant) GetStatus

func (x *Tenant) GetStatus() string

func (*Tenant) ProtoMessage

func (*Tenant) ProtoMessage()

func (*Tenant) ProtoReflect

func (x *Tenant) ProtoReflect() protoreflect.Message

func (*Tenant) Reset

func (x *Tenant) Reset()

func (*Tenant) String

func (x *Tenant) String() string

type TenantProcessRequest added in v1.26.0

type TenantProcessRequest struct {
	Node             string                      `protobuf:"bytes,1,opt,name=node,proto3" json:"node,omitempty"`
	Action           TenantProcessRequest_Action `protobuf:"varint,2,opt,name=action,proto3,enum=weaviate.internal.cluster.TenantProcessRequest_Action" json:"action,omitempty"`
	TenantsProcesses []*TenantsProcess           `protobuf:"bytes,3,rep,name=tenants_processes,json=tenantsProcesses,proto3" json:"tenants_processes,omitempty"`
	// contains filtered or unexported fields
}

func (*TenantProcessRequest) Descriptor deprecated added in v1.26.0

func (*TenantProcessRequest) Descriptor() ([]byte, []int)

Deprecated: Use TenantProcessRequest.ProtoReflect.Descriptor instead.

func (*TenantProcessRequest) GetAction added in v1.26.0

func (*TenantProcessRequest) GetNode added in v1.26.0

func (x *TenantProcessRequest) GetNode() string

func (*TenantProcessRequest) GetTenantsProcesses added in v1.26.0

func (x *TenantProcessRequest) GetTenantsProcesses() []*TenantsProcess

func (*TenantProcessRequest) ProtoMessage added in v1.26.0

func (*TenantProcessRequest) ProtoMessage()

func (*TenantProcessRequest) ProtoReflect added in v1.26.0

func (x *TenantProcessRequest) ProtoReflect() protoreflect.Message

func (*TenantProcessRequest) Reset added in v1.26.0

func (x *TenantProcessRequest) Reset()

func (*TenantProcessRequest) String added in v1.26.0

func (x *TenantProcessRequest) String() string

type TenantProcessRequest_Action added in v1.26.0

type TenantProcessRequest_Action int32
const (
	TenantProcessRequest_ACTION_UNSPECIFIED TenantProcessRequest_Action = 0
	TenantProcessRequest_ACTION_FREEZING    TenantProcessRequest_Action = 1
	TenantProcessRequest_ACTION_UNFREEZING  TenantProcessRequest_Action = 2
)

func (TenantProcessRequest_Action) Descriptor added in v1.26.0

func (TenantProcessRequest_Action) Enum added in v1.26.0

func (TenantProcessRequest_Action) EnumDescriptor deprecated added in v1.26.0

func (TenantProcessRequest_Action) EnumDescriptor() ([]byte, []int)

Deprecated: Use TenantProcessRequest_Action.Descriptor instead.

func (TenantProcessRequest_Action) Number added in v1.26.0

func (TenantProcessRequest_Action) String added in v1.26.0

func (TenantProcessRequest_Action) Type added in v1.26.0

type TenantWithVersion

type TenantWithVersion struct {
	ShardVersion uint64
	Tenant       *models.Tenant
}

type TenantsProcess added in v1.26.0

type TenantsProcess struct {
	Op     TenantsProcess_Op `protobuf:"varint,1,opt,name=op,proto3,enum=weaviate.internal.cluster.TenantsProcess_Op" json:"op,omitempty"`
	Tenant *Tenant           `protobuf:"bytes,2,opt,name=tenant,proto3" json:"tenant,omitempty"`
	// contains filtered or unexported fields
}

func (*TenantsProcess) Descriptor deprecated added in v1.26.0

func (*TenantsProcess) Descriptor() ([]byte, []int)

Deprecated: Use TenantsProcess.ProtoReflect.Descriptor instead.

func (*TenantsProcess) GetOp added in v1.26.0

func (x *TenantsProcess) GetOp() TenantsProcess_Op

func (*TenantsProcess) GetTenant added in v1.26.0

func (x *TenantsProcess) GetTenant() *Tenant

func (*TenantsProcess) ProtoMessage added in v1.26.0

func (*TenantsProcess) ProtoMessage()

func (*TenantsProcess) ProtoReflect added in v1.26.0

func (x *TenantsProcess) ProtoReflect() protoreflect.Message

func (*TenantsProcess) Reset added in v1.26.0

func (x *TenantsProcess) Reset()

func (*TenantsProcess) String added in v1.26.0

func (x *TenantsProcess) String() string

type TenantsProcess_Op added in v1.26.0

type TenantsProcess_Op int32
const (
	TenantsProcess_OP_UNSPECIFIED TenantsProcess_Op = 0
	TenantsProcess_OP_START       TenantsProcess_Op = 1
	TenantsProcess_OP_DONE        TenantsProcess_Op = 2
	TenantsProcess_OP_ABORT       TenantsProcess_Op = 3
)

func (TenantsProcess_Op) Descriptor added in v1.26.0

func (TenantsProcess_Op) Enum added in v1.26.0

func (TenantsProcess_Op) EnumDescriptor deprecated added in v1.26.0

func (TenantsProcess_Op) EnumDescriptor() ([]byte, []int)

Deprecated: Use TenantsProcess_Op.Descriptor instead.

func (TenantsProcess_Op) Number added in v1.26.0

func (TenantsProcess_Op) String added in v1.26.0

func (x TenantsProcess_Op) String() string

func (TenantsProcess_Op) Type added in v1.26.0

type UnimplementedClusterServiceServer

type UnimplementedClusterServiceServer struct{}

UnimplementedClusterServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedClusterServiceServer) Apply

func (UnimplementedClusterServiceServer) JoinPeer

func (UnimplementedClusterServiceServer) NotifyPeer

func (UnimplementedClusterServiceServer) Query

func (UnimplementedClusterServiceServer) RemovePeer

type UnsafeClusterServiceServer

type UnsafeClusterServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeClusterServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ClusterServiceServer will result in compilation errors.

type UpdateClassRequest

type UpdateClassRequest struct {
	Class *models.Class
	State *sharding.State
}

type UpdateShardStatusRequest

type UpdateShardStatusRequest struct {
	Class, Shard, Status string
	SchemaVersion        uint64
}

type UpdateTenantsRequest

type UpdateTenantsRequest struct {
	Tenants      []*Tenant `protobuf:"bytes,1,rep,name=tenants,proto3" json:"tenants,omitempty"`
	ClusterNodes []string  `protobuf:"bytes,2,rep,name=cluster_nodes,json=clusterNodes,proto3" json:"cluster_nodes,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateTenantsRequest) Descriptor deprecated

func (*UpdateTenantsRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateTenantsRequest.ProtoReflect.Descriptor instead.

func (*UpdateTenantsRequest) GetClusterNodes added in v1.26.0

func (x *UpdateTenantsRequest) GetClusterNodes() []string

func (*UpdateTenantsRequest) GetTenants

func (x *UpdateTenantsRequest) GetTenants() []*Tenant

func (*UpdateTenantsRequest) ProtoMessage

func (*UpdateTenantsRequest) ProtoMessage()

func (*UpdateTenantsRequest) ProtoReflect

func (x *UpdateTenantsRequest) ProtoReflect() protoreflect.Message

func (*UpdateTenantsRequest) Reset

func (x *UpdateTenantsRequest) Reset()

func (*UpdateTenantsRequest) String

func (x *UpdateTenantsRequest) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL