federationv1beta1

package
v1.30.0-20240220184920... Latest Latest
Warning

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

 Go to latest Published: unknown License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_buf_registry_legacy_federation_v1beta1_doc_proto protoreflect.FileDescriptor
View Source 
var File_buf_registry_legacy_federation_v1beta1_graph_proto protoreflect.FileDescriptor
View Source 
var File_buf_registry_legacy_federation_v1beta1_graph_service_proto protoreflect.FileDescriptor
View Source 
var File_buf_registry_legacy_federation_v1beta1_resource_proto protoreflect.FileDescriptor
View Source 
var File_buf_registry_legacy_federation_v1beta1_upload_service_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type GetGraphRequest 

type GetGraphRequest struct {

	// The references to resolve to Commits to include in the graph.
	//
	// See the documentation on ResourceRef for resource resolution details.
	//
	// Once the resource is resolved, the following Commit is included:
	//   - If a Module is referenced, the Commit of the default Label is included.
	//   - If a Label is referenced, the Commit of this Label is included.
	//   - If a Commit is referenced, the Commit is included.
	//
	// The specified ResourceRefs must reference unique Modules, that is no two ResourceRefs
	// may resolve to the same Module.
	ResourceRefs []*ResourceRef `protobuf:"bytes,1,rep,name=resource_refs,json=resourceRefs,proto3" json:"resource_refs,omitempty"`
	// The DigestType to return for Commit nodes.
	//
	// If this DigestType is not available, an error is returned.
	// Note that certain DigestTypes may be deprecated over time.
	//
	// If not set, the latest DigestType is used.
	DigestType v1beta1.DigestType `` /* 136-byte string literal not displayed */
	// contains filtered or unexported fields
}

See the package documentation for more details. You should likely use buf.registry.module.v1beta1 and not this package.

func (*GetGraphRequest) Descriptor deprecated 

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

Deprecated: Use GetGraphRequest.ProtoReflect.Descriptor instead.

func (*GetGraphRequest) GetDigestType 

func (x *GetGraphRequest) GetDigestType() v1beta1.DigestType

func (*GetGraphRequest) GetResourceRefs 

func (x *GetGraphRequest) GetResourceRefs() []*ResourceRef

func (*GetGraphRequest) ProtoMessage 

func (*GetGraphRequest) ProtoMessage()

func (*GetGraphRequest) ProtoReflect 

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

func (*GetGraphRequest) Reset 

func (x *GetGraphRequest) Reset()

func (*GetGraphRequest) String 

func (x *GetGraphRequest) String() string

type GetGraphResponse 

type GetGraphResponse struct {

	// The Graph calculated for the Commits.
	Graph *Graph `protobuf:"bytes,1,opt,name=graph,proto3" json:"graph,omitempty"`
	// contains filtered or unexported fields
}

See the package documentation for more details. You should likely use buf.registry.module.v1beta1 and not this package.

func (*GetGraphResponse) Descriptor deprecated 

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

Deprecated: Use GetGraphResponse.ProtoReflect.Descriptor instead.

func (*GetGraphResponse) GetGraph 

func (x *GetGraphResponse) GetGraph() *Graph

func (*GetGraphResponse) ProtoMessage 

func (*GetGraphResponse) ProtoMessage()

func (*GetGraphResponse) ProtoReflect 

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

func (*GetGraphResponse) Reset 

func (x *GetGraphResponse) Reset()

func (*GetGraphResponse) String 

func (x *GetGraphResponse) String() string

type Graph 

type Graph struct {

	// The nodes of the graph, each of which are Commits.
	Commits []*Graph_Commit `protobuf:"bytes,1,rep,name=commits,proto3" json:"commits,omitempty"`
	// The edges of the graph.
	Edges []*Graph_Edge `protobuf:"bytes,2,rep,name=edges,proto3" json:"edges,omitempty"`
	// contains filtered or unexported fields
}

A dependency graph that allows for federation.

See the package documentation for more details. You should likely use buf.registry.module.v1beta1 and not this package.

func (*Graph) Descriptor deprecated 

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

Deprecated: Use Graph.ProtoReflect.Descriptor instead.

func (*Graph) GetCommits 

func (x *Graph) GetCommits() []*Graph_Commit

func (*Graph) GetEdges 

