v1alpha1

package
v1.17.0 Latest Latest
Warning

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

Go to latest
Published: Aug 12, 2024 License: Apache-2.0 Imports: 10 Imported by: 3

Documentation

Index

Constants

View Source
const (
	ChangeLogService_SendChangeLog_FullMethodName = "/changelogs.proto.v1alpha1.ChangeLogService/SendChangeLog"
)

Variables

View Source
var (
	OperationType_name = map[int32]string{
		0: "OPERATION_TYPE_UNSPECIFIED",
		1: "OPERATION_TYPE_CREATE",
		2: "OPERATION_TYPE_UPDATE",
		3: "OPERATION_TYPE_DELETE",
	}
	OperationType_value = map[string]int32{
		"OPERATION_TYPE_UNSPECIFIED": 0,
		"OPERATION_TYPE_CREATE":      1,
		"OPERATION_TYPE_UPDATE":      2,
		"OPERATION_TYPE_DELETE":      3,
	}
)

Enum value maps for OperationType.

View Source
var ChangeLogService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "changelogs.proto.v1alpha1.ChangeLogService",
	HandlerType: (*ChangeLogServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "SendChangeLog",
			Handler:    _ChangeLogService_SendChangeLog_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "changelogs/proto/v1alpha1/changelog.proto",
}

ChangeLogService_ServiceDesc is the grpc.ServiceDesc for ChangeLogService 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_changelogs_proto_v1alpha1_changelog_proto protoreflect.FileDescriptor

Functions

func RegisterChangeLogServiceServer

func RegisterChangeLogServiceServer(s grpc.ServiceRegistrar, srv ChangeLogServiceServer)

Types

type ChangeLogEntry

type ChangeLogEntry struct {

	// The timestamp at which the change occurred.
	Timestamp *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// The name and version of the provider that is making the change to the
	// resource.
	Provider string `protobuf:"bytes,2,opt,name=provider,proto3" json:"provider,omitempty"`
	// The API version of the resource that was changed, e.g. Group/Version.
	ApiVersion string `protobuf:"bytes,3,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"`
	// The kind of the resource that was changed.
	Kind string `protobuf:"bytes,4,opt,name=kind,proto3" json:"kind,omitempty"`
	// The name of the resource that was changed.
	Name string `protobuf:"bytes,5,opt,name=name,proto3" json:"name,omitempty"`
	// The external name of the resource that was changed.
	ExternalName string `protobuf:"bytes,6,opt,name=external_name,json=externalName,proto3" json:"external_name,omitempty"`
	// The type of operation that was performed on the resource, e.g. Create,
	// Update, or Delete.
	Operation OperationType `protobuf:"varint,7,opt,name=operation,proto3,enum=changelogs.proto.v1alpha1.OperationType" json:"operation,omitempty"`
	// A full snapshot of the resource's state, as observed directly before the
	// resource was changed.
	Snapshot *structpb.Struct `protobuf:"bytes,8,opt,name=snapshot,proto3" json:"snapshot,omitempty"`
	// An optional error message that describes any error encountered while
	// performing the operation on the resource.
	ErrorMessage *string `protobuf:"bytes,9,opt,name=error_message,json=errorMessage,proto3,oneof" json:"error_message,omitempty"`
	// An optional additional details that can be provided for further context
	// about the change.
	AdditionalDetails map[string]string `` /* 201-byte string literal not displayed */
	// contains filtered or unexported fields
}

ChangeLogEntry represents a single change log entry, with detailed information about the resource that was changed.

func (*ChangeLogEntry) Descriptor deprecated

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

Deprecated: Use ChangeLogEntry.ProtoReflect.Descriptor instead.

func (*ChangeLogEntry) GetAdditionalDetails

func (x *ChangeLogEntry) GetAdditionalDetails() map[string]string

func (*ChangeLogEntry) GetApiVersion

func (x *ChangeLogEntry) GetApiVersion() string

func (*ChangeLogEntry) GetErrorMessage

func (x *ChangeLogEntry) GetErrorMessage() string

func (*ChangeLogEntry) GetExternalName

func (x *ChangeLogEntry) GetExternalName() string

func (*ChangeLogEntry) GetKind

func (x *ChangeLogEntry) GetKind() string

func (*ChangeLogEntry) GetName

func (x *ChangeLogEntry) GetName() string

