netmap

type Clause int32

type Filter struct {

	// Name of the filter or a reference to a named filter. '*' means
	// application to the whole unfiltered NetworkMap. At top level it's used as a
	// filter name. At lower levels it's considered to be a reference to another
	// named filter
	Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// Key to filter
	Key *string `protobuf:"bytes,2,opt,name=key" json:"key,omitempty"`
	// Filtering operation
	Op *Operation `protobuf:"varint,3,opt,name=op,enum=frost.fs.netmap.Operation" json:"op,omitempty"`
	// Value to match
	Value *string `protobuf:"bytes,4,opt,name=value" json:"value,omitempty"`
	// List of inner filters. Top level operation will be applied to the whole
	// list.
	Filters []*Filter `protobuf:"bytes,5,rep,name=filters" json:"filters,omitempty"`
	// contains filtered or unexported fields
}

type Filter_builder struct {

	// Name of the filter or a reference to a named filter. '*' means
	// application to the whole unfiltered NetworkMap. At top level it's used as a
	// filter name. At lower levels it's considered to be a reference to another
	// named filter
	Name *string
	// Key to filter
	Key *string
	// Filtering operation
	Op *Operation
	// Value to match
	Value *string
	// List of inner filters. Top level operation will be applied to the whole
	// list.
	Filters []*Filter
	// contains filtered or unexported fields
}

type LocalNodeInfoRequest struct {

	// Body of the LocalNodeInfo request message
	Body *LocalNodeInfoRequest_Body `protobuf:"bytes,1,opt,name=body" json:"body,omitempty"`
	// Carries request meta information. Header data is used only to regulate
	// message transport and does not affect request execution.
	MetaHeader *grpc.RequestMetaHeader `protobuf:"bytes,2,opt,name=meta_header,json=metaHeader" json:"meta_header,omitempty"`
	// Carries request verification information. This header is used to
	// authenticate the nodes of the message route and check the correctness of
	// transmission.
	VerifyHeader *grpc.RequestVerificationHeader `protobuf:"bytes,3,opt,name=verify_header,json=verifyHeader" json:"verify_header,omitempty"`
	// contains filtered or unexported fields
}

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

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

type LocalNodeInfoRequest_builder struct {

	// Body of the LocalNodeInfo request message
	Body *LocalNodeInfoRequest_Body
	// Carries request meta information. Header data is used only to regulate
	// message transport and does not affect request execution.
	MetaHeader *grpc.RequestMetaHeader
	// Carries request verification information. This header is used to
	// authenticate the nodes of the message route and check the correctness of
	// transmission.
	VerifyHeader *grpc.RequestVerificationHeader
	// contains filtered or unexported fields
}

type LocalNodeInfoResponse struct {

	// Body of the balance response message.
	Body *LocalNodeInfoResponse_Body `protobuf:"bytes,1,opt,name=body" json:"body,omitempty"`
	// Carries response meta information. Header data is used only to regulate
	// message transport and does not affect response execution.
	MetaHeader *grpc.ResponseMetaHeader `protobuf:"bytes,2,opt,name=meta_header,json=metaHeader" json:"meta_header,omitempty"`
	// Carries response verification information. This header is used to
	// authenticate the nodes of the message route and check the correctness of
	// transmission.
	VerifyHeader *grpc.ResponseVerificationHeader `protobuf:"bytes,3,opt,name=verify_header,json=verifyHeader" json:"verify_header,omitempty"`
	// contains filtered or unexported fields
}

type LocalNodeInfoResponse_Body struct {

	// Latest FrostFS API version in use
	Version *grpc1.Version `protobuf:"bytes,1,opt,name=version" json:"version,omitempty"`
	// NodeInfo structure with recent information from node itself
	NodeInfo *NodeInfo `protobuf:"bytes,2,opt,name=node_info,json=nodeInfo" json:"node_info,omitempty"`
	// contains filtered or unexported fields
}

type LocalNodeInfoResponse_Body_builder struct {

	// Latest FrostFS API version in use
	Version *grpc1.Version
	// NodeInfo structure with recent information from node itself
	NodeInfo *NodeInfo
	// contains filtered or unexported fields
}

type LocalNodeInfoResponse_builder struct {

	// Body of the balance response message.
	Body *LocalNodeInfoResponse_Body
	// Carries response meta information. Header data is used only to regulate
	// message transport and does not affect response execution.
	MetaHeader *grpc.ResponseMetaHeader
	// Carries response verification information. This header is used to
	// authenticate the nodes of the message route and check the correctness of
	// transmission.
	VerifyHeader *grpc.ResponseVerificationHeader
	// contains filtered or unexported fields
}

