rpc

package
v0.2.5 Latest Latest
Warning

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

 Go to latest Published: Aug 31, 2023 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	Search_Index_FullMethodName = "/google.cloud.apigeeregistry.v1.Search/Index"
	Search_Query_FullMethodName = "/google.cloud.apigeeregistry.v1.Search/Query"
)

Variables

View Source 
var File_google_cloud_apigeeregistry_v1_analysis_diff_analytics_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_apigeeregistry_v1_search_service_proto protoreflect.FileDescriptor
View Source 
var Search_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.apigeeregistry.v1.Search",
	HandlerType: (*SearchServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Index",
			Handler:    _Search_Index_Handler,
		},
		{
			MethodName: "Query",
			Handler:    _Search_Query_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/apigeeregistry/v1/search_service.proto",
}

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

Functions

func RegisterSearchServer 

func RegisterSearchServer(s grpc.ServiceRegistrar, srv SearchServer)

Types

type ChangeDetails added in v0.2.1 

type ChangeDetails struct {

	// breakingChanges is a Diff proto that only contains the breaking changes
	// of a diff.
	BreakingChanges *Diff `protobuf:"bytes,1,opt,name=breaking_changes,json=breakingChanges,proto3" json:"breaking_changes,omitempty"`
	// nonBreakingChanges is a Diff proto that only contains the non-breaking
	// changes of a diff.
	NonBreakingChanges *Diff `protobuf:"bytes,2,opt,name=non_breaking_changes,json=nonBreakingChanges,proto3" json:"non_breaking_changes,omitempty"`
	// unknownChanges is a Diff proto that contains all the changes that could not
	// be classified in the other categories.
	UnknownChanges *Diff `protobuf:"bytes,3,opt,name=unknown_changes,json=unknownChanges,proto3" json:"unknown_changes,omitempty"`
	// contains filtered or unexported fields
}

ChangeDetails classifies changes from diff into separate categories.

func (*ChangeDetails) Descriptor deprecated added in v0.2.1 

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

Deprecated: Use ChangeDetails.ProtoReflect.Descriptor instead.

func (*ChangeDetails) GetBreakingChanges added in v0.2.1 

func (x *ChangeDetails) GetBreakingChanges() *Diff

func (*ChangeDetails) GetNonBreakingChanges added in v0.2.1 

func (x *ChangeDetails) GetNonBreakingChanges() *Diff

func (*ChangeDetails) GetUnknownChanges added in v0.2.1 

func (x *ChangeDetails) GetUnknownChanges() *Diff

func (*ChangeDetails) ProtoMessage added in v0.2.1 

func (*ChangeDetails) ProtoMessage()

func (*ChangeDetails) ProtoReflect added in v0.2.1 

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

func (*ChangeDetails) Reset added in v0.2.1 

func (x *ChangeDetails) Reset()

func (*ChangeDetails) String added in v0.2.1 

func (x *ChangeDetails) String() string

type ChangeMetrics added in v0.2.1 

type ChangeMetrics struct {

	// breaking_change_percentage is the percentage of changes that are breaking.
	// It is computed by the equation
	// (breaking_change_count / (nonbreaking_change_count + breaking_change_count))
	BreakingChangePercentage float64 `` /* 137-byte string literal not displayed */
	// breaking_change_rate is the average number of breaking changes that are
	// introduced per Diff.
	// It is computed by the equation
	// ((nonbreaking_change_count + breaking_change_count) / diff_count)
	BreakingChangeRate float64 `protobuf:"fixed64,2,opt,name=breaking_change_rate,json=breakingChangeRate,proto3" json:"breaking_change_rate,omitempty"`
	// contains filtered or unexported fields
}

ChangeMetrics holds metrics about a list of diffs. Each metric is computed from two or more stats.

func (*ChangeMetrics) Descriptor deprecated added in v0.2.1 

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

Deprecated: Use ChangeMetrics.ProtoReflect.Descriptor instead.

