control

package
v0.27.6 Latest Latest
Warning

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

 Go to latest Published: Mar 28, 2022 License: GPL-3.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	NetmapStatus_name = map[int32]string{
		0: "STATUS_UNDEFINED",
		1: "ONLINE",
		2: "OFFLINE",
		3: "MAINTENANCE",
	}
	NetmapStatus_value = map[string]int32{
		"STATUS_UNDEFINED": 0,
		"ONLINE":           1,
		"OFFLINE":          2,
		"MAINTENANCE":      3,
	}
)

Enum value maps for NetmapStatus.

View Source 
var (
	HealthStatus_name = map[int32]string{
		0: "HEALTH_STATUS_UNDEFINED",
		1: "STARTING",
		2: "READY",
		3: "SHUTTING_DOWN",
	}
	HealthStatus_value = map[string]int32{
		"HEALTH_STATUS_UNDEFINED": 0,
		"STARTING":                1,
		"READY":                   2,
		"SHUTTING_DOWN":           3,
	}
)

Enum value maps for HealthStatus.

View Source 
var (
	ShardMode_name = map[int32]string{
		0: "SHARD_MODE_UNDEFINED",
		1: "READ_WRITE",
		2: "READ_ONLY",
	}
	ShardMode_value = map[string]int32{
		"SHARD_MODE_UNDEFINED": 0,
		"READ_WRITE":           1,
		"READ_ONLY":            2,
	}
)

Enum value maps for ShardMode.

View Source 
var ControlService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "control.ControlService",
	HandlerType: (*ControlServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "HealthCheck",
			Handler:    _ControlService_HealthCheck_Handler,
		},
		{
			MethodName: "NetmapSnapshot",
			Handler:    _ControlService_NetmapSnapshot_Handler,
		},
		{
			MethodName: "SetNetmapStatus",
			Handler:    _ControlService_SetNetmapStatus_Handler,
		},
		{
			MethodName: "DropObjects",
			Handler:    _ControlService_DropObjects_Handler,
		},
		{
			MethodName: "ListShards",
			Handler:    _ControlService_ListShards_Handler,
		},
		{
			MethodName: "SetShardMode",
			Handler:    _ControlService_SetShardMode_Handler,
		},
		{
			MethodName: "DumpShard",
			Handler:    _ControlService_DumpShard_Handler,
		},
		{
			MethodName: "RestoreShard",
			Handler:    _ControlService_RestoreShard_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "pkg/services/control/service.proto",
}

ControlService_ServiceDesc is the grpc.ServiceDesc for ControlService 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_pkg_services_control_service_proto protoreflect.FileDescriptor
View Source 
var File_pkg_services_control_types_proto protoreflect.FileDescriptor

Functions

func RegisterControlServiceServer 

func RegisterControlServiceServer(s grpc.ServiceRegistrar, srv ControlServiceServer)

Types

type ControlServiceClient 

type ControlServiceClient interface {
	// Performs health check of the storage node.
	HealthCheck(ctx context.Context, in *HealthCheckRequest, opts ...grpc.CallOption) (*HealthCheckResponse, error)
	// Returns network map snapshot of the current NeoFS epoch.
	NetmapSnapshot(ctx context.Context, in *NetmapSnapshotRequest, opts ...grpc.CallOption) (*NetmapSnapshotResponse, error)
	// Sets status of the storage node in NeoFS network map.
	SetNetmapStatus(ctx context.Context, in *SetNetmapStatusRequest, opts ...grpc.CallOption) (*SetNetmapStatusResponse, error)
	// Mark objects to be removed from node's local object storage.
	DropObjects(ctx context.Context, in *DropObjectsRequest, opts ...grpc.CallOption) (*DropObjectsResponse, error)
	// Returns list that contains information about all shards of a node.
	ListShards(ctx context.Context, in *ListShardsRequest, opts ...grpc.CallOption) (*ListShardsResponse, error)
	// Sets mode of the shard.
	SetShardMode(ctx context.Context, in *SetShardModeRequest, opts ...grpc.CallOption) (*SetShardModeResponse, error)
	// Dump objects from the shard.
	DumpShard(ctx context.Context, in *DumpShardRequest, opts ...grpc.CallOption) (*DumpShardResponse, error)
	// Restore objects from dump.
	RestoreShard(ctx context.Context, in *RestoreShardRequest, opts ...grpc.CallOption) (*RestoreShardResponse, error)
}

ControlServiceClient is the client API for ControlService 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.

func NewControlServiceClient 

func NewControlServiceClient(cc grpc.ClientConnInterface) ControlServiceClient

type ControlServiceServer 

type ControlServiceServer interface {
	// Performs health check of the storage node.
	HealthCheck(context.Context, *HealthCheckRequest) (*HealthCheckResponse, error)
	// Returns network map snapshot of the current NeoFS epoch.
	NetmapSnapshot(context.Context, *NetmapSnapshotRequest) (*NetmapSnapshotResponse, error)
	// Sets status of the storage node in NeoFS network map.
	SetNetmapStatus(context.Context, *SetNetmapStatusRequest) (*SetNetmapStatusResponse, error)
	// Mark objects to be removed from node's local object storage.
	DropObjects(context.Context, *DropObjectsRequest) (*DropObjectsResponse, error)
	// Returns list that contains information about all shards of a node.
	ListShards(context.Context, *ListShardsRequest) (*ListShardsResponse, error)
	// Sets mode of the shard.
	SetShardMode(context.Context, *SetShardModeRequest) (*SetShardModeResponse, error)
	// Dump objects from the shard.
	DumpShard(context.Context, *DumpShardRequest) (*DumpShardResponse, error)
	// Restore objects from dump.
	RestoreShard(context.Context, *RestoreShardRequest) (*RestoreShardResponse, error)
}

ControlServiceServer is the server API for ControlService service. All implementations should embed UnimplementedControlServiceServer for forward compatibility

type DropObjectsRequest added in v0.16.0 

type DropObjectsRequest struct {

	// Body of the request message.
	Body *DropObjectsRequest_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Body signature.
	Signature *Signature `protobuf:"bytes,2,opt,name=signature,proto3" json:"signature,omitempty"`
	// contains filtered or unexported fields
}

Request to drop the objects.

func (*DropObjectsRequest) Descriptor deprecated added in v0.16.0 

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

Deprecated: Use DropObjectsRequest.ProtoReflect.Descriptor instead.

func (*DropObjectsRequest) GetBody added in v0.16.0 

func (x *DropObjectsRequest) GetBody() *DropObjectsRequest_Body

func (*DropObjectsRequest) GetSignature added in v0.16.0 

func (x *DropObjectsRequest) GetSignature() *Signature

func (*DropObjectsRequest) ProtoMessage added in v0.16.0 

func (*DropObjectsRequest) ProtoMessage()

func (*DropObjectsRequest) ProtoReflect added in v0.16.0 

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

func (*DropObjectsRequest) ReadSignedData added in v0.16.0 

func (x *DropObjectsRequest) ReadSignedData(buf []byte) ([]byte, error)

ReadSignedData reads signed data of "Drop objects" request to buf.

If buffer length is less than x.SignedDataSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same signed data.

func (*DropObjectsRequest) Reset added in v0.16.0 

func (x *DropObjectsRequest) Reset()

func (*DropObjectsRequest) SetBody added in v0.16.0 

func (x *DropObjectsRequest) SetBody(v *DropObjectsRequest_Body)

SetBody sets body of the set "Drop objects" request.

func (*DropObjectsRequest) SetSignature added in v0.16.0 

func (x *DropObjectsRequest) SetSignature(body *Signature)

SetSignature sets signature of the "Drop objects" request body.

func (*DropObjectsRequest) SignedDataSize added in v0.16.0 

func (x *DropObjectsRequest) SignedDataSize() int

SignedDataSize returns binary size of the signed data of "Drop objects" request.

Structures with the same field values have the same signed data size.

func (*DropObjectsRequest) String added in v0.16.0 

func (x *DropObjectsRequest) String() string

type DropObjectsRequest_Body added in v0.16.0 

type DropObjectsRequest_Body struct {

	// List of object addresses to be removed.
	// in NeoFS API binary format.
	AddressList [][]byte `protobuf:"bytes,1,rep,name=address_list,json=addressList,proto3" json:"address_list,omitempty"`
	// contains filtered or unexported fields
}

Request body structure.

func (*DropObjectsRequest_Body) Descriptor deprecated added in v0.16.0 

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

Deprecated: Use DropObjectsRequest_Body.ProtoReflect.Descriptor instead.

func (*DropObjectsRequest_Body) GetAddressList added in v0.16.0 

func (x *DropObjectsRequest_Body) GetAddressList() [][]byte

func (*DropObjectsRequest_Body) ProtoMessage added in v0.16.0 

func (*DropObjectsRequest_Body) ProtoMessage()

func (*DropObjectsRequest_Body) ProtoReflect added in v0.16.0 

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

func (*DropObjectsRequest_Body) Reset added in v0.16.0 

func (x *DropObjectsRequest_Body) Reset()

func (*DropObjectsRequest_Body) SetAddressList added in v0.16.0 

func (x *DropObjectsRequest_Body) SetAddressList(v [][]byte)

SetAddressList sets list of objects to be removed in NeoFS API binary format.

func (*DropObjectsRequest_Body) StableMarshal added in v0.16.0 

func (x *DropObjectsRequest_Body) StableMarshal(buf []byte) ([]byte, error)

StableMarshal reads binary representation of "Drop objects" request body in protobuf binary format.

If buffer length is less than x.StableSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same binary format.

func (*DropObjectsRequest_Body) StableSize added in v0.16.0 

func (x *DropObjectsRequest_Body) StableSize() int

StableSize returns binary size of "Drop objects" response body in protobuf binary format.

Structures with the same field values have the same binary size.

func (*DropObjectsRequest_Body) String added in v0.16.0 

func (x *DropObjectsRequest_Body) String() string

type DropObjectsResponse added in v0.16.0 

type DropObjectsResponse struct {

	// Body of the response message.
	Body *DropObjectsResponse_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Body signature.
	Signature *Signature `protobuf:"bytes,2,opt,name=signature,proto3" json:"signature,omitempty"`
	// contains filtered or unexported fields
}

Response to request to drop the objects.

