admin

package
v7.0.0-...-5d54eda Latest Latest
Warning

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

Go to latest
Published: Dec 21, 2021 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var ConfigManagementService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "com.daml.ledger.api.v1.admin.ConfigManagementService",
	HandlerType: (*ConfigManagementServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetTimeModel",
			Handler:    _ConfigManagementService_GetTimeModel_Handler,
		},
		{
			MethodName: "SetTimeModel",
			Handler:    _ConfigManagementService_SetTimeModel_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "com/daml/ledger/api/v1/admin/config_management_service.proto",
}

ConfigManagementService_ServiceDesc is the grpc.ServiceDesc for ConfigManagementService 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_com_daml_ledger_api_v1_admin_config_management_service_proto protoreflect.FileDescriptor
View Source
var File_com_daml_ledger_api_v1_admin_package_management_service_proto protoreflect.FileDescriptor
View Source
var File_com_daml_ledger_api_v1_admin_participant_pruning_service_proto protoreflect.FileDescriptor
View Source
var File_com_daml_ledger_api_v1_admin_party_management_service_proto protoreflect.FileDescriptor
View Source
var PackageManagementService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "com.daml.ledger.api.v1.admin.PackageManagementService",
	HandlerType: (*PackageManagementServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListKnownPackages",
			Handler:    _PackageManagementService_ListKnownPackages_Handler,
		},
		{
			MethodName: "UploadDarFile",
			Handler:    _PackageManagementService_UploadDarFile_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "com/daml/ledger/api/v1/admin/package_management_service.proto",
}

PackageManagementService_ServiceDesc is the grpc.ServiceDesc for PackageManagementService 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 ParticipantPruningService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "com.daml.ledger.api.v1.admin.ParticipantPruningService",
	HandlerType: (*ParticipantPruningServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Prune",
			Handler:    _ParticipantPruningService_Prune_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "com/daml/ledger/api/v1/admin/participant_pruning_service.proto",
}

ParticipantPruningService_ServiceDesc is the grpc.ServiceDesc for ParticipantPruningService 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 PartyManagementService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "com.daml.ledger.api.v1.admin.PartyManagementService",
	HandlerType: (*PartyManagementServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetParticipantId",
			Handler:    _PartyManagementService_GetParticipantId_Handler,
		},
		{
			MethodName: "GetParties",
			Handler:    _PartyManagementService_GetParties_Handler,
		},
		{
			MethodName: "ListKnownParties",
			Handler:    _PartyManagementService_ListKnownParties_Handler,
		},
		{
			MethodName: "AllocateParty",
			Handler:    _PartyManagementService_AllocateParty_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "com/daml/ledger/api/v1/admin/party_management_service.proto",
}

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

Functions

func RegisterConfigManagementServiceServer

func RegisterConfigManagementServiceServer(s grpc.ServiceRegistrar, srv ConfigManagementServiceServer)

func RegisterPackageManagementServiceServer

func RegisterPackageManagementServiceServer(s grpc.ServiceRegistrar, srv PackageManagementServiceServer)

func RegisterParticipantPruningServiceServer

func RegisterParticipantPruningServiceServer(s grpc.ServiceRegistrar, srv ParticipantPruningServiceServer)

func RegisterPartyManagementServiceServer

func RegisterPartyManagementServiceServer(s grpc.ServiceRegistrar, srv PartyManagementServiceServer)

Types

type AllocatePartyRequest

type AllocatePartyRequest struct {

	// A hint to the backing participant which party ID to allocate. It can be
	// ignored.
	// Must be a valid PartyIdString (as described in “value.proto“).
	// Optional
	PartyIdHint string `protobuf:"bytes,1,opt,name=party_id_hint,json=partyIdHint,proto3" json:"party_id_hint,omitempty"`
	// Human-readable name of the party to be added to the participant. It doesn't
	// have to be unique.
	// Optional
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// contains filtered or unexported fields
}

func (*AllocatePartyRequest) Descriptor deprecated

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

Deprecated: Use AllocatePartyRequest.ProtoReflect.Descriptor instead.

func (*AllocatePartyRequest) GetDisplayName

func (x *AllocatePartyRequest) GetDisplayName() string

func (*AllocatePartyRequest) GetPartyIdHint

func (x *AllocatePartyRequest) GetPartyIdHint() string

func (*AllocatePartyRequest) ProtoMessage

func (*AllocatePartyRequest) ProtoMessage()

func (*AllocatePartyRequest) ProtoReflect

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

func (*AllocatePartyRequest) Reset

func (x *AllocatePartyRequest) Reset()

func (*AllocatePartyRequest) String

func (x *AllocatePartyRequest) String() string

type AllocatePartyResponse

type AllocatePartyResponse struct {
	PartyDetails *PartyDetails `protobuf:"bytes,1,opt,name=party_details,json=partyDetails,proto3" json:"party_details,omitempty"`
	// contains filtered or unexported fields
}

func (*AllocatePartyResponse) Descriptor deprecated

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

Deprecated: Use AllocatePartyResponse.ProtoReflect.Descriptor instead.

func (*AllocatePartyResponse) GetPartyDetails

