Documentation ¶
Index ¶
- Variables
- type CreateProjectRequest
- func (*CreateProjectRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CreateProjectRequest) GetOrgId() string
- func (x *CreateProjectRequest) GetProject() *Project
- func (*CreateProjectRequest) ProtoMessage()
- func (x *CreateProjectRequest) ProtoReflect() protoreflect.Message
- func (x *CreateProjectRequest) Reset()
- func (x *CreateProjectRequest) String() string
- type CreateProjectResponse
- func (*CreateProjectResponse) Descriptor() ([]byte, []int)deprecated
- func (x *CreateProjectResponse) GetProject() *Project
- func (*CreateProjectResponse) ProtoMessage()
- func (x *CreateProjectResponse) ProtoReflect() protoreflect.Message
- func (x *CreateProjectResponse) Reset()
- func (x *CreateProjectResponse) String() string
- type DeleteProjectRequest
- func (*DeleteProjectRequest) Descriptor() ([]byte, []int)deprecated
- func (x *DeleteProjectRequest) GetProjectId() string
- func (*DeleteProjectRequest) ProtoMessage()
- func (x *DeleteProjectRequest) ProtoReflect() protoreflect.Message
- func (x *DeleteProjectRequest) Reset()
- func (x *DeleteProjectRequest) String() string
- type DeleteProjectResponse
- type GetProjectRequest
- type GetProjectResponse
- func (*GetProjectResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetProjectResponse) GetProject() *Project
- func (*GetProjectResponse) ProtoMessage()
- func (x *GetProjectResponse) ProtoReflect() protoreflect.Message
- func (x *GetProjectResponse) Reset()
- func (x *GetProjectResponse) String() string
- type ListProjectsRequest
- func (*ListProjectsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ListProjectsRequest) GetOrgId() string
- func (x *ListProjectsRequest) GetPageSize() int32
- func (x *ListProjectsRequest) GetPageToken() string
- func (*ListProjectsRequest) ProtoMessage()
- func (x *ListProjectsRequest) ProtoReflect() protoreflect.Message
- func (x *ListProjectsRequest) Reset()
- func (x *ListProjectsRequest) String() string
- type ListProjectsResponse
- func (*ListProjectsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListProjectsResponse) GetNextPageToken() string
- func (x *ListProjectsResponse) GetProjects() []*Project
- func (*ListProjectsResponse) ProtoMessage()
- func (x *ListProjectsResponse) ProtoReflect() protoreflect.Message
- func (x *ListProjectsResponse) Reset()
- func (x *ListProjectsResponse) String() string
- type PatchProjectRequest
- func (*PatchProjectRequest) Descriptor() ([]byte, []int)deprecated
- func (x *PatchProjectRequest) GetPatchMask() *fieldmaskpb.FieldMask
- func (x *PatchProjectRequest) GetProject() *Project
- func (*PatchProjectRequest) ProtoMessage()
- func (x *PatchProjectRequest) ProtoReflect() protoreflect.Message
- func (x *PatchProjectRequest) Reset()
- func (x *PatchProjectRequest) String() string
- type PatchProjectResponse
- func (*PatchProjectResponse) Descriptor() ([]byte, []int)deprecated
- func (x *PatchProjectResponse) GetProject() *Project
- func (*PatchProjectResponse) ProtoMessage()
- func (x *PatchProjectResponse) ProtoReflect() protoreflect.Message
- func (x *PatchProjectResponse) Reset()
- func (x *PatchProjectResponse) String() string
- type Project
- func (*Project) Descriptor() ([]byte, []int)deprecated
- func (x *Project) GetDirectory() string
- func (x *Project) GetId() string
- func (x *Project) GetName() string
- func (x *Project) GetRepo() string
- func (*Project) ProtoMessage()
- func (x *Project) ProtoReflect() protoreflect.Message
- func (x *Project) Reset()
- func (x *Project) String() string
- type SearchProjectsRequest
- type SearchProjectsResponse
- type UpdateProjectRequest
- func (*UpdateProjectRequest) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateProjectRequest) GetProject() *Project
- func (*UpdateProjectRequest) ProtoMessage()
- func (x *UpdateProjectRequest) ProtoReflect() protoreflect.Message
- func (x *UpdateProjectRequest) Reset()
- func (x *UpdateProjectRequest) String() string
- type UpdateProjectResponse
- func (*UpdateProjectResponse) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateProjectResponse) GetProject() *Project
- func (*UpdateProjectResponse) ProtoMessage()
- func (x *UpdateProjectResponse) ProtoReflect() protoreflect.Message
- func (x *UpdateProjectResponse) Reset()
- func (x *UpdateProjectResponse) String() string
Constants ¶
This section is empty.
Variables ¶
var File_priv_projects_v1alpha1_projects_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type CreateProjectRequest ¶
type CreateProjectRequest struct { // The id of the organization under which to create the project. OrgId string `protobuf:"bytes,1,opt,name=org_id,json=orgId,proto3" json:"org_id,omitempty"` // The project object that you want to create. ID must be left empty since it will // be assigned by there server. Project *Project `protobuf:"bytes,2,opt,name=project,proto3" json:"project,omitempty"` // contains filtered or unexported fields }
func (*CreateProjectRequest) Descriptor
deprecated
func (*CreateProjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateProjectRequest.ProtoReflect.Descriptor instead.
func (*CreateProjectRequest) GetOrgId ¶
func (x *CreateProjectRequest) GetOrgId() string
func (*CreateProjectRequest) GetProject ¶
func (x *CreateProjectRequest) GetProject() *Project
func (*CreateProjectRequest) ProtoMessage ¶
func (*CreateProjectRequest) ProtoMessage()
func (*CreateProjectRequest) ProtoReflect ¶
func (x *CreateProjectRequest) ProtoReflect() protoreflect.Message
func (*CreateProjectRequest) Reset ¶
func (x *CreateProjectRequest) Reset()
func (*CreateProjectRequest) String ¶
func (x *CreateProjectRequest) String() string
type CreateProjectResponse ¶
type CreateProjectResponse struct { // The created project object. Project *Project `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` // contains filtered or unexported fields }
func (*CreateProjectResponse) Descriptor
deprecated
func (*CreateProjectResponse) Descriptor() ([]byte, []int)
Deprecated: Use CreateProjectResponse.ProtoReflect.Descriptor instead.
func (*CreateProjectResponse) GetProject ¶
func (x *CreateProjectResponse) GetProject() *Project
func (*CreateProjectResponse) ProtoMessage ¶
func (*CreateProjectResponse) ProtoMessage()
func (*CreateProjectResponse) ProtoReflect ¶
func (x *CreateProjectResponse) ProtoReflect() protoreflect.Message
func (*CreateProjectResponse) Reset ¶
func (x *CreateProjectResponse) Reset()
func (*CreateProjectResponse) String ¶
func (x *CreateProjectResponse) String() string
type DeleteProjectRequest ¶
type DeleteProjectRequest struct { // The unique id of the project you want to delete ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"` // contains filtered or unexported fields }
func (*DeleteProjectRequest) Descriptor
deprecated
func (*DeleteProjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteProjectRequest.ProtoReflect.Descriptor instead.
func (*DeleteProjectRequest) GetProjectId ¶
func (x *DeleteProjectRequest) GetProjectId() string
func (*DeleteProjectRequest) ProtoMessage ¶
func (*DeleteProjectRequest) ProtoMessage()
func (*DeleteProjectRequest) ProtoReflect ¶
func (x *DeleteProjectRequest) ProtoReflect() protoreflect.Message
func (*DeleteProjectRequest) Reset ¶
func (x *DeleteProjectRequest) Reset()
func (*DeleteProjectRequest) String ¶
func (x *DeleteProjectRequest) String() string
type DeleteProjectResponse ¶
type DeleteProjectResponse struct {
// contains filtered or unexported fields
}
func (*DeleteProjectResponse) Descriptor
deprecated
func (*DeleteProjectResponse) Descriptor() ([]byte, []int)
Deprecated: Use DeleteProjectResponse.ProtoReflect.Descriptor instead.
func (*DeleteProjectResponse) ProtoMessage ¶
func (*DeleteProjectResponse) ProtoMessage()
func (*DeleteProjectResponse) ProtoReflect ¶
func (x *DeleteProjectResponse) ProtoReflect() protoreflect.Message
func (*DeleteProjectResponse) Reset ¶
func (x *DeleteProjectResponse) Reset()
func (*DeleteProjectResponse) String ¶
func (x *DeleteProjectResponse) String() string
type GetProjectRequest ¶
type GetProjectRequest struct { // The unique id used to identify the project. It's the same id returned by a // project creation request or a project list request. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // contains filtered or unexported fields }
func (*GetProjectRequest) Descriptor
deprecated
func (*GetProjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetProjectRequest.ProtoReflect.Descriptor instead.
func (*GetProjectRequest) GetId ¶
func (x *GetProjectRequest) GetId() string
func (*GetProjectRequest) ProtoMessage ¶
func (*GetProjectRequest) ProtoMessage()
func (*GetProjectRequest) ProtoReflect ¶
func (x *GetProjectRequest) ProtoReflect() protoreflect.Message
func (*GetProjectRequest) Reset ¶
func (x *GetProjectRequest) Reset()
func (*GetProjectRequest) String ¶
func (x *GetProjectRequest) String() string
type GetProjectResponse ¶
type GetProjectResponse struct { // The requested project object. Project *Project `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` // contains filtered or unexported fields }
func (*GetProjectResponse) Descriptor
deprecated
func (*GetProjectResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetProjectResponse.ProtoReflect.Descriptor instead.
func (*GetProjectResponse) GetProject ¶
func (x *GetProjectResponse) GetProject() *Project
func (*GetProjectResponse) ProtoMessage ¶
func (*GetProjectResponse) ProtoMessage()
func (*GetProjectResponse) ProtoReflect ¶
func (x *GetProjectResponse) ProtoReflect() protoreflect.Message
func (*GetProjectResponse) Reset ¶
func (x *GetProjectResponse) Reset()
func (*GetProjectResponse) String ¶
func (x *GetProjectResponse) String() string
type ListProjectsRequest ¶
type ListProjectsRequest struct { // The id of the organization under which you want to list projects. OrgId string `protobuf:"bytes,1,opt,name=org_id,json=orgId,proto3" json:"org_id,omitempty"` // The maximum number of objects returned in a response. This number can range // between 1 and 100, and it defaults to 10. PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"` // A cursor for use in pagination. PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"` // contains filtered or unexported fields }
func (*ListProjectsRequest) Descriptor
deprecated
func (*ListProjectsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListProjectsRequest.ProtoReflect.Descriptor instead.
func (*ListProjectsRequest) GetOrgId ¶
func (x *ListProjectsRequest) GetOrgId() string
func (*ListProjectsRequest) GetPageSize ¶
func (x *ListProjectsRequest) GetPageSize() int32
func (*ListProjectsRequest) GetPageToken ¶
func (x *ListProjectsRequest) GetPageToken() string
func (*ListProjectsRequest) ProtoMessage ¶
func (*ListProjectsRequest) ProtoMessage()
func (*ListProjectsRequest) ProtoReflect ¶
func (x *ListProjectsRequest) ProtoReflect() protoreflect.Message
func (*ListProjectsRequest) Reset ¶
func (x *ListProjectsRequest) Reset()
func (*ListProjectsRequest) String ¶
func (x *ListProjectsRequest) String() string
type ListProjectsResponse ¶
type ListProjectsResponse struct { // A list containing the retrieved project objects. The list can be empty. Projects []*Project `protobuf:"bytes,1,rep,name=projects,proto3" json:"projects,omitempty"` // A cursor to fetch the next page. NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"` // contains filtered or unexported fields }
func (*ListProjectsResponse) Descriptor
deprecated
func (*ListProjectsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListProjectsResponse.ProtoReflect.Descriptor instead.
func (*ListProjectsResponse) GetNextPageToken ¶
func (x *ListProjectsResponse) GetNextPageToken() string
func (*ListProjectsResponse) GetProjects ¶
func (x *ListProjectsResponse) GetProjects() []*Project
func (*ListProjectsResponse) ProtoMessage ¶
func (*ListProjectsResponse) ProtoMessage()
func (*ListProjectsResponse) ProtoReflect ¶
func (x *ListProjectsResponse) ProtoReflect() protoreflect.Message
func (*ListProjectsResponse) Reset ¶
func (x *ListProjectsResponse) Reset()
func (*ListProjectsResponse) String ¶
func (x *ListProjectsResponse) String() string
type PatchProjectRequest ¶
type PatchProjectRequest struct { // The project object you want to patch. Project *Project `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` // A field mask containing the list of fields you would like to update. // Only the fields listed in this field mask will be modified. PatchMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=patch_mask,json=patchMask,proto3" json:"patch_mask,omitempty"` // contains filtered or unexported fields }
func (*PatchProjectRequest) Descriptor
deprecated
func (*PatchProjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use PatchProjectRequest.ProtoReflect.Descriptor instead.
func (*PatchProjectRequest) GetPatchMask ¶
func (x *PatchProjectRequest) GetPatchMask() *fieldmaskpb.FieldMask
func (*PatchProjectRequest) GetProject ¶
func (x *PatchProjectRequest) GetProject() *Project
func (*PatchProjectRequest) ProtoMessage ¶
func (*PatchProjectRequest) ProtoMessage()
func (*PatchProjectRequest) ProtoReflect ¶
func (x *PatchProjectRequest) ProtoReflect() protoreflect.Message
func (*PatchProjectRequest) Reset ¶
func (x *PatchProjectRequest) Reset()
func (*PatchProjectRequest) String ¶
func (x *PatchProjectRequest) String() string
type PatchProjectResponse ¶
type PatchProjectResponse struct { // The updated project object. Project *Project `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` // contains filtered or unexported fields }
func (*PatchProjectResponse) Descriptor
deprecated
func (*PatchProjectResponse) Descriptor() ([]byte, []int)
Deprecated: Use PatchProjectResponse.ProtoReflect.Descriptor instead.
func (*PatchProjectResponse) GetProject ¶
func (x *PatchProjectResponse) GetProject() *Project
func (*PatchProjectResponse) ProtoMessage ¶
func (*PatchProjectResponse) ProtoMessage()
func (*PatchProjectResponse) ProtoReflect ¶
func (x *PatchProjectResponse) ProtoReflect() protoreflect.Message
func (*PatchProjectResponse) Reset ¶
func (x *PatchProjectResponse) Reset()
func (*PatchProjectResponse) String ¶
func (x *PatchProjectResponse) String() string
type Project ¶
type Project struct { // Unique identifier for the ojbect Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // The source control repository where the project's code lives // Usually it's a git repository. Repo string `protobuf:"bytes,3,opt,name=repo,proto3" json:"repo,omitempty"` // TODO: document format of string. Is this <owner>/<repo> (assumes GitHub), or a url? Or either? // The directory within the repository where the project's code lives. It should be a path within // the repo, and if left empty, it defaults to the root of the repo. Directory string `protobuf:"bytes,4,opt,name=directory,proto3" json:"directory,omitempty"` Name string `protobuf:"bytes,5,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
The project object
Projects describe a specific folder in a code repository that you develop on, build and deploy as a unit. For example a backend that exposes your internal API, and a nodejs server that serves your webapp, would each be a project.
In a multi-repo world, each project might live at the root of it's own git repository. In a monorepo world, several projects might be in the same git repository, but have different root directories.
func (*Project) Descriptor
deprecated
func (*Project) GetDirectory ¶
func (*Project) ProtoMessage ¶
func (*Project) ProtoMessage()
func (*Project) ProtoReflect ¶
func (x *Project) ProtoReflect() protoreflect.Message
type SearchProjectsRequest ¶
type SearchProjectsRequest struct {
// contains filtered or unexported fields
}
func (*SearchProjectsRequest) Descriptor
deprecated
func (*SearchProjectsRequest) Descriptor() ([]byte, []int)
Deprecated: Use SearchProjectsRequest.ProtoReflect.Descriptor instead.
func (*SearchProjectsRequest) ProtoMessage ¶
func (*SearchProjectsRequest) ProtoMessage()
func (*SearchProjectsRequest) ProtoReflect ¶
func (x *SearchProjectsRequest) ProtoReflect() protoreflect.Message
func (*SearchProjectsRequest) Reset ¶
func (x *SearchProjectsRequest) Reset()
func (*SearchProjectsRequest) String ¶
func (x *SearchProjectsRequest) String() string
type SearchProjectsResponse ¶
type SearchProjectsResponse struct {
// contains filtered or unexported fields
}
func (*SearchProjectsResponse) Descriptor
deprecated
func (*SearchProjectsResponse) Descriptor() ([]byte, []int)
Deprecated: Use SearchProjectsResponse.ProtoReflect.Descriptor instead.
func (*SearchProjectsResponse) ProtoMessage ¶
func (*SearchProjectsResponse) ProtoMessage()
func (*SearchProjectsResponse) ProtoReflect ¶
func (x *SearchProjectsResponse) ProtoReflect() protoreflect.Message
func (*SearchProjectsResponse) Reset ¶
func (x *SearchProjectsResponse) Reset()
func (*SearchProjectsResponse) String ¶
func (x *SearchProjectsResponse) String() string
type UpdateProjectRequest ¶
type UpdateProjectRequest struct { // The project object you want to update. Project *Project `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` // contains filtered or unexported fields }
func (*UpdateProjectRequest) Descriptor
deprecated
func (*UpdateProjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateProjectRequest.ProtoReflect.Descriptor instead.
func (*UpdateProjectRequest) GetProject ¶
func (x *UpdateProjectRequest) GetProject() *Project
func (*UpdateProjectRequest) ProtoMessage ¶
func (*UpdateProjectRequest) ProtoMessage()
func (*UpdateProjectRequest) ProtoReflect ¶
func (x *UpdateProjectRequest) ProtoReflect() protoreflect.Message
func (*UpdateProjectRequest) Reset ¶
func (x *UpdateProjectRequest) Reset()
func (*UpdateProjectRequest) String ¶
func (x *UpdateProjectRequest) String() string
type UpdateProjectResponse ¶
type UpdateProjectResponse struct { // The updated project object. Project *Project `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` // contains filtered or unexported fields }
func (*UpdateProjectResponse) Descriptor
deprecated
func (*UpdateProjectResponse) Descriptor() ([]byte, []int)
Deprecated: Use UpdateProjectResponse.ProtoReflect.Descriptor instead.
func (*UpdateProjectResponse) GetProject ¶
func (x *UpdateProjectResponse) GetProject() *Project
func (*UpdateProjectResponse) ProtoMessage ¶
func (*UpdateProjectResponse) ProtoMessage()
func (*UpdateProjectResponse) ProtoReflect ¶
func (x *UpdateProjectResponse) ProtoReflect() protoreflect.Message
func (*UpdateProjectResponse) Reset ¶
func (x *UpdateProjectResponse) Reset()
func (*UpdateProjectResponse) String ¶
func (x *UpdateProjectResponse) String() string