referrerstore

package
v1.1.1 Latest Latest
Warning

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

Go to latest
Published: May 2, 2024 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_referrerstore_proto protoreflect.FileDescriptor
View Source
var ReferrerStorePlugin_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "referrerstore.ReferrerStorePlugin",
	HandlerType: (*ReferrerStorePluginServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetBlobContent",
			Handler:    _ReferrerStorePlugin_GetBlobContent_Handler,
		},
		{
			MethodName: "GetSubjectDescriptor",
			Handler:    _ReferrerStorePlugin_GetSubjectDescriptor_Handler,
		},
		{
			MethodName: "GetReferenceManifest",
			Handler:    _ReferrerStorePlugin_GetReferenceManifest_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "ListReferrers",
			Handler:       _ReferrerStorePlugin_ListReferrers_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "referrerstore.proto",
}

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

Functions

func RegisterReferrerStorePluginServer

func RegisterReferrerStorePluginServer(s grpc.ServiceRegistrar, srv ReferrerStorePluginServer)

Types

type GetBlobContentRequest

type GetBlobContentRequest struct {

	// The artifact for which blobs have been requested.
	Artifact *common.Descriptor `protobuf:"bytes,1,opt,name=artifact,proto3" json:"artifact,omitempty"`
	// Optional. Custom to the store plugin. Can be used to modify the query performed or results returned.
	Configuration *_struct.Struct `protobuf:"bytes,2,opt,name=configuration,proto3" json:"configuration,omitempty"`
	// contains filtered or unexported fields
}

The request for GetBlobContent.

func (*GetBlobContentRequest) Descriptor deprecated

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

Deprecated: Use GetBlobContentRequest.ProtoReflect.Descriptor instead.

func (*GetBlobContentRequest) GetArtifact

func (x *GetBlobContentRequest) GetArtifact() *common.Descriptor

func (*GetBlobContentRequest) GetConfiguration

func (x *GetBlobContentRequest) GetConfiguration() *_struct.Struct

func (*GetBlobContentRequest) ProtoMessage

func (*GetBlobContentRequest) ProtoMessage()

func (*GetBlobContentRequest) ProtoReflect

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

func (*GetBlobContentRequest) Reset

func (x *GetBlobContentRequest) Reset()

func (*GetBlobContentRequest) String

func (x *GetBlobContentRequest) String() string

type GetBlobContentResponse

type GetBlobContentResponse struct {

	// The artifact for which blobs have been requested.
	Artifact *common.Descriptor `protobuf:"bytes,1,opt,name=artifact,proto3" json:"artifact,omitempty"`
	// The collection of blob contents.
	Content [][]byte `protobuf:"bytes,2,rep,name=content,proto3" json:"content,omitempty"`
	// contains filtered or unexported fields
}

The response for GetBlobContent.

func (*GetBlobContentResponse) Descriptor deprecated

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

Deprecated: Use GetBlobContentResponse.ProtoReflect.Descriptor instead.

func (*GetBlobContentResponse) GetArtifact

func (x *GetBlobContentResponse) GetArtifact() *common.Descriptor

func (*GetBlobContentResponse) GetContent

func (x *GetBlobContentResponse) GetContent() [][]byte

func (*GetBlobContentResponse) ProtoMessage

func (*GetBlobContentResponse) ProtoMessage()

func (*GetBlobContentResponse) ProtoReflect

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

func (*GetBlobContentResponse) Reset

func (x *GetBlobContentResponse) Reset()

func (*GetBlobContentResponse) String

func (x *GetBlobContentResponse) String() string

type GetManifestRequest

type GetManifestRequest struct {

	// The path of the subject.
	SubjectPath string `protobuf:"bytes,1,opt,name=subjectPath,proto3" json:"subjectPath,omitempty"`
	// The referrer for which the manifest is being requested.
	Referrer *common.Descriptor `protobuf:"bytes,2,opt,name=referrer,proto3" json:"referrer,omitempty"`
	// Optional. Custom to the store plugin. Can be used to modify the query performed or results returned.
	Configuration *_struct.Struct `protobuf:"bytes,3,opt,name=configuration,proto3" json:"configuration,omitempty"`
	// contains filtered or unexported fields
}

The request for GetReferenceManifest.

func (*GetManifestRequest) Descriptor deprecated

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

Deprecated: Use GetManifestRequest.ProtoReflect.Descriptor instead.

func (*GetManifestRequest) GetConfiguration

func (x *GetManifestRequest) GetConfiguration() *_struct.Struct

func (*GetManifestRequest) GetReferrer

func (x *GetManifestRequest) GetReferrer() *common.Descriptor

func (*GetManifestRequest) GetSubjectPath