func DropObjects added in v0.17.0 

func DropObjects(
	cli *client.Client,
	req *DropObjectsRequest,
	opts ...client.CallOption,
) (*DropObjectsResponse, error)

DropObjects executes ControlService.DropObjects RPC.

func (*DropObjectsResponse) Descriptor deprecated added in v0.16.0 

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

Deprecated: Use DropObjectsResponse.ProtoReflect.Descriptor instead.

func (*DropObjectsResponse) GetBody added in v0.16.0 

func (x *DropObjectsResponse) GetBody() *DropObjectsResponse_Body

func (*DropObjectsResponse) GetSignature added in v0.16.0 

func (x *DropObjectsResponse) GetSignature() *Signature

func (*DropObjectsResponse) ProtoMessage added in v0.16.0 

func (*DropObjectsResponse) ProtoMessage()

func (*DropObjectsResponse) ProtoReflect added in v0.16.0 

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

func (*DropObjectsResponse) ReadSignedData added in v0.16.0 

func (x *DropObjectsResponse) ReadSignedData(buf []byte) ([]byte, error)

ReadSignedData reads signed data of "Drop objects" response to buf.

If buffer length is less than x.SignedDataSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same signed data.

func (*DropObjectsResponse) Reset added in v0.16.0 

func (x *DropObjectsResponse) Reset()

func (*DropObjectsResponse) SetBody added in v0.16.0 

func (x *DropObjectsResponse) SetBody(v *DropObjectsResponse_Body)

SetBody sets set body of the "Drop objects" response.

func (*DropObjectsResponse) SetSignature added in v0.16.0 

func (x *DropObjectsResponse) SetSignature(v *Signature)

SetSignature sets signature of the "Drop objects" response body.

func (*DropObjectsResponse) SignedDataSize added in v0.16.0 

func (x *DropObjectsResponse) SignedDataSize() int

SignedDataSize returns binary size of the signed data of "Drop objects" response.

Structures with the same field values have the same signed data size.

func (*DropObjectsResponse) String added in v0.16.0 

func (x *DropObjectsResponse) String() string

type DropObjectsResponse_Body added in v0.16.0 

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

Response body structure.

func (*DropObjectsResponse_Body) Descriptor deprecated added in v0.16.0 

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

Deprecated: Use DropObjectsResponse_Body.ProtoReflect.Descriptor instead.

func (*DropObjectsResponse_Body) ProtoMessage added in v0.16.0 

func (*DropObjectsResponse_Body) ProtoMessage()

func (*DropObjectsResponse_Body) ProtoReflect added in v0.16.0 

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

func (*DropObjectsResponse_Body) Reset added in v0.16.0 

func (x *DropObjectsResponse_Body) Reset()

func (*DropObjectsResponse_Body) StableMarshal added in v0.16.0 

func (x *DropObjectsResponse_Body) StableMarshal(buf []byte) ([]byte, error)

StableMarshal reads binary representation of "Drop objects" response body in protobuf binary format.

If buffer length is less than x.StableSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same binary format.

func (*DropObjectsResponse_Body) StableSize added in v0.16.0 

func (x *DropObjectsResponse_Body) StableSize() int

StableSize returns binary size of "Drop objects" response body in protobuf binary format.

Structures with the same field values have the same binary size.

func (*DropObjectsResponse_Body) String added in v0.16.0 

func (x *DropObjectsResponse_Body) String() string

type DumpShardRequest added in v0.27.5 

type DumpShardRequest struct {

	// Body of dump shard request message.
	Body *DumpShardRequest_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Body signature.
	Signature *Signature `protobuf:"bytes,2,opt,name=signature,proto3" json:"signature,omitempty"`
	// contains filtered or unexported fields
}

DumpShard request.

func (*DumpShardRequest) Descriptor deprecated added in v0.27.5 

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

Deprecated: Use DumpShardRequest.ProtoReflect.Descriptor instead.

func (*DumpShardRequest) GetBody added in v0.27.5 

func (x *DumpShardRequest) GetBody() *DumpShardRequest_Body

func (*DumpShardRequest) GetSignature added in v0.27.5 

func (x *DumpShardRequest) GetSignature() *Signature

func (*DumpShardRequest) ProtoMessage added in v0.27.5 

func (*DumpShardRequest) ProtoMessage()

func (*DumpShardRequest) ProtoReflect added in v0.27.5 

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

func (*DumpShardRequest) ReadSignedData added in v0.27.5 

func (x *DumpShardRequest) ReadSignedData(buf []byte) ([]byte, error)

ReadSignedData reads signed data from request to buf.

If buffer length is less than x.SignedDataSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same signed data.

func (*DumpShardRequest) Reset added in v0.27.5 

func (x *DumpShardRequest) Reset()

func (*DumpShardRequest) SetBody added in v0.27.5 

func (x *DumpShardRequest) SetBody(v *DumpShardRequest_Body)

SetBody sets request body.

func (*DumpShardRequest) SetSignature added in v0.27.5 

func (x *DumpShardRequest) SetSignature(v *Signature)

SetSignature sets body signature of the request.

func (*DumpShardRequest) SignedDataSize added in v0.27.5 

func (x *DumpShardRequest) SignedDataSize() int

SignedDataSize returns size of the request signed data in bytes.

Structures with the same field values have the same signed data size.

func (*DumpShardRequest) String added in v0.27.5 

func (x *DumpShardRequest) String() string

type DumpShardRequest_Body added in v0.27.5 

type DumpShardRequest_Body struct {

	// ID of the shard.
	Shard_ID []byte `protobuf:"bytes,1,opt,name=shard_ID,json=shardID,proto3" json:"shard_ID,omitempty"`
	// Path to the output.
	Filepath string `protobuf:"bytes,2,opt,name=filepath,proto3" json:"filepath,omitempty"`
	// Flag indicating whether object read errors should be ignored.
	IgnoreErrors bool `protobuf:"varint,3,opt,name=ignore_errors,json=ignoreErrors,proto3" json:"ignore_errors,omitempty"`
	// contains filtered or unexported fields
}

Request body structure.

func (*DumpShardRequest_Body) Descriptor deprecated added in v0.27.5 

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

Deprecated: Use DumpShardRequest_Body.ProtoReflect.Descriptor instead.

func (*DumpShardRequest_Body) GetFilepath added in v0.27.5 

func (x *DumpShardRequest_Body) GetFilepath() string

func (*DumpShardRequest_Body) GetIgnoreErrors added in v0.27.5 

func (x *DumpShardRequest_Body) GetIgnoreErrors() bool

func (*DumpShardRequest_Body) GetShard_ID added in v0.27.5 

func (x *DumpShardRequest_Body) GetShard_ID() []byte

func (*DumpShardRequest_Body) ProtoMessage added in v0.27.5 

func (*DumpShardRequest_Body) ProtoMessage()

func (*DumpShardRequest_Body) ProtoReflect added in v0.27.5 

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

func (*DumpShardRequest_Body) Reset added in v0.27.5 

func (x *DumpShardRequest_Body) Reset()

func (*DumpShardRequest_Body) SetFilepath added in v0.27.5 

func (x *DumpShardRequest_Body) SetFilepath(p string)

SetFilepath sets filepath for the dump shard request.

func (*DumpShardRequest_Body) SetIgnoreErrors added in v0.27.5 

func (x *DumpShardRequest_Body) SetIgnoreErrors(ignore bool)

SetIgnoreErrors sets ignore errors flag for the dump shard request.

func (*DumpShardRequest_Body) SetShardID added in v0.27.5 

func (x *DumpShardRequest_Body) SetShardID(id []byte)

SetShardID sets shard ID for the dump shard request.

func (*DumpShardRequest_Body) StableMarshal added in v0.27.5 

func (x *DumpShardRequest_Body) StableMarshal(buf []byte) ([]byte, error)

StableMarshal reads binary representation of request body binary format.

If buffer length is less than StableSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same binary format.

func (*DumpShardRequest_Body) StableSize added in v0.27.5 

func (x *DumpShardRequest_Body) StableSize() int

StableSize returns binary size of the request body in protobuf binary format.

Structures with the same field values have the same binary size.

func (*DumpShardRequest_Body) String added in v0.27.5 

func (x *DumpShardRequest_Body) String() string

type DumpShardResponse added in v0.27.5 

type DumpShardResponse struct {

	// Body of dump shard response message.
	Body *DumpShardResponse_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Body signature.
	Signature *Signature `protobuf:"bytes,2,opt,name=signature,proto3" json:"signature,omitempty"`
	// contains filtered or unexported fields
}

DumpShard response.

func DumpShard added in v0.27.5 

func DumpShard(cli *client.Client, req *DumpShardRequest, opts ...client.CallOption) (*DumpShardResponse, error)

DumpShard executes ControlService.DumpShard RPC.

func (*DumpShardResponse) Descriptor deprecated added in v0.27.5 

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

Deprecated: Use DumpShardResponse.ProtoReflect.Descriptor instead.

func (*DumpShardResponse) GetBody added in v0.27.5 

func (x *DumpShardResponse) GetBody() *DumpShardResponse_Body

func (*DumpShardResponse) GetSignature added in v0.27.5 

func (x *DumpShardResponse) GetSignature() *Signature

func (*DumpShardResponse) ProtoMessage added in v0.27.5 

func (*DumpShardResponse) ProtoMessage()

func (*DumpShardResponse) ProtoReflect added in v0.27.5 

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

func (*DumpShardResponse) ReadSignedData added in v0.27.5 

func (x *DumpShardResponse) ReadSignedData(buf []byte) ([]byte, error)

ReadSignedData reads signed data from response to buf.

If buffer length is less than SignedDataSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same signed data.

func (*DumpShardResponse) Reset added in v0.27.5 

func (x *DumpShardResponse) Reset()

func (*DumpShardResponse) SetBody added in v0.27.5 

func (x *DumpShardResponse) SetBody(v *DumpShardResponse_Body)

SetBody sets response body.

func (*DumpShardResponse) SetSignature added in v0.27.5 

func (x *DumpShardResponse) SetSignature(v *Signature)

SetSignature sets response body signature.

func (*DumpShardResponse) SignedDataSize added in v0.27.5 

func (x *DumpShardResponse) SignedDataSize() int

SignedDataSize returns binary size of the signed data.

