v0

package
v1.3.0 Latest Latest
Warning

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

Go to latest
Published: Jan 27, 2025 License: Apache-2.0 Imports: 25 Imported by: 0

Documentation

Index

Constants

View Source
const (
	WatchPermissionSetsService_WatchPermissionSets_FullMethodName  = "/authzed.api.materialize.v0.WatchPermissionSetsService/WatchPermissionSets"
	WatchPermissionSetsService_LookupPermissionSets_FullMethodName = "/authzed.api.materialize.v0.WatchPermissionSetsService/LookupPermissionSets"
)
View Source
const (
	WatchPermissionsService_WatchPermissions_FullMethodName = "/authzed.api.materialize.v0.WatchPermissionsService/WatchPermissions"
)

Variables

View Source
var (
	PermissionChange_Permissionship_name = map[int32]string{
		0: "PERMISSIONSHIP_UNSPECIFIED",
		1: "PERMISSIONSHIP_NO_PERMISSION",
		2: "PERMISSIONSHIP_HAS_PERMISSION",
		3: "PERMISSIONSHIP_CONDITIONAL_PERMISSION",
	}
	PermissionChange_Permissionship_value = map[string]int32{
		"PERMISSIONSHIP_UNSPECIFIED":            0,
		"PERMISSIONSHIP_NO_PERMISSION":          1,
		"PERMISSIONSHIP_HAS_PERMISSION":         2,
		"PERMISSIONSHIP_CONDITIONAL_PERMISSION": 3,
	}
)

Enum value maps for PermissionChange_Permissionship.

View Source
var (
	PermissionSetChange_SetOperation_name = map[int32]string{
		0: "SET_OPERATION_UNSPECIFIED",
		1: "SET_OPERATION_ADDED",
		2: "SET_OPERATION_REMOVED",
	}
	PermissionSetChange_SetOperation_value = map[string]int32{
		"SET_OPERATION_UNSPECIFIED": 0,
		"SET_OPERATION_ADDED":       1,
		"SET_OPERATION_REMOVED":     2,
	}
)

Enum value maps for PermissionSetChange_SetOperation.

View Source
var File_authzed_api_materialize_v0_watchpermissions_proto protoreflect.FileDescriptor
View Source
var File_authzed_api_materialize_v0_watchpermissionsets_proto protoreflect.FileDescriptor
View Source
var WatchPermissionSetsService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "authzed.api.materialize.v0.WatchPermissionSetsService",
	HandlerType: (*WatchPermissionSetsServiceServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "WatchPermissionSets",
			Handler:       _WatchPermissionSetsService_WatchPermissionSets_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "LookupPermissionSets",
			Handler:       _WatchPermissionSetsService_LookupPermissionSets_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "authzed/api/materialize/v0/watchpermissionsets.proto",
}

WatchPermissionSetsService_ServiceDesc is the grpc.ServiceDesc for WatchPermissionSetsService 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 WatchPermissionsService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "authzed.api.materialize.v0.WatchPermissionsService",
	HandlerType: (*WatchPermissionsServiceServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "WatchPermissions",
			Handler:       _WatchPermissionsService_WatchPermissions_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "authzed/api/materialize/v0/watchpermissions.proto",
}

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

Functions

func RegisterWatchPermissionSetsServiceServer

func RegisterWatchPermissionSetsServiceServer(s grpc.ServiceRegistrar, srv WatchPermissionSetsServiceServer)

func RegisterWatchPermissionsServiceServer

func RegisterWatchPermissionsServiceServer(s grpc.ServiceRegistrar, srv WatchPermissionsServiceServer)

Types

type BreakingSchemaChange added in v0.14.0

type BreakingSchemaChange struct {

	// change_at is the revision at which a breaking schema event has happened.
	ChangeAt *v1.ZedToken `protobuf:"bytes,1,opt,name=change_at,json=changeAt,proto3" json:"change_at,omitempty"`
	// contains filtered or unexported fields
}

BreakingSchemaChange is used to signal a breaking schema change has happened, and that the consumer should expect delays in the ingestion of new changes, because the permission set snapshot needs to be rebuilt from scratch. Once the snapshot is ready, the consumer will receive a LookupPermissionSetsRequired event.

func (*BreakingSchemaChange) CloneMessageVT added in v0.14.0

func (m *BreakingSchemaChange) CloneMessageVT() proto.Message

func (*BreakingSchemaChange) CloneVT added in v0.14.0

func (*BreakingSchemaChange) Descriptor deprecated added in v0.14.0

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

Deprecated: Use BreakingSchemaChange.ProtoReflect.Descriptor instead.

func (*BreakingSchemaChange) EqualMessageVT added in v0.14.0

func (this *BreakingSchemaChange) EqualMessageVT(thatMsg proto.Message) bool

func (*BreakingSchemaChange) EqualVT added in v0.14.0

func (this *BreakingSchemaChange) EqualVT(that *BreakingSchemaChange) bool

func (*BreakingSchemaChange) GetChangeAt added in v0.14.0

func (x *BreakingSchemaChange) GetChangeAt() *v1.ZedToken

func (*BreakingSchemaChange) MarshalToSizedBufferVT added in v0.14.0

func (m *BreakingSchemaChange) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*BreakingSchemaChange) MarshalToVT added in v0.14.0

func (m *BreakingSchemaChange) MarshalToVT(dAtA []byte) (int, error)

func (*BreakingSchemaChange) MarshalVT added in v0.14.0

func (m *BreakingSchemaChange) MarshalVT() (dAtA []byte, err error)

func (*BreakingSchemaChange) ProtoMessage added in v0.14.0

func (*BreakingSchemaChange) ProtoMessage()

func (*BreakingSchemaChange) ProtoReflect added in v0.14.0

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

func (*BreakingSchemaChange) Reset added in v0.14.0

func (x *BreakingSchemaChange) Reset()

func (*BreakingSchemaChange) SizeVT added in v0.14.0

func (m *BreakingSchemaChange) SizeVT() (n int)

func (*BreakingSchemaChange) String added in v0.14.0

func (x *BreakingSchemaChange) String() string

func (*BreakingSchemaChange) UnmarshalVT added in v0.14.0

func (m *BreakingSchemaChange) UnmarshalVT(dAtA []byte) error

func (*BreakingSchemaChange) Validate added in v0.14.0

func (m *BreakingSchemaChange) Validate() error

Validate checks the field values on BreakingSchemaChange with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*BreakingSchemaChange) ValidateAll added in v0.14.0

func (m *BreakingSchemaChange) ValidateAll() error

ValidateAll checks the field values on BreakingSchemaChange with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in BreakingSchemaChangeMultiError, or nil if none found.

type BreakingSchemaChangeMultiError added in v0.14.0

type BreakingSchemaChangeMultiError []error

BreakingSchemaChangeMultiError is an error wrapping multiple validation errors returned by BreakingSchemaChange.ValidateAll() if the designated constraints aren't met.

func (BreakingSchemaChangeMultiError) AllErrors added in v0.14.0

func (m BreakingSchemaChangeMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (BreakingSchemaChangeMultiError) Error added in v0.14.0

Error returns a concatenation of all the error messages it wraps.

type BreakingSchemaChangeValidationError added in v0.14.0

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

BreakingSchemaChangeValidationError is the validation error returned by BreakingSchemaChange.Validate if the designated constraints aren't met.

func (BreakingSchemaChangeValidationError) Cause added in v0.14.0

Cause function returns cause value.

func (BreakingSchemaChangeValidationError) Error added in v0.14.0

Error satisfies the builtin error interface

func (BreakingSchemaChangeValidationError) ErrorName added in v0.14.0

ErrorName returns error name.

func (BreakingSchemaChangeValidationError) Field added in v0.14.0

Field function returns field value.

func (BreakingSchemaChangeValidationError) Key added in v0.14.0

Key function returns key value.

func (BreakingSchemaChangeValidationError) Reason added in v0.14.0

Reason function returns reason value.

type Cursor

type Cursor struct {

	// limit is the number of permission sets to stream over a single LookupPermissionSets call that was requested.
	Limit uint32 `protobuf:"varint,1,opt,name=limit,proto3" json:"limit,omitempty"`
	// token is the snapshot revision at which the cursor was computed.
	Token *v1.ZedToken `protobuf:"bytes,4,opt,name=token,proto3" json:"token,omitempty"`
	// starting_index is an offset of the permission set represented by this cursor
	StartingIndex uint32 `protobuf:"varint,5,opt,name=starting_index,json=startingIndex,proto3" json:"starting_index,omitempty"`
	// completed_members is a boolean flag that indicates that the cursor has reached the end of the permission sets
	CompletedMembers bool `protobuf:"varint,6,opt,name=completed_members,json=completedMembers,proto3" json:"completed_members,omitempty"`
	// starting_key is a string cursor used by some backends to resume the stream from a specific point.
	StartingKey string `protobuf:"bytes,7,opt,name=starting_key,json=startingKey,proto3" json:"starting_key,omitempty"`
	// cursor is a string-encoded internal materialize cursor.
	Cursor string `protobuf:"bytes,8,opt,name=cursor,proto3" json:"cursor,omitempty"`
	// contains filtered or unexported fields
}

func (*Cursor) CloneMessageVT

func (m *Cursor) CloneMessageVT() proto.Message

func (*Cursor) CloneVT

func (m *Cursor) CloneVT() *Cursor

func (*Cursor) Descriptor deprecated

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

Deprecated: Use Cursor.ProtoReflect.Descriptor instead.

func (*Cursor) EqualMessageVT

func (this *Cursor) EqualMessageVT(thatMsg proto.Message) bool

func (*Cursor) EqualVT

func (this *Cursor) EqualVT(that *Cursor) bool

func (*Cursor) GetCompletedMembers

func (x *Cursor) GetCompletedMembers() bool

func (*Cursor) GetCursor added in v1.2.0

func (x *Cursor) GetCursor() string

func (*Cursor) GetLimit

func (x *Cursor) GetLimit() uint32

func (*Cursor) GetStartingIndex

func (x *Cursor) GetStartingIndex() uint32

func (*Cursor) GetStartingKey added in v0.15.0

func (x *Cursor) GetStartingKey() string

func (*Cursor) GetToken

func (x *Cursor) GetToken() *v1.ZedToken

func (*Cursor) MarshalToSizedBufferVT

func (m *Cursor) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*Cursor) MarshalToVT

