projects

package
v0.0.0-...-45e3bc7 Latest Latest
Warning

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

 Go to latest Published: Jun 3, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func WithAssignableUserPageNumber 

func WithAssignableUserPageNumber(n int32) listAssignableUsersOptionFunc

WithAssignableUserPageNumber sets the page number (0-based) for the assignable users listing.

func WithAssignableUserPageSize 

func WithAssignableUserPageSize(size int32) listAssignableUsersOptionFunc

WithAssignableUserPageSize sets the number of results per page for the assignable users listing.

func WithAssignableUserSort 

func WithAssignableUserSort(fields ...string) listAssignableUsersOptionFunc

WithAssignableUserSort sets the sorting criteria for the assignable users listing.

func WithExportFilterLastRun 

func WithExportFilterLastRun(date openapi_types.Date) exportProjectsOptionFunc

WithExportFilterLastRun filters exported projects by last run date.

func WithExportFilterName 

func WithExportFilterName(name string) exportProjectsOptionFunc

WithExportFilterName filters exported projects by exact name.

func WithExportFilterType 

func WithExportFilterType(projectType string) exportProjectsOptionFunc

WithExportFilterType filters exported projects by type (e.g. "INTERNAL").

func WithExportView 

func WithExportView(view string) exportProjectsOptionFunc

WithExportView sets the export format view (e.g. "csv").

func WithProjectInfoInterval 

func WithProjectInfoInterval(interval string) getProjectInfoOptionFunc

WithProjectInfoInterval sets the interval for project info statistics (e.g. "1M", "3M").

func WithProjectName 

func WithProjectName(name string) listProjectsOptionFunc

WithProjectName filters the project list by exact project name.

func WithProjectPageNumber 

func WithProjectPageNumber(n int32) listProjectsOptionFunc

WithProjectPageNumber sets the page number (0-based) for project listing.

func WithProjectPageSize 

func WithProjectPageSize(size int32) listProjectsOptionFunc

WithProjectPageSize sets the number of results per page for project listing.

func WithProjectSort 

func WithProjectSort(fields ...string) listProjectsOptionFunc

WithProjectSort sets the sorting criteria for project listing (e.g. "name,asc").

func WithProjectType 

func WithProjectType(projectType string) listProjectsOptionFunc

WithProjectType filters the project list by project type (e.g. "INTERNAL").

func WithSearchUsernamesPageNumber 

func WithSearchUsernamesPageNumber(n int32) searchUsernamesOptionFunc

WithSearchUsernamesPageNumber sets the page number (0-based) for the username search.

func WithSearchUsernamesPageSize 

func WithSearchUsernamesPageSize(size int32) searchUsernamesOptionFunc

WithSearchUsernamesPageSize sets the number of results per page for the username search.

func WithSearchUsernamesSort 

func WithSearchUsernamesSort(fields ...string) searchUsernamesOptionFunc

WithSearchUsernamesSort sets the sorting criteria for the username search.

func WithUserPageNumber 

func WithUserPageNumber(n int32) listProjectUsersOptionFunc

WithUserPageNumber sets the page number (0-based) for project users listing.

func WithUserPageSize 

func WithUserPageSize(size int32) listProjectUsersOptionFunc

WithUserPageSize sets the number of results per page for project users listing.

func WithUserSort 

func WithUserSort(fields ...string) listProjectUsersOptionFunc

WithUserSort sets the sorting criteria for project users listing.

func WithWidgetInterval 

func WithWidgetInterval(interval string) getWidgetByCodeOptionFunc

WithWidgetInterval sets the interval for the project widget data (e.g. "1M", "3M").

Types

type ExportProjectsOption 

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

ExportProjectsOption configures the filter parameters for exporting projects.

type GetProjectInfoOption 

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

GetProjectInfoOption configures the parameters for getting project info.

type GetWidgetByCodeOption 

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

GetWidgetByCodeOption configures the query parameters for getting a project widget.

type ListAssignableUsersOption 

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

ListAssignableUsersOption configures the filter and pagination parameters for listing assignable users.

type ListProjectUsersOption 

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

ListProjectUsersOption configures the filter and pagination parameters for listing project users.

type ListProjectsOption 

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

ListProjectsOption configures the filter and pagination parameters for listing projects.

type ProjectsScope 

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

ProjectsScope provides operations on projects at the instance level.

func NewProjectsScope 

func NewProjectsScope(s core.Scope) *ProjectsScope

NewProjectsScope constructs a ProjectsScope for wiring from the facade.

func (*ProjectsScope) AddPreference 

func (p *ProjectsScope) AddPreference(
	ctx context.Context,
	projectName string,
	filterID int64,
) (*types.OperationCompletionRS, error)

AddPreference adds a filter to the current user's preferences for the specified project.

func (*ProjectsScope) AssignUsers 

func (p *ProjectsScope) AssignUsers(
	ctx context.Context,
	projectName string,
	request types.AssignUsersRQ,
) (*types.OperationCompletionRS, error)

AssignUsers assigns users to a project with specified roles.

func (*ProjectsScope) Create 

func (p *ProjectsScope) Create(
	ctx context.Context,
	request types.CreateProjectRQ,
) (*types.EntryCreatedRS, error)

