netmap

package
v1.27.0 Latest Latest
Warning

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

 Go to latest Published: Jun 3, 2021 License: Apache-2.0 Imports: 11 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	Operation_name = map[int32]string{
		0: "OPERATION_UNSPECIFIED",
		1: "EQ",
		2: "NE",
		3: "GT",
		4: "GE",
		5: "LT",
		6: "LE",
		7: "OR",
		8: "AND",
	}
	Operation_value = map[string]int32{
		"OPERATION_UNSPECIFIED": 0,
		"EQ":                    1,
		"NE":                    2,
		"GT":                    3,
		"GE":                    4,
		"LT":                    5,
		"LE":                    6,
		"OR":                    7,
		"AND":                   8,
	}
)

Enum value maps for Operation.

View Source 
var (
	Clause_name = map[int32]string{
		0: "CLAUSE_UNSPECIFIED",
		1: "SAME",
		2: "DISTINCT",
	}
	Clause_value = map[string]int32{
		"CLAUSE_UNSPECIFIED": 0,
		"SAME":               1,
		"DISTINCT":           2,
	}
)

Enum value maps for Clause.

View Source 
var (
	NodeInfo_State_name = map[int32]string{
		0: "UNSPECIFIED",
		1: "ONLINE",
		2: "OFFLINE",
	}
	NodeInfo_State_value = map[string]int32{
		"UNSPECIFIED": 0,
		"ONLINE":      1,
		"OFFLINE":     2,
	}
)

Enum value maps for NodeInfo_State.

View Source 
var File_v2_netmap_grpc_service_proto protoreflect.FileDescriptor
View Source 
var File_v2_netmap_grpc_types_proto protoreflect.FileDescriptor

Functions

func RegisterNetmapServiceServer 

func RegisterNetmapServiceServer(s *grpc2.Server, srv NetmapServiceServer)

Types

type Clause 

type Clause int32

Selector modifier shows how the node set will be formed. By default selector just groups nodes into a bucket by attribute, selecting nodes only by their hash distance. 

const (
	// No modifier defined. Will select nodes from bucket randomly.
	Clause_CLAUSE_UNSPECIFIED Clause = 0
	// SAME will select only nodes having the same value of bucket attribute
	Clause_SAME Clause = 1
	// DISTINCT will select nodes having different values of bucket attribute
	Clause_DISTINCT Clause = 2
)

func (Clause) Descriptor 

func (Clause) Descriptor() protoreflect.EnumDescriptor

func (Clause) Enum 

func (x Clause) Enum() *Clause

func (Clause) EnumDescriptor deprecated 

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

Deprecated: Use Clause.Descriptor instead.

func (Clause) Number 

func (x Clause) Number() protoreflect.EnumNumber

func (Clause) String 

func (x Clause) String() string

func (Clause) Type 

func (Clause) Type() protoreflect.EnumType

type Filter 

type Filter struct {

	// Name of the filter or a reference to the 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,proto3" json:"name,omitempty"`
	// Key to filter
	Key string `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
	// Filtering operation
	Op Operation `protobuf:"varint,3,opt,name=op,proto3,enum=neo.fs.v2.netmap.Operation" json:"op,omitempty"`
	// Value to match
	Value string `protobuf:"bytes,4,opt,name=value,proto3" 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,proto3" json:"filters,omitempty"`
	// contains filtered or unexported fields
}

Filter will return the subset of nodes from `NetworkMap` or another filter's results, that will satisfy filter's conditions.

func (*Filter) Descriptor deprecated 

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

Deprecated: Use Filter.ProtoReflect.Descriptor instead.

func (*Filter) GetFilters 

func (x *Filter) GetFilters() []*Filter

func (*Filter) GetKey 

func (x *Filter) GetKey() string

func (*Filter) GetName 

func (x *Filter) GetName() string

func (*Filter) GetOp 

func (x *Filter) GetOp() Operation

func (*Filter) GetValue 

func (x *Filter) GetValue() string

func (*Filter) ProtoMessage 

func (*Filter) ProtoMessage()

func (*Filter) ProtoReflect 

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

func (*Filter) Reset 

func (x *Filter) Reset()

func (*Filter) SetFilters 

func (m *Filter) SetFilters(v []*Filter)

SetFilters sets sub-filters of placement filter.

func (*Filter) SetKey 