func (m *Cursor) MarshalToVT(dAtA []byte) (int, error)

func (*Cursor) MarshalVT

func (m *Cursor) MarshalVT() (dAtA []byte, err error)

func (*Cursor) ProtoMessage

func (*Cursor) ProtoMessage()

func (*Cursor) ProtoReflect

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

func (*Cursor) Reset

func (x *Cursor) Reset()

func (*Cursor) SizeVT

func (m *Cursor) SizeVT() (n int)

func (*Cursor) String

func (x *Cursor) String() string

func (*Cursor) UnmarshalVT

func (m *Cursor) UnmarshalVT(dAtA []byte) error

func (*Cursor) Validate

func (m *Cursor) Validate() error

Validate checks the field values on Cursor with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Cursor) ValidateAll

func (m *Cursor) ValidateAll() error

ValidateAll checks the field values on Cursor with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in CursorMultiError, or nil if none found.

type CursorMultiError

type CursorMultiError []error

CursorMultiError is an error wrapping multiple validation errors returned by Cursor.ValidateAll() if the designated constraints aren't met.

func (CursorMultiError) AllErrors

func (m CursorMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (CursorMultiError) Error

func (m CursorMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type CursorValidationError

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

CursorValidationError is the validation error returned by Cursor.Validate if the designated constraints aren't met.

func (CursorValidationError) Cause

func (e CursorValidationError) Cause() error

Cause function returns cause value.

func (CursorValidationError) Error

func (e CursorValidationError) Error() string

Error satisfies the builtin error interface

func (CursorValidationError) ErrorName

func (e CursorValidationError) ErrorName() string

ErrorName returns error name.

func (CursorValidationError) Field

func (e CursorValidationError) Field() string

Field function returns field value.

func (CursorValidationError) Key

func (e CursorValidationError) Key() bool

Key function returns key value.

func (CursorValidationError) Reason

func (e CursorValidationError) Reason() string

Reason function returns reason value.

type LookupPermissionSetsRequest

type LookupPermissionSetsRequest struct {

	// limit is the number of permission sets to stream over a single LookupPermissionSets. Once the limit is reached,
	// the server will close the stream. If more permission sets are available, the consume should open a new stream
	// providing optional_starting_after_cursor, using the cursor from the last response.
	Limit uint32 `protobuf:"varint,1,opt,name=limit,proto3" json:"limit,omitempty"`
	// optional_at_revision specifies the client is requesting to lookup PermissionSets at a specific revision. It's
	// optional, and if not provided, PermissionSets will be looked up at the current revision. The cursor always
	// takes precedence in defining the revision when present.
	OptionalAtRevision *v1.ZedToken `protobuf:"bytes,2,opt,name=optional_at_revision,json=optionalAtRevision,proto3" json:"optional_at_revision,omitempty"`
	// optional_starting_after_cursor is used to specify the offset to start streaming permission sets from.
	OptionalStartingAfterCursor *Cursor `` /* 146-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*LookupPermissionSetsRequest) CloneMessageVT

func (m *LookupPermissionSetsRequest) CloneMessageVT() proto.Message

func (*LookupPermissionSetsRequest) CloneVT

func (*LookupPermissionSetsRequest) Descriptor deprecated

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

Deprecated: Use LookupPermissionSetsRequest.ProtoReflect.Descriptor instead.

func (*LookupPermissionSetsRequest) EqualMessageVT

func (this *LookupPermissionSetsRequest) EqualMessageVT(thatMsg proto.Message) bool

func (*LookupPermissionSetsRequest) EqualVT

func (*LookupPermissionSetsRequest) GetLimit

func (x *LookupPermissionSetsRequest) GetLimit() uint32

func (*LookupPermissionSetsRequest) GetOptionalAtRevision added in v0.14.0

func (x *LookupPermissionSetsRequest) GetOptionalAtRevision() *v1.ZedToken

func (*LookupPermissionSetsRequest) GetOptionalStartingAfterCursor

func (x *LookupPermissionSetsRequest) GetOptionalStartingAfterCursor() *Cursor

func (*LookupPermissionSetsRequest) MarshalToSizedBufferVT

func (m *LookupPermissionSetsRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*LookupPermissionSetsRequest) MarshalToVT

func (m *LookupPermissionSetsRequest) MarshalToVT(dAtA []byte) (int, error)

func (*LookupPermissionSetsRequest) MarshalVT

func (m *LookupPermissionSetsRequest) MarshalVT() (dAtA []byte, err error)

func (*LookupPermissionSetsRequest) ProtoMessage

func (*LookupPermissionSetsRequest) ProtoMessage()

func (*LookupPermissionSetsRequest) ProtoReflect

func (*LookupPermissionSetsRequest) Reset

func (x *LookupPermissionSetsRequest) Reset()

func (*LookupPermissionSetsRequest) SizeVT

func (m *LookupPermissionSetsRequest) SizeVT() (n int)

func (*LookupPermissionSetsRequest) String

func (x *LookupPermissionSetsRequest) String() string

func (*LookupPermissionSetsRequest) UnmarshalVT

func (m *LookupPermissionSetsRequest) UnmarshalVT(dAtA []byte) error

func (*LookupPermissionSetsRequest) Validate

func (m *LookupPermissionSetsRequest) Validate() error

Validate checks the field values on LookupPermissionSetsRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*LookupPermissionSetsRequest) ValidateAll

func (m *LookupPermissionSetsRequest) ValidateAll() error

ValidateAll checks the field values on LookupPermissionSetsRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in LookupPermissionSetsRequestMultiError, or nil if none found.

type LookupPermissionSetsRequestMultiError

type LookupPermissionSetsRequestMultiError []error

LookupPermissionSetsRequestMultiError is an error wrapping multiple validation errors returned by LookupPermissionSetsRequest.ValidateAll() if the designated constraints aren't met.

func (LookupPermissionSetsRequestMultiError) AllErrors

AllErrors returns a list of validation violation errors.

func (LookupPermissionSetsRequestMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type LookupPermissionSetsRequestValidationError

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

LookupPermissionSetsRequestValidationError is the validation error returned by LookupPermissionSetsRequest.Validate if the designated constraints aren't met.

func (LookupPermissionSetsRequestValidationError) Cause

Cause function returns cause value.

func (LookupPermissionSetsRequestValidationError) Error

Error satisfies the builtin error interface

func (LookupPermissionSetsRequestValidationError) ErrorName

ErrorName returns error name.

func (LookupPermissionSetsRequestValidationError) Field

Field function returns field value.

func (LookupPermissionSetsRequestValidationError) Key

Key function returns key value.

func (LookupPermissionSetsRequestValidationError) Reason

Reason function returns reason value.

type LookupPermissionSetsRequired

type LookupPermissionSetsRequired struct {

	// required_lookup_at is the snapshot revision at which the permission set needs to be rebuilt to.
	RequiredLookupAt *v1.ZedToken `protobuf:"bytes,1,opt,name=required_lookup_at,json=requiredLookupAt,proto3" json:"required_lookup_at,omitempty"`
	// contains filtered or unexported fields
}

LookupPermissionSetsRequired is a signal that the consumer should perform a LookupPermissionSets call because the permission set snapshot needs to be rebuilt from scratch. This typically happens when the origin SpiceDB cluster has seen its schema changed, see BreakingSchemaChange event.

func (*LookupPermissionSetsRequired) CloneMessageVT

func (m *LookupPermissionSetsRequired) CloneMessageVT() proto.Message

func (*LookupPermissionSetsRequired) CloneVT

func (*LookupPermissionSetsRequired) Descriptor deprecated

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

Deprecated: Use LookupPermissionSetsRequired.ProtoReflect.Descriptor instead.

func (*LookupPermissionSetsRequired) EqualMessageVT

func (this *LookupPermissionSetsRequired) EqualMessageVT(thatMsg proto.Message) bool

func (*LookupPermissionSetsRequired) EqualVT

func (*LookupPermissionSetsRequired) GetRequiredLookupAt

func (x *LookupPermissionSetsRequired) GetRequiredLookupAt() *v1.ZedToken

func (*LookupPermissionSetsRequired) MarshalToSizedBufferVT

func (m *LookupPermissionSetsRequired) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*LookupPermissionSetsRequired) MarshalToVT

func (m *LookupPermissionSetsRequired) MarshalToVT(dAtA []byte) (int, error)

func (*LookupPermissionSetsRequired) MarshalVT

func (m *LookupPermissionSetsRequired) MarshalVT() (dAtA []byte, err error)

func (*LookupPermissionSetsRequired) ProtoMessage

func (*LookupPermissionSetsRequired) ProtoMessage()

func (*LookupPermissionSetsRequired) ProtoReflect

func (*LookupPermissionSetsRequired) Reset

func (x *LookupPermissionSetsRequired) Reset()

func (*LookupPermissionSetsRequired) SizeVT

func (m *LookupPermissionSetsRequired) SizeVT() (n int)

func (*LookupPermissionSetsRequired) String

func (*LookupPermissionSetsRequired) UnmarshalVT

func (m *LookupPermissionSetsRequired) UnmarshalVT(dAtA []byte) error

func (*LookupPermissionSetsRequired) Validate

func (m *LookupPermissionSetsRequired) Validate() error

Validate checks the field values on LookupPermissionSetsRequired with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*LookupPermissionSetsRequired) ValidateAll

func (m *LookupPermissionSetsRequired) ValidateAll() error

ValidateAll checks the field values on LookupPermissionSetsRequired with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in LookupPermissionSetsRequiredMultiError, or nil if none found.

type LookupPermissionSetsRequiredMultiError

type LookupPermissionSetsRequiredMultiError []error

LookupPermissionSetsRequiredMultiError is an error wrapping multiple validation errors returned by LookupPermissionSetsRequired.ValidateAll() if the designated constraints aren't met.

func (LookupPermissionSetsRequiredMultiError) AllErrors

AllErrors returns a list of validation violation errors.

func (LookupPermissionSetsRequiredMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type LookupPermissionSetsRequiredValidationError

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

LookupPermissionSetsRequiredValidationError is the validation error returned by LookupPermissionSetsRequired.Validate if the designated constraints aren't met.

func (LookupPermissionSetsRequiredValidationError) Cause

Cause function returns cause value.

func (LookupPermissionSetsRequiredValidationError) Error

Error satisfies the builtin error interface

func (LookupPermissionSetsRequiredValidationError) ErrorName

ErrorName returns error name.

func (LookupPermissionSetsRequiredValidationError) Field

Field function returns field value.

func (LookupPermissionSetsRequiredValidationError) Key

Key function returns key value.

func (LookupPermissionSetsRequiredValidationError) Reason

Reason function returns reason value.

type LookupPermissionSetsResponse

type LookupPermissionSetsResponse struct {

	// change represents the permission set delta necessary to transition an uninitialized target system to
	// a specific snapshot revision. In practice it's not different from the WatchPermissionSetsResponse.change, except
	// all changes will be of time SET_OPERATION_ADDED because it's assumed there is no known previous state.
	//
	// Applying the deltas to a previously initialized target system would yield incorrect results.
	Change *PermissionSetChange `protobuf:"bytes,1,opt,name=change,proto3" json:"change,omitempty"`
	// cursor points to a specific permission set in a revision.
	// The consumer should keep track of the cursor in order to resume streaming in the event of consumer restarts. This
	// is particularly important in backfill scenarios that may take hours or event days to complete.
	Cursor *Cursor `protobuf:"bytes,2,opt,name=cursor,proto3" json:"cursor,omitempty"`
	// contains filtered or unexported fields
}

func (*LookupPermissionSetsResponse) CloneMessageVT

func (m *LookupPermissionSetsResponse) CloneMessageVT() proto.Message

func (*LookupPermissionSetsResponse) CloneVT

func (*LookupPermissionSetsResponse) Descriptor deprecated

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

Deprecated: Use LookupPermissionSetsResponse.ProtoReflect.Descriptor instead.

func (*LookupPermissionSetsResponse) EqualMessageVT

func (this *LookupPermissionSetsResponse) EqualMessageVT(thatMsg proto.Message) bool

func (*LookupPermissionSetsResponse) EqualVT

func (*LookupPermissionSetsResponse) GetChange

func (*LookupPermissionSetsResponse) GetCursor

func (x *LookupPermissionSetsResponse) GetCursor() *Cursor

func (*LookupPermissionSetsResponse) MarshalToSizedBufferVT

func (m *LookupPermissionSetsResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*LookupPermissionSetsResponse) MarshalToVT

func (m *LookupPermissionSetsResponse) MarshalToVT(dAtA []byte) (int, error)

func (*LookupPermissionSetsResponse) MarshalVT

func (m *LookupPermissionSetsResponse) MarshalVT() (dAtA []byte, err error)

func (*LookupPermissionSetsResponse) ProtoMessage

func (*LookupPermissionSetsResponse) ProtoMessage()

func (*LookupPermissionSetsResponse) ProtoReflect

func (*LookupPermissionSetsResponse) Reset

func (x *LookupPermissionSetsResponse) Reset()

func (*LookupPermissionSetsResponse) SizeVT

func (m *LookupPermissionSetsResponse) SizeVT() (n int)

func (*LookupPermissionSetsResponse) String

func (*LookupPermissionSetsResponse) UnmarshalVT

func (m *LookupPermissionSetsResponse) UnmarshalVT(dAtA []byte) error

func (*LookupPermissionSetsResponse) Validate

func (m *LookupPermissionSetsResponse) Validate() error

Validate checks the field values on LookupPermissionSetsResponse with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*LookupPermissionSetsResponse) ValidateAll

func (m *LookupPermissionSetsResponse) ValidateAll() error

ValidateAll checks the field values on LookupPermissionSetsResponse with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in LookupPermissionSetsResponseMultiError, or nil if none found.

type LookupPermissionSetsResponseMultiError

type LookupPermissionSetsResponseMultiError []error

LookupPermissionSetsResponseMultiError is an error wrapping multiple validation errors returned by LookupPermissionSetsResponse.ValidateAll() if the designated constraints aren't met.

func (LookupPermissionSetsResponseMultiError) AllErrors

AllErrors returns a list of validation violation errors.

func (LookupPermissionSetsResponseMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type LookupPermissionSetsResponseValidationError

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

LookupPermissionSetsResponseValidationError is the validation error returned by LookupPermissionSetsResponse.Validate if the designated constraints aren't met.

func (LookupPermissionSetsResponseValidationError) Cause

Cause function returns cause value.

func (LookupPermissionSetsResponseValidationError) Error

Error satisfies the builtin error interface

func (LookupPermissionSetsResponseValidationError) ErrorName

ErrorName returns error name.

func (LookupPermissionSetsResponseValidationError) Field

Field function returns field value.

func (LookupPermissionSetsResponseValidationError) Key

Key function returns key value.

func (LookupPermissionSetsResponseValidationError) Reason

Reason function returns reason value.

type MemberReference

type MemberReference struct {

	// object_type is the type of object of a permission set member
	ObjectType string `protobuf:"bytes,1,opt,name=object_type,json=objectType,proto3" json:"object_type,omitempty"`
	// object_id is the ID of a permission set member
	ObjectId string `protobuf:"bytes,2,opt,name=object_id,json=objectId,proto3" json:"object_id,omitempty"`
	// optional_permission_or_relation is the permission or relation referenced by this permission set member
	OptionalPermissionOrRelation string `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*MemberReference) CloneMessageVT

func (m *MemberReference) CloneMessageVT() proto.Message

func (*MemberReference) CloneVT

func (m *MemberReference) CloneVT() *MemberReference

func (*MemberReference) Descriptor deprecated

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

Deprecated: Use MemberReference.ProtoReflect.Descriptor instead.

func (*MemberReference) EqualMessageVT

func (this *MemberReference) EqualMessageVT(thatMsg proto.Message) bool

func (*MemberReference) EqualVT

func (this *MemberReference) EqualVT(that *MemberReference) bool

func (*MemberReference) GetObjectId

func (x *MemberReference) GetObjectId() string

func (*MemberReference) GetObjectType

func (x *MemberReference) GetObjectType() string

func (*MemberReference) GetOptionalPermissionOrRelation

func (x *MemberReference) GetOptionalPermissionOrRelation() string

func (*MemberReference) MarshalToSizedBufferVT

func (m *MemberReference) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*MemberReference) MarshalToVT

func (m *MemberReference) MarshalToVT(dAtA []byte) (int, error)

func (*MemberReference) MarshalVT

func (m *MemberReference) MarshalVT() (dAtA []byte, err error)

func (*MemberReference) ProtoMessage

func (*MemberReference) ProtoMessage()

func (*MemberReference) ProtoReflect

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

func (*MemberReference) Reset

func (x *MemberReference) Reset()

func (*MemberReference) SizeVT

func (m *MemberReference) SizeVT() (n int)

func (*MemberReference) String

func (x *MemberReference) String() string

func (*MemberReference) UnmarshalVT

func (m *MemberReference) UnmarshalVT(dAtA []byte) error

func (*MemberReference) Validate

func (m *MemberReference) Validate() error

Validate checks the field values on MemberReference with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*MemberReference) ValidateAll

func (m *MemberReference) ValidateAll() error

ValidateAll checks the field values on MemberReference with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in MemberReferenceMultiError, or nil if none found.

type MemberReferenceMultiError

type MemberReferenceMultiError []error

MemberReferenceMultiError is an error wrapping multiple validation errors returned by MemberReference.ValidateAll() if the designated constraints aren't met.

func (MemberReferenceMultiError) AllErrors

func (m MemberReferenceMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (MemberReferenceMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type MemberReferenceValidationError

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

MemberReferenceValidationError is the validation error returned by MemberReference.Validate if the designated constraints aren't met.

func (MemberReferenceValidationError) Cause

Cause function returns cause value.

func (MemberReferenceValidationError) Error

Error satisfies the builtin error interface

func (MemberReferenceValidationError) ErrorName

func (e MemberReferenceValidationError) ErrorName() string

ErrorName returns error name.

func (MemberReferenceValidationError) Field

Field function returns field value.

func (MemberReferenceValidationError) Key

Key function returns key value.

func (MemberReferenceValidationError) Reason

Reason function returns reason value.

type PermissionChange

type PermissionChange struct {

	// revision represents the revision at which the change occurred.
	Revision *v1.ZedToken `protobuf:"bytes,1,opt,name=revision,proto3" json:"revision,omitempty"`
	// resource is the resource that the permission change is related to.
	Resource *v1.ObjectReference `protobuf:"bytes,2,opt,name=resource,proto3" json:"resource,omitempty"`
	// permission is the permission that has changed.
	Permission string `protobuf:"bytes,3,opt,name=permission,proto3" json:"permission,omitempty"`
	// subject is the subject that the permission change is related to.
	Subject *v1.SubjectReference `protobuf:"bytes,4,opt,name=subject,proto3" json:"subject,omitempty"`
	// permissionship is the new permissionship of the subject over the resource after the change.
	Permissionship PermissionChange_Permissionship `` /* 146-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*PermissionChange) CloneMessageVT

func (m *PermissionChange) CloneMessageVT() proto.Message

func (*PermissionChange) CloneVT

func (m *PermissionChange) CloneVT() *PermissionChange

func (*PermissionChange) Descriptor deprecated

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

Deprecated: Use PermissionChange.ProtoReflect.Descriptor instead.

func (*PermissionChange) EqualMessageVT

func (this *PermissionChange) EqualMessageVT(thatMsg proto.Message) bool

func (*PermissionChange) EqualVT

func (this *PermissionChange) EqualVT(that *PermissionChange) bool

func (*PermissionChange) GetPermission

func (x *PermissionChange) GetPermission() string

func (*PermissionChange) GetPermissionship

func (x *PermissionChange) GetPermissionship() PermissionChange_Permissionship

func (*PermissionChange) GetResource

func (x *PermissionChange) GetResource() *v1.ObjectReference

func (*PermissionChange) GetRevision

func (x *PermissionChange) GetRevision() *v1.ZedToken

func (*PermissionChange) GetSubject

func (x *PermissionChange) GetSubject() *v1.SubjectReference

func (*PermissionChange) MarshalToSizedBufferVT

func (m *PermissionChange) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*PermissionChange) MarshalToVT

func (m *PermissionChange) MarshalToVT(dAtA []byte) (int, error)

func (*PermissionChange) MarshalVT

func (m *PermissionChange) MarshalVT() (dAtA []byte, err error)

func (*PermissionChange) ProtoMessage

func (*PermissionChange) ProtoMessage()

func (*PermissionChange) ProtoReflect

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

func (*PermissionChange) Reset

func (x *PermissionChange) Reset()

func (*PermissionChange) SizeVT

func (m *PermissionChange) SizeVT() (n int)

func (*PermissionChange) String

func (x *PermissionChange) String() string

func (*PermissionChange) UnmarshalVT

func (m *PermissionChange) UnmarshalVT(dAtA []byte) error

func (*PermissionChange) Validate

func (m *PermissionChange) Validate() error

Validate checks the field values on PermissionChange with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*PermissionChange) ValidateAll

func (m *PermissionChange) ValidateAll() error

ValidateAll checks the field values on PermissionChange with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in PermissionChangeMultiError, or nil if none found.

type PermissionChangeMultiError

type PermissionChangeMultiError []error

PermissionChangeMultiError is an error wrapping multiple validation errors returned by PermissionChange.ValidateAll() if the designated constraints aren't met.

func (PermissionChangeMultiError) AllErrors

func (m PermissionChangeMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (PermissionChangeMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type PermissionChangeValidationError

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

PermissionChangeValidationError is the validation error returned by PermissionChange.Validate if the designated constraints aren't met.

func (PermissionChangeValidationError) Cause

Cause function returns cause value.

func (PermissionChangeValidationError) Error

Error satisfies the builtin error interface

func (PermissionChangeValidationError) ErrorName

ErrorName returns error name.

func (PermissionChangeValidationError) Field

Field function returns field value.

func (PermissionChangeValidationError) Key

Key function returns key value.

func (PermissionChangeValidationError) Reason

Reason function returns reason value.

type PermissionChange_Permissionship

type PermissionChange_Permissionship int32
const (
	PermissionChange_PERMISSIONSHIP_UNSPECIFIED            PermissionChange_Permissionship = 0
	PermissionChange_PERMISSIONSHIP_NO_PERMISSION          PermissionChange_Permissionship = 1
	PermissionChange_PERMISSIONSHIP_HAS_PERMISSION         PermissionChange_Permissionship = 2
	PermissionChange_PERMISSIONSHIP_CONDITIONAL_PERMISSION PermissionChange_Permissionship = 3
)

func (PermissionChange_Permissionship) Descriptor

func (PermissionChange_Permissionship) Enum

func (PermissionChange_Permissionship) EnumDescriptor deprecated

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

Deprecated: Use PermissionChange_Permissionship.Descriptor instead.

func (PermissionChange_Permissionship) Number

func (PermissionChange_Permissionship) String

func (PermissionChange_Permissionship) Type

type PermissionSetChange

type PermissionSetChange struct {

	// revision represents the revision at which the permission set change occurred.
	AtRevision *v1.ZedToken `protobuf:"bytes,1,opt,name=at_revision,json=atRevision,proto3" json:"at_revision,omitempty"`
	// operation represents the type of set operation that took place as part of the change
	Operation PermissionSetChange_SetOperation `` /* 137-byte string literal not displayed */
	// parent_set represents the permission set parent of either another set or a member
	ParentSet *SetReference `protobuf:"bytes,3,opt,name=parent_set,json=parentSet,proto3" json:"parent_set,omitempty"`
	// Types that are valid to be assigned to Child:
	//
	//	*PermissionSetChange_ChildSet
	//	*PermissionSetChange_ChildMember
	Child isPermissionSetChange_Child `protobuf_oneof:"child"`
	// contains filtered or unexported fields
}

func (*PermissionSetChange) CloneMessageVT

func (m *PermissionSetChange) CloneMessageVT() proto.Message

func (*PermissionSetChange) CloneVT

func (*PermissionSetChange) Descriptor deprecated

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

Deprecated: Use PermissionSetChange.ProtoReflect.Descriptor instead.

func (*PermissionSetChange) EqualMessageVT

func (this *PermissionSetChange) EqualMessageVT(thatMsg proto.Message) bool

func (*PermissionSetChange) EqualVT

func (this *PermissionSetChange) EqualVT(that *PermissionSetChange) bool

func (*PermissionSetChange) GetAtRevision

func (x *PermissionSetChange) GetAtRevision() *v1.ZedToken

func (*PermissionSetChange) GetChild

func (x *PermissionSetChange) GetChild() isPermissionSetChange_Child

func (*PermissionSetChange) GetChildMember

func (x *PermissionSetChange) GetChildMember() *MemberReference

func (*PermissionSetChange) GetChildSet

func (x *PermissionSetChange) GetChildSet() *SetReference

func (*PermissionSetChange) GetOperation

func (*PermissionSetChange) GetParentSet

func (x *PermissionSetChange) GetParentSet() *SetReference

func (*PermissionSetChange) MarshalToSizedBufferVT

func (m *PermissionSetChange) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*PermissionSetChange) MarshalToVT

func (m *PermissionSetChange) MarshalToVT(dAtA []byte) (int, error)

func (*PermissionSetChange) MarshalVT

func (m *PermissionSetChange) MarshalVT() (dAtA []byte, err error)

func (*PermissionSetChange) ProtoMessage

func (*PermissionSetChange) ProtoMessage()

func (*PermissionSetChange) ProtoReflect

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

func (*PermissionSetChange) Reset

func (x *PermissionSetChange) Reset()

func (*PermissionSetChange) SizeVT

func (m *PermissionSetChange) SizeVT() (n int)

func (*PermissionSetChange) String

func (x *PermissionSetChange) String() string

func (*PermissionSetChange) UnmarshalVT

func (m *PermissionSetChange) UnmarshalVT(dAtA []byte) error

func (*PermissionSetChange) Validate

func (m *PermissionSetChange) Validate() error

Validate checks the field values on PermissionSetChange with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*PermissionSetChange) ValidateAll