func (x *AllocatePartyResponse) GetPartyDetails() *PartyDetails

func (*AllocatePartyResponse) ProtoMessage

func (*AllocatePartyResponse) ProtoMessage()

func (*AllocatePartyResponse) ProtoReflect

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

func (*AllocatePartyResponse) Reset

func (x *AllocatePartyResponse) Reset()

func (*AllocatePartyResponse) String

func (x *AllocatePartyResponse) String() string

type ConfigManagementServiceClient

type ConfigManagementServiceClient interface {
	// Return the currently active time model and the current configuration generation.
	// Errors:
	// - “UNAUTHENTICATED“: if the request does not include a valid access token
	// - “PERMISSION_DENIED“: if the claims in the token are insufficient to perform a given operation
	GetTimeModel(ctx context.Context, in *GetTimeModelRequest, opts ...grpc.CallOption) (*GetTimeModelResponse, error)
	// Set the ledger time model.
	// Errors:
	// - “UNAUTHENTICATED“: if the request does not include a valid access token
	// - “PERMISSION_DENIED“: if the claims in the token are insufficient to perform a given operation
	// - “INVALID_ARGUMENT“: if arguments are invalid, or the provided configuration generation
	//   does not match the current active configuration generation. The caller is expected
	//   to retry by again fetching current time model using 'GetTimeModel', applying changes
	//   and resubmitting.
	// - “ABORTED“: if the request is rejected or times out. Note that a timed out request may
	//   have still been committed to the ledger. Application should re-query the current
	//   time model before retrying.
	// - “UNIMPLEMENTED“: if this method is not supported by the backing ledger.
	SetTimeModel(ctx context.Context, in *SetTimeModelRequest, opts ...grpc.CallOption) (*SetTimeModelResponse, error)
}

ConfigManagementServiceClient is the client API for ConfigManagementService service.

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

type ConfigManagementServiceServer

type ConfigManagementServiceServer interface {
	// Return the currently active time model and the current configuration generation.
	// Errors:
	// - “UNAUTHENTICATED“: if the request does not include a valid access token
	// - “PERMISSION_DENIED“: if the claims in the token are insufficient to perform a given operation
	GetTimeModel(context.Context, *GetTimeModelRequest) (*GetTimeModelResponse, error)
	// Set the ledger time model.
	// Errors:
	// - “UNAUTHENTICATED“: if the request does not include a valid access token
	// - “PERMISSION_DENIED“: if the claims in the token are insufficient to perform a given operation
	// - “INVALID_ARGUMENT“: if arguments are invalid, or the provided configuration generation
	//   does not match the current active configuration generation. The caller is expected
	//   to retry by again fetching current time model using 'GetTimeModel', applying changes
	//   and resubmitting.
	// - “ABORTED“: if the request is rejected or times out. Note that a timed out request may
	//   have still been committed to the ledger. Application should re-query the current
	//   time model before retrying.
	// - “UNIMPLEMENTED“: if this method is not supported by the backing ledger.
	SetTimeModel(context.Context, *SetTimeModelRequest) (*SetTimeModelResponse, error)
	// contains filtered or unexported methods
}

ConfigManagementServiceServer is the server API for ConfigManagementService service. All implementations must embed UnimplementedConfigManagementServiceServer for forward compatibility

type GetParticipantIdRequest

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

func (*GetParticipantIdRequest) Descriptor deprecated

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

Deprecated: Use GetParticipantIdRequest.ProtoReflect.Descriptor instead.

func (*GetParticipantIdRequest) ProtoMessage

func (*GetParticipantIdRequest) ProtoMessage()

func (*GetParticipantIdRequest) ProtoReflect

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

func (*GetParticipantIdRequest) Reset

func (x *GetParticipantIdRequest) Reset()

func (*GetParticipantIdRequest) String

func (x *GetParticipantIdRequest) String() string

type GetParticipantIdResponse

type GetParticipantIdResponse struct {

	// Identifier of the participant, which SHOULD be globally unique.
	// Must be a valid LedgerString (as describe in “value.proto“).
	ParticipantId string `protobuf:"bytes,1,opt,name=participant_id,json=participantId,proto3" json:"participant_id,omitempty"`
	// contains filtered or unexported fields
}

func (*GetParticipantIdResponse) Descriptor deprecated

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

Deprecated: Use GetParticipantIdResponse.ProtoReflect.Descriptor instead.

func (*GetParticipantIdResponse) GetParticipantId

func (x *GetParticipantIdResponse) GetParticipantId() string

func (*GetParticipantIdResponse) ProtoMessage

func (*GetParticipantIdResponse) ProtoMessage()

func (*GetParticipantIdResponse) ProtoReflect

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

func (*GetParticipantIdResponse) Reset

func (x *GetParticipantIdResponse) Reset()

func (*GetParticipantIdResponse) String

func (x *GetParticipantIdResponse) String() string

type GetPartiesRequest

type GetPartiesRequest struct {

	// The stable, unique identifier of the Daml parties.
	// Must be valid PartyIdStrings (as described in “value.proto“).
	// Required
	Parties []string `protobuf:"bytes,1,rep,name=parties,proto3" json:"parties,omitempty"`
	// contains filtered or unexported fields
}