func (*ChangeMetrics) GetBreakingChangePercentage added in v0.2.1 

func (x *ChangeMetrics) GetBreakingChangePercentage() float64

func (*ChangeMetrics) GetBreakingChangeRate added in v0.2.1 

func (x *ChangeMetrics) GetBreakingChangeRate() float64

func (*ChangeMetrics) ProtoMessage added in v0.2.1 

func (*ChangeMetrics) ProtoMessage()

func (*ChangeMetrics) ProtoReflect added in v0.2.1 

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

func (*ChangeMetrics) Reset added in v0.2.1 

func (x *ChangeMetrics) Reset()

func (*ChangeMetrics) String added in v0.2.1 

func (x *ChangeMetrics) String() string

type ChangeStats added in v0.2.1 

type ChangeStats struct {

	// breaking_change_count represents the total number of breaking changes.
	BreakingChangeCount int64 `protobuf:"varint,1,opt,name=breaking_change_count,json=breakingChangeCount,proto3" json:"breaking_change_count,omitempty"`
	// nonbreaking_change_count represents the total number of non-breaking changes.
	NonbreakingChangeCount int64 `` /* 130-byte string literal not displayed */
	// diff_count represents the number of diffs used in this stats
	DiffCount int64 `protobuf:"varint,3,opt,name=diff_count,json=diffCount,proto3" json:"diff_count,omitempty"`
	// contains filtered or unexported fields
}

ChangeStats holds information relating to a list of diffs

func (*ChangeStats) Descriptor deprecated added in v0.2.1 

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

Deprecated: Use ChangeStats.ProtoReflect.Descriptor instead.

func (*ChangeStats) GetBreakingChangeCount added in v0.2.1 

func (x *ChangeStats) GetBreakingChangeCount() int64

func (*ChangeStats) GetDiffCount added in v0.2.1 

func (x *ChangeStats) GetDiffCount() int64

func (*ChangeStats) GetNonbreakingChangeCount added in v0.2.1 

func (x *ChangeStats) GetNonbreakingChangeCount() int64

func (*ChangeStats) ProtoMessage added in v0.2.1 

func (*ChangeStats) ProtoMessage()

func (*ChangeStats) ProtoReflect added in v0.2.1 

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

func (*ChangeStats) Reset added in v0.2.1 

func (x *ChangeStats) Reset()

func (*ChangeStats) String added in v0.2.1 

func (x *ChangeStats) String() string

type Diff added in v0.2.1 

type Diff struct {

	// additions holds every addition change in the diff.
	// The string will hold the entire field path of one addition change in the
	// format foo.bar.x .
	Additions []string `protobuf:"bytes,1,rep,name=additions,proto3" json:"additions,omitempty"`
	// deletions holds every deletion change in the diff.
	// The string will hold the entire field path of one deletion change in the
	// format foo.bar.x .
	Deletions []string `protobuf:"bytes,2,rep,name=deletions,proto3" json:"deletions,omitempty"`
	// modifications holds every modification change in the diff.
	// The string key will hold the field path of one modification change in the
	// format foo.bar.x.
	// The value of the key will represent the element that was modified in the
	// field.
	Modifications map[string]*Diff_ValueChange `` /* 167-byte string literal not displayed */
	// contains filtered or unexported fields
}

Diff contains the diff of a spec and its revision.

func (*Diff) Descriptor deprecated added in v0.2.1 

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

Deprecated: Use Diff.ProtoReflect.Descriptor instead.

func (*Diff) GetAdditions added in v0.2.1 

func (x *Diff) GetAdditions() []string

func (*Diff) GetDeletions added in v0.2.1 

func (x *Diff) GetDeletions() []string

func (*Diff) GetModifications added in v0.2.1 

func (x *Diff) GetModifications() map[string]*Diff_ValueChange

func (*Diff) ProtoMessage added in v0.2.1 

