effectv1

package
v1.4.0 Latest Latest
Warning

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

 Go to latest Published: Oct 20, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	EffectService_ExecuteEffect_FullMethodName             = "/fenced.effect.v1.EffectService/ExecuteEffect"
	EffectService_GetEffect_FullMethodName                 = "/fenced.effect.v1.EffectService/GetEffect"
	EffectService_GetEffectByIdempotencyKey_FullMethodName = "/fenced.effect.v1.EffectService/GetEffectByIdempotencyKey"
)

Variables

View Source 
var (
	EffectStatus_name = map[int32]string{
		0: "EFFECT_STATUS_UNSPECIFIED",
		1: "EFFECT_STATUS_PENDING",
		2: "EFFECT_STATUS_EXECUTING",
		3: "EFFECT_STATUS_COMMITTED",
		4: "EFFECT_STATUS_FAILED",
		5: "EFFECT_STATUS_UNKNOWN",
	}
	EffectStatus_value = map[string]int32{
		"EFFECT_STATUS_UNSPECIFIED": 0,
		"EFFECT_STATUS_PENDING":     1,
		"EFFECT_STATUS_EXECUTING":   2,
		"EFFECT_STATUS_COMMITTED":   3,
		"EFFECT_STATUS_FAILED":      4,
		"EFFECT_STATUS_UNKNOWN":     5,
	}
)

Enum value maps for EffectStatus.

View Source 
var EffectService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "fenced.effect.v1.EffectService",
	HandlerType: (*EffectServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ExecuteEffect",
			Handler:    _EffectService_ExecuteEffect_Handler,
		},
		{
			MethodName: "GetEffect",
			Handler:    _EffectService_GetEffect_Handler,
		},
		{
			MethodName: "GetEffectByIdempotencyKey",
			Handler:    _EffectService_GetEffectByIdempotencyKey_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "fenced/effect/v1/effect.proto",
}

EffectService_ServiceDesc is the grpc.ServiceDesc for EffectService 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_fenced_effect_v1_effect_proto protoreflect.FileDescriptor

Functions

func RegisterEffectServiceServer 

func RegisterEffectServiceServer(s grpc.ServiceRegistrar, srv EffectServiceServer)

Types

type EffectReceipt 

