topologyv1

package
v0.0.0-...-89c8abe Latest Latest
Warning

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

Go to latest
Published: Apr 17, 2024 License: Apache-2.0 Imports: 32 Imported by: 0

Documentation

Overview

Package topologyv1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source
const (
	TopologyAPI_GetTopology_FullMethodName = "/clutch.topology.v1.TopologyAPI/GetTopology"
	TopologyAPI_Search_FullMethodName      = "/clutch.topology.v1.TopologyAPI/Search"
)

Variables

View Source
var (
	SearchRequest_Sort_Direction_name = map[int32]string{
		0: "UNSPECIFIED",
		1: "ASCENDING",
		2: "DESCENDING",
	}
	SearchRequest_Sort_Direction_value = map[string]int32{
		"UNSPECIFIED": 0,
		"ASCENDING":   1,
		"DESCENDING":  2,
	}
)

Enum value maps for SearchRequest_Sort_Direction.

View Source
var (
	Constraint_Operator_name = map[int32]string{
		0: "UNSPECIFIED",
		1: "EQUAL",
		2: "NOT_EQUAL",
		3: "GREATER_THAN",
		4: "GREATER_THAN_OR_EQUAL",
		5: "LESS_THAN",
		6: "LESS_THAN_OR_EQUAL",
		7: "CONTAINS_STRING",
		8: "CONTAINS_VALUE",
		9: "CONTAINS_KEY",
	}
	Constraint_Operator_value = map[string]int32{
		"UNSPECIFIED":           0,
		"EQUAL":                 1,
		"NOT_EQUAL":             2,
		"GREATER_THAN":          3,
		"GREATER_THAN_OR_EQUAL": 4,
		"LESS_THAN":             5,
		"LESS_THAN_OR_EQUAL":    6,
		"CONTAINS_STRING":       7,
		"CONTAINS_VALUE":        8,
		"CONTAINS_KEY":          9,
	}
)

Enum value maps for Constraint_Operator.

View Source
var (
	MetadataQuery_Aggregation_name = map[int32]string{
		0: "UNSPECIFIED",
		1: "SUM",
		2: "AVERAGE",
		3: "MEDIAN",
		4: "MODE",
		5: "MIN",
		6: "MAX",
		7: "COUNT",
	}
	MetadataQuery_Aggregation_value = map[string]int32{
		"UNSPECIFIED": 0,
		"SUM":         1,
		"AVERAGE":     2,
		"MEDIAN":      3,
		"MODE":        4,
		"MIN":         5,
		"MAX":         6,
		"COUNT":       7,
	}
)

Enum value maps for MetadataQuery_Aggregation.

View Source
var (
	UpdateCacheRequest_Action_name = map[int32]string{
		0: "UNSPECIFIED",
		1: "CREATE_OR_UPDATE",
		2: "DELETE",
	}
	UpdateCacheRequest_Action_value = map[string]int32{
		"UNSPECIFIED":      0,
		"CREATE_OR_UPDATE": 1,
		"DELETE":           2,
	}
)

Enum value maps for UpdateCacheRequest_Action.

View Source
var File_topology_v1_topology_api_proto protoreflect.FileDescriptor
View Source
var TopologyAPI_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "clutch.topology.v1.TopologyAPI",
	HandlerType: (*TopologyAPIServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetTopology",
			Handler:    _TopologyAPI_GetTopology_Handler,
		},
		{
			MethodName: "Search",
			Handler:    _TopologyAPI_Search_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "topology/v1/topology_api.proto",
}

TopologyAPI_ServiceDesc is the grpc.ServiceDesc for TopologyAPI service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterTopologyAPIHandler

func RegisterTopologyAPIHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterTopologyAPIHandler registers the http handlers for service TopologyAPI to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterTopologyAPIHandlerClient

func RegisterTopologyAPIHandlerClient(ctx context.Context, mux *runtime.ServeMux, client TopologyAPIClient) error

RegisterTopologyAPIHandlerClient registers the http handlers for service TopologyAPI to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "TopologyAPIClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "TopologyAPIClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "TopologyAPIClient" to call the correct interceptors.

func RegisterTopologyAPIHandlerFromEndpoint

func RegisterTopologyAPIHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterTopologyAPIHandlerFromEndpoint is same as RegisterTopologyAPIHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterTopologyAPIHandlerServer

func RegisterTopologyAPIHandlerServer(ctx context.Context, mux *runtime.ServeMux, server TopologyAPIServer) error

RegisterTopologyAPIHandlerServer registers the http handlers for service TopologyAPI to "mux". UnaryRPC :call TopologyAPIServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterTopologyAPIHandlerFromEndpoint instead.

func RegisterTopologyAPIServer

func RegisterTopologyAPIServer(s grpc.ServiceRegistrar, srv TopologyAPIServer)

Types

type Constraint

