project

package
v0.0.0-...-7cae57c Latest Latest
Warning

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

Go to latest
Published: Jul 18, 2025 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

View Source
const (
	ProjectService_Describe_FullMethodName = "/InternalApi.Project.ProjectService/Describe"
	ProjectService_List_FullMethodName     = "/InternalApi.Project.ProjectService/List"
)

Variables

View Source
var (
	ListRequest_Order_name = map[int32]string{
		0: "BY_NAME_ASC",
		1: "BY_CREATION_TIME_ASC",
	}
	ListRequest_Order_value = map[string]int32{
		"BY_NAME_ASC":          0,
		"BY_CREATION_TIME_ASC": 1,
	}
)

Enum value maps for ListRequest_Order.

View Source
var (
	Project_RunType_name = map[int32]string{
		0: "BRANCHES",
		1: "TAGS",
		2: "PULL_REQUESTS",
		3: "FORKED_PULL_REQUESTS",
	}
	Project_RunType_value = map[string]int32{
		"BRANCHES":             0,
		"TAGS":                 1,
		"PULL_REQUESTS":        2,
		"FORKED_PULL_REQUESTS": 3,
	}
)

Enum value maps for Project_RunType.

View Source
var (
	Project_PermissionType_name = map[int32]string{
		0: "EMPTY",
		1: "DEFAULT_BRANCH",
		2: "NON_DEFAULT_BRANCH",
		3: "PULL_REQUEST",
		4: "FORKED_PULL_REQUEST",
		5: "TAG",
	}
	Project_PermissionType_value = map[string]int32{
		"EMPTY":               0,
		"DEFAULT_BRANCH":      1,
		"NON_DEFAULT_BRANCH":  2,
		"PULL_REQUEST":        3,
		"FORKED_PULL_REQUEST": 4,
		"TAG":                 5,
	}
)

Enum value maps for Project_PermissionType.

View Source
var File_project_proto protoreflect.FileDescriptor
View Source
var ProjectService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "InternalApi.Project.ProjectService",
	HandlerType: (*ProjectServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Describe",
			Handler:    _ProjectService_Describe_Handler,
		},
		{
			MethodName: "List",
			Handler:    _ProjectService_List_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "project.proto",
}

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

Functions

func RegisterProjectServiceServer

func RegisterProjectServiceServer(s grpc.ServiceRegistrar, srv ProjectServiceServer)

Types

type DescribeRequest