func (x *GetManifestRequest) GetSubjectPath() string

func (*GetManifestRequest) ProtoMessage

func (*GetManifestRequest) ProtoMessage()

func (*GetManifestRequest) ProtoReflect

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

func (*GetManifestRequest) Reset

func (x *GetManifestRequest) Reset()

func (*GetManifestRequest) String

func (x *GetManifestRequest) String() string

type GetManifestResponse

type GetManifestResponse struct {

	// The fully realized Manifest object for the requested referrer.
	Manifest *common.Manifest `protobuf:"bytes,1,opt,name=manifest,proto3" json:"manifest,omitempty"`
	// contains filtered or unexported fields
}

The response for GetReferenceManifest.

func (*GetManifestResponse) Descriptor deprecated

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

Deprecated: Use GetManifestResponse.ProtoReflect.Descriptor instead.

func (*GetManifestResponse) GetManifest

func (x *GetManifestResponse) GetManifest() *common.Manifest

func (*GetManifestResponse) ProtoMessage

func (*GetManifestResponse) ProtoMessage()

func (*GetManifestResponse) ProtoReflect

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

func (*GetManifestResponse) Reset

func (x *GetManifestResponse) Reset()

func (*GetManifestResponse) String

func (x *GetManifestResponse) String() string

type GetSubjectDescriptorRequest

type GetSubjectDescriptorRequest struct {

	// The provided path for the subject.
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// Optional. Custom to the store plugin. Can be used to modify the query performed or results returned.
	Configuration *_struct.Struct `protobuf:"bytes,2,opt,name=configuration,proto3" json:"configuration,omitempty"`
	// contains filtered or unexported fields
}

The request for GetSubjectDescriptor.

func (*GetSubjectDescriptorRequest) Descriptor deprecated

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

Deprecated: Use GetSubjectDescriptorRequest.ProtoReflect.Descriptor instead.

func (*GetSubjectDescriptorRequest) GetConfiguration

func (x *GetSubjectDescriptorRequest) GetConfiguration() *_struct.Struct

func (*GetSubjectDescriptorRequest) GetPath

func (x *GetSubjectDescriptorRequest) GetPath() string

func (*GetSubjectDescriptorRequest) ProtoMessage

func (*GetSubjectDescriptorRequest) ProtoMessage()

func (*GetSubjectDescriptorRequest) ProtoReflect

func (*GetSubjectDescriptorRequest) Reset

func (x *GetSubjectDescriptorRequest) Reset()

func (*GetSubjectDescriptorRequest) String

func (x *GetSubjectDescriptorRequest) String() string

type GetSubjectDescriptorResponse

type GetSubjectDescriptorResponse struct {

	// The retrieved properties for the provided subject (path).
	Subject *common.Descriptor `protobuf:"bytes,1,opt,name=subject,proto3" json:"subject,omitempty"`
	// contains filtered or unexported fields
}

The response for GetSubjectDescriptor.

func (*GetSubjectDescriptorResponse) Descriptor deprecated

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

Deprecated: Use GetSubjectDescriptorResponse.ProtoReflect.Descriptor instead.

func (*GetSubjectDescriptorResponse) GetSubject

func (*GetSubjectDescriptorResponse) ProtoMessage

func (*GetSubjectDescriptorResponse) ProtoMessage()

func (*GetSubjectDescriptorResponse) ProtoReflect

func (*GetSubjectDescriptorResponse) Reset

func (x *GetSubjectDescriptorResponse) Reset()

func (*GetSubjectDescriptorResponse) String

type ListReferrersRequest

type ListReferrersRequest struct {

	// The subject.
	Subject *common.Descriptor `protobuf:"bytes,1,opt,name=subject,proto3" json:"subject,omitempty"`
	// The specific types of artifacts to query and return. If empty, all artifacts regardless of type are returned.
	ArtifactTypes []string `protobuf:"bytes,2,rep,name=artifactTypes,proto3" json:"artifactTypes,omitempty"`
	// Optional. Custom to the store plugin. Can be used to modify the query performed or results returned, e.g: paging.
	Configuration *_struct.Struct `protobuf:"bytes,3,opt,name=configuration,proto3" json:"configuration,omitempty"`
	// contains filtered or unexported fields
}

The request object for ListReferrers.

func (*ListReferrersRequest) Descriptor deprecated

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

Deprecated: Use ListReferrersRequest.ProtoReflect.Descriptor instead.

func (*ListReferrersRequest) GetArtifactTypes

func (x *ListReferrersRequest) GetArtifactTypes() []string

func (*ListReferrersRequest) GetConfiguration

func (x *ListReferrersRequest) GetConfiguration() *_struct.Struct

func (*ListReferrersRequest) GetSubject

