checkself

package

v0.2.0 Latest Latest Go to latest Published: May 9, 2024 License: Apache-2.0 Imports: 21 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/senzing-garage/check-self

Links

Open Source Insights

Documentation ¶

Rendered for

Overview ¶

One or two sentence synopsis of the package...

Overview ¶

One or two paragraph overview of the package... (This page describes the nature of the individual package.)

More information at https://github.com/senzing-garage/check-self

Another Header ¶

Details of the package... Lorem ipsum dolor sit amet, consectetur adipiscing elit...

Examples ¶

The examples given here should be specific to the package.

Examples of use can be seen in the examplepackage_test.go files.

package main
import (
	fmt

	"github.com/senzing-garage/check-self/examplepackage"
)

func main() {
	ctx := context.TODO()
	testObject := &ExamplePackageImpl{
		Something: "I'm here",
	}
	err := testObject.SaySomething(ctx)
	if err != nil {
		fmt.Println("whoops")
	}
}

0.1.4 Created by make-go-github-file.yaml on Wed Jul 26 21:26:54 UTC 2023

Examples ¶

CheckSelfImpl.CheckSelf

Constants ¶

View Source

const DefaultSenzingToolsLicenseDaysLeft = "30"

View Source

const DefaultSenzingToolsLicenseRecordsPercent = "90"

View Source

const ExampleConstant = 1

An example constant.

Variables ¶

View Source

var ExampleVariable = map[int]string{
	1: "Just a string",
}

An example variable.

View Source

var RequiredConfigFiles = []string{
	"cfgVariant.json",
	"defaultGNRCP.config",
}

View Source

var RequiredResourceFiles = []string{
	"templates/g2config.json",
}

View Source

var RequiredSupportFiles = []string{
	"anyTransRule.ibm",
	"g2SifterRules.ibm",
}

Functions ¶

This section is empty.

Types ¶

type CheckSelf ¶

type CheckSelf interface {
	CheckSelf(ctx context.Context) error
}

The ExamplePackage interface is an example interface.

type CheckSelfImpl ¶

type CheckSelfImpl struct {
	ConfigPath                 string
	DatabaseUrl                string
	EngineLogLevel             string // TODO:
	ErrorLicenseDaysLeft       string
	ErrorLicenseRecordsPercent string
	GrpcDialOptions            []grpc.DialOption // TODO:
	GrpcUrl                    string            // TODO:
	InputUrl                   string            // TODO:
	LicenseStringBase64        string            // TODO:
	LogLevel                   string            // TODO:
	ObserverUrl                string            // TODO:
	ResourcePath               string
	SenzingDirectory           string // TODO:
	SenzingInstanceName        string
	SenzingVerboseLogging      int64
	Settings                   string
	SupportPath                string
	// contains filtered or unexported fields
}

CheckSelfImpl is the basic checker.

func (*CheckSelfImpl) Break ¶

func (checkself *CheckSelfImpl) Break(ctx context.Context, reportChecks []string, reportInfo []string, reportErrors []string) ([]string, []string, []string, error)

func (*CheckSelfImpl) CheckConfigPath ¶

func (checkself *CheckSelfImpl) CheckConfigPath(ctx context.Context, reportChecks []string, reportInfo []string, reportErrors []string) ([]string, []string, []string, error)

func (*CheckSelfImpl) CheckDatabaseSchema ¶

func (checkself *CheckSelfImpl) CheckDatabaseSchema(ctx context.Context, reportChecks []string, reportInfo []string, reportErrors []string) ([]string, []string, []string, error)

func (*CheckSelfImpl) CheckDatabaseUrl ¶

func (checkself *CheckSelfImpl) CheckDatabaseUrl(ctx context.Context, reportChecks []string, reportInfo []string, reportErrors []string) ([]string, []string, []string, error)

func (*CheckSelfImpl) CheckEngineConfigurationJson ¶

func (checkself *CheckSelfImpl) CheckEngineConfigurationJson(ctx context.Context, reportChecks []string, reportInfo []string, reportErrors []string) ([]string, []string, []string, error)

func (*CheckSelfImpl) CheckLicense ¶

func (checkself *CheckSelfImpl) CheckLicense(ctx context.Context, reportChecks []string, reportInfo []string, reportErrors []string) ([]string, []string, []string, error)

func (*CheckSelfImpl) CheckResourcePath ¶

func (checkself *CheckSelfImpl) CheckResourcePath(ctx context.Context, reportChecks []string, reportInfo []string, reportErrors []string) ([]string, []string, []string, error)

func (*CheckSelfImpl) CheckSelf ¶

func (checkself *CheckSelfImpl) CheckSelf(ctx context.Context) error

The CheckSelf method prints the output of numerous checks.

Input

ctx: A context to control lifecycle.

Output

Nothing is returned, except for an error. However, something is printed. See the example output.

Example ¶

// For more information, visit https://github.com/senzing-garage/check-self/blob/main/checkself/checkself_examples_test.go
ctx := context.TODO()
examplePackage := &CheckSelfImpl{}
examplePackage.CheckSelf(ctx)

Output:

func (*CheckSelfImpl) CheckSenzingConfiguration ¶

func (checkself *CheckSelfImpl) CheckSenzingConfiguration(ctx context.Context, reportChecks []string, reportInfo []string, reportErrors []string) ([]string, []string, []string, error)

func (*CheckSelfImpl) CheckSupportPath ¶

func (checkself *CheckSelfImpl) CheckSupportPath(ctx context.Context, reportChecks []string, reportInfo []string, reportErrors []string) ([]string, []string, []string, error)

func (*CheckSelfImpl) ListEnvironmentVariables ¶

func (checkself *CheckSelfImpl) ListEnvironmentVariables(ctx context.Context, reportChecks []string, reportInfo []string, reportErrors []string) ([]string, []string, []string, error)

func (*CheckSelfImpl) ListStructVariables ¶

func (checkself *CheckSelfImpl) ListStructVariables(ctx context.Context, reportChecks []string, reportInfo []string, reportErrors []string) ([]string, []string, []string, error)

func (*CheckSelfImpl) Prolog ¶

func (checkself *CheckSelfImpl) Prolog(ctx context.Context, reportChecks []string, reportInfo []string, reportErrors []string) ([]string, []string, []string, error)

type ProductLicenseResponse ¶

type ProductLicenseResponse struct {
	Billing      string `json:"billing"`
	Contract     string `json:"contract"`
	Customer     string `json:"customer"`
	ExpireDate   string `json:"expireDate"`
	IssueDate    string `json:"issueDate"`
	LicenseLevel string `json:"licenseLevel"`
	LicenseType  string `json:"licenseType"`
	RecordLimit  int64  `json:"recordLimit"`
}

Source Files ¶

View all Source files

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