type DescribeRequest struct {
	ProjectId            string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	IncludePrivateGitKey bool   `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

Describe call request

  • project_id = [required] UUID of the project.
  • include_private_git_key = [optional] request the private ssh key in the response. default: false

func (*DescribeRequest) Descriptor deprecated

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

Deprecated: Use DescribeRequest.ProtoReflect.Descriptor instead.

func (*DescribeRequest) GetIncludePrivateGitKey

func (x *DescribeRequest) GetIncludePrivateGitKey() bool

func (*DescribeRequest) GetProjectId

func (x *DescribeRequest) GetProjectId() string

func (*DescribeRequest) ProtoMessage

func (*DescribeRequest) ProtoMessage()

func (*DescribeRequest) ProtoReflect

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

func (*DescribeRequest) Reset

func (x *DescribeRequest) Reset()

func (*DescribeRequest) String

func (x *DescribeRequest) String() string

type DescribeResponse

type DescribeResponse struct {
	ResponseStatus *response_status.ResponseStatus `protobuf:"bytes,1,opt,name=response_status,json=responseStatus,proto3" json:"response_status,omitempty"`
	Project        *Project                        `protobuf:"bytes,2,opt,name=project,proto3" json:"project,omitempty"`
	// contains filtered or unexported fields
}

Describe call response

Response: - response_status = [required] Status of the reponse. - project = [required if response status OK]

func (*DescribeResponse) Descriptor deprecated

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

Deprecated: Use DescribeResponse.ProtoReflect.Descriptor instead.

func (*DescribeResponse) GetProject

func (x *DescribeResponse) GetProject() *Project

func (*DescribeResponse) GetResponseStatus

func (x *DescribeResponse) GetResponseStatus() *response_status.ResponseStatus

func (*DescribeResponse) ProtoMessage

func (*DescribeResponse) ProtoMessage()

func (*DescribeResponse) ProtoReflect

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

func (*DescribeResponse) Reset

func (x *DescribeResponse) Reset()

func (*DescribeResponse) String

func (x *DescribeResponse) String() string

type ListRequest

type ListRequest struct {
	OrgId       string               `protobuf:"bytes,2,opt,name=org_id,json=orgId,proto3" json:"org_id,omitempty"`
	CreatedAtGt *timestamp.Timestamp `protobuf:"bytes,3,opt,name=created_at_gt,json=createdAtGt,proto3" json:"created_at_gt,omitempty"`
	Order       ListRequest_Order    `protobuf:"varint,4,opt,name=order,proto3,enum=InternalApi.Project.ListRequest_Order" json:"order,omitempty"`
	PageSize    int32                `protobuf:"varint,5,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	PageToken   string               `protobuf:"bytes,6,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

List call request

- org_id = [optional] If present, the response will include projects form organization. - created_at_gt = [optional] If present, the response will include projects created at after the timestamp - order = [required] Sorting order direction - page_size = [required] Number of orgs in one response - page_token = [required] Token for the page

func (*ListRequest) Descriptor deprecated

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

Deprecated: Use ListRequest.ProtoReflect.Descriptor instead.

func (*ListRequest) GetCreatedAtGt

func (x *ListRequest) GetCreatedAtGt() *timestamp.Timestamp

func (*ListRequest) GetOrder

func (x *ListRequest) GetOrder() ListRequest_Order

func (*ListRequest) GetOrgId

func (x *ListRequest) GetOrgId() string

func (*ListRequest) GetPageSize

func (x *ListRequest) GetPageSize() int32

func (*ListRequest) GetPageToken

func (x *ListRequest) GetPageToken() string

func (*ListRequest) ProtoMessage

func (*ListRequest) ProtoMessage()

func (*ListRequest) ProtoReflect

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

func (*ListRequest) Reset

func (x *ListRequest) Reset()

func (*ListRequest) String

func (x *ListRequest) String() string

type ListRequest_Order

type ListRequest_Order int32
const (
	ListRequest_BY_NAME_ASC          ListRequest_Order = 0
	ListRequest_BY_CREATION_TIME_ASC ListRequest_Order = 1
)

func (ListRequest_Order) Descriptor

func (ListRequest_Order) Enum

func (ListRequest_Order) EnumDescriptor deprecated

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

Deprecated: Use ListRequest_Order.Descriptor instead.

func (ListRequest_Order) Number

func (ListRequest_Order) String

func (x ListRequest_Order) String() string

func (ListRequest_Order) Type

type ListResponse

type ListResponse struct {
	ResponseStatus *response_status.ResponseStatus `protobuf:"bytes,1,opt,name=response_status,json=responseStatus,proto3" json:"response_status,omitempty"`
	Projects       []*Project                      `protobuf:"bytes,2,rep,name=projects,proto3" json:"projects,omitempty"`
	NextPageToken  string                          `protobuf:"bytes,3,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

List call response

Response: - response_status = [required] Status of the reponse. - projects = [required if response status OK] Projects - next_page_token = [required if response status OK] Token for the next page.

func (*ListResponse) Descriptor deprecated

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

Deprecated: Use ListResponse.ProtoReflect.Descriptor instead.

func (*ListResponse) GetNextPageToken

func (x *ListResponse) GetNextPageToken() string

func (*ListResponse) GetProjects

func (x *ListResponse) GetProjects() []*Project

func (*ListResponse) GetResponseStatus

func (x *ListResponse) GetResponseStatus() *response_status.ResponseStatus

func (*ListResponse) ProtoMessage

func (*ListResponse) ProtoMessage()

func (*ListResponse) ProtoReflect

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

func (*ListResponse) Reset

func (x *ListResponse) Reset()

func (*ListResponse) String

func (x *ListResponse) String() string

type Project

type Project struct {
	Id                 string                      `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Name               string                      `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	Slug               string                      `protobuf:"bytes,3,opt,name=slug,proto3" json:"slug,omitempty"`
	Private            bool                        `protobuf:"varint,5,opt,name=private,proto3" json:"private,omitempty"`
	OwnerId            string                      `protobuf:"bytes,6,opt,name=owner_id,json=ownerId,proto3" json:"owner_id,omitempty"`
	CacheId            string                      `protobuf:"bytes,7,opt,name=cache_id,json=cacheId,proto3" json:"cache_id,omitempty"`
	PrivateGitKey      string                      `protobuf:"bytes,8,opt,name=private_git_key,json=privateGitKey,proto3" json:"private_git_key,omitempty"`
	GitUrl             string                      `protobuf:"bytes,9,opt,name=git_url,json=gitUrl,proto3" json:"git_url,omitempty"`
	ArtifactStoreId    string                      `protobuf:"bytes,10,opt,name=artifact_store_id,json=artifactStoreId,proto3" json:"artifact_store_id,omitempty"`
	OrgId              string                      `protobuf:"bytes,11,opt,name=org_id,json=orgId,proto3" json:"org_id,omitempty"`
	CreatedAt          *timestamp.Timestamp        `protobuf:"bytes,12,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	RunOn              []Project_RunType           `` /* 126-byte string literal not displayed */
	ForkedPullRequests *Project_ForkedPullRequests `protobuf:"bytes,14,opt,name=forked_pull_requests,json=forkedPullRequests,proto3" json:"forked_pull_requests,omitempty"`
	Public             bool                        `protobuf:"varint,15,opt,name=public,proto3" json:"public,omitempty"`
	DockerRegistryId   string                      `protobuf:"bytes,16,opt,name=docker_registry_id,json=dockerRegistryId,proto3" json:"docker_registry_id,omitempty"`
	CreatorId          string                      `protobuf:"bytes,17,opt,name=creator_id,json=creatorId,proto3" json:"creator_id,omitempty"`
	RepositoryId       string                      `protobuf:"bytes,18,opt,name=repository_id,json=repositoryId,proto3" json:"repository_id,omitempty"`
	CustomPermissions  bool                        `protobuf:"varint,21,opt,name=custom_permissions,json=customPermissions,proto3" json:"custom_permissions,omitempty"`
	DebugPermissions   []Project_PermissionType    `` /* 166-byte string literal not displayed */
	AttachPermissions  []Project_PermissionType    `` /* 169-byte string literal not displayed */
	// contains filtered or unexported fields
}
  • id = [required] Project UUID.
  • name = [required] Name of the project.
  • slug = [required] Slug of the project.
  • private = [required, deprecated] True if the project if private, false othwrwise
  • public = [required] True if the project if public, false othwrwise
  • owner_id = [required] Owner UUID [uniquely identifies the owner]
  • creator_id = [required] Creator ID - id of the user who created this project
  • cache_id = [required] ID of project's cache on Cachehub.
  • private_git_key = [required if include_private_git_key=true in the request] The private SSH key for checkout out the repository.
  • git_url = [required] The URL to the git repository.
  • artifact_store_id = [required] ID of project's artifact store on Artifacthub.
  • docker_registry_id = [optional] If project has Docker registry, response includes ID of this registry on Registryhub.
  • org_id = [required] ID of organization to witch this projects belongs.
  • created_at = [required] date of creation of project
  • run_on = [required] List of events from repo provider on witch this project is triggered
  • forked_pull_requests = [required] Setting related to Pull Requests from forked repositories
  • repository_id = [required] Repository ID - id of the repository that is connected to the project
  • custom_permissions = [required if restricted organization] True if project do not follow organization defaults for debug/attach permissions.
  • debug_permissions = [required if restricted organization] List of types for witch debug sessions are allowed. Used only if custom_permissions is set to true.
  • attach_permissions = [required if restricted organization] List of types for witch attached sessions are allowed. Used only if custom_permissions is set to true.

func (*Project) Descriptor deprecated

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

Deprecated: Use Project.ProtoReflect.Descriptor instead.

func (*Project) GetArtifactStoreId

func (x *Project) GetArtifactStoreId() string

func (*Project) GetAttachPermissions

func (x *Project) GetAttachPermissions() []Project_PermissionType

func (*Project) GetCacheId

func (x *Project) GetCacheId() string

func (*Project) GetCreatedAt

func (x *Project) GetCreatedAt() *timestamp.Timestamp

func (*Project) GetCreatorId

func (x *Project) GetCreatorId() string

func (*Project) GetCustomPermissions

func (x *Project) GetCustomPermissions() bool

func (*Project) GetDebugPermissions

func (x *Project) GetDebugPermissions() []Project_PermissionType

func (*Project) GetDockerRegistryId

func (x *Project) GetDockerRegistryId() string

func (*Project) GetForkedPullRequests

func (x *Project) GetForkedPullRequests() *Project_ForkedPullRequests

func (*Project) GetGitUrl

func (x *Project) GetGitUrl() string

func (*Project) GetId

func (x *Project) GetId() string

func (*Project) GetName

func (x *Project) GetName() string

func (*Project) GetOrgId

func (x *Project) GetOrgId() string

func (*Project) GetOwnerId

func (x *Project) GetOwnerId() string

func (*Project) GetPrivate

func (x *Project) GetPrivate() bool

func (*Project) GetPrivateGitKey

func (x *Project) GetPrivateGitKey() string

func (*Project) GetPublic

func (x *Project) GetPublic() bool

func (*Project) GetRepositoryId

func (x *Project) GetRepositoryId() string

func (*Project) GetRunOn

func (x *Project) GetRunOn() []Project_RunType

func (*Project) GetSlug

func (x *Project) GetSlug() string

func (*Project) ProtoMessage

func (*Project) ProtoMessage()

func (*Project) ProtoReflect

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

func (*Project) Reset

func (x *Project) Reset()

func (*Project) String

func (x *Project) String() string

type ProjectServiceClient

type ProjectServiceClient interface {
	// Operation is called to describe an existing project.
	// Operation is synchronous.
	Describe(ctx context.Context, in *DescribeRequest, opts ...grpc.CallOption) (*DescribeResponse, error)
	// Operation is called to list organizations for user.
	// Operation is synchronous.
	List(ctx context.Context, in *ListRequest, opts ...grpc.CallOption) (*ListResponse, error)
}

ProjectServiceClient is the client API for ProjectService service.

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

type ProjectServiceServer

type ProjectServiceServer interface {
	// Operation is called to describe an existing project.
	// Operation is synchronous.
	Describe(context.Context, *DescribeRequest) (*DescribeResponse, error)
	// Operation is called to list organizations for user.
	// Operation is synchronous.
	List(context.Context, *ListRequest) (*ListResponse, error)
}

ProjectServiceServer is the server API for ProjectService service. All implementations should embed UnimplementedProjectServiceServer for forward compatibility.

type Project_ForkedPullRequests

type Project_ForkedPullRequests struct {
	AllowedSecrets      []string `protobuf:"bytes,1,rep,name=allowed_secrets,json=allowedSecrets,proto3" json:"allowed_secrets,omitempty"`
	AllowedContributors []string `protobuf:"bytes,2,rep,name=allowed_contributors,json=allowedContributors,proto3" json:"allowed_contributors,omitempty"`
	// contains filtered or unexported fields
}

ForkedPullRequests

Contains options regarding forked Pull Requests

- allowed_secrets = [optional, default = []] list of secrets that can be exported. Empty list means that no secret will be exported. - allowed_contributors = [optional, default = []] list of contributors that can create workflows from forked PRs. Empty list means that everyone can.

func (*Project_ForkedPullRequests) Descriptor deprecated

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

Deprecated: Use Project_ForkedPullRequests.ProtoReflect.Descriptor instead.

func (*Project_ForkedPullRequests) GetAllowedContributors

func (x *Project_ForkedPullRequests) GetAllowedContributors() []string

func (*Project_ForkedPullRequests) GetAllowedSecrets

func (x *Project_ForkedPullRequests) GetAllowedSecrets() []string

func (*Project_ForkedPullRequests) ProtoMessage

func (*Project_ForkedPullRequests) ProtoMessage()

func (*Project_ForkedPullRequests) ProtoReflect

func (*Project_ForkedPullRequests) Reset

func (x *Project_ForkedPullRequests) Reset()

func (*Project_ForkedPullRequests) String

func (x *Project_ForkedPullRequests) String() string

type Project_PermissionType

type Project_PermissionType int32
const (
	Project_EMPTY               Project_PermissionType = 0
	Project_DEFAULT_BRANCH      Project_PermissionType = 1
	Project_NON_DEFAULT_BRANCH  Project_PermissionType = 2
	Project_PULL_REQUEST        Project_PermissionType = 3
	Project_FORKED_PULL_REQUEST Project_PermissionType = 4
	Project_TAG                 Project_PermissionType = 5
)

func (Project_PermissionType) Descriptor

func (Project_PermissionType) Enum

func (Project_PermissionType) EnumDescriptor deprecated

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

Deprecated: Use Project_PermissionType.Descriptor instead.

func (Project_PermissionType) Number

func (Project_PermissionType) String

func (x Project_PermissionType) String() string

func (Project_PermissionType) Type

type Project_RunType

type Project_RunType int32
const (
	Project_BRANCHES             Project_RunType = 0
	Project_TAGS                 Project_RunType = 1
	Project_PULL_REQUESTS        Project_RunType = 2
	Project_FORKED_PULL_REQUESTS Project_RunType = 3
)

func (Project_RunType) Descriptor

func (Project_RunType) Enum

func (x Project_RunType) Enum() *Project_RunType

func (Project_RunType) EnumDescriptor deprecated

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

Deprecated: Use Project_RunType.Descriptor instead.

func (Project_RunType) Number

func (Project_RunType) String

func (x Project_RunType) String() string

func (Project_RunType) Type

type UnimplementedProjectServiceServer

type UnimplementedProjectServiceServer struct{}

UnimplementedProjectServiceServer should be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedProjectServiceServer) Describe

func (UnimplementedProjectServiceServer) List

type UnsafeProjectServiceServer

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

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

Jump to

Keyboard shortcuts

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