type Netmap struct {

	// Network map revision number.
	Epoch *uint64 `protobuf:"varint,1,opt,name=epoch" json:"epoch,omitempty"`
	// Nodes presented in network.
	Nodes []*NodeInfo `protobuf:"bytes,2,rep,name=nodes" json:"nodes,omitempty"`
	// contains filtered or unexported fields
}

type NetmapServiceClient interface {
	// Get NodeInfo structure from the particular node directly.
	// Node information can be taken from `Netmap` smart contract. In some cases,
	// though, one may want to get recent information directly or to talk to the
	// node not yet present in the `Network Map` to find out what API version can
	// be used for further communication. This can be also used to check if a node
	// is up and running.
	//
	// Statuses:
	// - **OK** (0, SECTION_SUCCESS):
	// information about the server has been successfully read;
	// - Common failures (SECTION_FAILURE_COMMON).
	LocalNodeInfo(ctx context.Context, in *LocalNodeInfoRequest, opts ...grpc.CallOption) (*LocalNodeInfoResponse, error)
	// Read recent information about the FrostFS network.
	//
	// Statuses:
	// - **OK** (0, SECTION_SUCCESS):
	// information about the current network state has been successfully read;
	// - Common failures (SECTION_FAILURE_COMMON).
	NetworkInfo(ctx context.Context, in *NetworkInfoRequest, opts ...grpc.CallOption) (*NetworkInfoResponse, error)
	// Returns network map snapshot of the current FrostFS epoch.
	//
	// Statuses:
	// - **OK** (0, SECTION_SUCCESS):
	// information about the current network map has been successfully read;
	// - Common failures (SECTION_FAILURE_COMMON).
	NetmapSnapshot(ctx context.Context, in *NetmapSnapshotRequest, opts ...grpc.CallOption) (*NetmapSnapshotResponse, error)
}

type NetmapServiceServer interface {
	// Get NodeInfo structure from the particular node directly.
	// Node information can be taken from `Netmap` smart contract. In some cases,
	// though, one may want to get recent information directly or to talk to the
	// node not yet present in the `Network Map` to find out what API version can
	// be used for further communication. This can be also used to check if a node
	// is up and running.
	//
	// Statuses:
	// - **OK** (0, SECTION_SUCCESS):
	// information about the server has been successfully read;
	// - Common failures (SECTION_FAILURE_COMMON).
	LocalNodeInfo(context.Context, *LocalNodeInfoRequest) (*LocalNodeInfoResponse, error)
	// Read recent information about the FrostFS network.
	//
	// Statuses:
	// - **OK** (0, SECTION_SUCCESS):
	// information about the current network state has been successfully read;
	// - Common failures (SECTION_FAILURE_COMMON).
	NetworkInfo(context.Context, *NetworkInfoRequest) (*NetworkInfoResponse, error)
	// Returns network map snapshot of the current FrostFS epoch.
	//
	// Statuses:
	// - **OK** (0, SECTION_SUCCESS):
	// information about the current network map has been successfully read;
	// - Common failures (SECTION_FAILURE_COMMON).
	NetmapSnapshot(context.Context, *NetmapSnapshotRequest) (*NetmapSnapshotResponse, error)
}

type NetmapSnapshotRequest struct {

	// Body of get netmap snapshot request message.
	Body *NetmapSnapshotRequest_Body `protobuf:"bytes,1,opt,name=body" json:"body,omitempty"`
	// Carries request meta information. Header data is used only to regulate
	// message transport and does not affect request execution.
	MetaHeader *grpc.RequestMetaHeader `protobuf:"bytes,2,opt,name=meta_header,json=metaHeader" json:"meta_header,omitempty"`
	// Carries request verification information. This header is used to
	// authenticate the nodes of the message route and check the correctness of
	// transmission.
	VerifyHeader *grpc.RequestVerificationHeader `protobuf:"bytes,3,opt,name=verify_header,json=verifyHeader" json:"verify_header,omitempty"`
	// contains filtered or unexported fields
}

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

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

type NetmapSnapshotRequest_builder struct {

	// Body of get netmap snapshot request message.
	Body *NetmapSnapshotRequest_Body
	// Carries request meta information. Header data is used only to regulate
	// message transport and does not affect request execution.
	MetaHeader *grpc.RequestMetaHeader
	// Carries request verification information. This header is used to
	// authenticate the nodes of the message route and check the correctness of
	// transmission.
	VerifyHeader *grpc.RequestVerificationHeader
	// contains filtered or unexported fields
}