func (*GetPartiesRequest) Descriptor deprecated

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

Deprecated: Use GetPartiesRequest.ProtoReflect.Descriptor instead.

func (*GetPartiesRequest) GetParties

func (x *GetPartiesRequest) GetParties() []string

func (*GetPartiesRequest) ProtoMessage

func (*GetPartiesRequest) ProtoMessage()

func (*GetPartiesRequest) ProtoReflect

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

func (*GetPartiesRequest) Reset

func (x *GetPartiesRequest) Reset()

func (*GetPartiesRequest) String

func (x *GetPartiesRequest) String() string

type GetPartiesResponse

type GetPartiesResponse struct {

	// The details of the requested Daml parties by the participant, if known.
	// The party details may not be in the same order as requested.
	// Required
	PartyDetails []*PartyDetails `protobuf:"bytes,1,rep,name=party_details,json=partyDetails,proto3" json:"party_details,omitempty"`
	// contains filtered or unexported fields
}

func (*GetPartiesResponse) Descriptor deprecated

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

Deprecated: Use GetPartiesResponse.ProtoReflect.Descriptor instead.

func (*GetPartiesResponse) GetPartyDetails

func (x *GetPartiesResponse) GetPartyDetails() []*PartyDetails

func (*GetPartiesResponse) ProtoMessage

func (*GetPartiesResponse) ProtoMessage()

func (*GetPartiesResponse) ProtoReflect

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

func (*GetPartiesResponse) Reset

func (x *GetPartiesResponse) Reset()

func (*GetPartiesResponse) String

func (x *GetPartiesResponse) String() string

type GetTimeModelRequest

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

func (*GetTimeModelRequest) Descriptor deprecated

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

Deprecated: Use GetTimeModelRequest.ProtoReflect.Descriptor instead.

func (*GetTimeModelRequest) ProtoMessage

func (*GetTimeModelRequest) ProtoMessage()

func (*GetTimeModelRequest) ProtoReflect

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

func (*GetTimeModelRequest) Reset

func (x *GetTimeModelRequest) Reset()

func (*GetTimeModelRequest) String

func (x *GetTimeModelRequest) String() string

type GetTimeModelResponse

type GetTimeModelResponse struct {

	// The current configuration generation. The generation is a monotonically increasing
	// integer that is incremented on each change. Used when setting the time model.
	ConfigurationGeneration int64 `` /* 131-byte string literal not displayed */
	// The current ledger time model.
	TimeModel *TimeModel `protobuf:"bytes,2,opt,name=time_model,json=timeModel,proto3" json:"time_model,omitempty"`
	// contains filtered or unexported fields
}

func (*GetTimeModelResponse) Descriptor deprecated

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

Deprecated: Use GetTimeModelResponse.ProtoReflect.Descriptor instead.

func (*GetTimeModelResponse) GetConfigurationGeneration

func (x *GetTimeModelResponse) GetConfigurationGeneration() int64

func (*GetTimeModelResponse) GetTimeModel

func (x *GetTimeModelResponse) GetTimeModel() *TimeModel

func (*GetTimeModelResponse) ProtoMessage

func (*GetTimeModelResponse) ProtoMessage()

func (*GetTimeModelResponse) ProtoReflect

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

func (*GetTimeModelResponse) Reset

func (x *GetTimeModelResponse) Reset()

func (*GetTimeModelResponse) String

func (x *GetTimeModelResponse) String() string

type ListKnownPackagesRequest

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

func (*ListKnownPackagesRequest) Descriptor deprecated

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

Deprecated: Use ListKnownPackagesRequest.ProtoReflect.Descriptor instead.

func (*ListKnownPackagesRequest) ProtoMessage

func (*ListKnownPackagesRequest) ProtoMessage()

func (*ListKnownPackagesRequest) ProtoReflect

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

func (*ListKnownPackagesRequest) Reset

func (x *ListKnownPackagesRequest) Reset()

func (*ListKnownPackagesRequest) String

func (x *ListKnownPackagesRequest) String() string

type ListKnownPackagesResponse

type ListKnownPackagesResponse struct {

	// The details of all Daml-LF packages known to backing participant.
	// Required
	PackageDetails []*PackageDetails `protobuf:"bytes,1,rep,name=package_details,json=packageDetails,proto3" json:"package_details,omitempty"`
	// contains filtered or unexported fields
}

func (*ListKnownPackagesResponse) Descriptor deprecated

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

Deprecated: Use ListKnownPackagesResponse.ProtoReflect.Descriptor instead.

func (*ListKnownPackagesResponse) GetPackageDetails

func (x *ListKnownPackagesResponse) GetPackageDetails() []*PackageDetails

func (*ListKnownPackagesResponse) ProtoMessage

func (*ListKnownPackagesResponse) ProtoMessage()

func (*ListKnownPackagesResponse) ProtoReflect

func (*ListKnownPackagesResponse) Reset

func (x *ListKnownPackagesResponse) Reset()

func (*ListKnownPackagesResponse) String

func (x *ListKnownPackagesResponse) String() string

type ListKnownPartiesRequest

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

func (*ListKnownPartiesRequest) Descriptor deprecated

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

