scopechecker

type ScopeCheckRequest struct {

	// The uri to validate.
	// The type QueuedUri includes all the context needed to do scope check
	QueuedUri *frontier.QueuedUri `protobuf:"bytes,1,opt,name=queued_uri,json=queuedUri,proto3" json:"queued_uri,omitempty"`
	// Name of script. Used for logging.
	ScopeScriptName string `protobuf:"bytes,2,opt,name=scope_script_name,json=scopeScriptName,proto3" json:"scope_script_name,omitempty"`
	// The Script to evaluate.
	ScopeScript string `protobuf:"bytes,3,opt,name=scope_script,json=scopeScript,proto3" json:"scope_script,omitempty"`
	// Turn on debug messages
	Debug bool `protobuf:"varint,4,opt,name=debug,proto3" json:"debug,omitempty"`
	// contains filtered or unexported fields
}

type ScopeCheckResponse struct {

	// The outcome of the scope evaluation
	Evaluation ScopeCheckResponse_Evaluation `` /* 139-byte string literal not displayed */
	// Heritrix status code indicating reason for exclude.
	// Most relevant reasons are:
	//   - -5 RUNTIME_EXCEPTION           Unexpected runtime exception.
	//   - -7 ILLEGAL_URI                 URI recognized as unsupported or illegal.
	//   - -4000 CHAFF_DETECTION             Chaff detection of traps/content with negligible value applied.
	//   - -4001 TOO_MANY_HOPS               The URI is too many link hops away from the seed.
	//   - -4002 TOO_MANY_TRANSITIVE_HOPS    The URI is too many embed/transitive hops away from the last URI in scope.
	//   - -5001 BLOCKED                     Blocked from fetch by user setting.
	//   - -5002 BLOCKED_BY_CUSTOM_PROCESSOR Blocked by a custom processor.
	ExcludeReason int32 `protobuf:"varint,2,opt,name=exclude_reason,json=excludeReason,proto3" json:"exclude_reason,omitempty"`
	// URI canonicalized for checking against already included list.
	// Examples of canonicalization could be:
	// * Removing well known session id's (e.g. jsessionid) from query parameters.
	// * Canonicalize according to the rules described for Google Safe Browsing (https://developers.google.com/safe-browsing/v4/urls-hashing)
	IncludeCheckUri *commons.ParsedUri `protobuf:"bytes,3,opt,name=include_check_uri,json=includeCheckUri,proto3" json:"include_check_uri,omitempty"`
	// Error is present if script had errors
	Error *commons.Error `protobuf:"bytes,4,opt,name=error,proto3" json:"error,omitempty"`
	// If script outputs anything to the console (e.g. if debug is turned on in the request or script contains print() statements),
	// this field will contain the output
	Console string `protobuf:"bytes,5,opt,name=console,proto3" json:"console,omitempty"`
	// contains filtered or unexported fields
}

type ScopeCheckResponse_Evaluation int32

type ScopesCheckerServiceClient interface {
	// Check if URI is in scope for this crawl
	ScopeCheck(ctx context.Context, in *ScopeCheckRequest, opts ...grpc.CallOption) (*ScopeCheckResponse, error)
}

type ScopesCheckerServiceServer interface {
	// Check if URI is in scope for this crawl
	ScopeCheck(context.Context, *ScopeCheckRequest) (*ScopeCheckResponse, error)
	// contains filtered or unexported methods
}

type UnimplementedScopesCheckerServiceServer struct{}

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