admin

package
v7.11.0 Latest Latest
Warning

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

 Go to latest Published: May 1, 2023 License: Apache-2.0 Imports: 12 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_metering_report_service_proto protoreflect.FileDescriptor
View Source 
var File_com_daml_ledger_api_v1_admin_object_meta_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 File_com_daml_ledger_api_v1_admin_user_management_service_proto protoreflect.FileDescriptor
View Source 
var MeteringReportService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "com.daml.ledger.api.v1.admin.MeteringReportService",
	HandlerType: (*MeteringReportServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetMeteringReport",
			Handler:    _MeteringReportService_GetMeteringReport_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "com/daml/ledger/api/v1/admin/metering_report_service.proto",
}

MeteringReportService_ServiceDesc is the grpc.ServiceDesc for MeteringReportService 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 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,
		},
		{
			MethodName: "UpdatePartyDetails",
			Handler:    _PartyManagementService_UpdatePartyDetails_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)

View Source 
var UserManagementService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "com.daml.ledger.api.v1.admin.UserManagementService",
	HandlerType: (*UserManagementServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateUser",
			Handler:    _UserManagementService_CreateUser_Handler,
		},
		{
			MethodName: "GetUser",
			Handler:    _UserManagementService_GetUser_Handler,
		},
		{
			MethodName: "UpdateUser",
			Handler:    _UserManagementService_UpdateUser_Handler,
		},
		{
			MethodName: "DeleteUser",
			Handler:    _UserManagementService_DeleteUser_Handler,
		},
		{
			MethodName: "ListUsers",
			Handler:    _UserManagementService_ListUsers_Handler,
		},
		{
			MethodName: "GrantUserRights",
			Handler:    _UserManagementService_GrantUserRights_Handler,
		},
		{
			MethodName: "RevokeUserRights",
			Handler:    _UserManagementService_RevokeUserRights_Handler,
		},
		{
			MethodName: "ListUserRights",
			Handler:    _UserManagementService_ListUserRights_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "com/daml/ledger/api/v1/admin/user_management_service.proto",
}

UserManagementService_ServiceDesc is the grpc.ServiceDesc for UserManagementService 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 RegisterMeteringReportServiceServer 

func RegisterMeteringReportServiceServer(s grpc.ServiceRegistrar, srv MeteringReportServiceServer)

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)

func RegisterUserManagementServiceServer 

func RegisterUserManagementServiceServer(s grpc.ServiceRegistrar, srv UserManagementServiceServer)

Types

type AllocatePartyRequest 

type AllocatePartyRequest struct {

	// A hint to the 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.
	// Use of this field is discouraged. Use “local_metadata“ instead.
	// Optional
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Participant-local metadata to be stored in the “PartyDetails“ of this newly allocated party.
	// Optional
	LocalMetadata *ObjectMeta `protobuf:"bytes,3,opt,name=local_metadata,json=localMetadata,proto3" json:"local_metadata,omitempty"`
	// contains filtered or unexported fields
}

Required authorization: “HasRight(ParticipantAdmin)“

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) GetLocalMetadata added in v7.10.0 

func (x *AllocatePartyRequest) GetLocalMetadata() *ObjectMeta

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.
	GetTimeModel(ctx context.Context, in *GetTimeModelRequest, opts ...grpc.CallOption) (*GetTimeModelResponse, error)
	// Set the ledger time model.
	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.

func NewConfigManagementServiceClient 

func NewConfigManagementServiceClient(cc grpc.ClientConnInterface) ConfigManagementServiceClient

type ConfigManagementServiceServer 