type NetmapSnapshotResponse struct {

	// Body of get netmap snapshot response message.
	Body *NetmapSnapshotResponse_Body `protobuf:"bytes,1,opt,name=body" json:"body,omitempty"`
	// Carries response meta information. Header data is used only to regulate
	// message transport and does not affect response execution.
	MetaHeader *grpc.ResponseMetaHeader `protobuf:"bytes,2,opt,name=meta_header,json=metaHeader" json:"meta_header,omitempty"`
	// Carries response verification information. This header is used to
	// authenticate the nodes of the message route and check the correctness of
	// transmission.
	VerifyHeader *grpc.ResponseVerificationHeader `protobuf:"bytes,3,opt,name=verify_header,json=verifyHeader" json:"verify_header,omitempty"`
	// contains filtered or unexported fields
}

type NetmapSnapshotResponse_Body struct {

	// Structure of the requested network map.
	Netmap *Netmap `protobuf:"bytes,1,opt,name=netmap" json:"netmap,omitempty"`
	// contains filtered or unexported fields
}

type NetmapSnapshotResponse_Body_builder struct {

	// Structure of the requested network map.
	Netmap *Netmap
	// contains filtered or unexported fields
}

type NetmapSnapshotResponse_builder struct {

	// Body of get netmap snapshot response message.
	Body *NetmapSnapshotResponse_Body
	// Carries response meta information. Header data is used only to regulate
	// message transport and does not affect response execution.
	MetaHeader *grpc.ResponseMetaHeader
	// Carries response verification information. This header is used to
	// authenticate the nodes of the message route and check the correctness of
	// transmission.
	VerifyHeader *grpc.ResponseVerificationHeader
	// contains filtered or unexported fields
}

type Netmap_builder struct {

	// Network map revision number.
	Epoch *uint64
	// Nodes presented in network.
	Nodes []*NodeInfo
	// contains filtered or unexported fields
}

type NetworkConfig struct {

	// List of parameter values
	Parameters []*NetworkConfig_Parameter `protobuf:"bytes,1,rep,name=parameters" json:"parameters,omitempty"`
	// contains filtered or unexported fields
}

type NetworkConfig_Parameter struct {

	// Parameter key. UTF-8 encoded string
	Key []byte `protobuf:"bytes,1,opt,name=key" json:"key,omitempty"`
	// Parameter value
	Value []byte `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"`
	// contains filtered or unexported fields
}

type NetworkConfig_Parameter_builder struct {

	// Parameter key. UTF-8 encoded string
	Key []byte
	// Parameter value
	Value []byte
	// contains filtered or unexported fields
}

type NetworkConfig_builder struct {

	// List of parameter values
	Parameters []*NetworkConfig_Parameter
	// contains filtered or unexported fields
}

type NetworkInfo struct {

	// Number of the current epoch in the FrostFS network
	CurrentEpoch *uint64 `protobuf:"varint,1,opt,name=current_epoch,json=currentEpoch" json:"current_epoch,omitempty"`
	// Magic number of the sidechain of the FrostFS network
	MagicNumber *uint64 `protobuf:"varint,2,opt,name=magic_number,json=magicNumber" json:"magic_number,omitempty"`
	// MillisecondsPerBlock network parameter of the sidechain of the FrostFS
	// network
	MsPerBlock *int64 `protobuf:"varint,3,opt,name=ms_per_block,json=msPerBlock" json:"ms_per_block,omitempty"`
	// FrostFS network configuration
	NetworkConfig *NetworkConfig `protobuf:"bytes,4,opt,name=network_config,json=networkConfig" json:"network_config,omitempty"`
	// contains filtered or unexported fields
}

type NetworkInfoRequest struct {

	// Body of the NetworkInfo request message
	Body *NetworkInfoRequest_Body `protobuf:"bytes,1,opt,name=body" json:"body,omitempty"`
	// Carries request meta information. Header data is used only to regulate
	// message transport and does not affect request execution.
	MetaHeader *grpc.RequestMetaHeader `protobuf:"bytes,2,opt,name=meta_header,json=metaHeader" json:"meta_header,omitempty"`
	// Carries request verification information. This header is used to
	// authenticate the nodes of the message route and check the correctness of
	// transmission.
	VerifyHeader *grpc.RequestVerificationHeader `protobuf:"bytes,3,opt,name=verify_header,json=verifyHeader" json:"verify_header,omitempty"`
	// contains filtered or unexported fields
}

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

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