Create creates a new project in the Report Portal instance.

func (*ProjectsScope) Delete 

func (p *ProjectsScope) Delete(
	ctx context.Context,
	projectID int64,
) (*types.DeleteBulkRS, error)

Delete deletes a project by its numeric ID.

func (*ProjectsScope) DeleteIndex 

func (p *ProjectsScope) DeleteIndex(
	ctx context.Context,
	projectName string,
) (*types.OperationCompletionRS, error)

DeleteIndex deletes the analyzer index for the specified project.

func (*ProjectsScope) Export 

func (p *ProjectsScope) Export(
	ctx context.Context,
	options ...ExportProjectsOption,
) ([]byte, error)

Export returns a Jasper report of projects as raw bytes.

func (*ProjectsScope) Get 

func (p *ProjectsScope) Get(
	ctx context.Context,
	projectName string,
) (*types.ProjectResource, error)

Get returns the full details of a project by name.

func (*ProjectsScope) GetAnalyzerStatus 

func (p *ProjectsScope) GetAnalyzerStatus(
	ctx context.Context,
) (map[string]bool, error)

GetAnalyzerStatus returns the analyzer indexing status for all projects.

func (*ProjectsScope) GetInfo 

func (p *ProjectsScope) GetInfo(
	ctx context.Context,
	projectName string,
	options ...GetProjectInfoOption,
) (*types.ProjectInfoResource, error)

GetInfo returns aggregated project statistics for the given project.

func (*ProjectsScope) GetPreference 

func (p *ProjectsScope) GetPreference(
	ctx context.Context,
	projectName string,
) (*types.PreferenceResource, error)

GetPreference returns the current user's preference for the specified project.

func (*ProjectsScope) GetWidgetByCode 

func (p *ProjectsScope) GetWidgetByCode(
	ctx context.Context,
	projectName string,
	widgetCode string,
	options ...GetWidgetByCodeOption,
) (map[string]any, error)

GetWidgetByCode returns a preconfigured project widget by its code.

func (*ProjectsScope) IndexData 

func (p *ProjectsScope) IndexData(
	ctx context.Context,
	projectName string,
) (*types.OperationCompletionRS, error)

IndexData triggers re-indexing of the specified project's data.

func (*ProjectsScope) List 

func (p *ProjectsScope) List(
	ctx context.Context,
	options ...ListProjectsOption,
) (*types.PageProjectInfoResource, error)

List returns a paginated list of project info summaries.

func (*ProjectsScope) ListAssignableUsers 

func (p *ProjectsScope) ListAssignableUsers(
	ctx context.Context,
	projectName string,
	options ...ListAssignableUsersOption,
) (*types.PageUserResource, error)

ListAssignableUsers returns a paginated list of users available for assignment to the project.

func (*ProjectsScope) ListNames 

func (p *ProjectsScope) ListNames(ctx context.Context) ([]string, error)

ListNames returns all project names in the Report Portal instance. The underlying endpoint (GetAllProjectNames) may return all projects regardless of the caller's access, depending on deployment configuration.

func (*ProjectsScope) ListUsernames 

func (p *ProjectsScope) ListUsernames(
	ctx context.Context,
	projectName string,
	term string,
) ([]string, error)

ListUsernames returns usernames assigned to a project, filtered by the given term.

func (*ProjectsScope) ListUsers 

func (p *ProjectsScope) ListUsers(
	ctx context.Context,
	projectName string,
	options ...ListProjectUsersOption,
) (*types.PageUserResource, error)

ListUsers returns a paginated list of users assigned to a project.

func (*ProjectsScope) RemovePreference 

func (p *ProjectsScope) RemovePreference(
	ctx context.Context,
	projectName string,
	filterID int64,
) (*types.OperationCompletionRS, error)

RemovePreference removes a filter from the current user's preferences for the specified project.

func (*ProjectsScope) SearchNames 

func (p *ProjectsScope) SearchNames(
	ctx context.Context,
	term string,
) ([]string, error)

SearchNames searches for project names matching the given term.

func (*ProjectsScope) SearchUsernames 

func (p *ProjectsScope) SearchUsernames(
	ctx context.Context,
	projectName string,
	term string,
	options ...SearchUsernamesOption,
) (*types.PageSearchUserResource, error)

SearchUsernames searches for usernames within a project by term.

func (*ProjectsScope) UnassignUsers 

func (p *ProjectsScope) UnassignUsers(
	ctx context.Context,
	projectName string,
	request types.UnassignUsersRQ,
) (*types.OperationCompletionRS, error)

UnassignUsers removes users from a project.

func (*ProjectsScope) Update 

func (p *ProjectsScope) Update(
	ctx context.Context,
	projectName string,
	request types.UpdateProjectRQ,
) (*types.OperationCompletionRS, error)

Update modifies the configuration of an existing project.

func (*ProjectsScope) UpdateNotificationConfig 

func (p *ProjectsScope) UpdateNotificationConfig(
	ctx context.Context,
	projectName string,
	request types.ProjectNotificationConfigDTO,
) (*types.OperationCompletionRS, error)

UpdateNotificationConfig updates the notification configuration for a project.

type SearchUsernamesOption 

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

SearchUsernamesOption configures the pagination parameters for searching usernames.

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.