parameters

type AuthParameters struct {
	// FixedProjectID is a GCP project ID prefilled in the form. User won't be able to edit it from the form.
	FixedProjectID *string

	// QuotaProjectID is a GCP project ID used as the quota project. This is useful when user wants to use KHI against a project with another project with larger logging read quota.
	QuotaProjectID *string

	// OAuthClientID is the client ID used for getting access tokens via OAuth.
	OAuthClientID *string

	// OAuthClientSecret is the client secret used for getting access tokens via OAuth.
	OAuthClientSecret *string

	// OAuthRedirectURI is the callback URL for OAuth. This must be provided as full qualified URL.
	OAuthRedirectURI *string

	// OAuthRedirectTargetServingPath is the path to serve the callback target.
	OAuthRedirectTargetServingPath *string

	// OAuthStateSuffix is the suffix added to the state parameter in OAuth. The state will be generated in the format of `<random-string><suffix>`.
	OAuthStateSuffix *string

	// AccessToken is the token used for GCP related requests.
	//
	// Deprecated: Passing raw access token string to parameter is deprecated and not recommended. It's recommended to authenticate with Application Default Credentials(ADC).
	AccessToken *string
}

type CommonParameters struct {
	// DataDestinationFolder is the folder path where the final khi file to be stored for serving.
	DataDestinationFolder *string
	// TemporaryFolder is the folder path where be used as a working directory to generate the final khi file.
	TemporaryFolder *string
	// UploadFileStoreFolder is the folder path to store the uploaded log files.
	UploadFileStoreFolder *string
	// Version is the flag to show the version name and exit.
	Version *bool
}

type DebugParameters struct {
	// Profiler decides if KHI uses CloudProfiler or not.
	Profiler *bool
	// ProfilerService is the service name given to CloudProfiler.
	ProfilerService *string
	// ProfilerProject is the GCP project ID where the profiler sends the data to.
	ProfilerProject *string

	// Verbose
	// If this flag is set, KHI prints verbose logs.
	Verbose *bool

	// NoColor
	// If this flag is set, KHI prints logs without color.
	NoColor *bool

	// CloudTrace
	// If this flag is set, KHI sends traces to Cloud Trace.
	CloudTrace *bool
	// CloudTraceProject
	// The GCP project ID where the trace sends the data to.
	CloudTraceProject *string
}

type HelpParameters struct {
	// Help
	// If this parameter is set, KHI exits with printing the usage.
	Help *bool
}

type JobParameters struct {
	// JobMode
	// If this flag is set, KHI run as job mode and doesn't serve as a web server.
	JobMode *bool
	// InspectionType is the inspection type used in the job mode. Inspection types are defined in `inspection-type.go` in multiple directory. Check them for more details.
	InspectionType *string
	// InspectionFeatures is comma separated feature list to query.
	InspectionFeatures *string
	// InspectionValues is the JSON represented parameters.
	InspectionValues *string
	// ExportDestination is the destination file path of KHI file written after the query.
	ExportDestination *string
}

type ParameterStore interface {
	// Prepare initialize settings for reading parameters with `flag` package.
	Prepare() error

	// PostProcess override parsed parameters depending on the other parsed parameters.
	PostProcess() error
}

type ServerParameters struct {
	// ViewerMode limits the KHI feature to query logs with the backend. When it is true, KHI is only serve the frontend to open KHI files.
	ViewerMode *bool
	// Port is the port number where KHI server listens.
	Port *int
	// Host is the host address where KHI server serves.
	Host *string
	// BasePath specifies the base address of API endpoints. This path always ends with `/`.
	BasePath *string
	// FrontendResourceBasePath is another base address only for frontend assets. If this value is not set, this uses the BasePath value by default.
	FrontendResourceBasePath *string
	// FrontendAssetFolder is the root folder of the assets used in frontend including index.html.
	FrontendAssetFolder *string
	// MaxUploadFileSizeInBytes is the maximum limit of uploaded file. Server returns 400 when the request exceeds it.
	MaxUploadFileSizeInBytes *int
}