Structures with the same field values have the same signed data size.

func (*DumpShardResponse) String added in v0.27.5 

func (x *DumpShardResponse) String() string

type DumpShardResponse_Body added in v0.27.5 

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

Response body structure.

func (*DumpShardResponse_Body) Descriptor deprecated added in v0.27.5 

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

Deprecated: Use DumpShardResponse_Body.ProtoReflect.Descriptor instead.

func (*DumpShardResponse_Body) ProtoMessage added in v0.27.5 

func (*DumpShardResponse_Body) ProtoMessage()

func (*DumpShardResponse_Body) ProtoReflect added in v0.27.5 

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

func (*DumpShardResponse_Body) Reset added in v0.27.5 

func (x *DumpShardResponse_Body) Reset()

func (*DumpShardResponse_Body) StableMarshal added in v0.27.5 

func (x *DumpShardResponse_Body) StableMarshal(buf []byte) ([]byte, error)

StableMarshal reads binary representation of the response body in protobuf binary format.

If buffer length is less than x.StableSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same binary format.

func (*DumpShardResponse_Body) StableSize added in v0.27.5 

func (x *DumpShardResponse_Body) StableSize() int

StableSize returns binary size of the response body in protobuf binary format.

Structures with the same field values have the same binary size.

func (*DumpShardResponse_Body) String added in v0.27.5 

func (x *DumpShardResponse_Body) String() string

type HealthCheckRequest 

type HealthCheckRequest struct {

	// Body of health check request message.
	Body *HealthCheckRequest_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Body signature.
	Signature *Signature `protobuf:"bytes,2,opt,name=signature,proto3" json:"signature,omitempty"`
	// contains filtered or unexported fields
}

Health check request.

func (*HealthCheckRequest) Descriptor deprecated 

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

Deprecated: Use HealthCheckRequest.ProtoReflect.Descriptor instead.

func (*HealthCheckRequest) GetBody 

func (x *HealthCheckRequest) GetBody() *HealthCheckRequest_Body

func (*HealthCheckRequest) GetSignature 

func (x *HealthCheckRequest) GetSignature() *Signature

func (*HealthCheckRequest) ProtoMessage 

func (*HealthCheckRequest) ProtoMessage()

func (*HealthCheckRequest) ProtoReflect 

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

func (*HealthCheckRequest) ReadSignedData 

func (x *HealthCheckRequest) ReadSignedData(buf []byte) ([]byte, error)

ReadSignedData reads signed data of health check request to buf.

If buffer length is less than x.SignedDataSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same signed data.

func (*HealthCheckRequest) Reset 

func (x *HealthCheckRequest) Reset()

func (*HealthCheckRequest) SetBody 

func (x *HealthCheckRequest) SetBody(v *HealthCheckRequest_Body)

SetBody sets health check request body.

func (*HealthCheckRequest) SetSignature 

func (x *HealthCheckRequest) SetSignature(body *Signature)

SetSignature sets signature of the health check request body.

func (*HealthCheckRequest) SignedDataSize 

func (x *HealthCheckRequest) SignedDataSize() int

SignedDataSize returns binary size of the signed data of health check request.

Structures with the same field values have the same signed data size.

func (*HealthCheckRequest) String 

func (x *HealthCheckRequest) String() string

type HealthCheckRequest_Body 

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

Health check request body.

func (*HealthCheckRequest_Body) Descriptor deprecated 

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

Deprecated: Use HealthCheckRequest_Body.ProtoReflect.Descriptor instead.

func (*HealthCheckRequest_Body) ProtoMessage 

func (*HealthCheckRequest_Body) ProtoMessage()

func (*HealthCheckRequest_Body) ProtoReflect 

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

func (*HealthCheckRequest_Body) Reset 

func (x *HealthCheckRequest_Body) Reset()

func (*HealthCheckRequest_Body) StableMarshal 

func (x *HealthCheckRequest_Body) StableMarshal(buf []byte) ([]byte, error)

StableMarshal reads binary representation of health check request body in protobuf binary format.

If buffer length is less than x.StableSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same binary format.

func (*HealthCheckRequest_Body) StableSize 

func (x *HealthCheckRequest_Body) StableSize() int

StableSize returns binary size of health check request body in protobuf binary format.

Structures with the same field values have the same binary size.

func (*HealthCheckRequest_Body) String 

func (x *HealthCheckRequest_Body) String() string

type HealthCheckResponse 

type HealthCheckResponse struct {

	// Body of health check response message.
	Body *HealthCheckResponse_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Body signature.
	Signature *Signature `protobuf:"bytes,2,opt,name=signature,proto3" json:"signature,omitempty"`
	// contains filtered or unexported fields
}

Health check request.

func HealthCheck added in v0.17.0 

func HealthCheck(
	cli *client.Client,
	req *HealthCheckRequest,
	opts ...client.CallOption,
) (*HealthCheckResponse, error)

HealthCheck executes ControlService.HealthCheck RPC.

func (*HealthCheckResponse) Descriptor deprecated 

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

Deprecated: Use HealthCheckResponse.ProtoReflect.Descriptor instead.

func (*HealthCheckResponse) GetBody 

func (x *HealthCheckResponse) GetBody() *HealthCheckResponse_Body

func (*HealthCheckResponse) GetSignature 

func (x *HealthCheckResponse) GetSignature() *Signature

func (*HealthCheckResponse) ProtoMessage 

func (*HealthCheckResponse) ProtoMessage()

func (*HealthCheckResponse) ProtoReflect 

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

func (*HealthCheckResponse) ReadSignedData 

func (x *HealthCheckResponse) ReadSignedData(buf []byte) ([]byte, error)

ReadSignedData reads signed data of health check response to buf.

If buffer length is less than x.SignedDataSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same signed data.

func (*HealthCheckResponse) Reset 

func (x *HealthCheckResponse) Reset()

func (*HealthCheckResponse) SetBody 

func (x *HealthCheckResponse) SetBody(v *HealthCheckResponse_Body)

SetBody sets health check response body.

func (*HealthCheckResponse) SetSignature 

func (x *HealthCheckResponse) SetSignature(v *Signature)

SetSignature sets signature of the health check response body.

func (*HealthCheckResponse) SignedDataSize 

func (x *HealthCheckResponse) SignedDataSize() int

SignedDataSize returns binary size of the signed data of health check response.

Structures with the same field values have the same signed data size.

func (*HealthCheckResponse) String 

func (x *HealthCheckResponse) String() string

type HealthCheckResponse_Body 

type HealthCheckResponse_Body struct {

	// Status of the storage node in NeoFS network map.
	NetmapStatus NetmapStatus `protobuf:"varint,1,opt,name=netmap_status,json=netmapStatus,proto3,enum=control.NetmapStatus" json:"netmap_status,omitempty"`
	// Health status of storage node application.
	HealthStatus HealthStatus `protobuf:"varint,2,opt,name=health_status,json=healthStatus,proto3,enum=control.HealthStatus" json:"health_status,omitempty"`
	// contains filtered or unexported fields
}

Health check response body

func (*HealthCheckResponse_Body) Descriptor deprecated 

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

Deprecated: Use HealthCheckResponse_Body.ProtoReflect.Descriptor instead.

func (*HealthCheckResponse_Body) GetHealthStatus 

func (x *HealthCheckResponse_Body) GetHealthStatus() HealthStatus

func (*HealthCheckResponse_Body) GetNetmapStatus 

func (x *HealthCheckResponse_Body) GetNetmapStatus() NetmapStatus

func (*HealthCheckResponse_Body) ProtoMessage 

func (*HealthCheckResponse_Body) ProtoMessage()

func (*HealthCheckResponse_Body) ProtoReflect 

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

func (*HealthCheckResponse_Body) Reset 

func (x *HealthCheckResponse_Body) Reset()

func (*HealthCheckResponse_Body) SetHealthStatus 

func (x *HealthCheckResponse_Body) SetHealthStatus(v HealthStatus)

SetHealthStatus sets health status of the storage node application.

func (*HealthCheckResponse_Body) SetNetmapStatus 

func (x *HealthCheckResponse_Body) SetNetmapStatus(v NetmapStatus)

SetNetmapStatus sets status of the storage node in NeoFS network map.

func (*HealthCheckResponse_Body) StableMarshal 

func (x *HealthCheckResponse_Body) StableMarshal(buf []byte) ([]byte, error)

StableMarshal reads binary representation of health check response body in protobuf binary format.

If buffer length is less than x.StableSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same binary format.

func (*HealthCheckResponse_Body) StableSize 

func (x *HealthCheckResponse_Body) StableSize() int

StableSize returns binary size of health check response body in protobuf binary format.

Structures with the same field values have the same binary size.

func (*HealthCheckResponse_Body) String 

func (x *HealthCheckResponse_Body) String() string

type HealthStatus 

type HealthStatus int32

Health status of the storage node application. 

const (
	// Undefined status, default value.
	HealthStatus_HEALTH_STATUS_UNDEFINED HealthStatus = 0
	// Storage node application is starting.
	HealthStatus_STARTING HealthStatus = 1
	// Storage node application is started and serves all services.
	HealthStatus_READY HealthStatus = 2
	// Storage node application is shutting down.
	HealthStatus_SHUTTING_DOWN HealthStatus = 3
)

func (HealthStatus) Descriptor 

func (HealthStatus) Descriptor() protoreflect.EnumDescriptor

func (HealthStatus) Enum 

func (x HealthStatus) Enum() *HealthStatus

func (HealthStatus) EnumDescriptor deprecated 

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

Deprecated: Use HealthStatus.Descriptor instead.

func (HealthStatus) Number 

func (x HealthStatus) Number() protoreflect.EnumNumber

func (HealthStatus) String 

func (x HealthStatus) String() string

func (HealthStatus) Type 

func (HealthStatus) Type() protoreflect.EnumType

type ListShardsRequest added in v0.27.2 

type ListShardsRequest struct {

	// Body of the request message.
	Body *ListShardsRequest_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Body signature.
	Signature *Signature `protobuf:"bytes,2,opt,name=signature,proto3" json:"signature,omitempty"`
	// contains filtered or unexported fields
}

Request to list all shards of the node.

func (*ListShardsRequest) Descriptor deprecated added in v0.27.2 

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

Deprecated: Use ListShardsRequest.ProtoReflect.Descriptor instead.