func (m *Filter) SetKey(v string)

SetKey of placement filter.

func (*Filter) SetName 

func (m *Filter) SetName(v string)

SetName of placement filter.

func (*Filter) SetOp 

func (m *Filter) SetOp(v Operation)

SetOperation of placement filter.

func (*Filter) SetValue 

func (m *Filter) SetValue(v string)

SetValue of placement filter.

func (*Filter) String 

func (x *Filter) String() string

type LocalNodeInfoRequest 

type LocalNodeInfoRequest struct {

	// Body of the LocalNodeInfo request message
	Body *LocalNodeInfoRequest_Body `protobuf:"bytes,1,opt,name=body,proto3" 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,proto3" 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,proto3" json:"verify_header,omitempty"`
	// contains filtered or unexported fields
}

Get NodeInfo structure from the particular node directly

func (*LocalNodeInfoRequest) Descriptor deprecated 

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

Deprecated: Use LocalNodeInfoRequest.ProtoReflect.Descriptor instead.

func (*LocalNodeInfoRequest) GetBody 

func (x *LocalNodeInfoRequest) GetBody() *LocalNodeInfoRequest_Body

func (*LocalNodeInfoRequest) GetMetaHeader 

func (x *LocalNodeInfoRequest) GetMetaHeader() *grpc.RequestMetaHeader

func (*LocalNodeInfoRequest) GetVerifyHeader 

func (x *LocalNodeInfoRequest) GetVerifyHeader() *grpc.RequestVerificationHeader

func (*LocalNodeInfoRequest) ProtoMessage 

func (*LocalNodeInfoRequest) ProtoMessage()

func (*LocalNodeInfoRequest) ProtoReflect 

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

func (*LocalNodeInfoRequest) Reset 

func (x *LocalNodeInfoRequest) Reset()

func (*LocalNodeInfoRequest) SetBody 

func (m *LocalNodeInfoRequest) SetBody(v *LocalNodeInfoRequest_Body)

SetBody sets body of the request.

func (*LocalNodeInfoRequest) SetMetaHeader 

func (m *LocalNodeInfoRequest) SetMetaHeader(v *session.RequestMetaHeader)

SetMetaHeader sets meta header of the request.

func (*LocalNodeInfoRequest) SetVerifyHeader 

func (m *LocalNodeInfoRequest) SetVerifyHeader(v *session.RequestVerificationHeader)

SetVerifyHeader sets verification header of the request.

func (*LocalNodeInfoRequest) String 

func (x *LocalNodeInfoRequest) String() string

type LocalNodeInfoRequest_Body 

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

LocalNodeInfo request body is empty.

func (*LocalNodeInfoRequest_Body) Descriptor deprecated 

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

Deprecated: Use LocalNodeInfoRequest_Body.ProtoReflect.Descriptor instead.

func (*LocalNodeInfoRequest_Body) ProtoMessage 

func (*LocalNodeInfoRequest_Body) ProtoMessage()

func (*LocalNodeInfoRequest_Body) ProtoReflect 

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

func (*LocalNodeInfoRequest_Body) Reset 

func (x *LocalNodeInfoRequest_Body) Reset()

func (*LocalNodeInfoRequest_Body) String 

func (x *LocalNodeInfoRequest_Body) String() string

type LocalNodeInfoResponse 

type LocalNodeInfoResponse struct {

	// Body of the balance response message.
	Body *LocalNodeInfoResponse_Body `protobuf:"bytes,1,opt,name=body,proto3" 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,proto3" 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,proto3" json:"verify_header,omitempty"`
	// contains filtered or unexported fields
}

Local Node Info, including API Version in use

func (*LocalNodeInfoResponse) Descriptor deprecated 

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

Deprecated: Use LocalNodeInfoResponse.ProtoReflect.Descriptor instead.

func (*LocalNodeInfoResponse) GetBody 

func (x *LocalNodeInfoResponse) GetBody() *LocalNodeInfoResponse_Body

func (*LocalNodeInfoResponse) GetMetaHeader 

func (x *LocalNodeInfoResponse) GetMetaHeader() *grpc.ResponseMetaHeader

func (*LocalNodeInfoResponse) GetVerifyHeader 

func (x *LocalNodeInfoResponse) GetVerifyHeader() *grpc.ResponseVerificationHeader

func (*LocalNodeInfoResponse) ProtoMessage 