type NetworkInfoRequest_builder struct {

	// Body of the NetworkInfo request message
	Body *NetworkInfoRequest_Body
	// Carries request meta information. Header data is used only to regulate
	// message transport and does not affect request execution.
	MetaHeader *grpc.RequestMetaHeader
	// Carries request verification information. This header is used to
	// authenticate the nodes of the message route and check the correctness of
	// transmission.
	VerifyHeader *grpc.RequestVerificationHeader
	// contains filtered or unexported fields
}

type NetworkInfoResponse struct {

	// Body of the NetworkInfo response message.
	Body *NetworkInfoResponse_Body `protobuf:"bytes,1,opt,name=body" json:"body,omitempty"`
	// Carries response meta information. Header data is used only to regulate
	// message transport and does not affect response execution.
	MetaHeader *grpc.ResponseMetaHeader `protobuf:"bytes,2,opt,name=meta_header,json=metaHeader" json:"meta_header,omitempty"`
	// Carries response verification information. This header is used to
	// authenticate the nodes of the message route and check the correctness of
	// transmission.
	VerifyHeader *grpc.ResponseVerificationHeader `protobuf:"bytes,3,opt,name=verify_header,json=verifyHeader" json:"verify_header,omitempty"`
	// contains filtered or unexported fields
}

type NetworkInfoResponse_Body struct {

	// NetworkInfo structure with recent information.
	NetworkInfo *NetworkInfo `protobuf:"bytes,1,opt,name=network_info,json=networkInfo" json:"network_info,omitempty"`
	// contains filtered or unexported fields
}

type NetworkInfoResponse_Body_builder struct {

	// NetworkInfo structure with recent information.
	NetworkInfo *NetworkInfo
	// contains filtered or unexported fields
}

type NetworkInfoResponse_builder struct {

	// Body of the NetworkInfo response message.
	Body *NetworkInfoResponse_Body
	// Carries response meta information. Header data is used only to regulate
	// message transport and does not affect response execution.
	MetaHeader *grpc.ResponseMetaHeader
	// Carries response verification information. This header is used to
	// authenticate the nodes of the message route and check the correctness of
	// transmission.
	VerifyHeader *grpc.ResponseVerificationHeader
	// contains filtered or unexported fields
}

type NetworkInfo_builder struct {

	// Number of the current epoch in the FrostFS network
	CurrentEpoch *uint64
	// Magic number of the sidechain of the FrostFS network
	MagicNumber *uint64
	// MillisecondsPerBlock network parameter of the sidechain of the FrostFS
	// network
	MsPerBlock *int64
	// FrostFS network configuration
	NetworkConfig *NetworkConfig
	// contains filtered or unexported fields
}

type NodeInfo struct {

	// Public key of the FrostFS node in a binary format
	PublicKey []byte `protobuf:"bytes,1,opt,name=public_key,json=publicKey" json:"public_key,omitempty"`
	// Ways to connect to a node
	Addresses []string `protobuf:"bytes,2,rep,name=addresses" json:"addresses,omitempty"`
	// Carries list of the FrostFS node attributes in a key-value form. Key name
	// must be a node-unique valid UTF-8 string. Value can't be empty. NodeInfo
	// structures with duplicated attribute names or attributes with empty values
	// will be considered invalid.
	Attributes []*NodeInfo_Attribute `protobuf:"bytes,3,rep,name=attributes" json:"attributes,omitempty"`
	// Carries state of the FrostFS node
	State *NodeInfo_State `protobuf:"varint,4,opt,name=state,enum=frost.fs.netmap.NodeInfo_State" json:"state,omitempty"`
	// contains filtered or unexported fields
}

type NodeInfo_Attribute struct {

	// Key of the node attribute
	Key *string `protobuf:"bytes,1,opt,name=key" json:"key,omitempty"`
	// Value of the node attribute
	Value *string `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"`
	// Parent keys, if any. For example for `City` it could be `Region` and
	// `Country`.
	Parents []string `protobuf:"bytes,3,rep,name=parents" json:"parents,omitempty"`
	// contains filtered or unexported fields
}

type NodeInfo_Attribute_builder struct {

	// Key of the node attribute
	Key *string
	// Value of the node attribute
	Value *string
	// Parent keys, if any. For example for `City` it could be `Region` and
	// `Country`.
	Parents []string
	// contains filtered or unexported fields
}

type NodeInfo_State int32