type ConfigManagementServiceServer interface {
	// Return the currently active time model and the current configuration generation.
	GetTimeModel(context.Context, *GetTimeModelRequest) (*GetTimeModelResponse, error)
	// Set the ledger time model.
	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 CreateUserRequest 

type CreateUserRequest struct {

	// The user to create.
	// Required
	User *User `protobuf:"bytes,1,opt,name=user,proto3" json:"user,omitempty"`
	// The rights to be assigned to the user upon creation,
	// which SHOULD include appropriate rights for the “user.primary_party“.
	// Optional
	Rights []*Right `protobuf:"bytes,2,rep,name=rights,proto3" json:"rights,omitempty"`
	// contains filtered or unexported fields
}

Required authorization: “HasRight(ParticipantAdmin)“

func (*CreateUserRequest) Descriptor deprecated 

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

Deprecated: Use CreateUserRequest.ProtoReflect.Descriptor instead.

func (*CreateUserRequest) GetRights 

func (x *CreateUserRequest) GetRights() []*Right

func (*CreateUserRequest) GetUser 

func (x *CreateUserRequest) GetUser() *User

func (*CreateUserRequest) ProtoMessage 

func (*CreateUserRequest) ProtoMessage()

func (*CreateUserRequest) ProtoReflect 

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

func (*CreateUserRequest) Reset 

func (x *CreateUserRequest) Reset()

func (*CreateUserRequest) String 

func (x *CreateUserRequest) String() string

type CreateUserResponse added in v7.6.3 

type CreateUserResponse struct {

	// Created user.
	User *User `protobuf:"bytes,1,opt,name=user,proto3" json:"user,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateUserResponse) Descriptor deprecated added in v7.6.3 

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

Deprecated: Use CreateUserResponse.ProtoReflect.Descriptor instead.

func (*CreateUserResponse) GetUser added in v7.6.3 

func (x *CreateUserResponse) GetUser() *User

func (*CreateUserResponse) ProtoMessage added in v7.6.3 

func (*CreateUserResponse) ProtoMessage()

func (*CreateUserResponse) ProtoReflect added in v7.6.3 

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

func (*CreateUserResponse) Reset added in v7.6.3 

func (x *CreateUserResponse) Reset()

func (*CreateUserResponse) String added in v7.6.3 

func (x *CreateUserResponse) String() string

type DeleteUserRequest 

type DeleteUserRequest struct {

	// The user to delete.
	// Required
	UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// contains filtered or unexported fields
}

Required authorization: “HasRight(ParticipantAdmin)“

func (*DeleteUserRequest) Descriptor deprecated 

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

Deprecated: Use DeleteUserRequest.ProtoReflect.Descriptor instead.

func (*DeleteUserRequest) GetUserId 

func (x *DeleteUserRequest) GetUserId() string

func (*DeleteUserRequest) ProtoMessage 

func (*DeleteUserRequest) ProtoMessage()

func (*DeleteUserRequest) ProtoReflect 

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

func (*DeleteUserRequest) Reset 

func (x *DeleteUserRequest) Reset()

func (*DeleteUserRequest) String 

func (x *DeleteUserRequest) String() string

type DeleteUserResponse 

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

Does not (yet) contain any data.

func (*DeleteUserResponse) Descriptor deprecated 

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

Deprecated: Use DeleteUserResponse.ProtoReflect.Descriptor instead.

func (*DeleteUserResponse) ProtoMessage 

func (*DeleteUserResponse) ProtoMessage()

func (*DeleteUserResponse) ProtoReflect 

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

func (*DeleteUserResponse) Reset 

func (x *DeleteUserResponse) Reset()

func (*DeleteUserResponse) String 

func (x *DeleteUserResponse) String() string

type GetMeteringReportRequest 

type GetMeteringReportRequest struct {

	// The from timestamp (inclusive).
	// Required.
	From *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=from,proto3" json:"from,omitempty"`
	// The to timestamp (exclusive).
	// If not provided, the server will default to its current time.
	To *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=to,proto3" json:"to,omitempty"`
	// If set to a non-empty value, then the report will only be generated for that application.
	// Optional.
	ApplicationId string `protobuf:"bytes,3,opt,name=application_id,json=applicationId,proto3" json:"application_id,omitempty"`
	// contains filtered or unexported fields
}

Authorized if and only if the authenticated user is a participant admin.

func (*GetMeteringReportRequest) Descriptor deprecated 

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

Deprecated: Use GetMeteringReportRequest.ProtoReflect.Descriptor instead.

func (*GetMeteringReportRequest) GetApplicationId 

func (x *GetMeteringReportRequest) GetApplicationId() string

func (*GetMeteringReportRequest) GetFrom 

func (x *GetMeteringReportRequest) GetFrom() *timestamppb.Timestamp

func (*GetMeteringReportRequest) GetTo 

func (x *GetMeteringReportRequest) GetTo() *timestamppb.Timestamp

func (*GetMeteringReportRequest) ProtoMessage 

func (*GetMeteringReportRequest) ProtoMessage()

func (*GetMeteringReportRequest) ProtoReflect 

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

func (*GetMeteringReportRequest) Reset 

func (x *GetMeteringReportRequest) Reset()

func (*GetMeteringReportRequest) String 

func (x *GetMeteringReportRequest) String() string

type GetMeteringReportResponse 

type GetMeteringReportResponse struct {

	// The actual request that was executed.
	Request *GetMeteringReportRequest `protobuf:"bytes,1,opt,name=request,proto3" json:"request,omitempty"`
	// The time at which the report was computed.
	ReportGenerationTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=report_generation_time,json=reportGenerationTime,proto3" json:"report_generation_time,omitempty"`
	// The metering report json
	MeteringReportJson *structpb.Struct `protobuf:"bytes,4,opt,name=metering_report_json,json=meteringReportJson,proto3" json:"metering_report_json,omitempty"`
	// contains filtered or unexported fields
}

func (*GetMeteringReportResponse) Descriptor deprecated 

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

Deprecated: Use GetMeteringReportResponse.ProtoReflect.Descriptor instead.

func (*GetMeteringReportResponse) GetMeteringReportJson added in v7.10.0 

func (x *GetMeteringReportResponse) GetMeteringReportJson() *structpb.Struct

func (*GetMeteringReportResponse) GetReportGenerationTime 

func (x *GetMeteringReportResponse) GetReportGenerationTime() *timestamppb.Timestamp

func (*GetMeteringReportResponse) GetRequest 

func (x *GetMeteringReportResponse) GetRequest() *GetMeteringReportRequest

func (*GetMeteringReportResponse) ProtoMessage 

func (*GetMeteringReportResponse) ProtoMessage()

func (*GetMeteringReportResponse) ProtoReflect 

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

func (*GetMeteringReportResponse) Reset 

func (x *GetMeteringReportResponse) Reset()

func (*GetMeteringReportResponse) String 

func (x *GetMeteringReportResponse) String() string

type GetParticipantIdRequest 

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

Required authorization: “HasRight(ParticipantAdmin)“

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
}

Required authorization: “HasRight(ParticipantAdmin)“

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 GetUserRequest 

type GetUserRequest struct {

	// The user whose data to retrieve.
	// If set to empty string (the default), then the data for the authenticated user will be retrieved.
	// Required
	UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// contains filtered or unexported fields
}

Required authorization: “HasRight(ParticipantAdmin) OR IsAuthenticatedUser(user_id)“

func (*GetUserRequest) Descriptor deprecated 

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

Deprecated: Use GetUserRequest.ProtoReflect.Descriptor instead.

func (*GetUserRequest) GetUserId 

func (x *GetUserRequest) GetUserId() string

func (*GetUserRequest) ProtoMessage 

func (*GetUserRequest) ProtoMessage()

func (*GetUserRequest) ProtoReflect 

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

func (*GetUserRequest) Reset 

func (x *GetUserRequest) Reset()

func (*GetUserRequest) String 

func (x *GetUserRequest) String() string

type GetUserResponse added in v7.6.3 

type GetUserResponse struct {

	// Retrieved user.
	User *User `protobuf:"bytes,1,opt,name=user,proto3" json:"user,omitempty"`
	// contains filtered or unexported fields
}

func (*GetUserResponse) Descriptor deprecated added in v7.6.3 

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

Deprecated: Use GetUserResponse.ProtoReflect.Descriptor instead.

func (*GetUserResponse) GetUser added in v7.6.3 

func (x *GetUserResponse) GetUser() *User

func (*GetUserResponse) ProtoMessage added in v7.6.3 

func (*GetUserResponse) ProtoMessage()

func (*GetUserResponse) ProtoReflect added in v7.6.3 

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

func (*GetUserResponse) Reset added in v7.6.3 

func (x *GetUserResponse) Reset()

func (*GetUserResponse) String added in v7.6.3 

func (x *GetUserResponse) String() string

type GrantUserRightsRequest 

type GrantUserRightsRequest struct {

	// The user to whom to grant rights.
	// Required
	UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// The rights to grant.
	// Optional
	Rights []*Right `protobuf:"bytes,2,rep,name=rights,proto3" json:"rights,omitempty"`
	// contains filtered or unexported fields
}

Add the rights to the set of rights granted to the user.

Required authorization: “HasRight(ParticipantAdmin)“

func (*GrantUserRightsRequest) Descriptor deprecated 

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

Deprecated: Use GrantUserRightsRequest.ProtoReflect.Descriptor instead.

func (*GrantUserRightsRequest) GetRights 

