projectsv1

package
v1.9.11 Latest Latest
Warning

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

Go to latest
Published: Jan 14, 2025 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source
const (
	Projects_ListProjects_FullMethodName  = "/tcnapi.omni.projects.v1.Projects/ListProjects"
	Projects_GetProject_FullMethodName    = "/tcnapi.omni.projects.v1.Projects/GetProject"
	Projects_CreateProject_FullMethodName = "/tcnapi.omni.projects.v1.Projects/CreateProject"
	Projects_UpdateProject_FullMethodName = "/tcnapi.omni.projects.v1.Projects/UpdateProject"
	Projects_DeleteProject_FullMethodName = "/tcnapi.omni.projects.v1.Projects/DeleteProject"
)

Variables

View Source
var (
	Project_State_name = map[int32]string{
		0:     "STATE_UNSPECIFIED",
		17000: "STATE_OPEN",
		17010: "STATE_CLOSED",
	}
	Project_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"STATE_OPEN":        17000,
		"STATE_CLOSED":      17010,
	}
)

Enum value maps for Project_State.

View Source
var File_tcnapi_omni_projects_v1_entities_proto protoreflect.FileDescriptor
View Source
var File_tcnapi_omni_projects_v1_projects_proto protoreflect.FileDescriptor
View Source
var File_tcnapi_omni_projects_v1_service_proto protoreflect.FileDescriptor
View Source
var Projects_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "tcnapi.omni.projects.v1.Projects",
	HandlerType: (*ProjectsServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListProjects",
			Handler:    _Projects_ListProjects_Handler,
		},
		{
			MethodName: "GetProject",
			Handler:    _Projects_GetProject_Handler,
		},
		{
			MethodName: "CreateProject",
			Handler:    _Projects_CreateProject_Handler,
		},
		{
			MethodName: "UpdateProject",
			Handler:    _Projects_UpdateProject_Handler,
		},
		{
			MethodName: "DeleteProject",
			Handler:    _Projects_DeleteProject_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "tcnapi/omni/projects/v1/service.proto",
}

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

Functions

func RegisterProjectsServer

func RegisterProjectsServer(s grpc.ServiceRegistrar, srv ProjectsServer)

Types

type CreateProjectRequest

type CreateProjectRequest struct {

	// the parent of the project
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// the project to be created
	Project *Project `protobuf:"bytes,3,opt,name=project,proto3" json:"project,omitempty"`
	// contains filtered or unexported fields
}

request used to create a project

func (*CreateProjectRequest) Descriptor deprecated

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

Deprecated: Use CreateProjectRequest.ProtoReflect.Descriptor instead.

func (*CreateProjectRequest) GetParent

func (x *CreateProjectRequest) GetParent() 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 DeleteProjectRequest