func (*ListShardsRequest) GetBody added in v0.27.2 

func (x *ListShardsRequest) GetBody() *ListShardsRequest_Body

func (*ListShardsRequest) GetSignature added in v0.27.2 

func (x *ListShardsRequest) GetSignature() *Signature

func (*ListShardsRequest) ProtoMessage added in v0.27.2 

func (*ListShardsRequest) ProtoMessage()

func (*ListShardsRequest) ProtoReflect added in v0.27.2 

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

func (*ListShardsRequest) ReadSignedData added in v0.27.2 

func (x *ListShardsRequest) ReadSignedData(buf []byte) ([]byte, error)

ReadSignedData reads signed data of list shards request to buf.

If buffer length is less than x.SignedDataSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same signed data.

func (*ListShardsRequest) Reset added in v0.27.2 

func (x *ListShardsRequest) Reset()

func (*ListShardsRequest) SetBody added in v0.27.2 

func (x *ListShardsRequest) SetBody(v *ListShardsRequest_Body)

SetBody sets list shards request body.

func (*ListShardsRequest) SetSignature added in v0.27.2 

func (x *ListShardsRequest) SetSignature(body *Signature)

SetSignature sets signature of the list shards request body.

func (*ListShardsRequest) SignedDataSize added in v0.27.2 

func (x *ListShardsRequest) SignedDataSize() int

SignedDataSize returns binary size of the signed data of list shards request.

Structures with the same field values have the same signed data size.

func (*ListShardsRequest) String added in v0.27.2 

func (x *ListShardsRequest) String() string

type ListShardsRequest_Body added in v0.27.2 

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

Request body structure.

func (*ListShardsRequest_Body) Descriptor deprecated added in v0.27.2 

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

Deprecated: Use ListShardsRequest_Body.ProtoReflect.Descriptor instead.

func (*ListShardsRequest_Body) ProtoMessage added in v0.27.2 

func (*ListShardsRequest_Body) ProtoMessage()

func (*ListShardsRequest_Body) ProtoReflect added in v0.27.2 

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

func (*ListShardsRequest_Body) Reset added in v0.27.2 

func (x *ListShardsRequest_Body) Reset()

func (*ListShardsRequest_Body) StableMarshal added in v0.27.2 

func (x *ListShardsRequest_Body) StableMarshal(buf []byte) ([]byte, error)

StableMarshal reads binary representation of list shards request body in protobuf binary format.

If buffer length is less than x.StableSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same binary format.

func (*ListShardsRequest_Body) StableSize added in v0.27.2 

func (x *ListShardsRequest_Body) StableSize() int

StableSize returns binary size of list shards request body in protobuf binary format.

Structures with the same field values have the same binary size.

func (*ListShardsRequest_Body) String added in v0.27.2 

func (x *ListShardsRequest_Body) String() string

type ListShardsResponse added in v0.27.2 

type ListShardsResponse struct {

	// Body of the response message.
	Body *ListShardsResponse_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Body signature.
	Signature *Signature `protobuf:"bytes,2,opt,name=signature,proto3" json:"signature,omitempty"`
	// contains filtered or unexported fields
}

ListShards response.

func ListShards added in v0.27.2 

func ListShards(
	cli *client.Client,
	req *ListShardsRequest,
	opts ...client.CallOption,
) (*ListShardsResponse, error)

ListShards executes ControlService.ListShards RPC.

func (*ListShardsResponse) Descriptor deprecated added in v0.27.2 

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

Deprecated: Use ListShardsResponse.ProtoReflect.Descriptor instead.

func (*ListShardsResponse) GetBody added in v0.27.2 

func (x *ListShardsResponse) GetBody() *ListShardsResponse_Body

func (*ListShardsResponse) GetSignature added in v0.27.2 

func (x *ListShardsResponse) GetSignature() *Signature

func (*ListShardsResponse) ProtoMessage added in v0.27.2 

func (*ListShardsResponse) ProtoMessage()

func (*ListShardsResponse) ProtoReflect added in v0.27.2 

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

func (*ListShardsResponse) ReadSignedData added in v0.27.2 

func (x *ListShardsResponse) ReadSignedData(buf []byte) ([]byte, error)

ReadSignedData reads signed data of list shards response to buf.

If buffer length is less than x.SignedDataSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same signed data.

func (*ListShardsResponse) Reset added in v0.27.2 

func (x *ListShardsResponse) Reset()

func (*ListShardsResponse) SetBody added in v0.27.2 

func (x *ListShardsResponse) SetBody(v *ListShardsResponse_Body)

SetBody sets list shards response body.

func (*ListShardsResponse) SetSignature added in v0.27.2 

func (x *ListShardsResponse) SetSignature(v *Signature)

SetSignature sets signature of the list shards response body.

func (*ListShardsResponse) SignedDataSize added in v0.27.2 

func (x *ListShardsResponse) SignedDataSize() int

SignedDataSize returns binary size of the signed data of list shards response.

Structures with the same field values have the same signed data size.

func (*ListShardsResponse) String added in v0.27.2 

func (x *ListShardsResponse) String() string

type ListShardsResponse_Body added in v0.27.2 

type ListShardsResponse_Body struct {

	// List of the node's shards.
	Shards []*ShardInfo `protobuf:"bytes,1,rep,name=shards,proto3" json:"shards,omitempty"`
	// contains filtered or unexported fields
}

Response body structure.

func (*ListShardsResponse_Body) Descriptor deprecated added in v0.27.2 

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

Deprecated: Use ListShardsResponse_Body.ProtoReflect.Descriptor instead.

func (*ListShardsResponse_Body) GetShards added in v0.27.2 

func (x *ListShardsResponse_Body) GetShards() []*ShardInfo

func (*ListShardsResponse_Body) ProtoMessage added in v0.27.2 

func (*ListShardsResponse_Body) ProtoMessage()

func (*ListShardsResponse_Body) ProtoReflect added in v0.27.2 

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

func (*ListShardsResponse_Body) Reset added in v0.27.2 

func (x *ListShardsResponse_Body) Reset()

func (*ListShardsResponse_Body) SetShards added in v0.27.2 

func (x *ListShardsResponse_Body) SetShards(v []*ShardInfo)

SetShards sets shards of the storage node.

func (*ListShardsResponse_Body) StableMarshal added in v0.27.2 

func (x *ListShardsResponse_Body) StableMarshal(buf []byte) ([]byte, error)

StableMarshal reads binary representation of list shards response body in protobuf binary format.

If buffer length is less than x.StableSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same binary format.

func (*ListShardsResponse_Body) StableSize added in v0.27.2 

func (x *ListShardsResponse_Body) StableSize() int

StableSize returns binary size of list shards response body in protobuf binary format.

Structures with the same field values have the same binary size.

func (*ListShardsResponse_Body) String added in v0.27.2 

func (x *ListShardsResponse_Body) String() string

type Netmap 

