modulev1beta1

package
v1.34.0-20240102211805... Latest Latest
Warning

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

 Go to latest Published: unknown License: Apache-2.0 Imports: 8 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	DigestType_name = map[int32]string{
		0: "DIGEST_TYPE_UNSPECIFIED",
		1: "DIGEST_TYPE_B4",
		2: "DIGEST_TYPE_B5",
	}
	DigestType_value = map[string]int32{
		"DIGEST_TYPE_UNSPECIFIED": 0,
		"DIGEST_TYPE_B4":          1,
		"DIGEST_TYPE_B5":          2,
	}
)

Enum value maps for DigestType.

View Source 
var (
	FileType_name = map[int32]string{
		0: "FILE_TYPE_UNSPECIFIED",
		1: "FILE_TYPE_PROTO",
		2: "FILE_TYPE_DOC",
		3: "FILE_TYPE_LICENSE",
	}
	FileType_value = map[string]int32{
		"FILE_TYPE_UNSPECIFIED": 0,
		"FILE_TYPE_PROTO":       1,
		"FILE_TYPE_DOC":         2,
		"FILE_TYPE_LICENSE":     3,
	}
)

Enum value maps for FileType.

View Source 
var (
	ListLabelsRequest_Order_name = map[int32]string{
		0: "ORDER_UNSPECIFIED",
		1: "ORDER_CREATE_TIME_ASC",
		2: "ORDER_CREATE_TIME_DESC",
	}
	ListLabelsRequest_Order_value = map[string]int32{
		"ORDER_UNSPECIFIED":      0,
		"ORDER_CREATE_TIME_ASC":  1,
		"ORDER_CREATE_TIME_DESC": 2,
	}
)

Enum value maps for ListLabelsRequest_Order.

View Source 
var (
	ListLabelHistoryRequest_Order_name = map[int32]string{
		0: "ORDER_UNSPECIFIED",
		1: "ORDER_DESC",
		2: "ORDER_ASC",
	}
	ListLabelHistoryRequest_Order_value = map[string]int32{
		"ORDER_UNSPECIFIED": 0,
		"ORDER_DESC":        1,
		"ORDER_ASC":         2,
	}
)

Enum value maps for ListLabelHistoryRequest_Order.

View Source 
var (
	ModuleVisibility_name = map[int32]string{
		0: "MODULE_VISIBILITY_UNSPECIFIED",
		1: "MODULE_VISIBILITY_PUBLIC",
		2: "MODULE_VISIBILITY_PRIVATE",
	}
	ModuleVisibility_value = map[string]int32{
		"MODULE_VISIBILITY_UNSPECIFIED": 0,
		"MODULE_VISIBILITY_PUBLIC":      1,
		"MODULE_VISIBILITY_PRIVATE":     2,
	}
)

Enum value maps for ModuleVisibility.

View Source 
var (
	ModuleState_name = map[int32]string{
		0: "MODULE_STATE_UNSPECIFIED",
		1: "MODULE_STATE_ACTIVE",
		2: "MODULE_STATE_DEPRECATED",
	}
	ModuleState_value = map[string]int32{
		"MODULE_STATE_UNSPECIFIED": 0,
		"MODULE_STATE_ACTIVE":      1,
		"MODULE_STATE_DEPRECATED":  2,
	}
)

Enum value maps for ModuleState.

View Source 
var (
	ListModulesRequest_Order_name = map[int32]string{
		0: "ORDER_UNSPECIFIED",
		1: "ORDER_CREATE_TIME_ASC",
		2: "ORDER_CREATE_TIME_DESC",
	}
	ListModulesRequest_Order_value = map[string]int32{
		"ORDER_UNSPECIFIED":      0,
		"ORDER_CREATE_TIME_ASC":  1,
		"ORDER_CREATE_TIME_DESC": 2,
	}
)

Enum value maps for ListModulesRequest_Order.

View Source 
var (
	VCSType_name = map[int32]string{
		0: "VCS_TYPE_UNSPECIFIED",
		1: "VCS_TYPE_GIT",
	}
	VCSType_value = map[string]int32{
		"VCS_TYPE_UNSPECIFIED": 0,
		"VCS_TYPE_GIT":         1,
	}
)

Enum value maps for VCSType.

View Source 
var File_buf_registry_module_v1beta1_commit_proto protoreflect.FileDescriptor
View Source 
var File_buf_registry_module_v1beta1_commit_service_proto protoreflect.FileDescriptor
View Source 
var File_buf_registry_module_v1beta1_digest_proto protoreflect.FileDescriptor
View Source 
var File_buf_registry_module_v1beta1_download_service_proto protoreflect.FileDescriptor
View Source 
var File_buf_registry_module_v1beta1_file_proto protoreflect.FileDescriptor
View Source 
var File_buf_registry_module_v1beta1_graph_proto protoreflect.FileDescriptor
View Source 
var File_buf_registry_module_v1beta1_graph_service_proto protoreflect.FileDescriptor
View Source 
var File_buf_registry_module_v1beta1_label_proto protoreflect.FileDescriptor
View Source 
var File_buf_registry_module_v1beta1_label_service_proto protoreflect.FileDescriptor
View Source 
var File_buf_registry_module_v1beta1_module_proto protoreflect.FileDescriptor
View Source 
var File_buf_registry_module_v1beta1_module_service_proto protoreflect.FileDescriptor
View Source 
var File_buf_registry_module_v1beta1_resource_proto protoreflect.FileDescriptor
View Source 
var File_buf_registry_module_v1beta1_upload_service_proto protoreflect.FileDescriptor
View Source 
var File_buf_registry_module_v1beta1_vcs_commit_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Commit 

type Commit struct {

	// The id of the Commit.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The time the Commit was pushed to the BSR.
	//
	// Commits are immutable, so there is no corresponding update_time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// The id of the User or Organization that owns the Module that the Commit is associated with.
	OwnerId string `protobuf:"bytes,3,opt,name=owner_id,json=ownerId,proto3" json:"owner_id,omitempty"`
	// The id of the Module that the Commit is associated with.
	ModuleId string `protobuf:"bytes,4,opt,name=module_id,json=moduleId,proto3" json:"module_id,omitempty"`
	// The Digest of the Commit's contents.
	//
	// Note that individual RPCs may request a specific DigestType, and a Digest of
	// this DigestType will be returned as part of this Commit. This may affect your
	// caching of returned Commit messages if you require different DigestTypes.
	Digest *Digest `protobuf:"bytes,5,opt,name=digest,proto3" json:"digest,omitempty"`
	// The id of the User that created this Commit on the BSR.
	CreatedByUserId string `protobuf:"bytes,6,opt,name=created_by_user_id,json=createdByUserId,proto3" json:"created_by_user_id,omitempty"`
	// VCS commit information.
	VcsCommit *VCSCommit `protobuf:"bytes,7,opt,name=vcs_commit,json=vcsCommit,proto3" json:"vcs_commit,omitempty"`
	// contains filtered or unexported fields
}

A commit on a specific Module.

Commits are immutable.

Many Commits may be associated with one Digest.

Note that the Digest returned on a Commit depends on the requested DigestType in the RPC that returned the Commit.

func (*Commit) Descriptor deprecated 

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

Deprecated: Use Commit.ProtoReflect.Descriptor instead.

func (*Commit) GetCreateTime 

func (x *Commit) GetCreateTime() *timestamppb.Timestamp

func (*Commit) GetCreatedByUserId 

func (x *Commit) GetCreatedByUserId() string

func (*Commit) GetDigest 

func (x *Commit) GetDigest() *Digest

func (*Commit) GetId 

func (x *Commit) GetId() string

func (*Commit) GetModuleId 

func (x *Commit) GetModuleId() string

func (*Commit) GetOwnerId 

func (x *Commit) GetOwnerId() string

func (*Commit) GetVcsCommit 

func (x *Commit) GetVcsCommit() *VCSCommit

func (*Commit) ProtoMessage 

func (*Commit) ProtoMessage()

func (*Commit) ProtoReflect 

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

func (*Commit) Reset 

func (x *Commit) Reset()

func (*Commit) String 

func (x *Commit) String() string

type CreateModulesRequest 