func (m *PermissionSetChange) ValidateAll() error

ValidateAll checks the field values on PermissionSetChange with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in PermissionSetChangeMultiError, or nil if none found.

type PermissionSetChangeMultiError

type PermissionSetChangeMultiError []error

PermissionSetChangeMultiError is an error wrapping multiple validation errors returned by PermissionSetChange.ValidateAll() if the designated constraints aren't met.

func (PermissionSetChangeMultiError) AllErrors

func (m PermissionSetChangeMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (PermissionSetChangeMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type PermissionSetChangeValidationError

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

PermissionSetChangeValidationError is the validation error returned by PermissionSetChange.Validate if the designated constraints aren't met.

func (PermissionSetChangeValidationError) Cause

Cause function returns cause value.

func (PermissionSetChangeValidationError) Error

Error satisfies the builtin error interface

func (PermissionSetChangeValidationError) ErrorName

ErrorName returns error name.

func (PermissionSetChangeValidationError) Field

Field function returns field value.

func (PermissionSetChangeValidationError) Key

Key function returns key value.

func (PermissionSetChangeValidationError) Reason

Reason function returns reason value.

type PermissionSetChange_ChildMember

type PermissionSetChange_ChildMember struct {
	// child_member represents the scenario where an specific object is considered member of the parent set
	ChildMember *MemberReference `protobuf:"bytes,5,opt,name=child_member,json=childMember,proto3,oneof"`
}

func (*PermissionSetChange_ChildMember) CloneVT

func (m *PermissionSetChange_ChildMember) CloneVT() isPermissionSetChange_Child

func (*PermissionSetChange_ChildMember) EqualVT

func (this *PermissionSetChange_ChildMember) EqualVT(thatIface isPermissionSetChange_Child) bool

func (*PermissionSetChange_ChildMember) MarshalToSizedBufferVT

func (m *PermissionSetChange_ChildMember) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*PermissionSetChange_ChildMember) MarshalToVT

func (m *PermissionSetChange_ChildMember) MarshalToVT(dAtA []byte) (int, error)

func (*PermissionSetChange_ChildMember) SizeVT

func (m *PermissionSetChange_ChildMember) SizeVT() (n int)

type PermissionSetChange_ChildSet

type PermissionSetChange_ChildSet struct {
	// child_set represents the scenario where another set is considered member of the parent set
	ChildSet *SetReference `protobuf:"bytes,4,opt,name=child_set,json=childSet,proto3,oneof"`
}

func (*PermissionSetChange_ChildSet) CloneVT

func (m *PermissionSetChange_ChildSet) CloneVT() isPermissionSetChange_Child

func (*PermissionSetChange_ChildSet) EqualVT

func (this *PermissionSetChange_ChildSet) EqualVT(thatIface isPermissionSetChange_Child) bool

func (*PermissionSetChange_ChildSet) MarshalToSizedBufferVT

func (m *PermissionSetChange_ChildSet) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*PermissionSetChange_ChildSet) MarshalToVT

