check

Documentation

Index

• Variables
• type CheckReport
  • func (*CheckReport) Descriptor() ([]byte, []int)
  • func (x *CheckReport) GetCreateTime() *timestamppb.Timestamp
  • func (x *CheckReport) GetError() string
  • func (x *CheckReport) GetId() string
  • func (x *CheckReport) GetKind() string
  • func (x *CheckReport) GetProblems() []*Problem
  • func (*CheckReport) ProtoMessage()
  • func (x *CheckReport) ProtoReflect() protoreflect.Message
  • func (x *CheckReport) Reset()
  • func (x *CheckReport) String() string
• type Problem
  • func (*Problem) Descriptor() ([]byte, []int)
  • func (x *Problem) GetLocation() string
  • func (x *Problem) GetMessage() string
  • func (x *Problem) GetRuleDocUri() string
  • func (x *Problem) GetRuleId() string
  • func (x *Problem) GetSeverity() Problem_Severity
  • func (x *Problem) GetSuggestion() string
  • func (*Problem) ProtoMessage()
  • func (x *Problem) ProtoReflect() protoreflect.Message
  • func (x *Problem) Reset()
  • func (x *Problem) String() string
• type Problem_Severity
  • func (Problem_Severity) Descriptor() protoreflect.EnumDescriptor
  • func (x Problem_Severity) Enum() *Problem_Severity
  • func (Problem_Severity) EnumDescriptor() ([]byte, []int)
  • func (x Problem_Severity) Number() protoreflect.EnumNumber
  • func (x Problem_Severity) String() string
  • func (Problem_Severity) Type() protoreflect.EnumType

Variables

var (
	Problem_Severity_name = map[int32]string{
		0: "SEVERITY_UNSPECIFIED",
		1: "ERROR",
		2: "WARNING",
		3: "INFO",
		4: "HINT",
	}
	Problem_Severity_value = map[string]int32{
		"SEVERITY_UNSPECIFIED": 0,
		"ERROR":                1,
		"WARNING":              2,
		"INFO":                 3,
		"HINT":                 4,
	}
)

Enum value maps for Problem_Severity.

var File_google_cloud_apigeeregistry_v1_check_check_report_proto protoreflect.FileDescriptor

Types

type CheckReport

type CheckReport struct {

	// Identifier of the response.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Artifact kind. May be used in YAML representations to identify the type of
	// this artifact.
	Kind string `protobuf:"bytes,2,opt,name=kind,proto3" json:"kind,omitempty"`
	// Creation timestamp.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// A list of Problems found.
	Problems []*Problem `protobuf:"bytes,4,rep,name=problems,proto3" json:"problems,omitempty"`
	// Populated if check wasn't able to complete due to an error.
	Error string `protobuf:"bytes,5,opt,name=error,proto3" json:"error,omitempty"`
	// contains filtered or unexported fields
}

CheckReport is the results of running the check command.

func (*CheckReport) Descriptor

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

Deprecated: Use CheckReport.ProtoReflect.Descriptor instead.

func (*CheckReport) GetCreateTime

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

func (*CheckReport) GetError

func (x *CheckReport) GetError() string

func (*CheckReport) GetId

func (x *CheckReport) GetId() string

func (*CheckReport) GetKind

func (x *CheckReport) GetKind() string

func (*CheckReport) GetProblems

func (x *CheckReport) GetProblems() []*Problem

func (*CheckReport) ProtoMessage

func (*CheckReport) ProtoMessage()

func (*CheckReport) ProtoReflect

func (x *CheckReport) ProtoReflect() protoreflect.Message

func (*CheckReport) Reset

func (x *CheckReport) Reset()

func (*CheckReport) String

func (x *CheckReport) String() string

type Problem

type Problem struct {

	// Message provides a short description of the problem.
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// Suggestion provides a suggested fix, if applicable.
	Suggestion string `protobuf:"bytes,3,opt,name=suggestion,proto3" json:"suggestion,omitempty"`
	// Location provides the location of the problem.
	// If for a Resource, it is the Resource name.
	// If for a field, this is the Resource name + "::" + field name.
	Location string `protobuf:"bytes,4,opt,name=location,proto3" json:"location,omitempty"`
	// RuleId provides the ID of the rule that this problem belongs to.
	RuleId string `protobuf:"bytes,5,opt,name=rule_id,json=ruleId,proto3" json:"rule_id,omitempty"`
	// RuleDocUri provides a uri to the documented explaination of this rule.
	RuleDocUri string `protobuf:"bytes,6,opt,name=rule_doc_uri,json=ruleDocUri,proto3" json:"rule_doc_uri,omitempty"`
	// Severity provides information on the criticality of the Problem.
	Severity Problem_Severity `` /* 129-byte string literal not displayed */
	// contains filtered or unexported fields
}

Problem is a result of a rule check.

func (*Problem) Descriptor

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

Deprecated: Use Problem.ProtoReflect.Descriptor instead.

func (*Problem) GetLocation

func (x *Problem) GetLocation() string

func (*Problem) GetMessage

func (x *Problem) GetMessage() string

func (*Problem) GetRuleDocUri

func (x *Problem) GetRuleDocUri() string

func (*Problem) GetRuleId

func (x *Problem) GetRuleId() string

func (*Problem) GetSeverity

func (x *Problem) GetSeverity() Problem_Severity

func (*Problem) GetSuggestion

func (x *Problem) GetSuggestion() string

func (*Problem) ProtoMessage

func (*Problem) ProtoMessage()

func (*Problem) ProtoReflect

func (x *Problem) ProtoReflect() protoreflect.Message

func (*Problem) Reset

func (x *Problem) Reset()

func (*Problem) String

func (x *Problem) String() string

type Problem_Severity

type Problem_Severity int32

Possible severities for the violation of a rule.

const (
	// The default value, unused.
	Problem_SEVERITY_UNSPECIFIED Problem_Severity = 0
	// Violation of the rule is an error that must be fixed.
	Problem_ERROR Problem_Severity = 1
	// Violation of the rule is a pattern that is wrong,
	// and should be warned about.
	Problem_WARNING Problem_Severity = 2
	// Violation of the rule is not necessarily a bad pattern
	// or error, but information the user should be aware of.
	Problem_INFO Problem_Severity = 3
	// Violation of the rule is a hint that is provided to
	// the user to fix their spec's design.
	Problem_HINT Problem_Severity = 4
)

func (Problem_Severity) Descriptor

func (Problem_Severity) Descriptor() protoreflect.EnumDescriptor

func (Problem_Severity) Enum

func (x Problem_Severity) Enum() *Problem_Severity

func (Problem_Severity) EnumDescriptor

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

Deprecated: Use Problem_Severity.Descriptor instead.

func (Problem_Severity) Number

func (x Problem_Severity) Number() protoreflect.EnumNumber

func (Problem_Severity) String

func (x Problem_Severity) String() string

func (Problem_Severity) Type

func (Problem_Severity) Type() protoreflect.EnumType