func (x *GrantUserRightsRequest) GetRights() []*Right

func (*GrantUserRightsRequest) GetUserId 

func (x *GrantUserRightsRequest) GetUserId() string

func (*GrantUserRightsRequest) ProtoMessage 

func (*GrantUserRightsRequest) ProtoMessage()

func (*GrantUserRightsRequest) ProtoReflect 

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

func (*GrantUserRightsRequest) Reset 

func (x *GrantUserRightsRequest) Reset()

func (*GrantUserRightsRequest) String 

func (x *GrantUserRightsRequest) String() string

type GrantUserRightsResponse 

type GrantUserRightsResponse struct {

	// The rights that were newly granted by the request.
	NewlyGrantedRights []*Right `protobuf:"bytes,1,rep,name=newly_granted_rights,json=newlyGrantedRights,proto3" json:"newly_granted_rights,omitempty"`
	// contains filtered or unexported fields
}

func (*GrantUserRightsResponse) Descriptor deprecated 

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

Deprecated: Use GrantUserRightsResponse.ProtoReflect.Descriptor instead.

func (*GrantUserRightsResponse) GetNewlyGrantedRights 

func (x *GrantUserRightsResponse) GetNewlyGrantedRights() []*Right

func (*GrantUserRightsResponse) ProtoMessage 

func (*GrantUserRightsResponse) ProtoMessage()

func (*GrantUserRightsResponse) ProtoReflect 

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

func (*GrantUserRightsResponse) Reset 

func (x *GrantUserRightsResponse) Reset()

func (*GrantUserRightsResponse) String 

func (x *GrantUserRightsResponse) 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 (x *ListKnownPackagesResponse) ProtoReflect() protoreflect.Message

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
}

Required authorization: “HasRight(ParticipantAdmin)“

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 ListUserRightsRequest 

type ListUserRightsRequest struct {

	// The user for which to list the rights.
	// If set to empty string (the default), then the rights for the authenticated user will be listed.
	// Required
	UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// contains filtered or unexported fields
}

Required authorization: “HasRight(ParticipantAdmin) OR IsAuthenticatedUser(user_id)“

func (*ListUserRightsRequest) Descriptor deprecated 

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

Deprecated: Use ListUserRightsRequest.ProtoReflect.Descriptor instead.

func (*ListUserRightsRequest) GetUserId 

func (x *ListUserRightsRequest) GetUserId() string

func (*ListUserRightsRequest) ProtoMessage 

func (*ListUserRightsRequest) ProtoMessage()

func (*ListUserRightsRequest) ProtoReflect 

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

func (*ListUserRightsRequest) Reset 

func (x *ListUserRightsRequest) Reset()

func (*ListUserRightsRequest) String 

func (x *ListUserRightsRequest) String() string

type ListUserRightsResponse 

type ListUserRightsResponse struct {

	// All rights of the user.
	Rights []*Right `protobuf:"bytes,1,rep,name=rights,proto3" json:"rights,omitempty"`
	// contains filtered or unexported fields
}

func (*ListUserRightsResponse) Descriptor deprecated 

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

Deprecated: Use ListUserRightsResponse.ProtoReflect.Descriptor instead.

func (*ListUserRightsResponse) GetRights 

func (x *ListUserRightsResponse) GetRights() []*Right

func (*ListUserRightsResponse) ProtoMessage 

func (*ListUserRightsResponse) ProtoMessage()

func (*ListUserRightsResponse) ProtoReflect 

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

func (*ListUserRightsResponse) Reset 

func (x *ListUserRightsResponse) Reset()

func (*ListUserRightsResponse) String 

func (x *ListUserRightsResponse) String() string

type ListUsersRequest 

type ListUsersRequest struct {

	// Pagination token to determine the specific page to fetch.
	// Leave empty to fetch the first page.
	// Optional
	PageToken string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Maximum number of results to be returned by the server. The server will return no more than that many results, but it might return fewer.
	// If 0, the server will decide the number of results to be returned.
	// Optional
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// contains filtered or unexported fields
}

Required authorization: “HasRight(ParticipantAdmin)“

func (*ListUsersRequest) Descriptor deprecated 

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

Deprecated: Use ListUsersRequest.ProtoReflect.Descriptor instead.

func (*ListUsersRequest) GetPageSize added in v7.6.3 

func (x *ListUsersRequest) GetPageSize() int32

func (*ListUsersRequest) GetPageToken added in v7.6.3 

func (x *ListUsersRequest) GetPageToken() string

func (*ListUsersRequest) ProtoMessage 

func (*ListUsersRequest) ProtoMessage()

func (*ListUsersRequest) ProtoReflect 

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

func (*ListUsersRequest) Reset 

func (x *ListUsersRequest) Reset()

func (*ListUsersRequest) String 

func (x *ListUsersRequest) String() string

type ListUsersResponse 