func (*Diff) ProtoMessage()

func (*Diff) ProtoReflect added in v0.2.1 

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

func (*Diff) Reset added in v0.2.1 

func (x *Diff) Reset()

func (*Diff) String added in v0.2.1 

func (x *Diff) String() string

type Diff_ValueChange added in v0.2.1 

type Diff_ValueChange struct {

	// from represents the previous value of the element.
	From string `protobuf:"bytes,1,opt,name=from,proto3" json:"from,omitempty"`
	// to represents the current value of the element.
	To string `protobuf:"bytes,2,opt,name=to,proto3" json:"to,omitempty"`
	// contains filtered or unexported fields
}

ValueChange hold the values of the elements that changed in one diff change.

func (*Diff_ValueChange) Descriptor deprecated added in v0.2.1 

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

Deprecated: Use Diff_ValueChange.ProtoReflect.Descriptor instead.

func (*Diff_ValueChange) GetFrom added in v0.2.1 

func (x *Diff_ValueChange) GetFrom() string

func (*Diff_ValueChange) GetTo added in v0.2.1 

func (x *Diff_ValueChange) GetTo() string

func (*Diff_ValueChange) ProtoMessage added in v0.2.1 

func (*Diff_ValueChange) ProtoMessage()

func (*Diff_ValueChange) ProtoReflect added in v0.2.1 

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

func (*Diff_ValueChange) Reset added in v0.2.1 

func (x *Diff_ValueChange) Reset()

func (*Diff_ValueChange) String added in v0.2.1 

func (x *Diff_ValueChange) String() string

type IndexMetadata 

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

Metadata for Index method.

func (*IndexMetadata) Descriptor deprecated 

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

Deprecated: Use IndexMetadata.ProtoReflect.Descriptor instead.

func (*IndexMetadata) ProtoMessage 

func (*IndexMetadata) ProtoMessage()

func (*IndexMetadata) ProtoReflect 

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

func (*IndexMetadata) Reset 

func (x *IndexMetadata) Reset()

func (*IndexMetadata) String 

func (x *IndexMetadata) String() string

type IndexRequest 

type IndexRequest struct {
	ResourceName string `protobuf:"bytes,1,opt,name=resource_name,json=resourceName,proto3" json:"resource_name,omitempty"`
	// contains filtered or unexported fields
}

Request for Index method.

func (*IndexRequest) Descriptor deprecated 

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

Deprecated: Use IndexRequest.ProtoReflect.Descriptor instead.

func (*IndexRequest) GetResourceName 

func (x *IndexRequest) GetResourceName() string

func (*IndexRequest) ProtoMessage 

func (*IndexRequest) ProtoMessage()

func (*IndexRequest) ProtoReflect 

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

func (*IndexRequest) Reset 

func (x *IndexRequest) Reset()

func (*IndexRequest) String 

func (x *IndexRequest) String() string

type IndexResponse 