Deprecated: Use ListKnownPartiesRequest.ProtoReflect.Descriptor instead.

func (*ListKnownPartiesRequest) ProtoMessage

func (*ListKnownPartiesRequest) ProtoMessage()

func (*ListKnownPartiesRequest) ProtoReflect

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

func (*ListKnownPartiesRequest) Reset

func (x *ListKnownPartiesRequest) Reset()

func (*ListKnownPartiesRequest) String

func (x *ListKnownPartiesRequest) String() string

type ListKnownPartiesResponse

type ListKnownPartiesResponse struct {

	// The details of all Daml parties known by the participant.
	// Required
	PartyDetails []*PartyDetails `protobuf:"bytes,1,rep,name=party_details,json=partyDetails,proto3" json:"party_details,omitempty"`
	// contains filtered or unexported fields
}

func (*ListKnownPartiesResponse) Descriptor deprecated

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

Deprecated: Use ListKnownPartiesResponse.ProtoReflect.Descriptor instead.

func (*ListKnownPartiesResponse) GetPartyDetails

func (x *ListKnownPartiesResponse) GetPartyDetails() []*PartyDetails

func (*ListKnownPartiesResponse) ProtoMessage

func (*ListKnownPartiesResponse) ProtoMessage()

func (*ListKnownPartiesResponse) ProtoReflect

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

func (*ListKnownPartiesResponse) Reset

func (x *ListKnownPartiesResponse) Reset()

func (*ListKnownPartiesResponse) String

func (x *ListKnownPartiesResponse) String() string

type PackageDetails

type PackageDetails struct {

	// The identity of the Daml-LF package.
	// Must be a valid PackageIdString (as describe in “value.proto“).
	// Required
	PackageId string `protobuf:"bytes,1,opt,name=package_id,json=packageId,proto3" json:"package_id,omitempty"`
	// Size of the package in bytes.
	// The size of the package is given by the size of the “daml_lf“
	// ArchivePayload. See further details in “daml_lf.proto“.
	// Required
	PackageSize uint64 `protobuf:"varint,2,opt,name=package_size,json=packageSize,proto3" json:"package_size,omitempty"`
	// Indicates since when the package is known to the backing participant.
	// Required
	KnownSince *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=known_since,json=knownSince,proto3" json:"known_since,omitempty"`
	// Description provided by the backing participant describing where
	// it got the package from.
	// Optional
	SourceDescription string `protobuf:"bytes,4,opt,name=source_description,json=sourceDescription,proto3" json:"source_description,omitempty"`
	// contains filtered or unexported fields
}

func (*PackageDetails) Descriptor deprecated

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

Deprecated: Use PackageDetails.ProtoReflect.Descriptor instead.

func (*PackageDetails) GetKnownSince

func (x *PackageDetails) GetKnownSince() *timestamppb.Timestamp

func (*PackageDetails) GetPackageId

func (x *PackageDetails) GetPackageId() string

func (*PackageDetails) GetPackageSize

func (x *PackageDetails) GetPackageSize() uint64

func (*PackageDetails) GetSourceDescription

func (x *PackageDetails) GetSourceDescription() string

func (*PackageDetails) ProtoMessage

func (*PackageDetails) ProtoMessage()

func (*PackageDetails) ProtoReflect

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

func (*PackageDetails) Reset

func (x *PackageDetails) Reset()

func (*PackageDetails) String

func (x *PackageDetails) String() string

type PackageManagementServiceClient

type PackageManagementServiceClient interface {
	// Returns the details of all Daml-LF packages known to the backing participant.
	// Errors:
	// - “UNAUTHENTICATED“: if the request does not include a valid access token
	// - “PERMISSION_DENIED“: if the claims in the token are insufficient to perform a given operation
	ListKnownPackages(ctx context.Context, in *ListKnownPackagesRequest, opts ...grpc.CallOption) (*ListKnownPackagesResponse, error)
	// Upload a DAR file to the backing participant.
	// Depending on the ledger implementation this might also make the package
	// available on the whole ledger. This call might not be supported by some
	// ledger implementations. Canton could be an example, where uploading a DAR
	// is not sufficient to render it usable, it must be activated first.
	// This call may:
	// - Succeed, if the package was successfully uploaded, or if the same package
	//   was already uploaded before.
	// - Respond with a gRPC error
	// Errors:
	// - “UNAUTHENTICATED“: if the request does not include a valid access token
	// - “PERMISSION_DENIED“: if the claims in the token are insufficient to perform a given operation
	// - “UNIMPLEMENTED“: if DAR package uploading is not supported by the backing participant
	// - “INVALID_ARGUMENT“: if the DAR file is too big or malformed. The maximum supported size is implementation specific.
	UploadDarFile(ctx context.Context, in *UploadDarFileRequest, opts ...grpc.CallOption) (*UploadDarFileResponse, error)
}

PackageManagementServiceClient is the client API for PackageManagementService service.

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

type PackageManagementServiceServer