type NodeInfo_builder struct {

	// Public key of the FrostFS node in a binary format
	PublicKey []byte
	// Ways to connect to a node
	Addresses []string
	// Carries list of the FrostFS node attributes in a key-value form. Key name
	// must be a node-unique valid UTF-8 string. Value can't be empty. NodeInfo
	// structures with duplicated attribute names or attributes with empty values
	// will be considered invalid.
	Attributes []*NodeInfo_Attribute
	// Carries state of the FrostFS node
	State *NodeInfo_State
	// contains filtered or unexported fields
}

type Operation int32

type PlacementPolicy struct {

	// Rules to set number of object replicas and place each one into a named
	// bucket
	Replicas []*Replica `protobuf:"bytes,1,rep,name=replicas" json:"replicas,omitempty"`
	// Container backup factor controls how deep FrostFS will search for nodes
	// alternatives to include into container's nodes subset
	ContainerBackupFactor *uint32 `protobuf:"varint,2,opt,name=container_backup_factor,json=containerBackupFactor" json:"container_backup_factor,omitempty"`
	// Set of Selectors to form the container's nodes subset
	Selectors []*Selector `protobuf:"bytes,3,rep,name=selectors" json:"selectors,omitempty"`
	// List of named filters to reference in selectors
	Filters []*Filter `protobuf:"bytes,4,rep,name=filters" json:"filters,omitempty"`
	// Unique flag defines non-overlapping application for replicas
	Unique *bool `protobuf:"varint,5,opt,name=unique" json:"unique,omitempty"`
	// contains filtered or unexported fields
}

type PlacementPolicy_builder struct {

	// Rules to set number of object replicas and place each one into a named
	// bucket
	Replicas []*Replica
	// Container backup factor controls how deep FrostFS will search for nodes
	// alternatives to include into container's nodes subset
	ContainerBackupFactor *uint32
	// Set of Selectors to form the container's nodes subset
	Selectors []*Selector
	// List of named filters to reference in selectors
	Filters []*Filter
	// Unique flag defines non-overlapping application for replicas
	Unique *bool
	// contains filtered or unexported fields
}

type Replica struct {

	// How many object replicas to put
	Count *uint32 `protobuf:"varint,1,opt,name=count" json:"count,omitempty"`
	// Named selector bucket to put replicas
	Selector *string `protobuf:"bytes,2,opt,name=selector" json:"selector,omitempty"`
	// Data shards count
	EcDataCount *uint32 `protobuf:"varint,3,opt,name=ec_data_count,json=ecDataCount" json:"ec_data_count,omitempty"`
	// Parity shards count
	EcParityCount *uint32 `protobuf:"varint,4,opt,name=ec_parity_count,json=ecParityCount" json:"ec_parity_count,omitempty"`
	// Use all nodes from the node set defined by the selector.
	// This flag is applicable only to the 'REP' selector and cannot be used for
	// 'EC'.
	Wildcard *bool `protobuf:"varint,5,opt,name=wildcard" json:"wildcard,omitempty"`
	// contains filtered or unexported fields
}

type Replica_builder struct {

	// How many object replicas to put
	Count *uint32
	// Named selector bucket to put replicas
	Selector *string
	// Data shards count
	EcDataCount *uint32
	// Parity shards count
	EcParityCount *uint32
	// Use all nodes from the node set defined by the selector.
	// This flag is applicable only to the 'REP' selector and cannot be used for
	// 'EC'.
	Wildcard *bool
	// contains filtered or unexported fields
}

type Selector struct {

	// Selector name to reference in object placement section
	Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// How many nodes to select from the bucket
	Count *uint32 `protobuf:"varint,2,opt,name=count" json:"count,omitempty"`
	// Selector modifier showing how to form a bucket
	Clause *Clause `protobuf:"varint,3,opt,name=clause,enum=frost.fs.netmap.Clause" json:"clause,omitempty"`
	// Bucket attribute to select from
	Attribute *string `protobuf:"bytes,4,opt,name=attribute" json:"attribute,omitempty"`
	// Filter reference to select from
	Filter *string `protobuf:"bytes,5,opt,name=filter" json:"filter,omitempty"`
	// Use all nodes from the bucket.
	Wildcard *bool `protobuf:"varint,6,opt,name=wildcard" json:"wildcard,omitempty"`
	// contains filtered or unexported fields
}

type Selector_builder struct {

	// Selector name to reference in object placement section
	Name *string
	// How many nodes to select from the bucket
	Count *uint32
	// Selector modifier showing how to form a bucket
	Clause *Clause
	// Bucket attribute to select from
	Attribute *string
	// Filter reference to select from
	Filter *string
	// Use all nodes from the bucket.
	Wildcard *bool
	// contains filtered or unexported fields
}

type UnimplementedNetmapServiceServer struct{}

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