func (x *Graph) GetEdges() []*Graph_Edge

func (*Graph) ProtoMessage 

func (*Graph) ProtoMessage()

func (*Graph) ProtoReflect 

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

func (*Graph) Reset 

func (x *Graph) Reset()

func (*Graph) String 

func (x *Graph) String() string

type Graph_Commit 

type Graph_Commit struct {

	// The top-level Commit.
	Commit *v1beta1.Commit `protobuf:"bytes,1,opt,name=commit,proto3" json:"commit,omitempty"`
	// The registry hostname of the Commit.
	Registry string `protobuf:"bytes,2,opt,name=registry,proto3" json:"registry,omitempty"`
	// contains filtered or unexported fields
}

A Commit in the dependency graph.

This wraps the top-level Commit.

func (*Graph_Commit) Descriptor deprecated 

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

Deprecated: Use Graph_Commit.ProtoReflect.Descriptor instead.

func (*Graph_Commit) GetCommit 

func (x *Graph_Commit) GetCommit() *v1beta1.Commit

func (*Graph_Commit) GetRegistry 

func (x *Graph_Commit) GetRegistry() string

func (*Graph_Commit) ProtoMessage 

func (*Graph_Commit) ProtoMessage()

func (*Graph_Commit) ProtoReflect 

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

func (*Graph_Commit) Reset 

func (x *Graph_Commit) Reset()

func (*Graph_Commit) String 

func (x *Graph_Commit) String() string

type Graph_Edge 

type Graph_Edge struct {

	// The Node of the start of the edge.
	FromNode *Graph_Node `protobuf:"bytes,1,opt,name=from_node,json=fromNode,proto3" json:"from_node,omitempty"`
	// The Node of the end of the edge.
	ToNode *Graph_Node `protobuf:"bytes,2,opt,name=to_node,json=toNode,proto3" json:"to_node,omitempty"`
	// contains filtered or unexported fields
}

An edge in the dependency graph.

func (*Graph_Edge) Descriptor deprecated 

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

Deprecated: Use Graph_Edge.ProtoReflect.Descriptor instead.

func (*Graph_Edge) GetFromNode 

func (x *Graph_Edge) GetFromNode() *Graph_Node

func (*Graph_Edge) GetToNode 

func (x *Graph_Edge) GetToNode() *Graph_Node

func (*Graph_Edge) ProtoMessage 

func (*Graph_Edge) ProtoMessage()

func (*Graph_Edge) ProtoReflect 

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

func (*Graph_Edge) Reset 

func (x *Graph_Edge) Reset()

func (*Graph_Edge) String 

func (x *Graph_Edge) String() string

type Graph_Node 

type Graph_Node struct {

	// The commit of the node.
	CommitId string `protobuf:"bytes,1,opt,name=commit_id,json=commitId,proto3" json:"commit_id,omitempty"`
	// The registry hostname of the Node.
	Registry string `protobuf:"bytes,2,opt,name=registry,proto3" json:"registry,omitempty"`
	// contains filtered or unexported fields
}

A node in the dependency graph.

func (*Graph_Node) Descriptor deprecated 

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

Deprecated: Use Graph_Node.ProtoReflect.Descriptor instead.

func (*Graph_Node) GetCommitId 

func (x *Graph_Node) GetCommitId() string

func (*Graph_Node) GetRegistry 

func (x *Graph_Node) GetRegistry() string

func (*Graph_Node) ProtoMessage 

func (*Graph_Node) ProtoMessage()

func (*Graph_Node) ProtoReflect 

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

func (*Graph_Node) Reset 

func (x *Graph_Node) Reset()

func (*Graph_Node) String 

func (x *Graph_Node) String() string

type ResourceRef 

type ResourceRef struct {

	// Types that are assignable to Value:
	//
	//	*ResourceRef_Id
	//	*ResourceRef_Name_
	Value isResourceRef_Value `protobuf_oneof:"value"`
	// The registry hostname of the resource.
	Registry string `protobuf:"bytes,3,opt,name=registry,proto3" json:"registry,omitempty"`
	// contains filtered or unexported fields
}

A reference to any of:

  • Module
  • Label
  • Commit

The id or name is resolved to a specific resource. If an id is passed, this is interpreted as being the id of the resource. If a name is passed, the semantics according to ResourceRef.Name are applied.