type PackageManagementServiceServer interface {
	// Returns the details of all Daml-LF packages known to the backing participant.
	// Errors:
	// - “UNAUTHENTICATED“: if the request does not include a valid access token
	// - “PERMISSION_DENIED“: if the claims in the token are insufficient to perform a given operation
	ListKnownPackages(context.Context, *ListKnownPackagesRequest) (*ListKnownPackagesResponse, error)
	// Upload a DAR file to the backing participant.
	// Depending on the ledger implementation this might also make the package
	// available on the whole ledger. This call might not be supported by some
	// ledger implementations. Canton could be an example, where uploading a DAR
	// is not sufficient to render it usable, it must be activated first.
	// This call may:
	// - Succeed, if the package was successfully uploaded, or if the same package
	//   was already uploaded before.
	// - Respond with a gRPC error
	// Errors:
	// - “UNAUTHENTICATED“: if the request does not include a valid access token
	// - “PERMISSION_DENIED“: if the claims in the token are insufficient to perform a given operation
	// - “UNIMPLEMENTED“: if DAR package uploading is not supported by the backing participant
	// - “INVALID_ARGUMENT“: if the DAR file is too big or malformed. The maximum supported size is implementation specific.
	UploadDarFile(context.Context, *UploadDarFileRequest) (*UploadDarFileResponse, error)
	// contains filtered or unexported methods
}

PackageManagementServiceServer is the server API for PackageManagementService service. All implementations must embed UnimplementedPackageManagementServiceServer for forward compatibility

type ParticipantPruningServiceClient

type ParticipantPruningServiceClient interface {
	// Prune the ledger specifying the offset before and at which ledger transactions should be removed. Only returns when
	// the potentially long-running prune request ends successfully or with one of the following errors:
	// - “INVALID_ARGUMENT“: if the payload, particularly the offset is malformed or missing
	// - “UNIMPLEMENTED“: if the participant is based on a ledger that has not implemented pruning
	// - “INTERNAL“: if the participant has encountered a failure and has potentially applied pruning partially. Such cases
	//   warrant verifying the participant health before retrying the prune with the same (or a larger, valid) offset.
	//   Successful retries after such errors ensure that different components reach a consistent pruning state.
	//
	// Other GRPC errors can be returned depending on the type of condition preventing a prune:
	// - “OUT_OF_RANGE“: if the participant is not yet able to prune at the specified offset, but without user intervention
	//   the offset will eventually be usable for pruning.
	// - “FAILED_PRECONDITION“ if some sort of user intervention is required before pruning can proceed at the specified
	//   offset.
	Prune(ctx context.Context, in *PruneRequest, opts ...grpc.CallOption) (*PruneResponse, error)
}

ParticipantPruningServiceClient is the client API for ParticipantPruningService service.

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

type ParticipantPruningServiceServer

type ParticipantPruningServiceServer interface {
	// Prune the ledger specifying the offset before and at which ledger transactions should be removed. Only returns when
	// the potentially long-running prune request ends successfully or with one of the following errors:
	// - “INVALID_ARGUMENT“: if the payload, particularly the offset is malformed or missing
	// - “UNIMPLEMENTED“: if the participant is based on a ledger that has not implemented pruning
	// - “INTERNAL“: if the participant has encountered a failure and has potentially applied pruning partially. Such cases
	//   warrant verifying the participant health before retrying the prune with the same (or a larger, valid) offset.
	//   Successful retries after such errors ensure that different components reach a consistent pruning state.
	//
	// Other GRPC errors can be returned depending on the type of condition preventing a prune:
	// - “OUT_OF_RANGE“: if the participant is not yet able to prune at the specified offset, but without user intervention
	//   the offset will eventually be usable for pruning.
	// - “FAILED_PRECONDITION“ if some sort of user intervention is required before pruning can proceed at the specified
	//   offset.
	Prune(context.Context, *PruneRequest) (*PruneResponse, error)
	// contains filtered or unexported methods
}

ParticipantPruningServiceServer is the server API for ParticipantPruningService service. All implementations must embed UnimplementedParticipantPruningServiceServer for forward compatibility

type PartyDetails

type PartyDetails struct {

	// The stable unique identifier of a Daml party.
	// Must be a valid PartyIdString (as described in “value.proto“).
	// Required
	Party string `protobuf:"bytes,1,opt,name=party,proto3" json:"party,omitempty"`
	// Human readable name associated with the party. Caution, it might not be
	// unique.
	// Optional
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// true if party is hosted by the backing participant.
	// Required
	IsLocal bool `protobuf:"varint,3,opt,name=is_local,json=isLocal,proto3" json:"is_local,omitempty"`
	// contains filtered or unexported fields
}

func (*PartyDetails) Descriptor deprecated

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

Deprecated: Use PartyDetails.ProtoReflect.Descriptor instead.

func (*PartyDetails) GetDisplayName

func (x *PartyDetails) GetDisplayName() string

func (*PartyDetails) GetIsLocal

func (x *PartyDetails) GetIsLocal() bool

func (*PartyDetails) GetParty

func (x *PartyDetails) GetParty() string

func (*PartyDetails) ProtoMessage

func (*PartyDetails) ProtoMessage()

func (*PartyDetails) ProtoReflect

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

func (*PartyDetails) Reset

func (x *PartyDetails) Reset()

func (*PartyDetails) String

func (x *PartyDetails) String() string

type PartyManagementServiceClient