func (x *ListReferrersRequest) GetSubject() *common.Descriptor

func (*ListReferrersRequest) ProtoMessage

func (*ListReferrersRequest) ProtoMessage()

func (*ListReferrersRequest) ProtoReflect

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

func (*ListReferrersRequest) Reset

func (x *ListReferrersRequest) Reset()

func (*ListReferrersRequest) String

func (x *ListReferrersRequest) String() string

type ListReferrersResponse

type ListReferrersResponse struct {

	// The subject.
	Subject *common.Descriptor `protobuf:"bytes,1,opt,name=subject,proto3" json:"subject,omitempty"`
	// The collection of results.
	Artifacts []*common.Referrer `protobuf:"bytes,2,rep,name=artifacts,proto3" json:"artifacts,omitempty"`
	// If paging is supported and more results were found,
	// this value can be provided in a follow up to get the next set.
	NextToken string `protobuf:"bytes,3,opt,name=nextToken,proto3" json:"nextToken,omitempty"`
	// contains filtered or unexported fields
}

The response object for ListReferrers.

func (*ListReferrersResponse) Descriptor deprecated

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

Deprecated: Use ListReferrersResponse.ProtoReflect.Descriptor instead.

func (*ListReferrersResponse) GetArtifacts

func (x *ListReferrersResponse) GetArtifacts() []*common.Referrer

func (*ListReferrersResponse) GetNextToken

func (x *ListReferrersResponse) GetNextToken() string

func (*ListReferrersResponse) GetSubject

func (x *ListReferrersResponse) GetSubject() *common.Descriptor

func (*ListReferrersResponse) ProtoMessage

func (*ListReferrersResponse) ProtoMessage()

func (*ListReferrersResponse) ProtoReflect

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

func (*ListReferrersResponse) Reset

func (x *ListReferrersResponse) Reset()

func (*ListReferrersResponse) String

func (x *ListReferrersResponse) String() string

type ReferrerStorePluginClient

type ReferrerStorePluginClient interface {
	// Query all the referrers that are linked to a subject.
	ListReferrers(ctx context.Context, in *ListReferrersRequest, opts ...grpc.CallOption) (ReferrerStorePlugin_ListReferrersClient, error)
	// Fetch the contents of a blob for a given artifact.
	GetBlobContent(ctx context.Context, in *GetBlobContentRequest, opts ...grpc.CallOption) (*GetBlobContentResponse, error)
	// Fetch additional metadata for a subject.
	GetSubjectDescriptor(ctx context.Context, in *GetSubjectDescriptorRequest, opts ...grpc.CallOption) (*GetSubjectDescriptorResponse, error)
	// Fetch the contents of a reference manifest.
	GetReferenceManifest(ctx context.Context, in *GetManifestRequest, opts ...grpc.CallOption) (*GetManifestResponse, error)
}

ReferrerStorePluginClient is the client API for ReferrerStorePlugin 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 ReferrerStorePluginServer

type ReferrerStorePluginServer interface {
	// Query all the referrers that are linked to a subject.
	ListReferrers(*ListReferrersRequest, ReferrerStorePlugin_ListReferrersServer) error
	// Fetch the contents of a blob for a given artifact.
	GetBlobContent(context.Context, *GetBlobContentRequest) (*GetBlobContentResponse, error)
	// Fetch additional metadata for a subject.
	GetSubjectDescriptor(context.Context, *GetSubjectDescriptorRequest) (*GetSubjectDescriptorResponse, error)
	// Fetch the contents of a reference manifest.
	GetReferenceManifest(context.Context, *GetManifestRequest) (*GetManifestResponse, error)
	// contains filtered or unexported methods
}

ReferrerStorePluginServer is the server API for ReferrerStorePlugin service. All implementations must embed UnimplementedReferrerStorePluginServer for forward compatibility

type ReferrerStorePlugin_ListReferrersClient

type ReferrerStorePlugin_ListReferrersClient interface {
	Recv() (*ListReferrersResponse, error)
	grpc.ClientStream
}

type ReferrerStorePlugin_ListReferrersServer

type ReferrerStorePlugin_ListReferrersServer interface {
	Send(*ListReferrersResponse) error
	grpc.ServerStream
}

type UnimplementedReferrerStorePluginServer

type UnimplementedReferrerStorePluginServer struct {
}

UnimplementedReferrerStorePluginServer must be embedded to have forward compatible implementations.

func (UnimplementedReferrerStorePluginServer) GetBlobContent

func (UnimplementedReferrerStorePluginServer) GetReferenceManifest

func (UnimplementedReferrerStorePluginServer) GetSubjectDescriptor

type UnsafeReferrerStorePluginServer

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

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

Jump to

Keyboard shortcuts

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