ResourceRefs can only be used in requests, and only for read-only RPCs, that is you should not use an arbitrary reference when modifying a specific resource.

ResourceRefs cannot reference archived Labels. The only way to retrieve an archived Label is to use LabelService.GetLabels.

See the package documentation for more details. You should likely use buf.registry.module.v1beta1 and not this package.

func (*ResourceRef) Descriptor deprecated 

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

Deprecated: Use ResourceRef.ProtoReflect.Descriptor instead.

func (*ResourceRef) GetId 

func (x *ResourceRef) GetId() string

func (*ResourceRef) GetName 

func (x *ResourceRef) GetName() *ResourceRef_Name

func (*ResourceRef) GetRegistry 

func (x *ResourceRef) GetRegistry() string

func (*ResourceRef) GetValue 

func (m *ResourceRef) GetValue() isResourceRef_Value

func (*ResourceRef) ProtoMessage 

func (*ResourceRef) ProtoMessage()

func (*ResourceRef) ProtoReflect 

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

func (*ResourceRef) Reset 

func (x *ResourceRef) Reset()

func (*ResourceRef) String 

func (x *ResourceRef) String() string

type ResourceRef_Id 

type ResourceRef_Id struct {
	// The id of the resource.
	Id string `protobuf:"bytes,1,opt,name=id,proto3,oneof"`
}

type ResourceRef_Name 

type ResourceRef_Name struct {

	// The name of the User or Organization that owns the resource.
	Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner,omitempty"`
	// The name of the Module the contains or is the resource.
	Module string `protobuf:"bytes,2,opt,name=module,proto3" json:"module,omitempty"`
	// If the oneof is present but empty, this should be treated as not present.
	//
	// Types that are assignable to Child:
	//
	//	*ResourceRef_Name_LabelName
	//	*ResourceRef_Name_Ref
	Child isResourceRef_Name_Child `protobuf_oneof:"child"`
	// contains filtered or unexported fields
}

The fully-qualified name component of a ResourceRef.

The following semantics are applied:

  • If the child oneof is not specified, the name is interpreted to reference a Module.
  • If label_name is specified, the name is interpreted to reference a Label.
  • If ref is specified, it is interpreted to be either an id or name.
  • If an id, this is equivalent to setting the id field on ResourceRef. However, backends can choose to validate that the owner and module fields match the resource referenced, as additional validation.
  • If a name, this is interpreted to be a Label name or an ID of a Commit without any dashes.
  • If there is a conflict between names across resources (for example, there is a Commit id and Label name of the same value), the following order of precedence is applied:
  • Commit
  • Label

Names can only be used in requests, and only for read-only RPCs, that is you should not use an arbitrary reference when modifying a specific resource.

func (*ResourceRef_Name) Descriptor deprecated 

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

Deprecated: Use ResourceRef_Name.ProtoReflect.Descriptor instead.

func (*ResourceRef_Name) GetChild 

func (m *ResourceRef_Name) GetChild() isResourceRef_Name_Child

func (*ResourceRef_Name) GetLabelName 

func (x *ResourceRef_Name) GetLabelName() string

func (*ResourceRef_Name) GetModule 

func (x *ResourceRef_Name) GetModule() string

func (*ResourceRef_Name) GetOwner 

func (x *ResourceRef_Name) GetOwner() string

func (*ResourceRef_Name) GetRef 

func (x *ResourceRef_Name) GetRef() string

func (*ResourceRef_Name) ProtoMessage 

func (*ResourceRef_Name) ProtoMessage()

func (*ResourceRef_Name) ProtoReflect 

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

func (*ResourceRef_Name) Reset 

func (x *ResourceRef_Name) Reset()

func (*ResourceRef_Name) String 

func (x *ResourceRef_Name) String() string

type ResourceRef_Name_ 

type ResourceRef_Name_ struct {
	// The fully-qualified name of the resource.
	Name *ResourceRef_Name `protobuf:"bytes,2,opt,name=name,proto3,oneof"`
}

type ResourceRef_Name_LabelName 

type ResourceRef_Name_LabelName struct {
	// The name of the Label.
	//
	// If this value is present but empty, this should be treated as not present, that is
	// an empty value is the same as a null value.
	LabelName string `protobuf:"bytes,3,opt,name=label_name,json=labelName,proto3,oneof"`
}