type EffectReceipt struct {
	EffectId        string                 `protobuf:"bytes,1,opt,name=effect_id,json=effectId,proto3" json:"effect_id,omitempty"`
	TenantId        string                 `protobuf:"bytes,2,opt,name=tenant_id,json=tenantId,proto3" json:"tenant_id,omitempty"`
	Status          EffectStatus           `protobuf:"varint,3,opt,name=status,proto3,enum=fenced.effect.v1.EffectStatus" json:"status,omitempty"`
	ProviderReceipt []byte                 `protobuf:"bytes,4,opt,name=provider_receipt,json=providerReceipt,proto3" json:"provider_receipt,omitempty"`
	StartedAt       *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=started_at,json=startedAt,proto3" json:"started_at,omitempty"`
	CompletedAt     *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=completed_at,json=completedAt,proto3" json:"completed_at,omitempty"`
	AttemptId       string                 `protobuf:"bytes,7,opt,name=attempt_id,json=attemptId,proto3" json:"attempt_id,omitempty"`
	FencingToken    int64                  `protobuf:"varint,8,opt,name=fencing_token,json=fencingToken,proto3" json:"fencing_token,omitempty"`
	ResultHash      string                 `protobuf:"bytes,9,opt,name=result_hash,json=resultHash,proto3" json:"result_hash,omitempty"`
	ErrorMessage    string                 `protobuf:"bytes,10,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
	// contains filtered or unexported fields
}

func (*EffectReceipt) Descriptor deprecated 

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

Deprecated: Use EffectReceipt.ProtoReflect.Descriptor instead.

func (*EffectReceipt) GetAttemptId 

func (x *EffectReceipt) GetAttemptId() string

func (*EffectReceipt) GetCompletedAt 

func (x *EffectReceipt) GetCompletedAt() *timestamppb.Timestamp

func (*EffectReceipt) GetEffectId 

func (x *EffectReceipt) GetEffectId() string

func (*EffectReceipt) GetErrorMessage 

func (x *EffectReceipt) GetErrorMessage() string

func (*EffectReceipt) GetFencingToken 

func (x *EffectReceipt) GetFencingToken() int64

func (*EffectReceipt) GetProviderReceipt 

func (x *EffectReceipt) GetProviderReceipt() []byte

func (*EffectReceipt) GetResultHash 

func (x *EffectReceipt) GetResultHash() string

func (*EffectReceipt) GetStartedAt 

func (x *EffectReceipt) GetStartedAt() *timestamppb.Timestamp

func (*EffectReceipt) GetStatus 

func (x *EffectReceipt) GetStatus() EffectStatus

func (*EffectReceipt) GetTenantId 

func (x *EffectReceipt) GetTenantId() string

func (*EffectReceipt) ProtoMessage 

func (*EffectReceipt) ProtoMessage()

func (*EffectReceipt) ProtoReflect 

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

func (*EffectReceipt) Reset 

func (x *EffectReceipt) Reset()

func (*EffectReceipt) String 

func (x *EffectReceipt) String() string

type EffectRecord 

type EffectRecord struct {
	Request   *EffectRequest         `protobuf:"bytes,1,opt,name=request,proto3" json:"request,omitempty"`
	Receipt   *EffectReceipt         `protobuf:"bytes,2,opt,name=receipt,proto3" json:"receipt,omitempty"`
	Status    EffectStatus           `protobuf:"varint,3,opt,name=status,proto3,enum=fenced.effect.v1.EffectStatus" json:"status,omitempty"`
	CreatedAt *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	UpdatedAt *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
	Version   int64                  `protobuf:"varint,6,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

func (*EffectRecord) Descriptor deprecated 

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

Deprecated: Use EffectRecord.ProtoReflect.Descriptor instead.

func (*EffectRecord) GetCreatedAt 

func (x *EffectRecord) GetCreatedAt() *timestamppb.Timestamp

func (*EffectRecord) GetReceipt 

func (x *EffectRecord) GetReceipt() *EffectReceipt

func (*EffectRecord) GetRequest 

func (x *EffectRecord) GetRequest() *EffectRequest

func (*EffectRecord) GetStatus 

func (x *EffectRecord) GetStatus() EffectStatus

func (*EffectRecord) GetUpdatedAt 

func (x *EffectRecord) GetUpdatedAt() *timestamppb.Timestamp

func (*EffectRecord) GetVersion 

func (x *EffectRecord) GetVersion() int64

func (*EffectRecord) ProtoMessage 

func (*EffectRecord) ProtoMessage()

func (*EffectRecord) ProtoReflect 

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

func (*EffectRecord) Reset 

func (x *EffectRecord) Reset()

func (*EffectRecord) String 

func (x *EffectRecord) String() string

type EffectRequest 

type EffectRequest struct {
	EffectId       string                 `protobuf:"bytes,1,opt,name=effect_id,json=effectId,proto3" json:"effect_id,omitempty"`
	TenantId       string                 `protobuf:"bytes,2,opt,name=tenant_id,json=tenantId,proto3" json:"tenant_id,omitempty"`
	AgentId        string                 `protobuf:"bytes,3,opt,name=agent_id,json=agentId,proto3" json:"agent_id,omitempty"`
	RunId          string                 `protobuf:"bytes,4,opt,name=run_id,json=runId,proto3" json:"run_id,omitempty"`
	AttemptId      string                 `protobuf:"bytes,5,opt,name=attempt_id,json=attemptId,proto3" json:"attempt_id,omitempty"`
	FencingToken   int64                  `protobuf:"varint,6,opt,name=fencing_token,json=fencingToken,proto3" json:"fencing_token,omitempty"`
	Provider       string                 `protobuf:"bytes,7,opt,name=provider,proto3" json:"provider,omitempty"`
	Operation      string                 `protobuf:"bytes,8,opt,name=operation,proto3" json:"operation,omitempty"`
	IdempotencyKey string                 `protobuf:"bytes,9,opt,name=idempotency_key,json=idempotencyKey,proto3" json:"idempotency_key,omitempty"`
	PayloadHash    string                 `protobuf:"bytes,10,opt,name=payload_hash,json=payloadHash,proto3" json:"payload_hash,omitempty"`
	Payload        []byte                 `protobuf:"bytes,11,opt,name=payload,proto3" json:"payload,omitempty"`
	Deadline       *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=deadline,proto3" json:"deadline,omitempty"`
	TraceId        string                 `protobuf:"bytes,13,opt,name=trace_id,json=traceId,proto3" json:"trace_id,omitempty"`
	CreatedAt      *timestamppb.Timestamp `protobuf:"bytes,14,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// contains filtered or unexported fields
}

func (*EffectRequest) Descriptor deprecated 

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

Deprecated: Use EffectRequest.ProtoReflect.Descriptor instead.

func (*EffectRequest) GetAgentId 

func (x *EffectRequest) GetAgentId() string

func (*EffectRequest) GetAttemptId 

func (x *EffectRequest) GetAttemptId() string

func (*EffectRequest) GetCreatedAt 

func (x *EffectRequest) GetCreatedAt() *timestamppb.Timestamp

func (*EffectRequest) GetDeadline 

func (x *EffectRequest) GetDeadline() *timestamppb.Timestamp

func (*EffectRequest) GetEffectId 

func (x *EffectRequest) GetEffectId() string

func (*EffectRequest) GetFencingToken 

func (x *EffectRequest) GetFencingToken() int64

func (*EffectRequest) GetIdempotencyKey 

func (x *EffectRequest) GetIdempotencyKey() string

func (*EffectRequest) GetOperation 

func (x *EffectRequest) GetOperation() string

func (*EffectRequest) GetPayload 

func (x *EffectRequest) GetPayload() []byte

func (*EffectRequest) GetPayloadHash 

func (x *EffectRequest) GetPayloadHash() string

func (*EffectRequest) GetProvider 

func (x *EffectRequest) GetProvider() string

func (*EffectRequest) GetRunId 

func (x *EffectRequest) GetRunId() string

func (*EffectRequest) GetTenantId 

func (x *EffectRequest) GetTenantId() string

func (*EffectRequest) GetTraceId 

func (x *EffectRequest) GetTraceId() string

func (*EffectRequest) ProtoMessage 

func (*EffectRequest) ProtoMessage()

func (*EffectRequest) ProtoReflect 

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

func (*EffectRequest) Reset 

func (x *EffectRequest) Reset()

func (*EffectRequest) String 

func (x *EffectRequest) String() string

type EffectServiceClient 

type EffectServiceClient interface {
	ExecuteEffect(ctx context.Context, in *ExecuteEffectRequest, opts ...grpc.CallOption) (*ExecuteEffectResponse, error)
	GetEffect(ctx context.Context, in *GetEffectRequest, opts ...grpc.CallOption) (*GetEffectResponse, error)
	GetEffectByIdempotencyKey(ctx context.Context, in *GetEffectByIdempotencyKeyRequest, opts ...grpc.CallOption) (*GetEffectByIdempotencyKeyResponse, error)
}

EffectServiceClient is the client API for EffectService 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.

Durable external side-effect API with monotonic fencing, idempotent replay protection, and unambiguous terminal state accounting. v1 field numbers, RPC signatures, and error semantics are FROZEN (v1.2 Contract Freeze).

func NewEffectServiceClient 

func NewEffectServiceClient(cc grpc.ClientConnInterface) EffectServiceClient

type EffectServiceServer 

type EffectServiceServer interface {
	ExecuteEffect(context.Context, *ExecuteEffectRequest) (*ExecuteEffectResponse, error)
	GetEffect(context.Context, *GetEffectRequest) (*GetEffectResponse, error)
	GetEffectByIdempotencyKey(context.Context, *GetEffectByIdempotencyKeyRequest) (*GetEffectByIdempotencyKeyResponse, error)
	// contains filtered or unexported methods
}

EffectServiceServer is the server API for EffectService service. All implementations must embed UnimplementedEffectServiceServer for forward compatibility.

Durable external side-effect API with monotonic fencing, idempotent replay protection, and unambiguous terminal state accounting. v1 field numbers, RPC signatures, and error semantics are FROZEN (v1.2 Contract Freeze).

type EffectStatus 

type EffectStatus int32
const (
	EffectStatus_EFFECT_STATUS_UNSPECIFIED EffectStatus = 0
	EffectStatus_EFFECT_STATUS_PENDING     EffectStatus = 1
	EffectStatus_EFFECT_STATUS_EXECUTING   EffectStatus = 2
	// Committed external effect: exactly-once side-effect proof. Safe to replay idempotently.
	EffectStatus_EFFECT_STATUS_COMMITTED EffectStatus = 3
	// Definitively failed by provider.
	EffectStatus_EFFECT_STATUS_FAILED EffectStatus = 4
	// Ambiguous outcome (timeout, connection reset). MUST NEVER be blindly retried or auto-replayed.
	EffectStatus_EFFECT_STATUS_UNKNOWN EffectStatus = 5
)

func (EffectStatus) Descriptor 

func (EffectStatus) Descriptor() protoreflect.EnumDescriptor

func (EffectStatus) Enum 

func (x EffectStatus) Enum() *EffectStatus

func (EffectStatus) EnumDescriptor deprecated 

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

Deprecated: Use EffectStatus.Descriptor instead.

func (EffectStatus) Number 

func (x EffectStatus) Number() protoreflect.EnumNumber

func (EffectStatus) String 

func (x EffectStatus) String() string

func (EffectStatus) Type 

func (EffectStatus) Type() protoreflect.EnumType

type ExecuteEffectRequest 

type ExecuteEffectRequest struct {
	Request *EffectRequest `protobuf:"bytes,1,opt,name=request,proto3" json:"request,omitempty"`
	// contains filtered or unexported fields
}

func (*ExecuteEffectRequest) Descriptor deprecated 

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

Deprecated: Use ExecuteEffectRequest.ProtoReflect.Descriptor instead.

func (*ExecuteEffectRequest) GetRequest 

func (x *ExecuteEffectRequest) GetRequest() *EffectRequest

func (*ExecuteEffectRequest) ProtoMessage 

func (*ExecuteEffectRequest) ProtoMessage()

func (*ExecuteEffectRequest) ProtoReflect 

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

func (*ExecuteEffectRequest) Reset 

func (x *ExecuteEffectRequest) Reset()

func (*ExecuteEffectRequest) String 

func (x *ExecuteEffectRequest) String() string

type ExecuteEffectResponse 

type ExecuteEffectResponse struct {
	Receipt  *EffectReceipt `protobuf:"bytes,1,opt,name=receipt,proto3" json:"receipt,omitempty"`
	Replayed bool           `protobuf:"varint,2,opt,name=replayed,proto3" json:"replayed,omitempty"`
	// contains filtered or unexported fields
}

func (*ExecuteEffectResponse) Descriptor deprecated 

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

Deprecated: Use ExecuteEffectResponse.ProtoReflect.Descriptor instead.

func (*ExecuteEffectResponse) GetReceipt 

func (x *ExecuteEffectResponse) GetReceipt() *EffectReceipt

func (*ExecuteEffectResponse) GetReplayed 

func (x *ExecuteEffectResponse) GetReplayed() bool

func (*ExecuteEffectResponse) ProtoMessage 

func (*ExecuteEffectResponse) ProtoMessage()

func (*ExecuteEffectResponse) ProtoReflect 

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

func (*ExecuteEffectResponse) Reset 

func (x *ExecuteEffectResponse) Reset()

func (*ExecuteEffectResponse) String 

func (x *ExecuteEffectResponse) String() string

type GetEffectByIdempotencyKeyRequest 

type GetEffectByIdempotencyKeyRequest struct {
	TenantId       string `protobuf:"bytes,1,opt,name=tenant_id,json=tenantId,proto3" json:"tenant_id,omitempty"`
	AgentId        string `protobuf:"bytes,2,opt,name=agent_id,json=agentId,proto3" json:"agent_id,omitempty"`
	IdempotencyKey string `protobuf:"bytes,3,opt,name=idempotency_key,json=idempotencyKey,proto3" json:"idempotency_key,omitempty"`
	// contains filtered or unexported fields
}

func (*GetEffectByIdempotencyKeyRequest) Descriptor deprecated 

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

Deprecated: Use GetEffectByIdempotencyKeyRequest.ProtoReflect.Descriptor instead.

func (*GetEffectByIdempotencyKeyRequest) GetAgentId 

func (x *GetEffectByIdempotencyKeyRequest) GetAgentId() string

func (*GetEffectByIdempotencyKeyRequest) GetIdempotencyKey 

func (x *GetEffectByIdempotencyKeyRequest) GetIdempotencyKey() string

func (*GetEffectByIdempotencyKeyRequest) GetTenantId 

func (x *GetEffectByIdempotencyKeyRequest) GetTenantId() string

func (*GetEffectByIdempotencyKeyRequest) ProtoMessage 

func (*GetEffectByIdempotencyKeyRequest) ProtoMessage()

func (*GetEffectByIdempotencyKeyRequest) ProtoReflect 

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

func (*GetEffectByIdempotencyKeyRequest) Reset 

func (x *GetEffectByIdempotencyKeyRequest) Reset()

func (*GetEffectByIdempotencyKeyRequest) String 

func (x *GetEffectByIdempotencyKeyRequest) String() string

type GetEffectByIdempotencyKeyResponse 

type GetEffectByIdempotencyKeyResponse struct {
	Record *EffectRecord `protobuf:"bytes,1,opt,name=record,proto3" json:"record,omitempty"`
	// contains filtered or unexported fields
}

func (*GetEffectByIdempotencyKeyResponse) Descriptor deprecated 

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

Deprecated: Use GetEffectByIdempotencyKeyResponse.ProtoReflect.Descriptor instead.

func (*GetEffectByIdempotencyKeyResponse) GetRecord 

func (x *GetEffectByIdempotencyKeyResponse) GetRecord() *EffectRecord

func (*GetEffectByIdempotencyKeyResponse) ProtoMessage 

func (*GetEffectByIdempotencyKeyResponse) ProtoMessage()

func (*GetEffectByIdempotencyKeyResponse) ProtoReflect 

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

func (*GetEffectByIdempotencyKeyResponse) Reset 

func (x *GetEffectByIdempotencyKeyResponse) Reset()

func (*GetEffectByIdempotencyKeyResponse) String 

func (x *GetEffectByIdempotencyKeyResponse) String() string

type GetEffectRequest 

type GetEffectRequest struct {
	TenantId string `protobuf:"bytes,1,opt,name=tenant_id,json=tenantId,proto3" json:"tenant_id,omitempty"`
	EffectId string `protobuf:"bytes,2,opt,name=effect_id,json=effectId,proto3" json:"effect_id,omitempty"`
	// contains filtered or unexported fields
}

func (*GetEffectRequest) Descriptor deprecated 

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

Deprecated: Use GetEffectRequest.ProtoReflect.Descriptor instead.

func (*GetEffectRequest) GetEffectId 

func (x *GetEffectRequest) GetEffectId() string

func (*GetEffectRequest) GetTenantId 

func (x *GetEffectRequest) GetTenantId() string

func (*GetEffectRequest) ProtoMessage 

func (*GetEffectRequest) ProtoMessage()

func (*GetEffectRequest) ProtoReflect 

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

func (*GetEffectRequest) Reset 

func (x *GetEffectRequest) Reset()

func (*GetEffectRequest) String 

func (x *GetEffectRequest) String() string

type GetEffectResponse 

type GetEffectResponse struct {
	Record *EffectRecord `protobuf:"bytes,1,opt,name=record,proto3" json:"record,omitempty"`
	// contains filtered or unexported fields
}

func (*GetEffectResponse) Descriptor deprecated 

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

Deprecated: Use GetEffectResponse.ProtoReflect.Descriptor instead.

func (*GetEffectResponse) GetRecord 

func (x *GetEffectResponse) GetRecord() *EffectRecord

func (*GetEffectResponse) ProtoMessage 

func (*GetEffectResponse) ProtoMessage()

func (*GetEffectResponse) ProtoReflect 

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

func (*GetEffectResponse) Reset 

func (x *GetEffectResponse) Reset()

func (*GetEffectResponse) String 

func (x *GetEffectResponse) String() string

type UnimplementedEffectServiceServer 

type UnimplementedEffectServiceServer struct{}

UnimplementedEffectServiceServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedEffectServiceServer) ExecuteEffect 

func (UnimplementedEffectServiceServer) ExecuteEffect(context.Context, *ExecuteEffectRequest) (*ExecuteEffectResponse, error)

func (UnimplementedEffectServiceServer) GetEffect 

func (UnimplementedEffectServiceServer) GetEffect(context.Context, *GetEffectRequest) (*GetEffectResponse, error)

func (UnimplementedEffectServiceServer) GetEffectByIdempotencyKey 

func (UnimplementedEffectServiceServer) GetEffectByIdempotencyKey(context.Context, *GetEffectByIdempotencyKeyRequest) (*GetEffectByIdempotencyKeyResponse, error)

type UnsafeEffectServiceServer 

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

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

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.