func (*ChangeLogEntry) GetOperation

func (x *ChangeLogEntry) GetOperation() OperationType

func (*ChangeLogEntry) GetProvider

func (x *ChangeLogEntry) GetProvider() string

func (*ChangeLogEntry) GetSnapshot

func (x *ChangeLogEntry) GetSnapshot() *structpb.Struct

func (*ChangeLogEntry) GetTimestamp

func (x *ChangeLogEntry) GetTimestamp() *timestamppb.Timestamp

func (*ChangeLogEntry) ProtoMessage

func (*ChangeLogEntry) ProtoMessage()

func (*ChangeLogEntry) ProtoReflect

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

func (*ChangeLogEntry) Reset

func (x *ChangeLogEntry) Reset()

func (*ChangeLogEntry) String

func (x *ChangeLogEntry) String() string

type ChangeLogServiceClient

type ChangeLogServiceClient interface {
	// SendChangeLog sends a change log entry to the change log service.
	SendChangeLog(ctx context.Context, in *SendChangeLogRequest, opts ...grpc.CallOption) (*SendChangeLogResponse, error)
}

ChangeLogServiceClient is the client API for ChangeLogService service.

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

type ChangeLogServiceServer

type ChangeLogServiceServer interface {
	// SendChangeLog sends a change log entry to the change log service.
	SendChangeLog(context.Context, *SendChangeLogRequest) (*SendChangeLogResponse, error)
	// contains filtered or unexported methods
}

ChangeLogServiceServer is the server API for ChangeLogService service. All implementations must embed UnimplementedChangeLogServiceServer for forward compatibility

type OperationType

type OperationType int32

OperationType represents the type of operation that was performed on a resource.

const (
	OperationType_OPERATION_TYPE_UNSPECIFIED OperationType = 0
	OperationType_OPERATION_TYPE_CREATE      OperationType = 1
	OperationType_OPERATION_TYPE_UPDATE      OperationType = 2
	OperationType_OPERATION_TYPE_DELETE      OperationType = 3
)

func (OperationType) Descriptor

func (OperationType) Enum

func (x OperationType) Enum() *OperationType

func (OperationType) EnumDescriptor deprecated

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

Deprecated: Use OperationType.Descriptor instead.

func (OperationType) Number

func (OperationType) String

func (x OperationType) String() string

func (OperationType) Type

type SendChangeLogRequest

type SendChangeLogRequest struct {

	// The change log entry to send as part of this request.
	Entry *ChangeLogEntry `protobuf:"bytes,1,opt,name=entry,proto3" json:"entry,omitempty"`
	// contains filtered or unexported fields
}

SendChangeLogRequest represents a request to send a single change log entry.

func (*SendChangeLogRequest) Descriptor deprecated

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

Deprecated: Use SendChangeLogRequest.ProtoReflect.Descriptor instead.

func (*SendChangeLogRequest) GetEntry

func (x *SendChangeLogRequest) GetEntry() *ChangeLogEntry

func (*SendChangeLogRequest) ProtoMessage

func (*SendChangeLogRequest) ProtoMessage()

func (*SendChangeLogRequest) ProtoReflect

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

func (*SendChangeLogRequest) Reset

func (x *SendChangeLogRequest) Reset()

func (*SendChangeLogRequest) String

func (x *SendChangeLogRequest) String() string

type SendChangeLogResponse

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

SendChangeLogResponse is the response returned by the ChangeLogService after a change log entry is sent. Currently, this is an empty message as the only useful information expected to sent back at this time will be through errors.

func (*SendChangeLogResponse) Descriptor deprecated

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

Deprecated: Use SendChangeLogResponse.ProtoReflect.Descriptor instead.

func (*SendChangeLogResponse) ProtoMessage

func (*SendChangeLogResponse) ProtoMessage()

func (*SendChangeLogResponse) ProtoReflect

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

func (*SendChangeLogResponse) Reset

func (x *SendChangeLogResponse) Reset()

func (*SendChangeLogResponse) String

func (x *SendChangeLogResponse) String() string

type UnimplementedChangeLogServiceServer

type UnimplementedChangeLogServiceServer struct {
}

UnimplementedChangeLogServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedChangeLogServiceServer) SendChangeLog

type UnsafeChangeLogServiceServer

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

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

Jump to

Keyboard shortcuts

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