type ResourceRef_Name_Ref 

type ResourceRef_Name_Ref struct {
	// The untyped reference, applying the semantics as documented on the Name message.
	//
	// If this value is present but empty, this should be treated as not present, that is
	// an empty value is the same as a null value.
	Ref string `protobuf:"bytes,4,opt,name=ref,proto3,oneof"`
}

type UploadRequest 

type UploadRequest struct {

	// The Contents of all references.
	Contents []*UploadRequest_Content `protobuf:"bytes,1,rep,name=contents,proto3" json:"contents,omitempty"`
	// contains filtered or unexported fields
}

See the package documentation for more details. You should likely use buf.registry.module.v1beta1 and not this package.

func (*UploadRequest) Descriptor deprecated 

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

Deprecated: Use UploadRequest.ProtoReflect.Descriptor instead.

func (*UploadRequest) GetContents 

func (x *UploadRequest) GetContents() []*UploadRequest_Content

func (*UploadRequest) ProtoMessage 

func (*UploadRequest) ProtoMessage()

func (*UploadRequest) ProtoReflect 

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

func (*UploadRequest) Reset 

func (x *UploadRequest) Reset()

func (*UploadRequest) String 

func (x *UploadRequest) String() string

type UploadRequest_Content 

type UploadRequest_Content struct {

	// The Module of the reference.
	ModuleRef *v1beta1.ModuleRef `protobuf:"bytes,1,opt,name=module_ref,json=moduleRef,proto3" json:"module_ref,omitempty"`
	// The dependencies of the reference.
	//
	// This will include all transitive dependencies.
	DepRefs []*UploadRequest_DepRef `protobuf:"bytes,2,rep,name=dep_refs,json=depRefs,proto3" json:"dep_refs,omitempty"`
	// The Files of the Content.
	//
	// This will consist of the .proto files, license files, and documentation files.
	Files []*v1beta1.File `protobuf:"bytes,3,rep,name=files,proto3" json:"files,omitempty"`
	// The original v1beta1 or v1 buf.yaml file that encapsulated this reference, if it existed.
	//
	// This is used in deprecated digest calculations only. None of the structured
	// information within this File will or should convey further information about the reference.
	V1BufYamlFile *v1beta1.File `protobuf:"bytes,4,opt,name=v1_buf_yaml_file,json=v1BufYamlFile,proto3" json:"v1_buf_yaml_file,omitempty"`
	// The original v1beta1 or v1 buf.lock file that encapsulated this reference, if it existed.
	//
	// This is used in deprecated digest calculations only. None of the structured
	// information within this File will or should convey further information about the reference.
	//
	// Importantly, this file is *not* used to determine the dependencies of the reference. To
	// specify the dependencies, use the dep_refs fields.
	V1BufLockFile *v1beta1.File `protobuf:"bytes,5,opt,name=v1_buf_lock_file,json=v1BufLockFile,proto3" json:"v1_buf_lock_file,omitempty"`
	// The labels to associate with the Commit for the Content.
	//
	// If an id is set, this id must represent a Label that already exists and is
	// owned by the Module. The Label will point to the newly-created Commits for the References,
	// or will be updated to point to the pre-existing Commit for the Reference.
	//
	// If no labels are referenced, the default Label for the Module is used.
	//
	// If the Labels do not exist, they will be created.
	// If the Labels were archived, they will be unarchived.
	ScopedLabelRefs []*v1beta1.ScopedLabelRef `protobuf:"bytes,6,rep,name=scoped_label_refs,json=scopedLabelRefs,proto3" json:"scoped_label_refs,omitempty"`
	// The URL of the source control commit to associate with the Commit for this Content.
	//
	// BSR users can navigate to this link to find source control information that is relevant to this Commit
	// (e.g. commit description, PR discussion, authors, approvers, etc.).
	SourceControlUrl string `protobuf:"bytes,7,opt,name=source_control_url,json=sourceControlUrl,proto3" json:"source_control_url,omitempty"`
	// contains filtered or unexported fields
}

Content to upload for a given reference.

func (*UploadRequest_Content) Descriptor deprecated 

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

Deprecated: Use UploadRequest_Content.ProtoReflect.Descriptor instead.