func (m *PermissionSetChange_ChildSet) MarshalToVT(dAtA []byte) (int, error)

func (*PermissionSetChange_ChildSet) SizeVT

func (m *PermissionSetChange_ChildSet) SizeVT() (n int)

type PermissionSetChange_SetOperation

type PermissionSetChange_SetOperation int32
const (
	PermissionSetChange_SET_OPERATION_UNSPECIFIED PermissionSetChange_SetOperation = 0
	PermissionSetChange_SET_OPERATION_ADDED       PermissionSetChange_SetOperation = 1
	PermissionSetChange_SET_OPERATION_REMOVED     PermissionSetChange_SetOperation = 2
)

func (PermissionSetChange_SetOperation) Descriptor

func (PermissionSetChange_SetOperation) Enum

func (PermissionSetChange_SetOperation) EnumDescriptor deprecated

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

Deprecated: Use PermissionSetChange_SetOperation.Descriptor instead.

func (PermissionSetChange_SetOperation) Number

func (PermissionSetChange_SetOperation) String

func (PermissionSetChange_SetOperation) Type

type SetReference

type SetReference struct {

	// object_type is the type of object in a permission set
	ObjectType string `protobuf:"bytes,1,opt,name=object_type,json=objectType,proto3" json:"object_type,omitempty"`
	// object_id is the ID of a permission set
	ObjectId string `protobuf:"bytes,2,opt,name=object_id,json=objectId,proto3" json:"object_id,omitempty"`
	// permission_or_relation is the permission or relation referenced by this permission set
	PermissionOrRelation string `protobuf:"bytes,3,opt,name=permission_or_relation,json=permissionOrRelation,proto3" json:"permission_or_relation,omitempty"`
	// contains filtered or unexported fields
}