type Netmap struct {

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

Network map structure.

func (*Netmap) Descriptor deprecated 

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

Deprecated: Use Netmap.ProtoReflect.Descriptor instead.

func (*Netmap) GetEpoch 

func (x *Netmap) GetEpoch() uint64

func (*Netmap) GetNodes 

func (x *Netmap) GetNodes() []*NodeInfo

func (*Netmap) MarshalJSON 

func (x *Netmap) MarshalJSON() ([]byte, error)

func (*Netmap) ProtoMessage 

func (*Netmap) ProtoMessage()

func (*Netmap) ProtoReflect 

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

func (*Netmap) Reset 

func (x *Netmap) Reset()

func (*Netmap) SetEpoch 

func (x *Netmap) SetEpoch(v uint64)

SetEpoch sets revision number of the network map.

func (*Netmap) SetNodes 

func (x *Netmap) SetNodes(v []*NodeInfo)

SetNodes sets nodes presented in network.

func (*Netmap) StableMarshal 

func (x *Netmap) StableMarshal(buf []byte) ([]byte, error)

StableMarshal reads binary representation of netmap in protobuf binary format.

If buffer length is less than x.StableSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same binary format.

func (*Netmap) StableSize 

func (x *Netmap) StableSize() int

StableSize returns binary size of netmap in protobuf binary format.

Structures with the same field values have the same binary size.

func (*Netmap) String 

func (x *Netmap) String() string

type NetmapSnapshotRequest 

type NetmapSnapshotRequest struct {

	// Body of get netmap snapshot request message.
	Body *NetmapSnapshotRequest_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Body signature.
	Signature *Signature `protobuf:"bytes,2,opt,name=signature,proto3" json:"signature,omitempty"`
	// contains filtered or unexported fields
}

Get netmap snapshot request.

func (*NetmapSnapshotRequest) Descriptor deprecated 

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

Deprecated: Use NetmapSnapshotRequest.ProtoReflect.Descriptor instead.

func (*NetmapSnapshotRequest) GetBody 

func (x *NetmapSnapshotRequest) GetBody() *NetmapSnapshotRequest_Body

func (*NetmapSnapshotRequest) GetSignature 

func (x *NetmapSnapshotRequest) GetSignature() *Signature

func (*NetmapSnapshotRequest) ProtoMessage 

func (*NetmapSnapshotRequest) ProtoMessage()

func (*NetmapSnapshotRequest) ProtoReflect 

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

func (*NetmapSnapshotRequest) ReadSignedData 

func (x *NetmapSnapshotRequest) ReadSignedData(buf []byte) ([]byte, error)

ReadSignedData reads signed data of netmap snapshot request to buf.

If buffer length is less than x.SignedDataSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same signed data.

func (*NetmapSnapshotRequest) Reset 

func (x *NetmapSnapshotRequest) Reset()

func (*NetmapSnapshotRequest) SetBody 

func (x *NetmapSnapshotRequest) SetBody(v *NetmapSnapshotRequest_Body)

SetBody sets get netmap snapshot request body.

func (*NetmapSnapshotRequest) SetSignature 

func (x *NetmapSnapshotRequest) SetSignature(body *Signature)

SetSignature sets signature of the netmap snapshot request body.

func (*NetmapSnapshotRequest) SignedDataSize 

func (x *NetmapSnapshotRequest) SignedDataSize() int

SignedDataSize returns binary size of the signed data of netmap snapshot request.

Structures with the same field values have the same signed data size.

func (*NetmapSnapshotRequest) String 

func (x *NetmapSnapshotRequest) String() string

type NetmapSnapshotRequest_Body 

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

Get netmap snapshot request body.

func (*NetmapSnapshotRequest_Body) Descriptor deprecated 

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

Deprecated: Use NetmapSnapshotRequest_Body.ProtoReflect.Descriptor instead.

func (*NetmapSnapshotRequest_Body) ProtoMessage 

func (*NetmapSnapshotRequest_Body) ProtoMessage()

func (*NetmapSnapshotRequest_Body) ProtoReflect 

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

func (*NetmapSnapshotRequest_Body) Reset 

func (x *NetmapSnapshotRequest_Body) Reset()

func (*NetmapSnapshotRequest_Body) StableMarshal 

func (x *NetmapSnapshotRequest_Body) StableMarshal(buf []byte) ([]byte, error)

StableMarshal reads binary representation of netmap snapshot request body in protobuf binary format.

If buffer length is less than x.StableSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same binary format.

func (*NetmapSnapshotRequest_Body) StableSize 

func (x *NetmapSnapshotRequest_Body) StableSize() int

StableSize returns binary size of netmap snapshot request body in protobuf binary format.

Structures with the same field values have the same binary size.

func (*NetmapSnapshotRequest_Body) String 

func (x *NetmapSnapshotRequest_Body) String() string

type NetmapSnapshotResponse 

type NetmapSnapshotResponse struct {

	// Body of get netmap snapshot response message.
	Body *NetmapSnapshotResponse_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Body signature.
	Signature *Signature `protobuf:"bytes,2,opt,name=signature,proto3" json:"signature,omitempty"`
	// contains filtered or unexported fields
}

Get netmap snapshot request.

func NetmapSnapshot added in v0.17.0 

func NetmapSnapshot(
	cli *client.Client,
	req *NetmapSnapshotRequest,
	opts ...client.CallOption,
) (*NetmapSnapshotResponse, error)

NetmapSnapshot executes ControlService.NetmapSnapshot RPC.

func (*NetmapSnapshotResponse) Descriptor deprecated 

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

Deprecated: Use NetmapSnapshotResponse.ProtoReflect.Descriptor instead.

func (*NetmapSnapshotResponse) GetBody 

func (x *NetmapSnapshotResponse) GetBody() *NetmapSnapshotResponse_Body

func (*NetmapSnapshotResponse) GetSignature 

func (x *NetmapSnapshotResponse) GetSignature() *Signature

func (*NetmapSnapshotResponse) ProtoMessage 

func (*NetmapSnapshotResponse) ProtoMessage()

func (*NetmapSnapshotResponse) ProtoReflect 

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

func (*NetmapSnapshotResponse) ReadSignedData 

func (x *NetmapSnapshotResponse) ReadSignedData(buf []byte) ([]byte, error)

ReadSignedData reads signed data of netmap snapshot response to buf.

If buffer length is less than x.SignedDataSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same signed data.

func (*NetmapSnapshotResponse) Reset 

func (x *NetmapSnapshotResponse) Reset()

func (*NetmapSnapshotResponse) SetBody 

func (x *NetmapSnapshotResponse) SetBody(v *NetmapSnapshotResponse_Body)

SetBody sets get netmap snapshot response body.

func (*NetmapSnapshotResponse) SetSignature 

func (x *NetmapSnapshotResponse) SetSignature(v *Signature)

SetSignature sets signature of the get netmap snapshot response body.

func (*NetmapSnapshotResponse) SignedDataSize 

func (x *NetmapSnapshotResponse) SignedDataSize() int

SignedDataSize returns binary size of the signed data of netmap snapshot response.

Structures with the same field values have the same signed data size.

func (*NetmapSnapshotResponse) String 

func (x *NetmapSnapshotResponse) String() string

type NetmapSnapshotResponse_Body 

type NetmapSnapshotResponse_Body struct {

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

Get netmap snapshot response body

func (*NetmapSnapshotResponse_Body) Descriptor deprecated 

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

Deprecated: Use NetmapSnapshotResponse_Body.ProtoReflect.Descriptor instead.

func (*NetmapSnapshotResponse_Body) GetNetmap 

func (x *NetmapSnapshotResponse_Body) GetNetmap() *Netmap

func (*NetmapSnapshotResponse_Body) ProtoMessage 

func (*NetmapSnapshotResponse_Body) ProtoMessage()

func (*NetmapSnapshotResponse_Body) ProtoReflect 

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

func (*NetmapSnapshotResponse_Body) Reset 

func (x *NetmapSnapshotResponse_Body) Reset()

func (*NetmapSnapshotResponse_Body) SetNetmap 

func (x *NetmapSnapshotResponse_Body) SetNetmap(v *Netmap)

SetNetmap sets structure of the current network map.

func (*NetmapSnapshotResponse_Body) StableMarshal 

func (x *NetmapSnapshotResponse_Body) StableMarshal(buf []byte) ([]byte, error)

StableMarshal reads binary representation of netmap snapshot response body in protobuf binary format.

If buffer length is less than x.StableSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same binary format.

func (*NetmapSnapshotResponse_Body) StableSize 

func (x *NetmapSnapshotResponse_Body) StableSize() int

StableSize returns binary size of netmap snapshot response body in protobuf binary format.

Structures with the same field values have the same binary size.

func (*NetmapSnapshotResponse_Body) String 

func (x *NetmapSnapshotResponse_Body) String() string

type NetmapStatus 

type NetmapStatus int32

Status of the storage node in the NeoFS network map. 

const (
	// Undefined status, default value.
	NetmapStatus_STATUS_UNDEFINED NetmapStatus = 0
	// Node is online.
	NetmapStatus_ONLINE NetmapStatus = 1
	// Node is offline.
	NetmapStatus_OFFLINE NetmapStatus = 2
	// Node is maintained by the owner.
	NetmapStatus_MAINTENANCE NetmapStatus = 3
)

func (NetmapStatus) Descriptor 

func (NetmapStatus) Descriptor() protoreflect.EnumDescriptor

func (NetmapStatus) Enum 

func (x NetmapStatus) Enum() *NetmapStatus

func (NetmapStatus) EnumDescriptor deprecated 

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

Deprecated: Use NetmapStatus.Descriptor instead.

func (NetmapStatus) Number 

func (x NetmapStatus) Number() protoreflect.EnumNumber

func (NetmapStatus) String 

func (x NetmapStatus) String() string

func (NetmapStatus) Type 

func (NetmapStatus) Type() protoreflect.EnumType

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.
	Addresses []string `protobuf:"bytes,2,rep,name=addresses,proto3" json:"addresses,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 NetmapStatus `protobuf:"varint,4,opt,name=state,proto3,enum=control.NetmapStatus" 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) GetAddresses added in v0.22.0 

func (x *NodeInfo) GetAddresses() []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() NetmapStatus

func (*NodeInfo) ProtoMessage 

func (*NodeInfo) ProtoMessage()

func (*NodeInfo) ProtoReflect 

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

func (*NodeInfo) Reset 

func (x *NodeInfo) Reset()

func (*NodeInfo) SetAddresses added in v0.22.0 

func (x *NodeInfo) SetAddresses(v []string)

SetAddresses sets ways to connect to a node.

func (*NodeInfo) SetAttributes 

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

SetAttributes sets attributes of the NeoFS Storage Node.

func (*NodeInfo) SetPublicKey 

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

SetPublicKey sets public key of the NeoFS node in a binary format.

func (*NodeInfo) SetState 

func (x *NodeInfo) SetState(v NetmapStatus)

SetState sets state of the NeoFS node.

func (*NodeInfo) StableMarshal 

func (x *NodeInfo) StableMarshal(buf []byte) ([]byte, error)

StableMarshal reads binary representation of node information in protobuf binary format.

If buffer length is less than x.StableSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same binary format.

func (*NodeInfo) StableSize 

func (x *NodeInfo) StableSize() int

StableSize returns binary size of node information in protobuf binary format.

Structures with the same field values have the same binary size.

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.
  • 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 standard.
  • Country \ Country code in [ISO 3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. Calculated automatically from `Locode` attribute
  • Region \ Country's administative subdivision where node is located. Calculated automatically from `Locode` attribute based on `SubDiv` field. Presented in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.
  • City \ City, town, village or rural area name where node is located written without diacritics . Calculated automatically from `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 (x *NodeInfo_Attribute) SetKey(v string)

SetKey sets key of the node attribute.

func (*NodeInfo_Attribute) SetParents 

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

SetParents sets parent keys.

func (*NodeInfo_Attribute) SetValue 

func (x *NodeInfo_Attribute) SetValue(v string)

SetValue sets value of the node attribute.

func (*NodeInfo_Attribute) StableMarshal 

func (x *NodeInfo_Attribute) StableMarshal(buf []byte) ([]byte, error)

StableMarshal reads binary representation of node attribute in protobuf binary format.

If buffer length is less than x.StableSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same binary format.

func (*NodeInfo_Attribute) StableSize 

func (x *NodeInfo_Attribute) StableSize() int

StableSize returns binary size of node attribute in protobuf binary format.

Structures with the same field values have the same binary size.

func (*NodeInfo_Attribute) String 

func (x *NodeInfo_Attribute) String() string

type RestoreShardRequest added in v0.27.5 

type RestoreShardRequest struct {

	// Body of restore shard request message.
	Body *RestoreShardRequest_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Body signature.
	Signature *Signature `protobuf:"bytes,2,opt,name=signature,proto3" json:"signature,omitempty"`
	// contains filtered or unexported fields
}

RestoreShard request.

func (*RestoreShardRequest) Descriptor deprecated added in v0.27.5 

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

Deprecated: Use RestoreShardRequest.ProtoReflect.Descriptor instead.

func (*RestoreShardRequest) GetBody added in v0.27.5 

func (x *RestoreShardRequest) GetBody() *RestoreShardRequest_Body

func (*RestoreShardRequest) GetSignature added in v0.27.5 

func (x *RestoreShardRequest) GetSignature() *Signature

func (*RestoreShardRequest) ProtoMessage added in v0.27.5 

func (*RestoreShardRequest) ProtoMessage()

func (*RestoreShardRequest) ProtoReflect added in v0.27.5 

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

func (*RestoreShardRequest) ReadSignedData added in v0.27.5 

func (x *RestoreShardRequest) ReadSignedData(buf []byte) ([]byte, error)

ReadSignedData reads signed data from request to buf.

If buffer length is less than x.SignedDataSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same signed data.

func (*RestoreShardRequest) Reset added in v0.27.5 

func (x *RestoreShardRequest) Reset()

func (*RestoreShardRequest) SetBody added in v0.27.5 

func (x *RestoreShardRequest) SetBody(v *RestoreShardRequest_Body)

SetBody sets request body.

func (*RestoreShardRequest) SetSignature added in v0.27.5 

func (x *RestoreShardRequest) SetSignature(v *Signature)

SetSignature sets body signature of the request.

func (*RestoreShardRequest) SignedDataSize added in v0.27.5 

func (x *RestoreShardRequest) SignedDataSize() int

SignedDataSize returns size of the request signed data in bytes.

Structures with the same field values have the same signed data size.

func (*RestoreShardRequest) String added in v0.27.5 

func (x *RestoreShardRequest) String() string

type RestoreShardRequest_Body added in v0.27.5 

type RestoreShardRequest_Body struct {

	// ID of the shard.
	Shard_ID []byte `protobuf:"bytes,1,opt,name=shard_ID,json=shardID,proto3" json:"shard_ID,omitempty"`
	// Path to the output.
	Filepath string `protobuf:"bytes,2,opt,name=filepath,proto3" json:"filepath,omitempty"`
	// Flag indicating whether object read errors should be ignored.
	IgnoreErrors bool `protobuf:"varint,3,opt,name=ignore_errors,json=ignoreErrors,proto3" json:"ignore_errors,omitempty"`
	// contains filtered or unexported fields
}

Request body structure.

func (*RestoreShardRequest_Body) Descriptor deprecated added in v0.27.5 

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

Deprecated: Use RestoreShardRequest_Body.ProtoReflect.Descriptor instead.

func (*RestoreShardRequest_Body) GetFilepath added in v0.27.5 

func (x *RestoreShardRequest_Body) GetFilepath() string

func (*RestoreShardRequest_Body) GetIgnoreErrors added in v0.27.5 

func (x *RestoreShardRequest_Body) GetIgnoreErrors() bool

func (*RestoreShardRequest_Body) GetShard_ID added in v0.27.5 

func (x *RestoreShardRequest_Body) GetShard_ID() []byte

func (*RestoreShardRequest_Body) ProtoMessage added in v0.27.5 

func (*RestoreShardRequest_Body) ProtoMessage()

func (*RestoreShardRequest_Body) ProtoReflect added in v0.27.5 

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

func (*RestoreShardRequest_Body) Reset added in v0.27.5 

func (x *RestoreShardRequest_Body) Reset()

func (*RestoreShardRequest_Body) SetFilepath added in v0.27.5 

func (x *RestoreShardRequest_Body) SetFilepath(p string)

SetFilepath sets filepath for the restore shard request.

func (*RestoreShardRequest_Body) SetIgnoreErrors added in v0.27.5 

func (x *RestoreShardRequest_Body) SetIgnoreErrors(ignore bool)

SetIgnoreErrors sets ignore errors flag for the restore shard request.

func (*RestoreShardRequest_Body) SetShardID added in v0.27.5 

func (x *RestoreShardRequest_Body) SetShardID(id []byte)

SetShardID sets shard ID for the restore shard request.

func (*RestoreShardRequest_Body) StableMarshal added in v0.27.5 

func (x *RestoreShardRequest_Body) StableMarshal(buf []byte) ([]byte, error)

StableMarshal reads binary representation of request body binary format.

If buffer length is less than StableSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same binary format.

func (*RestoreShardRequest_Body) StableSize added in v0.27.5 

func (x *RestoreShardRequest_Body) StableSize() int

StableSize returns binary size of the request body in protobuf binary format.

Structures with the same field values have the same binary size.

func (*RestoreShardRequest_Body) String added in v0.27.5 

func (x *RestoreShardRequest_Body) String() string

type RestoreShardResponse added in v0.27.5 

type RestoreShardResponse struct {

	// Body of restore shard response message.
	Body *RestoreShardResponse_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Body signature.
	Signature *Signature `protobuf:"bytes,2,opt,name=signature,proto3" json:"signature,omitempty"`
	// contains filtered or unexported fields
}

RestoreShard response.

func RestoreShard added in v0.27.5 

func RestoreShard(cli *client.Client, req *RestoreShardRequest, opts ...client.CallOption) (*RestoreShardResponse, error)

RestoreShard executes ControlService.DumpShard RPC.

func (*RestoreShardResponse) Descriptor deprecated added in v0.27.5 

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

Deprecated: Use RestoreShardResponse.ProtoReflect.Descriptor instead.

func (*RestoreShardResponse) GetBody added in v0.27.5 

func (x *RestoreShardResponse) GetBody() *RestoreShardResponse_Body

func (*RestoreShardResponse) GetSignature added in v0.27.5 

func (x *RestoreShardResponse) GetSignature() *Signature

func (*RestoreShardResponse) ProtoMessage added in v0.27.5 

func (*RestoreShardResponse) ProtoMessage()

func (*RestoreShardResponse) ProtoReflect added in v0.27.5 

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

func (*RestoreShardResponse) ReadSignedData added in v0.27.5 

func (x *RestoreShardResponse) ReadSignedData(buf []byte) ([]byte, error)

ReadSignedData reads signed data from response to buf.

If buffer length is less than SignedDataSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same signed data.

func (*RestoreShardResponse) Reset added in v0.27.5 

func (x *RestoreShardResponse) Reset()

func (*RestoreShardResponse) SetBody added in v0.27.5 

func (x *RestoreShardResponse) SetBody(v *RestoreShardResponse_Body)

SetBody sets response body.

func (*RestoreShardResponse) SetSignature added in v0.27.5 

func (x *RestoreShardResponse) SetSignature(v *Signature)

SetSignature sets response body signature.

func (*RestoreShardResponse) SignedDataSize added in v0.27.5 

func (x *RestoreShardResponse) SignedDataSize() int

SignedDataSize returns binary size of the signed data.

Structures with the same field values have the same signed data size.

func (*RestoreShardResponse) String added in v0.27.5 

func (x *RestoreShardResponse) String() string

type RestoreShardResponse_Body added in v0.27.5 

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

Response body structure.

func (*RestoreShardResponse_Body) Descriptor deprecated added in v0.27.5 

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

Deprecated: Use RestoreShardResponse_Body.ProtoReflect.Descriptor instead.

func (*RestoreShardResponse_Body) ProtoMessage added in v0.27.5 

func (*RestoreShardResponse_Body) ProtoMessage()

func (*RestoreShardResponse_Body) ProtoReflect added in v0.27.5 

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

func (*RestoreShardResponse_Body) Reset added in v0.27.5 

func (x *RestoreShardResponse_Body) Reset()

func (*RestoreShardResponse_Body) StableMarshal added in v0.27.5 

func (x *RestoreShardResponse_Body) StableMarshal(buf []byte) ([]byte, error)

StableMarshal reads binary representation of the response body in protobuf binary format.

If buffer length is less than x.StableSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same binary format.

func (*RestoreShardResponse_Body) StableSize added in v0.27.5 

func (x *RestoreShardResponse_Body) StableSize() int

StableSize returns binary size of the response body in protobuf binary format.

Structures with the same field values have the same binary size.

func (*RestoreShardResponse_Body) String added in v0.27.5 

func (x *RestoreShardResponse_Body) String() string

type SetNetmapStatusRequest 

type SetNetmapStatusRequest struct {

	// Body of set netmap status request message.
	Body *SetNetmapStatusRequest_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Body signature.
	Signature *Signature `protobuf:"bytes,2,opt,name=signature,proto3" json:"signature,omitempty"`
	// contains filtered or unexported fields
}

Set netmap status request.

func (*SetNetmapStatusRequest) Descriptor deprecated 

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

Deprecated: Use SetNetmapStatusRequest.ProtoReflect.Descriptor instead.

func (*SetNetmapStatusRequest) GetBody 

func (x *SetNetmapStatusRequest) GetBody() *SetNetmapStatusRequest_Body

func (*SetNetmapStatusRequest) GetSignature 

func (x *SetNetmapStatusRequest) GetSignature() *Signature

func (*SetNetmapStatusRequest) ProtoMessage 

func (*SetNetmapStatusRequest) ProtoMessage()

func (*SetNetmapStatusRequest) ProtoReflect 

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

func (*SetNetmapStatusRequest) ReadSignedData 

func (x *SetNetmapStatusRequest) ReadSignedData(buf []byte) ([]byte, error)

ReadSignedData reads signed data of set netmap status request to buf.

If buffer length is less than x.SignedDataSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same signed data.

func (*SetNetmapStatusRequest) Reset 

func (x *SetNetmapStatusRequest) Reset()

func (*SetNetmapStatusRequest) SetBody 

func (x *SetNetmapStatusRequest) SetBody(v *SetNetmapStatusRequest_Body)

SetBody sets body of the set netmap status request .

func (*SetNetmapStatusRequest) SetSignature 

func (x *SetNetmapStatusRequest) SetSignature(body *Signature)

SetSignature sets signature of the set netmap status request body.

func (*SetNetmapStatusRequest) SignedDataSize 

func (x *SetNetmapStatusRequest) SignedDataSize() int

SignedDataSize returns binary size of the signed data of set netmap status request.

Structures with the same field values have the same signed data size.

func (*SetNetmapStatusRequest) String 

func (x *SetNetmapStatusRequest) String() string

type SetNetmapStatusRequest_Body 

type SetNetmapStatusRequest_Body struct {

	// New storage node status in NeoFS network map.
	Status NetmapStatus `protobuf:"varint,1,opt,name=status,proto3,enum=control.NetmapStatus" json:"status,omitempty"`
	// contains filtered or unexported fields
}

Set netmap status request body.

func (*SetNetmapStatusRequest_Body) Descriptor deprecated 

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

Deprecated: Use SetNetmapStatusRequest_Body.ProtoReflect.Descriptor instead.

func (*SetNetmapStatusRequest_Body) GetStatus 

func (x *SetNetmapStatusRequest_Body) GetStatus() NetmapStatus

func (*SetNetmapStatusRequest_Body) ProtoMessage 

func (*SetNetmapStatusRequest_Body) ProtoMessage()

func (*SetNetmapStatusRequest_Body) ProtoReflect 

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

func (*SetNetmapStatusRequest_Body) Reset 

func (x *SetNetmapStatusRequest_Body) Reset()

func (*SetNetmapStatusRequest_Body) SetStatus 

func (x *SetNetmapStatusRequest_Body) SetStatus(v NetmapStatus)

SetStatus sets new storage node status in NeoFS network map.

func (*SetNetmapStatusRequest_Body) StableMarshal 

func (x *SetNetmapStatusRequest_Body) StableMarshal(buf []byte) ([]byte, error)

StableMarshal reads binary representation of set netmap status request body in protobuf binary format.

If buffer length is less than x.StableSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same binary format.

func (*SetNetmapStatusRequest_Body) StableSize 

func (x *SetNetmapStatusRequest_Body) StableSize() int

StableSize returns binary size of netmap status response body in protobuf binary format.

Structures with the same field values have the same binary size.

func (*SetNetmapStatusRequest_Body) String 

func (x *SetNetmapStatusRequest_Body) String() string

type SetNetmapStatusResponse 

type SetNetmapStatusResponse struct {

	// Body of set netmap status response message.
	Body *SetNetmapStatusResponse_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Body signature.
	Signature *Signature `protobuf:"bytes,2,opt,name=signature,proto3" json:"signature,omitempty"`
	// contains filtered or unexported fields
}

Set netmap status response.

func SetNetmapStatus added in v0.17.0 

func SetNetmapStatus(
	cli *client.Client,
	req *SetNetmapStatusRequest,
	opts ...client.CallOption,
) (*SetNetmapStatusResponse, error)

SetNetmapStatus executes ControlService.SetNetmapStatus RPC.

func (*SetNetmapStatusResponse) Descriptor deprecated 

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

Deprecated: Use SetNetmapStatusResponse.ProtoReflect.Descriptor instead.

func (*SetNetmapStatusResponse) GetBody 

func (x *SetNetmapStatusResponse) GetBody() *SetNetmapStatusResponse_Body

func (*SetNetmapStatusResponse) GetSignature 

func (x *SetNetmapStatusResponse) GetSignature() *Signature

func (*SetNetmapStatusResponse) ProtoMessage 

func (*SetNetmapStatusResponse) ProtoMessage()

func (*SetNetmapStatusResponse) ProtoReflect 

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

func (*SetNetmapStatusResponse) ReadSignedData 

func (x *SetNetmapStatusResponse) ReadSignedData(buf []byte) ([]byte, error)

ReadSignedData reads signed data of set netmap status response to buf.

If buffer length is less than x.SignedDataSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same signed data.

func (*SetNetmapStatusResponse) Reset 

func (x *SetNetmapStatusResponse) Reset()

func (*SetNetmapStatusResponse) SetBody 

func (x *SetNetmapStatusResponse) SetBody(v *SetNetmapStatusResponse_Body)

SetBody sets set body of the netmap status response.

func (*SetNetmapStatusResponse) SetSignature 

func (x *SetNetmapStatusResponse) SetSignature(v *Signature)

SetSignature sets signature of the set netmap status response body.

func (*SetNetmapStatusResponse) SignedDataSize 

func (x *SetNetmapStatusResponse) SignedDataSize() int

SignedDataSize returns binary size of the signed data of set netmap status response.

Structures with the same field values have the same signed data size.

func (*SetNetmapStatusResponse) String 

func (x *SetNetmapStatusResponse) String() string

type SetNetmapStatusResponse_Body 

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

Set netmap status response body

func (*SetNetmapStatusResponse_Body) Descriptor deprecated 

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

Deprecated: Use SetNetmapStatusResponse_Body.ProtoReflect.Descriptor instead.

func (*SetNetmapStatusResponse_Body) ProtoMessage 

func (*SetNetmapStatusResponse_Body) ProtoMessage()

func (*SetNetmapStatusResponse_Body) ProtoReflect 

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

func (*SetNetmapStatusResponse_Body) Reset 

func (x *SetNetmapStatusResponse_Body) Reset()

func (*SetNetmapStatusResponse_Body) StableMarshal 

func (x *SetNetmapStatusResponse_Body) StableMarshal(buf []byte) ([]byte, error)

StableMarshal reads binary representation of set netmap status response body in protobuf binary format.

If buffer length is less than x.StableSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same binary format.

func (*SetNetmapStatusResponse_Body) StableSize 

func (x *SetNetmapStatusResponse_Body) StableSize() int

StableSize returns binary size of set netmap status response body in protobuf binary format.

Structures with the same field values have the same binary size.

func (*SetNetmapStatusResponse_Body) String 

func (x *SetNetmapStatusResponse_Body) String() string

type SetShardModeRequest added in v0.27.3 

type SetShardModeRequest struct {

	// Body of set shard mode request message.
	Body *SetShardModeRequest_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Body signature.
	Signature *Signature `protobuf:"bytes,2,opt,name=signature,proto3" json:"signature,omitempty"`
	// contains filtered or unexported fields
}

Request to set mode of the shard.

func (*SetShardModeRequest) Descriptor deprecated added in v0.27.3 

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

Deprecated: Use SetShardModeRequest.ProtoReflect.Descriptor instead.

func (*SetShardModeRequest) GetBody added in v0.27.3 

func (x *SetShardModeRequest) GetBody() *SetShardModeRequest_Body

func (*SetShardModeRequest) GetSignature added in v0.27.3 

func (x *SetShardModeRequest) GetSignature() *Signature

func (*SetShardModeRequest) ProtoMessage added in v0.27.3 

func (*SetShardModeRequest) ProtoMessage()

func (*SetShardModeRequest) ProtoReflect added in v0.27.3 

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

func (*SetShardModeRequest) ReadSignedData added in v0.27.3 

func (x *SetShardModeRequest) ReadSignedData(buf []byte) ([]byte, error)

ReadSignedData reads signed data of the set shard mode request to buf.

If buffer length is less than x.SignedDataSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same signed data.

func (*SetShardModeRequest) Reset added in v0.27.3 

func (x *SetShardModeRequest) Reset()

func (*SetShardModeRequest) SetBody added in v0.27.3 

func (x *SetShardModeRequest) SetBody(v *SetShardModeRequest_Body)

SetBody sets request body.

func (*SetShardModeRequest) SetSignature added in v0.27.3 

func (x *SetShardModeRequest) SetSignature(v *Signature)

SetSignature sets signature of the request body.

func (*SetShardModeRequest) SignedDataSize added in v0.27.3 

func (x *SetShardModeRequest) SignedDataSize() int

SignedDataSize returns binary size of the signed data of the set shard mode request.

Structures with the same field values have the same signed data size.

func (*SetShardModeRequest) String added in v0.27.3 

func (x *SetShardModeRequest) String() string

type SetShardModeRequest_Body added in v0.27.3 

type SetShardModeRequest_Body struct {

	// ID of the shard.
	Shard_ID []byte `protobuf:"bytes,1,opt,name=shard_ID,json=shardID,proto3" json:"shard_ID,omitempty"`
	// Mode that requested to be set.
	Mode ShardMode `protobuf:"varint,2,opt,name=mode,proto3,enum=control.ShardMode" json:"mode,omitempty"`
	// contains filtered or unexported fields
}

Request body structure.

func (*SetShardModeRequest_Body) Descriptor deprecated added in v0.27.3 

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

Deprecated: Use SetShardModeRequest_Body.ProtoReflect.Descriptor instead.

func (*SetShardModeRequest_Body) GetMode added in v0.27.3 

func (x *SetShardModeRequest_Body) GetMode() ShardMode

func (*SetShardModeRequest_Body) GetShard_ID added in v0.27.3 

func (x *SetShardModeRequest_Body) GetShard_ID() []byte

func (*SetShardModeRequest_Body) ProtoMessage added in v0.27.3 

func (*SetShardModeRequest_Body) ProtoMessage()

func (*SetShardModeRequest_Body) ProtoReflect added in v0.27.3 

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

func (*SetShardModeRequest_Body) Reset added in v0.27.3 

func (x *SetShardModeRequest_Body) Reset()

func (*SetShardModeRequest_Body) SetMode added in v0.27.3 

func (x *SetShardModeRequest_Body) SetMode(v ShardMode)

SetMode sets mode of the shard.

func (*SetShardModeRequest_Body) SetShardID added in v0.27.3 

func (x *SetShardModeRequest_Body) SetShardID(v []byte)

SetShardID sets shard ID whose mode is requested to be set.

func (*SetShardModeRequest_Body) StableMarshal added in v0.27.3 

func (x *SetShardModeRequest_Body) StableMarshal(buf []byte) ([]byte, error)

StableMarshal reads binary representation of set shard mode request body in protobuf binary format.

If buffer length is less than x.StableSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same binary format.

func (*SetShardModeRequest_Body) StableSize added in v0.27.3 

func (x *SetShardModeRequest_Body) StableSize() int

StableSize returns binary size of set shard mode response body in protobuf binary format.

Structures with the same field values have the same binary size.

func (*SetShardModeRequest_Body) String added in v0.27.3 

func (x *SetShardModeRequest_Body) String() string

type SetShardModeResponse added in v0.27.3 

type SetShardModeResponse struct {

	// Body of set shard mode response message.
	Body *SetShardModeResponse_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Body signature.
	Signature *Signature `protobuf:"bytes,2,opt,name=signature,proto3" json:"signature,omitempty"`
	// contains filtered or unexported fields
}

SetShardMode response.

func SetShardMode added in v0.27.3 

func SetShardMode(
	cli *client.Client,
	req *SetShardModeRequest,
	opts ...client.CallOption,
) (*SetShardModeResponse, error)

SetShardMode executes ControlService.SetShardMode RPC.

func (*SetShardModeResponse) Descriptor deprecated added in v0.27.3 

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

Deprecated: Use SetShardModeResponse.ProtoReflect.Descriptor instead.

func (*SetShardModeResponse) GetBody added in v0.27.3 

func (x *SetShardModeResponse) GetBody() *SetShardModeResponse_Body

func (*SetShardModeResponse) GetSignature added in v0.27.3 

func (x *SetShardModeResponse) GetSignature() *Signature

func (*SetShardModeResponse) ProtoMessage added in v0.27.3 

func (*SetShardModeResponse) ProtoMessage()

func (*SetShardModeResponse) ProtoReflect added in v0.27.3 

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

func (*SetShardModeResponse) ReadSignedData added in v0.27.3 

func (x *SetShardModeResponse) ReadSignedData(buf []byte) ([]byte, error)

ReadSignedData reads signed data of the set shard mode response to buf.

If buffer length is less than x.SignedDataSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same signed data.

func (*SetShardModeResponse) Reset added in v0.27.3 

func (x *SetShardModeResponse) Reset()

func (*SetShardModeResponse) SetBody added in v0.27.3 

func (x *SetShardModeResponse) SetBody(v *SetShardModeResponse_Body)

SetBody sets body of the set shard mode response.

func (*SetShardModeResponse) SetSignature added in v0.27.3 

func (x *SetShardModeResponse) SetSignature(v *Signature)

SetSignature sets signature of the set shard mode response body.

func (*SetShardModeResponse) SignedDataSize added in v0.27.3 

func (x *SetShardModeResponse) SignedDataSize() int

SignedDataSize returns binary size of the signed data of the set shard mode response.

Structures with the same field values have the same signed data size.

func (*SetShardModeResponse) String added in v0.27.3 

func (x *SetShardModeResponse) String() string

type SetShardModeResponse_Body added in v0.27.3 

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

Response body structure.

func (*SetShardModeResponse_Body) Descriptor deprecated added in v0.27.3 

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

Deprecated: Use SetShardModeResponse_Body.ProtoReflect.Descriptor instead.

func (*SetShardModeResponse_Body) ProtoMessage added in v0.27.3 

func (*SetShardModeResponse_Body) ProtoMessage()

func (*SetShardModeResponse_Body) ProtoReflect added in v0.27.3 

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

func (*SetShardModeResponse_Body) Reset added in v0.27.3 

func (x *SetShardModeResponse_Body) Reset()

func (*SetShardModeResponse_Body) StableMarshal added in v0.27.3 

func (x *SetShardModeResponse_Body) StableMarshal(buf []byte) ([]byte, error)

StableMarshal reads binary representation of the set shard mode response body in protobuf binary format.

If buffer length is less than x.StableSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same binary format.

func (*SetShardModeResponse_Body) StableSize added in v0.27.3 

func (x *SetShardModeResponse_Body) StableSize() int

StableSize returns binary size of the set shard mode response body in protobuf binary format.

Structures with the same field values have the same binary size.

func (*SetShardModeResponse_Body) String added in v0.27.3 

func (x *SetShardModeResponse_Body) String() string

type ShardInfo added in v0.27.2 

type ShardInfo struct {

	// ID of the shard.
	Shard_ID []byte `protobuf:"bytes,1,opt,name=shard_ID,json=shardID,proto3" json:"shard_ID,omitempty"`
	// Path to shard's metabase.
	MetabasePath string `protobuf:"bytes,2,opt,name=metabase_path,json=metabasePath,proto3" json:"metabase_path,omitempty"`
	// Path to shard's blobstor.
	BlobstorPath string `protobuf:"bytes,3,opt,name=blobstor_path,json=blobstorPath,proto3" json:"blobstor_path,omitempty"`
	// Path to shard's write-cache, empty if disabled.
	WritecachePath string `protobuf:"bytes,4,opt,name=writecache_path,json=writecachePath,proto3" json:"writecache_path,omitempty"`
	// Work mode of the shard.
	Mode ShardMode `protobuf:"varint,5,opt,name=mode,proto3,enum=control.ShardMode" json:"mode,omitempty"`
	// contains filtered or unexported fields
}

Shard description.

func (*ShardInfo) Descriptor deprecated added in v0.27.2 

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

Deprecated: Use ShardInfo.ProtoReflect.Descriptor instead.

func (*ShardInfo) GetBlobstorPath added in v0.27.2 

func (x *ShardInfo) GetBlobstorPath() string

func (*ShardInfo) GetMetabasePath added in v0.27.2 

func (x *ShardInfo) GetMetabasePath() string

func (*ShardInfo) GetMode added in v0.27.2 

func (x *ShardInfo) GetMode() ShardMode

func (*ShardInfo) GetShard_ID added in v0.27.2 

func (x *ShardInfo) GetShard_ID() []byte

func (*ShardInfo) GetWritecachePath added in v0.27.2 

func (x *ShardInfo) GetWritecachePath() string

func (*ShardInfo) ProtoMessage added in v0.27.2 

func (*ShardInfo) ProtoMessage()

func (*ShardInfo) ProtoReflect added in v0.27.2 

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

func (*ShardInfo) Reset added in v0.27.2 

func (x *ShardInfo) Reset()

func (*ShardInfo) SetBlobstorPath added in v0.27.2 

func (x *ShardInfo) SetBlobstorPath(v string)

SetBlobstorPath sets path to shard's blobstor.

func (*ShardInfo) SetID added in v0.27.2 

func (x *ShardInfo) SetID(v []byte)

SetID sets identificator of the shard.

func (*ShardInfo) SetMetabasePath added in v0.27.2 

func (x *ShardInfo) SetMetabasePath(v string)

SetMetabasePath sets path to shard's metabase.

func (*ShardInfo) SetMode added in v0.27.2 

func (x *ShardInfo) SetMode(v ShardMode)

SetMode sets path to shard's work mode.

func (*ShardInfo) SetWriteCachePath added in v0.27.2 

func (x *ShardInfo) SetWriteCachePath(v string)

SetWriteCachePath sets path to shard's write-cache.

func (*ShardInfo) StableMarshal added in v0.27.2 

func (x *ShardInfo) StableMarshal(buf []byte) ([]byte, error)

StableMarshal reads binary representation of shard information in protobuf binary format.

If buffer length is less than x.StableSize(), new buffer is allocated.

Returns any error encountered which did not allow writing the data completely. Otherwise, returns the buffer in which the data is written.

Structures with the same field values have the same binary format.

func (*ShardInfo) StableSize added in v0.27.2 

func (x *ShardInfo) StableSize() int

StableSize returns binary size of shard information in protobuf binary format.

Structures with the same field values have the same binary size.

func (*ShardInfo) String added in v0.27.2 

func (x *ShardInfo) String() string

type ShardMode added in v0.27.2 

type ShardMode int32

Work mode of the shard. 

const (
	// Undefined mode, default value.
	ShardMode_SHARD_MODE_UNDEFINED ShardMode = 0
	// Read-write.
	ShardMode_READ_WRITE ShardMode = 1
	// Read-only.
	ShardMode_READ_ONLY ShardMode = 2
)

func (ShardMode) Descriptor added in v0.27.2 

func (ShardMode) Descriptor() protoreflect.EnumDescriptor

func (ShardMode) Enum added in v0.27.2 

func (x ShardMode) Enum() *ShardMode

func (ShardMode) EnumDescriptor deprecated added in v0.27.2 

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

Deprecated: Use ShardMode.Descriptor instead.

func (ShardMode) Number added in v0.27.2 

func (x ShardMode) Number() protoreflect.EnumNumber

func (ShardMode) String added in v0.27.2 

func (x ShardMode) String() string

func (ShardMode) Type added in v0.27.2 

func (ShardMode) Type() protoreflect.EnumType

type Signature 

type Signature struct {

	// Public key used for signing.
	Key []byte `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// Binary signature.
	Sign []byte `protobuf:"bytes,2,opt,name=sign,json=signature,proto3" json:"sign,omitempty"`
	// contains filtered or unexported fields
}

Signature of some message.

func (*Signature) Descriptor deprecated 

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

Deprecated: Use Signature.ProtoReflect.Descriptor instead.

func (*Signature) GetKey 

func (x *Signature) GetKey() []byte

func (*Signature) GetSign 

func (x *Signature) GetSign() []byte

func (*Signature) ProtoMessage 

func (*Signature) ProtoMessage()

func (*Signature) ProtoReflect 

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

func (*Signature) Reset 

func (x *Signature) Reset()

func (*Signature) SetKey 

func (x *Signature) SetKey(v []byte)

SetKey sets public key used for signing.

func (*Signature) SetSign 

func (x *Signature) SetSign(v []byte)

SetSign sets binary signature.

func (*Signature) String 

func (x *Signature) String() string

type UnimplementedControlServiceServer 

type UnimplementedControlServiceServer struct {
}

UnimplementedControlServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedControlServiceServer) DropObjects added in v0.16.0 