func (*LocalNodeInfoResponse) ProtoMessage()

func (*LocalNodeInfoResponse) ProtoReflect 

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

func (*LocalNodeInfoResponse) Reset 

func (x *LocalNodeInfoResponse) Reset()

func (*LocalNodeInfoResponse) SetBody 

func (m *LocalNodeInfoResponse) SetBody(v *LocalNodeInfoResponse_Body)

SetBody sets body of the response.

func (*LocalNodeInfoResponse) SetMetaHeader 

func (m *LocalNodeInfoResponse) SetMetaHeader(v *session.ResponseMetaHeader)

SetMetaHeader sets meta header of the response.

func (*LocalNodeInfoResponse) SetVerifyHeader 

func (m *LocalNodeInfoResponse) SetVerifyHeader(v *session.ResponseVerificationHeader)

SetVerifyHeader sets verification header of the response.

func (*LocalNodeInfoResponse) String 

func (x *LocalNodeInfoResponse) String() string

type LocalNodeInfoResponse_Body 

type LocalNodeInfoResponse_Body struct {

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

Local Node Info, including API Version in use.

func (*LocalNodeInfoResponse_Body) Descriptor deprecated 

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

Deprecated: Use LocalNodeInfoResponse_Body.ProtoReflect.Descriptor instead.

func (*LocalNodeInfoResponse_Body) GetNodeInfo 

func (x *LocalNodeInfoResponse_Body) GetNodeInfo() *NodeInfo

func (*LocalNodeInfoResponse_Body) GetVersion 

func (x *LocalNodeInfoResponse_Body) GetVersion() *grpc1.Version

func (*LocalNodeInfoResponse_Body) ProtoMessage 

func (*LocalNodeInfoResponse_Body) ProtoMessage()

func (*LocalNodeInfoResponse_Body) ProtoReflect 

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

func (*LocalNodeInfoResponse_Body) Reset 

func (x *LocalNodeInfoResponse_Body) Reset()

func (*LocalNodeInfoResponse_Body) SetNodeInfo 

func (m *LocalNodeInfoResponse_Body) SetNodeInfo(v *NodeInfo)

SetNodeInfo sets node info of response body.

func (*LocalNodeInfoResponse_Body) SetVersion 

func (m *LocalNodeInfoResponse_Body) SetVersion(v *refs.Version)

SetVersion sets version of response body.

func (*LocalNodeInfoResponse_Body) String 

func (x *LocalNodeInfoResponse_Body) String() string

type NetmapServiceClient 

type NetmapServiceClient interface {
	// Get NodeInfo structure from the particular node directly. Node information
	// can be taken from `Netmap` smart contract, but in some cases the one may
	// want to get recent information directly, or to talk to the node not yet
	// present in `Network Map` to find out what API version can be used for
	// further communication. Can also be used to check if node is up and running.
	LocalNodeInfo(ctx context.Context, in *LocalNodeInfoRequest, opts ...grpc2.CallOption) (*LocalNodeInfoResponse, error)
	// Read recent information about the NeoFS network.
	NetworkInfo(ctx context.Context, in *NetworkInfoRequest, opts ...grpc2.CallOption) (*NetworkInfoResponse, error)
}

NetmapServiceClient is the client API for NetmapService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewNetmapServiceClient 

func NewNetmapServiceClient(cc grpc2.ClientConnInterface) NetmapServiceClient

type NetmapServiceServer 

type NetmapServiceServer interface {
	// Get NodeInfo structure from the particular node directly. Node information
	// can be taken from `Netmap` smart contract, but in some cases the one may
	// want to get recent information directly, or to talk to the node not yet
	// present in `Network Map` to find out what API version can be used for
	// further communication. Can also be used to check if node is up and running.
	LocalNodeInfo(context.Context, *LocalNodeInfoRequest) (*LocalNodeInfoResponse, error)
	// Read recent information about the NeoFS network.
	NetworkInfo(context.Context, *NetworkInfoRequest) (*NetworkInfoResponse, error)
}

NetmapServiceServer is the server API for NetmapService service.

type NetworkInfo added in v1.24.0 

type NetworkInfo struct {

	// Number of the current epoch in the NeoFS network.
	CurrentEpoch uint64 `protobuf:"varint,1,opt,name=current_epoch,json=currentEpoch,proto3" json:"current_epoch,omitempty"`
	// Magic number of the sidechain of the NeoFS network.
	MagicNumber uint64 `protobuf:"varint,2,opt,name=magic_number,json=magicNumber,proto3" json:"magic_number,omitempty"`
	// contains filtered or unexported fields
}

Information about NeoFS network

func (*NetworkInfo) Descriptor deprecated added in v1.24.0 

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

Deprecated: Use NetworkInfo.ProtoReflect.Descriptor instead.

func (*NetworkInfo) GetCurrentEpoch added in v1.24.0 

func (x *NetworkInfo) GetCurrentEpoch() uint64

func (*NetworkInfo) GetMagicNumber added in v1.24.0 

func (x *NetworkInfo) GetMagicNumber() uint64

func (*NetworkInfo) ProtoMessage added in v1.24.0 

func (*NetworkInfo) ProtoMessage()

func (*NetworkInfo) ProtoReflect added in v1.24.0 

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

func (*NetworkInfo) Reset added in v1.24.0 

func (x *NetworkInfo) Reset()

func (*NetworkInfo) SetCurrentEpoch added in v1.24.0 

func (x *NetworkInfo) SetCurrentEpoch(v uint64)

SetCurrentEpoch sets number of the current epoch.

func (*NetworkInfo) SetMagicNumber added in v1.24.0 

func (x *NetworkInfo) SetMagicNumber(v uint64)

SetMagicNumber sets magic number of the sidechain.

func (*NetworkInfo) String added in v1.24.0 

func (x *NetworkInfo) String() string

type NetworkInfoRequest added in v1.24.0 

type NetworkInfoRequest struct {

	// Body of the NetworkInfo request message
	Body *NetworkInfoRequest_Body `protobuf:"bytes,1,opt,name=body,proto3" 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,proto3" 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,proto3" json:"verify_header,omitempty"`
	// contains filtered or unexported fields
}

Get NetworkInfo structure with the network view from particular node.

func (*NetworkInfoRequest) Descriptor deprecated added in v1.24.0 

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

Deprecated: Use NetworkInfoRequest.ProtoReflect.Descriptor instead.

func (*NetworkInfoRequest) GetBody added in v1.24.0 

func (x *NetworkInfoRequest) GetBody() *NetworkInfoRequest_Body

func (*NetworkInfoRequest) GetMetaHeader added in v1.24.0 

func (x *NetworkInfoRequest) GetMetaHeader() *grpc.RequestMetaHeader

func (*NetworkInfoRequest) GetVerifyHeader added in v1.24.0 

func (x *NetworkInfoRequest) GetVerifyHeader() *grpc.RequestVerificationHeader

func (*NetworkInfoRequest) ProtoMessage added in v1.24.0 

func (*NetworkInfoRequest) ProtoMessage()

func (*NetworkInfoRequest) ProtoReflect added in v1.24.0 

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

func (*NetworkInfoRequest) Reset added in v1.24.0 

func (x *NetworkInfoRequest) Reset()

func (*NetworkInfoRequest) SetBody added in v1.24.0 

func (x *NetworkInfoRequest) SetBody(v *NetworkInfoRequest_Body)

SetBody sets body of the request.

func (*NetworkInfoRequest) SetMetaHeader added in v1.24.0 

func (x *NetworkInfoRequest) SetMetaHeader(v *session.RequestMetaHeader)

SetMetaHeader sets meta header of the request.

func (*NetworkInfoRequest) SetVerifyHeader added in v1.24.0 

func (x *NetworkInfoRequest) SetVerifyHeader(v *session.RequestVerificationHeader)

SetVerifyHeader sets verification header of the request.

func (*NetworkInfoRequest) String added in v1.24.0 

func (x *NetworkInfoRequest) String() string

type NetworkInfoRequest_Body added in v1.24.0 

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

NetworkInfo request body is empty.

func (*NetworkInfoRequest_Body) Descriptor deprecated added in v1.24.0 

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

Deprecated: Use NetworkInfoRequest_Body.ProtoReflect.Descriptor instead.

func (*NetworkInfoRequest_Body) ProtoMessage added in v1.24.0 

func (*NetworkInfoRequest_Body) ProtoMessage()

func (*NetworkInfoRequest_Body) ProtoReflect added in v1.24.0 

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

func (*NetworkInfoRequest_Body) Reset added in v1.24.0 

func (x *NetworkInfoRequest_Body) Reset()

func (*NetworkInfoRequest_Body) String added in v1.24.0 

func (x *NetworkInfoRequest_Body) String() string

type NetworkInfoResponse added in v1.24.0 

type NetworkInfoResponse struct {

	// Body of the NetworkInfo response message.
	Body *NetworkInfoResponse_Body `protobuf:"bytes,1,opt,name=body,proto3" 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,proto3" 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,proto3" json:"verify_header,omitempty"`
	// contains filtered or unexported fields
}

Response with NetworkInfo structure including current epoch and sidechain magic number.

func (*NetworkInfoResponse) Descriptor deprecated added in v1.24.0 

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

Deprecated: Use NetworkInfoResponse.ProtoReflect.Descriptor instead.

func (*NetworkInfoResponse) GetBody added in v1.24.0 

func (x *NetworkInfoResponse) GetBody() *NetworkInfoResponse_Body

func (*NetworkInfoResponse) GetMetaHeader added in v1.24.0 

func (x *NetworkInfoResponse) GetMetaHeader() *grpc.ResponseMetaHeader

func (*NetworkInfoResponse) GetVerifyHeader added in v1.24.0 

func (x *NetworkInfoResponse) GetVerifyHeader() *grpc.ResponseVerificationHeader

func (*NetworkInfoResponse) ProtoMessage added in v1.24.0 

func (*NetworkInfoResponse) ProtoMessage()

func (*NetworkInfoResponse) ProtoReflect added in v1.24.0 

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

func (*NetworkInfoResponse) Reset added in v1.24.0 

func (x *NetworkInfoResponse) Reset()

func (*NetworkInfoResponse) SetBody added in v1.24.0 

func (x *NetworkInfoResponse) SetBody(v *NetworkInfoResponse_Body)

SetBody sets body of the response.

func (*NetworkInfoResponse) SetMetaHeader added in v1.24.0 

func (x *NetworkInfoResponse) SetMetaHeader(v *session.ResponseMetaHeader)

SetMetaHeader sets meta header of the response.

func (*NetworkInfoResponse) SetVerifyHeader added in v1.24.0 

func (x *NetworkInfoResponse) SetVerifyHeader(v *session.ResponseVerificationHeader)

SetVerifyHeader sets verification header of the response.

func (*NetworkInfoResponse) String added in v1.24.0 

func (x *NetworkInfoResponse) String() string

type NetworkInfoResponse_Body added in v1.24.0 

type NetworkInfoResponse_Body struct {

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

Information about the network.

func (*NetworkInfoResponse_Body) Descriptor deprecated added in v1.24.0 

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

Deprecated: Use NetworkInfoResponse_Body.ProtoReflect.Descriptor instead.

func (*NetworkInfoResponse_Body) GetNetworkInfo added in v1.24.0 

func (x *NetworkInfoResponse_Body) GetNetworkInfo() *NetworkInfo

func (*NetworkInfoResponse_Body) ProtoMessage added in v1.24.0 

func (*NetworkInfoResponse_Body) ProtoMessage()

func (*NetworkInfoResponse_Body) ProtoReflect added in v1.24.0 

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

func (*NetworkInfoResponse_Body) Reset added in v1.24.0 

func (x *NetworkInfoResponse_Body) Reset()

func (*NetworkInfoResponse_Body) SetNetworkInfo added in v1.24.0 

func (x *NetworkInfoResponse_Body) SetNetworkInfo(v *NetworkInfo)

SetNetworkInfo sets information about the network.

func (*NetworkInfoResponse_Body) String added in v1.24.0 

func (x *NetworkInfoResponse_Body) String() string

type NodeInfo 

type NodeInfo struct {

	// Public key of the NeoFS node in a binary format.
	PublicKey []byte `protobuf:"bytes,1,opt,name=public_key,json=publicKey,proto3" json:"public_key,omitempty"`
	// Ways to connect to a node
	Address string `protobuf:"bytes,2,opt,name=address,proto3" json:"address,omitempty"`
	// Carries list of the NeoFS 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,proto3" json:"attributes,omitempty"`
	// Carries state of the NeoFS node.
	State NodeInfo_State `protobuf:"varint,4,opt,name=state,proto3,enum=neo.fs.v2.netmap.NodeInfo_State" json:"state,omitempty"`
	// contains filtered or unexported fields
}

NeoFS node description

func (*NodeInfo) Descriptor deprecated 

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

Deprecated: Use NodeInfo.ProtoReflect.Descriptor instead.

func (*NodeInfo) GetAddress 

func (x *NodeInfo) GetAddress() string

func (*NodeInfo) GetAttributes 

func (x *NodeInfo) GetAttributes() []*NodeInfo_Attribute

func (*NodeInfo) GetPublicKey 

func (x *NodeInfo) GetPublicKey() []byte

func (*NodeInfo) GetState 

func (x *NodeInfo) GetState() NodeInfo_State

func (*NodeInfo) ProtoMessage 

func (*NodeInfo) ProtoMessage()

func (*NodeInfo) ProtoReflect 

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

func (*NodeInfo) Reset 

func (x *NodeInfo) Reset()

func (*NodeInfo) SetAddress 

func (m *NodeInfo) SetAddress(v string)

SetAddress sets node network address.

func (*NodeInfo) SetAttributes 

func (m *NodeInfo) SetAttributes(v []*NodeInfo_Attribute)

SetAttributes sets list of the node attributes.

func (*NodeInfo) SetPublicKey 

func (m *NodeInfo) SetPublicKey(v []byte)

SetPublicKey sets node public key in a binary format.

func (*NodeInfo) SetState 

func (m *NodeInfo) SetState(v NodeInfo_State)

SetState sets node state.

func (*NodeInfo) String 

func (x *NodeInfo) String() string

type NodeInfo_Attribute 

type NodeInfo_Attribute struct {

	// Key of the node attribute.
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// Value of the node attribute.
	Value string `protobuf:"bytes,2,opt,name=value,proto3" 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,proto3" json:"parents,omitempty"`
	// contains filtered or unexported fields
}

Administrator-defined Attributes of the NeoFS Storage Node.

`Attribute` is a Key-Value metadata pair. Key name must be a valid UTF-8 string. Value can't be empty.

Node's attributes are mostly used during Storage Policy evaluation to calculate object's placement and find a set of nodes satisfying policy requirements. There are some "well-known" node attributes common to all the Storage Nodes in the network and used implicitly with default values if not explicitly set:

  • Capacity \ Total available disk space in Gigabytes.
  • Price \ Price in GAS tokens for storing one GB of data during one Epoch. In node attributes it's a string presenting floating point number with comma or point delimiter for decimal part. In the Network Map it will be saved as 64-bit unsigned integer representing number of minimal token fractions.
  • Subnet \ String ID of Node's storage subnet. There can be only one subnet served by the Storage Node.
  • UN-LOCODE \ Node's geographic location in UN/LOCODE(https://www.unece.org/cefact/codesfortrade/codes_index.html) format approximated to the nearest point defined in the standard.
  • CountryCode \ Country code in [ISO 3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. Calculated automatically from `UN-LOCODE` attribute.
  • Country \ Country short name in English, as defined in [ISO-3166](https://www.iso.org/obp/ui/#search). Calculated automatically from `UN-LOCODE` attribute.
  • Location \ Place names are given, whenever possible, in their national language versions as expressed in the Roman alphabet using the 26 characters of the character set adopted for international trade data interchange, written without diacritics . Calculated automatically from `UN-LOCODE` attribute.
  • SubDivCode \ Country's administrative subdivision where node is located. Calculated automatically from `UN-LOCODE` attribute based on `SubDiv` field. Presented in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.
  • SubDiv \ Country's administrative subdivision name, as defined in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). Calculated automatically from `UN-LOCODE` attribute.
  • Continent \ Node's continent name according to the [Seven-Continent model] (https://en.wikipedia.org/wiki/Continent#Number). Calculated automatically from `UN-LOCODE` attribute.

For detailed description of each well-known attribute please see the corresponding section in NeoFS Technical specification.

func (*NodeInfo_Attribute) Descriptor deprecated 

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

Deprecated: Use NodeInfo_Attribute.ProtoReflect.Descriptor instead.

func (*NodeInfo_Attribute) GetKey 

func (x *NodeInfo_Attribute) GetKey() string

func (*NodeInfo_Attribute) GetParents 

func (x *NodeInfo_Attribute) GetParents() []string

func (*NodeInfo_Attribute) GetValue 

func (x *NodeInfo_Attribute) GetValue() string

func (*NodeInfo_Attribute) ProtoMessage 

func (*NodeInfo_Attribute) ProtoMessage()

func (*NodeInfo_Attribute) ProtoReflect 

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

func (*NodeInfo_Attribute) Reset 

func (x *NodeInfo_Attribute) Reset()

func (*NodeInfo_Attribute) SetKey 

func (m *NodeInfo_Attribute) SetKey(v string)

SetKey sets key to the node attribute.

func (*NodeInfo_Attribute) SetParents 

func (m *NodeInfo_Attribute) SetParents(v []string)

SetParent sets value of the node parents.

func (*NodeInfo_Attribute) SetValue 

func (m *NodeInfo_Attribute) SetValue(v string)

SetValue sets value of the node attribute.

func (*NodeInfo_Attribute) String 

func (x *NodeInfo_Attribute) String() string

type NodeInfo_State 

type NodeInfo_State int32

Represents the enumeration of various states of the NeoFS node. 

const (
	// Unknown state.
	NodeInfo_UNSPECIFIED NodeInfo_State = 0
	// Active state in the network.
	NodeInfo_ONLINE NodeInfo_State = 1
	// Network unavailable state.
	NodeInfo_OFFLINE NodeInfo_State = 2
)

func (NodeInfo_State) Descriptor 

func (NodeInfo_State) Descriptor() protoreflect.EnumDescriptor

func (NodeInfo_State) Enum 

func (x NodeInfo_State) Enum() *NodeInfo_State

func (NodeInfo_State) EnumDescriptor deprecated 

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

Deprecated: Use NodeInfo_State.Descriptor instead.

func (NodeInfo_State) Number 

func (x NodeInfo_State) Number() protoreflect.EnumNumber

func (NodeInfo_State) String 

func (x NodeInfo_State) String() string

func (NodeInfo_State) Type 

func (NodeInfo_State) Type() protoreflect.EnumType

type Operation 

type Operation int32

Operations on filters 

const (
	// No Operation defined
	Operation_OPERATION_UNSPECIFIED Operation = 0
	// Equal
	Operation_EQ Operation = 1
	// Not Equal
	Operation_NE Operation = 2
	// Greater then
	Operation_GT Operation = 3
	// Greater or equal
	Operation_GE Operation = 4
	// Less then
	Operation_LT Operation = 5
	// Less or equal
	Operation_LE Operation = 6
	// Logical OR
	Operation_OR Operation = 7
	// Logical AND
	Operation_AND Operation = 8
)

func (Operation) Descriptor 

func (Operation) Descriptor() protoreflect.EnumDescriptor

func (Operation) Enum 

func (x Operation) Enum() *Operation

func (Operation) EnumDescriptor deprecated 

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

Deprecated: Use Operation.Descriptor instead.

func (Operation) Number 

func (x Operation) Number() protoreflect.EnumNumber

func (Operation) String 

func (x Operation) String() string

func (Operation) Type 

func (Operation) Type() protoreflect.EnumType

type PlacementPolicy 

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,proto3" json:"replicas,omitempty"`
	// Container backup factor controls how deep NeoFS will search for nodes
	// alternatives to include into container's nodes subset
	ContainerBackupFactor uint32 `` /* 127-byte string literal not displayed */
	// Set of Selectors to form the container's nodes subset
	Selectors []*Selector `protobuf:"bytes,3,rep,name=selectors,proto3" json:"selectors,omitempty"`
	// List of named filters to reference in selectors
	Filters []*Filter `protobuf:"bytes,4,rep,name=filters,proto3" json:"filters,omitempty"`
	// contains filtered or unexported fields
}

Set of rules to select a subset of nodes from `NetworkMap` able to store container's objects. The format is simple enough to transpile from different storage policy definition languages.

func (*PlacementPolicy) Descriptor deprecated 

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

Deprecated: Use PlacementPolicy.ProtoReflect.Descriptor instead.

func (*PlacementPolicy) GetContainerBackupFactor 

func (x *PlacementPolicy) GetContainerBackupFactor() uint32

func (*PlacementPolicy) GetFilters 

func (x *PlacementPolicy) GetFilters() []*Filter

func (*PlacementPolicy) GetReplicas 

func (x *PlacementPolicy) GetReplicas() []*Replica

func (*PlacementPolicy) GetSelectors 

func (x *PlacementPolicy) GetSelectors() []*Selector

func (*PlacementPolicy) ProtoMessage 

func (*PlacementPolicy) ProtoMessage()

func (*PlacementPolicy) ProtoReflect 

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

func (*PlacementPolicy) Reset 

func (x *PlacementPolicy) Reset()

func (*PlacementPolicy) SetContainerBackupFactor 

func (m *PlacementPolicy) SetContainerBackupFactor(v uint32)

SetContainerBackupFactor of placement policy.

func (*PlacementPolicy) SetFilters 

func (m *PlacementPolicy) SetFilters(v []*Filter)

SetFilters of placement policy.

func (*PlacementPolicy) SetReplicas 

func (m *PlacementPolicy) SetReplicas(v []*Replica)

SetReplicas of placement policy.

func (*PlacementPolicy) SetSelectors 

func (m *PlacementPolicy) SetSelectors(v []*Selector)

SetSelectors of placement policy.

func (*PlacementPolicy) String 

func (x *PlacementPolicy) String() string

type Replica 

type Replica struct {

	// How many object replicas to put
	Count uint32 `protobuf:"varint,1,opt,name=count,proto3" json:"count,omitempty"`
	// Named selector bucket to put replicas
	Selector string `protobuf:"bytes,2,opt,name=selector,proto3" json:"selector,omitempty"`
	// contains filtered or unexported fields
}

Number of object replicas in a set of nodes from the defined selector. If no selector set the root bucket containing all possible nodes will be used by default.

func (*Replica) Descriptor deprecated 

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

Deprecated: Use Replica.ProtoReflect.Descriptor instead.

func (*Replica) GetCount 

func (x *Replica) GetCount() uint32

func (*Replica) GetSelector 

func (x *Replica) GetSelector() string

func (*Replica) ProtoMessage 

func (*Replica) ProtoMessage()

func (*Replica) ProtoReflect 

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

func (*Replica) Reset 

func (x *Replica) Reset()

func (*Replica) SetCount 

func (m *Replica) SetCount(v uint32)

SetCount of object replica.

func (*Replica) SetSelector 

func (m *Replica) SetSelector(v string)

SetSelector of object replica.

func (*Replica) String 

func (x *Replica) String() string

type Selector 

type Selector struct {

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

Selector chooses a number of nodes from the bucket taking the nearest nodes to the provided `ContainerID` by hash distance.

func (*Selector) Descriptor deprecated 

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

Deprecated: Use Selector.ProtoReflect.Descriptor instead.

func (*Selector) GetAttribute 

func (x *Selector) GetAttribute() string

func (*Selector) GetClause 

func (x *Selector) GetClause() Clause

func (*Selector) GetCount 

func (x *Selector) GetCount() uint32

func (*Selector) GetFilter 

func (x *Selector) GetFilter() string

func (*Selector) GetName 

func (x *Selector) GetName() string

func (*Selector) ProtoMessage 

func (*Selector) ProtoMessage()

func (*Selector) ProtoReflect 

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

func (*Selector) Reset 

func (x *Selector) Reset()

func (*Selector) SetAttribute 

func (m *Selector) SetAttribute(v string)

SetAttribute of nodes of placement selector.

func (*Selector) SetClause 

func (m *Selector) SetClause(v Clause)

SetClause of placement selector.

func (*Selector) SetCount 

func (m *Selector) SetCount(v uint32)

SetCount of nodes of placement selector.

func (*Selector) SetFilter 

func (m *Selector) SetFilter(v string)

SetFilter of placement selector.

func (*Selector) SetName 

func (m *Selector) SetName(v string)

SetName of placement selector.

func (*Selector) String 

func (x *Selector) String() string

type UnimplementedNetmapServiceServer 

type UnimplementedNetmapServiceServer struct {
}

UnimplementedNetmapServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedNetmapServiceServer) LocalNodeInfo 

func (*UnimplementedNetmapServiceServer) LocalNodeInfo(context.Context, *LocalNodeInfoRequest) (*LocalNodeInfoResponse, error)

func (*UnimplementedNetmapServiceServer) NetworkInfo added in v1.24.0 

func (*UnimplementedNetmapServiceServer) NetworkInfo(context.Context, *NetworkInfoRequest) (*NetworkInfoResponse, error)

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.