func (*SetReference) CloneMessageVT

func (m *SetReference) CloneMessageVT() proto.Message

func (*SetReference) CloneVT

func (m *SetReference) CloneVT() *SetReference

func (*SetReference) Descriptor deprecated

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

Deprecated: Use SetReference.ProtoReflect.Descriptor instead.

func (*SetReference) EqualMessageVT

func (this *SetReference) EqualMessageVT(thatMsg proto.Message) bool

func (*SetReference) EqualVT

func (this *SetReference) EqualVT(that *SetReference) bool

func (*SetReference) GetObjectId

func (x *SetReference) GetObjectId() string

func (*SetReference) GetObjectType

func (x *SetReference) GetObjectType() string

func (*SetReference) GetPermissionOrRelation

func (x *SetReference) GetPermissionOrRelation() string

func (*SetReference) MarshalToSizedBufferVT

func (m *SetReference) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*SetReference) MarshalToVT

func (m *SetReference) MarshalToVT(dAtA []byte) (int, error)

func (*SetReference) MarshalVT

func (m *SetReference) MarshalVT() (dAtA []byte, err error)

func (*SetReference) ProtoMessage

func (*SetReference) ProtoMessage()

func (*SetReference) ProtoReflect

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

func (*SetReference) Reset

func (x *SetReference) Reset()

func (*SetReference) SizeVT

func (m *SetReference) SizeVT() (n int)

func (*SetReference) String

func (x *SetReference) String() string

func (*SetReference) UnmarshalVT

func (m *SetReference) UnmarshalVT(dAtA []byte) error

func (*SetReference) Validate

func (m *SetReference) Validate() error

Validate checks the field values on SetReference with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*SetReference) ValidateAll

func (m *SetReference) ValidateAll() error

ValidateAll checks the field values on SetReference with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in SetReferenceMultiError, or nil if none found.

type SetReferenceMultiError

type SetReferenceMultiError []error

SetReferenceMultiError is an error wrapping multiple validation errors returned by SetReference.ValidateAll() if the designated constraints aren't met.

func (SetReferenceMultiError) AllErrors