func (UnimplementedControlServiceServer) DropObjects(context.Context, *DropObjectsRequest) (*DropObjectsResponse, error)

func (UnimplementedControlServiceServer) DumpShard added in v0.27.5 

func (UnimplementedControlServiceServer) DumpShard(context.Context, *DumpShardRequest) (*DumpShardResponse, error)

func (UnimplementedControlServiceServer) HealthCheck 

func (UnimplementedControlServiceServer) HealthCheck(context.Context, *HealthCheckRequest) (*HealthCheckResponse, error)

func (UnimplementedControlServiceServer) ListShards added in v0.27.2 

func (UnimplementedControlServiceServer) ListShards(context.Context, *ListShardsRequest) (*ListShardsResponse, error)

func (UnimplementedControlServiceServer) NetmapSnapshot 

func (UnimplementedControlServiceServer) NetmapSnapshot(context.Context, *NetmapSnapshotRequest) (*NetmapSnapshotResponse, error)

func (UnimplementedControlServiceServer) RestoreShard added in v0.27.5 

func (UnimplementedControlServiceServer) RestoreShard(context.Context, *RestoreShardRequest) (*RestoreShardResponse, error)

func (UnimplementedControlServiceServer) SetNetmapStatus 

func (UnimplementedControlServiceServer) SetNetmapStatus(context.Context, *SetNetmapStatusRequest) (*SetNetmapStatusResponse, error)

func (UnimplementedControlServiceServer) SetShardMode added in v0.27.3 

func (UnimplementedControlServiceServer) SetShardMode(context.Context, *SetShardModeRequest) (*SetShardModeResponse, error)

type UnsafeControlServiceServer added in v0.26.0 

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

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

Source Files

View all Source files

Directories

Path Synopsis
ir
server

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.