type ListUsersResponse struct {

	// A subset of users of the participant node that fit into this page.
	Users []*User `protobuf:"bytes,1,rep,name=users,proto3" json:"users,omitempty"`
	// Pagination token to retrieve the next page.
	// Empty, if there are no further results.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*ListUsersResponse) Descriptor deprecated 

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

Deprecated: Use ListUsersResponse.ProtoReflect.Descriptor instead.

func (*ListUsersResponse) GetNextPageToken added in v7.6.3 

func (x *ListUsersResponse) GetNextPageToken() string

func (*ListUsersResponse) GetUsers 

func (x *ListUsersResponse) GetUsers() []*User

func (*ListUsersResponse) ProtoMessage 

func (*ListUsersResponse) ProtoMessage()

func (*ListUsersResponse) ProtoReflect 

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

func (*ListUsersResponse) Reset 

func (x *ListUsersResponse) Reset()

func (*ListUsersResponse) String 

func (x *ListUsersResponse) String() string

type MeteringReportServiceClient 

type MeteringReportServiceClient interface {
	// Retrieve a metering report.
	GetMeteringReport(ctx context.Context, in *GetMeteringReportRequest, opts ...grpc.CallOption) (*GetMeteringReportResponse, error)
}

MeteringReportServiceClient is the client API for MeteringReportService 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 NewMeteringReportServiceClient 

func NewMeteringReportServiceClient(cc grpc.ClientConnInterface) MeteringReportServiceClient

type MeteringReportServiceServer 

type MeteringReportServiceServer interface {
	// Retrieve a metering report.
	GetMeteringReport(context.Context, *GetMeteringReportRequest) (*GetMeteringReportResponse, error)
	// contains filtered or unexported methods
}

MeteringReportServiceServer is the server API for MeteringReportService service. All implementations must embed UnimplementedMeteringReportServiceServer for forward compatibility

type ObjectMeta added in v7.10.0 

type ObjectMeta struct {

	// An opaque, non-empty value, populated by a participant server which represents the internal version of the resource
	// this “ObjectMeta“ message is attached to. The participant server will change it to a unique value each time the corresponding resource is updated.
	// You must not rely on the format of resource version. The participant server might change it without notice.
	// You can obtain the newest resource version value by issuing a read request.
	// You may use it for concurrent change detection by passing it back unmodified in an update request.
	// The participant server will then compare the passed value with the value maintained by the system to determine
	// if any other updates took place since you had read the resource version.
	// Upon a successful update you are guaranteed that no other update took place during your read-modify-write sequence.
	// However, if another update took place during your read-modify-write sequence then your update will fail with an appropriate error.
	// Concurrent change control is optional. It will be applied only if you include a resource version in an update request.
	// When creating a new instance of a resource you must leave the resource version empty.
	// Its value will be populated by the participant server upon successful resource creation.
	// Optional
	ResourceVersion string `protobuf:"bytes,6,opt,name=resource_version,json=resourceVersion,proto3" json:"resource_version,omitempty"`
	// A set of modifiable key-value pairs that can be used to represent arbitrary, client-specific metadata.
	// Constraints:
	// 1. The total size over all keys and values cannot exceed 256kb in UTF-8 encoding.
	// 2. Keys are composed of an optional prefix segment and a required name segment such that:
	//   - key prefix, when present, must be a valid DNS subdomain with at most 253 characters, followed by a '/' (forward slash) character,
	//   - name segment must have at most 63 characters that are either alphanumeric ([a-z0-9A-Z]), or a '.' (dot), '-' (dash) or '_' (underscore);
	//     and it must start and end with an alphanumeric character.
	//
	// 2. Values can be any non-empty strings.
	// Keys with empty prefix are reserved for end-users.
	// Properties set by external tools or internally by the participant server must use non-empty key prefixes.
	// Duplicate keys are disallowed by the semantics of the protobuf3 maps.
	// See: https://developers.google.com/protocol-buffers/docs/proto3#maps
	// Annotations may be a part of a modifiable resource.
	// Use the resource's update RPC to update its annotations.
	// In order to add a new annotation or update an existing one using an update RPC, provide the desired annotation in the update request.
	// In order to remove an annotation using an update RPC, provide the target annotation's key but set its value to the empty string in the update request.
	// Optional
	// Modifiable
	Annotations map[string]string `` /* 164-byte string literal not displayed */
	// contains filtered or unexported fields
}

Represents metadata corresponding to a participant resource (e.g. a participant user or participant local information about a party).

Based on “ObjectMeta“ meta used in Kubernetes API. See https://github.com/kubernetes/apimachinery/blob/master/pkg/apis/meta/v1/generated.proto#L640

func (*ObjectMeta) Descriptor deprecated added in v7.10.0 

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

Deprecated: Use ObjectMeta.ProtoReflect.Descriptor instead.

func (*ObjectMeta) GetAnnotations added in v7.10.0 

func (x *ObjectMeta) GetAnnotations() map[string]string

func (*ObjectMeta) GetResourceVersion added in v7.10.0 

func (x *ObjectMeta) GetResourceVersion() string

func (*ObjectMeta) ProtoMessage added in v7.10.0 

func (*ObjectMeta) ProtoMessage()

func (*ObjectMeta) ProtoReflect added in v7.10.0 

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

func (*ObjectMeta) Reset added in v7.10.0 

func (x *ObjectMeta) Reset()

func (*ObjectMeta) String added in v7.10.0 

func (x *ObjectMeta) 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.
	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
	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.

func NewPackageManagementServiceClient 

func NewPackageManagementServiceClient(cc grpc.ClientConnInterface) PackageManagementServiceClient

type PackageManagementServiceServer 

type PackageManagementServiceServer interface {
	// Returns the details of all Daml-LF packages known to the backing participant.
	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
	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 an error.
	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.

func NewParticipantPruningServiceClient 

func NewParticipantPruningServiceClient(cc grpc.ClientConnInterface) ParticipantPruningServiceClient

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 an error.
	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 at allocation time.
	// Caution, it might not be unique.
	// Use of this field is discouraged. Use the `local_metadata` field instead.
	// Optional
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// true if party is hosted by the participant.
	// Optional
	IsLocal bool `protobuf:"varint,3,opt,name=is_local,json=isLocal,proto3" json:"is_local,omitempty"`
	// Participant-local metadata of this party.
	// Optional,
	// Modifiable
	LocalMetadata *ObjectMeta `protobuf:"bytes,4,opt,name=local_metadata,json=localMetadata,proto3" json:"local_metadata,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) GetLocalMetadata added in v7.10.0 

func (x *PartyDetails) GetLocalMetadata() *ObjectMeta

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 participant.
	// All horizontally scaled replicas should return the same id.
	// daml-on-kv-ledger: returns an identifier supplied on command line at launch time
	// canton: returns globally unique identifier of the participant
	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.
	GetParties(ctx context.Context, in *GetPartiesRequest, opts ...grpc.CallOption) (*GetPartiesResponse, error)
	// List the parties known by the participant.
	// The list returned contains parties whose ledger access is facilitated by
	// the participant and the ones maintained elsewhere.
	ListKnownParties(ctx context.Context, in *ListKnownPartiesRequest, opts ...grpc.CallOption) (*ListKnownPartiesResponse, error)
	// Allocates a new party on a ledger and adds it to the set managed by the participant.
	// Caller specifies a party identifier suggestion, the actual identifier
	// allocated might be different and is implementation specific.
	// Caller can specify party metadata that is stored locally on the participant.
	// This call may:
	//   - Succeed, in which case the actual allocated identifier is visible in
	//     the response.
	//   - Respond with a gRPC error
	//
	// 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)
	// Update selected modifiable participant-local attributes of a party details resource.
	// Can update the participant's local information for both local and non-local parties.
	UpdatePartyDetails(ctx context.Context, in *UpdatePartyDetailsRequest, opts ...grpc.CallOption) (*UpdatePartyDetailsResponse, 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.

func NewPartyManagementServiceClient 

func NewPartyManagementServiceClient(cc grpc.ClientConnInterface) PartyManagementServiceClient

type PartyManagementServiceServer 

type PartyManagementServiceServer interface {
	// Return the identifier of the participant.
	// All horizontally scaled replicas should return the same id.
	// daml-on-kv-ledger: returns an identifier supplied on command line at launch time
	// canton: returns globally unique identifier of the participant
	GetParticipantId(context.Context, *GetParticipantIdRequest) (*GetParticipantIdResponse, error)
	// Get the party details of the given parties. Only known parties will be
	// returned in the list.
	GetParties(context.Context, *GetPartiesRequest) (*GetPartiesResponse, error)
	// List the parties known by the participant.
	// The list returned contains parties whose ledger access is facilitated by
	// the participant and the ones maintained elsewhere.
	ListKnownParties(context.Context, *ListKnownPartiesRequest) (*ListKnownPartiesResponse, error)
	// Allocates a new party on a ledger and adds it to the set managed by the participant.
	// Caller specifies a party identifier suggestion, the actual identifier
	// allocated might be different and is implementation specific.
	// Caller can specify party metadata that is stored locally on the participant.
	// This call may:
	//   - Succeed, in which case the actual allocated identifier is visible in
	//     the response.
	//   - Respond with a gRPC error
	//
	// 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)
	// Update selected modifiable participant-local attributes of a party details resource.
	// Can update the participant's local information for both local and non-local parties.
	UpdatePartyDetails(context.Context, *UpdatePartyDetailsRequest) (*UpdatePartyDetailsResponse, 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 which the ledger is to be pruned.
	// By default the following data is pruned:
	//  1. All normal and divulged contracts that have been archived before
	//     `prune_up_to`.
	//  2. All transaction events and completions before `prune_up_to`
	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"`
	// Prune all immediately and retroactively divulged contracts created before `prune_up_to`
	// independent of whether they were archived before `prune_up_to`. Useful to avoid leaking
	// storage on participant nodes that can see a divulged contract but not its archival.
	//
	// Application developers SHOULD write their Daml applications
	// such that they do not rely on divulged contracts; i.e., no warnings from
	// using divulged contracts as inputs to transactions are emitted.
	//
	// Participant node operators SHOULD set the `prune_all_divulged_contracts` flag to avoid leaking
	// storage due to accumulating unarchived divulged contracts PROVIDED that:
	//  1. no application using this participant node relies on divulgence OR
	//  2. divulged contracts on which applications rely have been re-divulged after the `prune_up_to` offset.
	PruneAllDivulgedContracts bool `` /* 141-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*PruneRequest) Descriptor deprecated 

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

Deprecated: Use PruneRequest.ProtoReflect.Descriptor instead.

func (*PruneRequest) GetPruneAllDivulgedContracts 

func (x *PruneRequest) GetPruneAllDivulgedContracts() bool

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 RevokeUserRightsRequest 

type RevokeUserRightsRequest struct {

	// The user from whom to revoke rights.
	// Required
	UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// The rights to revoke.
	// Optional
	Rights []*Right `protobuf:"bytes,2,rep,name=rights,proto3" json:"rights,omitempty"`
	// contains filtered or unexported fields
}

Remove the rights from the set of rights granted to the user.

Required authorization: “HasRight(ParticipantAdmin)“

func (*RevokeUserRightsRequest) Descriptor deprecated 

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

Deprecated: Use RevokeUserRightsRequest.ProtoReflect.Descriptor instead.

func (*RevokeUserRightsRequest) GetRights 

func (x *RevokeUserRightsRequest) GetRights() []*Right

func (*RevokeUserRightsRequest) GetUserId 

func (x *RevokeUserRightsRequest) GetUserId() string

func (*RevokeUserRightsRequest) ProtoMessage 

func (*RevokeUserRightsRequest) ProtoMessage()

func (*RevokeUserRightsRequest) ProtoReflect 

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

func (*RevokeUserRightsRequest) Reset 

func (x *RevokeUserRightsRequest) Reset()

func (*RevokeUserRightsRequest) String 

func (x *RevokeUserRightsRequest) String() string

type RevokeUserRightsResponse 

type RevokeUserRightsResponse struct {

	// The rights that were actually revoked by the request.
	NewlyRevokedRights []*Right `protobuf:"bytes,1,rep,name=newly_revoked_rights,json=newlyRevokedRights,proto3" json:"newly_revoked_rights,omitempty"`
	// contains filtered or unexported fields
}

func (*RevokeUserRightsResponse) Descriptor deprecated 

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

Deprecated: Use RevokeUserRightsResponse.ProtoReflect.Descriptor instead.

func (*RevokeUserRightsResponse) GetNewlyRevokedRights 

func (x *RevokeUserRightsResponse) GetNewlyRevokedRights() []*Right

func (*RevokeUserRightsResponse) ProtoMessage 

func (*RevokeUserRightsResponse) ProtoMessage()

func (*RevokeUserRightsResponse) ProtoReflect 

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

func (*RevokeUserRightsResponse) Reset 

func (x *RevokeUserRightsResponse) Reset()

func (*RevokeUserRightsResponse) String 

func (x *RevokeUserRightsResponse) String() string
type Right struct {

	// Required
	//
	// Types that are assignable to Kind:
	//
	//	*Right_ParticipantAdmin_
	//	*Right_CanActAs_
	//	*Right_CanReadAs_
	Kind isRight_Kind `protobuf_oneof:"kind"`
	// contains filtered or unexported fields
}

A right granted to a user.

func (*Right) Descriptor deprecated 

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

Deprecated: Use Right.ProtoReflect.Descriptor instead.

func (*Right) GetCanActAs 

func (x *Right) GetCanActAs() *Right_CanActAs

func (*Right) GetCanReadAs 

func (x *Right) GetCanReadAs() *Right_CanReadAs

func (*Right) GetKind 

func (m *Right) GetKind() isRight_Kind

func (*Right) GetParticipantAdmin 

func (x *Right) GetParticipantAdmin() *Right_ParticipantAdmin

func (*Right) ProtoMessage 

func (*Right) ProtoMessage()

func (*Right) ProtoReflect 

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

func (*Right) Reset 

func (x *Right) Reset()

func (*Right) String 

func (x *Right) String() string

type Right_CanActAs 

type Right_CanActAs struct {

	// The right to authorize commands for this party.
	Party string `protobuf:"bytes,1,opt,name=party,proto3" json:"party,omitempty"`
	// contains filtered or unexported fields
}

func (*Right_CanActAs) Descriptor deprecated 

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

Deprecated: Use Right_CanActAs.ProtoReflect.Descriptor instead.

func (*Right_CanActAs) GetParty 

func (x *Right_CanActAs) GetParty() string

func (*Right_CanActAs) ProtoMessage 

func (*Right_CanActAs) ProtoMessage()

func (*Right_CanActAs) ProtoReflect 

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

func (*Right_CanActAs) Reset 

func (x *Right_CanActAs) Reset()

func (*Right_CanActAs) String 

func (x *Right_CanActAs) String() string

type Right_CanActAs_ 

type Right_CanActAs_ struct {
	// The user can act as a specific party.
	CanActAs *Right_CanActAs `protobuf:"bytes,2,opt,name=can_act_as,json=canActAs,proto3,oneof"`
}

type Right_CanReadAs 

type Right_CanReadAs struct {

	// The right to read ledger data visible to this party.
	Party string `protobuf:"bytes,1,opt,name=party,proto3" json:"party,omitempty"`
	// contains filtered or unexported fields
}

func (*Right_CanReadAs) Descriptor deprecated 

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

Deprecated: Use Right_CanReadAs.ProtoReflect.Descriptor instead.

func (*Right_CanReadAs) GetParty 

func (x *Right_CanReadAs) GetParty() string

func (*Right_CanReadAs) ProtoMessage 

func (*Right_CanReadAs) ProtoMessage()

func (*Right_CanReadAs) ProtoReflect 

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

func (*Right_CanReadAs) Reset 

func (x *Right_CanReadAs) Reset()

func (*Right_CanReadAs) String 

func (x *Right_CanReadAs) String() string

type Right_CanReadAs_ 

type Right_CanReadAs_ struct {
	// The user can read ledger data visible to a specific party.
	CanReadAs *Right_CanReadAs `protobuf:"bytes,3,opt,name=can_read_as,json=canReadAs,proto3,oneof"`
}

type Right_ParticipantAdmin 

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

The right to administrate the participant node.

func (*Right_ParticipantAdmin) Descriptor deprecated 

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

Deprecated: Use Right_ParticipantAdmin.ProtoReflect.Descriptor instead.

func (*Right_ParticipantAdmin) ProtoMessage 

func (*Right_ParticipantAdmin) ProtoMessage()

func (*Right_ParticipantAdmin) ProtoReflect 

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

func (*Right_ParticipantAdmin) Reset 

func (x *Right_ParticipantAdmin) Reset()

func (*Right_ParticipantAdmin) String 

func (x *Right_ParticipantAdmin) String() string

type Right_ParticipantAdmin_ 

type Right_ParticipantAdmin_ struct {
	// The user can administrate the participant node.
	ParticipantAdmin *Right_ParticipantAdmin `protobuf:"bytes,1,opt,name=participant_admin,json=participantAdmin,proto3,oneof"`
}

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) GetTimeModel(context.Context, *GetTimeModelRequest) (*GetTimeModelResponse, error)

func (UnimplementedConfigManagementServiceServer) SetTimeModel 

func (UnimplementedConfigManagementServiceServer) SetTimeModel(context.Context, *SetTimeModelRequest) (*SetTimeModelResponse, error)

type UnimplementedMeteringReportServiceServer 

type UnimplementedMeteringReportServiceServer struct {
}

UnimplementedMeteringReportServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedMeteringReportServiceServer) GetMeteringReport 

func (UnimplementedMeteringReportServiceServer) GetMeteringReport(context.Context, *GetMeteringReportRequest) (*GetMeteringReportResponse, error)

type UnimplementedPackageManagementServiceServer 

type UnimplementedPackageManagementServiceServer struct {
}

UnimplementedPackageManagementServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedPackageManagementServiceServer) ListKnownPackages 

func (UnimplementedPackageManagementServiceServer) ListKnownPackages(context.Context, *ListKnownPackagesRequest) (*ListKnownPackagesResponse, error)

func (UnimplementedPackageManagementServiceServer) UploadDarFile 

func (UnimplementedPackageManagementServiceServer) UploadDarFile(context.Context, *UploadDarFileRequest) (*UploadDarFileResponse, error)

type UnimplementedParticipantPruningServiceServer 

type UnimplementedParticipantPruningServiceServer struct {
}

UnimplementedParticipantPruningServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedParticipantPruningServiceServer) Prune 

func (UnimplementedParticipantPruningServiceServer) Prune(context.Context, *PruneRequest) (*PruneResponse, error)

type UnimplementedPartyManagementServiceServer 

type UnimplementedPartyManagementServiceServer struct {
}

UnimplementedPartyManagementServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedPartyManagementServiceServer) AllocateParty 

func (UnimplementedPartyManagementServiceServer) AllocateParty(context.Context, *AllocatePartyRequest) (*AllocatePartyResponse, error)

func (UnimplementedPartyManagementServiceServer) GetParticipantId 

func (UnimplementedPartyManagementServiceServer) GetParticipantId(context.Context, *GetParticipantIdRequest) (*GetParticipantIdResponse, error)

func (UnimplementedPartyManagementServiceServer) GetParties 

func (UnimplementedPartyManagementServiceServer) GetParties(context.Context, *GetPartiesRequest) (*GetPartiesResponse, error)

func (UnimplementedPartyManagementServiceServer) ListKnownParties 

func (UnimplementedPartyManagementServiceServer) ListKnownParties(context.Context, *ListKnownPartiesRequest) (*ListKnownPartiesResponse, error)

func (UnimplementedPartyManagementServiceServer) UpdatePartyDetails added in v7.10.0 

func (UnimplementedPartyManagementServiceServer) UpdatePartyDetails(context.Context, *UpdatePartyDetailsRequest) (*UpdatePartyDetailsResponse, error)

type UnimplementedUserManagementServiceServer 

type UnimplementedUserManagementServiceServer struct {
}

UnimplementedUserManagementServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedUserManagementServiceServer) CreateUser 

func (UnimplementedUserManagementServiceServer) CreateUser(context.Context, *CreateUserRequest) (*CreateUserResponse, error)

func (UnimplementedUserManagementServiceServer) DeleteUser 

func (UnimplementedUserManagementServiceServer) DeleteUser(context.Context, *DeleteUserRequest) (*DeleteUserResponse, error)

func (UnimplementedUserManagementServiceServer) GetUser 

func (UnimplementedUserManagementServiceServer) GetUser(context.Context, *GetUserRequest) (*GetUserResponse, error)

func (UnimplementedUserManagementServiceServer) GrantUserRights 

func (UnimplementedUserManagementServiceServer) GrantUserRights(context.Context, *GrantUserRightsRequest) (*GrantUserRightsResponse, error)

func (UnimplementedUserManagementServiceServer) ListUserRights 

func (UnimplementedUserManagementServiceServer) ListUserRights(context.Context, *ListUserRightsRequest) (*ListUserRightsResponse, error)

func (UnimplementedUserManagementServiceServer) ListUsers 

func (UnimplementedUserManagementServiceServer) ListUsers(context.Context, *ListUsersRequest) (*ListUsersResponse, error)

func (UnimplementedUserManagementServiceServer) RevokeUserRights 

func (UnimplementedUserManagementServiceServer) RevokeUserRights(context.Context, *RevokeUserRightsRequest) (*RevokeUserRightsResponse, error)

func (UnimplementedUserManagementServiceServer) UpdateUser added in v7.10.0 

func (UnimplementedUserManagementServiceServer) UpdateUser(context.Context, *UpdateUserRequest) (*UpdateUserResponse, error)

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 UnsafeMeteringReportServiceServer 

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

UnsafeMeteringReportServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to MeteringReportServiceServer 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 UnsafeUserManagementServiceServer 

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

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

type UpdatePartyDetailsRequest added in v7.10.0 

type UpdatePartyDetailsRequest struct {

	// Party to be updated
	// Required,
	// Modifiable
	PartyDetails *PartyDetails `protobuf:"bytes,1,opt,name=party_details,json=partyDetails,proto3" json:"party_details,omitempty"`
	// An update mask specifies how and which properties of the “PartyDetails“ message are to be updated.
	// An update mask consists of a set of update paths.
	// A valid update path points to a field or a subfield relative to the “PartyDetails“ message.
	// A valid update mask must:
	// (1) contain at least one update path,
	// (2) contain only valid update paths.
	// Fields that can be updated are marked as “Modifiable“.
	// An update path can also point to non-“Modifiable“ fields such as 'party' and 'local_metadata.resource_version'
	// because they are used:
	// (1) to identify the party details resource subject to the update,
	// (2) for concurrent change control.
	// An update path can also point to non-“Modifiable“ fields such as 'is_local' and 'display_name'
	// as long as the values provided in the update request match the server values.
	// Examples of update paths: 'local_metadata.annotations', 'local_metadata'.
	// For additional information see the documentation for standard protobuf3's “google.protobuf.FieldMask“.
	// For similar Ledger API see “com.daml.ledger.api.v1.admin.UpdateUserRequest“.
	// Required
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Required authorization: “HasRight(ParticipantAdmin)“ In a scenario when a party is known to this participant but has been allocated through a different participant, the resource version of it might be not set on this participant until after the first update RPC has been completed.

func (*UpdatePartyDetailsRequest) Descriptor deprecated added in v7.10.0 

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

Deprecated: Use UpdatePartyDetailsRequest.ProtoReflect.Descriptor instead.

func (*UpdatePartyDetailsRequest) GetPartyDetails added in v7.10.0 

func (x *UpdatePartyDetailsRequest) GetPartyDetails() *PartyDetails

func (*UpdatePartyDetailsRequest) GetUpdateMask added in v7.10.0 

func (x *UpdatePartyDetailsRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdatePartyDetailsRequest) ProtoMessage added in v7.10.0 

func (*UpdatePartyDetailsRequest) ProtoMessage()

func (*UpdatePartyDetailsRequest) ProtoReflect added in v7.10.0 

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

func (*UpdatePartyDetailsRequest) Reset added in v7.10.0 

func (x *UpdatePartyDetailsRequest) Reset()

func (*UpdatePartyDetailsRequest) String added in v7.10.0 

func (x *UpdatePartyDetailsRequest) String() string

type UpdatePartyDetailsResponse added in v7.10.0 

type UpdatePartyDetailsResponse struct {

	// Updated party details
	PartyDetails *PartyDetails `protobuf:"bytes,1,opt,name=party_details,json=partyDetails,proto3" json:"party_details,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdatePartyDetailsResponse) Descriptor deprecated added in v7.10.0 

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

Deprecated: Use UpdatePartyDetailsResponse.ProtoReflect.Descriptor instead.

func (*UpdatePartyDetailsResponse) GetPartyDetails added in v7.10.0 

func (x *UpdatePartyDetailsResponse) GetPartyDetails() *PartyDetails

func (*UpdatePartyDetailsResponse) ProtoMessage added in v7.10.0 

func (*UpdatePartyDetailsResponse) ProtoMessage()

func (*UpdatePartyDetailsResponse) ProtoReflect added in v7.10.0 

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

func (*UpdatePartyDetailsResponse) Reset added in v7.10.0 

func (x *UpdatePartyDetailsResponse) Reset()

func (*UpdatePartyDetailsResponse) String added in v7.10.0 

func (x *UpdatePartyDetailsResponse) String() string

type UpdateUserRequest added in v7.10.0 

type UpdateUserRequest struct {

	// The user to update.
	// Required,
	// Modifiable
	User *User `protobuf:"bytes,1,opt,name=user,proto3" json:"user,omitempty"`
	// An update mask specifies how and which properties of the “User“ message are to be updated.
	// An update mask consists of a set of update paths.
	// A valid update path points to a field or a subfield relative to the “User“ message.
	// A valid update mask must:
	// (1) contain at least one update path,
	// (2) contain only valid update paths.
	// Fields that can be updated are marked as “Modifiable“.
	// An update path can also point to a non-“Modifiable“ fields such as 'id' and 'metadata.resource_version'
	// because they are used:
	// (1) to identify the user resource subject to the update,
	// (2) for concurrent change control.
	// Examples of valid update paths: 'primary_party', 'metadata', 'metadata.annotations'.
	// For additional information see the documentation for standard protobuf3's “google.protobuf.FieldMask“.
	// For similar Ledger API see “com.daml.ledger.api.v1.admin.UpdatePartyDetailsRequest“.
	// Required
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Required authorization: “HasRight(ParticipantAdmin)“

func (*UpdateUserRequest) Descriptor deprecated added in v7.10.0 

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

Deprecated: Use UpdateUserRequest.ProtoReflect.Descriptor instead.

func (*UpdateUserRequest) GetUpdateMask added in v7.10.0 

func (x *UpdateUserRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateUserRequest) GetUser added in v7.10.0 

func (x *UpdateUserRequest) GetUser() *User

func (*UpdateUserRequest) ProtoMessage added in v7.10.0 

func (*UpdateUserRequest) ProtoMessage()

func (*UpdateUserRequest) ProtoReflect added in v7.10.0 

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

func (*UpdateUserRequest) Reset added in v7.10.0 

func (x *UpdateUserRequest) Reset()

func (*UpdateUserRequest) String added in v7.10.0 

func (x *UpdateUserRequest) String() string

type UpdateUserResponse added in v7.10.0 

type UpdateUserResponse struct {

	// Updated user
	User *User `protobuf:"bytes,1,opt,name=user,proto3" json:"user,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateUserResponse) Descriptor deprecated added in v7.10.0 

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

Deprecated: Use UpdateUserResponse.ProtoReflect.Descriptor instead.

func (*UpdateUserResponse) GetUser added in v7.10.0 

func (x *UpdateUserResponse) GetUser() *User

func (*UpdateUserResponse) ProtoMessage added in v7.10.0 

func (*UpdateUserResponse) ProtoMessage()

func (*UpdateUserResponse) ProtoReflect added in v7.10.0 

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

func (*UpdateUserResponse) Reset added in v7.10.0 

func (x *UpdateUserResponse) Reset()

func (*UpdateUserResponse) String added in v7.10.0 

func (x *UpdateUserResponse) String() string

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

type User 

type User struct {

	// The user identifier, which must be a non-empty string of at most 128
	// characters that are either lowercase alphanumeric ASCII characters or one of the symbols "@^$.!`-#+'~_|:".
	// Required
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The primary party as which this user reads and acts by default on the ledger
	// *provided* it has the corresponding “CanReadAs(primary_party)“ or
	// “CanActAs(primary_party)“ rights.
	// Ledger API clients SHOULD set this field to a non-empty value for all users to
	// enable the users to act on the ledger using their own Daml party.
	// Users for participant administrators MAY have an associated primary party.
	// Optional,
	// Modifiable
	PrimaryParty string `protobuf:"bytes,2,opt,name=primary_party,json=primaryParty,proto3" json:"primary_party,omitempty"`
	// When set, then the user is denied all access to the Ledger API.
	// Otherwise, the user has access to the Ledger API as per the user's rights.
	// Optional,
	// Modifiable
	IsDeactivated bool `protobuf:"varint,3,opt,name=is_deactivated,json=isDeactivated,proto3" json:"is_deactivated,omitempty"`
	// The metadata of this user.
	// Note that the “metadata.resource_version“ tracks changes to the properties described by the “User“ message and not the user's rights.
	// Optional,
	// Modifiable
	Metadata *ObjectMeta `protobuf:"bytes,4,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

Users are used to dynamically manage the rights given to Daml applications. They are stored and managed per participant node.

Read the :doc:`Authorization documentation </app-dev/authorization>` to learn more.

func (*User) Descriptor deprecated 

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

Deprecated: Use User.ProtoReflect.Descriptor instead.

func (*User) GetId 

func (x *User) GetId() string

func (*User) GetIsDeactivated added in v7.10.0 

func (x *User) GetIsDeactivated() bool

func (*User) GetMetadata added in v7.10.0 

func (x *User) GetMetadata() *ObjectMeta

func (*User) GetPrimaryParty 

func (x *User) GetPrimaryParty() string

func (*User) ProtoMessage 

func (*User) ProtoMessage()

func (*User) ProtoReflect 

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

func (*User) Reset 

func (x *User) Reset()

func (*User) String 

func (x *User) String() string

type UserManagementServiceClient 

type UserManagementServiceClient interface {
	// Create a new user.
	CreateUser(ctx context.Context, in *CreateUserRequest, opts ...grpc.CallOption) (*CreateUserResponse, error)
	// Get the user data of a specific user or the authenticated user.
	GetUser(ctx context.Context, in *GetUserRequest, opts ...grpc.CallOption) (*GetUserResponse, error)
	// Update selected modifiable attribute of a user resource described by the “User“ message.
	UpdateUser(ctx context.Context, in *UpdateUserRequest, opts ...grpc.CallOption) (*UpdateUserResponse, error)
	// Delete an existing user and all its rights.
	DeleteUser(ctx context.Context, in *DeleteUserRequest, opts ...grpc.CallOption) (*DeleteUserResponse, error)
	// List all existing users.
	ListUsers(ctx context.Context, in *ListUsersRequest, opts ...grpc.CallOption) (*ListUsersResponse, error)
	// Grant rights to a user.
	// Granting rights does not affect the resource version of the corresponding user.
	GrantUserRights(ctx context.Context, in *GrantUserRightsRequest, opts ...grpc.CallOption) (*GrantUserRightsResponse, error)
	// Revoke rights from a user.
	// Revoking rights does not affect the resource version of the corresponding user.
	RevokeUserRights(ctx context.Context, in *RevokeUserRightsRequest, opts ...grpc.CallOption) (*RevokeUserRightsResponse, error)
	// List the set of all rights granted to a user.
	ListUserRights(ctx context.Context, in *ListUserRightsRequest, opts ...grpc.CallOption) (*ListUserRightsResponse, error)
}

UserManagementServiceClient is the client API for UserManagementService 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 NewUserManagementServiceClient 

func NewUserManagementServiceClient(cc grpc.ClientConnInterface) UserManagementServiceClient

type UserManagementServiceServer 

type UserManagementServiceServer interface {
	// Create a new user.
	CreateUser(context.Context, *CreateUserRequest) (*CreateUserResponse, error)
	// Get the user data of a specific user or the authenticated user.
	GetUser(context.Context, *GetUserRequest) (*GetUserResponse, error)
	// Update selected modifiable attribute of a user resource described by the “User“ message.
	UpdateUser(context.Context, *UpdateUserRequest) (*UpdateUserResponse, error)
	// Delete an existing user and all its rights.
	DeleteUser(context.Context, *DeleteUserRequest) (*DeleteUserResponse, error)
	// List all existing users.
	ListUsers(context.Context, *ListUsersRequest) (*ListUsersResponse, error)
	// Grant rights to a user.
	// Granting rights does not affect the resource version of the corresponding user.
	GrantUserRights(context.Context, *GrantUserRightsRequest) (*GrantUserRightsResponse, error)
	// Revoke rights from a user.
	// Revoking rights does not affect the resource version of the corresponding user.
	RevokeUserRights(context.Context, *RevokeUserRightsRequest) (*RevokeUserRightsResponse, error)
	// List the set of all rights granted to a user.
	ListUserRights(context.Context, *ListUserRightsRequest) (*ListUserRightsResponse, error)
	// contains filtered or unexported methods
}

UserManagementServiceServer is the server API for UserManagementService service. All implementations must embed UnimplementedUserManagementServiceServer for forward compatibility

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.