type IndexResponse struct {
	Status string `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// Additional message, e.g. if search is not available
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

Response for Index method.

func (*IndexResponse) Descriptor deprecated 

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

Deprecated: Use IndexResponse.ProtoReflect.Descriptor instead.

func (*IndexResponse) GetMessage 

func (x *IndexResponse) GetMessage() string

func (*IndexResponse) GetStatus 

func (x *IndexResponse) GetStatus() string

func (*IndexResponse) ProtoMessage 

func (*IndexResponse) ProtoMessage()

func (*IndexResponse) ProtoReflect 

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

func (*IndexResponse) Reset 

func (x *IndexResponse) Reset()

func (*IndexResponse) String 

func (x *IndexResponse) String() string

type QueryRequest 

type QueryRequest struct {

	// Search query string
	Q string `protobuf:"bytes,1,opt,name=q,proto3" json:"q,omitempty"`
	// Page size
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Page token
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request for Query method.

func (*QueryRequest) Descriptor deprecated 

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

Deprecated: Use QueryRequest.ProtoReflect.Descriptor instead.

func (*QueryRequest) GetPageSize 

func (x *QueryRequest) GetPageSize() int32

func (*QueryRequest) GetPageToken 

func (x *QueryRequest) GetPageToken() string

func (*QueryRequest) GetQ 

func (x *QueryRequest) GetQ() string

func (*QueryRequest) ProtoMessage 

func (*QueryRequest) ProtoMessage()

func (*QueryRequest) ProtoReflect 

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

func (*QueryRequest) Reset 

func (x *QueryRequest) Reset()

func (*QueryRequest) String 

func (x *QueryRequest) String() string

type QueryResponse 

type QueryResponse struct {

	// Search results
	Results []*QueryResponse_Result `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"`
	// Next page token
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// Additional message, e.g. if search is not available
	Message string `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

Response for Query method.

func (*QueryResponse) Descriptor deprecated 

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

Deprecated: Use QueryResponse.ProtoReflect.Descriptor instead.

func (*QueryResponse) GetMessage 

func (x *QueryResponse) GetMessage() string

func (*QueryResponse) GetNextPageToken 

func (x *QueryResponse) GetNextPageToken() string

func (*QueryResponse) GetResults 

func (x *QueryResponse) GetResults() []*QueryResponse_Result

func (*QueryResponse) ProtoMessage 

func (*QueryResponse) ProtoMessage()

func (*QueryResponse) ProtoReflect 

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

func (*QueryResponse) Reset 

func (x *QueryResponse) Reset()

func (*QueryResponse) String 

func (x *QueryResponse) String() string

type QueryResponse_Result 

type QueryResponse_Result struct {

	// Key of matching entity
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// Excerpt of matching text
	Excerpt string `protobuf:"bytes,2,opt,name=excerpt,proto3" json:"excerpt,omitempty"`
	// contains filtered or unexported fields
}

Result of query

func (*QueryResponse_Result) Descriptor deprecated 

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

Deprecated: Use QueryResponse_Result.ProtoReflect.Descriptor instead.

func (*QueryResponse_Result) GetExcerpt 

func (x *QueryResponse_Result) GetExcerpt() string

func (*QueryResponse_Result) GetKey 

func (x *QueryResponse_Result) GetKey() string

func (*QueryResponse_Result) ProtoMessage 

func (*QueryResponse_Result) ProtoMessage()

func (*QueryResponse_Result) ProtoReflect 

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

func (*QueryResponse_Result) Reset 

func (x *QueryResponse_Result) Reset()

func (*QueryResponse_Result) String 

func (x *QueryResponse_Result) String() string

type SearchClient 

type SearchClient interface {
	// Add a resource to the search index.
	Index(ctx context.Context, in *IndexRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Query the index.
	Query(ctx context.Context, in *QueryRequest, opts ...grpc.CallOption) (*QueryResponse, error)
}

SearchClient is the client API for Search 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.

func NewSearchClient 

func NewSearchClient(cc grpc.ClientConnInterface) SearchClient

type SearchServer 

type SearchServer interface {
	// Add a resource to the search index.
	Index(context.Context, *IndexRequest) (*longrunning.Operation, error)
	// Query the index.
	Query(context.Context, *QueryRequest) (*QueryResponse, error)
	// contains filtered or unexported methods
}

SearchServer is the server API for Search service. All implementations must embed UnimplementedSearchServer for forward compatibility

type UnimplementedSearchServer 

type UnimplementedSearchServer struct {
}

UnimplementedSearchServer must be embedded to have forward compatible implementations.

func (UnimplementedSearchServer) Index 

func (UnimplementedSearchServer) Index(context.Context, *IndexRequest) (*longrunning.Operation, error)

func (UnimplementedSearchServer) Query 

func (UnimplementedSearchServer) Query(context.Context, *QueryRequest) (*QueryResponse, error)

type UnsafeSearchServer 

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

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.