func (*UploadRequest_Content) GetDepRefs 

func (x *UploadRequest_Content) GetDepRefs() []*UploadRequest_DepRef

func (*UploadRequest_Content) GetFiles 

func (x *UploadRequest_Content) GetFiles() []*v1beta1.File

func (*UploadRequest_Content) GetModuleRef 

func (x *UploadRequest_Content) GetModuleRef() *v1beta1.ModuleRef

func (*UploadRequest_Content) GetScopedLabelRefs 

func (x *UploadRequest_Content) GetScopedLabelRefs() []*v1beta1.ScopedLabelRef

func (*UploadRequest_Content) GetSourceControlUrl 

func (x *UploadRequest_Content) GetSourceControlUrl() string

func (*UploadRequest_Content) GetV1BufLockFile 

func (x *UploadRequest_Content) GetV1BufLockFile() *v1beta1.File

func (*UploadRequest_Content) GetV1BufYamlFile 

func (x *UploadRequest_Content) GetV1BufYamlFile() *v1beta1.File

func (*UploadRequest_Content) ProtoMessage 

func (*UploadRequest_Content) ProtoMessage()

func (*UploadRequest_Content) ProtoReflect 

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

func (*UploadRequest_Content) Reset 

func (x *UploadRequest_Content) Reset()

func (*UploadRequest_Content) String 

func (x *UploadRequest_Content) String() string

type UploadRequest_DepRef 

type UploadRequest_DepRef struct {

	// The Module of the dep.
	ModuleRef *v1beta1.ModuleRef `protobuf:"bytes,1,opt,name=module_ref,json=moduleRef,proto3" json:"module_ref,omitempty"`
	// The commit_id of the Commit, if this is referencing a Commit that already exists.
	//
	// If the ModuleRef refers to a Module that has associated Content, this field should *not*
	// be set, and setting it is an error.
	CommitId string `protobuf:"bytes,2,opt,name=commit_id,json=commitId,proto3" json:"commit_id,omitempty"`
	// The registry hostname of the dep.
	Registry string `protobuf:"bytes,3,opt,name=registry,proto3" json:"registry,omitempty"`
	// contains filtered or unexported fields
}

A dependency of Content, either referencing another Content message, or referencing a Commit that already exists.

func (*UploadRequest_DepRef) Descriptor deprecated 

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

Deprecated: Use UploadRequest_DepRef.ProtoReflect.Descriptor instead.

func (*UploadRequest_DepRef) GetCommitId 

func (x *UploadRequest_DepRef) GetCommitId() string

func (*UploadRequest_DepRef) GetModuleRef 

func (x *UploadRequest_DepRef) GetModuleRef() *v1beta1.ModuleRef

func (*UploadRequest_DepRef) GetRegistry 

func (x *UploadRequest_DepRef) GetRegistry() string

func (*UploadRequest_DepRef) ProtoMessage 

func (*UploadRequest_DepRef) ProtoMessage()

func (*UploadRequest_DepRef) ProtoReflect 

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

func (*UploadRequest_DepRef) Reset 

func (x *UploadRequest_DepRef) Reset()

func (*UploadRequest_DepRef) String 

func (x *UploadRequest_DepRef) String() string

type UploadResponse 

type UploadResponse struct {

	// The Commits for each reference in the same order as given on the request.
	//
	// A single Commit will be returned for each reference. These Commits may or may not be new.
	// If nothing changed for a given reference, the existing Commit will be returned.
	Commits []*v1beta1.Commit `protobuf:"bytes,1,rep,name=commits,proto3" json:"commits,omitempty"`
	// contains filtered or unexported fields
}

See the package documentation for more details. You should likely use buf.registry.module.v1beta1 and not this package.

func (*UploadResponse) Descriptor deprecated 

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

Deprecated: Use UploadResponse.ProtoReflect.Descriptor instead.

func (*UploadResponse) GetCommits 

func (x *UploadResponse) GetCommits() []*v1beta1.Commit

func (*UploadResponse) ProtoMessage 

func (*UploadResponse) ProtoMessage()

func (*UploadResponse) ProtoReflect 

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

func (*UploadResponse) Reset 

func (x *UploadResponse) Reset()

func (*UploadResponse) String 

func (x *UploadResponse) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

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