type Constraint struct {
	Operator Constraint_Operator `protobuf:"varint,1,opt,name=operator,proto3,enum=clutch.topology.v1.Constraint_Operator" json:"operator,omitempty"`
	Value    *structpb.Value     `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

A metadata constraint with an operator and a value

func (*Constraint) Descriptor deprecated

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

Deprecated: Use Constraint.ProtoReflect.Descriptor instead.

func (*Constraint) GetOperator

func (x *Constraint) GetOperator() Constraint_Operator

func (*Constraint) GetValue

func (x *Constraint) GetValue() *structpb.Value

func (*Constraint) ProtoMessage

func (*Constraint) ProtoMessage()

func (*Constraint) ProtoReflect

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

func (*Constraint) Reset

func (x *Constraint) Reset()

func (*Constraint) String

func (x *Constraint) String() string

func (*Constraint) Validate

func (m *Constraint) Validate() error

Validate checks the field values on Constraint with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Constraint) ValidateAll

func (m *Constraint) ValidateAll() error

ValidateAll checks the field values on Constraint with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ConstraintMultiError, or nil if none found.

type ConstraintMultiError

type ConstraintMultiError []error

ConstraintMultiError is an error wrapping multiple validation errors returned by Constraint.ValidateAll() if the designated constraints aren't met.

func (ConstraintMultiError) AllErrors

func (m ConstraintMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ConstraintMultiError) Error

func (m ConstraintMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type ConstraintValidationError

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

ConstraintValidationError is the validation error returned by Constraint.Validate if the designated constraints aren't met.

func (ConstraintValidationError) Cause

func (e ConstraintValidationError) Cause() error

Cause function returns cause value.

func (ConstraintValidationError) Error

Error satisfies the builtin error interface

func (ConstraintValidationError) ErrorName

func (e ConstraintValidationError) ErrorName() string

ErrorName returns error name.

func (ConstraintValidationError) Field

Field function returns field value.

func (ConstraintValidationError) Key

Key function returns key value.

func (ConstraintValidationError) Reason

func (e ConstraintValidationError) Reason() string

Reason function returns reason value.

type Constraint_Operator

type Constraint_Operator int32
const (
	Constraint_UNSPECIFIED Constraint_Operator = 0
	// number operators
	Constraint_EQUAL                 Constraint_Operator = 1
	Constraint_NOT_EQUAL             Constraint_Operator = 2
	Constraint_GREATER_THAN          Constraint_Operator = 3
	Constraint_GREATER_THAN_OR_EQUAL Constraint_Operator = 4
	Constraint_LESS_THAN             Constraint_Operator = 5
	Constraint_LESS_THAN_OR_EQUAL    Constraint_Operator = 6
	// string operators
	Constraint_CONTAINS_STRING Constraint_Operator = 7
	// array operators
	Constraint_CONTAINS_VALUE Constraint_Operator = 8
	// map operators
	Constraint_CONTAINS_KEY Constraint_Operator = 9
)

func (Constraint_Operator) Descriptor

func (Constraint_Operator) Enum

func (Constraint_Operator) EnumDescriptor deprecated

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

Deprecated: Use Constraint_Operator.Descriptor instead.

func (Constraint_Operator) Number

func (Constraint_Operator) String

func (x Constraint_Operator) String() string

func (Constraint_Operator) Type

type Edge

type Edge struct {

	// Each edge has an opaque ID that is used to identify the edge during result
	// processing and presentation.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Node ID where the edge originates.
	SourceNodeId string `protobuf:"bytes,2,opt,name=source_node_id,json=sourceNodeId,proto3" json:"source_node_id,omitempty"`
	// Node ID where the edge terminates.
	TargetNodeId string `protobuf:"bytes,3,opt,name=target_node_id,json=targetNodeId,proto3" json:"target_node_id,omitempty"`
	// Metadata maps field names to assorted state or characteristics of the
	// edge.
	Metadata map[string]*structpb.Value `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*Edge) Descriptor deprecated

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

Deprecated: Use Edge.ProtoReflect.Descriptor instead.

func (*Edge) GetId

func (x *Edge) GetId() string

func (*Edge) GetMetadata

func (x *Edge) GetMetadata() map[string]*structpb.Value

func (*Edge) GetSourceNodeId

func (x *Edge) GetSourceNodeId() string

func (*Edge) GetTargetNodeId

func (x *Edge) GetTargetNodeId() string

func (*Edge) ProtoMessage

func (*Edge) ProtoMessage()

func (*Edge) ProtoReflect

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

func (*Edge) Reset

func (x *Edge) Reset()

func (*Edge) String

func (x *Edge) String() string

func (*Edge) Validate

func (m *Edge) Validate() error

Validate checks the field values on Edge with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Edge) ValidateAll

func (m *Edge) ValidateAll() error

ValidateAll checks the field values on Edge with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in EdgeMultiError, or nil if none found.

type EdgeMultiError

type EdgeMultiError []error

EdgeMultiError is an error wrapping multiple validation errors returned by Edge.ValidateAll() if the designated constraints aren't met.

func (EdgeMultiError) AllErrors