type PartyManagementServiceClient interface {
	// Return the identifier of the backing participant.
	// All horizontally scaled replicas should return the same id.
	// daml-on-sql: returns an identifier supplied on command line at launch time
	// daml-on-kv-ledger: as above
	// canton: returns globally unique identifier of the backing participant
	// Errors:
	// - “UNAUTHENTICATED“: if the request does not include a valid access token
	// - “PERMISSION_DENIED“: if the claims in the token are insufficient to perform a given operation
	GetParticipantId(ctx context.Context, in *GetParticipantIdRequest, opts ...grpc.CallOption) (*GetParticipantIdResponse, error)
	// Get the party details of the given parties. Only known parties will be
	// returned in the list.
	// Errors:
	// - “UNAUTHENTICATED“: if the request does not include a valid access token
	// - “PERMISSION_DENIED“: if the claims in the token are insufficient to perform a given operation
	GetParties(ctx context.Context, in *GetPartiesRequest, opts ...grpc.CallOption) (*GetPartiesResponse, error)
	// List the parties known by the backing participant.
	// The list returned contains parties whose ledger access is facilitated by
	// backing participant and the ones maintained elsewhere.
	// Errors:
	// - “UNAUTHENTICATED“: if the request does not include a valid access token
	// - “PERMISSION_DENIED“: if the claims in the token are insufficient to perform a given operation
	ListKnownParties(ctx context.Context, in *ListKnownPartiesRequest, opts ...grpc.CallOption) (*ListKnownPartiesResponse, error)
	// Adds a new party to the set managed by the backing participant.
	// Caller specifies a party identifier suggestion, the actual identifier
	// allocated might be different and is implementation specific.
	// This call may:
	// - Succeed, in which case the actual allocated identifier is visible in
	//   the response.
	// - Respond with a gRPC error
	// Errors:
	// - “UNAUTHENTICATED“: if the request does not include a valid access token
	// - “PERMISSION_DENIED“: if the claims in the token are insufficient to perform a given operation
	// - “UNIMPLEMENTED“: if synchronous party allocation is not supported by the backing participant
	// - “INVALID_ARGUMENT“: if the provided hint and/or display name is invalid on the given ledger (see below).
	// daml-on-sql: suggestion's uniqueness is checked and call rejected if the identifier is already present
	// daml-on-kv-ledger: suggestion's uniqueness is checked by the validators in
	// the consensus layer and call rejected if the identifier is already present.
	// canton: completely different globally unique identifier is allocated.
	// Behind the scenes calls to an internal protocol are made. As that protocol
	// is richer than the surface protocol, the arguments take implicit values
	// The party identifier suggestion must be a valid party name. Party names are required to be non-empty US-ASCII strings built from letters, digits, space,
	// colon, minus and underscore limited to 255 chars
	AllocateParty(ctx context.Context, in *AllocatePartyRequest, opts ...grpc.CallOption) (*AllocatePartyResponse, error)
}

PartyManagementServiceClient is the client API for PartyManagementService service.

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

type PartyManagementServiceServer

type PartyManagementServiceServer interface {
	// Return the identifier of the backing participant.
	// All horizontally scaled replicas should return the same id.
	// daml-on-sql: returns an identifier supplied on command line at launch time
	// daml-on-kv-ledger: as above
	// canton: returns globally unique identifier of the backing participant
	// Errors:
	// - “UNAUTHENTICATED“: if the request does not include a valid access token
	// - “PERMISSION_DENIED“: if the claims in the token are insufficient to perform a given operation
	GetParticipantId(context.Context, *GetParticipantIdRequest) (*GetParticipantIdResponse, error)
	// Get the party details of the given parties. Only known parties will be
	// returned in the list.
	// Errors:
	// - “UNAUTHENTICATED“: if the request does not include a valid access token
	// - “PERMISSION_DENIED“: if the claims in the token are insufficient to perform a given operation
	GetParties(context.Context, *GetPartiesRequest) (*GetPartiesResponse, error)
	// List the parties known by the backing participant.
	// The list returned contains parties whose ledger access is facilitated by
	// backing participant and the ones maintained elsewhere.
	// Errors:
	// - “UNAUTHENTICATED“: if the request does not include a valid access token
	// - “PERMISSION_DENIED“: if the claims in the token are insufficient to perform a given operation
	ListKnownParties(context.Context, *ListKnownPartiesRequest) (*ListKnownPartiesResponse, error)
	// Adds a new party to the set managed by the backing participant.
	// Caller specifies a party identifier suggestion, the actual identifier
	// allocated might be different and is implementation specific.
	// This call may:
	// - Succeed, in which case the actual allocated identifier is visible in
	//   the response.
	// - Respond with a gRPC error
	// Errors:
	// - “UNAUTHENTICATED“: if the request does not include a valid access token
	// - “PERMISSION_DENIED“: if the claims in the token are insufficient to perform a given operation
	// - “UNIMPLEMENTED“: if synchronous party allocation is not supported by the backing participant
	// - “INVALID_ARGUMENT“: if the provided hint and/or display name is invalid on the given ledger (see below).
	// daml-on-sql: suggestion's uniqueness is checked and call rejected if the identifier is already present
	// daml-on-kv-ledger: suggestion's uniqueness is checked by the validators in
	// the consensus layer and call rejected if the identifier is already present.
	// canton: completely different globally unique identifier is allocated.
	// Behind the scenes calls to an internal protocol are made. As that protocol
	// is richer than the surface protocol, the arguments take implicit values
	// The party identifier suggestion must be a valid party name. Party names are required to be non-empty US-ASCII strings built from letters, digits, space,
	// colon, minus and underscore limited to 255 chars
	AllocateParty(context.Context, *AllocatePartyRequest) (*AllocatePartyResponse, error)
	// contains filtered or unexported methods
}