type DeleteProjectRequest struct {

	// the name of the project
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

request used to delete a project

func (*DeleteProjectRequest) Descriptor deprecated

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

Deprecated: Use DeleteProjectRequest.ProtoReflect.Descriptor instead.

func (*DeleteProjectRequest) GetName

func (x *DeleteProjectRequest) GetName() 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 GetProjectRequest

type GetProjectRequest struct {

	// the name of the project
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

get single project based on name and mask used to getting particular data

func (*GetProjectRequest) Descriptor deprecated

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

Deprecated: Use GetProjectRequest.ProtoReflect.Descriptor instead.

func (*GetProjectRequest) GetName

func (x *GetProjectRequest) GetName() 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 ListProjectsRequest

type ListProjectsRequest struct {

	// the parent of the listed projects
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// returned page
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// used to specify the page token
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// used to specify the filter
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

request used to get a list of projects

func (*ListProjectsRequest) Descriptor deprecated

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

Deprecated: Use ListProjectsRequest.ProtoReflect.Descriptor instead.

func (*ListProjectsRequest) GetFilter added in v1.8.17

func (x *ListProjectsRequest) GetFilter() string

func (*ListProjectsRequest) GetPageSize

func (x *ListProjectsRequest) GetPageSize() int32

func (*ListProjectsRequest) GetPageToken

func (x *ListProjectsRequest) GetPageToken() string

func (*ListProjectsRequest) GetParent

func (x *ListProjectsRequest) GetParent() 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 {

	// the list of projects
	Projects []*Project `protobuf:"bytes,1,rep,name=projects,proto3" json:"projects,omitempty"`
	// the next page token
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

response used listing all projects

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 Project

type Project struct {

	// project identifier
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// project title
	Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
	// project description
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// project state
	State Project_State `protobuf:"varint,4,opt,name=state,proto3,enum=tcnapi.omni.projects.v1.Project_State" json:"state,omitempty"`
	// creation date
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// contains filtered or unexported fields
}

Project -

func (*Project) Descriptor deprecated

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

Deprecated: Use Project.ProtoReflect.Descriptor instead.

func (*Project) GetCreateTime

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

func (*Project) GetDescription

func (x *Project) GetDescription() string

func (*Project) GetName

func (x *Project) GetName() string

func (*Project) GetState

func (x *Project) GetState() Project_State

func (*Project) GetTitle

func (x *Project) GetTitle() 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 Project_State

type Project_State int32

This enum represents the state of a project

const (
	// Project state is Unknown
	Project_STATE_UNSPECIFIED Project_State = 0
	// Project state is Open
	Project_STATE_OPEN Project_State = 17000
	// Project state is Closed
	Project_STATE_CLOSED Project_State = 17010
)

func (Project_State) Descriptor

func (Project_State) Enum

func (x Project_State) Enum() *Project_State

func (Project_State) EnumDescriptor deprecated

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

Deprecated: Use Project_State.Descriptor instead.

func (Project_State) Number

func (Project_State) String

func (x Project_State) String() string

func (Project_State) Type

type ProjectsClient

type ProjectsClient interface {
	// Method to list projects
	ListProjects(ctx context.Context, in *ListProjectsRequest, opts ...grpc.CallOption) (*ListProjectsResponse, error)
	// Method to get a rpoject
	GetProject(ctx context.Context, in *GetProjectRequest, opts ...grpc.CallOption) (*Project, error)
	// Method to create a project
	CreateProject(ctx context.Context, in *CreateProjectRequest, opts ...grpc.CallOption) (*Project, error)
	// Method to update a project
	UpdateProject(ctx context.Context, in *UpdateProjectRequest, opts ...grpc.CallOption) (*Project, error)
	// Method to delete a project
	DeleteProject(ctx context.Context, in *DeleteProjectRequest, opts ...grpc.CallOption) (*Project, error)
}

ProjectsClient is the client API for Projects 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.

Projects service is the public api for the omni/projects service.

func NewProjectsClient

func NewProjectsClient(cc grpc.ClientConnInterface) ProjectsClient

type ProjectsServer

type ProjectsServer interface {
	// Method to list projects
	ListProjects(context.Context, *ListProjectsRequest) (*ListProjectsResponse, error)
	// Method to get a rpoject
	GetProject(context.Context, *GetProjectRequest) (*Project, error)
	// Method to create a project
	CreateProject(context.Context, *CreateProjectRequest) (*Project, error)
	// Method to update a project
	UpdateProject(context.Context, *UpdateProjectRequest) (*Project, error)
	// Method to delete a project
	DeleteProject(context.Context, *DeleteProjectRequest) (*Project, error)
	// contains filtered or unexported methods
}

ProjectsServer is the server API for Projects service. All implementations must embed UnimplementedProjectsServer for forward compatibility.

Projects service is the public api for the omni/projects service.

type UnimplementedProjectsServer

type UnimplementedProjectsServer struct{}

UnimplementedProjectsServer must 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 (UnimplementedProjectsServer) CreateProject

func (UnimplementedProjectsServer) DeleteProject

func (UnimplementedProjectsServer) GetProject

func (UnimplementedProjectsServer) ListProjects

func (UnimplementedProjectsServer) UpdateProject

type UnsafeProjectsServer

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

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

type UpdateProjectRequest

type UpdateProjectRequest struct {

	// the project to be updated
	Project *Project `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// the update mask
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

request used to update a project

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

func (x *UpdateProjectRequest) GetUpdateMask() *fieldmaskpb.FieldMask

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

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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