func (m EdgeMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (EdgeMultiError) Error

func (m EdgeMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type EdgeValidationError

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

EdgeValidationError is the validation error returned by Edge.Validate if the designated constraints aren't met.

func (EdgeValidationError) Cause

func (e EdgeValidationError) Cause() error

Cause function returns cause value.

func (EdgeValidationError) Error

func (e EdgeValidationError) Error() string

Error satisfies the builtin error interface

func (EdgeValidationError) ErrorName

func (e EdgeValidationError) ErrorName() string

ErrorName returns error name.

func (EdgeValidationError) Field

func (e EdgeValidationError) Field() string

Field function returns field value.

func (EdgeValidationError) Key

func (e EdgeValidationError) Key() bool

Key function returns key value.

func (EdgeValidationError) Reason

func (e EdgeValidationError) Reason() string

Reason function returns reason value.

type FeatureQuery

type FeatureQuery struct {
	Name   string   `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Values []string `protobuf:"bytes,2,rep,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

A query allows the user to specify multiple dimensions and the corresponding desired values for the identifying features of the returned nodes.

func (*FeatureQuery) Descriptor deprecated

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

Deprecated: Use FeatureQuery.ProtoReflect.Descriptor instead.

func (*FeatureQuery) GetName

func (x *FeatureQuery) GetName() string

func (*FeatureQuery) GetValues

func (x *FeatureQuery) GetValues() []string

func (*FeatureQuery) ProtoMessage

func (*FeatureQuery) ProtoMessage()

func (*FeatureQuery) ProtoReflect

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

func (*FeatureQuery) Reset

func (x *FeatureQuery) Reset()

func (*FeatureQuery) String

func (x *FeatureQuery) String() string

func (*FeatureQuery) Validate

func (m *FeatureQuery) Validate() error

Validate checks the field values on FeatureQuery with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*FeatureQuery) ValidateAll

func (m *FeatureQuery) ValidateAll() error

ValidateAll checks the field values on FeatureQuery with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in FeatureQueryMultiError, or nil if none found.

type FeatureQueryMultiError

type FeatureQueryMultiError []error

FeatureQueryMultiError is an error wrapping multiple validation errors returned by FeatureQuery.ValidateAll() if the designated constraints aren't met.

func (FeatureQueryMultiError) AllErrors

func (m FeatureQueryMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (FeatureQueryMultiError) Error

func (m FeatureQueryMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type FeatureQueryValidationError

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

FeatureQueryValidationError is the validation error returned by FeatureQuery.Validate if the designated constraints aren't met.

func (FeatureQueryValidationError) Cause

Cause function returns cause value.

func (FeatureQueryValidationError) Error

Error satisfies the builtin error interface

func (FeatureQueryValidationError) ErrorName

func (e FeatureQueryValidationError) ErrorName() string

ErrorName returns error name.

func (FeatureQueryValidationError) Field

Field function returns field value.

func (FeatureQueryValidationError) Key

Key function returns key value.

func (FeatureQueryValidationError) Reason

Reason function returns reason value.

type GetTopologyRequest

type GetTopologyRequest struct {
	Queries []*Query `protobuf:"bytes,1,rep,name=queries,proto3" json:"queries,omitempty"`
	// contains filtered or unexported fields
}

func (*GetTopologyRequest) Descriptor deprecated

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

Deprecated: Use GetTopologyRequest.ProtoReflect.Descriptor instead.

func (*GetTopologyRequest) GetQueries

func (x *GetTopologyRequest) GetQueries() []*Query

func (*GetTopologyRequest) ProtoMessage

func (*GetTopologyRequest) ProtoMessage()

func (*GetTopologyRequest) ProtoReflect

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

func (*GetTopologyRequest) Reset

func (x *GetTopologyRequest) Reset()

func (*GetTopologyRequest) String

func (x *GetTopologyRequest) String() string

func (*GetTopologyRequest) Validate

func (m *GetTopologyRequest) Validate() error

Validate checks the field values on GetTopologyRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*GetTopologyRequest) ValidateAll

func (m *GetTopologyRequest) ValidateAll() error

ValidateAll checks the field values on GetTopologyRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in GetTopologyRequestMultiError, or nil if none found.

type GetTopologyRequestMultiError

type GetTopologyRequestMultiError []error

GetTopologyRequestMultiError is an error wrapping multiple validation errors returned by GetTopologyRequest.ValidateAll() if the designated constraints aren't met.

func (GetTopologyRequestMultiError) AllErrors

func (m GetTopologyRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (GetTopologyRequestMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type GetTopologyRequestValidationError

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

GetTopologyRequestValidationError is the validation error returned by GetTopologyRequest.Validate if the designated constraints aren't met.

func (GetTopologyRequestValidationError) Cause

Cause function returns cause value.

func (GetTopologyRequestValidationError) Error

Error satisfies the builtin error interface

func (GetTopologyRequestValidationError) ErrorName

ErrorName returns error name.

func (GetTopologyRequestValidationError) Field

Field function returns field value.

func (GetTopologyRequestValidationError) Key

Key function returns key value.

func (GetTopologyRequestValidationError) Reason

Reason function returns reason value.

type GetTopologyResponse

type GetTopologyResponse struct {
	Results []*QueryResult `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"`
	// contains filtered or unexported fields
}

func (*GetTopologyResponse) Descriptor deprecated

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

Deprecated: Use GetTopologyResponse.ProtoReflect.Descriptor instead.

func (*GetTopologyResponse) GetResults

func (x *GetTopologyResponse) GetResults() []*QueryResult

func (*GetTopologyResponse) ProtoMessage

func (*GetTopologyResponse) ProtoMessage()

func (*GetTopologyResponse) ProtoReflect

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

func (*GetTopologyResponse) Reset

func (x *GetTopologyResponse) Reset()

func (*GetTopologyResponse) String

func (x *GetTopologyResponse) String() string

func (*GetTopologyResponse) Validate

func (m *GetTopologyResponse) Validate() error

Validate checks the field values on GetTopologyResponse with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*GetTopologyResponse) ValidateAll

func (m *GetTopologyResponse) ValidateAll() error

ValidateAll checks the field values on GetTopologyResponse with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in GetTopologyResponseMultiError, or nil if none found.

type GetTopologyResponseMultiError

type GetTopologyResponseMultiError []error

GetTopologyResponseMultiError is an error wrapping multiple validation errors returned by GetTopologyResponse.ValidateAll() if the designated constraints aren't met.

func (GetTopologyResponseMultiError) AllErrors

func (m GetTopologyResponseMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (GetTopologyResponseMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type GetTopologyResponseValidationError

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

GetTopologyResponseValidationError is the validation error returned by GetTopologyResponse.Validate if the designated constraints aren't met.

func (GetTopologyResponseValidationError) Cause

Cause function returns cause value.

func (GetTopologyResponseValidationError) Error

Error satisfies the builtin error interface

func (GetTopologyResponseValidationError) ErrorName

ErrorName returns error name.

func (GetTopologyResponseValidationError) Field

Field function returns field value.

func (GetTopologyResponseValidationError) Key

Key function returns key value.

func (GetTopologyResponseValidationError) Reason

Reason function returns reason value.

type MetadataQuery

type MetadataQuery struct {

	// name of the metadata field to populate. i.e. call_volume, service_tier,
	// etc.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// i.e. Wavefront params: google.protobuf.Struct{ ...start: <Time>, end:
	// <Time>, Timeout: <Duration>} i.e. other params for other clients TBD
	Params      *structpb.Struct          `protobuf:"bytes,2,opt,name=params,proto3" json:"params,omitempty"`
	Aggregation MetadataQuery_Aggregation `` /* 126-byte string literal not displayed */
	// a series of restrictive constraints for the value/values of a Type to pass
	Constraints []*Constraint `protobuf:"bytes,5,rep,name=constraints,proto3" json:"constraints,omitempty"`
	// contains filtered or unexported fields
}

Similar to FeatureQuery, rather than pre-traversal filtering, MetadataQuery specifies metadata params and potential filters for nodes and edges

func (*MetadataQuery) Descriptor deprecated

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

Deprecated: Use MetadataQuery.ProtoReflect.Descriptor instead.

func (*MetadataQuery) GetAggregation

func (x *MetadataQuery) GetAggregation() MetadataQuery_Aggregation

func (*MetadataQuery) GetConstraints

func (x *MetadataQuery) GetConstraints() []*Constraint

func (*MetadataQuery) GetName

func (x *MetadataQuery) GetName() string

func (*MetadataQuery) GetParams

func (x *MetadataQuery) GetParams() *structpb.Struct

func (*MetadataQuery) ProtoMessage

func (*MetadataQuery) ProtoMessage()

func (*MetadataQuery) ProtoReflect

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

func (*MetadataQuery) Reset

func (x *MetadataQuery) Reset()

func (*MetadataQuery) String

func (x *MetadataQuery) String() string

func (*MetadataQuery) Validate

func (m *MetadataQuery) Validate() error

Validate checks the field values on MetadataQuery with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*MetadataQuery) ValidateAll

func (m *MetadataQuery) ValidateAll() error

ValidateAll checks the field values on MetadataQuery with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in MetadataQueryMultiError, or nil if none found.

type MetadataQueryMultiError

type MetadataQueryMultiError []error

MetadataQueryMultiError is an error wrapping multiple validation errors returned by MetadataQuery.ValidateAll() if the designated constraints aren't met.

func (MetadataQueryMultiError) AllErrors

func (m MetadataQueryMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (MetadataQueryMultiError) Error

func (m MetadataQueryMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type MetadataQueryValidationError

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

MetadataQueryValidationError is the validation error returned by MetadataQuery.Validate if the designated constraints aren't met.

func (MetadataQueryValidationError) Cause

Cause function returns cause value.

func (MetadataQueryValidationError) Error

Error satisfies the builtin error interface

func (MetadataQueryValidationError) ErrorName

func (e MetadataQueryValidationError) ErrorName() string

ErrorName returns error name.

func (MetadataQueryValidationError) Field

Field function returns field value.

func (MetadataQueryValidationError) Key

Key function returns key value.

func (MetadataQueryValidationError) Reason

Reason function returns reason value.

type MetadataQuery_Aggregation

type MetadataQuery_Aggregation int32

if aggregate, then all timeseries or array metadata is aggregated into a value and returned otherwise, it will return the original array/timeseries. This is meant to reduce message size for larger queries.

const (
	// default; no aggregation applied
	MetadataQuery_UNSPECIFIED MetadataQuery_Aggregation = 0
	MetadataQuery_SUM         MetadataQuery_Aggregation = 1
	MetadataQuery_AVERAGE     MetadataQuery_Aggregation = 2
	MetadataQuery_MEDIAN      MetadataQuery_Aggregation = 3
	MetadataQuery_MODE        MetadataQuery_Aggregation = 4
	MetadataQuery_MIN         MetadataQuery_Aggregation = 5
	MetadataQuery_MAX         MetadataQuery_Aggregation = 6
	MetadataQuery_COUNT       MetadataQuery_Aggregation = 7
)

func (MetadataQuery_Aggregation) Descriptor

func (MetadataQuery_Aggregation) Enum

func (MetadataQuery_Aggregation) EnumDescriptor deprecated

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

Deprecated: Use MetadataQuery_Aggregation.Descriptor instead.

func (MetadataQuery_Aggregation) Number

func (MetadataQuery_Aggregation) String

func (x MetadataQuery_Aggregation) String() string

func (MetadataQuery_Aggregation) Type

type Node

type Node struct {

	// Each node has an opaque ID that is used to identify the node during result
	// processing and presentation.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Features represent the identifying characteristics (i.e. dimensions) of a
	// node that make it unique.
	//
	// When a node is returned from a query, the set of feature fields included on
	// the node will match those in the query.
	Features map[string]string `` /* 157-byte string literal not displayed */
	// Metadata maps field names to assorted state or characteristics of the node.
	Metadata map[string]*structpb.Value `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*Node) Descriptor deprecated

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

Deprecated: Use Node.ProtoReflect.Descriptor instead.

func (*Node) GetFeatures

func (x *Node) GetFeatures() map[string]string

func (*Node) GetId

func (x *Node) GetId() string

func (*Node) GetMetadata

func (x *Node) GetMetadata() map[string]*structpb.Value

func (*Node) ProtoMessage

func (*Node) ProtoMessage()

func (*Node) ProtoReflect

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

func (*Node) Reset

func (x *Node) Reset()

func (*Node) String

func (x *Node) String() string

func (*Node) Validate

func (m *Node) Validate() error

Validate checks the field values on Node with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Node) ValidateAll

func (m *Node) ValidateAll() error

ValidateAll checks the field values on Node with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in NodeMultiError, or nil if none found.

type NodeMultiError

type NodeMultiError []error

NodeMultiError is an error wrapping multiple validation errors returned by Node.ValidateAll() if the designated constraints aren't met.

func (NodeMultiError) AllErrors

func (m NodeMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (NodeMultiError) Error

func (m NodeMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type NodeValidationError

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

NodeValidationError is the validation error returned by Node.Validate if the designated constraints aren't met.

func (NodeValidationError) Cause

func (e NodeValidationError) Cause() error

Cause function returns cause value.

func (NodeValidationError) Error

func (e NodeValidationError) Error() string

Error satisfies the builtin error interface

func (NodeValidationError) ErrorName

func (e NodeValidationError) ErrorName() string

ErrorName returns error name.

func (NodeValidationError) Field

func (e NodeValidationError) Field() string

Field function returns field value.

func (NodeValidationError) Key

func (e NodeValidationError) Key() bool

Key function returns key value.

func (NodeValidationError) Reason

func (e NodeValidationError) Reason() string

Reason function returns reason value.

type Query

type Query struct {

	// Features represent the identifying characteristics of a node that make it
	// unique, i.e. the resulting dimensions of the nodes in the result set.
	//
	// A query can specify the set of desired values or wildcard values for each
	// feature.
	Features []*FeatureQuery `protobuf:"bytes,1,rep,name=features,proto3" json:"features,omitempty"`
	// Metadata is non-identifying characteristics of a node which can be
	// filtered upon and changed.
	NodeMetadata []*MetadataQuery `protobuf:"bytes,4,rep,name=node_metadata,json=nodeMetadata,proto3" json:"node_metadata,omitempty"`
	// Metadata query for edges.
	EdgeMetadata []*MetadataQuery `protobuf:"bytes,5,rep,name=edge_metadata,json=edgeMetadata,proto3" json:"edge_metadata,omitempty"`
	// Maximum depth to traverse in the graph upwards.
	SourceDepth uint32 `protobuf:"varint,2,opt,name=source_depth,json=sourceDepth,proto3" json:"source_depth,omitempty"`
	// Maximum depth to traverse in the graph downwards.
	TargetDepth uint32 `protobuf:"varint,3,opt,name=target_depth,json=targetDepth,proto3" json:"target_depth,omitempty"`
	// contains filtered or unexported fields
}

func (*Query) Descriptor deprecated

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

Deprecated: Use Query.ProtoReflect.Descriptor instead.

func (*Query) GetEdgeMetadata

func (x *Query) GetEdgeMetadata() []*MetadataQuery

func (*Query) GetFeatures

func (x *Query) GetFeatures() []*FeatureQuery

func (*Query) GetNodeMetadata

func (x *Query) GetNodeMetadata() []*MetadataQuery

func (*Query) GetSourceDepth

func (x *Query) GetSourceDepth() uint32

func (*Query) GetTargetDepth

func (x *Query) GetTargetDepth() uint32

func (*Query) ProtoMessage

func (*Query) ProtoMessage()

func (*Query) ProtoReflect

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

func (*Query) Reset

func (x *Query) Reset()

func (*Query) String

func (x *Query) String() string

func (*Query) Validate

func (m *Query) Validate() error

Validate checks the field values on Query with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Query) ValidateAll

func (m *Query) ValidateAll() error

ValidateAll checks the field values on Query with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in QueryMultiError, or nil if none found.

type QueryMultiError

type QueryMultiError []error

QueryMultiError is an error wrapping multiple validation errors returned by Query.ValidateAll() if the designated constraints aren't met.

func (QueryMultiError) AllErrors

func (m QueryMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (QueryMultiError) Error

func (m QueryMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type QueryResult

type QueryResult struct {

	// Errors thats pertain to the issued query.
	Status *status.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// Query issued in the request to yield the result.
	Query *Query `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
	// Subset of the IDs for the query-matched nodes before any traversal
	// occurred.
	MatchedNodeIds []string `protobuf:"bytes,3,rep,name=matched_node_ids,json=matchedNodeIds,proto3" json:"matched_node_ids,omitempty"`
	// Map of node IDs to the node object.
	Nodes map[string]*Node `` /* 151-byte string literal not displayed */
	// Map of edge IDs to the edge object.
	Edges map[string]*Edge `` /* 151-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*QueryResult) Descriptor deprecated

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

Deprecated: Use QueryResult.ProtoReflect.Descriptor instead.

func (*QueryResult) GetEdges

func (x *QueryResult) GetEdges() map[string]*Edge

func (*QueryResult) GetMatchedNodeIds

func (x *QueryResult) GetMatchedNodeIds() []string

func (*QueryResult) GetNodes

func (x *QueryResult) GetNodes() map[string]*Node

func (*QueryResult) GetQuery

func (x *QueryResult) GetQuery() *Query

func (*QueryResult) GetStatus

func (x *QueryResult) GetStatus() *status.Status

func (*QueryResult) ProtoMessage

func (*QueryResult) ProtoMessage()

func (*QueryResult) ProtoReflect

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

func (*QueryResult) Reset

func (x *QueryResult) Reset()

func (*QueryResult) String

func (x *QueryResult) String() string

func (*QueryResult) Validate

func (m *QueryResult) Validate() error

Validate checks the field values on QueryResult with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*QueryResult) ValidateAll

func (m *QueryResult) ValidateAll() error

ValidateAll checks the field values on QueryResult with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in QueryResultMultiError, or nil if none found.

type QueryResultMultiError

type QueryResultMultiError []error

QueryResultMultiError is an error wrapping multiple validation errors returned by QueryResult.ValidateAll() if the designated constraints aren't met.

func (QueryResultMultiError) AllErrors

func (m QueryResultMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (QueryResultMultiError) Error

func (m QueryResultMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type QueryResultValidationError

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

QueryResultValidationError is the validation error returned by QueryResult.Validate if the designated constraints aren't met.

func (QueryResultValidationError) Cause

Cause function returns cause value.

func (QueryResultValidationError) Error

Error satisfies the builtin error interface

func (QueryResultValidationError) ErrorName

func (e QueryResultValidationError) ErrorName() string

ErrorName returns error name.

func (QueryResultValidationError) Field

Field function returns field value.

func (QueryResultValidationError) Key

Key function returns key value.

func (QueryResultValidationError) Reason

Reason function returns reason value.

type QueryValidationError

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

QueryValidationError is the validation error returned by Query.Validate if the designated constraints aren't met.

func (QueryValidationError) Cause

func (e QueryValidationError) Cause() error

Cause function returns cause value.

func (QueryValidationError) Error

func (e QueryValidationError) Error() string

Error satisfies the builtin error interface

func (QueryValidationError) ErrorName

func (e QueryValidationError) ErrorName() string

ErrorName returns error name.

func (QueryValidationError) Field

func (e QueryValidationError) Field() string

Field function returns field value.

func (QueryValidationError) Key

func (e QueryValidationError) Key() bool

Key function returns key value.

func (QueryValidationError) Reason

func (e QueryValidationError) Reason() string

Reason function returns reason value.

type Resource

type Resource struct {

	// Id is the unique identifer of the Resource.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Pb is the clutch proto object.
	Pb *anypb.Any `protobuf:"bytes,2,opt,name=pb,proto3" json:"pb,omitempty"`
	// Metadata is set by the service which produces the topology Resource, for example k8s would extract
	// relevant metadata that gives the Topology API the ability to query against it.
	Metadata map[string]*structpb.Value `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*Resource) Descriptor deprecated

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

Deprecated: Use Resource.ProtoReflect.Descriptor instead.

func (*Resource) GetId

func (x *Resource) GetId() string

func (*Resource) GetMetadata

func (x *Resource) GetMetadata() map[string]*structpb.Value

func (*Resource) GetPb

func (x *Resource) GetPb() *anypb.Any

func (*Resource) ProtoMessage

func (*Resource) ProtoMessage()

func (*Resource) ProtoReflect

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

func (*Resource) Reset

func (x *Resource) Reset()

func (*Resource) String

func (x *Resource) String() string

func (*Resource) Validate

func (m *Resource) Validate() error

Validate checks the field values on Resource with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Resource) ValidateAll

func (m *Resource) ValidateAll() error

ValidateAll checks the field values on Resource with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ResourceMultiError, or nil if none found.

type ResourceMultiError

type ResourceMultiError []error

ResourceMultiError is an error wrapping multiple validation errors returned by Resource.ValidateAll() if the designated constraints aren't met.

func (ResourceMultiError) AllErrors

func (m ResourceMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ResourceMultiError) Error

func (m ResourceMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type ResourceValidationError

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

ResourceValidationError is the validation error returned by Resource.Validate if the designated constraints aren't met.

func (ResourceValidationError) Cause

func (e ResourceValidationError) Cause() error

Cause function returns cause value.

func (ResourceValidationError) Error

func (e ResourceValidationError) Error() string

Error satisfies the builtin error interface

func (ResourceValidationError) ErrorName

func (e ResourceValidationError) ErrorName() string

ErrorName returns error name.

func (ResourceValidationError) Field

func (e ResourceValidationError) Field() string

Field function returns field value.

func (ResourceValidationError) Key

func (e ResourceValidationError) Key() bool

Key function returns key value.

func (ResourceValidationError) Reason

func (e ResourceValidationError) Reason() string

Reason function returns reason value.

type SearchRequest

type SearchRequest struct {
	Sort *SearchRequest_Sort `protobuf:"bytes,1,opt,name=sort,proto3" json:"sort,omitempty"`
	// Currently page_token specifies the page number you wish to request.
	// The rationale behind the naming is we might changes this to a cursor implentation
	// in the future and did not want to break existing implementations of the API.
	// https://cloud.google.com/apis/design/design_patterns#list_pagination
	PageToken string                `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	Limit     uint64                `protobuf:"varint,3,opt,name=limit,proto3" json:"limit,omitempty"`
	Filter    *SearchRequest_Filter `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

func (*SearchRequest) Descriptor deprecated

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

Deprecated: Use SearchRequest.ProtoReflect.Descriptor instead.

func (*SearchRequest) GetFilter

func (x *SearchRequest) GetFilter() *SearchRequest_Filter

func (*SearchRequest) GetLimit

func (x *SearchRequest) GetLimit() uint64

func (*SearchRequest) GetPageToken

func (x *SearchRequest) GetPageToken() string

func (*SearchRequest) GetSort

func (x *SearchRequest) GetSort() *SearchRequest_Sort

func (*SearchRequest) ProtoMessage

func (*SearchRequest) ProtoMessage()

func (*SearchRequest) ProtoReflect

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

func (*SearchRequest) Reset

func (x *SearchRequest) Reset()

func (*SearchRequest) String

func (x *SearchRequest) String() string

func (*SearchRequest) Validate

func (m *SearchRequest) Validate() error

Validate checks the field values on SearchRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*SearchRequest) ValidateAll

func (m *SearchRequest) ValidateAll() error

ValidateAll checks the field values on SearchRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in SearchRequestMultiError, or nil if none found.

type SearchRequestMultiError

type SearchRequestMultiError []error

SearchRequestMultiError is an error wrapping multiple validation errors returned by SearchRequest.ValidateAll() if the designated constraints aren't met.

func (SearchRequestMultiError) AllErrors

func (m SearchRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (SearchRequestMultiError) Error

func (m SearchRequestMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type SearchRequestValidationError

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

SearchRequestValidationError is the validation error returned by SearchRequest.Validate if the designated constraints aren't met.

func (SearchRequestValidationError) Cause

Cause function returns cause value.

func (SearchRequestValidationError) Error

Error satisfies the builtin error interface

func (SearchRequestValidationError) ErrorName

func (e SearchRequestValidationError) ErrorName() string

ErrorName returns error name.

func (SearchRequestValidationError) Field

Field function returns field value.

func (SearchRequestValidationError) Key

Key function returns key value.

func (SearchRequestValidationError) Reason

Reason function returns reason value.

type SearchRequest_Filter

type SearchRequest_Filter struct {
	Search  *SearchRequest_Filter_Search `protobuf:"bytes,1,opt,name=search,proto3" json:"search,omitempty"`
	TypeUrl string                       `protobuf:"bytes,2,opt,name=type_url,json=typeUrl,proto3" json:"type_url,omitempty"`
	// Any valid metadata on the cache Resource object
	Metadata map[string]string `` /* 157-byte string literal not displayed */
	// If case-sensitive, will use `LIKE`. Else, will use `ILIKE`
	// Notes about ILIKE from postgres docs:
	// The key word ILIKE can be used instead of LIKE to make the match case-insensitive
	// according to the active locale. This is not in the SQL standard but is a
	// PostgreSQL extension.
	CaseSensitive bool `protobuf:"varint,5,opt,name=case_sensitive,json=caseSensitive,proto3" json:"case_sensitive,omitempty"`
	// contains filtered or unexported fields
}

func (*SearchRequest_Filter) Descriptor deprecated

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

Deprecated: Use SearchRequest_Filter.ProtoReflect.Descriptor instead.

func (*SearchRequest_Filter) GetCaseSensitive

func (x *SearchRequest_Filter) GetCaseSensitive() bool

func (*SearchRequest_Filter) GetMetadata

func (x *SearchRequest_Filter) GetMetadata() map[string]string

func (*SearchRequest_Filter) GetSearch

func (*SearchRequest_Filter) GetTypeUrl

func (x *SearchRequest_Filter) GetTypeUrl() string

func (*SearchRequest_Filter) ProtoMessage

func (*SearchRequest_Filter) ProtoMessage()

func (*SearchRequest_Filter) ProtoReflect

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

func (*SearchRequest_Filter) Reset

func (x *SearchRequest_Filter) Reset()

func (*SearchRequest_Filter) String

func (x *SearchRequest_Filter) String() string

func (*SearchRequest_Filter) Validate

func (m *SearchRequest_Filter) Validate() error

Validate checks the field values on SearchRequest_Filter with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*SearchRequest_Filter) ValidateAll

func (m *SearchRequest_Filter) ValidateAll() error

ValidateAll checks the field values on SearchRequest_Filter with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in SearchRequest_FilterMultiError, or nil if none found.

type SearchRequest_FilterMultiError

type SearchRequest_FilterMultiError []error

SearchRequest_FilterMultiError is an error wrapping multiple validation errors returned by SearchRequest_Filter.ValidateAll() if the designated constraints aren't met.

func (SearchRequest_FilterMultiError) AllErrors

func (m SearchRequest_FilterMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (SearchRequest_FilterMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type SearchRequest_FilterValidationError

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

SearchRequest_FilterValidationError is the validation error returned by SearchRequest_Filter.Validate if the designated constraints aren't met.

func (SearchRequest_FilterValidationError) Cause

Cause function returns cause value.

func (SearchRequest_FilterValidationError) Error

Error satisfies the builtin error interface

func (SearchRequest_FilterValidationError) ErrorName

ErrorName returns error name.

func (SearchRequest_FilterValidationError) Field

Field function returns field value.

func (SearchRequest_FilterValidationError) Key

Key function returns key value.

func (SearchRequest_FilterValidationError) Reason

Reason function returns reason value.

type SearchRequest_Filter_Search struct {

	// Using field mask selector to delinate a column or metadata.
	// if the metadata is nested specify the full path like the example shows below.
	// example for metadata 'metadata.level1.level2.level3.fieldname'
	// example for column 'column.id'
	Field string `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
	Text  string `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
	// contains filtered or unexported fields
}

func (*SearchRequest_Filter_Search) Descriptor deprecated

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

Deprecated: Use SearchRequest_Filter_Search.ProtoReflect.Descriptor instead.

func (*SearchRequest_Filter_Search) GetField

func (x *SearchRequest_Filter_Search) GetField() string

func (*SearchRequest_Filter_Search) GetText

func (x *SearchRequest_Filter_Search) GetText() string

func (*SearchRequest_Filter_Search) ProtoMessage

func (*SearchRequest_Filter_Search) ProtoMessage()

func (*SearchRequest_Filter_Search) ProtoReflect

func (*SearchRequest_Filter_Search) Reset

func (x *SearchRequest_Filter_Search) Reset()

func (*SearchRequest_Filter_Search) String

func (x *SearchRequest_Filter_Search) String() string

func (*SearchRequest_Filter_Search) Validate

func (m *SearchRequest_Filter_Search) Validate() error

Validate checks the field values on SearchRequest_Filter_Search with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*SearchRequest_Filter_Search) ValidateAll

func (m *SearchRequest_Filter_Search) ValidateAll() error

ValidateAll checks the field values on SearchRequest_Filter_Search with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in SearchRequest_Filter_SearchMultiError, or nil if none found.

type SearchRequest_Filter_SearchMultiError

type SearchRequest_Filter_SearchMultiError []error

SearchRequest_Filter_SearchMultiError is an error wrapping multiple validation errors returned by SearchRequest_Filter_Search.ValidateAll() if the designated constraints aren't met.

func (SearchRequest_Filter_SearchMultiError) AllErrors

AllErrors returns a list of validation violation errors.

func (SearchRequest_Filter_SearchMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type SearchRequest_Filter_SearchValidationError

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

SearchRequest_Filter_SearchValidationError is the validation error returned by SearchRequest_Filter_Search.Validate if the designated constraints aren't met.

func (SearchRequest_Filter_SearchValidationError) Cause

Cause function returns cause value.

func (SearchRequest_Filter_SearchValidationError) Error

Error satisfies the builtin error interface

func (SearchRequest_Filter_SearchValidationError) ErrorName

ErrorName returns error name.

func (SearchRequest_Filter_SearchValidationError) Field

Field function returns field value.

func (SearchRequest_Filter_SearchValidationError) Key

Key function returns key value.

func (SearchRequest_Filter_SearchValidationError) Reason

Reason function returns reason value.

type SearchRequest_Sort

type SearchRequest_Sort struct {
	Direction SearchRequest_Sort_Direction `protobuf:"varint,1,opt,name=direction,proto3,enum=clutch.topology.v1.SearchRequest_Sort_Direction" json:"direction,omitempty"`
	// Using field mask selector to delinate a column or metadata.
	// if the metadata is nested specify the full path like the example shows below.
	// example for metadata 'metadata.level1.level2.level3.fieldname'
	// example for column 'column.id'
	Field string `protobuf:"bytes,2,opt,name=field,proto3" json:"field,omitempty"`
	// contains filtered or unexported fields
}

The default sort is by column `id` and descending

func (*SearchRequest_Sort) Descriptor deprecated

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

Deprecated: Use SearchRequest_Sort.ProtoReflect.Descriptor instead.

func (*SearchRequest_Sort) GetDirection

func (*SearchRequest_Sort) GetField

func (x *SearchRequest_Sort) GetField() string

func (*SearchRequest_Sort) ProtoMessage

func (*SearchRequest_Sort) ProtoMessage()

func (*SearchRequest_Sort) ProtoReflect

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

func (*SearchRequest_Sort) Reset

func (x *SearchRequest_Sort) Reset()

func (*SearchRequest_Sort) String

func (x *SearchRequest_Sort) String() string

func (*SearchRequest_Sort) Validate

func (m *SearchRequest_Sort) Validate() error

Validate checks the field values on SearchRequest_Sort with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*SearchRequest_Sort) ValidateAll

func (m *SearchRequest_Sort) ValidateAll() error

ValidateAll checks the field values on SearchRequest_Sort with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in SearchRequest_SortMultiError, or nil if none found.

type SearchRequest_SortMultiError

type SearchRequest_SortMultiError []error

SearchRequest_SortMultiError is an error wrapping multiple validation errors returned by SearchRequest_Sort.ValidateAll() if the designated constraints aren't met.

func (SearchRequest_SortMultiError) AllErrors

func (m SearchRequest_SortMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (SearchRequest_SortMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type SearchRequest_SortValidationError

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

SearchRequest_SortValidationError is the validation error returned by SearchRequest_Sort.Validate if the designated constraints aren't met.

func (SearchRequest_SortValidationError) Cause

Cause function returns cause value.

func (SearchRequest_SortValidationError) Error

Error satisfies the builtin error interface

func (SearchRequest_SortValidationError) ErrorName

ErrorName returns error name.

func (SearchRequest_SortValidationError) Field

Field function returns field value.

func (SearchRequest_SortValidationError) Key

Key function returns key value.

func (SearchRequest_SortValidationError) Reason

Reason function returns reason value.

type SearchRequest_Sort_Direction

type SearchRequest_Sort_Direction int32
const (
	SearchRequest_Sort_UNSPECIFIED SearchRequest_Sort_Direction = 0
	SearchRequest_Sort_ASCENDING   SearchRequest_Sort_Direction = 1
	SearchRequest_Sort_DESCENDING  SearchRequest_Sort_Direction = 2
)

func (SearchRequest_Sort_Direction) Descriptor

func (SearchRequest_Sort_Direction) Enum

func (SearchRequest_Sort_Direction) EnumDescriptor deprecated

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

Deprecated: Use SearchRequest_Sort_Direction.Descriptor instead.

func (SearchRequest_Sort_Direction) Number

func (SearchRequest_Sort_Direction) String

func (SearchRequest_Sort_Direction) Type

type SearchResponse

type SearchResponse struct {
	Resources     []*Resource `protobuf:"bytes,1,rep,name=resources,proto3" json:"resources,omitempty"`
	NextPageToken string      `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*SearchResponse) Descriptor deprecated

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

Deprecated: Use SearchResponse.ProtoReflect.Descriptor instead.

func (*SearchResponse) GetNextPageToken

func (x *SearchResponse) GetNextPageToken() string

func (*SearchResponse) GetResources

func (x *SearchResponse) GetResources() []*Resource

func (*SearchResponse) ProtoMessage

func (*SearchResponse) ProtoMessage()

func (*SearchResponse) ProtoReflect

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

func (*SearchResponse) Reset

func (x *SearchResponse) Reset()

func (*SearchResponse) String

func (x *SearchResponse) String() string

func (*SearchResponse) Validate

func (m *SearchResponse) Validate() error

Validate checks the field values on SearchResponse with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*SearchResponse) ValidateAll

func (m *SearchResponse) ValidateAll() error

ValidateAll checks the field values on SearchResponse with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in SearchResponseMultiError, or nil if none found.

type SearchResponseMultiError

type SearchResponseMultiError []error

SearchResponseMultiError is an error wrapping multiple validation errors returned by SearchResponse.ValidateAll() if the designated constraints aren't met.

func (SearchResponseMultiError) AllErrors

func (m SearchResponseMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (SearchResponseMultiError) Error

func (m SearchResponseMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type SearchResponseValidationError

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

SearchResponseValidationError is the validation error returned by SearchResponse.Validate if the designated constraints aren't met.

func (SearchResponseValidationError) Cause

Cause function returns cause value.

func (SearchResponseValidationError) Error

Error satisfies the builtin error interface

func (SearchResponseValidationError) ErrorName

func (e SearchResponseValidationError) ErrorName() string

ErrorName returns error name.

func (SearchResponseValidationError) Field

Field function returns field value.

func (SearchResponseValidationError) Key

Key function returns key value.

func (SearchResponseValidationError) Reason

Reason function returns reason value.

type TopologyAPIClient

type TopologyAPIClient interface {
	GetTopology(ctx context.Context, in *GetTopologyRequest, opts ...grpc.CallOption) (*GetTopologyResponse, error)
	Search(ctx context.Context, in *SearchRequest, opts ...grpc.CallOption) (*SearchResponse, error)
}

TopologyAPIClient is the client API for TopologyAPI service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

type TopologyAPIServer

type TopologyAPIServer interface {
	GetTopology(context.Context, *GetTopologyRequest) (*GetTopologyResponse, error)
	Search(context.Context, *SearchRequest) (*SearchResponse, error)
}

TopologyAPIServer is the server API for TopologyAPI service. All implementations should embed UnimplementedTopologyAPIServer for forward compatibility

type UnimplementedTopologyAPIServer

type UnimplementedTopologyAPIServer struct {
}

UnimplementedTopologyAPIServer should be embedded to have forward compatible implementations.

func (UnimplementedTopologyAPIServer) GetTopology

func (UnimplementedTopologyAPIServer) Search

type UnsafeTopologyAPIServer

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

UnsafeTopologyAPIServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to TopologyAPIServer will result in compilation errors.

type UpdateCacheRequest

type UpdateCacheRequest struct {
	Resource *Resource `protobuf:"bytes,1,opt,name=resource,proto3" json:"resource,omitempty"`
	// Action denotes what the topology service should do with this object.
	Action UpdateCacheRequest_Action `protobuf:"varint,2,opt,name=action,proto3,enum=clutch.topology.v1.UpdateCacheRequest_Action" json:"action,omitempty"`
	// contains filtered or unexported fields
}

A UpdateCacheRequest is used when a service such as kubernetes or aws produces objects for the topology API to cache.

func (*UpdateCacheRequest) Descriptor deprecated

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

Deprecated: Use UpdateCacheRequest.ProtoReflect.Descriptor instead.

func (*UpdateCacheRequest) GetAction

func (*UpdateCacheRequest) GetResource

func (x *UpdateCacheRequest) GetResource() *Resource

func (*UpdateCacheRequest) ProtoMessage

func (*UpdateCacheRequest) ProtoMessage()

func (*UpdateCacheRequest) ProtoReflect

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

func (*UpdateCacheRequest) Reset

func (x *UpdateCacheRequest) Reset()

func (*UpdateCacheRequest) String

func (x *UpdateCacheRequest) String() string

func (*UpdateCacheRequest) Validate

func (m *UpdateCacheRequest) Validate() error

Validate checks the field values on UpdateCacheRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*UpdateCacheRequest) ValidateAll

func (m *UpdateCacheRequest) ValidateAll() error

ValidateAll checks the field values on UpdateCacheRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in UpdateCacheRequestMultiError, or nil if none found.

type UpdateCacheRequestMultiError

type UpdateCacheRequestMultiError []error

UpdateCacheRequestMultiError is an error wrapping multiple validation errors returned by UpdateCacheRequest.ValidateAll() if the designated constraints aren't met.

func (UpdateCacheRequestMultiError) AllErrors

func (m UpdateCacheRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (UpdateCacheRequestMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type UpdateCacheRequestValidationError

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

UpdateCacheRequestValidationError is the validation error returned by UpdateCacheRequest.Validate if the designated constraints aren't met.

func (UpdateCacheRequestValidationError) Cause

Cause function returns cause value.

func (UpdateCacheRequestValidationError) Error

Error satisfies the builtin error interface

func (UpdateCacheRequestValidationError) ErrorName

ErrorName returns error name.

func (UpdateCacheRequestValidationError) Field

Field function returns field value.

func (UpdateCacheRequestValidationError) Key

Key function returns key value.

func (UpdateCacheRequestValidationError) Reason

Reason function returns reason value.

type UpdateCacheRequest_Action

type UpdateCacheRequest_Action int32

Action signifies to the topology service what to do with an incoming topology Resource

The topology service gets a topology Resource off of the `GetTopologyObjectChannel` which is processed and stored in the topology_cache table.

const (
	UpdateCacheRequest_UNSPECIFIED      UpdateCacheRequest_Action = 0
	UpdateCacheRequest_CREATE_OR_UPDATE UpdateCacheRequest_Action = 1
	UpdateCacheRequest_DELETE           UpdateCacheRequest_Action = 2
)

func (UpdateCacheRequest_Action) Descriptor

func (UpdateCacheRequest_Action) Enum

func (UpdateCacheRequest_Action) EnumDescriptor deprecated

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

Deprecated: Use UpdateCacheRequest_Action.Descriptor instead.

func (UpdateCacheRequest_Action) Number

func (UpdateCacheRequest_Action) String

func (x UpdateCacheRequest_Action) String() string

func (UpdateCacheRequest_Action) Type

Jump to

Keyboard shortcuts

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