PartyManagementServiceServer is the server API for PartyManagementService service. All implementations must embed UnimplementedPartyManagementServiceServer for forward compatibility

type PruneRequest

type PruneRequest struct {

	// Inclusive offset up to and at which the ledger is to be pruned.
	PruneUpTo string `protobuf:"bytes,1,opt,name=prune_up_to,json=pruneUpTo,proto3" json:"prune_up_to,omitempty"`
	// Unique submission identifier.
	// Optional, defaults to a random identifier, used for logging.
	SubmissionId string `protobuf:"bytes,2,opt,name=submission_id,json=submissionId,proto3" json:"submission_id,omitempty"`
	// contains filtered or unexported fields
}

func (*PruneRequest) Descriptor deprecated

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

Deprecated: Use PruneRequest.ProtoReflect.Descriptor instead.

func (*PruneRequest) GetPruneUpTo

func (x *PruneRequest) GetPruneUpTo() string

func (*PruneRequest) GetSubmissionId

func (x *PruneRequest) GetSubmissionId() string

func (*PruneRequest) ProtoMessage

func (*PruneRequest) ProtoMessage()

func (*PruneRequest) ProtoReflect

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

func (*PruneRequest) Reset

func (x *PruneRequest) Reset()

func (*PruneRequest) String

func (x *PruneRequest) String() string

type PruneResponse

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

func (*PruneResponse) Descriptor deprecated

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

Deprecated: Use PruneResponse.ProtoReflect.Descriptor instead.

func (*PruneResponse) ProtoMessage

func (*PruneResponse) ProtoMessage()

func (*PruneResponse) ProtoReflect

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

func (*PruneResponse) Reset

func (x *PruneResponse) Reset()

func (*PruneResponse) String

func (x *PruneResponse) String() string

type SetTimeModelRequest

type SetTimeModelRequest struct {

	// Submission identifier used for tracking the request and to reject
	// duplicate submissions.
	// Required.
	SubmissionId string `protobuf:"bytes,1,opt,name=submission_id,json=submissionId,proto3" json:"submission_id,omitempty"`
	// Deadline for the configuration change after which the change is rejected.
	MaximumRecordTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=maximum_record_time,json=maximumRecordTime,proto3" json:"maximum_record_time,omitempty"`
	// The current configuration generation which we're submitting the change against.
	// This is used to perform a compare-and-swap of the configuration to
	// safeguard against concurrent modifications.
	// Required.
	ConfigurationGeneration int64 `` /* 131-byte string literal not displayed */
	// The new time model that replaces the current one.
	// Required.
	NewTimeModel *TimeModel `protobuf:"bytes,4,opt,name=new_time_model,json=newTimeModel,proto3" json:"new_time_model,omitempty"`
	// contains filtered or unexported fields
}

func (*SetTimeModelRequest) Descriptor deprecated

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

Deprecated: Use SetTimeModelRequest.ProtoReflect.Descriptor instead.

func (*SetTimeModelRequest) GetConfigurationGeneration

func (x *SetTimeModelRequest) GetConfigurationGeneration() int64

func (*SetTimeModelRequest) GetMaximumRecordTime

func (x *SetTimeModelRequest) GetMaximumRecordTime() *timestamppb.Timestamp

func (*SetTimeModelRequest) GetNewTimeModel

func (x *SetTimeModelRequest) GetNewTimeModel() *TimeModel

func (*SetTimeModelRequest) GetSubmissionId

func (x *SetTimeModelRequest) GetSubmissionId() string

func (*SetTimeModelRequest) ProtoMessage

func (*SetTimeModelRequest) ProtoMessage()

func (*SetTimeModelRequest) ProtoReflect

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

func (*SetTimeModelRequest) Reset

func (x *SetTimeModelRequest) Reset()

func (*SetTimeModelRequest) String

func (x *SetTimeModelRequest) String() string

type SetTimeModelResponse