func (m SetReferenceMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (SetReferenceMultiError) Error

func (m SetReferenceMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type SetReferenceValidationError

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

SetReferenceValidationError is the validation error returned by SetReference.Validate if the designated constraints aren't met.

func (SetReferenceValidationError) Cause

Cause function returns cause value.

func (SetReferenceValidationError) Error

Error satisfies the builtin error interface

func (SetReferenceValidationError) ErrorName

func (e SetReferenceValidationError) ErrorName() string

ErrorName returns error name.

func (SetReferenceValidationError) Field

Field function returns field value.

func (SetReferenceValidationError) Key

Key function returns key value.

func (SetReferenceValidationError) Reason

Reason function returns reason value.

type UnimplementedWatchPermissionSetsServiceServer

type UnimplementedWatchPermissionSetsServiceServer struct{}

UnimplementedWatchPermissionSetsServiceServer 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.

type UnimplementedWatchPermissionsServiceServer

type UnimplementedWatchPermissionsServiceServer struct{}

UnimplementedWatchPermissionsServiceServer 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.

type UnsafeWatchPermissionSetsServiceServer

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

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

type UnsafeWatchPermissionsServiceServer

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

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

type WatchPermissionSetsRequest

type WatchPermissionSetsRequest struct {

	// optional_starting_after is used to specify the SpiceDB revision to start watching from.
	// If not specified, the watch will start from the current SpiceDB revision time of the request ("head revision").
	OptionalStartingAfter *v1.ZedToken `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*WatchPermissionSetsRequest) CloneMessageVT

func (m *WatchPermissionSetsRequest) CloneMessageVT() proto.Message

func (*WatchPermissionSetsRequest) CloneVT

func (*WatchPermissionSetsRequest) Descriptor deprecated

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

Deprecated: Use WatchPermissionSetsRequest.ProtoReflect.Descriptor instead.

func (*WatchPermissionSetsRequest) EqualMessageVT

func (this *WatchPermissionSetsRequest) EqualMessageVT(thatMsg proto.Message) bool

func (*WatchPermissionSetsRequest) EqualVT

func (*WatchPermissionSetsRequest) GetOptionalStartingAfter

func (x *WatchPermissionSetsRequest) GetOptionalStartingAfter() *v1.ZedToken

func (*WatchPermissionSetsRequest) MarshalToSizedBufferVT

func (m *WatchPermissionSetsRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*WatchPermissionSetsRequest) MarshalToVT

func (m *WatchPermissionSetsRequest) MarshalToVT(dAtA []byte) (int, error)

func (*WatchPermissionSetsRequest) MarshalVT

func (m *WatchPermissionSetsRequest) MarshalVT() (dAtA []byte, err error)

func (*WatchPermissionSetsRequest) ProtoMessage

func (*WatchPermissionSetsRequest) ProtoMessage()

func (*WatchPermissionSetsRequest) ProtoReflect

func (*WatchPermissionSetsRequest) Reset

func (x *WatchPermissionSetsRequest) Reset()

func (*WatchPermissionSetsRequest) SizeVT

func (m *WatchPermissionSetsRequest) SizeVT() (n int)

func (*WatchPermissionSetsRequest) String

func (x *WatchPermissionSetsRequest) String() string

func (*WatchPermissionSetsRequest) UnmarshalVT

func (m *WatchPermissionSetsRequest) UnmarshalVT(dAtA []byte) error

func (*WatchPermissionSetsRequest) Validate

func (m *WatchPermissionSetsRequest) Validate() error

Validate checks the field values on WatchPermissionSetsRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*WatchPermissionSetsRequest) ValidateAll

func (m *WatchPermissionSetsRequest) ValidateAll() error

ValidateAll checks the field values on WatchPermissionSetsRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in WatchPermissionSetsRequestMultiError, or nil if none found.

type WatchPermissionSetsRequestMultiError

type WatchPermissionSetsRequestMultiError []error

WatchPermissionSetsRequestMultiError is an error wrapping multiple validation errors returned by WatchPermissionSetsRequest.ValidateAll() if the designated constraints aren't met.

func (WatchPermissionSetsRequestMultiError) AllErrors

AllErrors returns a list of validation violation errors.

func (WatchPermissionSetsRequestMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type WatchPermissionSetsRequestValidationError

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

WatchPermissionSetsRequestValidationError is the validation error returned by WatchPermissionSetsRequest.Validate if the designated constraints aren't met.

func (WatchPermissionSetsRequestValidationError) Cause

Cause function returns cause value.

func (WatchPermissionSetsRequestValidationError) Error

Error satisfies the builtin error interface

func (WatchPermissionSetsRequestValidationError) ErrorName

ErrorName returns error name.

func (WatchPermissionSetsRequestValidationError) Field

Field function returns field value.

func (WatchPermissionSetsRequestValidationError) Key

Key function returns key value.

func (WatchPermissionSetsRequestValidationError) Reason

Reason function returns reason value.

type WatchPermissionSetsResponse

type WatchPermissionSetsResponse struct {

	// Types that are valid to be assigned to Response:
	//
	//	*WatchPermissionSetsResponse_Change
	//	*WatchPermissionSetsResponse_CompletedRevision
	//	*WatchPermissionSetsResponse_LookupPermissionSetsRequired
	//	*WatchPermissionSetsResponse_BreakingSchemaChange
	Response isWatchPermissionSetsResponse_Response `protobuf_oneof:"response"`
	// contains filtered or unexported fields
}

func (*WatchPermissionSetsResponse) CloneMessageVT

func (m *WatchPermissionSetsResponse) CloneMessageVT() proto.Message

func (*WatchPermissionSetsResponse) CloneVT

func (*WatchPermissionSetsResponse) Descriptor deprecated

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

Deprecated: Use WatchPermissionSetsResponse.ProtoReflect.Descriptor instead.

func (*WatchPermissionSetsResponse) EqualMessageVT

func (this *WatchPermissionSetsResponse) EqualMessageVT(thatMsg proto.Message) bool

func (*WatchPermissionSetsResponse) EqualVT

func (*WatchPermissionSetsResponse) GetBreakingSchemaChange added in v0.14.0

func (x *WatchPermissionSetsResponse) GetBreakingSchemaChange() *BreakingSchemaChange

func (*WatchPermissionSetsResponse) GetChange

func (*WatchPermissionSetsResponse) GetCompletedRevision

func (x *WatchPermissionSetsResponse) GetCompletedRevision() *v1.ZedToken

func (*WatchPermissionSetsResponse) GetLookupPermissionSetsRequired

func (x *WatchPermissionSetsResponse) GetLookupPermissionSetsRequired() *LookupPermissionSetsRequired

func (*WatchPermissionSetsResponse) GetResponse

func (x *WatchPermissionSetsResponse) GetResponse() isWatchPermissionSetsResponse_Response

func (*WatchPermissionSetsResponse) MarshalToSizedBufferVT

func (m *WatchPermissionSetsResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*WatchPermissionSetsResponse) MarshalToVT

func (m *WatchPermissionSetsResponse) MarshalToVT(dAtA []byte) (int, error)

func (*WatchPermissionSetsResponse) MarshalVT

func (m *WatchPermissionSetsResponse) MarshalVT() (dAtA []byte, err error)

func (*WatchPermissionSetsResponse) ProtoMessage

func (*WatchPermissionSetsResponse) ProtoMessage()

func (*WatchPermissionSetsResponse) ProtoReflect

func (*WatchPermissionSetsResponse) Reset

func (x *WatchPermissionSetsResponse) Reset()

func (*WatchPermissionSetsResponse) SizeVT

func (m *WatchPermissionSetsResponse) SizeVT() (n int)

func (*WatchPermissionSetsResponse) String

func (x *WatchPermissionSetsResponse) String() string

func (*WatchPermissionSetsResponse) UnmarshalVT

func (m *WatchPermissionSetsResponse) UnmarshalVT(dAtA []byte) error

func (*WatchPermissionSetsResponse) Validate

func (m *WatchPermissionSetsResponse) Validate() error

Validate checks the field values on WatchPermissionSetsResponse with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*WatchPermissionSetsResponse) ValidateAll

func (m *WatchPermissionSetsResponse) ValidateAll() error

ValidateAll checks the field values on WatchPermissionSetsResponse with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in WatchPermissionSetsResponseMultiError, or nil if none found.

type WatchPermissionSetsResponseMultiError

type WatchPermissionSetsResponseMultiError []error

WatchPermissionSetsResponseMultiError is an error wrapping multiple validation errors returned by WatchPermissionSetsResponse.ValidateAll() if the designated constraints aren't met.

func (WatchPermissionSetsResponseMultiError) AllErrors

AllErrors returns a list of validation violation errors.

func (WatchPermissionSetsResponseMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type WatchPermissionSetsResponseValidationError

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

WatchPermissionSetsResponseValidationError is the validation error returned by WatchPermissionSetsResponse.Validate if the designated constraints aren't met.

func (WatchPermissionSetsResponseValidationError) Cause

Cause function returns cause value.

func (WatchPermissionSetsResponseValidationError) Error

Error satisfies the builtin error interface

func (WatchPermissionSetsResponseValidationError) ErrorName

ErrorName returns error name.

func (WatchPermissionSetsResponseValidationError) Field

Field function returns field value.

func (WatchPermissionSetsResponseValidationError) Key

Key function returns key value.

func (WatchPermissionSetsResponseValidationError) Reason

Reason function returns reason value.

type WatchPermissionSetsResponse_BreakingSchemaChange added in v0.14.0

type WatchPermissionSetsResponse_BreakingSchemaChange struct {
	// breaking_schema_change is a signal that a breaking schema change has been written to the origin SpiceDB cluster,
	// and that the consumer should expect delays in the ingestion of new changes,
	// because the permission set snapshot needs to be rebuilt from scratch. Once the snapshot is ready, the consumer
	// will receive a LookupPermissionSetsRequired event.
	BreakingSchemaChange *BreakingSchemaChange `protobuf:"bytes,4,opt,name=breaking_schema_change,json=breakingSchemaChange,proto3,oneof"`
}

func (*WatchPermissionSetsResponse_BreakingSchemaChange) CloneVT added in v0.14.0

func (m *WatchPermissionSetsResponse_BreakingSchemaChange) CloneVT() isWatchPermissionSetsResponse_Response

func (*WatchPermissionSetsResponse_BreakingSchemaChange) EqualVT added in v0.14.0

func (this *WatchPermissionSetsResponse_BreakingSchemaChange) EqualVT(thatIface isWatchPermissionSetsResponse_Response) bool

func (*WatchPermissionSetsResponse_BreakingSchemaChange) MarshalToSizedBufferVT added in v0.14.0

func (m *WatchPermissionSetsResponse_BreakingSchemaChange) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*WatchPermissionSetsResponse_BreakingSchemaChange) MarshalToVT added in v0.14.0

func (*WatchPermissionSetsResponse_BreakingSchemaChange) SizeVT added in v0.14.0

type WatchPermissionSetsResponse_Change

type WatchPermissionSetsResponse_Change struct {
	// change is the permission set delta that has occurred as result of a mutation in origin SpiceDB.
	// The consumer should apply this change to the current state of the permission sets in their target system.
	// Once an event arrives with completed_revision instead, the consumer shall consider the set of
	// changes originating from that revision completed.
	//
	// The consumer should keep track of the revision in order to resume streaming in the event of consumer restarts.
	Change *PermissionSetChange `protobuf:"bytes,1,opt,name=change,proto3,oneof"`
}

func (*WatchPermissionSetsResponse_Change) CloneVT

func (m *WatchPermissionSetsResponse_Change) CloneVT() isWatchPermissionSetsResponse_Response

func (*WatchPermissionSetsResponse_Change) EqualVT

func (this *WatchPermissionSetsResponse_Change) EqualVT(thatIface isWatchPermissionSetsResponse_Response) bool

func (*WatchPermissionSetsResponse_Change) MarshalToSizedBufferVT

func (m *WatchPermissionSetsResponse_Change) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*WatchPermissionSetsResponse_Change) MarshalToVT

func (m *WatchPermissionSetsResponse_Change) MarshalToVT(dAtA []byte) (int, error)

func (*WatchPermissionSetsResponse_Change) SizeVT

func (m *WatchPermissionSetsResponse_Change) SizeVT() (n int)

type WatchPermissionSetsResponse_CompletedRevision

type WatchPermissionSetsResponse_CompletedRevision struct {
	// completed_revision is the revision token that indicates the completion of a set of changes. It may also be
	// received without accompanying set of changes, indicating that a mutation in the origin SpiceDB cluster did
	// not yield any effective changes in the permission sets
	CompletedRevision *v1.ZedToken `protobuf:"bytes,2,opt,name=completed_revision,json=completedRevision,proto3,oneof"`
}

func (*WatchPermissionSetsResponse_CompletedRevision) CloneVT

func (m *WatchPermissionSetsResponse_CompletedRevision) CloneVT() isWatchPermissionSetsResponse_Response

func (*WatchPermissionSetsResponse_CompletedRevision) EqualVT

func (this *WatchPermissionSetsResponse_CompletedRevision) EqualVT(thatIface isWatchPermissionSetsResponse_Response) bool

func (*WatchPermissionSetsResponse_CompletedRevision) MarshalToSizedBufferVT

func (m *WatchPermissionSetsResponse_CompletedRevision) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*WatchPermissionSetsResponse_CompletedRevision) MarshalToVT

func (m *WatchPermissionSetsResponse_CompletedRevision) MarshalToVT(dAtA []byte) (int, error)

func (*WatchPermissionSetsResponse_CompletedRevision) SizeVT

type WatchPermissionSetsResponse_LookupPermissionSetsRequired

type WatchPermissionSetsResponse_LookupPermissionSetsRequired struct {
	// lookup_permission_sets_required is a signal that the consumer should perform a LookupPermissionSets call because
	// the permission set snapshot needs to be rebuilt from scratch. This typically happens when the origin SpiceDB
	// cluster has seen its schema changed.
	LookupPermissionSetsRequired *LookupPermissionSetsRequired `protobuf:"bytes,3,opt,name=lookup_permission_sets_required,json=lookupPermissionSetsRequired,proto3,oneof"`
}

func (*WatchPermissionSetsResponse_LookupPermissionSetsRequired) CloneVT

func (m *WatchPermissionSetsResponse_LookupPermissionSetsRequired) CloneVT() isWatchPermissionSetsResponse_Response

func (*WatchPermissionSetsResponse_LookupPermissionSetsRequired) EqualVT

func (this *WatchPermissionSetsResponse_LookupPermissionSetsRequired) EqualVT(thatIface isWatchPermissionSetsResponse_Response) bool

func (*WatchPermissionSetsResponse_LookupPermissionSetsRequired) MarshalToSizedBufferVT

func (m *WatchPermissionSetsResponse_LookupPermissionSetsRequired) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*WatchPermissionSetsResponse_LookupPermissionSetsRequired) MarshalToVT

func (*WatchPermissionSetsResponse_LookupPermissionSetsRequired) SizeVT

type WatchPermissionSetsServiceClient

type WatchPermissionSetsServiceClient interface {
	// WatchPermissionSets returns a stream of changes to the sets which can be used to compute the watched permissions.
	//
	// WatchPermissionSets lets consumers achieve the same thing as WatchPermissions, but trades off a simpler usage model with
	// significantly lower computational requirements. Unlike WatchPermissions, this method returns changes to the sets of permissions,
	// rather than the individual permissions. Permission sets are a normalized form of the computed permissions, which
	// means that the consumer must perform an extra computation over this representation to obtain the final computed
	// permissions, typically by intersecting the provided sets.
	//
	// For example, this would look like a JOIN between the
	// materialize permission sets table in a target relation database, the table with the resources to authorize access
	// to, and the table with the subject (e.g. a user).
	//
	// In exchange, the number of changes issued by WatchPermissionSets will be several orders of magnitude less than those
	// emitted by WatchPermissions, which has several implications:
	// - significantly less resources to compute the sets
	// - significantly less messages to stream over the network
	// - significantly less events to ingest on the consumer side
	// - less ingestion lag from the origin SpiceDB mutation
	//
	// The type of scenarios WatchPermissionSets is particularly well suited is when a single change
	// in the origin SpiceDB can yield millions of changes. For example, in the GitHub authorization model, assigning a role
	// to a top-level team of an organization with hundreds of thousands of employees can lead to an explosion of
	// permission change events that would require a lot of computational resources to process, both on Materialize and
	// the consumer side.
	//
	// WatchPermissionSets is thus recommended for any larger scale use case where the fan-out in permission changes that
	// emerges from a specific schema and data shape is too large to handle effectively.
	//
	// The API does not offer a sharding mechanism and thus there should only be one consumer per target system.
	// Implementing an active-active HA consumer setup over the same target system will require coordinating which
	// revisions have been consumed in order to prevent transitioning to an inconsistent state.
	WatchPermissionSets(ctx context.Context, in *WatchPermissionSetsRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[WatchPermissionSetsResponse], error)
	// LookupPermissionSets returns the current state of the permission sets which can be used to derive the computed permissions.
	// It's typically used to backfill the state of the permission sets in the consumer side.
	//
	// It's a cursored API and the consumer is responsible to keep track of the cursor and use it on each subsequent call.
	// Each stream will return <N> permission sets defined by the specified request limit. The server will keep streaming until
	// the sets per stream is hit, or the current state of the sets is reached,
	// whatever happens first, and then close the stream. The server will indicate there are no more changes to stream
	// through the `completed_members` in the cursor.
	//
	// There may be many elements to stream, and so the consumer should be prepared to resume the stream from the last
	// cursor received. Once completed, the consumer may start streaming permission set changes using WatchPermissionSets
	// and the revision token from the last LookupPermissionSets response.
	LookupPermissionSets(ctx context.Context, in *LookupPermissionSetsRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[LookupPermissionSetsResponse], error)
}

WatchPermissionSetsServiceClient is the client API for WatchPermissionSetsService 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 WatchPermissionSetsServiceServer

type WatchPermissionSetsServiceServer interface {
	// WatchPermissionSets returns a stream of changes to the sets which can be used to compute the watched permissions.
	//
	// WatchPermissionSets lets consumers achieve the same thing as WatchPermissions, but trades off a simpler usage model with
	// significantly lower computational requirements. Unlike WatchPermissions, this method returns changes to the sets of permissions,
	// rather than the individual permissions. Permission sets are a normalized form of the computed permissions, which
	// means that the consumer must perform an extra computation over this representation to obtain the final computed
	// permissions, typically by intersecting the provided sets.
	//
	// For example, this would look like a JOIN between the
	// materialize permission sets table in a target relation database, the table with the resources to authorize access
	// to, and the table with the subject (e.g. a user).
	//
	// In exchange, the number of changes issued by WatchPermissionSets will be several orders of magnitude less than those
	// emitted by WatchPermissions, which has several implications:
	// - significantly less resources to compute the sets
	// - significantly less messages to stream over the network
	// - significantly less events to ingest on the consumer side
	// - less ingestion lag from the origin SpiceDB mutation
	//
	// The type of scenarios WatchPermissionSets is particularly well suited is when a single change
	// in the origin SpiceDB can yield millions of changes. For example, in the GitHub authorization model, assigning a role
	// to a top-level team of an organization with hundreds of thousands of employees can lead to an explosion of
	// permission change events that would require a lot of computational resources to process, both on Materialize and
	// the consumer side.
	//
	// WatchPermissionSets is thus recommended for any larger scale use case where the fan-out in permission changes that
	// emerges from a specific schema and data shape is too large to handle effectively.
	//
	// The API does not offer a sharding mechanism and thus there should only be one consumer per target system.
	// Implementing an active-active HA consumer setup over the same target system will require coordinating which
	// revisions have been consumed in order to prevent transitioning to an inconsistent state.
	WatchPermissionSets(*WatchPermissionSetsRequest, grpc.ServerStreamingServer[WatchPermissionSetsResponse]) error
	// LookupPermissionSets returns the current state of the permission sets which can be used to derive the computed permissions.
	// It's typically used to backfill the state of the permission sets in the consumer side.
	//
	// It's a cursored API and the consumer is responsible to keep track of the cursor and use it on each subsequent call.
	// Each stream will return <N> permission sets defined by the specified request limit. The server will keep streaming until
	// the sets per stream is hit, or the current state of the sets is reached,
	// whatever happens first, and then close the stream. The server will indicate there are no more changes to stream
	// through the `completed_members` in the cursor.
	//
	// There may be many elements to stream, and so the consumer should be prepared to resume the stream from the last
	// cursor received. Once completed, the consumer may start streaming permission set changes using WatchPermissionSets
	// and the revision token from the last LookupPermissionSets response.
	LookupPermissionSets(*LookupPermissionSetsRequest, grpc.ServerStreamingServer[LookupPermissionSetsResponse]) error
	// contains filtered or unexported methods
}

WatchPermissionSetsServiceServer is the server API for WatchPermissionSetsService service. All implementations must embed UnimplementedWatchPermissionSetsServiceServer for forward compatibility.

type WatchPermissionSetsService_LookupPermissionSetsClient

type WatchPermissionSetsService_LookupPermissionSetsClient = grpc.ServerStreamingClient[LookupPermissionSetsResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type WatchPermissionSetsService_LookupPermissionSetsServer

type WatchPermissionSetsService_LookupPermissionSetsServer = grpc.ServerStreamingServer[LookupPermissionSetsResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type WatchPermissionSetsService_WatchPermissionSetsClient

type WatchPermissionSetsService_WatchPermissionSetsClient = grpc.ServerStreamingClient[WatchPermissionSetsResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type WatchPermissionSetsService_WatchPermissionSetsServer

type WatchPermissionSetsService_WatchPermissionSetsServer = grpc.ServerStreamingServer[WatchPermissionSetsResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type WatchPermissionsRequest

type WatchPermissionsRequest struct {

	// permissions is a list of permissions to watch for changes. At least one permission must be specified, and it must
	// be a subset or equal to the permissions that were enabled for the service.
	Permissions []*WatchedPermission `protobuf:"bytes,1,rep,name=permissions,proto3" json:"permissions,omitempty"`
	// optional_starting_after is the revision token to start watching from. If not provided, the stream
	// will start from the current revision at the moment of the request.
	OptionalStartingAfter *v1.ZedToken `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*WatchPermissionsRequest) CloneMessageVT

func (m *WatchPermissionsRequest) CloneMessageVT() proto.Message

func (*WatchPermissionsRequest) CloneVT

func (*WatchPermissionsRequest) Descriptor deprecated

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

Deprecated: Use WatchPermissionsRequest.ProtoReflect.Descriptor instead.

func (*WatchPermissionsRequest) EqualMessageVT

func (this *WatchPermissionsRequest) EqualMessageVT(thatMsg proto.Message) bool

func (*WatchPermissionsRequest) EqualVT

func (*WatchPermissionsRequest) GetOptionalStartingAfter

func (x *WatchPermissionsRequest) GetOptionalStartingAfter() *v1.ZedToken

func (*WatchPermissionsRequest) GetPermissions

func (x *WatchPermissionsRequest) GetPermissions() []*WatchedPermission

func (*WatchPermissionsRequest) MarshalToSizedBufferVT

func (m *WatchPermissionsRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*WatchPermissionsRequest) MarshalToVT

func (m *WatchPermissionsRequest) MarshalToVT(dAtA []byte) (int, error)

func (*WatchPermissionsRequest) MarshalVT

func (m *WatchPermissionsRequest) MarshalVT() (dAtA []byte, err error)

func (*WatchPermissionsRequest) ProtoMessage

func (*WatchPermissionsRequest) ProtoMessage()

func (*WatchPermissionsRequest) ProtoReflect

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

func (*WatchPermissionsRequest) Reset

func (x *WatchPermissionsRequest) Reset()

func (*WatchPermissionsRequest) SizeVT

func (m *WatchPermissionsRequest) SizeVT() (n int)

func (*WatchPermissionsRequest) String

func (x *WatchPermissionsRequest) String() string

func (*WatchPermissionsRequest) UnmarshalVT

func (m *WatchPermissionsRequest) UnmarshalVT(dAtA []byte) error

func (*WatchPermissionsRequest) Validate

func (m *WatchPermissionsRequest) Validate() error

Validate checks the field values on WatchPermissionsRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*WatchPermissionsRequest) ValidateAll

func (m *WatchPermissionsRequest) ValidateAll() error

ValidateAll checks the field values on WatchPermissionsRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in WatchPermissionsRequestMultiError, or nil if none found.

type WatchPermissionsRequestMultiError

type WatchPermissionsRequestMultiError []error

WatchPermissionsRequestMultiError is an error wrapping multiple validation errors returned by WatchPermissionsRequest.ValidateAll() if the designated constraints aren't met.

func (WatchPermissionsRequestMultiError) AllErrors

func (m WatchPermissionsRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (WatchPermissionsRequestMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type WatchPermissionsRequestValidationError

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

WatchPermissionsRequestValidationError is the validation error returned by WatchPermissionsRequest.Validate if the designated constraints aren't met.

func (WatchPermissionsRequestValidationError) Cause

Cause function returns cause value.

func (WatchPermissionsRequestValidationError) Error

Error satisfies the builtin error interface

func (WatchPermissionsRequestValidationError) ErrorName

ErrorName returns error name.

func (WatchPermissionsRequestValidationError) Field

Field function returns field value.

func (WatchPermissionsRequestValidationError) Key

Key function returns key value.

func (WatchPermissionsRequestValidationError) Reason

Reason function returns reason value.

type WatchPermissionsResponse

type WatchPermissionsResponse struct {

	// Types that are valid to be assigned to Response:
	//
	//	*WatchPermissionsResponse_Change
	//	*WatchPermissionsResponse_CompletedRevision
	Response isWatchPermissionsResponse_Response `protobuf_oneof:"response"`
	// contains filtered or unexported fields
}

func (*WatchPermissionsResponse) CloneMessageVT

func (m *WatchPermissionsResponse) CloneMessageVT() proto.Message

func (*WatchPermissionsResponse) CloneVT

func (*WatchPermissionsResponse) Descriptor deprecated

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

Deprecated: Use WatchPermissionsResponse.ProtoReflect.Descriptor instead.

func (*WatchPermissionsResponse) EqualMessageVT

func (this *WatchPermissionsResponse) EqualMessageVT(thatMsg proto.Message) bool

func (*WatchPermissionsResponse) EqualVT

func (*WatchPermissionsResponse) GetChange

func (*WatchPermissionsResponse) GetCompletedRevision

func (x *WatchPermissionsResponse) GetCompletedRevision() *v1.ZedToken

func (*WatchPermissionsResponse) GetResponse

func (x *WatchPermissionsResponse) GetResponse() isWatchPermissionsResponse_Response

func (*WatchPermissionsResponse) MarshalToSizedBufferVT

func (m *WatchPermissionsResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*WatchPermissionsResponse) MarshalToVT

func (m *WatchPermissionsResponse) MarshalToVT(dAtA []byte) (int, error)

func (*WatchPermissionsResponse) MarshalVT

func (m *WatchPermissionsResponse) MarshalVT() (dAtA []byte, err error)

func (*WatchPermissionsResponse) ProtoMessage

func (*WatchPermissionsResponse) ProtoMessage()

func (*WatchPermissionsResponse) ProtoReflect

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

func (*WatchPermissionsResponse) Reset

func (x *WatchPermissionsResponse) Reset()

func (*WatchPermissionsResponse) SizeVT

func (m *WatchPermissionsResponse) SizeVT() (n int)

func (*WatchPermissionsResponse) String

func (x *WatchPermissionsResponse) String() string

func (*WatchPermissionsResponse) UnmarshalVT

func (m *WatchPermissionsResponse) UnmarshalVT(dAtA []byte) error

func (*WatchPermissionsResponse) Validate

func (m *WatchPermissionsResponse) Validate() error

Validate checks the field values on WatchPermissionsResponse with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*WatchPermissionsResponse) ValidateAll

func (m *WatchPermissionsResponse) ValidateAll() error

ValidateAll checks the field values on WatchPermissionsResponse with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in WatchPermissionsResponseMultiError, or nil if none found.

type WatchPermissionsResponseMultiError

type WatchPermissionsResponseMultiError []error

WatchPermissionsResponseMultiError is an error wrapping multiple validation errors returned by WatchPermissionsResponse.ValidateAll() if the designated constraints aren't met.

func (WatchPermissionsResponseMultiError) AllErrors

func (m WatchPermissionsResponseMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (WatchPermissionsResponseMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type WatchPermissionsResponseValidationError

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

WatchPermissionsResponseValidationError is the validation error returned by WatchPermissionsResponse.Validate if the designated constraints aren't met.

func (WatchPermissionsResponseValidationError) Cause

Cause function returns cause value.

func (WatchPermissionsResponseValidationError) Error

Error satisfies the builtin error interface

func (WatchPermissionsResponseValidationError) ErrorName

ErrorName returns error name.

func (WatchPermissionsResponseValidationError) Field

Field function returns field value.

func (WatchPermissionsResponseValidationError) Key

Key function returns key value.

func (WatchPermissionsResponseValidationError) Reason

Reason function returns reason value.

type WatchPermissionsResponse_Change

type WatchPermissionsResponse_Change struct {
	// change is the computed permission delta that has occurred as result of a mutation in origin SpiceDB.
	// The consumer should apply this change to the current state of the computed permissions in their target system.
	// Once an event arrives with completed_revision instead, the consumer shall consider there are not more changes
	// originating from that revision.
	//
	// The consumer should keep track of the revision in order to resume streaming in the event of consumer restarts.
	Change *PermissionChange `protobuf:"bytes,1,opt,name=change,proto3,oneof"`
}

func (*WatchPermissionsResponse_Change) CloneVT

func (m *WatchPermissionsResponse_Change) CloneVT() isWatchPermissionsResponse_Response

func (*WatchPermissionsResponse_Change) EqualVT

func (this *WatchPermissionsResponse_Change) EqualVT(thatIface isWatchPermissionsResponse_Response) bool

func (*WatchPermissionsResponse_Change) MarshalToSizedBufferVT

func (m *WatchPermissionsResponse_Change) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*WatchPermissionsResponse_Change) MarshalToVT

func (m *WatchPermissionsResponse_Change) MarshalToVT(dAtA []byte) (int, error)

func (*WatchPermissionsResponse_Change) SizeVT

func (m *WatchPermissionsResponse_Change) SizeVT() (n int)

type WatchPermissionsResponse_CompletedRevision

type WatchPermissionsResponse_CompletedRevision struct {
	// completed_revision is the revision token that indicates all changes originating from a revision have been
	// streamed and thus the revision should be considered completed. It may also be
	// received without accompanying set of changes, indicating that a mutation in the origin SpiceDB cluster did
	// not yield any effective changes in the computed permissions
	CompletedRevision *v1.ZedToken `protobuf:"bytes,2,opt,name=completed_revision,json=completedRevision,proto3,oneof"`
}

func (*WatchPermissionsResponse_CompletedRevision) CloneVT

func (m *WatchPermissionsResponse_CompletedRevision) CloneVT() isWatchPermissionsResponse_Response

func (*WatchPermissionsResponse_CompletedRevision) EqualVT

func (this *WatchPermissionsResponse_CompletedRevision) EqualVT(thatIface isWatchPermissionsResponse_Response) bool

func (*WatchPermissionsResponse_CompletedRevision) MarshalToSizedBufferVT

func (m *WatchPermissionsResponse_CompletedRevision) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*WatchPermissionsResponse_CompletedRevision) MarshalToVT

func (m *WatchPermissionsResponse_CompletedRevision) MarshalToVT(dAtA []byte) (int, error)

func (*WatchPermissionsResponse_CompletedRevision) SizeVT

type WatchPermissionsServiceClient

type WatchPermissionsServiceClient interface {
	// WatchPermissions returns a stream of PermissionChange events for the given permissions.
	//
	// WatchPermissions is a long-running RPC, and will stream events until the client
	// closes the connection or the server terminates the stream. The consumer is responsible of
	// keeping track of the last seen revision and resuming the stream from that point in the event
	// of disconnection or client-side restarts.
	//
	// The API does not offer a sharding mechanism and thus there should only be one consumer per target system.
	// Implementing an active-active HA consumer setup over the same target system will require coordinating which
	// revisions have been consumed in order to prevent transitioning to an inconsistent state.
	//
	// Usage of WatchPermissions requires to be explicitly enabled on the service, including the permissions to be
	// watched. It requires more resources and is less performant than WatchPermissionsSets. It's usage
	// is only recommended when performing the set intersections of WatchPermissionSets in the client side is not viable
	// or there is a strict application requirement to use consume the computed permissions.
	WatchPermissions(ctx context.Context, in *WatchPermissionsRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[WatchPermissionsResponse], error)
}

WatchPermissionsServiceClient is the client API for WatchPermissionsService 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 WatchPermissionsServiceServer

type WatchPermissionsServiceServer interface {
	// WatchPermissions returns a stream of PermissionChange events for the given permissions.
	//
	// WatchPermissions is a long-running RPC, and will stream events until the client
	// closes the connection or the server terminates the stream. The consumer is responsible of
	// keeping track of the last seen revision and resuming the stream from that point in the event
	// of disconnection or client-side restarts.
	//
	// The API does not offer a sharding mechanism and thus there should only be one consumer per target system.
	// Implementing an active-active HA consumer setup over the same target system will require coordinating which
	// revisions have been consumed in order to prevent transitioning to an inconsistent state.
	//
	// Usage of WatchPermissions requires to be explicitly enabled on the service, including the permissions to be
	// watched. It requires more resources and is less performant than WatchPermissionsSets. It's usage
	// is only recommended when performing the set intersections of WatchPermissionSets in the client side is not viable
	// or there is a strict application requirement to use consume the computed permissions.
	WatchPermissions(*WatchPermissionsRequest, grpc.ServerStreamingServer[WatchPermissionsResponse]) error
	// contains filtered or unexported methods
}

WatchPermissionsServiceServer is the server API for WatchPermissionsService service. All implementations must embed UnimplementedWatchPermissionsServiceServer for forward compatibility.

type WatchPermissionsService_WatchPermissionsClient

type WatchPermissionsService_WatchPermissionsClient = grpc.ServerStreamingClient[WatchPermissionsResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type WatchPermissionsService_WatchPermissionsServer

type WatchPermissionsService_WatchPermissionsServer = grpc.ServerStreamingServer[WatchPermissionsResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type WatchedPermission

type WatchedPermission struct {

	// resource_type is the type of the resource to watch for changes.
	ResourceType string `protobuf:"bytes,1,opt,name=resource_type,json=resourceType,proto3" json:"resource_type,omitempty"`
	// permission is the permission to watch for changes.
	Permission string `protobuf:"bytes,2,opt,name=permission,proto3" json:"permission,omitempty"`
	// subject_type is the type of the subject to watch for changes.
	SubjectType string `protobuf:"bytes,3,opt,name=subject_type,json=subjectType,proto3" json:"subject_type,omitempty"`
	// optional_subject_relation is the relation on the subject to watch for changes.
	OptionalSubjectRelation string `` /* 132-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*WatchedPermission) CloneMessageVT

func (m *WatchedPermission) CloneMessageVT() proto.Message

func (*WatchedPermission) CloneVT

func (m *WatchedPermission) CloneVT() *WatchedPermission

func (*WatchedPermission) Descriptor deprecated

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

Deprecated: Use WatchedPermission.ProtoReflect.Descriptor instead.

func (*WatchedPermission) EqualMessageVT

func (this *WatchedPermission) EqualMessageVT(thatMsg proto.Message) bool

func (*WatchedPermission) EqualVT

func (this *WatchedPermission) EqualVT(that *WatchedPermission) bool

func (*WatchedPermission) GetOptionalSubjectRelation

func (x *WatchedPermission) GetOptionalSubjectRelation() string

func (*WatchedPermission) GetPermission

func (x *WatchedPermission) GetPermission() string

func (*WatchedPermission) GetResourceType

func (x *WatchedPermission) GetResourceType() string

func (*WatchedPermission) GetSubjectType

func (x *WatchedPermission) GetSubjectType() string

func (*WatchedPermission) MarshalToSizedBufferVT

func (m *WatchedPermission) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*WatchedPermission) MarshalToVT

func (m *WatchedPermission) MarshalToVT(dAtA []byte) (int, error)

func (*WatchedPermission) MarshalVT

func (m *WatchedPermission) MarshalVT() (dAtA []byte, err error)

func (*WatchedPermission) ProtoMessage

func (*WatchedPermission) ProtoMessage()

func (*WatchedPermission) ProtoReflect

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

func (*WatchedPermission) Reset

func (x *WatchedPermission) Reset()

func (*WatchedPermission) SizeVT

func (m *WatchedPermission) SizeVT() (n int)

func (*WatchedPermission) String

func (x *WatchedPermission) String() string

func (*WatchedPermission) UnmarshalVT

func (m *WatchedPermission) UnmarshalVT(dAtA []byte) error

func (*WatchedPermission) Validate

func (m *WatchedPermission) Validate() error

Validate checks the field values on WatchedPermission with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*WatchedPermission) ValidateAll

func (m *WatchedPermission) ValidateAll() error

ValidateAll checks the field values on WatchedPermission with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in WatchedPermissionMultiError, or nil if none found.

type WatchedPermissionMultiError

type WatchedPermissionMultiError []error

WatchedPermissionMultiError is an error wrapping multiple validation errors returned by WatchedPermission.ValidateAll() if the designated constraints aren't met.

func (WatchedPermissionMultiError) AllErrors

func (m WatchedPermissionMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (WatchedPermissionMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type WatchedPermissionValidationError

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

WatchedPermissionValidationError is the validation error returned by WatchedPermission.Validate if the designated constraints aren't met.

func (WatchedPermissionValidationError) Cause

Cause function returns cause value.

func (WatchedPermissionValidationError) Error

Error satisfies the builtin error interface

func (WatchedPermissionValidationError) ErrorName

ErrorName returns error name.

func (WatchedPermissionValidationError) Field

Field function returns field value.

func (WatchedPermissionValidationError) Key

Key function returns key value.

func (WatchedPermissionValidationError) Reason

Reason function returns reason value.

Jump to

Keyboard shortcuts

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