type CreateModulesRequest struct {

	// The Modules to create.
	Values []*CreateModulesRequest_Value `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateModulesRequest) Descriptor deprecated 

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

Deprecated: Use CreateModulesRequest.ProtoReflect.Descriptor instead.

func (*CreateModulesRequest) GetValues 

func (x *CreateModulesRequest) GetValues() []*CreateModulesRequest_Value

func (*CreateModulesRequest) ProtoMessage 

func (*CreateModulesRequest) ProtoMessage()

func (*CreateModulesRequest) ProtoReflect 

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

func (*CreateModulesRequest) Reset 

func (x *CreateModulesRequest) Reset()

func (*CreateModulesRequest) String 

func (x *CreateModulesRequest) String() string

type CreateModulesRequest_Value 

type CreateModulesRequest_Value struct {

	// The User or Organization to create the Module under.
	OwnerRef *v1beta1.OwnerRef `protobuf:"bytes,1,opt,name=owner_ref,json=ownerRef,proto3" json:"owner_ref,omitempty"`
	// The name of the Module.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// The module's visibility.
	Visibility ModuleVisibility `protobuf:"varint,3,opt,name=visibility,proto3,enum=buf.registry.module.v1beta1.ModuleVisibility" json:"visibility,omitempty"`
	// The configurable description of the Module.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// The configurable URL in the description of the module.
	Url string `protobuf:"bytes,5,opt,name=url,proto3" json:"url,omitempty"`
	// The name of the default Label of the Module.
	//
	// If not set, the default Label will be named "main" upon creation.
	DefaultLabelName string `protobuf:"bytes,6,opt,name=default_label_name,json=defaultLabelName,proto3" json:"default_label_name,omitempty"`
	// contains filtered or unexported fields
}

An individual request to create a Module.

func (*CreateModulesRequest_Value) Descriptor deprecated 

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

Deprecated: Use CreateModulesRequest_Value.ProtoReflect.Descriptor instead.

func (*CreateModulesRequest_Value) GetDefaultLabelName 

func (x *CreateModulesRequest_Value) GetDefaultLabelName() string

func (*CreateModulesRequest_Value) GetDescription 

func (x *CreateModulesRequest_Value) GetDescription() string

func (*CreateModulesRequest_Value) GetName 

func (x *CreateModulesRequest_Value) GetName() string

func (*CreateModulesRequest_Value) GetOwnerRef 

func (x *CreateModulesRequest_Value) GetOwnerRef() *v1beta1.OwnerRef

func (*CreateModulesRequest_Value) GetUrl 

func (x *CreateModulesRequest_Value) GetUrl() string

func (*CreateModulesRequest_Value) GetVisibility 

func (x *CreateModulesRequest_Value) GetVisibility() ModuleVisibility

func (*CreateModulesRequest_Value) ProtoMessage 

func (*CreateModulesRequest_Value) ProtoMessage()

func (*CreateModulesRequest_Value) ProtoReflect 

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

func (*CreateModulesRequest_Value) Reset 

func (x *CreateModulesRequest_Value) Reset()

func (*CreateModulesRequest_Value) String 

func (x *CreateModulesRequest_Value) String() string

type CreateModulesResponse 

type CreateModulesResponse struct {

	// The created Modules in the same order as given on the request.
	Modules []*Module `protobuf:"bytes,1,rep,name=modules,proto3" json:"modules,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateModulesResponse) Descriptor deprecated 

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

Deprecated: Use CreateModulesResponse.ProtoReflect.Descriptor instead.

func (*CreateModulesResponse) GetModules 

func (x *CreateModulesResponse) GetModules() []*Module

func (*CreateModulesResponse) ProtoMessage 

func (*CreateModulesResponse) ProtoMessage()

func (*CreateModulesResponse) ProtoReflect 

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

func (*CreateModulesResponse) Reset 

func (x *CreateModulesResponse) Reset()

func (*CreateModulesResponse) String 

func (x *CreateModulesResponse) String() string

type CreateOrUpdateLabelsRequest 

type CreateOrUpdateLabelsRequest struct {

	// The Labels to create.
	Values []*CreateOrUpdateLabelsRequest_Value `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateOrUpdateLabelsRequest) Descriptor deprecated 

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

Deprecated: Use CreateOrUpdateLabelsRequest.ProtoReflect.Descriptor instead.

func (*CreateOrUpdateLabelsRequest) GetValues 

func (x *CreateOrUpdateLabelsRequest) GetValues() []*CreateOrUpdateLabelsRequest_Value

func (*CreateOrUpdateLabelsRequest) ProtoMessage 

func (*CreateOrUpdateLabelsRequest) ProtoMessage()

func (*CreateOrUpdateLabelsRequest) ProtoReflect 

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

func (*CreateOrUpdateLabelsRequest) Reset 

func (x *CreateOrUpdateLabelsRequest) Reset()

func (*CreateOrUpdateLabelsRequest) String 

func (x *CreateOrUpdateLabelsRequest) String() string

type CreateOrUpdateLabelsRequest_Value 

type CreateOrUpdateLabelsRequest_Value struct {

	// The Labels to create or update.
	LabelRef *LabelRef `protobuf:"bytes,1,opt,name=label_ref,json=labelRef,proto3" json:"label_ref,omitempty"`
	// The id of the Commit to associate with the Label.
	//
	// If the Label already existed, the Label will now point to this Commit.
	CommitId string `protobuf:"bytes,2,opt,name=commit_id,json=commitId,proto3" json:"commit_id,omitempty"`
	// contains filtered or unexported fields
}

An individual request to create or update a Label.

func (*CreateOrUpdateLabelsRequest_Value) Descriptor deprecated 

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

Deprecated: Use CreateOrUpdateLabelsRequest_Value.ProtoReflect.Descriptor instead.

func (*CreateOrUpdateLabelsRequest_Value) GetCommitId 

func (x *CreateOrUpdateLabelsRequest_Value) GetCommitId() string

func (*CreateOrUpdateLabelsRequest_Value) GetLabelRef 

func (x *CreateOrUpdateLabelsRequest_Value) GetLabelRef() *LabelRef

func (*CreateOrUpdateLabelsRequest_Value) ProtoMessage 

func (*CreateOrUpdateLabelsRequest_Value) ProtoMessage()

func (*CreateOrUpdateLabelsRequest_Value) ProtoReflect 

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

func (*CreateOrUpdateLabelsRequest_Value) Reset 

func (x *CreateOrUpdateLabelsRequest_Value) Reset()

func (*CreateOrUpdateLabelsRequest_Value) String 

func (x *CreateOrUpdateLabelsRequest_Value) String() string

type CreateOrUpdateLabelsResponse 

type CreateOrUpdateLabelsResponse struct {

	// The created or updated Labels in the same order as given on the request.
	Labels []*Label `protobuf:"bytes,1,rep,name=labels,proto3" json:"labels,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateOrUpdateLabelsResponse) Descriptor deprecated 

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

Deprecated: Use CreateOrUpdateLabelsResponse.ProtoReflect.Descriptor instead.

func (*CreateOrUpdateLabelsResponse) GetLabels 

func (x *CreateOrUpdateLabelsResponse) GetLabels() []*Label

func (*CreateOrUpdateLabelsResponse) ProtoMessage 

func (*CreateOrUpdateLabelsResponse) ProtoMessage()

func (*CreateOrUpdateLabelsResponse) ProtoReflect 

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

func (*CreateOrUpdateLabelsResponse) Reset 

func (x *CreateOrUpdateLabelsResponse) Reset()

func (*CreateOrUpdateLabelsResponse) String 

func (x *CreateOrUpdateLabelsResponse) String() string

type DeleteLabelsRequest 

type DeleteLabelsRequest struct {

	// The Labels to delete.
	LabelRefs []*LabelRef `protobuf:"bytes,1,rep,name=label_refs,json=labelRefs,proto3" json:"label_refs,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteLabelsRequest) Descriptor deprecated 

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

Deprecated: Use DeleteLabelsRequest.ProtoReflect.Descriptor instead.

func (*DeleteLabelsRequest) GetLabelRefs 

func (x *DeleteLabelsRequest) GetLabelRefs() []*LabelRef

func (*DeleteLabelsRequest) ProtoMessage 

func (*DeleteLabelsRequest) ProtoMessage()

func (*DeleteLabelsRequest) ProtoReflect 

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

func (*DeleteLabelsRequest) Reset 

func (x *DeleteLabelsRequest) Reset()

func (*DeleteLabelsRequest) String 

func (x *DeleteLabelsRequest) String() string

type DeleteLabelsResponse 

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

func (*DeleteLabelsResponse) Descriptor deprecated 

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

Deprecated: Use DeleteLabelsResponse.ProtoReflect.Descriptor instead.

func (*DeleteLabelsResponse) ProtoMessage 

func (*DeleteLabelsResponse) ProtoMessage()

func (*DeleteLabelsResponse) ProtoReflect 

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

func (*DeleteLabelsResponse) Reset 

func (x *DeleteLabelsResponse) Reset()

func (*DeleteLabelsResponse) String 

func (x *DeleteLabelsResponse) String() string

type DeleteModulesRequest 

type DeleteModulesRequest struct {

	// The Modules to delete.
	ModuleRefs []*ModuleRef `protobuf:"bytes,1,rep,name=module_refs,json=moduleRefs,proto3" json:"module_refs,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteModulesRequest) Descriptor deprecated 

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

Deprecated: Use DeleteModulesRequest.ProtoReflect.Descriptor instead.

func (*DeleteModulesRequest) GetModuleRefs 

func (x *DeleteModulesRequest) GetModuleRefs() []*ModuleRef

func (*DeleteModulesRequest) ProtoMessage 

func (*DeleteModulesRequest) ProtoMessage()

func (*DeleteModulesRequest) ProtoReflect 

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

func (*DeleteModulesRequest) Reset 

func (x *DeleteModulesRequest) Reset()

func (*DeleteModulesRequest) String 

func (x *DeleteModulesRequest) String() string

type DeleteModulesResponse 

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

func (*DeleteModulesResponse) Descriptor deprecated 

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

Deprecated: Use DeleteModulesResponse.ProtoReflect.Descriptor instead.

func (*DeleteModulesResponse) ProtoMessage 

func (*DeleteModulesResponse) ProtoMessage()

func (*DeleteModulesResponse) ProtoReflect 

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

func (*DeleteModulesResponse) Reset 

func (x *DeleteModulesResponse) Reset()

func (*DeleteModulesResponse) String 

func (x *DeleteModulesResponse) String() string

type Digest 

type Digest struct {

	// The type of the Digest.
	Type DigestType `protobuf:"varint,1,opt,name=type,proto3,enum=buf.registry.module.v1beta1.DigestType" json:"type,omitempty"`
	// The value of the Digest.
	Value []byte `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

A digest of a Commit's content.

A digest represents all content for a single Commit, including its .proto files, documentation files, license files, and the digests of its dependencies.

TODO: CommitDigest? What to do about naming in bufbuild/buf (ModuleDigest)?

func (*Digest) Descriptor deprecated 

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

Deprecated: Use Digest.ProtoReflect.Descriptor instead.

func (*Digest) GetType 

func (x *Digest) GetType() DigestType

func (*Digest) GetValue 

func (x *Digest) GetValue() []byte

func (*Digest) ProtoMessage 

func (*Digest) ProtoMessage()

func (*Digest) ProtoReflect 

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

func (*Digest) Reset 

func (x *Digest) Reset()

func (*Digest) String 

func (x *Digest) String() string

type DigestType 

type DigestType int32

The type of Digest. 

const (
	DigestType_DIGEST_TYPE_UNSPECIFIED DigestType = 0
	// The b4 digest function.
	DigestType_DIGEST_TYPE_B4 DigestType = 1
	// The b5 digest function.
	DigestType_DIGEST_TYPE_B5 DigestType = 2
)

func (DigestType) Descriptor 

func (DigestType) Descriptor() protoreflect.EnumDescriptor

func (DigestType) Enum 

func (x DigestType) Enum() *DigestType

func (DigestType) EnumDescriptor deprecated 

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

Deprecated: Use DigestType.Descriptor instead.

func (DigestType) Number 

func (x DigestType) Number() protoreflect.EnumNumber

func (DigestType) String 

func (x DigestType) String() string

func (DigestType) Type 

func (DigestType) Type() protoreflect.EnumType

type DownloadRequest 

type DownloadRequest struct {

	// The references to get contents for.
	Values []*DownloadRequest_Value `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
	// The DigestType to return for Commits of references.
	//
	// 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, currently B5.
	DigestType DigestType `` /* 136-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*DownloadRequest) Descriptor deprecated 

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

Deprecated: Use DownloadRequest.ProtoReflect.Descriptor instead.

func (*DownloadRequest) GetDigestType 

func (x *DownloadRequest) GetDigestType() DigestType

func (*DownloadRequest) GetValues 

func (x *DownloadRequest) GetValues() []*DownloadRequest_Value

func (*DownloadRequest) ProtoMessage 

func (*DownloadRequest) ProtoMessage()

func (*DownloadRequest) ProtoReflect 

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

func (*DownloadRequest) Reset 

func (x *DownloadRequest) Reset()

func (*DownloadRequest) String 

func (x *DownloadRequest) String() string

type DownloadRequest_Value 

type DownloadRequest_Value struct {

	// The reference to get content for.
	//
	// See the documentation on ResourceRef for resource resolution details.
	//
	// Once the resource is resolved, the following content is returned:
	//   - If a Module is referenced, the content of the Commit of the default Label is returned.
	//   - If a Label is referenced, the content of the Commit of this Label is returned.
	//   - If a Commit is referenced, the content for this Commit is returned.
	ResourceRef *ResourceRef `protobuf:"bytes,1,opt,name=resource_ref,json=resourceRef,proto3" json:"resource_ref,omitempty"`
	// Specific file types to request.
	//
	// If not set, all file types are returned.
	FileTypes []FileType `` /* 138-byte string literal not displayed */
	// Specific file paths to retrieve.
	//
	// May be directories. For example, path "foo/bar" will result in files "foo/bar/baz.proto",
	// "foo/bar/LICENSE" being downloaded.
	//
	// If empty, all file paths for the given reference are retrieved.
	//
	// If no paths match, an empty Files list will be returned, however the call may still
	// be successful if paths_allow_not_exist is set (the dependency list may still be on
	// the response). If a directory "foo/bar" is specified but this directory has no files,
	// this is considered to be a non-match.
	//
	// This field also interacts with file_types - if file_types is set, a path only matches
	// if it is also of the file type, and if there are no matching paths for the given FileTypes,
	// an error is returned unless paths_not_allow_exist is set.
	//
	// Note that paths may reference dependency paths if include_dep_files is set.
	//
	// The path must be relative, and cannot contain any "." or ".." components
	// The separator "/" must be used.
	Paths []string `protobuf:"bytes,3,rep,name=paths,proto3" json:"paths,omitempty"`
	// Whether to allow file paths not to exist within the given module.
	//
	// For example, one may want to retrieve the file paths "buf.md" and "README.md",
	// but only expect one to actually exist.
	//
	// If false, it is an error to specify non-existent file paths.
	PathsAllowNotExist bool `protobuf:"varint,4,opt,name=paths_allow_not_exist,json=pathsAllowNotExist,proto3" json:"paths_allow_not_exist,omitempty"`
	// contains filtered or unexported fields
}

A request for content for a single reference.

func (*DownloadRequest_Value) Descriptor deprecated 

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

Deprecated: Use DownloadRequest_Value.ProtoReflect.Descriptor instead.

func (*DownloadRequest_Value) GetFileTypes 

func (x *DownloadRequest_Value) GetFileTypes() []FileType

func (*DownloadRequest_Value) GetPaths 

func (x *DownloadRequest_Value) GetPaths() []string

func (*DownloadRequest_Value) GetPathsAllowNotExist 

func (x *DownloadRequest_Value) GetPathsAllowNotExist() bool

func (*DownloadRequest_Value) GetResourceRef 

func (x *DownloadRequest_Value) GetResourceRef() *ResourceRef

func (*DownloadRequest_Value) ProtoMessage 

func (*DownloadRequest_Value) ProtoMessage()

func (*DownloadRequest_Value) ProtoReflect 

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

func (*DownloadRequest_Value) Reset 

func (x *DownloadRequest_Value) Reset()

func (*DownloadRequest_Value) String 

func (x *DownloadRequest_Value) String() string

type DownloadResponse 

type DownloadResponse struct {

	// The Contents of the references in the same order as requested.
	Contents []*DownloadResponse_Content `protobuf:"bytes,1,rep,name=contents,proto3" json:"contents,omitempty"`
	// contains filtered or unexported fields
}

func (*DownloadResponse) Descriptor deprecated 

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

Deprecated: Use DownloadResponse.ProtoReflect.Descriptor instead.

func (*DownloadResponse) GetContents 

func (x *DownloadResponse) GetContents() []*DownloadResponse_Content

func (*DownloadResponse) ProtoMessage 

func (*DownloadResponse) ProtoMessage()

func (*DownloadResponse) ProtoReflect 

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

func (*DownloadResponse) Reset 

func (x *DownloadResponse) Reset()

func (*DownloadResponse) String 

func (x *DownloadResponse) String() string

type DownloadResponse_Content 

type DownloadResponse_Content struct {

	// The Commit associated with the Content.
	//
	// The Commit associated with this ID will be present in the commits field.
	Commit *Commit `protobuf:"bytes,1,opt,name=commit,proto3" json:"commit,omitempty"`
	// The Files of the content.
	//
	// This will consist of the .proto files, license files, and documentation files.
	//
	// If no paths match and paths_allow_not_exist is set, this may be empty.
	Files []*File `protobuf:"bytes,2,rep,name=files,proto3" json:"files,omitempty"`
	// contains filtered or unexported fields
}

Content for a single Commit.

func (*DownloadResponse_Content) Descriptor deprecated 

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

Deprecated: Use DownloadResponse_Content.ProtoReflect.Descriptor instead.

func (*DownloadResponse_Content) GetCommit 

func (x *DownloadResponse_Content) GetCommit() *Commit

func (*DownloadResponse_Content) GetFiles 

func (x *DownloadResponse_Content) GetFiles() []*File

func (*DownloadResponse_Content) ProtoMessage 

func (*DownloadResponse_Content) ProtoMessage()

func (*DownloadResponse_Content) ProtoReflect 

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

func (*DownloadResponse_Content) Reset 

func (x *DownloadResponse_Content) Reset()

func (*DownloadResponse_Content) String 

func (x *DownloadResponse_Content) String() string

type File 

type File struct {

	// The path of the File.
	//
	// The path must be relative, and cannot contain any "." or ".." components.
	// The separator "/" must be used.
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// The content of the File.
	//
	// May be empty.
	Content []byte `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	// contains filtered or unexported fields
}

A file that can be read or written to from disk.

A File includes a path and associated content. Files are purposfully simple, and do not include attributes such as permissions.

func (*File) Descriptor deprecated 

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

Deprecated: Use File.ProtoReflect.Descriptor instead.

func (*File) GetContent 

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

func (*File) GetPath 

func (x *File) GetPath() string

func (*File) ProtoMessage 

func (*File) ProtoMessage()

func (*File) ProtoReflect 

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

func (*File) Reset 

func (x *File) Reset()

func (*File) String 

func (x *File) String() string

type FileType 

type FileType int32

A specific file type. 

const (
	FileType_FILE_TYPE_UNSPECIFIED FileType = 0
	// A .proto file.
	FileType_FILE_TYPE_PROTO FileType = 1
	// A documentation file.
	//
	// Documentation files are always named README.md, README.markdown, or buf.md.
	FileType_FILE_TYPE_DOC FileType = 2
	// A license file.
	//
	// License files are always named LICENSE.
	FileType_FILE_TYPE_LICENSE FileType = 3
)

func (FileType) Descriptor 

func (FileType) Descriptor() protoreflect.EnumDescriptor

func (FileType) Enum 

func (x FileType) Enum() *FileType

func (FileType) EnumDescriptor deprecated 

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

Deprecated: Use FileType.Descriptor instead.

func (FileType) Number 

func (x FileType) Number() protoreflect.EnumNumber

func (FileType) String 

func (x FileType) String() string

func (FileType) Type 

func (FileType) Type() protoreflect.EnumType

type GetCommitsRequest 

type GetCommitsRequest struct {

	// References to request a Commit for.
	//
	// See the documentation on ResourceRef for resource resolution details.
	//
	// Resolution is as follows:
	//   - If a Module is referenced, the Commit of the default Label is returned.
	//   - If a Label is referenced, the Commit of this Label is returned.
	//   - If a Commit is referenced, this Commit is returned.
	//
	// TODO: It's a little incongruent to have a Get request take a ResourceRef.
	ResourceRefs []*ResourceRef `protobuf:"bytes,1,rep,name=resource_refs,json=resourceRefs,proto3" json:"resource_refs,omitempty"`
	// The DigestType to use for Digests returned on Commits.
	//
	// 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, currently B5.
	DigestType DigestType `` /* 136-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*GetCommitsRequest) Descriptor deprecated 

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

Deprecated: Use GetCommitsRequest.ProtoReflect.Descriptor instead.

func (*GetCommitsRequest) GetDigestType 

func (x *GetCommitsRequest) GetDigestType() DigestType

func (*GetCommitsRequest) GetResourceRefs 

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

func (*GetCommitsRequest) ProtoMessage 

func (*GetCommitsRequest) ProtoMessage()

func (*GetCommitsRequest) ProtoReflect 

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

func (*GetCommitsRequest) Reset 

func (x *GetCommitsRequest) Reset()

func (*GetCommitsRequest) String 

func (x *GetCommitsRequest) String() string

type GetCommitsResponse 

type GetCommitsResponse struct {

	// The found Commits in the same order as requested.
	Commits []*Commit `protobuf:"bytes,1,rep,name=commits,proto3" json:"commits,omitempty"`
	// contains filtered or unexported fields
}

func (*GetCommitsResponse) Descriptor deprecated 

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

Deprecated: Use GetCommitsResponse.ProtoReflect.Descriptor instead.

func (*GetCommitsResponse) GetCommits 

func (x *GetCommitsResponse) GetCommits() []*Commit

func (*GetCommitsResponse) ProtoMessage 

func (*GetCommitsResponse) ProtoMessage()

func (*GetCommitsResponse) ProtoReflect 

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

func (*GetCommitsResponse) Reset 

func (x *GetCommitsResponse) Reset()

func (*GetCommitsResponse) String 

func (x *GetCommitsResponse) String() string

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 incuded.
	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 DigestType `` /* 136-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*GetGraphRequest) Descriptor deprecated 

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

Deprecated: Use GetGraphRequest.ProtoReflect.Descriptor instead.

func (*GetGraphRequest) GetDigestType 

func (x *GetGraphRequest) GetDigestType() 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
}

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 GetLabelsRequest 

type GetLabelsRequest struct {

	// The Labels to request.
	LabelRefs []*LabelRef `protobuf:"bytes,1,rep,name=label_refs,json=labelRefs,proto3" json:"label_refs,omitempty"`
	// contains filtered or unexported fields
}

func (*GetLabelsRequest) Descriptor deprecated 

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

Deprecated: Use GetLabelsRequest.ProtoReflect.Descriptor instead.

func (*GetLabelsRequest) GetLabelRefs 

func (x *GetLabelsRequest) GetLabelRefs() []*LabelRef

func (*GetLabelsRequest) ProtoMessage 

func (*GetLabelsRequest) ProtoMessage()

func (*GetLabelsRequest) ProtoReflect 

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

func (*GetLabelsRequest) Reset 

func (x *GetLabelsRequest) Reset()

func (*GetLabelsRequest) String 

func (x *GetLabelsRequest) String() string

type GetLabelsResponse 

type GetLabelsResponse struct {

	// The retrieved Labels in the same order as requested.
	Labels []*Label `protobuf:"bytes,1,rep,name=labels,proto3" json:"labels,omitempty"`
	// contains filtered or unexported fields
}

func (*GetLabelsResponse) Descriptor deprecated 

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

Deprecated: Use GetLabelsResponse.ProtoReflect.Descriptor instead.

func (*GetLabelsResponse) GetLabels 

func (x *GetLabelsResponse) GetLabels() []*Label

func (*GetLabelsResponse) ProtoMessage 

func (*GetLabelsResponse) ProtoMessage()

func (*GetLabelsResponse) ProtoReflect 

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

func (*GetLabelsResponse) Reset 

func (x *GetLabelsResponse) Reset()

func (*GetLabelsResponse) String 

func (x *GetLabelsResponse) String() string

type GetModulesRequest 

type GetModulesRequest struct {

	// The Modules to request.
	ModuleRefs []*ModuleRef `protobuf:"bytes,1,rep,name=module_refs,json=moduleRefs,proto3" json:"module_refs,omitempty"`
	// contains filtered or unexported fields
}

func (*GetModulesRequest) Descriptor deprecated 

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

Deprecated: Use GetModulesRequest.ProtoReflect.Descriptor instead.

func (*GetModulesRequest) GetModuleRefs 

func (x *GetModulesRequest) GetModuleRefs() []*ModuleRef

func (*GetModulesRequest) ProtoMessage 

func (*GetModulesRequest) ProtoMessage()

func (*GetModulesRequest) ProtoReflect 

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

func (*GetModulesRequest) Reset 

func (x *GetModulesRequest) Reset()

func (*GetModulesRequest) String 

func (x *GetModulesRequest) String() string

type GetModulesResponse 

type GetModulesResponse struct {

	// The retrieved Modules in the same order as requested.
	Modules []*Module `protobuf:"bytes,1,rep,name=modules,proto3" json:"modules,omitempty"`
	// contains filtered or unexported fields
}

func (*GetModulesResponse) Descriptor deprecated 

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

Deprecated: Use GetModulesResponse.ProtoReflect.Descriptor instead.

func (*GetModulesResponse) GetModules 

func (x *GetModulesResponse) GetModules() []*Module

func (*GetModulesResponse) ProtoMessage 

func (*GetModulesResponse) ProtoMessage()

func (*GetModulesResponse) ProtoReflect 

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

func (*GetModulesResponse) Reset 

func (x *GetModulesResponse) Reset()

func (*GetModulesResponse) String 

func (x *GetModulesResponse) String() string

type Graph 

type Graph struct {

	// The nodes of the graph, each of which are Commits.
	Commits []*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.

func (*Graph) Descriptor deprecated 

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

Deprecated: Use Graph.ProtoReflect.Descriptor instead.

func (*Graph) GetCommits 

func (x *Graph) GetCommits() []*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_Edge 

type Graph_Edge struct {

	// The Commit of the start of the edge.
	FromCommitId string `protobuf:"bytes,1,opt,name=from_commit_id,json=fromCommitId,proto3" json:"from_commit_id,omitempty"`
	// The Commit of the end of the edge.
	ToCommitId string `protobuf:"bytes,2,opt,name=to_commit_id,json=toCommitId,proto3" json:"to_commit_id,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) GetFromCommitId 

func (x *Graph_Edge) GetFromCommitId() string

func (*Graph_Edge) GetToCommitId 

func (x *Graph_Edge) GetToCommitId() string

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 Label 

type Label struct {

	// The id of the Label.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The time the Label was created on the BSR.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// The last time the Label was updated on the BSR.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// The name of the Label.
	//
	// Unique within a given Module.
	Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"`
	// The id of the User or Organization that owns the Module that the Label is associated with.
	OwnerId string `protobuf:"bytes,5,opt,name=owner_id,json=ownerId,proto3" json:"owner_id,omitempty"`
	// The id of the Module that the Label is associated with.
	ModuleId string `protobuf:"bytes,6,opt,name=module_id,json=moduleId,proto3" json:"module_id,omitempty"`
	// The id of the Commit currently associated with the Label.
	//
	// To get the history of the Commits that have been associated with a Label, use ListLabelHistory.
	CommitId string `protobuf:"bytes,7,opt,name=commit_id,json=commitId,proto3" json:"commit_id,omitempty"`
	// The id of the User that last updated this Label on the BSR.
	UpdatedByUserId string `protobuf:"bytes,8,opt,name=updated_by_user_id,json=updatedByUserId,proto3" json:"updated_by_user_id,omitempty"`
	// contains filtered or unexported fields
}

A label on a specific Module.

Many Labels can be associated with one Commit.

func (*Label) Descriptor deprecated 

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

Deprecated: Use Label.ProtoReflect.Descriptor instead.

func (*Label) GetCommitId 

func (x *Label) GetCommitId() string

func (*Label) GetCreateTime 

func (x *Label) GetCreateTime() *timestamppb.Timestamp

func (*Label) GetId 

func (x *Label) GetId() string

func (*Label) GetModuleId 

func (x *Label) GetModuleId() string

func (*Label) GetName 

func (x *Label) GetName() string

func (*Label) GetOwnerId 

func (x *Label) GetOwnerId() string

func (*Label) GetUpdateTime 

func (x *Label) GetUpdateTime() *timestamppb.Timestamp

func (*Label) GetUpdatedByUserId 

func (x *Label) GetUpdatedByUserId() string

func (*Label) ProtoMessage 

func (*Label) ProtoMessage()

func (*Label) ProtoReflect 

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

func (*Label) Reset 

func (x *Label) Reset()

func (*Label) String 

func (x *Label) String() string

type LabelRef 

type LabelRef struct {

	// Types that are assignable to Value:
	//
	//	*LabelRef_Id
	//	*LabelRef_Name_
	Value isLabelRef_Value `protobuf_oneof:"value"`
	// contains filtered or unexported fields
}

LabelRef is a reference to a Label, either an id or a fully-qualified name.

This is used in requests.

func (*LabelRef) Descriptor deprecated 

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

Deprecated: Use LabelRef.ProtoReflect.Descriptor instead.

func (*LabelRef) GetId 

func (x *LabelRef) GetId() string

func (*LabelRef) GetName 

func (x *LabelRef) GetName() *LabelRef_Name

func (*LabelRef) GetValue 

func (m *LabelRef) GetValue() isLabelRef_Value

func (*LabelRef) ProtoMessage 

func (*LabelRef) ProtoMessage()

func (*LabelRef) ProtoReflect 

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

func (*LabelRef) Reset 

func (x *LabelRef) Reset()

func (*LabelRef) String 

func (x *LabelRef) String() string

type LabelRef_Id 

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

type LabelRef_Name 

type LabelRef_Name struct {

	// The name of the owner of the Module that contains the Label, either a User or Organization.
	Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner,omitempty"`
	// The name of the Module that contains the Label, either a User or Organization.
	Module string `protobuf:"bytes,2,opt,name=module,proto3" json:"module,omitempty"`
	// The Label name.
	Label string `protobuf:"bytes,3,opt,name=label,proto3" json:"label,omitempty"`
	// contains filtered or unexported fields
}

The fully-qualified name of a Label within a BSR instance.

A Name uniquely identifies a Label. This is used for requests when a caller only has the label name and not the ID.

func (*LabelRef_Name) Descriptor deprecated 

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

Deprecated: Use LabelRef_Name.ProtoReflect.Descriptor instead.

func (*LabelRef_Name) GetLabel 

func (x *LabelRef_Name) GetLabel() string

func (*LabelRef_Name) GetModule 

func (x *LabelRef_Name) GetModule() string

func (*LabelRef_Name) GetOwner 

func (x *LabelRef_Name) GetOwner() string

func (*LabelRef_Name) ProtoMessage 

func (*LabelRef_Name) ProtoMessage()

func (*LabelRef_Name) ProtoReflect 

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

func (*LabelRef_Name) Reset 

func (x *LabelRef_Name) Reset()

func (*LabelRef_Name) String 

func (x *LabelRef_Name) String() string

type LabelRef_Name_ 

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

type ListLabelHistoryRequest 

type ListLabelHistoryRequest struct {

	// The maximum number of items to return.
	//
	// The default value is 10.
	PageSize uint32 `protobuf:"varint,1,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The page to start from.
	//
	// If empty, the first page is returned.
	PageToken string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// The Label to list history for.
	LabelRef *LabelRef `protobuf:"bytes,3,opt,name=label_ref,json=labelRef,proto3" json:"label_ref,omitempty"`
	// The order to list the Labels.
	//
	// By default, ORDER_DESC is used.
	//
	// TODO: Do we want ORDER_DESC to be the default?
	// TODO: We are purposefully not making the default the zero enum value, however
	// we may want to consider this.
	Order ListLabelHistoryRequest_Order `` /* 127-byte string literal not displayed */
	// The DigestType to use for Digests returned on Commits.
	//
	// 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, currently B5.
	DigestType DigestType `` /* 136-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*ListLabelHistoryRequest) Descriptor deprecated 

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

Deprecated: Use ListLabelHistoryRequest.ProtoReflect.Descriptor instead.

func (*ListLabelHistoryRequest) GetDigestType 

func (x *ListLabelHistoryRequest) GetDigestType() DigestType

func (*ListLabelHistoryRequest) GetLabelRef 

func (x *ListLabelHistoryRequest) GetLabelRef() *LabelRef

func (*ListLabelHistoryRequest) GetOrder 

func (x *ListLabelHistoryRequest) GetOrder() ListLabelHistoryRequest_Order

func (*ListLabelHistoryRequest) GetPageSize 

func (x *ListLabelHistoryRequest) GetPageSize() uint32

func (*ListLabelHistoryRequest) GetPageToken 

func (x *ListLabelHistoryRequest) GetPageToken() string

func (*ListLabelHistoryRequest) ProtoMessage 

func (*ListLabelHistoryRequest) ProtoMessage()

func (*ListLabelHistoryRequest) ProtoReflect 

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

func (*ListLabelHistoryRequest) Reset 

func (x *ListLabelHistoryRequest) Reset()

func (*ListLabelHistoryRequest) String 

func (x *ListLabelHistoryRequest) String() string

type ListLabelHistoryRequest_Order 

type ListLabelHistoryRequest_Order int32

The list order. 

const (
	ListLabelHistoryRequest_ORDER_UNSPECIFIED ListLabelHistoryRequest_Order = 0
	// Order by association time newest to oldest.
	//
	// The Commits most recently associated with the Label will be listed first.
	ListLabelHistoryRequest_ORDER_DESC ListLabelHistoryRequest_Order = 1
	// Order by association time oldest to newest.
	ListLabelHistoryRequest_ORDER_ASC ListLabelHistoryRequest_Order = 2
)

func (ListLabelHistoryRequest_Order) Descriptor 

func (ListLabelHistoryRequest_Order) Descriptor() protoreflect.EnumDescriptor

func (ListLabelHistoryRequest_Order) Enum 

func (x ListLabelHistoryRequest_Order) Enum() *ListLabelHistoryRequest_Order

func (ListLabelHistoryRequest_Order) EnumDescriptor deprecated 

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

Deprecated: Use ListLabelHistoryRequest_Order.Descriptor instead.

func (ListLabelHistoryRequest_Order) Number 

func (x ListLabelHistoryRequest_Order) Number() protoreflect.EnumNumber

func (ListLabelHistoryRequest_Order) String 

func (x ListLabelHistoryRequest_Order) String() string

func (ListLabelHistoryRequest_Order) Type 

func (ListLabelHistoryRequest_Order) Type() protoreflect.EnumType

type ListLabelHistoryResponse 

type ListLabelHistoryResponse struct {

	// The next page token.
	//
	// / If empty, there are no more pages.
	NextPageToken string `protobuf:"bytes,1,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// The listed Commits that represent the history of the Label.
	Commits []*Commit `protobuf:"bytes,2,rep,name=commits,proto3" json:"commits,omitempty"`
	// contains filtered or unexported fields
}

func (*ListLabelHistoryResponse) Descriptor deprecated 

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

Deprecated: Use ListLabelHistoryResponse.ProtoReflect.Descriptor instead.

func (*ListLabelHistoryResponse) GetCommits 

func (x *ListLabelHistoryResponse) GetCommits() []*Commit

func (*ListLabelHistoryResponse) GetNextPageToken 

func (x *ListLabelHistoryResponse) GetNextPageToken() string

func (*ListLabelHistoryResponse) ProtoMessage 

func (*ListLabelHistoryResponse) ProtoMessage()

func (*ListLabelHistoryResponse) ProtoReflect 

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

func (*ListLabelHistoryResponse) Reset 

func (x *ListLabelHistoryResponse) Reset()

func (*ListLabelHistoryResponse) String 

func (x *ListLabelHistoryResponse) String() string

type ListLabelsRequest 

type ListLabelsRequest struct {

	// The maximum number of items to return.
	//
	// The default value is 10.
	PageSize uint32 `protobuf:"varint,1,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The page to start from.
	//
	// If empty, the first page is returned,
	PageToken string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// The reference to list Labels for.
	//
	// See the documentation on Ref for resource resolution details.
	//
	// Once the resource is resolved, the following Labels are listed:
	//   - If a Module is referenced, all Labels for the Module are returned.
	//   - If a Label is referenced, this Label is returned.
	//   - If a Commit is referenced, all Labels for the Commit are returned.
	ResourceRef *ResourceRef `protobuf:"bytes,3,opt,name=resource_ref,json=resourceRef,proto3" json:"resource_ref,omitempty"`
	// The order to return the Labels.
	//
	// If not specified, defaults to ORDER_CREATE_TIME_ASC.
	//
	// TODO: Do we want ORDER_CREATE_TIME_ASC to be the default?
	// TODO: We are purposefully not making the default the zero enum value, however
	// we may want to consider this.
	Order ListLabelsRequest_Order `protobuf:"varint,4,opt,name=order,proto3,enum=buf.registry.module.v1beta1.ListLabelsRequest_Order" json:"order,omitempty"`
	// contains filtered or unexported fields
}

func (*ListLabelsRequest) Descriptor deprecated 

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

Deprecated: Use ListLabelsRequest.ProtoReflect.Descriptor instead.

func (*ListLabelsRequest) GetOrder 

func (x *ListLabelsRequest) GetOrder() ListLabelsRequest_Order

func (*ListLabelsRequest) GetPageSize 

func (x *ListLabelsRequest) GetPageSize() uint32

func (*ListLabelsRequest) GetPageToken 

func (x *ListLabelsRequest) GetPageToken() string

func (*ListLabelsRequest) GetResourceRef 

func (x *ListLabelsRequest) GetResourceRef() *ResourceRef

func (*ListLabelsRequest) ProtoMessage 

func (*ListLabelsRequest) ProtoMessage()

func (*ListLabelsRequest) ProtoReflect 

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

func (*ListLabelsRequest) Reset 

func (x *ListLabelsRequest) Reset()

func (*ListLabelsRequest) String 

func (x *ListLabelsRequest) String() string

type ListLabelsRequest_Order 

type ListLabelsRequest_Order int32

The list order. 

const (
	ListLabelsRequest_ORDER_UNSPECIFIED ListLabelsRequest_Order = 0
	// Order by create_time oldest to newest.
	ListLabelsRequest_ORDER_CREATE_TIME_ASC ListLabelsRequest_Order = 1
	// Order by create_time newest to oldest.
	ListLabelsRequest_ORDER_CREATE_TIME_DESC ListLabelsRequest_Order = 2
)

func (ListLabelsRequest_Order) Descriptor 

func (ListLabelsRequest_Order) Descriptor() protoreflect.EnumDescriptor

func (ListLabelsRequest_Order) Enum 

func (x ListLabelsRequest_Order) Enum() *ListLabelsRequest_Order

func (ListLabelsRequest_Order) EnumDescriptor deprecated 

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

Deprecated: Use ListLabelsRequest_Order.Descriptor instead.

func (ListLabelsRequest_Order) Number 

func (x ListLabelsRequest_Order) Number() protoreflect.EnumNumber

func (ListLabelsRequest_Order) String 

func (x ListLabelsRequest_Order) String() string

func (ListLabelsRequest_Order) Type 

func (ListLabelsRequest_Order) Type() protoreflect.EnumType

type ListLabelsResponse 

type ListLabelsResponse struct {

	// The next page token.
	//
	// / If empty, there are no more pages.
	NextPageToken string `protobuf:"bytes,1,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// The listed Labels.
	Labels []*Label `protobuf:"bytes,2,rep,name=labels,proto3" json:"labels,omitempty"`
	// contains filtered or unexported fields
}

func (*ListLabelsResponse) Descriptor deprecated 

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

Deprecated: Use ListLabelsResponse.ProtoReflect.Descriptor instead.

func (*ListLabelsResponse) GetLabels 

func (x *ListLabelsResponse) GetLabels() []*Label

func (*ListLabelsResponse) GetNextPageToken 

func (x *ListLabelsResponse) GetNextPageToken() string

func (*ListLabelsResponse) ProtoMessage 

func (*ListLabelsResponse) ProtoMessage()

func (*ListLabelsResponse) ProtoReflect 

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

func (*ListLabelsResponse) Reset 

func (x *ListLabelsResponse) Reset()

func (*ListLabelsResponse) String 

func (x *ListLabelsResponse) String() string

type ListModulesRequest 

type ListModulesRequest struct {

	// The maximum number of items to return.
	//
	// The default value is 10.
	PageSize uint32 `protobuf:"varint,1,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The page to start from.
	//
	// If empty, the first page is returned,
	PageToken string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// The specific Users or Organizations to list Modules for.
	//
	// If empty, all Modules for all owners are listed, but this functionality
	// is limited to Users with the necessary permissions.
	OwnerRefs []*v1beta1.OwnerRef `protobuf:"bytes,3,rep,name=owner_refs,json=ownerRefs,proto3" json:"owner_refs,omitempty"`
	// The order to return the Modules.
	//
	// If not specified, defaults to ORDER_CREATE_TIME_ASC.
	//
	// TODO: Do we want ORDER_CREATE_TIME_ASC to be the default?
	// TODO: We are purposefully not making the default the zero enum value, however
	// we may want to consider this.
	Order ListModulesRequest_Order `protobuf:"varint,4,opt,name=order,proto3,enum=buf.registry.module.v1beta1.ListModulesRequest_Order" json:"order,omitempty"`
	// contains filtered or unexported fields
}

func (*ListModulesRequest) Descriptor deprecated 

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

Deprecated: Use ListModulesRequest.ProtoReflect.Descriptor instead.

func (*ListModulesRequest) GetOrder 

func (x *ListModulesRequest) GetOrder() ListModulesRequest_Order

func (*ListModulesRequest) GetOwnerRefs 

func (x *ListModulesRequest) GetOwnerRefs() []*v1beta1.OwnerRef

func (*ListModulesRequest) GetPageSize 

func (x *ListModulesRequest) GetPageSize() uint32

func (*ListModulesRequest) GetPageToken 

func (x *ListModulesRequest) GetPageToken() string

func (*ListModulesRequest) ProtoMessage 

func (*ListModulesRequest) ProtoMessage()

func (*ListModulesRequest) ProtoReflect 

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

func (*ListModulesRequest) Reset 

func (x *ListModulesRequest) Reset()

func (*ListModulesRequest) String 

func (x *ListModulesRequest) String() string

type ListModulesRequest_Order 

type ListModulesRequest_Order int32

The list order. 

const (
	ListModulesRequest_ORDER_UNSPECIFIED ListModulesRequest_Order = 0
	// Order by create_time oldest to newest.
	ListModulesRequest_ORDER_CREATE_TIME_ASC ListModulesRequest_Order = 1
	// Order by create_time newest to oldest.
	ListModulesRequest_ORDER_CREATE_TIME_DESC ListModulesRequest_Order = 2
)

func (ListModulesRequest_Order) Descriptor 

func (ListModulesRequest_Order) Descriptor() protoreflect.EnumDescriptor

func (ListModulesRequest_Order) Enum 

func (x ListModulesRequest_Order) Enum() *ListModulesRequest_Order

func (ListModulesRequest_Order) EnumDescriptor deprecated 

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

Deprecated: Use ListModulesRequest_Order.Descriptor instead.

func (ListModulesRequest_Order) Number 

func (x ListModulesRequest_Order) Number() protoreflect.EnumNumber

func (ListModulesRequest_Order) String 

func (x ListModulesRequest_Order) String() string

func (ListModulesRequest_Order) Type 

func (ListModulesRequest_Order) Type() protoreflect.EnumType

type ListModulesResponse 

type ListModulesResponse struct {

	// The next page token.
	//
	// / If empty, there are no more pages.
	NextPageToken string `protobuf:"bytes,1,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// The listed Modules.
	Modules []*Module `protobuf:"bytes,2,rep,name=modules,proto3" json:"modules,omitempty"`
	// contains filtered or unexported fields
}

func (*ListModulesResponse) Descriptor deprecated 

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

Deprecated: Use ListModulesResponse.ProtoReflect.Descriptor instead.

func (*ListModulesResponse) GetModules 

func (x *ListModulesResponse) GetModules() []*Module

func (*ListModulesResponse) GetNextPageToken 

func (x *ListModulesResponse) GetNextPageToken() string

func (*ListModulesResponse) ProtoMessage 

func (*ListModulesResponse) ProtoMessage()

func (*ListModulesResponse) ProtoReflect 

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

func (*ListModulesResponse) Reset 

func (x *ListModulesResponse) Reset()

func (*ListModulesResponse) String 

func (x *ListModulesResponse) String() string

type Module 

type Module struct {

	// The id of the Module.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The time the Module was created on the BSR.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// The last time the Module was updated on the BSR.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// The name of the Module.
	//
	// Unique within a given User or Organization.
	Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"`
	// The id of the User or Organization that owns the Module.
	OwnerId string `protobuf:"bytes,5,opt,name=owner_id,json=ownerId,proto3" json:"owner_id,omitempty"`
	// The Module's visibility, either public or private.
	Visibility ModuleVisibility `protobuf:"varint,6,opt,name=visibility,proto3,enum=buf.registry.module.v1beta1.ModuleVisibility" json:"visibility,omitempty"`
	// The Module state, either active or deprecated.
	State ModuleState `protobuf:"varint,7,opt,name=state,proto3,enum=buf.registry.module.v1beta1.ModuleState" json:"state,omitempty"`
	// The configurable description of the Module.
	Description string `protobuf:"bytes,8,opt,name=description,proto3" json:"description,omitempty"`
	// The configurable URL in the description of the Module,
	Url string `protobuf:"bytes,9,opt,name=url,proto3" json:"url,omitempty"`
	// The name of the default label of the Module.
	//
	// This label may not yet exist. When a Module is created, it has no Commits, and Labels
	// must have a Commit, so this Label is not created when a Module is created. Additionally,
	// a User may modify the name of the default Label without this Label yet being created.
	DefaultLabelName string `protobuf:"bytes,10,opt,name=default_label_name,json=defaultLabelName,proto3" json:"default_label_name,omitempty"`
	// contains filtered or unexported fields
}

A module within the BSR.

func (*Module) Descriptor deprecated 

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

Deprecated: Use Module.ProtoReflect.Descriptor instead.

func (*Module) GetCreateTime 

func (x *Module) GetCreateTime() *timestamppb.Timestamp

func (*Module) GetDefaultLabelName 

func (x *Module) GetDefaultLabelName() string

func (*Module) GetDescription 

func (x *Module) GetDescription() string

func (*Module) GetId 

func (x *Module) GetId() string

func (*Module) GetName 

func (x *Module) GetName() string

func (*Module) GetOwnerId 

func (x *Module) GetOwnerId() string

func (*Module) GetState 

func (x *Module) GetState() ModuleState

func (*Module) GetUpdateTime 

func (x *Module) GetUpdateTime() *timestamppb.Timestamp

func (*Module) GetUrl 

func (x *Module) GetUrl() string

func (*Module) GetVisibility 

func (x *Module) GetVisibility() ModuleVisibility

func (*Module) ProtoMessage 

func (*Module) ProtoMessage()

func (*Module) ProtoReflect 

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

func (*Module) Reset 

func (x *Module) Reset()

func (*Module) String 

func (x *Module) String() string

type ModuleRef 

type ModuleRef struct {

	// Types that are assignable to Value:
	//
	//	*ModuleRef_Id
	//	*ModuleRef_Name_
	Value isModuleRef_Value `protobuf_oneof:"value"`
	// contains filtered or unexported fields
}

ModuleRef is a reference to a Module, either an id or a fully-qualified name.

This is used in requests.

func (*ModuleRef) Descriptor deprecated 

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

Deprecated: Use ModuleRef.ProtoReflect.Descriptor instead.

func (*ModuleRef) GetId 

func (x *ModuleRef) GetId() string

func (*ModuleRef) GetName 

func (x *ModuleRef) GetName() *ModuleRef_Name

func (*ModuleRef) GetValue 

func (m *ModuleRef) GetValue() isModuleRef_Value

func (*ModuleRef) ProtoMessage 

func (*ModuleRef) ProtoMessage()

func (*ModuleRef) ProtoReflect 

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

func (*ModuleRef) Reset 

func (x *ModuleRef) Reset()

func (*ModuleRef) String 

func (x *ModuleRef) String() string

type ModuleRef_Id 

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

type ModuleRef_Name 

type ModuleRef_Name struct {

	// The name of the owner of the Module, either a User or Organization.
	Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner,omitempty"`
	// The name of the Module.
	Module string `protobuf:"bytes,2,opt,name=module,proto3" json:"module,omitempty"`
	// contains filtered or unexported fields
}

The fully-qualified name of a Module within a BSR instance.

A Name uniquely identifies a Module. This is used for requests when a caller only has the module name and not the ID.

func (*ModuleRef_Name) Descriptor deprecated 

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

Deprecated: Use ModuleRef_Name.ProtoReflect.Descriptor instead.

func (*ModuleRef_Name) GetModule 

func (x *ModuleRef_Name) GetModule() string

func (*ModuleRef_Name) GetOwner 

func (x *ModuleRef_Name) GetOwner() string

func (*ModuleRef_Name) ProtoMessage 

func (*ModuleRef_Name) ProtoMessage()

func (*ModuleRef_Name) ProtoReflect 

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

func (*ModuleRef_Name) Reset 

func (x *ModuleRef_Name) Reset()

func (*ModuleRef_Name) String 

func (x *ModuleRef_Name) String() string

type ModuleRef_Name_ 

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

type ModuleState 

type ModuleState int32

The state of a Module, currently either active or deprecated. 

const (
	ModuleState_MODULE_STATE_UNSPECIFIED ModuleState = 0
	// MODULE_STATE_ACTIVE says that the Module is currently active.
	ModuleState_MODULE_STATE_ACTIVE ModuleState = 1
	// MODULE_STATE_DEPRECATED says that the Module has been deprecated and should not longer be
	// used.
	ModuleState_MODULE_STATE_DEPRECATED ModuleState = 2
)

func (ModuleState) Descriptor 

func (ModuleState) Descriptor() protoreflect.EnumDescriptor

func (ModuleState) Enum 

func (x ModuleState) Enum() *ModuleState

func (ModuleState) EnumDescriptor deprecated 

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

Deprecated: Use ModuleState.Descriptor instead.

func (ModuleState) Number 

func (x ModuleState) Number() protoreflect.EnumNumber

func (ModuleState) String 

func (x ModuleState) String() string

func (ModuleState) Type 

func (ModuleState) Type() protoreflect.EnumType

type ModuleVisibility 

type ModuleVisibility int32

The visibility of a Module, currently either public or private. 

const (
	ModuleVisibility_MODULE_VISIBILITY_UNSPECIFIED ModuleVisibility = 0
	// MODULE_VISIBILITY_PUBLIC says that the module is publicly availabile.
	ModuleVisibility_MODULE_VISIBILITY_PUBLIC ModuleVisibility = 1
	// MODULE_VISIBILITY_PRIVATE says that the module is private.
	ModuleVisibility_MODULE_VISIBILITY_PRIVATE ModuleVisibility = 2
)

func (ModuleVisibility) Descriptor 

func (ModuleVisibility) Descriptor() protoreflect.EnumDescriptor

func (ModuleVisibility) Enum 

func (x ModuleVisibility) Enum() *ModuleVisibility

func (ModuleVisibility) EnumDescriptor deprecated 

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

Deprecated: Use ModuleVisibility.Descriptor instead.

func (ModuleVisibility) Number 

func (x ModuleVisibility) Number() protoreflect.EnumNumber

func (ModuleVisibility) String 

func (x ModuleVisibility) String() string

func (ModuleVisibility) Type 

func (ModuleVisibility) Type() protoreflect.EnumType

type ResourceRef 

type ResourceRef struct {

	// Types that are assignable to Value:
	//
	//	*ResourceRef_Id
	//	*ResourceRef_Name_
	Value isResourceRef_Value `protobuf_oneof:"value"`
	// 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.

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) 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.
  • 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 ScopedLabelRef 

type ScopedLabelRef struct {

	// Types that are assignable to Value:
	//
	//	*ScopedLabelRef_Id
	//	*ScopedLabelRef_Name
	Value isScopedLabelRef_Value `protobuf_oneof:"value"`
	// contains filtered or unexported fields
}

A reference to a Label scoped to a Module, either an id or a name.

This is used in requests.

func (*ScopedLabelRef) Descriptor deprecated 

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

Deprecated: Use ScopedLabelRef.ProtoReflect.Descriptor instead.

func (*ScopedLabelRef) GetId 

func (x *ScopedLabelRef) GetId() string

func (*ScopedLabelRef) GetName 

func (x *ScopedLabelRef) GetName() string

func (*ScopedLabelRef) GetValue 

func (m *ScopedLabelRef) GetValue() isScopedLabelRef_Value

func (*ScopedLabelRef) ProtoMessage 

func (*ScopedLabelRef) ProtoMessage()

func (*ScopedLabelRef) ProtoReflect 

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

func (*ScopedLabelRef) Reset 

func (x *ScopedLabelRef) Reset()

func (*ScopedLabelRef) String 

func (x *ScopedLabelRef) String() string

type ScopedLabelRef_Id 

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

type ScopedLabelRef_Name 

type ScopedLabelRef_Name struct {
	// The name of the Label.
	Name string `protobuf:"bytes,2,opt,name=name,proto3,oneof"`
}

type UpdateModulesRequest 

type UpdateModulesRequest struct {

	// The Modules to update.
	Values []*UpdateModulesRequest_Value `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateModulesRequest) Descriptor deprecated 

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

Deprecated: Use UpdateModulesRequest.ProtoReflect.Descriptor instead.

func (*UpdateModulesRequest) GetValues 

func (x *UpdateModulesRequest) GetValues() []*UpdateModulesRequest_Value

func (*UpdateModulesRequest) ProtoMessage 

func (*UpdateModulesRequest) ProtoMessage()

func (*UpdateModulesRequest) ProtoReflect 

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

func (*UpdateModulesRequest) Reset 

func (x *UpdateModulesRequest) Reset()

func (*UpdateModulesRequest) String 

func (x *UpdateModulesRequest) String() string

type UpdateModulesRequest_Value 

type UpdateModulesRequest_Value struct {

	// The Module to update.
	ModuleRef *ModuleRef `protobuf:"bytes,1,opt,name=module_ref,json=moduleRef,proto3" json:"module_ref,omitempty"`
	// The module's visibility.
	Visibility *ModuleVisibility `` /* 130-byte string literal not displayed */
	// The deprecation status of the module.
	State *ModuleState `protobuf:"varint,4,opt,name=state,proto3,enum=buf.registry.module.v1beta1.ModuleState,oneof" json:"state,omitempty"`
	// The configurable description of the module.
	Description *string `protobuf:"bytes,5,opt,name=description,proto3,oneof" json:"description,omitempty"`
	// The configurable URL in the description of the module.
	Url *string `protobuf:"bytes,6,opt,name=url,proto3,oneof" json:"url,omitempty"`
	// The name of the default label of the Module.
	//
	// This label may not yet exist.
	DefaultLabelName *string `protobuf:"bytes,7,opt,name=default_label_name,json=defaultLabelName,proto3,oneof" json:"default_label_name,omitempty"`
	// contains filtered or unexported fields
}

An individual request to update a Module.

func (*UpdateModulesRequest_Value) Descriptor deprecated 

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

Deprecated: Use UpdateModulesRequest_Value.ProtoReflect.Descriptor instead.

func (*UpdateModulesRequest_Value) GetDefaultLabelName 

func (x *UpdateModulesRequest_Value) GetDefaultLabelName() string

func (*UpdateModulesRequest_Value) GetDescription 

func (x *UpdateModulesRequest_Value) GetDescription() string

func (*UpdateModulesRequest_Value) GetModuleRef 

func (x *UpdateModulesRequest_Value) GetModuleRef() *ModuleRef

func (*UpdateModulesRequest_Value) GetState 

func (x *UpdateModulesRequest_Value) GetState() ModuleState

func (*UpdateModulesRequest_Value) GetUrl 

func (x *UpdateModulesRequest_Value) GetUrl() string

func (*UpdateModulesRequest_Value) GetVisibility 

func (x *UpdateModulesRequest_Value) GetVisibility() ModuleVisibility

func (*UpdateModulesRequest_Value) ProtoMessage 

func (*UpdateModulesRequest_Value) ProtoMessage()

func (*UpdateModulesRequest_Value) ProtoReflect 

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

func (*UpdateModulesRequest_Value) Reset 

func (x *UpdateModulesRequest_Value) Reset()

func (*UpdateModulesRequest_Value) String 

func (x *UpdateModulesRequest_Value) String() string

type UpdateModulesResponse 

type UpdateModulesResponse struct {

	// The updated Modules in the same order as given on the request.
	Modules []*Module `protobuf:"bytes,1,rep,name=modules,proto3" json:"modules,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateModulesResponse) Descriptor deprecated 

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

Deprecated: Use UpdateModulesResponse.ProtoReflect.Descriptor instead.

func (*UpdateModulesResponse) GetModules 

func (x *UpdateModulesResponse) GetModules() []*Module

func (*UpdateModulesResponse) ProtoMessage 

func (*UpdateModulesResponse) ProtoMessage()

func (*UpdateModulesResponse) ProtoReflect 

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

func (*UpdateModulesResponse) Reset 

func (x *UpdateModulesResponse) Reset()

func (*UpdateModulesResponse) String 

func (x *UpdateModulesResponse) String() string

type UploadRequest 

type UploadRequest struct {

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

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) GetReferences 

func (x *UploadRequest) GetReferences() []*UploadRequest_Reference

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 content.
	ModuleRef *ModuleRef `protobuf:"bytes,1,opt,name=module_ref,json=moduleRef,proto3" json:"module_ref,omitempty"`
	// The Files of the content.
	//
	// This will consist of the .proto files, license files, and documentation files.
	Files []*File `protobuf:"bytes,2,rep,name=files,proto3" json:"files,omitempty"`
	// contains filtered or unexported fields
}

A set of content 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) GetFiles 

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

func (*UploadRequest_Content) GetModuleRef 

func (x *UploadRequest_Content) GetModuleRef() *ModuleRef

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_Reference 

type UploadRequest_Reference struct {

	// The Module of the reference.
	ModuleRef *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.
	//
	// Note that if a dependency should have Commits created for it, it should be specified
	// as a Reference in the references list, and have associated Content. In this case, only
	// the module component of the ResourceRef should be specified, and specifying any other
	// part of the ResourceRef will result in an error.
	//
	// See the documentation on ResourceRef for resource resolution details.
	//
	// Resolution is as follows:
	//   - If a Module is referenced, the Commit of the default Label is used.
	//   - If a Label is referenced, the Commit of this Label is used.
	//   - If a Commit is referenced, this Commit is used.
	DepResourceRefs []*ResourceRef `protobuf:"bytes,2,rep,name=dep_resource_refs,json=depResourceRefs,proto3" json:"dep_resource_refs,omitempty"`
	// The labels to associate with the Commits created by the upload.
	//
	// 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.
	ScopedLabelRefs []*ScopedLabelRef `protobuf:"bytes,3,rep,name=scoped_label_refs,json=scopedLabelRefs,proto3" json:"scoped_label_refs,omitempty"`
	// VCS Commit information.
	VcsCommit *VCSCommit `protobuf:"bytes,4,opt,name=vcs_commit,json=vcsCommit,proto3" json:"vcs_commit,omitempty"`
	// contains filtered or unexported fields
}

A reference to upload content for.

All references must have associated content. TODO: "Reference" isn't the best name. TODO: Merge with Content unless there's a good reason not to.

func (*UploadRequest_Reference) Descriptor deprecated 

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

Deprecated: Use UploadRequest_Reference.ProtoReflect.Descriptor instead.

func (*UploadRequest_Reference) GetDepResourceRefs 

func (x *UploadRequest_Reference) GetDepResourceRefs() []*ResourceRef

func (*UploadRequest_Reference) GetModuleRef 

func (x *UploadRequest_Reference) GetModuleRef() *ModuleRef

func (*UploadRequest_Reference) GetScopedLabelRefs 

func (x *UploadRequest_Reference) GetScopedLabelRefs() []*ScopedLabelRef

func (*UploadRequest_Reference) GetVcsCommit 

func (x *UploadRequest_Reference) GetVcsCommit() *VCSCommit

func (*UploadRequest_Reference) ProtoMessage 

func (*UploadRequest_Reference) ProtoMessage()

func (*UploadRequest_Reference) ProtoReflect 

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

func (*UploadRequest_Reference) Reset 

func (x *UploadRequest_Reference) Reset()

func (*UploadRequest_Reference) String 

func (x *UploadRequest_Reference) 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 []*Commit `protobuf:"bytes,1,rep,name=commits,proto3" json:"commits,omitempty"`
	// contains filtered or unexported fields
}

func (*UploadResponse) Descriptor deprecated 

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

Deprecated: Use UploadResponse.ProtoReflect.Descriptor instead.

func (*UploadResponse) GetCommits 

func (x *UploadResponse) GetCommits() []*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

type VCSCommit 

type VCSCommit struct {

	// The type of VCS that the Commit originated from.
	Type VCSType `protobuf:"varint,1,opt,name=type,proto3,enum=buf.registry.module.v1beta1.VCSType" json:"type,omitempty"`
	// The VCS hash of the Commit.
	Hash string `protobuf:"bytes,2,opt,name=hash,proto3" json:"hash,omitempty"`
	// The URL of of the commit within the VCS.
	Url string `protobuf:"bytes,3,opt,name=url,proto3" json:"url,omitempty"`
	// contains filtered or unexported fields
}

VCS commit information.

Stored within a Commit, not a resource on its own. Commits <-> VCSCommits are many-to-many, we do not enforce any uniqueness principles here, VCSCommits should just be considered metadata on a given Commit. As such, making them their own entity would result in checks we don't want to enforce. It is still split out into a separate message so that we can enforce required checks on certain fields iff VCSCommit is present.

TODO: Below is the explanation, but it's a little unsatisfying. Perhaps we revisit making VCSCommit an entity?

Multiple BSR commits may have the same content, but different VCS hashes. This costs some storage, but it allows the BSR to more accurately link back to source control. (For example, git commit A introduces a new service, commit B modifies it, and commit C deletes the service and moves the functionality to a different module. We want the BSR commits created from A and C to link back to the correct git commits and PR discussions.)

Multiple BSR commits may have the same VCS hash, but different content. This should only happen when users incorrectly hand-specify the VCS hash — and since commits are immutable and can’t be deleted, we don’t want a manually-created commit to forever block a later, fully-correct commit.

func (*VCSCommit) Descriptor deprecated 

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

Deprecated: Use VCSCommit.ProtoReflect.Descriptor instead.

func (*VCSCommit) GetHash 

func (x *VCSCommit) GetHash() string

func (*VCSCommit) GetType 

func (x *VCSCommit) GetType() VCSType

func (*VCSCommit) GetUrl 

func (x *VCSCommit) GetUrl() string

func (*VCSCommit) ProtoMessage 

func (*VCSCommit) ProtoMessage()

func (*VCSCommit) ProtoReflect 

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

func (*VCSCommit) Reset 

func (x *VCSCommit) Reset()

func (*VCSCommit) String 

func (x *VCSCommit) String() string

type VCSType 

type VCSType int32

The VCS type, currently only git. 

const (
	VCSType_VCS_TYPE_UNSPECIFIED VCSType = 0
	// The git version control system.
	VCSType_VCS_TYPE_GIT VCSType = 1
)

func (VCSType) Descriptor 

func (VCSType) Descriptor() protoreflect.EnumDescriptor

func (VCSType) Enum 

func (x VCSType) Enum() *VCSType

func (VCSType) EnumDescriptor deprecated 

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

Deprecated: Use VCSType.Descriptor instead.

func (VCSType) Number 

func (x VCSType) Number() protoreflect.EnumNumber

func (VCSType) String 

func (x VCSType) String() string

func (VCSType) Type 

func (VCSType) Type() protoreflect.EnumType

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.