type SetTimeModelResponse struct {

	// The configuration generation of the committed time model.
	ConfigurationGeneration int64 `` /* 131-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*SetTimeModelResponse) Descriptor deprecated

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

Deprecated: Use SetTimeModelResponse.ProtoReflect.Descriptor instead.

func (*SetTimeModelResponse) GetConfigurationGeneration

func (x *SetTimeModelResponse) GetConfigurationGeneration() int64

func (*SetTimeModelResponse) ProtoMessage

func (*SetTimeModelResponse) ProtoMessage()

func (*SetTimeModelResponse) ProtoReflect

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

func (*SetTimeModelResponse) Reset

func (x *SetTimeModelResponse) Reset()

func (*SetTimeModelResponse) String

func (x *SetTimeModelResponse) String() string

type TimeModel

type TimeModel struct {

	// The expected average latency of a transaction, i.e., the average time
	// from submitting the transaction to a [[WriteService]] and the transaction
	// being assigned a record time.
	// Required.
	AvgTransactionLatency *durationpb.Duration `` /* 126-byte string literal not displayed */
	// The minimimum skew between ledger time and record time: lt_TX >= rt_TX - minSkew
	// Required.
	MinSkew *durationpb.Duration `protobuf:"bytes,5,opt,name=min_skew,json=minSkew,proto3" json:"min_skew,omitempty"`
	// The maximum skew between ledger time and record time: lt_TX <= rt_TX + maxSkew
	// Required.
	MaxSkew *durationpb.Duration `protobuf:"bytes,6,opt,name=max_skew,json=maxSkew,proto3" json:"max_skew,omitempty"`
	// contains filtered or unexported fields
}

func (*TimeModel) Descriptor deprecated

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

Deprecated: Use TimeModel.ProtoReflect.Descriptor instead.

func (*TimeModel) GetAvgTransactionLatency

func (x *TimeModel) GetAvgTransactionLatency() *durationpb.Duration

func (*TimeModel) GetMaxSkew

func (x *TimeModel) GetMaxSkew() *durationpb.Duration

func (*TimeModel) GetMinSkew

func (x *TimeModel) GetMinSkew() *durationpb.Duration

func (*TimeModel) ProtoMessage

func (*TimeModel) ProtoMessage()

func (*TimeModel) ProtoReflect

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

func (*TimeModel) Reset

func (x *TimeModel) Reset()

func (*TimeModel) String

func (x *TimeModel) String() string

type UnimplementedConfigManagementServiceServer

type UnimplementedConfigManagementServiceServer struct {
}

UnimplementedConfigManagementServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedConfigManagementServiceServer) GetTimeModel

func (UnimplementedConfigManagementServiceServer) SetTimeModel

type UnimplementedPackageManagementServiceServer

type UnimplementedPackageManagementServiceServer struct {
}

UnimplementedPackageManagementServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedPackageManagementServiceServer) ListKnownPackages

func (UnimplementedPackageManagementServiceServer) UploadDarFile

type UnimplementedParticipantPruningServiceServer

type UnimplementedParticipantPruningServiceServer struct {
}

UnimplementedParticipantPruningServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedParticipantPruningServiceServer) Prune

type UnimplementedPartyManagementServiceServer

type UnimplementedPartyManagementServiceServer struct {
}

UnimplementedPartyManagementServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedPartyManagementServiceServer) AllocateParty

func (UnimplementedPartyManagementServiceServer) GetParticipantId

func (UnimplementedPartyManagementServiceServer) GetParties

func (UnimplementedPartyManagementServiceServer) ListKnownParties

type UnsafeConfigManagementServiceServer

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

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

type UnsafePackageManagementServiceServer

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

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

type UnsafeParticipantPruningServiceServer

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

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

type UnsafePartyManagementServiceServer

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

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

type UploadDarFileRequest

type UploadDarFileRequest struct {

	// Contains a Daml archive DAR file, which in turn is a jar like zipped
	// container for “daml_lf“ archives. See further details in
	// “daml_lf.proto“.
	// Required
	DarFile []byte `protobuf:"bytes,1,opt,name=dar_file,json=darFile,proto3" json:"dar_file,omitempty"`
	// Unique submission identifier.
	// Optional, defaults to a random identifier.
	SubmissionId string `protobuf:"bytes,2,opt,name=submission_id,json=submissionId,proto3" json:"submission_id,omitempty"`
	// contains filtered or unexported fields
}

func (*UploadDarFileRequest) Descriptor deprecated

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

Deprecated: Use UploadDarFileRequest.ProtoReflect.Descriptor instead.

func (*UploadDarFileRequest) GetDarFile

func (x *UploadDarFileRequest) GetDarFile() []byte

func (*UploadDarFileRequest) GetSubmissionId

func (x *UploadDarFileRequest) GetSubmissionId() string

func (*UploadDarFileRequest) ProtoMessage

func (*UploadDarFileRequest) ProtoMessage()

func (*UploadDarFileRequest) ProtoReflect

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

func (*UploadDarFileRequest) Reset

func (x *UploadDarFileRequest) Reset()

func (*UploadDarFileRequest) String

func (x *UploadDarFileRequest) String() string

type UploadDarFileResponse

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

An empty message that is received when the upload operation succeeded.

func (*UploadDarFileResponse) Descriptor deprecated

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

Deprecated: Use UploadDarFileResponse.ProtoReflect.Descriptor instead.

func (*UploadDarFileResponse) ProtoMessage

func (*UploadDarFileResponse) ProtoMessage()

func (*UploadDarFileResponse) ProtoReflect

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

func (*UploadDarFileResponse) Reset

func (x *UploadDarFileResponse) Reset()

func (*UploadDarFileResponse) String

func (x *UploadDarFileResponse) String() string

Jump to

Keyboard shortcuts

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