api

package
v1.0.0-beta.26 Latest Latest
Warning

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

Go to latest
Published: Mar 31, 2023 License: Apache-2.0 Imports: 30 Imported by: 4

Documentation

Overview

Package api is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Package api is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Package api is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Package api is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Package api is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Package api is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Package api is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Package api is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source
const (
	// HeaderRequestTimeout is an end-to-end request header that indicates the maximum time that a client is
	// prepared to await a response. The value of the header is in seconds. A client is allowed to send fractional
	// values. For ex, 0.1 means 100milliseconds.
	HeaderRequestTimeout = "Request-Timeout"

	HeaderAccessControlAllowOrigin = "Access-Control-Allow-Origin"
	HeaderAuthorization            = "authorization"

	SetCookie = "Set-Cookie"
	Cookie    = "Cookie"

	HeaderPrefix = "Tigris-"

	HeaderTxID     = "Tigris-Tx-Id"
	HeaderTxOrigin = "Tigris-Tx-Origin"

	HeaderSchemaSignOff = "Tigris-Schema-Sign-Off"
)
View Source
const (
	HealthMethodName = "/HealthAPI/Health"

	InsertMethodName  = apiMethodPrefix + "Insert"
	ReplaceMethodName = apiMethodPrefix + "Replace"
	UpdateMethodName  = apiMethodPrefix + "Update"
	DeleteMethodName  = apiMethodPrefix + "Delete"
	ReadMethodName    = apiMethodPrefix + "Read"

	SearchMethodName = apiMethodPrefix + "Search"

	SubscribeMethodName = apiMethodPrefix + "Subscribe"

	EventsMethodName = apiMethodPrefix + "Events"

	CommitTransactionMethodName   = apiMethodPrefix + "CommitTransaction"
	RollbackTransactionMethodName = apiMethodPrefix + "RollbackTransaction"

	CreateOrUpdateCollectionMethodName = apiMethodPrefix + "CreateOrUpdateCollection"
	DropCollectionMethodName           = apiMethodPrefix + "DropCollection"

	DropDatabaseMethodName = apiMethodPrefix + "DropDatabase"

	ListDatabasesMethodName   = apiMethodPrefix + "ListDatabases"
	ListCollectionsMethodName = apiMethodPrefix + "ListCollections"

	DescribeDatabaseMethodName   = apiMethodPrefix + "DescribeDatabase"
	DescribeCollectionMethodName = apiMethodPrefix + "DescribeCollection"

	ObservabilityMethodPrefix    = "/tigrisdata.observability.v1.Observability/"
	ManagementMethodPrefix       = "/tigrisdata.management.v1.Management/"
	CreateNamespaceMethodName    = ManagementMethodPrefix + "CreateNamespace"
	ListNamespaceMethodName      = ManagementMethodPrefix + "ListNamespaces"
	DescribeNamespacesMethodName = ManagementMethodPrefix + "DescribeNamespaces"

	AuthMethodPrefix         = "/tigrisdata.auth.v1.Auth/"
	GetAccessTokenMethodName = AuthMethodPrefix + "GetAccessToken"
)

Variables

View Source
var (
	GrantType_name = map[int32]string{
		0: "REFRESH_TOKEN",
		1: "CLIENT_CREDENTIALS",
	}
	GrantType_value = map[string]int32{
		"REFRESH_TOKEN":      0,
		"CLIENT_CREDENTIALS": 1,
	}
)

Enum value maps for GrantType.

View Source
var (
	Code_name = map[int32]string{
		0:  "OK",
		1:  "CANCELLED",
		2:  "UNKNOWN",
		3:  "INVALID_ARGUMENT",
		4:  "DEADLINE_EXCEEDED",
		5:  "NOT_FOUND",
		6:  "ALREADY_EXISTS",
		7:  "PERMISSION_DENIED",
		8:  "RESOURCE_EXHAUSTED",
		9:  "FAILED_PRECONDITION",
		10: "ABORTED",
		11: "OUT_OF_RANGE",
		12: "UNIMPLEMENTED",
		13: "INTERNAL",
		14: "UNAVAILABLE",
		15: "DATA_LOSS",
		16: "UNAUTHENTICATED",
		17: "CONFLICT",
		18: "BAD_GATEWAY",
		19: "METHOD_NOT_ALLOWED",
		20: "CONTENT_TOO_LARGE",
	}
	Code_value = map[string]int32{
		"OK":                  0,
		"CANCELLED":           1,
		"UNKNOWN":             2,
		"INVALID_ARGUMENT":    3,
		"DEADLINE_EXCEEDED":   4,
		"NOT_FOUND":           5,
		"ALREADY_EXISTS":      6,
		"PERMISSION_DENIED":   7,
		"RESOURCE_EXHAUSTED":  8,
		"FAILED_PRECONDITION": 9,
		"ABORTED":             10,
		"OUT_OF_RANGE":        11,
		"UNIMPLEMENTED":       12,
		"INTERNAL":            13,
		"UNAVAILABLE":         14,
		"DATA_LOSS":           15,
		"UNAUTHENTICATED":     16,
		"CONFLICT":            17,
		"BAD_GATEWAY":         18,
		"METHOD_NOT_ALLOWED":  19,
		"CONTENT_TOO_LARGE":   20,
	}
)

Enum value maps for Code.

View Source
var (
	TigrisOperation_name = map[int32]string{
		0: "ALL",
		1: "READ",
		2: "WRITE",
		3: "METADATA",
	}
	TigrisOperation_value = map[string]int32{
		"ALL":      0,
		"READ":     1,
		"WRITE":    2,
		"METADATA": 3,
	}
)

Enum value maps for TigrisOperation.

View Source
var (
	MetricQueryFunction_name = map[int32]string{
		0: "RATE",
		1: "COUNT",
		2: "NONE",
	}
	MetricQueryFunction_value = map[string]int32{
		"RATE":  0,
		"COUNT": 1,
		"NONE":  2,
	}
)

Enum value maps for MetricQueryFunction.

View Source
var (
	RollupAggregator_name = map[int32]string{
		0: "ROLLUP_AGGREGATOR_SUM",
		1: "ROLLUP_AGGREGATOR_COUNT",
		2: "ROLLUP_AGGREGATOR_MIN",
		3: "ROLLUP_AGGREGATOR_MAX",
		4: "ROLLUP_AGGREGATOR_AVG",
	}
	RollupAggregator_value = map[string]int32{
		"ROLLUP_AGGREGATOR_SUM":   0,
		"ROLLUP_AGGREGATOR_COUNT": 1,
		"ROLLUP_AGGREGATOR_MIN":   2,
		"ROLLUP_AGGREGATOR_MAX":   3,
		"ROLLUP_AGGREGATOR_AVG":   4,
	}
)

Enum value maps for RollupAggregator.

View Source
var (
	MetricQuerySpaceAggregation_name = map[int32]string{
		0: "AVG",
		1: "MIN",
		2: "MAX",
		3: "SUM",
	}
	MetricQuerySpaceAggregation_value = map[string]int32{
		"AVG": 0,
		"MIN": 1,
		"MAX": 2,
		"SUM": 3,
	}
)

Enum value maps for MetricQuerySpaceAggregation.

View Source
var (
	EventType_name = map[int32]string{
		0:  "ack",
		1:  "auth",
		2:  "error",
		3:  "message",
		4:  "subscribe",
		5:  "presence",
		6:  "presence_member",
		7:  "subscribed",
		8:  "unsubscribe",
		9:  "heartbeat",
		11: "connected",
		12: "disconnect",
		13: "disconnected",
		14: "attach",
		15: "detach",
	}
	EventType_value = map[string]int32{
		"ack":             0,
		"auth":            1,
		"error":           2,
		"message":         3,
		"subscribe":       4,
		"presence":        5,
		"presence_member": 6,
		"subscribed":      7,
		"unsubscribe":     8,
		"heartbeat":       9,
		"connected":       11,
		"disconnect":      12,
		"disconnected":    13,
		"attach":          14,
		"detach":          15,
	}
)

Enum value maps for EventType.

View Source
var (
	PresenceActions_name = map[int32]string{
		0: "present",
		1: "enter",
		2: "leave",
		3: "update",
	}
	PresenceActions_value = map[string]int32{
		"present": 0,
		"enter":   1,
		"leave":   2,
		"update":  3,
	}
)

Enum value maps for PresenceActions.

View Source
var Auth_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "tigrisdata.auth.v1.Auth",
	HandlerType: (*AuthServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetAccessToken",
			Handler:    _Auth_GetAccessToken_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "server/v1/auth.proto",
}

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

View Source
var Cache_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "tigrisdata.cache.v1.Cache",
	HandlerType: (*CacheServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateCache",
			Handler:    _Cache_CreateCache_Handler,
		},
		{
			MethodName: "ListCaches",
			Handler:    _Cache_ListCaches_Handler,
		},
		{
			MethodName: "DeleteCache",
			Handler:    _Cache_DeleteCache_Handler,
		},
		{
			MethodName: "Set",
			Handler:    _Cache_Set_Handler,
		},
		{
			MethodName: "GetSet",
			Handler:    _Cache_GetSet_Handler,
		},
		{
			MethodName: "Get",
			Handler:    _Cache_Get_Handler,
		},
		{
			MethodName: "Del",
			Handler:    _Cache_Del_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "Keys",
			Handler:       _Cache_Keys_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "server/v1/cache.proto",
}

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

View Source
var File_server_v1_api_proto protoreflect.FileDescriptor
View Source
var File_server_v1_auth_proto protoreflect.FileDescriptor
View Source
var File_server_v1_cache_proto protoreflect.FileDescriptor
View Source
var File_server_v1_health_proto protoreflect.FileDescriptor
View Source
var File_server_v1_management_proto protoreflect.FileDescriptor
View Source
var File_server_v1_observability_proto protoreflect.FileDescriptor
View Source
var File_server_v1_realtime_proto protoreflect.FileDescriptor
View Source
var File_server_v1_search_proto protoreflect.FileDescriptor
View Source
var HealthAPI_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "HealthAPI",
	HandlerType: (*HealthAPIServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Health",
			Handler:    _HealthAPI_Health_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "server/v1/health.proto",
}

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

View Source
var Management_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "tigrisdata.management.v1.Management",
	HandlerType: (*ManagementServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateNamespace",
			Handler:    _Management_CreateNamespace_Handler,
		},
		{
			MethodName: "DescribeNamespaces",
			Handler:    _Management_DescribeNamespaces_Handler,
		},
		{
			MethodName: "ListNamespaces",
			Handler:    _Management_ListNamespaces_Handler,
		},
		{
			MethodName: "InsertUserMetadata",
			Handler:    _Management_InsertUserMetadata_Handler,
		},
		{
			MethodName: "GetUserMetadata",
			Handler:    _Management_GetUserMetadata_Handler,
		},
		{
			MethodName: "UpdateUserMetadata",
			Handler:    _Management_UpdateUserMetadata_Handler,
		},
		{
			MethodName: "InsertNamespaceMetadata",
			Handler:    _Management_InsertNamespaceMetadata_Handler,
		},
		{
			MethodName: "GetNamespaceMetadata",
			Handler:    _Management_GetNamespaceMetadata_Handler,
		},
		{
			MethodName: "UpdateNamespaceMetadata",
			Handler:    _Management_UpdateNamespaceMetadata_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "server/v1/management.proto",
}

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

View Source
var Observability_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "tigrisdata.observability.v1.Observability",
	HandlerType: (*ObservabilityServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "QueryTimeSeriesMetrics",
			Handler:    _Observability_QueryTimeSeriesMetrics_Handler,
		},
		{
			MethodName: "QuotaLimits",
			Handler:    _Observability_QuotaLimits_Handler,
		},
		{
			MethodName: "QuotaUsage",
			Handler:    _Observability_QuotaUsage_Handler,
		},
		{
			MethodName: "GetInfo",
			Handler:    _Observability_GetInfo_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "server/v1/observability.proto",
}

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

View Source
var Realtime_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "tigrisdata.realtime.v1.Realtime",
	HandlerType: (*RealtimeServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Presence",
			Handler:    _Realtime_Presence_Handler,
		},
		{
			MethodName: "GetRTChannel",
			Handler:    _Realtime_GetRTChannel_Handler,
		},
		{
			MethodName: "GetRTChannels",
			Handler:    _Realtime_GetRTChannels_Handler,
		},
		{
			MethodName: "Messages",
			Handler:    _Realtime_Messages_Handler,
		},
		{
			MethodName: "ListSubscriptions",
			Handler:    _Realtime_ListSubscriptions_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "ReadMessages",
			Handler:       _Realtime_ReadMessages_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "server/v1/realtime.proto",
}

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

View Source
var Search_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "tigrisdata.search.v1.Search",
	HandlerType: (*SearchServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateOrUpdateIndex",
			Handler:    _Search_CreateOrUpdateIndex_Handler,
		},
		{
			MethodName: "GetIndex",
			Handler:    _Search_GetIndex_Handler,
		},
		{
			MethodName: "DeleteIndex",
			Handler:    _Search_DeleteIndex_Handler,
		},
		{
			MethodName: "ListIndexes",
			Handler:    _Search_ListIndexes_Handler,
		},
		{
			MethodName: "Get",
			Handler:    _Search_Get_Handler,
		},
		{
			MethodName: "CreateById",
			Handler:    _Search_CreateById_Handler,
		},
		{
			MethodName: "Create",
			Handler:    _Search_Create_Handler,
		},
		{
			MethodName: "CreateOrReplace",
			Handler:    _Search_CreateOrReplace_Handler,
		},
		{
			MethodName: "Update",
			Handler:    _Search_Update_Handler,
		},
		{
			MethodName: "Delete",
			Handler:    _Search_Delete_Handler,
		},
		{
			MethodName: "DeleteByQuery",
			Handler:    _Search_DeleteByQuery_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "Search",
			Handler:       _Search_Search_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "server/v1/search.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)

View Source
var Tigris_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "tigrisdata.v1.Tigris",
	HandlerType: (*TigrisServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "BeginTransaction",
			Handler:    _Tigris_BeginTransaction_Handler,
		},
		{
			MethodName: "CommitTransaction",
			Handler:    _Tigris_CommitTransaction_Handler,
		},
		{
			MethodName: "RollbackTransaction",
			Handler:    _Tigris_RollbackTransaction_Handler,
		},
		{
			MethodName: "Insert",
			Handler:    _Tigris_Insert_Handler,
		},
		{
			MethodName: "Replace",
			Handler:    _Tigris_Replace_Handler,
		},
		{
			MethodName: "Delete",
			Handler:    _Tigris_Delete_Handler,
		},
		{
			MethodName: "Update",
			Handler:    _Tigris_Update_Handler,
		},
		{
			MethodName: "Import",
			Handler:    _Tigris_Import_Handler,
		},
		{
			MethodName: "CreateOrUpdateCollection",
			Handler:    _Tigris_CreateOrUpdateCollection_Handler,
		},
		{
			MethodName: "DropCollection",
			Handler:    _Tigris_DropCollection_Handler,
		},
		{
			MethodName: "ListProjects",
			Handler:    _Tigris_ListProjects_Handler,
		},
		{
			MethodName: "ListCollections",
			Handler:    _Tigris_ListCollections_Handler,
		},
		{
			MethodName: "CreateProject",
			Handler:    _Tigris_CreateProject_Handler,
		},
		{
			MethodName: "DeleteProject",
			Handler:    _Tigris_DeleteProject_Handler,
		},
		{
			MethodName: "DescribeDatabase",
			Handler:    _Tigris_DescribeDatabase_Handler,
		},
		{
			MethodName: "CreateBranch",
			Handler:    _Tigris_CreateBranch_Handler,
		},
		{
			MethodName: "DeleteBranch",
			Handler:    _Tigris_DeleteBranch_Handler,
		},
		{
			MethodName: "ListBranches",
			Handler:    _Tigris_ListBranches_Handler,
		},
		{
			MethodName: "DescribeCollection",
			Handler:    _Tigris_DescribeCollection_Handler,
		},
		{
			MethodName: "CreateAppKey",
			Handler:    _Tigris_CreateAppKey_Handler,
		},
		{
			MethodName: "UpdateAppKey",
			Handler:    _Tigris_UpdateAppKey_Handler,
		},
		{
			MethodName: "DeleteAppKey",
			Handler:    _Tigris_DeleteAppKey_Handler,
		},
		{
			MethodName: "ListAppKeys",
			Handler:    _Tigris_ListAppKeys_Handler,
		},
		{
			MethodName: "RotateAppKeySecret",
			Handler:    _Tigris_RotateAppKeySecret_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "Read",
			Handler:       _Tigris_Read_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "Search",
			Handler:       _Tigris_Search_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "server/v1/api.proto",
}

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

Functions

func CodeToString

func CodeToString(c Code) string

CodeToString convert Tigris error code into string representation.

func CustomMatcher

func CustomMatcher(key string) (string, bool)

func GetHeader

func GetHeader(ctx context.Context, header string) string

func IsTxSupported

func IsTxSupported(ctx context.Context) bool

func MarshalStatus

func MarshalStatus(status *spb.Status) ([]byte, error)

MarshalStatus marshal status object.

func RegisterAuthHandler

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

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

func RegisterAuthHandlerClient

func RegisterAuthHandlerClient(ctx context.Context, mux *runtime.ServeMux, client AuthClient) error

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

func RegisterAuthHandlerFromEndpoint

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

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

func RegisterAuthHandlerServer

func RegisterAuthHandlerServer(ctx context.Context, mux *runtime.ServeMux, server AuthServer) error

RegisterAuthHandlerServer registers the http handlers for service Auth to "mux". UnaryRPC :call AuthServer 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 RegisterAuthHandlerFromEndpoint instead.

func RegisterAuthServer

func RegisterAuthServer(s grpc.ServiceRegistrar, srv AuthServer)

func RegisterCacheHandler

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

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

func RegisterCacheHandlerClient

func RegisterCacheHandlerClient(ctx context.Context, mux *runtime.ServeMux, client CacheClient) error

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

func RegisterCacheHandlerFromEndpoint

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

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

func RegisterCacheHandlerServer

func RegisterCacheHandlerServer(ctx context.Context, mux *runtime.ServeMux, server CacheServer) error

RegisterCacheHandlerServer registers the http handlers for service Cache to "mux". UnaryRPC :call CacheServer 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 RegisterCacheHandlerFromEndpoint instead.

func RegisterCacheServer

func RegisterCacheServer(s grpc.ServiceRegistrar, srv CacheServer)

func RegisterHealthAPIHandler

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

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

func RegisterHealthAPIHandlerClient

func RegisterHealthAPIHandlerClient(ctx context.Context, mux *runtime.ServeMux, client HealthAPIClient) error

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

func RegisterHealthAPIHandlerFromEndpoint

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

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

func RegisterHealthAPIHandlerServer

func RegisterHealthAPIHandlerServer(ctx context.Context, mux *runtime.ServeMux, server HealthAPIServer) error

RegisterHealthAPIHandlerServer registers the http handlers for service HealthAPI to "mux". UnaryRPC :call HealthAPIServer 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 RegisterHealthAPIHandlerFromEndpoint instead.

func RegisterHealthAPIServer

func RegisterHealthAPIServer(s grpc.ServiceRegistrar, srv HealthAPIServer)

func RegisterManagementHandler

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

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

func RegisterManagementHandlerClient

func RegisterManagementHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ManagementClient) error

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

func RegisterManagementHandlerFromEndpoint

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

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

func RegisterManagementHandlerServer

func RegisterManagementHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ManagementServer) error

RegisterManagementHandlerServer registers the http handlers for service Management to "mux". UnaryRPC :call ManagementServer 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 RegisterManagementHandlerFromEndpoint instead.

func RegisterManagementServer

func RegisterManagementServer(s grpc.ServiceRegistrar, srv ManagementServer)

func RegisterObservabilityHandler

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

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

func RegisterObservabilityHandlerClient

func RegisterObservabilityHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ObservabilityClient) error

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

func RegisterObservabilityHandlerFromEndpoint

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

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

func RegisterObservabilityHandlerServer

func RegisterObservabilityHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ObservabilityServer) error

RegisterObservabilityHandlerServer registers the http handlers for service Observability to "mux". UnaryRPC :call ObservabilityServer 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 RegisterObservabilityHandlerFromEndpoint instead.

func RegisterObservabilityServer

func RegisterObservabilityServer(s grpc.ServiceRegistrar, srv ObservabilityServer)

func RegisterRealtimeHandler

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

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

func RegisterRealtimeHandlerClient

func RegisterRealtimeHandlerClient(ctx context.Context, mux *runtime.ServeMux, client RealtimeClient) error

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

func RegisterRealtimeHandlerFromEndpoint

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

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

func RegisterRealtimeHandlerServer

func RegisterRealtimeHandlerServer(ctx context.Context, mux *runtime.ServeMux, server RealtimeServer) error

RegisterRealtimeHandlerServer registers the http handlers for service Realtime to "mux". UnaryRPC :call RealtimeServer 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 RegisterRealtimeHandlerFromEndpoint instead.

func RegisterRealtimeServer

func RegisterRealtimeServer(s grpc.ServiceRegistrar, srv RealtimeServer)

func RegisterSearchHandler

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

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

func RegisterSearchHandlerClient

func RegisterSearchHandlerClient(ctx context.Context, mux *runtime.ServeMux, client SearchClient) error

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

func RegisterSearchHandlerFromEndpoint

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

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

func RegisterSearchHandlerServer

func RegisterSearchHandlerServer(ctx context.Context, mux *runtime.ServeMux, server SearchServer) error

RegisterSearchHandlerServer registers the http handlers for service Search to "mux". UnaryRPC :call SearchServer 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 RegisterSearchHandlerFromEndpoint instead.

func RegisterSearchServer

func RegisterSearchServer(s grpc.ServiceRegistrar, srv SearchServer)

func RegisterTigrisHandler

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

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

func RegisterTigrisHandlerClient

func RegisterTigrisHandlerClient(ctx context.Context, mux *runtime.ServeMux, client TigrisClient) error

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

func RegisterTigrisHandlerFromEndpoint

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

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

func RegisterTigrisHandlerServer

func RegisterTigrisHandlerServer(ctx context.Context, mux *runtime.ServeMux, server TigrisServer) error

RegisterTigrisHandlerServer registers the http handlers for service Tigris to "mux". UnaryRPC :call TigrisServer 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 RegisterTigrisHandlerFromEndpoint instead.

func RegisterTigrisServer

func RegisterTigrisServer(s grpc.ServiceRegistrar, srv TigrisServer)

func ToGRPCCode

func ToGRPCCode(code Code) codes.Code

ToGRPCCode converts Tigris error code to GRPC code Extended codes converted to 'Unknown' GRPC code.

func ToHTTPCode

func ToHTTPCode(code Code) int

ToHTTPCode converts Tigris' code to HTTP status code Used to customize HTTP codes returned by GRPC-gateway.

Types

type AdditionalFunction

type AdditionalFunction struct {
	Rollup *RollupFunction `protobuf:"bytes,1,opt,name=rollup,proto3,oneof" json:"rollup,omitempty"`
	// contains filtered or unexported fields
}

Additional function to apply on metrics query

func (*AdditionalFunction) Descriptor deprecated

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

Deprecated: Use AdditionalFunction.ProtoReflect.Descriptor instead.

func (*AdditionalFunction) GetRollup

func (x *AdditionalFunction) GetRollup() *RollupFunction

func (*AdditionalFunction) ProtoMessage

func (*AdditionalFunction) ProtoMessage()

func (*AdditionalFunction) ProtoReflect

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

func (*AdditionalFunction) Reset

func (x *AdditionalFunction) Reset()

func (*AdditionalFunction) String

func (x *AdditionalFunction) String() string

type AppKey

type AppKey struct {

	// Generated client id
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// A human readable app name
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// A human readable app description
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Generated app secret
	Secret string `protobuf:"bytes,4,opt,name=secret,proto3" json:"secret,omitempty"`
	// Created at
	CreatedAt int64 `protobuf:"varint,5,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// Created by
	CreatedBy string `protobuf:"bytes,6,opt,name=created_by,json=createdBy,proto3" json:"created_by,omitempty"`
	// Updated at
	UpdatedAt int64 `protobuf:"varint,7,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
	// Updated by
	UpdatedBy string `protobuf:"bytes,8,opt,name=updated_by,json=updatedBy,proto3" json:"updated_by,omitempty"`
	// Project it belongs to
	Project string `protobuf:"bytes,9,opt,name=project,proto3" json:"project,omitempty"`
	// contains filtered or unexported fields
}

An user AppKey

func (*AppKey) Descriptor deprecated

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

Deprecated: Use AppKey.ProtoReflect.Descriptor instead.

func (*AppKey) GetCreatedAt

func (x *AppKey) GetCreatedAt() int64

func (*AppKey) GetCreatedBy

func (x *AppKey) GetCreatedBy() string

func (*AppKey) GetDescription

func (x *AppKey) GetDescription() string

func (*AppKey) GetId

func (x *AppKey) GetId() string

func (*AppKey) GetName

func (x *AppKey) GetName() string

func (*AppKey) GetProject

func (x *AppKey) GetProject() string

func (*AppKey) GetSecret

func (x *AppKey) GetSecret() string

func (*AppKey) GetUpdatedAt

func (x *AppKey) GetUpdatedAt() int64

func (*AppKey) GetUpdatedBy

func (x *AppKey) GetUpdatedBy() string

func (*AppKey) ProtoMessage

func (*AppKey) ProtoMessage()

func (*AppKey) ProtoReflect

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

func (*AppKey) Reset

func (x *AppKey) Reset()

func (*AppKey) String

func (x *AppKey) String() string

type AttachEvent

type AttachEvent struct {
	Channel string `protobuf:"bytes,1,opt,name=channel,proto3" json:"channel,omitempty"`
	// contains filtered or unexported fields
}

func (*AttachEvent) Descriptor deprecated

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

Deprecated: Use AttachEvent.ProtoReflect.Descriptor instead.

func (*AttachEvent) GetChannel

func (x *AttachEvent) GetChannel() string

func (*AttachEvent) ProtoMessage

func (*AttachEvent) ProtoMessage()

func (*AttachEvent) ProtoReflect

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

func (*AttachEvent) Reset

func (x *AttachEvent) Reset()

func (*AttachEvent) String

func (x *AttachEvent) String() string

type AuthClient

type AuthClient interface {
	// Endpoint for receiving access token from Tigris Server. The endpoint requires Grant Type(`grant_type`) which has
	// two possible values <i>"REFRESH_TOKEN"</i> or <i>"CLIENT_CREDENTIALS"</i> based on which either Refresh token(`refresh_token`)
	// needs to be set or client credentials(`client_id`, `client_secret`).
	GetAccessToken(ctx context.Context, in *GetAccessTokenRequest, opts ...grpc.CallOption) (*GetAccessTokenResponse, error)
}

AuthClient is the client API for Auth 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 NewAuthClient

func NewAuthClient(cc grpc.ClientConnInterface) AuthClient

type AuthEvent

type AuthEvent struct {
	AccessToken []byte `protobuf:"bytes,1,opt,name=access_token,json=accessToken,proto3" json:"access_token,omitempty"`
	// contains filtered or unexported fields
}

func (*AuthEvent) Descriptor deprecated

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

Deprecated: Use AuthEvent.ProtoReflect.Descriptor instead.

func (*AuthEvent) GetAccessToken

func (x *AuthEvent) GetAccessToken() []byte

func (*AuthEvent) ProtoMessage

func (*AuthEvent) ProtoMessage()

func (*AuthEvent) ProtoReflect

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

func (*AuthEvent) Reset

func (x *AuthEvent) Reset()

func (*AuthEvent) String

func (x *AuthEvent) String() string

type AuthServer

type AuthServer interface {
	// Endpoint for receiving access token from Tigris Server. The endpoint requires Grant Type(`grant_type`) which has
	// two possible values <i>"REFRESH_TOKEN"</i> or <i>"CLIENT_CREDENTIALS"</i> based on which either Refresh token(`refresh_token`)
	// needs to be set or client credentials(`client_id`, `client_secret`).
	GetAccessToken(context.Context, *GetAccessTokenRequest) (*GetAccessTokenResponse, error)
}

AuthServer is the server API for Auth service. All implementations should embed UnimplementedAuthServer for forward compatibility

type BeginTransactionRequest

type BeginTransactionRequest struct {

	// Project name whose DB this transaction belongs to.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// The transaction options.
	Options *TransactionOptions `protobuf:"bytes,2,opt,name=options,proto3" json:"options,omitempty"`
	// Optionally specify a project branch name to perform operation on
	Branch string `protobuf:"bytes,3,opt,name=branch,proto3" json:"branch,omitempty"`
	// contains filtered or unexported fields
}

Start new transaction in project specified by "project".

func (*BeginTransactionRequest) Descriptor deprecated

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

Deprecated: Use BeginTransactionRequest.ProtoReflect.Descriptor instead.

func (*BeginTransactionRequest) GetBranch

func (x *BeginTransactionRequest) GetBranch() string

func (*BeginTransactionRequest) GetOptions

func (*BeginTransactionRequest) GetProject

func (x *BeginTransactionRequest) GetProject() string

func (*BeginTransactionRequest) ProtoMessage

func (*BeginTransactionRequest) ProtoMessage()

func (*BeginTransactionRequest) ProtoReflect

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

func (*BeginTransactionRequest) Reset

func (x *BeginTransactionRequest) Reset()

func (*BeginTransactionRequest) String

func (x *BeginTransactionRequest) String() string

type BeginTransactionResponse

type BeginTransactionResponse struct {

	// Returns a tigris transactional context with details about the transactions.
	TxCtx *TransactionCtx `protobuf:"bytes,1,opt,name=tx_ctx,json=txCtx,proto3" json:"tx_ctx,omitempty"`
	// contains filtered or unexported fields
}

Start transaction returns transaction context which uniquely identifies the transaction

func (*BeginTransactionResponse) Descriptor deprecated

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

Deprecated: Use BeginTransactionResponse.ProtoReflect.Descriptor instead.

func (*BeginTransactionResponse) GetTxCtx

func (*BeginTransactionResponse) ProtoMessage

func (*BeginTransactionResponse) ProtoMessage()

func (*BeginTransactionResponse) ProtoReflect

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

func (*BeginTransactionResponse) Reset

func (x *BeginTransactionResponse) Reset()

func (*BeginTransactionResponse) String

func (x *BeginTransactionResponse) String() string

type BranchInfo

type BranchInfo struct {

	// Branch name
	Branch string `protobuf:"bytes,1,opt,name=branch,proto3" json:"branch,omitempty"`
	// Metadata about the branch
	Metadata *BranchMetadata `protobuf:"bytes,2,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

func (*BranchInfo) Descriptor deprecated

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

Deprecated: Use BranchInfo.ProtoReflect.Descriptor instead.

func (*BranchInfo) GetBranch

func (x *BranchInfo) GetBranch() string

func (*BranchInfo) GetMetadata

func (x *BranchInfo) GetMetadata() *BranchMetadata

func (*BranchInfo) ProtoMessage

func (*BranchInfo) ProtoMessage()

func (*BranchInfo) ProtoReflect

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

func (*BranchInfo) Reset

func (x *BranchInfo) Reset()

func (*BranchInfo) String

func (x *BranchInfo) String() string

type BranchMetadata

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

func (*BranchMetadata) Descriptor deprecated

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

Deprecated: Use BranchMetadata.ProtoReflect.Descriptor instead.

func (*BranchMetadata) ProtoMessage

func (*BranchMetadata) ProtoMessage()

func (*BranchMetadata) ProtoReflect

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

func (*BranchMetadata) Reset

func (x *BranchMetadata) Reset()

func (*BranchMetadata) String

func (x *BranchMetadata) String() string

type CacheClient

type CacheClient interface {
	CreateCache(ctx context.Context, in *CreateCacheRequest, opts ...grpc.CallOption) (*CreateCacheResponse, error)
	ListCaches(ctx context.Context, in *ListCachesRequest, opts ...grpc.CallOption) (*ListCachesResponse, error)
	DeleteCache(ctx context.Context, in *DeleteCacheRequest, opts ...grpc.CallOption) (*DeleteCacheResponse, error)
	Set(ctx context.Context, in *SetRequest, opts ...grpc.CallOption) (*SetResponse, error)
	GetSet(ctx context.Context, in *GetSetRequest, opts ...grpc.CallOption) (*GetSetResponse, error)
	Get(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (*GetResponse, error)
	Del(ctx context.Context, in *DelRequest, opts ...grpc.CallOption) (*DelResponse, error)
	Keys(ctx context.Context, in *KeysRequest, opts ...grpc.CallOption) (Cache_KeysClient, error)
}

CacheClient is the client API for Cache 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 NewCacheClient

func NewCacheClient(cc grpc.ClientConnInterface) CacheClient

type CacheMetadata

type CacheMetadata struct {

	// Cache name
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*CacheMetadata) Descriptor deprecated

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

Deprecated: Use CacheMetadata.ProtoReflect.Descriptor instead.

func (*CacheMetadata) GetName

func (x *CacheMetadata) GetName() string

func (*CacheMetadata) ProtoMessage

func (*CacheMetadata) ProtoMessage()

func (*CacheMetadata) ProtoReflect

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

func (*CacheMetadata) Reset

func (x *CacheMetadata) Reset()

func (*CacheMetadata) String

func (x *CacheMetadata) String() string

type CacheServer

CacheServer is the server API for Cache service. All implementations should embed UnimplementedCacheServer for forward compatibility

type Cache_KeysClient

type Cache_KeysClient interface {
	Recv() (*KeysResponse, error)
	grpc.ClientStream
}

type Cache_KeysServer

type Cache_KeysServer interface {
	Send(*KeysResponse) error
	grpc.ServerStream
}

type ChannelMetadata

type ChannelMetadata struct {
	Channel string `protobuf:"bytes,1,opt,name=channel,proto3" json:"channel,omitempty"`
	// contains filtered or unexported fields
}

func (*ChannelMetadata) Descriptor deprecated

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

Deprecated: Use ChannelMetadata.ProtoReflect.Descriptor instead.

func (*ChannelMetadata) GetChannel

func (x *ChannelMetadata) GetChannel() string

func (*ChannelMetadata) ProtoMessage

func (*ChannelMetadata) ProtoMessage()

func (*ChannelMetadata) ProtoReflect

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

func (*ChannelMetadata) Reset

func (x *ChannelMetadata) Reset()

func (*ChannelMetadata) String

func (x *ChannelMetadata) String() string

type Code

type Code int32

Codes returned by the Tigris server in the case of error

const (
	Code_OK                  Code = 0  // 200
	Code_CANCELLED           Code = 1  // 499
	Code_UNKNOWN             Code = 2  // 500
	Code_INVALID_ARGUMENT    Code = 3  // 400
	Code_DEADLINE_EXCEEDED   Code = 4  // 504
	Code_NOT_FOUND           Code = 5  // 404
	Code_ALREADY_EXISTS      Code = 6  // 409
	Code_PERMISSION_DENIED   Code = 7  // 403
	Code_RESOURCE_EXHAUSTED  Code = 8  // 429
	Code_FAILED_PRECONDITION Code = 9  // 412
	Code_ABORTED             Code = 10 // 409
	Code_OUT_OF_RANGE        Code = 11 // 400
	Code_UNIMPLEMENTED       Code = 12 // 501
	Code_INTERNAL            Code = 13 // 500
	Code_UNAVAILABLE         Code = 14 // 503
	Code_DATA_LOSS           Code = 15 // 500
	Code_UNAUTHENTICATED     Code = 16 // 401
	Code_CONFLICT            Code = 17 // 409
	Code_BAD_GATEWAY         Code = 18 // 502
	Code_METHOD_NOT_ALLOWED  Code = 19 // 405
	Code_CONTENT_TOO_LARGE   Code = 20 // 413
)

func CodeFromString

func CodeFromString(c string) Code

CodeFromString parses Tigris error code from its string representation.

func ToTigrisCode

func ToTigrisCode(code codes.Code) Code

ToTigrisCode converts GRPC code to Tigris code.

func (Code) Descriptor

func (Code) Descriptor() protoreflect.EnumDescriptor

func (Code) Enum

func (x Code) Enum() *Code

func (Code) EnumDescriptor deprecated

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

Deprecated: Use Code.Descriptor instead.

func (Code) Number

func (x Code) Number() protoreflect.EnumNumber

func (Code) String

func (x Code) String() string

func (Code) Type

func (Code) Type() protoreflect.EnumType

type Collation

type Collation struct {
	Case string `protobuf:"bytes,1,opt,name=case,proto3" json:"case,omitempty"`
	// contains filtered or unexported fields
}

A collation allows you to specify string comparison rules. Default is case-sensitive, to override it you can set this option to 'ci' that will apply to all the text fields in the filters.

func (*Collation) Descriptor deprecated

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

Deprecated: Use Collation.ProtoReflect.Descriptor instead.

func (*Collation) GetCase

func (x *Collation) GetCase() string

func (*Collation) ProtoMessage

func (*Collation) ProtoMessage()

func (*Collation) ProtoReflect

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

func (*Collation) Reset

func (x *Collation) Reset()

func (*Collation) String

func (x *Collation) String() string

type CollectionDescription

type CollectionDescription struct {

	// Name of the collection.
	Collection string `protobuf:"bytes,1,opt,name=collection,proto3" json:"collection,omitempty"`
	// Metadata about the collection.
	Metadata *CollectionMetadata `protobuf:"bytes,2,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Collections schema
	Schema []byte `protobuf:"bytes,3,opt,name=schema,proto3" json:"schema,omitempty"`
	// Collection size in bytes
	Size int64 `protobuf:"varint,4,opt,name=size,proto3" json:"size,omitempty"`
	// contains filtered or unexported fields
}

func (*CollectionDescription) Descriptor deprecated

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

Deprecated: Use CollectionDescription.ProtoReflect.Descriptor instead.

func (*CollectionDescription) GetCollection

func (x *CollectionDescription) GetCollection() string

func (*CollectionDescription) GetMetadata

func (x *CollectionDescription) GetMetadata() *CollectionMetadata

func (*CollectionDescription) GetSchema

func (x *CollectionDescription) GetSchema() []byte

func (*CollectionDescription) GetSize

func (x *CollectionDescription) GetSize() int64

func (*CollectionDescription) ProtoMessage

func (*CollectionDescription) ProtoMessage()

func (*CollectionDescription) ProtoReflect

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

func (*CollectionDescription) Reset

func (x *CollectionDescription) Reset()

func (*CollectionDescription) String

func (x *CollectionDescription) String() string

type CollectionInfo

type CollectionInfo struct {

	// Collection name.
	Collection string `protobuf:"bytes,1,opt,name=collection,proto3" json:"collection,omitempty"`
	// Metadata about the collection.
	Metadata *CollectionMetadata `protobuf:"bytes,2,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

func (*CollectionInfo) Descriptor deprecated

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

Deprecated: Use CollectionInfo.ProtoReflect.Descriptor instead.

func (*CollectionInfo) GetCollection

func (x *CollectionInfo) GetCollection() string

func (*CollectionInfo) GetMetadata

func (x *CollectionInfo) GetMetadata() *CollectionMetadata

func (*CollectionInfo) ProtoMessage

func (*CollectionInfo) ProtoMessage()

func (*CollectionInfo) ProtoReflect

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

func (*CollectionInfo) Reset

func (x *CollectionInfo) Reset()

func (*CollectionInfo) String

func (x *CollectionInfo) String() string

type CollectionMetadata

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

func (*CollectionMetadata) Descriptor deprecated

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

Deprecated: Use CollectionMetadata.ProtoReflect.Descriptor instead.

func (*CollectionMetadata) ProtoMessage

func (*CollectionMetadata) ProtoMessage()

func (*CollectionMetadata) ProtoReflect

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

func (*CollectionMetadata) Reset

func (x *CollectionMetadata) Reset()

func (*CollectionMetadata) String

func (x *CollectionMetadata) String() string

type CollectionOptions

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

Collection requests modifying options.

func (*CollectionOptions) Descriptor deprecated

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

Deprecated: Use CollectionOptions.ProtoReflect.Descriptor instead.

func (*CollectionOptions) ProtoMessage

func (*CollectionOptions) ProtoMessage()

func (*CollectionOptions) ProtoReflect

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

func (*CollectionOptions) Reset

func (x *CollectionOptions) Reset()

func (*CollectionOptions) String

func (x *CollectionOptions) String() string

type CommitTransactionRequest

type CommitTransactionRequest struct {

	// Project name whose DB this transaction belongs to.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// Optionally specify a database branch name to perform operation on
	Branch string `protobuf:"bytes,2,opt,name=branch,proto3" json:"branch,omitempty"`
	// contains filtered or unexported fields
}

Commit transaction with the given ID

func (*CommitTransactionRequest) Descriptor deprecated

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

Deprecated: Use CommitTransactionRequest.ProtoReflect.Descriptor instead.

func (*CommitTransactionRequest) GetBranch

func (x *CommitTransactionRequest) GetBranch() string

func (*CommitTransactionRequest) GetProject

func (x *CommitTransactionRequest) GetProject() string

func (*CommitTransactionRequest) ProtoMessage

func (*CommitTransactionRequest) ProtoMessage()

func (*CommitTransactionRequest) ProtoReflect

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

func (*CommitTransactionRequest) Reset

func (x *CommitTransactionRequest) Reset()

func (*CommitTransactionRequest) String

func (x *CommitTransactionRequest) String() string

type CommitTransactionResponse

type CommitTransactionResponse struct {

	// Status of commit transaction operation.
	Status string `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*CommitTransactionResponse) Descriptor deprecated

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

Deprecated: Use CommitTransactionResponse.ProtoReflect.Descriptor instead.

func (*CommitTransactionResponse) GetStatus

func (x *CommitTransactionResponse) GetStatus() string

func (*CommitTransactionResponse) ProtoMessage

func (*CommitTransactionResponse) ProtoMessage()

func (*CommitTransactionResponse) ProtoReflect

func (*CommitTransactionResponse) Reset

func (x *CommitTransactionResponse) Reset()

func (*CommitTransactionResponse) String

func (x *CommitTransactionResponse) String() string

type ConnectedEvent

type ConnectedEvent struct {
	SessionId string `protobuf:"bytes,1,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
	SocketId  string `protobuf:"bytes,2,opt,name=socket_id,json=socketId,proto3" json:"socket_id,omitempty"`
	// contains filtered or unexported fields
}

func (*ConnectedEvent) Descriptor deprecated

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

Deprecated: Use ConnectedEvent.ProtoReflect.Descriptor instead.

func (*ConnectedEvent) GetSessionId

func (x *ConnectedEvent) GetSessionId() string

func (*ConnectedEvent) GetSocketId

func (x *ConnectedEvent) GetSocketId() string

func (*ConnectedEvent) ProtoMessage

func (*ConnectedEvent) ProtoMessage()

func (*ConnectedEvent) ProtoReflect

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

func (*ConnectedEvent) Reset

func (x *ConnectedEvent) Reset()

func (*ConnectedEvent) String

func (x *ConnectedEvent) String() string

type CreateAppKeyRequest

type CreateAppKeyRequest struct {

	// A human readable app name
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// A human readable app description
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// Project name
	Project string `protobuf:"bytes,3,opt,name=project,proto3" json:"project,omitempty"`
	// contains filtered or unexported fields
}

Request creation of user app key

func (*CreateAppKeyRequest) Descriptor deprecated

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

Deprecated: Use CreateAppKeyRequest.ProtoReflect.Descriptor instead.

func (*CreateAppKeyRequest) GetDescription

func (x *CreateAppKeyRequest) GetDescription() string

func (*CreateAppKeyRequest) GetName

func (x *CreateAppKeyRequest) GetName() string

func (*CreateAppKeyRequest) GetProject

func (x *CreateAppKeyRequest) GetProject() string

func (*CreateAppKeyRequest) ProtoMessage

func (*CreateAppKeyRequest) ProtoMessage()

func (*CreateAppKeyRequest) ProtoReflect

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

func (*CreateAppKeyRequest) Reset

func (x *CreateAppKeyRequest) Reset()

func (*CreateAppKeyRequest) String

func (x *CreateAppKeyRequest) String() string

type CreateAppKeyResponse

type CreateAppKeyResponse struct {

	// created app object
	CreatedAppKey *AppKey `protobuf:"bytes,1,opt,name=created_app_key,json=createdAppKey,proto3" json:"created_app_key,omitempty"`
	// contains filtered or unexported fields
}

CreateAppKeyResponse returns created app keys

func (*CreateAppKeyResponse) Descriptor deprecated

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

Deprecated: Use CreateAppKeyResponse.ProtoReflect.Descriptor instead.

func (*CreateAppKeyResponse) GetCreatedAppKey

func (x *CreateAppKeyResponse) GetCreatedAppKey() *AppKey

func (*CreateAppKeyResponse) ProtoMessage

func (*CreateAppKeyResponse) ProtoMessage()

func (*CreateAppKeyResponse) ProtoReflect

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

func (*CreateAppKeyResponse) Reset

func (x *CreateAppKeyResponse) Reset()

func (*CreateAppKeyResponse) String

func (x *CreateAppKeyResponse) String() string

type CreateBranchRequest

type CreateBranchRequest struct {

	// Create a database branch in this project
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// Name of the database branch to be created.
	// <p></p>**Note**: `main` is a reserved branch name for primary database and is automatically created with CreateProject
	Branch string `protobuf:"bytes,2,opt,name=branch,proto3" json:"branch,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateBranchRequest) Descriptor deprecated

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

Deprecated: Use CreateBranchRequest.ProtoReflect.Descriptor instead.

func (*CreateBranchRequest) GetBranch

func (x *CreateBranchRequest) GetBranch() string

func (*CreateBranchRequest) GetProject

func (x *CreateBranchRequest) GetProject() string

func (*CreateBranchRequest) ProtoMessage

func (*CreateBranchRequest) ProtoMessage()

func (*CreateBranchRequest) ProtoReflect

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

func (*CreateBranchRequest) Reset

func (x *CreateBranchRequest) Reset()

func (*CreateBranchRequest) String

func (x *CreateBranchRequest) String() string

type CreateBranchResponse

type CreateBranchResponse struct {

	// A detailed response message.
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// An enum with value set as "created".
	Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateBranchResponse) Descriptor deprecated

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

Deprecated: Use CreateBranchResponse.ProtoReflect.Descriptor instead.

func (*CreateBranchResponse) GetMessage

func (x *CreateBranchResponse) GetMessage() string

func (*CreateBranchResponse) GetStatus

func (x *CreateBranchResponse) GetStatus() string

func (*CreateBranchResponse) ProtoMessage

func (*CreateBranchResponse) ProtoMessage()

func (*CreateBranchResponse) ProtoReflect

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

func (*CreateBranchResponse) Reset

func (x *CreateBranchResponse) Reset()

func (*CreateBranchResponse) String

func (x *CreateBranchResponse) String() string

type CreateByIdRequest

type CreateByIdRequest struct {

	// Tigris project name.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// index name where to create document.
	Index string `protobuf:"bytes,2,opt,name=index,proto3" json:"index,omitempty"`
	// document id.
	Id string `protobuf:"bytes,3,opt,name=id,proto3" json:"id,omitempty"`
	// A JSON document that needs to be indexed.
	Document []byte `protobuf:"bytes,4,opt,name=document,proto3" json:"document,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateByIdRequest) Descriptor deprecated

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

Deprecated: Use CreateByIdRequest.ProtoReflect.Descriptor instead.

func (*CreateByIdRequest) GetDocument

func (x *CreateByIdRequest) GetDocument() []byte

func (*CreateByIdRequest) GetId

func (x *CreateByIdRequest) GetId() string

func (*CreateByIdRequest) GetIndex

func (x *CreateByIdRequest) GetIndex() string

func (*CreateByIdRequest) GetProject

func (x *CreateByIdRequest) GetProject() string

func (*CreateByIdRequest) ProtoMessage

func (*CreateByIdRequest) ProtoMessage()

func (*CreateByIdRequest) ProtoReflect

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

func (*CreateByIdRequest) Reset

func (x *CreateByIdRequest) Reset()

func (*CreateByIdRequest) String

func (x *CreateByIdRequest) String() string

func (*CreateByIdRequest) UnmarshalJSON

func (x *CreateByIdRequest) UnmarshalJSON(data []byte) error

type CreateByIdResponse

type CreateByIdResponse struct {

	// Returns the id of the created document.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateByIdResponse) Descriptor deprecated

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

Deprecated: Use CreateByIdResponse.ProtoReflect.Descriptor instead.

func (*CreateByIdResponse) GetId

func (x *CreateByIdResponse) GetId() string

func (*CreateByIdResponse) ProtoMessage

func (*CreateByIdResponse) ProtoMessage()

func (*CreateByIdResponse) ProtoReflect

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

func (*CreateByIdResponse) Reset

func (x *CreateByIdResponse) Reset()

func (*CreateByIdResponse) String

func (x *CreateByIdResponse) String() string

type CreateCacheOptions

type CreateCacheOptions struct {
	TtlMs uint64 `protobuf:"varint,1,opt,name=ttl_ms,json=ttlMs,proto3" json:"ttl_ms,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateCacheOptions) Descriptor deprecated

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

Deprecated: Use CreateCacheOptions.ProtoReflect.Descriptor instead.

func (*CreateCacheOptions) GetTtlMs

func (x *CreateCacheOptions) GetTtlMs() uint64

func (*CreateCacheOptions) ProtoMessage

func (*CreateCacheOptions) ProtoMessage()

func (*CreateCacheOptions) ProtoReflect

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

func (*CreateCacheOptions) Reset

func (x *CreateCacheOptions) Reset()

func (*CreateCacheOptions) String

func (x *CreateCacheOptions) String() string

type CreateCacheRequest

type CreateCacheRequest struct {

	// Tigris project name
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// cache name
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// optional configuration
	Options *CreateCacheOptions `protobuf:"bytes,3,opt,name=options,proto3,oneof" json:"options,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateCacheRequest) Descriptor deprecated

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

Deprecated: Use CreateCacheRequest.ProtoReflect.Descriptor instead.

func (*CreateCacheRequest) GetName

func (x *CreateCacheRequest) GetName() string

func (*CreateCacheRequest) GetOptions

func (x *CreateCacheRequest) GetOptions() *CreateCacheOptions

func (*CreateCacheRequest) GetProject

func (x *CreateCacheRequest) GetProject() string

func (*CreateCacheRequest) ProtoMessage

func (*CreateCacheRequest) ProtoMessage()

func (*CreateCacheRequest) ProtoReflect

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

func (*CreateCacheRequest) Reset

func (x *CreateCacheRequest) Reset()

func (*CreateCacheRequest) String

func (x *CreateCacheRequest) String() string

type CreateCacheResponse

type CreateCacheResponse struct {

	// A detailed response message.
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// An enum with value set as "created"
	Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateCacheResponse) Descriptor deprecated

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

Deprecated: Use CreateCacheResponse.ProtoReflect.Descriptor instead.

func (*CreateCacheResponse) GetMessage

func (x *CreateCacheResponse) GetMessage() string

func (*CreateCacheResponse) GetStatus

func (x *CreateCacheResponse) GetStatus() string

func (*CreateCacheResponse) ProtoMessage

func (*CreateCacheResponse) ProtoMessage()

func (*CreateCacheResponse) ProtoReflect

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

func (*CreateCacheResponse) Reset

func (x *CreateCacheResponse) Reset()

func (*CreateCacheResponse) String

func (x *CreateCacheResponse) String() string

type CreateDocumentRequest

type CreateDocumentRequest struct {

	// Tigris project name.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// index name where to create documents.
	Index string `protobuf:"bytes,2,opt,name=index,proto3" json:"index,omitempty"`
	// An array of documents to be created or replaced. Each document is a JSON object.
	Documents [][]byte `protobuf:"bytes,3,rep,name=documents,proto3" json:"documents,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateDocumentRequest) Descriptor deprecated

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

Deprecated: Use CreateDocumentRequest.ProtoReflect.Descriptor instead.

func (*CreateDocumentRequest) GetDocuments

func (x *CreateDocumentRequest) GetDocuments() [][]byte

func (*CreateDocumentRequest) GetIndex

func (x *CreateDocumentRequest) GetIndex() string

func (*CreateDocumentRequest) GetProject

func (x *CreateDocumentRequest) GetProject() string

func (*CreateDocumentRequest) ProtoMessage

func (*CreateDocumentRequest) ProtoMessage()

func (*CreateDocumentRequest) ProtoReflect

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

func (*CreateDocumentRequest) Reset

func (x *CreateDocumentRequest) Reset()

func (*CreateDocumentRequest) String

func (x *CreateDocumentRequest) String() string

func (*CreateDocumentRequest) UnmarshalJSON

func (x *CreateDocumentRequest) UnmarshalJSON(data []byte) error

type CreateDocumentResponse

type CreateDocumentResponse struct {

	// An array of statuses of all the documents received in the request. Order is same as it is received in the
	// request. Each item of this array has an “id” and “error” key. Id is set as document id and error will be null
	// in case of success, otherwise error is set with an error code and message.
	Status []*DocStatus `protobuf:"bytes,1,rep,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateDocumentResponse) Descriptor deprecated

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

Deprecated: Use CreateDocumentResponse.ProtoReflect.Descriptor instead.

func (*CreateDocumentResponse) GetStatus

func (x *CreateDocumentResponse) GetStatus() []*DocStatus

func (*CreateDocumentResponse) ProtoMessage

func (*CreateDocumentResponse) ProtoMessage()

func (*CreateDocumentResponse) ProtoReflect

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

func (*CreateDocumentResponse) Reset

func (x *CreateDocumentResponse) Reset()

func (*CreateDocumentResponse) String

func (x *CreateDocumentResponse) String() string

type CreateNamespaceRequest

type CreateNamespaceRequest struct {

	// Optional: unique id
	Code uint32 `protobuf:"varint,1,opt,name=code,proto3" json:"code,omitempty"`
	// Optional: unique string id
	Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	// Required: The display name for namespace.
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateNamespaceRequest) Descriptor deprecated

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

Deprecated: Use CreateNamespaceRequest.ProtoReflect.Descriptor instead.

func (*CreateNamespaceRequest) GetCode

func (x *CreateNamespaceRequest) GetCode() uint32

func (*CreateNamespaceRequest) GetId

func (x *CreateNamespaceRequest) GetId() string

func (*CreateNamespaceRequest) GetName

func (x *CreateNamespaceRequest) GetName() string

func (*CreateNamespaceRequest) ProtoMessage

func (*CreateNamespaceRequest) ProtoMessage()

func (*CreateNamespaceRequest) ProtoReflect

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

func (*CreateNamespaceRequest) Reset

func (x *CreateNamespaceRequest) Reset()

func (*CreateNamespaceRequest) String

func (x *CreateNamespaceRequest) String() string

type CreateNamespaceResponse

type CreateNamespaceResponse struct {

	// A detailed response message.
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// An enum with value set as "created".
	Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// The created namespace
	Namespace *NamespaceInfo `protobuf:"bytes,3,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateNamespaceResponse) Descriptor deprecated

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

Deprecated: Use CreateNamespaceResponse.ProtoReflect.Descriptor instead.

func (*CreateNamespaceResponse) GetMessage

func (x *CreateNamespaceResponse) GetMessage() string

func (*CreateNamespaceResponse) GetNamespace

func (x *CreateNamespaceResponse) GetNamespace() *NamespaceInfo

func (*CreateNamespaceResponse) GetStatus

func (x *CreateNamespaceResponse) GetStatus() string

func (*CreateNamespaceResponse) ProtoMessage

func (*CreateNamespaceResponse) ProtoMessage()

func (*CreateNamespaceResponse) ProtoReflect

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

func (*CreateNamespaceResponse) Reset

func (x *CreateNamespaceResponse) Reset()

func (*CreateNamespaceResponse) String

func (x *CreateNamespaceResponse) String() string

type CreateOrReplaceDocumentRequest

type CreateOrReplaceDocumentRequest struct {

	// Project name whose db is under target to insert documents.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// index name where to create documents.
	Index string `protobuf:"bytes,2,opt,name=index,proto3" json:"index,omitempty"`
	// An array of documents to create. Each document is a JSON object. In case an id is missing then the server will
	// automatically generate it for you and create the document and in case an id is provided in the document and the
	// document already exists then that document will not index and in the response there will be an error corresponding
	// to that document id other documents will succeed.
	Documents [][]byte `protobuf:"bytes,3,rep,name=documents,proto3" json:"documents,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateOrReplaceDocumentRequest) Descriptor deprecated

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

Deprecated: Use CreateOrReplaceDocumentRequest.ProtoReflect.Descriptor instead.

func (*CreateOrReplaceDocumentRequest) GetDocuments

func (x *CreateOrReplaceDocumentRequest) GetDocuments() [][]byte

func (*CreateOrReplaceDocumentRequest) GetIndex

func (x *CreateOrReplaceDocumentRequest) GetIndex() string

func (*CreateOrReplaceDocumentRequest) GetProject

func (x *CreateOrReplaceDocumentRequest) GetProject() string

func (*CreateOrReplaceDocumentRequest) ProtoMessage

func (*CreateOrReplaceDocumentRequest) ProtoMessage()

func (*CreateOrReplaceDocumentRequest) ProtoReflect

func (*CreateOrReplaceDocumentRequest) Reset

func (x *CreateOrReplaceDocumentRequest) Reset()

func (*CreateOrReplaceDocumentRequest) String

func (*CreateOrReplaceDocumentRequest) UnmarshalJSON

func (x *CreateOrReplaceDocumentRequest) UnmarshalJSON(data []byte) error

type CreateOrReplaceDocumentResponse

type CreateOrReplaceDocumentResponse struct {

	// An array of statuses of all the documents received in the request. Order is same as it is received in the
	// request. Each item of this array has an “id” and “error” key. Id is set as document id and error will be null
	// in case of success, otherwise error is set with an error code and message.
	Status []*DocStatus `protobuf:"bytes,1,rep,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateOrReplaceDocumentResponse) Descriptor deprecated

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

Deprecated: Use CreateOrReplaceDocumentResponse.ProtoReflect.Descriptor instead.

func (*CreateOrReplaceDocumentResponse) GetStatus

func (x *CreateOrReplaceDocumentResponse) GetStatus() []*DocStatus

func (*CreateOrReplaceDocumentResponse) ProtoMessage

func (*CreateOrReplaceDocumentResponse) ProtoMessage()

func (*CreateOrReplaceDocumentResponse) ProtoReflect

func (*CreateOrReplaceDocumentResponse) Reset

func (*CreateOrReplaceDocumentResponse) String

type CreateOrUpdateCollectionRequest

type CreateOrUpdateCollectionRequest struct {

	// Project name whose db is under target to create or update collection.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// Collection name to create.
	Collection string `protobuf:"bytes,2,opt,name=collection,proto3" json:"collection,omitempty"`
	// The schema specifications are same as
	// JSON schema specification defined <a href="https://json-schema.org/specification.html" title="here">here</a>.
	// <p></p>
	// Schema example:
	//
	//	`{
	//	 "title": "user",
	//	 "description": "Collection of documents with details of users",
	//	 "properties": {
	//	   "id": {
	//	     "description": "A unique identifier for the user",
	//	     "type": "integer"
	//	   },
	//	   "name": {
	//	     "description": "Name of the user",
	//	     "type": "string",
	//	     "maxLength": 128
	//	   },
	//	   "balance": {
	//	     "description": "User account balance",
	//	     "type": "number"
	//	   }
	//	 },
	//	 "primary_key": ["id"]
	//	}`
	Schema []byte `protobuf:"bytes,3,opt,name=schema,proto3" json:"schema,omitempty"`
	// If set to `true` then the update schema request to the collection will fail by returning a conflict with HTTP Status
	// code 409. The default is false.
	OnlyCreate bool               `protobuf:"varint,4,opt,name=only_create,json=onlyCreate,proto3" json:"only_create,omitempty"`
	Options    *CollectionOptions `protobuf:"bytes,5,opt,name=options,proto3" json:"options,omitempty"`
	// Optionally specify a database branch name to perform operation on
	Branch string `protobuf:"bytes,6,opt,name=branch,proto3" json:"branch,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateOrUpdateCollectionRequest) Descriptor deprecated

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

Deprecated: Use CreateOrUpdateCollectionRequest.ProtoReflect.Descriptor instead.

func (*CreateOrUpdateCollectionRequest) GetBranch

func (x *CreateOrUpdateCollectionRequest) GetBranch() string

func (*CreateOrUpdateCollectionRequest) GetCollection

func (x *CreateOrUpdateCollectionRequest) GetCollection() string

func (*CreateOrUpdateCollectionRequest) GetOnlyCreate

func (x *CreateOrUpdateCollectionRequest) GetOnlyCreate() bool

func (*CreateOrUpdateCollectionRequest) GetOptions

func (*CreateOrUpdateCollectionRequest) GetProject

func (x *CreateOrUpdateCollectionRequest) GetProject() string

func (*CreateOrUpdateCollectionRequest) GetSchema

func (x *CreateOrUpdateCollectionRequest) GetSchema() []byte

func (*CreateOrUpdateCollectionRequest) ProtoMessage

func (*CreateOrUpdateCollectionRequest) ProtoMessage()

func (*CreateOrUpdateCollectionRequest) ProtoReflect

func (*CreateOrUpdateCollectionRequest) Reset

func (*CreateOrUpdateCollectionRequest) String

func (*CreateOrUpdateCollectionRequest) UnmarshalJSON

func (x *CreateOrUpdateCollectionRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON on CreateCollectionRequest avoids unmarshalling schema. The req handler deserializes the schema.

type CreateOrUpdateCollectionResponse

type CreateOrUpdateCollectionResponse struct {

	// A detailed response message.
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// An enum with value set as "created" or "updated"
	Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateOrUpdateCollectionResponse) Descriptor deprecated

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

Deprecated: Use CreateOrUpdateCollectionResponse.ProtoReflect.Descriptor instead.

func (*CreateOrUpdateCollectionResponse) GetMessage

func (x *CreateOrUpdateCollectionResponse) GetMessage() string

func (*CreateOrUpdateCollectionResponse) GetStatus

func (*CreateOrUpdateCollectionResponse) ProtoMessage

func (*CreateOrUpdateCollectionResponse) ProtoMessage()

func (*CreateOrUpdateCollectionResponse) ProtoReflect

func (*CreateOrUpdateCollectionResponse) Reset

func (*CreateOrUpdateCollectionResponse) String

type CreateOrUpdateIndexRequest

type CreateOrUpdateIndexRequest struct {

	// Tigris project name.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// search index name.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// schema of the index. The schema specifications are same as
	// JSON schema specification defined <a href="https://json-schema.org/specification.html" title="here">here</a>.
	// <p></p>
	// Schema example:
	//
	//	`{
	//	 "title": "ecommerce_index",
	//	 "description": "an ecommerce store search index",
	//	 "properties": {
	//	   "name": {
	//	     "description": "Name of the product",
	//	     "type": "string",
	//	     "maxLength": 128
	//	   },
	//	   "brand": {
	//	     "description": "Brand of the product",
	//	     "type": "string"
	//	   },
	//	   "price": {
	//	     "description": "Price of the product",
	//	     "type": "number"
	//	   }
	//	 }
	//	}`
	Schema []byte `protobuf:"bytes,3,opt,name=schema,proto3" json:"schema,omitempty"`
	// If set to `true` then a conflict with HTTP Status code 409 is returned if an index already exists.
	// The default is false.
	OnlyCreate bool `protobuf:"varint,4,opt,name=only_create,json=onlyCreate,proto3" json:"only_create,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateOrUpdateIndexRequest) Descriptor deprecated

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

Deprecated: Use CreateOrUpdateIndexRequest.ProtoReflect.Descriptor instead.

func (*CreateOrUpdateIndexRequest) GetName

func (x *CreateOrUpdateIndexRequest) GetName() string

func (*CreateOrUpdateIndexRequest) GetOnlyCreate

func (x *CreateOrUpdateIndexRequest) GetOnlyCreate() bool

func (*CreateOrUpdateIndexRequest) GetProject

func (x *CreateOrUpdateIndexRequest) GetProject() string

func (*CreateOrUpdateIndexRequest) GetSchema

func (x *CreateOrUpdateIndexRequest) GetSchema() []byte

func (*CreateOrUpdateIndexRequest) ProtoMessage

func (*CreateOrUpdateIndexRequest) ProtoMessage()

func (*CreateOrUpdateIndexRequest) ProtoReflect

func (*CreateOrUpdateIndexRequest) Reset

func (x *CreateOrUpdateIndexRequest) Reset()

func (*CreateOrUpdateIndexRequest) String

func (x *CreateOrUpdateIndexRequest) String() string

func (*CreateOrUpdateIndexRequest) UnmarshalJSON

func (x *CreateOrUpdateIndexRequest) UnmarshalJSON(data []byte) error

type CreateOrUpdateIndexResponse

type CreateOrUpdateIndexResponse struct {

	// A detailed response message.
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// An enum with value set as "created"
	Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateOrUpdateIndexResponse) Descriptor deprecated

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

Deprecated: Use CreateOrUpdateIndexResponse.ProtoReflect.Descriptor instead.

func (*CreateOrUpdateIndexResponse) GetMessage

func (x *CreateOrUpdateIndexResponse) GetMessage() string

func (*CreateOrUpdateIndexResponse) GetStatus

func (x *CreateOrUpdateIndexResponse) GetStatus() string

func (*CreateOrUpdateIndexResponse) ProtoMessage

func (*CreateOrUpdateIndexResponse) ProtoMessage()

func (*CreateOrUpdateIndexResponse) ProtoReflect

func (*CreateOrUpdateIndexResponse) Reset

func (x *CreateOrUpdateIndexResponse) Reset()

func (*CreateOrUpdateIndexResponse) String

func (x *CreateOrUpdateIndexResponse) String() string

type CreateProjectRequest

type CreateProjectRequest struct {

	// Create project with this name.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateProjectRequest) Descriptor deprecated

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

Deprecated: Use CreateProjectRequest.ProtoReflect.Descriptor instead.

func (*CreateProjectRequest) GetProject

func (x *CreateProjectRequest) GetProject() string

func (*CreateProjectRequest) ProtoMessage

func (*CreateProjectRequest) ProtoMessage()

func (*CreateProjectRequest) ProtoReflect

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

func (*CreateProjectRequest) Reset

func (x *CreateProjectRequest) Reset()

func (*CreateProjectRequest) String

func (x *CreateProjectRequest) String() string

type CreateProjectResponse

type CreateProjectResponse struct {

	// A detailed response message.
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// An enum with value set as "created".
	Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateProjectResponse) Descriptor deprecated

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

Deprecated: Use CreateProjectResponse.ProtoReflect.Descriptor instead.

func (*CreateProjectResponse) GetMessage

func (x *CreateProjectResponse) GetMessage() string

func (*CreateProjectResponse) GetStatus

func (x *CreateProjectResponse) GetStatus() string

func (*CreateProjectResponse) ProtoMessage

func (*CreateProjectResponse) ProtoMessage()

func (*CreateProjectResponse) ProtoReflect

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

func (*CreateProjectResponse) Reset

func (x *CreateProjectResponse) Reset()

func (*CreateProjectResponse) String

func (x *CreateProjectResponse) String() string

type CustomDecoder

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

func (CustomDecoder) Decode

func (f CustomDecoder) Decode(dst interface{}) error

type CustomMarshaler

type CustomMarshaler struct {
	JSONBuiltin *runtime.JSONBuiltin
}

CustomMarshaler is a marshaler to customize the response. Currently, it is only used to marshal custom error message otherwise it just uses the inbuilt mux marshaller.

func (*CustomMarshaler) ContentType

func (c *CustomMarshaler) ContentType(v interface{}) string

func (*CustomMarshaler) Marshal

func (c *CustomMarshaler) Marshal(v interface{}) ([]byte, error)

func (*CustomMarshaler) NewDecoder

func (c *CustomMarshaler) NewDecoder(r io.Reader) runtime.Decoder

func (*CustomMarshaler) NewEncoder

func (c *CustomMarshaler) NewEncoder(w io.Writer) runtime.Encoder

func (*CustomMarshaler) Unmarshal

func (c *CustomMarshaler) Unmarshal(data []byte, v interface{}) error

type DataPoint

type DataPoint struct {
	Timestamp int64   `protobuf:"varint,1,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	Value     float64 `protobuf:"fixed64,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Represents the data point in timeseries.

func (*DataPoint) Descriptor deprecated

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

Deprecated: Use DataPoint.ProtoReflect.Descriptor instead.

func (*DataPoint) GetTimestamp

func (x *DataPoint) GetTimestamp() int64

func (*DataPoint) GetValue

func (x *DataPoint) GetValue() float64

func (*DataPoint) ProtoMessage

func (*DataPoint) ProtoMessage()

func (*DataPoint) ProtoReflect

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

func (*DataPoint) Reset

func (x *DataPoint) Reset()

func (*DataPoint) String

func (x *DataPoint) String() string

type DatabaseMetadata

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

func (*DatabaseMetadata) Descriptor deprecated

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

Deprecated: Use DatabaseMetadata.ProtoReflect.Descriptor instead.

func (*DatabaseMetadata) ProtoMessage

func (*DatabaseMetadata) ProtoMessage()

func (*DatabaseMetadata) ProtoReflect

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

func (*DatabaseMetadata) Reset

func (x *DatabaseMetadata) Reset()

func (*DatabaseMetadata) String

func (x *DatabaseMetadata) String() string

type DatabaseOptions

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

Database requests modifying options.

func (*DatabaseOptions) Descriptor deprecated

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

Deprecated: Use DatabaseOptions.ProtoReflect.Descriptor instead.

func (*DatabaseOptions) ProtoMessage

func (*DatabaseOptions) ProtoMessage()

func (*DatabaseOptions) ProtoReflect

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

func (*DatabaseOptions) Reset

func (x *DatabaseOptions) Reset()

func (*DatabaseOptions) String

func (x *DatabaseOptions) String() string

type DelRequest

type DelRequest struct {

	// Tigris project name
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// cache name
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// cache key
	Key string `protobuf:"bytes,3,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

func (*DelRequest) Descriptor deprecated

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

Deprecated: Use DelRequest.ProtoReflect.Descriptor instead.

func (*DelRequest) GetKey

func (x *DelRequest) GetKey() string

func (*DelRequest) GetName

func (x *DelRequest) GetName() string

func (*DelRequest) GetProject

func (x *DelRequest) GetProject() string

func (*DelRequest) ProtoMessage

func (*DelRequest) ProtoMessage()

func (*DelRequest) ProtoReflect

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

func (*DelRequest) Reset

func (x *DelRequest) Reset()

func (*DelRequest) String

func (x *DelRequest) String() string

type DelResponse

type DelResponse struct {

	// A detailed response message.
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// An enum with value set as "deleted" or "not_found"
	Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*DelResponse) Descriptor deprecated

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

Deprecated: Use DelResponse.ProtoReflect.Descriptor instead.

func (*DelResponse) GetMessage

func (x *DelResponse) GetMessage() string

func (*DelResponse) GetStatus

func (x *DelResponse) GetStatus() string

func (*DelResponse) ProtoMessage

func (*DelResponse) ProtoMessage()

func (*DelResponse) ProtoReflect

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

func (*DelResponse) Reset

func (x *DelResponse) Reset()

func (*DelResponse) String

func (x *DelResponse) String() string

type DeleteAppKeyRequest

type DeleteAppKeyRequest struct {

	// app_key id
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// project name
	Project string `protobuf:"bytes,2,opt,name=project,proto3" json:"project,omitempty"`
	// contains filtered or unexported fields
}

Request deletion of an app key

func (*DeleteAppKeyRequest) Descriptor deprecated

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

Deprecated: Use DeleteAppKeyRequest.ProtoReflect.Descriptor instead.

func (*DeleteAppKeyRequest) GetId

func (x *DeleteAppKeyRequest) GetId() string

func (*DeleteAppKeyRequest) GetProject

func (x *DeleteAppKeyRequest) GetProject() string

func (*DeleteAppKeyRequest) ProtoMessage

func (*DeleteAppKeyRequest) ProtoMessage()

func (*DeleteAppKeyRequest) ProtoReflect

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

func (*DeleteAppKeyRequest) Reset

func (x *DeleteAppKeyRequest) Reset()

func (*DeleteAppKeyRequest) String

func (x *DeleteAppKeyRequest) String() string

type DeleteAppKeyResponse

type DeleteAppKeyResponse struct {

	// status flag for delete operation
	Deleted bool `protobuf:"varint,1,opt,name=deleted,proto3" json:"deleted,omitempty"`
	// contains filtered or unexported fields
}

AppKeys returns the flag to convey if app key was deleted

func (*DeleteAppKeyResponse) Descriptor deprecated

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

Deprecated: Use DeleteAppKeyResponse.ProtoReflect.Descriptor instead.

func (*DeleteAppKeyResponse) GetDeleted

func (x *DeleteAppKeyResponse) GetDeleted() bool

func (*DeleteAppKeyResponse) ProtoMessage

func (*DeleteAppKeyResponse) ProtoMessage()

func (*DeleteAppKeyResponse) ProtoReflect

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

func (*DeleteAppKeyResponse) Reset

func (x *DeleteAppKeyResponse) Reset()

func (*DeleteAppKeyResponse) String

func (x *DeleteAppKeyResponse) String() string

type DeleteBranchRequest

type DeleteBranchRequest struct {

	// Delete a database branch in this project
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// Name of the database branch to delete.
	// <p></p>**Note**: `main` branch cannot be deleted, use DeleteProject instead
	Branch string `protobuf:"bytes,2,opt,name=branch,proto3" json:"branch,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteBranchRequest) Descriptor deprecated

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

Deprecated: Use DeleteBranchRequest.ProtoReflect.Descriptor instead.

func (*DeleteBranchRequest) GetBranch

func (x *DeleteBranchRequest) GetBranch() string

func (*DeleteBranchRequest) GetProject

func (x *DeleteBranchRequest) GetProject() string

func (*DeleteBranchRequest) ProtoMessage

func (*DeleteBranchRequest) ProtoMessage()

func (*DeleteBranchRequest) ProtoReflect

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

func (*DeleteBranchRequest) Reset

func (x *DeleteBranchRequest) Reset()

func (*DeleteBranchRequest) String

func (x *DeleteBranchRequest) String() string

type DeleteBranchResponse

type DeleteBranchResponse struct {

	// A detailed response message.
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// An enum with value set as "deleted".
	Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteBranchResponse) Descriptor deprecated

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

Deprecated: Use DeleteBranchResponse.ProtoReflect.Descriptor instead.

func (*DeleteBranchResponse) GetMessage

func (x *DeleteBranchResponse) GetMessage() string

func (*DeleteBranchResponse) GetStatus

func (x *DeleteBranchResponse) GetStatus() string

func (*DeleteBranchResponse) ProtoMessage

func (*DeleteBranchResponse) ProtoMessage()

func (*DeleteBranchResponse) ProtoReflect

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

func (*DeleteBranchResponse) Reset

func (x *DeleteBranchResponse) Reset()

func (*DeleteBranchResponse) String

func (x *DeleteBranchResponse) String() string

type DeleteByQueryRequest

type DeleteByQueryRequest struct {

	// The project name.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// The index name of the documents that needs deletion.
	Index string `protobuf:"bytes,2,opt,name=index,proto3" json:"index,omitempty"`
	// A filter is required to delete matching documents. To delete document by id, you can pass the
	// filter as follows “`{"id": "test"}“`
	Filter []byte `protobuf:"bytes,3,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteByQueryRequest) Descriptor deprecated

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

Deprecated: Use DeleteByQueryRequest.ProtoReflect.Descriptor instead.

func (*DeleteByQueryRequest) GetFilter

func (x *DeleteByQueryRequest) GetFilter() []byte

func (*DeleteByQueryRequest) GetIndex

func (x *DeleteByQueryRequest) GetIndex() string

func (*DeleteByQueryRequest) GetProject

func (x *DeleteByQueryRequest) GetProject() string

func (*DeleteByQueryRequest) ProtoMessage

func (*DeleteByQueryRequest) ProtoMessage()

func (*DeleteByQueryRequest) ProtoReflect

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

func (*DeleteByQueryRequest) Reset

func (x *DeleteByQueryRequest) Reset()

func (*DeleteByQueryRequest) String

func (x *DeleteByQueryRequest) String() string

func (*DeleteByQueryRequest) UnmarshalJSON

func (x *DeleteByQueryRequest) UnmarshalJSON(data []byte) error

type DeleteByQueryResponse

type DeleteByQueryResponse struct {

	// The number of documents deleted.
	Count int32 `protobuf:"varint,1,opt,name=count,proto3" json:"count,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteByQueryResponse) Descriptor deprecated

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

Deprecated: Use DeleteByQueryResponse.ProtoReflect.Descriptor instead.

func (*DeleteByQueryResponse) GetCount

func (x *DeleteByQueryResponse) GetCount() int32

func (*DeleteByQueryResponse) ProtoMessage

func (*DeleteByQueryResponse) ProtoMessage()

func (*DeleteByQueryResponse) ProtoReflect

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

func (*DeleteByQueryResponse) Reset

func (x *DeleteByQueryResponse) Reset()

func (*DeleteByQueryResponse) String

func (x *DeleteByQueryResponse) String() string

type DeleteCacheRequest

type DeleteCacheRequest struct {

	// Tigris project name
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// cache name
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteCacheRequest) Descriptor deprecated

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

Deprecated: Use DeleteCacheRequest.ProtoReflect.Descriptor instead.

func (*DeleteCacheRequest) GetName

func (x *DeleteCacheRequest) GetName() string

func (*DeleteCacheRequest) GetProject

func (x *DeleteCacheRequest) GetProject() string

func (*DeleteCacheRequest) ProtoMessage

func (*DeleteCacheRequest) ProtoMessage()

func (*DeleteCacheRequest) ProtoReflect

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

func (*DeleteCacheRequest) Reset

func (x *DeleteCacheRequest) Reset()

func (*DeleteCacheRequest) String

func (x *DeleteCacheRequest) String() string

type DeleteCacheResponse

type DeleteCacheResponse struct {

	// A detailed response message.
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// An enum with value set as "deleted"
	Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteCacheResponse) Descriptor deprecated

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

Deprecated: Use DeleteCacheResponse.ProtoReflect.Descriptor instead.

func (*DeleteCacheResponse) GetMessage

func (x *DeleteCacheResponse) GetMessage() string

func (*DeleteCacheResponse) GetStatus

func (x *DeleteCacheResponse) GetStatus() string

func (*DeleteCacheResponse) ProtoMessage

func (*DeleteCacheResponse) ProtoMessage()

func (*DeleteCacheResponse) ProtoReflect

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

func (*DeleteCacheResponse) Reset

func (x *DeleteCacheResponse) Reset()

func (*DeleteCacheResponse) String

func (x *DeleteCacheResponse) String() string

type DeleteDocumentRequest

type DeleteDocumentRequest struct {

	// The project name.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// The index name of the documents that needs deletion.
	Index string `protobuf:"bytes,2,opt,name=index,proto3" json:"index,omitempty"`
	// A list of ids
	Ids []string `protobuf:"bytes,3,rep,name=ids,proto3" json:"ids,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteDocumentRequest) Descriptor deprecated

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

Deprecated: Use DeleteDocumentRequest.ProtoReflect.Descriptor instead.

func (*DeleteDocumentRequest) GetIds

func (x *DeleteDocumentRequest) GetIds() []string

func (*DeleteDocumentRequest) GetIndex

func (x *DeleteDocumentRequest) GetIndex() string

func (*DeleteDocumentRequest) GetProject

func (x *DeleteDocumentRequest) GetProject() string

func (*DeleteDocumentRequest) ProtoMessage

func (*DeleteDocumentRequest) ProtoMessage()

func (*DeleteDocumentRequest) ProtoReflect

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

func (*DeleteDocumentRequest) Reset

func (x *DeleteDocumentRequest) Reset()

func (*DeleteDocumentRequest) String

func (x *DeleteDocumentRequest) String() string

func (*DeleteDocumentRequest) UnmarshalJSON

func (x *DeleteDocumentRequest) UnmarshalJSON(data []byte) error

type DeleteDocumentResponse

type DeleteDocumentResponse struct {

	// An array of statuses of all the documents received in the request. Order is same as it is received in the
	// request. Each item of this array has an “id” and “error” key. Id is set as document id and error will be null
	// in case of success, otherwise error is set with an error code and message.
	Status []*DocStatus `protobuf:"bytes,1,rep,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteDocumentResponse) Descriptor deprecated

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

Deprecated: Use DeleteDocumentResponse.ProtoReflect.Descriptor instead.

func (*DeleteDocumentResponse) GetStatus

func (x *DeleteDocumentResponse) GetStatus() []*DocStatus

func (*DeleteDocumentResponse) ProtoMessage

func (*DeleteDocumentResponse) ProtoMessage()

func (*DeleteDocumentResponse) ProtoReflect

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

func (*DeleteDocumentResponse) Reset

func (x *DeleteDocumentResponse) Reset()

func (*DeleteDocumentResponse) String

func (x *DeleteDocumentResponse) String() string

type DeleteIndexRequest

type DeleteIndexRequest struct {

	// Tigris project name.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// index name.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteIndexRequest) Descriptor deprecated

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

Deprecated: Use DeleteIndexRequest.ProtoReflect.Descriptor instead.

func (*DeleteIndexRequest) GetName

func (x *DeleteIndexRequest) GetName() string

func (*DeleteIndexRequest) GetProject

func (x *DeleteIndexRequest) GetProject() string

func (*DeleteIndexRequest) ProtoMessage

func (*DeleteIndexRequest) ProtoMessage()

func (*DeleteIndexRequest) ProtoReflect

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

func (*DeleteIndexRequest) Reset

func (x *DeleteIndexRequest) Reset()

func (*DeleteIndexRequest) String

func (x *DeleteIndexRequest) String() string

type DeleteIndexResponse

type DeleteIndexResponse struct {

	// A detailed response message.
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// An enum with value set as "deleted".
	Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteIndexResponse) Descriptor deprecated

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

Deprecated: Use DeleteIndexResponse.ProtoReflect.Descriptor instead.

func (*DeleteIndexResponse) GetMessage

func (x *DeleteIndexResponse) GetMessage() string

func (*DeleteIndexResponse) GetStatus

func (x *DeleteIndexResponse) GetStatus() string

func (*DeleteIndexResponse) ProtoMessage

func (*DeleteIndexResponse) ProtoMessage()

func (*DeleteIndexResponse) ProtoReflect

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

func (*DeleteIndexResponse) Reset

func (x *DeleteIndexResponse) Reset()

func (*DeleteIndexResponse) String

func (x *DeleteIndexResponse) String() string

type DeleteProjectRequest

type DeleteProjectRequest struct {

	// Delete Project with this name.
	// <p></p>**Note**: Deletes all resources under this project. Use with caution.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteProjectRequest) Descriptor deprecated

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

Deprecated: Use DeleteProjectRequest.ProtoReflect.Descriptor instead.

func (*DeleteProjectRequest) GetProject

func (x *DeleteProjectRequest) GetProject() string

func (*DeleteProjectRequest) ProtoMessage

func (*DeleteProjectRequest) ProtoMessage()

func (*DeleteProjectRequest) ProtoReflect

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

func (*DeleteProjectRequest) Reset

func (x *DeleteProjectRequest) Reset()

func (*DeleteProjectRequest) String

func (x *DeleteProjectRequest) String() string

type DeleteProjectResponse

type DeleteProjectResponse struct {

	// A detailed response message.
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// An enum with value set as "dropped".
	Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteProjectResponse) Descriptor deprecated

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

Deprecated: Use DeleteProjectResponse.ProtoReflect.Descriptor instead.

func (*DeleteProjectResponse) GetMessage

func (x *DeleteProjectResponse) GetMessage() string

func (*DeleteProjectResponse) GetStatus

func (x *DeleteProjectResponse) GetStatus() string

func (*DeleteProjectResponse) ProtoMessage

func (*DeleteProjectResponse) ProtoMessage()

func (*DeleteProjectResponse) ProtoReflect

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

func (*DeleteProjectResponse) Reset

func (x *DeleteProjectResponse) Reset()

func (*DeleteProjectResponse) String

func (x *DeleteProjectResponse) String() string

type DeleteRequest

type DeleteRequest struct {

	// Project name whose db is under target to delete documents.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// Collection name where to insert documents.
	Collection string `protobuf:"bytes,2,opt,name=collection,proto3" json:"collection,omitempty"`
	// Delete documents which matching specified filter.
	// A filter can simply be key, value where key
	// is the field name and value would be the value for this field. Or a filter can be logical where
	// two or more fields can be logically joined using $or and $and. A few examples of filter:
	// <li> To delete a user document where the id has a value 1: “`{"id": 1 }“`
	// <li> To delete all the user documents where the key "id" has a value 1 or 2 or 3: `{"$or": [{"id": 1}, {"id": 2}, {"id": 3}]}`
	Filter  []byte                `protobuf:"bytes,3,opt,name=filter,proto3" json:"filter,omitempty"`
	Options *DeleteRequestOptions `protobuf:"bytes,4,opt,name=options,proto3" json:"options,omitempty"`
	// Optionally specify a database branch name to perform operation on
	Branch string `protobuf:"bytes,5,opt,name=branch,proto3" json:"branch,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteRequest) Descriptor deprecated

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

Deprecated: Use DeleteRequest.ProtoReflect.Descriptor instead.

func (*DeleteRequest) GetBranch

func (x *DeleteRequest) GetBranch() string

func (*DeleteRequest) GetCollection

func (x *DeleteRequest) GetCollection() string

func (*DeleteRequest) GetFilter

func (x *DeleteRequest) GetFilter() []byte

func (*DeleteRequest) GetOptions

func (x *DeleteRequest) GetOptions() *DeleteRequestOptions

func (*DeleteRequest) GetProject

func (x *DeleteRequest) GetProject() string

func (*DeleteRequest) ProtoMessage

func (*DeleteRequest) ProtoMessage()

func (*DeleteRequest) ProtoReflect

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

func (*DeleteRequest) Reset

func (x *DeleteRequest) Reset()

func (*DeleteRequest) String

func (x *DeleteRequest) String() string

func (*DeleteRequest) UnmarshalJSON

func (x *DeleteRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON on DeleteRequest avoids unmarshalling filter and instead this way we can write a custom struct to do the unmarshalling and will be avoiding any extra allocation/copying.

type DeleteRequestOptions

type DeleteRequestOptions struct {
	WriteOptions *WriteOptions `protobuf:"bytes,1,opt,name=write_options,json=writeOptions,proto3" json:"write_options,omitempty"`
	// A collation allows you to specify string comparison rules. Default is case-sensitive, to override it you can set
	// this option to 'ci' that will apply to all the text fields in the filters.
	Collation *Collation `protobuf:"bytes,2,opt,name=collation,proto3" json:"collation,omitempty"`
	// Limit the number of documents to be deleted
	Limit int64 `protobuf:"varint,3,opt,name=limit,proto3" json:"limit,omitempty"`
	// contains filtered or unexported fields
}

Additional options for deleted requests.

func (*DeleteRequestOptions) Descriptor deprecated

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

Deprecated: Use DeleteRequestOptions.ProtoReflect.Descriptor instead.

func (*DeleteRequestOptions) GetCollation

func (x *DeleteRequestOptions) GetCollation() *Collation

func (*DeleteRequestOptions) GetLimit

func (x *DeleteRequestOptions) GetLimit() int64

func (*DeleteRequestOptions) GetWriteOptions

func (x *DeleteRequestOptions) GetWriteOptions() *WriteOptions

func (*DeleteRequestOptions) ProtoMessage

func (*DeleteRequestOptions) ProtoMessage()

func (*DeleteRequestOptions) ProtoReflect

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

func (*DeleteRequestOptions) Reset

func (x *DeleteRequestOptions) Reset()

func (*DeleteRequestOptions) String

func (x *DeleteRequestOptions) String() string

type DeleteResponse

type DeleteResponse struct {

	// Has metadata related to the documents stored.
	Metadata *ResponseMetadata `protobuf:"bytes,1,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// an enum with value set as "deleted"
	Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// Returns the number of documents deleted.
	DeletedCount int32 `protobuf:"varint,3,opt,name=deleted_count,json=deletedCount,proto3" json:"deleted_count,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteResponse) Descriptor deprecated

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

Deprecated: Use DeleteResponse.ProtoReflect.Descriptor instead.

func (*DeleteResponse) GetDeletedCount

func (x *DeleteResponse) GetDeletedCount() int32

func (*DeleteResponse) GetMetadata

func (x *DeleteResponse) GetMetadata() *ResponseMetadata

func (*DeleteResponse) GetStatus

func (x *DeleteResponse) GetStatus() string

func (*DeleteResponse) MarshalJSON

func (x *DeleteResponse) MarshalJSON() ([]byte, error)

func (*DeleteResponse) ProtoMessage

func (*DeleteResponse) ProtoMessage()

func (*DeleteResponse) ProtoReflect

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

func (*DeleteResponse) Reset

func (x *DeleteResponse) Reset()

func (*DeleteResponse) String

func (x *DeleteResponse) String() string

type DescribeCollectionRequest

type DescribeCollectionRequest struct {

	// Project name whose db is under target to get description of its collection.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// Name of the collection.
	Collection string `protobuf:"bytes,2,opt,name=collection,proto3" json:"collection,omitempty"`
	// Return schema in the requested format.
	// Format can be JSON, Go, TypeScript, Java.
	// Default is JSON.
	SchemaFormat string `protobuf:"bytes,3,opt,name=schema_format,json=schemaFormat,proto3" json:"schema_format,omitempty"`
	// Collection options.
	Options *CollectionOptions `protobuf:"bytes,4,opt,name=options,proto3" json:"options,omitempty"`
	// Optionally specify a database branch name to perform operation on
	Branch string `protobuf:"bytes,5,opt,name=branch,proto3" json:"branch,omitempty"`
	// contains filtered or unexported fields
}

func (*DescribeCollectionRequest) Descriptor deprecated

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

Deprecated: Use DescribeCollectionRequest.ProtoReflect.Descriptor instead.

func (*DescribeCollectionRequest) GetBranch

func (x *DescribeCollectionRequest) GetBranch() string

func (*DescribeCollectionRequest) GetCollection

func (x *DescribeCollectionRequest) GetCollection() string

func (*DescribeCollectionRequest) GetOptions

func (*DescribeCollectionRequest) GetProject

func (x *DescribeCollectionRequest) GetProject() string

func (*DescribeCollectionRequest) GetSchemaFormat

func (x *DescribeCollectionRequest) GetSchemaFormat() string

func (*DescribeCollectionRequest) ProtoMessage

func (*DescribeCollectionRequest) ProtoMessage()

func (*DescribeCollectionRequest) ProtoReflect

func (*DescribeCollectionRequest) Reset

func (x *DescribeCollectionRequest) Reset()

func (*DescribeCollectionRequest) String

func (x *DescribeCollectionRequest) String() string

type DescribeCollectionResponse

type DescribeCollectionResponse struct {

	// Name of the collection.
	Collection string `protobuf:"bytes,1,opt,name=collection,proto3" json:"collection,omitempty"`
	// Metadata about the collection.
	Metadata *CollectionMetadata `protobuf:"bytes,2,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Schema of this collection.
	Schema []byte `protobuf:"bytes,3,opt,name=schema,proto3" json:"schema,omitempty"`
	// The size of this collection in bytes.
	Size int64 `protobuf:"varint,4,opt,name=size,proto3" json:"size,omitempty"`
	// contains filtered or unexported fields
}

A detailed description of the collection. The description returns collection metadata and the schema.

func (*DescribeCollectionResponse) Descriptor deprecated

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

Deprecated: Use DescribeCollectionResponse.ProtoReflect.Descriptor instead.

func (*DescribeCollectionResponse) GetCollection

func (x *DescribeCollectionResponse) GetCollection() string

func (*DescribeCollectionResponse) GetMetadata

func (*DescribeCollectionResponse) GetSchema

func (x *DescribeCollectionResponse) GetSchema() []byte

func (*DescribeCollectionResponse) GetSize

func (x *DescribeCollectionResponse) GetSize() int64

func (*DescribeCollectionResponse) MarshalJSON

func (x *DescribeCollectionResponse) MarshalJSON() ([]byte, error)

func (*DescribeCollectionResponse) ProtoMessage

func (*DescribeCollectionResponse) ProtoMessage()

func (*DescribeCollectionResponse) ProtoReflect

func (*DescribeCollectionResponse) Reset

func (x *DescribeCollectionResponse) Reset()

func (*DescribeCollectionResponse) String

func (x *DescribeCollectionResponse) String() string

type DescribeDatabaseRequest

type DescribeDatabaseRequest struct {

	// Project name whose db is under target to get description.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// Return schema in the requested format.
	// Format can be JSON, Go, TypeScript, Java.
	// Default is JSON.
	SchemaFormat string `protobuf:"bytes,2,opt,name=schema_format,json=schemaFormat,proto3" json:"schema_format,omitempty"`
	// Optionally specify a database branch name to perform operation on
	Branch string `protobuf:"bytes,3,opt,name=branch,proto3" json:"branch,omitempty"`
	// contains filtered or unexported fields
}

func (*DescribeDatabaseRequest) Descriptor deprecated

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

Deprecated: Use DescribeDatabaseRequest.ProtoReflect.Descriptor instead.

func (*DescribeDatabaseRequest) GetBranch

func (x *DescribeDatabaseRequest) GetBranch() string

func (*DescribeDatabaseRequest) GetProject

func (x *DescribeDatabaseRequest) GetProject() string

func (*DescribeDatabaseRequest) GetSchemaFormat

func (x *DescribeDatabaseRequest) GetSchemaFormat() string

func (*DescribeDatabaseRequest) ProtoMessage

func (*DescribeDatabaseRequest) ProtoMessage()

func (*DescribeDatabaseRequest) ProtoReflect

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

func (*DescribeDatabaseRequest) Reset

func (x *DescribeDatabaseRequest) Reset()

func (*DescribeDatabaseRequest) String

func (x *DescribeDatabaseRequest) String() string

type DescribeDatabaseResponse

type DescribeDatabaseResponse struct {

	// Metadata about the database.
	Metadata *DatabaseMetadata `protobuf:"bytes,1,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// A detailed description about all the collections.
	// The description returns collection metadata and the schema.
	Collections []*CollectionDescription `protobuf:"bytes,2,rep,name=collections,proto3" json:"collections,omitempty"`
	// Sum of all the collections sizes present in this database
	Size int64 `protobuf:"varint,3,opt,name=size,proto3" json:"size,omitempty"`
	// List of all the branches in this database
	Branches []string `protobuf:"bytes,4,rep,name=branches,proto3" json:"branches,omitempty"`
	// contains filtered or unexported fields
}

A detailed description of the database and all the associated collections. Description of the collection includes schema details as well.

func (*DescribeDatabaseResponse) Descriptor deprecated

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

Deprecated: Use DescribeDatabaseResponse.ProtoReflect.Descriptor instead.

func (*DescribeDatabaseResponse) GetBranches

func (x *DescribeDatabaseResponse) GetBranches() []string

func (*DescribeDatabaseResponse) GetCollections

func (x *DescribeDatabaseResponse) GetCollections() []*CollectionDescription

func (*DescribeDatabaseResponse) GetMetadata

func (x *DescribeDatabaseResponse) GetMetadata() *DatabaseMetadata

func (*DescribeDatabaseResponse) GetSize

func (x *DescribeDatabaseResponse) GetSize() int64

func (*DescribeDatabaseResponse) MarshalJSON

func (x *DescribeDatabaseResponse) MarshalJSON() ([]byte, error)

func (*DescribeDatabaseResponse) ProtoMessage

func (*DescribeDatabaseResponse) ProtoMessage()

func (*DescribeDatabaseResponse) ProtoReflect

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

func (*DescribeDatabaseResponse) Reset

func (x *DescribeDatabaseResponse) Reset()

func (*DescribeDatabaseResponse) String

func (x *DescribeDatabaseResponse) String() string

type DescribeNamespacesData

type DescribeNamespacesData struct {
	Details string `protobuf:"bytes,1,opt,name=details,proto3" json:"details,omitempty"`
	// contains filtered or unexported fields
}

func (*DescribeNamespacesData) Descriptor deprecated

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

Deprecated: Use DescribeNamespacesData.ProtoReflect.Descriptor instead.

func (*DescribeNamespacesData) GetDetails

func (x *DescribeNamespacesData) GetDetails() string

func (*DescribeNamespacesData) ProtoMessage

func (*DescribeNamespacesData) ProtoMessage()

func (*DescribeNamespacesData) ProtoReflect

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

func (*DescribeNamespacesData) Reset

func (x *DescribeNamespacesData) Reset()

func (*DescribeNamespacesData) String

func (x *DescribeNamespacesData) String() string

type DescribeNamespacesRequest

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

func (*DescribeNamespacesRequest) Descriptor deprecated

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

Deprecated: Use DescribeNamespacesRequest.ProtoReflect.Descriptor instead.

func (*DescribeNamespacesRequest) ProtoMessage

func (*DescribeNamespacesRequest) ProtoMessage()

func (*DescribeNamespacesRequest) ProtoReflect

func (*DescribeNamespacesRequest) Reset

func (x *DescribeNamespacesRequest) Reset()

func (*DescribeNamespacesRequest) String

func (x *DescribeNamespacesRequest) String() string

type DescribeNamespacesResponse

type DescribeNamespacesResponse struct {
	Data *DescribeNamespacesData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*DescribeNamespacesResponse) Descriptor deprecated

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

Deprecated: Use DescribeNamespacesResponse.ProtoReflect.Descriptor instead.

func (*DescribeNamespacesResponse) GetData

func (*DescribeNamespacesResponse) ProtoMessage

func (*DescribeNamespacesResponse) ProtoMessage()

func (*DescribeNamespacesResponse) ProtoReflect

func (*DescribeNamespacesResponse) Reset

func (x *DescribeNamespacesResponse) Reset()

func (*DescribeNamespacesResponse) String

func (x *DescribeNamespacesResponse) String() string

type DetachEvent

type DetachEvent struct {
	Channel string `protobuf:"bytes,1,opt,name=channel,proto3" json:"channel,omitempty"`
	// contains filtered or unexported fields
}

func (*DetachEvent) Descriptor deprecated

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

Deprecated: Use DetachEvent.ProtoReflect.Descriptor instead.

func (*DetachEvent) GetChannel

func (x *DetachEvent) GetChannel() string

func (*DetachEvent) ProtoMessage

func (*DetachEvent) ProtoMessage()

func (*DetachEvent) ProtoReflect

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

func (*DetachEvent) Reset

func (x *DetachEvent) Reset()

func (*DetachEvent) String

func (x *DetachEvent) String() string

type DisconnectEvent

type DisconnectEvent struct {
	Channel string `protobuf:"bytes,1,opt,name=channel,proto3" json:"channel,omitempty"`
	// contains filtered or unexported fields
}

func (*DisconnectEvent) Descriptor deprecated

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

Deprecated: Use DisconnectEvent.ProtoReflect.Descriptor instead.

func (*DisconnectEvent) GetChannel

func (x *DisconnectEvent) GetChannel() string

func (*DisconnectEvent) ProtoMessage

func (*DisconnectEvent) ProtoMessage()

func (*DisconnectEvent) ProtoReflect

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

func (*DisconnectEvent) Reset

func (x *DisconnectEvent) Reset()

func (*DisconnectEvent) String

func (x *DisconnectEvent) String() string

type DocStatus

type DocStatus struct {

	// An id of the document.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// An error that has "code" and "message". It is set as null in case there is no error.
	Error *Error `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`
	// contains filtered or unexported fields
}

func (*DocStatus) Descriptor deprecated

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

Deprecated: Use DocStatus.ProtoReflect.Descriptor instead.

func (*DocStatus) GetError

func (x *DocStatus) GetError() *Error

func (*DocStatus) GetId

func (x *DocStatus) GetId() string

func (*DocStatus) MarshalJSON

func (x *DocStatus) MarshalJSON() ([]byte, error)

func (*DocStatus) ProtoMessage

func (*DocStatus) ProtoMessage()

func (*DocStatus) ProtoReflect

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

func (*DocStatus) Reset

func (x *DocStatus) Reset()

func (*DocStatus) String

func (x *DocStatus) String() string

type DropCollectionRequest

type DropCollectionRequest struct {

	// Project name whose db is under target to delete collection.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// Collection name to delete.
	Collection string             `protobuf:"bytes,2,opt,name=collection,proto3" json:"collection,omitempty"`
	Options    *CollectionOptions `protobuf:"bytes,3,opt,name=options,proto3" json:"options,omitempty"`
	// Optionally specify a project branch name to perform operation on
	Branch string `protobuf:"bytes,4,opt,name=branch,proto3" json:"branch,omitempty"`
	// contains filtered or unexported fields
}

func (*DropCollectionRequest) Descriptor deprecated

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

Deprecated: Use DropCollectionRequest.ProtoReflect.Descriptor instead.

func (*DropCollectionRequest) GetBranch

func (x *DropCollectionRequest) GetBranch() string

func (*DropCollectionRequest) GetCollection

func (x *DropCollectionRequest) GetCollection() string

func (*DropCollectionRequest) GetOptions

func (x *DropCollectionRequest) GetOptions() *CollectionOptions

func (*DropCollectionRequest) GetProject

func (x *DropCollectionRequest) GetProject() string

func (*DropCollectionRequest) ProtoMessage

func (*DropCollectionRequest) ProtoMessage()

func (*DropCollectionRequest) ProtoReflect

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

func (*DropCollectionRequest) Reset

func (x *DropCollectionRequest) Reset()

func (*DropCollectionRequest) String

func (x *DropCollectionRequest) String() string

type DropCollectionResponse

type DropCollectionResponse struct {

	// A detailed response message.
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// An enum with value set as "dropped".
	Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*DropCollectionResponse) Descriptor deprecated

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

Deprecated: Use DropCollectionResponse.ProtoReflect.Descriptor instead.

func (*DropCollectionResponse) GetMessage

func (x *DropCollectionResponse) GetMessage() string

func (*DropCollectionResponse) GetStatus

func (x *DropCollectionResponse) GetStatus() string

func (*DropCollectionResponse) ProtoMessage

func (*DropCollectionResponse) ProtoMessage()

func (*DropCollectionResponse) ProtoReflect

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

func (*DropCollectionResponse) Reset

func (x *DropCollectionResponse) Reset()

func (*DropCollectionResponse) String

func (x *DropCollectionResponse) String() string

type Error

type Error struct {

	// The status code is a short, machine parsable string,
	// which uniquely identifies the error type.
	// Tigris to HTTP code mapping [here](/reference/http-code)
	Code Code `protobuf:"varint,1,opt,name=code,proto3,enum=tigrisdata.observability.v1.Code" json:"code,omitempty"`
	// A developer-facing descriptive error message
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

The Error type defines a logical error model

func (*Error) Descriptor deprecated

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

Deprecated: Use Error.ProtoReflect.Descriptor instead.

func (*Error) GetCode

func (x *Error) GetCode() Code

func (*Error) GetMessage

func (x *Error) GetMessage() string

func (*Error) ProtoMessage

func (*Error) ProtoMessage()

func (*Error) ProtoReflect

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

func (*Error) Reset

func (x *Error) Reset()

func (*Error) String

func (x *Error) String() string

type ErrorDetails

type ErrorDetails struct {
	Code    string     `protobuf:"bytes,1,opt,name=code,proto3" json:"code,omitempty"`
	Message string     `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	Retry   *RetryInfo `protobuf:"bytes,3,opt,name=retry,proto3" json:"retry,omitempty"`
	// contains filtered or unexported fields
}

ErrorDetails defines error format passed by Tigris HTTP protocol

func (*ErrorDetails) Descriptor deprecated

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

Deprecated: Use ErrorDetails.ProtoReflect.Descriptor instead.

func (*ErrorDetails) GetCode

func (x *ErrorDetails) GetCode() string

func (*ErrorDetails) GetMessage

func (x *ErrorDetails) GetMessage() string

func (*ErrorDetails) GetRetry

func (x *ErrorDetails) GetRetry() *RetryInfo

func (*ErrorDetails) ProtoMessage

func (*ErrorDetails) ProtoMessage()

func (*ErrorDetails) ProtoReflect

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

func (*ErrorDetails) Reset

func (x *ErrorDetails) Reset()

func (*ErrorDetails) String

func (x *ErrorDetails) String() string

type ErrorEvent

type ErrorEvent struct {
	Code    int32  `protobuf:"varint,1,opt,name=code,proto3" json:"code,omitempty"`
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

func (*ErrorEvent) Descriptor deprecated

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

Deprecated: Use ErrorEvent.ProtoReflect.Descriptor instead.

func (*ErrorEvent) GetCode

func (x *ErrorEvent) GetCode() int32

func (*ErrorEvent) GetMessage

func (x *ErrorEvent) GetMessage() string

func (*ErrorEvent) ProtoMessage

func (*ErrorEvent) ProtoMessage()

func (*ErrorEvent) ProtoReflect

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

func (*ErrorEvent) Reset

func (x *ErrorEvent) Reset()

func (*ErrorEvent) String

func (x *ErrorEvent) String() string

type EventType

type EventType int32
const (
	EventType_ack             EventType = 0
	EventType_auth            EventType = 1
	EventType_error           EventType = 2
	EventType_message         EventType = 3
	EventType_subscribe       EventType = 4
	EventType_presence        EventType = 5
	EventType_presence_member EventType = 6
	EventType_subscribed      EventType = 7
	EventType_unsubscribe     EventType = 8
	// if a heartbeat is delayed by up to D seconds, and our timeout is T,
	// the client sends a heartbeat command every (T - D) seconds, if it is not sending any other data.
	EventType_heartbeat    EventType = 9
	EventType_connected    EventType = 11
	EventType_disconnect   EventType = 12
	EventType_disconnected EventType = 13
	EventType_attach       EventType = 14
	EventType_detach       EventType = 15
)

func (EventType) Descriptor

func (EventType) Descriptor() protoreflect.EnumDescriptor

func (EventType) Enum

func (x EventType) Enum() *EventType

func (EventType) EnumDescriptor deprecated

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

Deprecated: Use EventType.Descriptor instead.

func (EventType) Number

func (x EventType) Number() protoreflect.EnumNumber

func (EventType) String

func (x EventType) String() string

func (EventType) Type

type FacetCount

type FacetCount struct {
	Count int64  `protobuf:"varint,1,opt,name=count,proto3" json:"count,omitempty"`
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*FacetCount) Descriptor deprecated

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

Deprecated: Use FacetCount.ProtoReflect.Descriptor instead.

func (*FacetCount) GetCount

func (x *FacetCount) GetCount() int64

func (*FacetCount) GetValue

func (x *FacetCount) GetValue() string

func (*FacetCount) ProtoMessage

func (*FacetCount) ProtoMessage()

func (*FacetCount) ProtoReflect

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

func (*FacetCount) Reset

func (x *FacetCount) Reset()

func (*FacetCount) String

func (x *FacetCount) String() string

type FacetStats

type FacetStats struct {

	// Average of all values in a field. Only available for numeric fields
	Avg *float64 `protobuf:"fixed64,1,opt,name=avg,proto3,oneof" json:"avg,omitempty"`
	// Maximum of all values in a field. Only available for numeric fields
	Max *float64 `protobuf:"fixed64,2,opt,name=max,proto3,oneof" json:"max,omitempty"`
	// Minimum of all values in a field. Only available for numeric fields
	Min *float64 `protobuf:"fixed64,3,opt,name=min,proto3,oneof" json:"min,omitempty"`
	// Sum of all values in a field. Only available for numeric fields
	Sum *float64 `protobuf:"fixed64,4,opt,name=sum,proto3,oneof" json:"sum,omitempty"`
	// Total number of values in a field
	Count int64 `protobuf:"varint,5,opt,name=count,proto3" json:"count,omitempty"`
	// contains filtered or unexported fields
}

Additional stats for faceted field

func (*FacetStats) Descriptor deprecated

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

Deprecated: Use FacetStats.ProtoReflect.Descriptor instead.

func (*FacetStats) GetAvg

func (x *FacetStats) GetAvg() float64

func (*FacetStats) GetCount

func (x *FacetStats) GetCount() int64

func (*FacetStats) GetMax

func (x *FacetStats) GetMax() float64

func (*FacetStats) GetMin

func (x *FacetStats) GetMin() float64

func (*FacetStats) GetSum

func (x *FacetStats) GetSum() float64

func (*FacetStats) MarshalJSON

func (x *FacetStats) MarshalJSON() ([]byte, error)

func (*FacetStats) ProtoMessage

func (*FacetStats) ProtoMessage()

func (*FacetStats) ProtoReflect

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

func (*FacetStats) Reset

func (x *FacetStats) Reset()

func (*FacetStats) String

func (x *FacetStats) String() string

type GetAccessTokenRequest

type GetAccessTokenRequest struct {
	GrantType GrantType `protobuf:"varint,1,opt,name=grant_type,json=grantType,proto3,enum=tigrisdata.auth.v1.GrantType" json:"grant_type,omitempty"`
	// Refresh token is required when grant type is set as `REFRESH_TOKEN`.
	RefreshToken string `protobuf:"bytes,2,opt,name=refresh_token,json=refreshToken,proto3" json:"refresh_token,omitempty"`
	// Client Id is required when grant type is set as `CLIENT_CREDENTIALS`.
	ClientId string `protobuf:"bytes,3,opt,name=client_id,json=clientId,proto3" json:"client_id,omitempty"`
	// Your Tigris API Key is required when grant type is set as `CLIENT_CREDENTIALS`.
	ClientSecret string `protobuf:"bytes,4,opt,name=client_secret,json=clientSecret,proto3" json:"client_secret,omitempty"`
	// contains filtered or unexported fields
}

The Request message for the GetAccessToken. The grant type is a required field and based on the grant type the other fields are used as mentioned below.

func (*GetAccessTokenRequest) Descriptor deprecated

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

Deprecated: Use GetAccessTokenRequest.ProtoReflect.Descriptor instead.

func (*GetAccessTokenRequest) GetClientId

func (x *GetAccessTokenRequest) GetClientId() string

func (*GetAccessTokenRequest) GetClientSecret

func (x *GetAccessTokenRequest) GetClientSecret() string

func (*GetAccessTokenRequest) GetGrantType

func (x *GetAccessTokenRequest) GetGrantType() GrantType

func (*GetAccessTokenRequest) GetRefreshToken

func (x *GetAccessTokenRequest) GetRefreshToken() string

func (*GetAccessTokenRequest) ProtoMessage

func (*GetAccessTokenRequest) ProtoMessage()

func (*GetAccessTokenRequest) ProtoReflect

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

func (*GetAccessTokenRequest) Reset

func (x *GetAccessTokenRequest) Reset()

func (*GetAccessTokenRequest) String

func (x *GetAccessTokenRequest) String() string

func (*GetAccessTokenRequest) UnmarshalJSON

func (x *GetAccessTokenRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON on GetAccessTokenRequest. Handles enum.

type GetAccessTokenResponse

type GetAccessTokenResponse struct {

	// An Access Token.
	AccessToken string `protobuf:"bytes,1,opt,name=access_token,json=accessToken,proto3" json:"access_token,omitempty"`
	// The Refresh Token.
	RefreshToken string `protobuf:"bytes,2,opt,name=refresh_token,json=refreshToken,proto3" json:"refresh_token,omitempty"`
	// Access token expiration timeout in seconds.
	ExpiresIn int32 `protobuf:"varint,3,opt,name=expires_in,json=expiresIn,proto3" json:"expires_in,omitempty"`
	// contains filtered or unexported fields
}

The response of GetAccessToken which contains access_token and optionally refresh_token.

func (*GetAccessTokenResponse) Descriptor deprecated

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

Deprecated: Use GetAccessTokenResponse.ProtoReflect.Descriptor instead.

func (*GetAccessTokenResponse) GetAccessToken

func (x *GetAccessTokenResponse) GetAccessToken() string

func (*GetAccessTokenResponse) GetExpiresIn

func (x *GetAccessTokenResponse) GetExpiresIn() int32

func (*GetAccessTokenResponse) GetRefreshToken

func (x *GetAccessTokenResponse) GetRefreshToken() string

func (*GetAccessTokenResponse) ProtoMessage

func (*GetAccessTokenResponse) ProtoMessage()

func (*GetAccessTokenResponse) ProtoReflect

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

func (*GetAccessTokenResponse) Reset

func (x *GetAccessTokenResponse) Reset()

func (*GetAccessTokenResponse) String

func (x *GetAccessTokenResponse) String() string

type GetDocumentRequest

type GetDocumentRequest struct {

	// Tigris project name.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// index name where to create documents.
	Index string `protobuf:"bytes,2,opt,name=index,proto3" json:"index,omitempty"`
	// document id.
	Ids []string `protobuf:"bytes,3,rep,name=ids,proto3" json:"ids,omitempty"`
	// contains filtered or unexported fields
}

func (*GetDocumentRequest) Descriptor deprecated

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

Deprecated: Use GetDocumentRequest.ProtoReflect.Descriptor instead.

func (*GetDocumentRequest) GetIds

func (x *GetDocumentRequest) GetIds() []string

func (*GetDocumentRequest) GetIndex

func (x *GetDocumentRequest) GetIndex() string

func (*GetDocumentRequest) GetProject

func (x *GetDocumentRequest) GetProject() string

func (*GetDocumentRequest) ProtoMessage

func (*GetDocumentRequest) ProtoMessage()

func (*GetDocumentRequest) ProtoReflect

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

func (*GetDocumentRequest) Reset

func (x *GetDocumentRequest) Reset()

func (*GetDocumentRequest) String

func (x *GetDocumentRequest) String() string

type GetDocumentResponse

type GetDocumentResponse struct {

	// An array of documents.
	Documents []*SearchHit `protobuf:"bytes,1,rep,name=documents,proto3" json:"documents,omitempty"`
	// contains filtered or unexported fields
}

func (*GetDocumentResponse) Descriptor deprecated

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

Deprecated: Use GetDocumentResponse.ProtoReflect.Descriptor instead.

func (*GetDocumentResponse) GetDocuments

func (x *GetDocumentResponse) GetDocuments() []*SearchHit

func (*GetDocumentResponse) MarshalJSON

func (x *GetDocumentResponse) MarshalJSON() ([]byte, error)

func (*GetDocumentResponse) ProtoMessage

func (*GetDocumentResponse) ProtoMessage()

func (*GetDocumentResponse) ProtoReflect

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

func (*GetDocumentResponse) Reset

func (x *GetDocumentResponse) Reset()

func (*GetDocumentResponse) String

func (x *GetDocumentResponse) String() string

type GetIndexRequest

type GetIndexRequest struct {

	// Tigris project name.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// index name.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*GetIndexRequest) Descriptor deprecated

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

Deprecated: Use GetIndexRequest.ProtoReflect.Descriptor instead.

func (*GetIndexRequest) GetName

func (x *GetIndexRequest) GetName() string

func (*GetIndexRequest) GetProject

func (x *GetIndexRequest) GetProject() string

func (*GetIndexRequest) ProtoMessage

func (*GetIndexRequest) ProtoMessage()

func (*GetIndexRequest) ProtoReflect

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

func (*GetIndexRequest) Reset

func (x *GetIndexRequest) Reset()

func (*GetIndexRequest) String

func (x *GetIndexRequest) String() string

type GetIndexResponse

type GetIndexResponse struct {

	// index info in the response.
	Index *IndexInfo `protobuf:"bytes,1,opt,name=index,proto3" json:"index,omitempty"`
	// contains filtered or unexported fields
}

func (*GetIndexResponse) Descriptor deprecated

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

Deprecated: Use GetIndexResponse.ProtoReflect.Descriptor instead.

func (*GetIndexResponse) GetIndex

func (x *GetIndexResponse) GetIndex() *IndexInfo

func (*GetIndexResponse) ProtoMessage

func (*GetIndexResponse) ProtoMessage()

func (*GetIndexResponse) ProtoReflect

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

func (*GetIndexResponse) Reset

func (x *GetIndexResponse) Reset()

func (*GetIndexResponse) String

func (x *GetIndexResponse) String() string

type GetInfoRequest

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

func (*GetInfoRequest) Descriptor deprecated

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

Deprecated: Use GetInfoRequest.ProtoReflect.Descriptor instead.

func (*GetInfoRequest) ProtoMessage

func (*GetInfoRequest) ProtoMessage()

func (*GetInfoRequest) ProtoReflect

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

func (*GetInfoRequest) Reset

func (x *GetInfoRequest) Reset()

func (*GetInfoRequest) String

func (x *GetInfoRequest) String() string

type GetInfoResponse

type GetInfoResponse struct {
	ServerVersion string `protobuf:"bytes,1,opt,name=server_version,json=serverVersion,proto3" json:"server_version,omitempty"`
	// NOTE: This is a hack to propagate this object definition to OpenAPI
	Error *Error `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"`
	// contains filtered or unexported fields
}

func (*GetInfoResponse) Descriptor deprecated

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

Deprecated: Use GetInfoResponse.ProtoReflect.Descriptor instead.

func (*GetInfoResponse) GetError

func (x *GetInfoResponse) GetError() *Error

func (*GetInfoResponse) GetServerVersion

func (x *GetInfoResponse) GetServerVersion() string

func (*GetInfoResponse) ProtoMessage

func (*GetInfoResponse) ProtoMessage()

func (*GetInfoResponse) ProtoReflect

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

func (*GetInfoResponse) Reset

func (x *GetInfoResponse) Reset()

func (*GetInfoResponse) String

func (x *GetInfoResponse) String() string

type GetNamespaceMetadataRequest

type GetNamespaceMetadataRequest struct {
	MetadataKey string `protobuf:"bytes,1,opt,name=metadataKey,proto3" json:"metadataKey,omitempty"`
	// contains filtered or unexported fields
}

Request namespace metadata

func (*GetNamespaceMetadataRequest) Descriptor deprecated

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

Deprecated: Use GetNamespaceMetadataRequest.ProtoReflect.Descriptor instead.

func (*GetNamespaceMetadataRequest) GetMetadataKey

func (x *GetNamespaceMetadataRequest) GetMetadataKey() string

func (*GetNamespaceMetadataRequest) ProtoMessage

func (*GetNamespaceMetadataRequest) ProtoMessage()

func (*GetNamespaceMetadataRequest) ProtoReflect

func (*GetNamespaceMetadataRequest) Reset

func (x *GetNamespaceMetadataRequest) Reset()

func (*GetNamespaceMetadataRequest) String

func (x *GetNamespaceMetadataRequest) String() string

type GetNamespaceMetadataResponse

type GetNamespaceMetadataResponse struct {
	MetadataKey string `protobuf:"bytes,1,opt,name=metadataKey,proto3" json:"metadataKey,omitempty"`
	NamespaceId uint32 `protobuf:"varint,2,opt,name=namespaceId,proto3" json:"namespaceId,omitempty"`
	Value       []byte `protobuf:"bytes,3,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Namespace metadata response

func (*GetNamespaceMetadataResponse) Descriptor deprecated

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

Deprecated: Use GetNamespaceMetadataResponse.ProtoReflect.Descriptor instead.

func (*GetNamespaceMetadataResponse) GetMetadataKey

func (x *GetNamespaceMetadataResponse) GetMetadataKey() string

func (*GetNamespaceMetadataResponse) GetNamespaceId

func (x *GetNamespaceMetadataResponse) GetNamespaceId() uint32

func (*GetNamespaceMetadataResponse) GetValue

func (x *GetNamespaceMetadataResponse) GetValue() []byte

func (*GetNamespaceMetadataResponse) MarshalJSON

func (x *GetNamespaceMetadataResponse) MarshalJSON() ([]byte, error)

func (*GetNamespaceMetadataResponse) ProtoMessage

func (*GetNamespaceMetadataResponse) ProtoMessage()

func (*GetNamespaceMetadataResponse) ProtoReflect

func (*GetNamespaceMetadataResponse) Reset

func (x *GetNamespaceMetadataResponse) Reset()

func (*GetNamespaceMetadataResponse) String

type GetRTChannelRequest

type GetRTChannelRequest struct {
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	Channel string `protobuf:"bytes,2,opt,name=channel,proto3" json:"channel,omitempty"`
	// contains filtered or unexported fields
}

func (*GetRTChannelRequest) Descriptor deprecated

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

Deprecated: Use GetRTChannelRequest.ProtoReflect.Descriptor instead.

func (*GetRTChannelRequest) GetChannel

func (x *GetRTChannelRequest) GetChannel() string

func (*GetRTChannelRequest) GetProject

func (x *GetRTChannelRequest) GetProject() string

func (*GetRTChannelRequest) ProtoMessage

func (*GetRTChannelRequest) ProtoMessage()

func (*GetRTChannelRequest) ProtoReflect

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

func (*GetRTChannelRequest) Reset

func (x *GetRTChannelRequest) Reset()

func (*GetRTChannelRequest) String

func (x *GetRTChannelRequest) String() string

type GetRTChannelResponse

type GetRTChannelResponse struct {
	Channel string `protobuf:"bytes,1,opt,name=channel,proto3" json:"channel,omitempty"`
	// contains filtered or unexported fields
}

func (*GetRTChannelResponse) Descriptor deprecated

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

Deprecated: Use GetRTChannelResponse.ProtoReflect.Descriptor instead.

func (*GetRTChannelResponse) GetChannel

func (x *GetRTChannelResponse) GetChannel() string

func (*GetRTChannelResponse) ProtoMessage

func (*GetRTChannelResponse) ProtoMessage()

func (*GetRTChannelResponse) ProtoReflect

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

func (*GetRTChannelResponse) Reset

func (x *GetRTChannelResponse) Reset()

func (*GetRTChannelResponse) String

func (x *GetRTChannelResponse) String() string

type GetRTChannelsRequest

type GetRTChannelsRequest struct {
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// contains filtered or unexported fields
}

func (*GetRTChannelsRequest) Descriptor deprecated

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

Deprecated: Use GetRTChannelsRequest.ProtoReflect.Descriptor instead.

func (*GetRTChannelsRequest) GetProject

func (x *GetRTChannelsRequest) GetProject() string

func (*GetRTChannelsRequest) ProtoMessage

func (*GetRTChannelsRequest) ProtoMessage()

func (*GetRTChannelsRequest) ProtoReflect

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

func (*GetRTChannelsRequest) Reset

func (x *GetRTChannelsRequest) Reset()

func (*GetRTChannelsRequest) String

func (x *GetRTChannelsRequest) String() string

type GetRTChannelsResponse

type GetRTChannelsResponse struct {
	Channels []*ChannelMetadata `protobuf:"bytes,1,rep,name=channels,proto3" json:"channels,omitempty"`
	// contains filtered or unexported fields
}

func (*GetRTChannelsResponse) Descriptor deprecated

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

Deprecated: Use GetRTChannelsResponse.ProtoReflect.Descriptor instead.

func (*GetRTChannelsResponse) GetChannels

func (x *GetRTChannelsResponse) GetChannels() []*ChannelMetadata

func (*GetRTChannelsResponse) ProtoMessage

func (*GetRTChannelsResponse) ProtoMessage()

func (*GetRTChannelsResponse) ProtoReflect

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

func (*GetRTChannelsResponse) Reset

func (x *GetRTChannelsResponse) Reset()

func (*GetRTChannelsResponse) String

func (x *GetRTChannelsResponse) String() string

type GetRequest

type GetRequest struct {

	// Tigris project name
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// cache name
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// cache key
	Key string `protobuf:"bytes,3,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

func (*GetRequest) Descriptor deprecated

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

Deprecated: Use GetRequest.ProtoReflect.Descriptor instead.

func (*GetRequest) GetKey

func (x *GetRequest) GetKey() string

func (*GetRequest) GetName

func (x *GetRequest) GetName() string

func (*GetRequest) GetProject

func (x *GetRequest) GetProject() string

func (*GetRequest) ProtoMessage

func (*GetRequest) ProtoMessage()

func (*GetRequest) ProtoReflect

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

func (*GetRequest) Reset

func (x *GetRequest) Reset()

func (*GetRequest) String

func (x *GetRequest) String() string

type GetResponse

type GetResponse struct {

	// value
	Value []byte `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	// expiration ms
	ExpiresInMs *uint64 `protobuf:"varint,2,opt,name=expires_in_ms,json=expiresInMs,proto3,oneof" json:"expires_in_ms,omitempty"`
	// contains filtered or unexported fields
}

func (*GetResponse) Descriptor deprecated

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

Deprecated: Use GetResponse.ProtoReflect.Descriptor instead.

func (*GetResponse) GetExpiresInMs

func (x *GetResponse) GetExpiresInMs() uint64

func (*GetResponse) GetValue

func (x *GetResponse) GetValue() []byte

func (*GetResponse) ProtoMessage

func (*GetResponse) ProtoMessage()

func (*GetResponse) ProtoReflect

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

func (*GetResponse) Reset

func (x *GetResponse) Reset()

func (*GetResponse) String

func (x *GetResponse) String() string

type GetSetRequest

type GetSetRequest struct {

	// Tigris project name
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// cache name
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// cache key
	Key string `protobuf:"bytes,3,opt,name=key,proto3" json:"key,omitempty"`
	// free form byte[] value
	Value []byte `protobuf:"bytes,4,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*GetSetRequest) Descriptor deprecated

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

Deprecated: Use GetSetRequest.ProtoReflect.Descriptor instead.

func (*GetSetRequest) GetKey

func (x *GetSetRequest) GetKey() string

func (*GetSetRequest) GetName

func (x *GetSetRequest) GetName() string

func (*GetSetRequest) GetProject

func (x *GetSetRequest) GetProject() string

func (*GetSetRequest) GetValue

func (x *GetSetRequest) GetValue() []byte

func (*GetSetRequest) ProtoMessage

func (*GetSetRequest) ProtoMessage()

func (*GetSetRequest) ProtoReflect

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

func (*GetSetRequest) Reset

func (x *GetSetRequest) Reset()

func (*GetSetRequest) String

func (x *GetSetRequest) String() string

type GetSetResponse

type GetSetResponse struct {

	// A detailed response message.
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// An enum with value set as "set"
	Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// An old value if exists
	OldValue []byte `protobuf:"bytes,3,opt,name=old_value,json=oldValue,proto3,oneof" json:"old_value,omitempty"`
	// contains filtered or unexported fields
}

func (*GetSetResponse) Descriptor deprecated

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

Deprecated: Use GetSetResponse.ProtoReflect.Descriptor instead.

func (*GetSetResponse) GetMessage

func (x *GetSetResponse) GetMessage() string

func (*GetSetResponse) GetOldValue

func (x *GetSetResponse) GetOldValue() []byte

func (*GetSetResponse) GetStatus

func (x *GetSetResponse) GetStatus() string

func (*GetSetResponse) ProtoMessage

func (*GetSetResponse) ProtoMessage()

func (*GetSetResponse) ProtoReflect

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

func (*GetSetResponse) Reset

func (x *GetSetResponse) Reset()

func (*GetSetResponse) String

func (x *GetSetResponse) String() string

type GetUserMetadataRequest

type GetUserMetadataRequest struct {
	MetadataKey string `protobuf:"bytes,1,opt,name=metadataKey,proto3" json:"metadataKey,omitempty"`
	// contains filtered or unexported fields
}

Request user metadata

func (*GetUserMetadataRequest) Descriptor deprecated

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

Deprecated: Use GetUserMetadataRequest.ProtoReflect.Descriptor instead.

func (*GetUserMetadataRequest) GetMetadataKey

func (x *GetUserMetadataRequest) GetMetadataKey() string

func (*GetUserMetadataRequest) ProtoMessage

func (*GetUserMetadataRequest) ProtoMessage()

func (*GetUserMetadataRequest) ProtoReflect

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

func (*GetUserMetadataRequest) Reset

func (x *GetUserMetadataRequest) Reset()

func (*GetUserMetadataRequest) String

func (x *GetUserMetadataRequest) String() string

type GetUserMetadataResponse

type GetUserMetadataResponse struct {
	MetadataKey string `protobuf:"bytes,1,opt,name=metadataKey,proto3" json:"metadataKey,omitempty"`
	UserId      string `protobuf:"bytes,2,opt,name=userId,proto3" json:"userId,omitempty"`
	NamespaceId uint32 `protobuf:"varint,3,opt,name=namespaceId,proto3" json:"namespaceId,omitempty"`
	Value       []byte `protobuf:"bytes,4,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

User metadata response

func (*GetUserMetadataResponse) Descriptor deprecated

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

Deprecated: Use GetUserMetadataResponse.ProtoReflect.Descriptor instead.

func (*GetUserMetadataResponse) GetMetadataKey

func (x *GetUserMetadataResponse) GetMetadataKey() string

func (*GetUserMetadataResponse) GetNamespaceId

func (x *GetUserMetadataResponse) GetNamespaceId() uint32

func (*GetUserMetadataResponse) GetUserId

func (x *GetUserMetadataResponse) GetUserId() string

func (*GetUserMetadataResponse) GetValue

func (x *GetUserMetadataResponse) GetValue() []byte

func (*GetUserMetadataResponse) MarshalJSON

func (x *GetUserMetadataResponse) MarshalJSON() ([]byte, error)

func (*GetUserMetadataResponse) ProtoMessage

func (*GetUserMetadataResponse) ProtoMessage()

func (*GetUserMetadataResponse) ProtoReflect

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

func (*GetUserMetadataResponse) Reset

func (x *GetUserMetadataResponse) Reset()

func (*GetUserMetadataResponse) String

func (x *GetUserMetadataResponse) String() string

type GrantType

type GrantType int32
const (
	GrantType_REFRESH_TOKEN      GrantType = 0
	GrantType_CLIENT_CREDENTIALS GrantType = 1
)

func (GrantType) Descriptor

func (GrantType) Descriptor() protoreflect.EnumDescriptor

func (GrantType) Enum

func (x GrantType) Enum() *GrantType

func (GrantType) EnumDescriptor deprecated

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

Deprecated: Use GrantType.Descriptor instead.

func (GrantType) Number

func (x GrantType) Number() protoreflect.EnumNumber

func (GrantType) String

func (x GrantType) String() string

func (GrantType) Type

type GroupedSearchHits

type GroupedSearchHits struct {
	GroupKeys []string     `protobuf:"bytes,1,rep,name=group_keys,json=groupKeys,proto3" json:"group_keys,omitempty"`
	Hits      []*SearchHit `protobuf:"bytes,2,rep,name=hits,proto3" json:"hits,omitempty"`
	// contains filtered or unexported fields
}

func (*GroupedSearchHits) Descriptor deprecated

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

Deprecated: Use GroupedSearchHits.ProtoReflect.Descriptor instead.

func (*GroupedSearchHits) GetGroupKeys

func (x *GroupedSearchHits) GetGroupKeys() []string

func (*GroupedSearchHits) GetHits

func (x *GroupedSearchHits) GetHits() []*SearchHit

func (*GroupedSearchHits) ProtoMessage

func (*GroupedSearchHits) ProtoMessage()

func (*GroupedSearchHits) ProtoReflect

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

func (*GroupedSearchHits) Reset

func (x *GroupedSearchHits) Reset()

func (*GroupedSearchHits) String

func (x *GroupedSearchHits) String() string

type HealthAPIClient

type HealthAPIClient interface {
	// This endpoint can be used to check the liveness of the server.
	Health(ctx context.Context, in *HealthCheckInput, opts ...grpc.CallOption) (*HealthCheckResponse, error)
}

HealthAPIClient is the client API for HealthAPI 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 NewHealthAPIClient

func NewHealthAPIClient(cc grpc.ClientConnInterface) HealthAPIClient

type HealthAPIServer

type HealthAPIServer interface {
	// This endpoint can be used to check the liveness of the server.
	Health(context.Context, *HealthCheckInput) (*HealthCheckResponse, error)
}

HealthAPIServer is the server API for HealthAPI service. All implementations should embed UnimplementedHealthAPIServer for forward compatibility

type HealthCheckInput

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

func (*HealthCheckInput) Descriptor deprecated

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

Deprecated: Use HealthCheckInput.ProtoReflect.Descriptor instead.

func (*HealthCheckInput) ProtoMessage

func (*HealthCheckInput) ProtoMessage()

func (*HealthCheckInput) ProtoReflect

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

func (*HealthCheckInput) Reset

func (x *HealthCheckInput) Reset()

func (*HealthCheckInput) String

func (x *HealthCheckInput) String() string

type HealthCheckResponse

type HealthCheckResponse struct {
	Response string `protobuf:"bytes,1,opt,name=response,proto3" json:"response,omitempty"`
	// contains filtered or unexported fields
}

func (*HealthCheckResponse) Descriptor deprecated

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

Deprecated: Use HealthCheckResponse.ProtoReflect.Descriptor instead.

func (*HealthCheckResponse) GetResponse

func (x *HealthCheckResponse) GetResponse() string

func (*HealthCheckResponse) ProtoMessage

func (*HealthCheckResponse) ProtoMessage()

func (*HealthCheckResponse) ProtoReflect

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

func (*HealthCheckResponse) Reset

func (x *HealthCheckResponse) Reset()

func (*HealthCheckResponse) String

func (x *HealthCheckResponse) String() string

type HeartbeatEvent

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

func (*HeartbeatEvent) Descriptor deprecated

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

Deprecated: Use HeartbeatEvent.ProtoReflect.Descriptor instead.

func (*HeartbeatEvent) ProtoMessage

func (*HeartbeatEvent) ProtoMessage()

func (*HeartbeatEvent) ProtoReflect

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

func (*HeartbeatEvent) Reset

func (x *HeartbeatEvent) Reset()

func (*HeartbeatEvent) String

func (x *HeartbeatEvent) String() string

type ImportRequest

type ImportRequest struct {

	// Project name whose db is under target to import documents.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// Collection name where to import documents.
	Collection string `protobuf:"bytes,2,opt,name=collection,proto3" json:"collection,omitempty"`
	// Array of documents to import. Each document is a JSON object.
	Documents [][]byte              `protobuf:"bytes,3,rep,name=documents,proto3" json:"documents,omitempty"`
	Options   *ImportRequestOptions `protobuf:"bytes,4,opt,name=options,proto3" json:"options,omitempty"`
	// Optionally specify a database branch name to perform operation on
	Branch string `protobuf:"bytes,5,opt,name=branch,proto3" json:"branch,omitempty"`
	// Allow to create collection if it doesn't exists
	CreateCollection bool `protobuf:"varint,6,opt,name=create_collection,json=createCollection,proto3" json:"create_collection,omitempty"`
	// List of fields which constitutes primary key of the collection
	//
	// If not specified and field with name 'id' is present,
	// it's used as a primary key, further if inferred type is
	// UUID, then it's set as autogenerated.
	PrimaryKey []string `protobuf:"bytes,7,rep,name=primary_key,json=primaryKey,proto3" json:"primary_key,omitempty"`
	// The list of autogenerated fields of the collection
	Autogenerated []string `protobuf:"bytes,8,rep,name=autogenerated,proto3" json:"autogenerated,omitempty"`
	// contains filtered or unexported fields
}

func (*ImportRequest) Descriptor deprecated

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

Deprecated: Use ImportRequest.ProtoReflect.Descriptor instead.

func (*ImportRequest) GetAutogenerated

func (x *ImportRequest) GetAutogenerated() []string

func (*ImportRequest) GetBranch

func (x *ImportRequest) GetBranch() string

func (*ImportRequest) GetCollection

func (x *ImportRequest) GetCollection() string

func (*ImportRequest) GetCreateCollection

func (x *ImportRequest) GetCreateCollection() bool

func (*ImportRequest) GetDocuments

func (x *ImportRequest) GetDocuments() [][]byte

func (*ImportRequest) GetOptions

func (x *ImportRequest) GetOptions() *ImportRequestOptions

func (*ImportRequest) GetPrimaryKey

func (x *ImportRequest) GetPrimaryKey() []string

func (*ImportRequest) GetProject

func (x *ImportRequest) GetProject() string

func (*ImportRequest) ProtoMessage

func (*ImportRequest) ProtoMessage()

func (*ImportRequest) ProtoReflect

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

func (*ImportRequest) Reset

func (x *ImportRequest) Reset()

func (*ImportRequest) String

func (x *ImportRequest) String() string

func (*ImportRequest) UnmarshalJSON

func (x *ImportRequest) UnmarshalJSON(data []byte) error

type ImportRequestOptions

type ImportRequestOptions struct {
	WriteOptions *WriteOptions `protobuf:"bytes,1,opt,name=write_options,json=writeOptions,proto3" json:"write_options,omitempty"`
	// contains filtered or unexported fields
}

additional options for import requests.

func (*ImportRequestOptions) Descriptor deprecated

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

Deprecated: Use ImportRequestOptions.ProtoReflect.Descriptor instead.

func (*ImportRequestOptions) GetWriteOptions

func (x *ImportRequestOptions) GetWriteOptions() *WriteOptions

func (*ImportRequestOptions) ProtoMessage

func (*ImportRequestOptions) ProtoMessage()

func (*ImportRequestOptions) ProtoReflect

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

func (*ImportRequestOptions) Reset

func (x *ImportRequestOptions) Reset()

func (*ImportRequestOptions) String

func (x *ImportRequestOptions) String() string

type ImportResponse

type ImportResponse struct {

	// Has metadata related to the documents stored.
	Metadata *ResponseMetadata `protobuf:"bytes,1,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// An enum with value set as "inserted"
	Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// an array returns the value of the primary keys.
	Keys [][]byte `protobuf:"bytes,3,rep,name=keys,proto3" json:"keys,omitempty"`
	// contains filtered or unexported fields
}

func (*ImportResponse) Descriptor deprecated

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

Deprecated: Use ImportResponse.ProtoReflect.Descriptor instead.

func (*ImportResponse) GetKeys

func (x *ImportResponse) GetKeys() [][]byte

func (*ImportResponse) GetMetadata

func (x *ImportResponse) GetMetadata() *ResponseMetadata

func (*ImportResponse) GetStatus

func (x *ImportResponse) GetStatus() string

func (*ImportResponse) MarshalJSON

func (x *ImportResponse) MarshalJSON() ([]byte, error)

func (*ImportResponse) ProtoMessage

func (*ImportResponse) ProtoMessage()

func (*ImportResponse) ProtoReflect

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

func (*ImportResponse) Reset

func (x *ImportResponse) Reset()

func (*ImportResponse) String

func (x *ImportResponse) String() string

type IndexInfo

type IndexInfo struct {

	// Name of the index.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Schema of the index.
	Schema []byte `protobuf:"bytes,2,opt,name=schema,proto3" json:"schema,omitempty"`
	// contains filtered or unexported fields
}

func (*IndexInfo) Descriptor deprecated

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

Deprecated: Use IndexInfo.ProtoReflect.Descriptor instead.

func (*IndexInfo) GetName

func (x *IndexInfo) GetName() string

func (*IndexInfo) GetSchema

func (x *IndexInfo) GetSchema() []byte

func (*IndexInfo) MarshalJSON

func (x *IndexInfo) MarshalJSON() ([]byte, error)

func (*IndexInfo) ProtoMessage

func (*IndexInfo) ProtoMessage()

func (*IndexInfo) ProtoReflect

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

func (*IndexInfo) Reset

func (x *IndexInfo) Reset()

func (*IndexInfo) String

func (x *IndexInfo) String() string

type IndexSource

type IndexSource struct {

	// An index can be either managed by user explicitly then the type is set as "user" or the index is backed by Tigris
	// collection. In case it is backed by Tigris collection the type is "tigris".
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// Applicable only in case index is backed by Tigris collection.
	Collection string `protobuf:"bytes,2,opt,name=collection,proto3" json:"collection,omitempty"`
	// Applicable only in case index is backed by Tigris collection. This is the database branch for the above collection.
	// For primary database it can be omitted or "main" can be passed.
	Branch string `protobuf:"bytes,3,opt,name=branch,proto3" json:"branch,omitempty"`
	// contains filtered or unexported fields
}

func (*IndexSource) Descriptor deprecated

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

Deprecated: Use IndexSource.ProtoReflect.Descriptor instead.

func (*IndexSource) GetBranch

func (x *IndexSource) GetBranch() string

func (*IndexSource) GetCollection

func (x *IndexSource) GetCollection() string

func (*IndexSource) GetType

func (x *IndexSource) GetType() string

func (*IndexSource) ProtoMessage

func (*IndexSource) ProtoMessage()

func (*IndexSource) ProtoReflect

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

func (*IndexSource) Reset

func (x *IndexSource) Reset()

func (*IndexSource) String

func (x *IndexSource) String() string

type InsertNamespaceMetadataRequest

type InsertNamespaceMetadataRequest struct {
	MetadataKey string `protobuf:"bytes,1,opt,name=metadataKey,proto3" json:"metadataKey,omitempty"`
	Value       []byte `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Request insertion of namespace metadata

func (*InsertNamespaceMetadataRequest) Descriptor deprecated

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

Deprecated: Use InsertNamespaceMetadataRequest.ProtoReflect.Descriptor instead.

func (*InsertNamespaceMetadataRequest) GetMetadataKey

func (x *InsertNamespaceMetadataRequest) GetMetadataKey() string

func (*InsertNamespaceMetadataRequest) GetValue

func (x *InsertNamespaceMetadataRequest) GetValue() []byte

func (*InsertNamespaceMetadataRequest) ProtoMessage

func (*InsertNamespaceMetadataRequest) ProtoMessage()

func (*InsertNamespaceMetadataRequest) ProtoReflect

func (*InsertNamespaceMetadataRequest) Reset

func (x *InsertNamespaceMetadataRequest) Reset()

func (*InsertNamespaceMetadataRequest) String

func (*InsertNamespaceMetadataRequest) UnmarshalJSON

func (x *InsertNamespaceMetadataRequest) UnmarshalJSON(data []byte) error

type InsertNamespaceMetadataResponse

type InsertNamespaceMetadataResponse struct {
	MetadataKey string `protobuf:"bytes,1,opt,name=metadataKey,proto3" json:"metadataKey,omitempty"`
	NamespaceId uint32 `protobuf:"varint,2,opt,name=namespaceId,proto3" json:"namespaceId,omitempty"`
	Value       []byte `protobuf:"bytes,3,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Insertion of namespace metadata response

func (*InsertNamespaceMetadataResponse) Descriptor deprecated

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

Deprecated: Use InsertNamespaceMetadataResponse.ProtoReflect.Descriptor instead.

func (*InsertNamespaceMetadataResponse) GetMetadataKey

func (x *InsertNamespaceMetadataResponse) GetMetadataKey() string

func (*InsertNamespaceMetadataResponse) GetNamespaceId

func (x *InsertNamespaceMetadataResponse) GetNamespaceId() uint32

func (*InsertNamespaceMetadataResponse) GetValue

func (x *InsertNamespaceMetadataResponse) GetValue() []byte

func (*InsertNamespaceMetadataResponse) MarshalJSON

func (x *InsertNamespaceMetadataResponse) MarshalJSON() ([]byte, error)

func (*InsertNamespaceMetadataResponse) ProtoMessage

func (*InsertNamespaceMetadataResponse) ProtoMessage()

func (*InsertNamespaceMetadataResponse) ProtoReflect

func (*InsertNamespaceMetadataResponse) Reset

func (*InsertNamespaceMetadataResponse) String

type InsertRequest

type InsertRequest struct {

	// Project name whose db is under target to insert documents.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// Collection name where to insert documents.
	Collection string `protobuf:"bytes,2,opt,name=collection,proto3" json:"collection,omitempty"`
	// Array of documents to insert. Each document is a JSON object.
	Documents [][]byte              `protobuf:"bytes,3,rep,name=documents,proto3" json:"documents,omitempty"`
	Options   *InsertRequestOptions `protobuf:"bytes,4,opt,name=options,proto3" json:"options,omitempty"`
	// Optionally specify a database branch name to perform operation on
	Branch string `protobuf:"bytes,5,opt,name=branch,proto3" json:"branch,omitempty"`
	// contains filtered or unexported fields
}

func (*InsertRequest) Descriptor deprecated

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

Deprecated: Use InsertRequest.ProtoReflect.Descriptor instead.

func (*InsertRequest) GetBranch

func (x *InsertRequest) GetBranch() string

func (*InsertRequest) GetCollection

func (x *InsertRequest) GetCollection() string

func (*InsertRequest) GetDocuments

func (x *InsertRequest) GetDocuments() [][]byte

func (*InsertRequest) GetOptions

func (x *InsertRequest) GetOptions() *InsertRequestOptions

func (*InsertRequest) GetProject

func (x *InsertRequest) GetProject() string

func (*InsertRequest) ProtoMessage

func (*InsertRequest) ProtoMessage()

func (*InsertRequest) ProtoReflect

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

func (*InsertRequest) Reset

func (x *InsertRequest) Reset()

func (*InsertRequest) String

func (x *InsertRequest) String() string

func (*InsertRequest) UnmarshalJSON

func (x *InsertRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON on InsertRequest avoids unmarshalling user document. We only need to extract primary/index keys from the document and want to store the document as-is in the database. This way there is no extra cost of serialization/deserialization and also less error-prone because we are not touching the user document. The req handler needs to extract out the relevant keys from the user docs and should pass it as-is to the underlying engine.

type InsertRequestOptions

type InsertRequestOptions struct {
	WriteOptions *WriteOptions `protobuf:"bytes,1,opt,name=write_options,json=writeOptions,proto3" json:"write_options,omitempty"`
	// contains filtered or unexported fields
}

additional options for insert requests.

func (*InsertRequestOptions) Descriptor deprecated

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

Deprecated: Use InsertRequestOptions.ProtoReflect.Descriptor instead.

func (*InsertRequestOptions) GetWriteOptions

func (x *InsertRequestOptions) GetWriteOptions() *WriteOptions

func (*InsertRequestOptions) ProtoMessage

func (*InsertRequestOptions) ProtoMessage()

func (*InsertRequestOptions) ProtoReflect

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

func (*InsertRequestOptions) Reset

func (x *InsertRequestOptions) Reset()

func (*InsertRequestOptions) String

func (x *InsertRequestOptions) String() string

type InsertResponse

type InsertResponse struct {

	// Has metadata related to the documents stored.
	Metadata *ResponseMetadata `protobuf:"bytes,1,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// An enum with value set as "inserted"
	Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// an array returns the value of the primary keys.
	Keys [][]byte `protobuf:"bytes,3,rep,name=keys,proto3" json:"keys,omitempty"`
	// contains filtered or unexported fields
}

func (*InsertResponse) Descriptor deprecated

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

Deprecated: Use InsertResponse.ProtoReflect.Descriptor instead.

func (*InsertResponse) GetKeys

func (x *InsertResponse) GetKeys() [][]byte

func (*InsertResponse) GetMetadata

func (x *InsertResponse) GetMetadata() *ResponseMetadata

func (*InsertResponse) GetStatus

func (x *InsertResponse) GetStatus() string

func (*InsertResponse) MarshalJSON

func (x *InsertResponse) MarshalJSON() ([]byte, error)

func (*InsertResponse) ProtoMessage

func (*InsertResponse) ProtoMessage()

func (*InsertResponse) ProtoReflect

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

func (*InsertResponse) Reset

func (x *InsertResponse) Reset()

func (*InsertResponse) String

func (x *InsertResponse) String() string

type InsertUserMetadataRequest

type InsertUserMetadataRequest struct {
	MetadataKey string `protobuf:"bytes,1,opt,name=metadataKey,proto3" json:"metadataKey,omitempty"`
	Value       []byte `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Request insertion of user metadata

func (*InsertUserMetadataRequest) Descriptor deprecated

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

Deprecated: Use InsertUserMetadataRequest.ProtoReflect.Descriptor instead.

func (*InsertUserMetadataRequest) GetMetadataKey

func (x *InsertUserMetadataRequest) GetMetadataKey() string

func (*InsertUserMetadataRequest) GetValue

func (x *InsertUserMetadataRequest) GetValue() []byte

func (*InsertUserMetadataRequest) ProtoMessage

func (*InsertUserMetadataRequest) ProtoMessage()

func (*InsertUserMetadataRequest) ProtoReflect

func (*InsertUserMetadataRequest) Reset

func (x *InsertUserMetadataRequest) Reset()

func (*InsertUserMetadataRequest) String

func (x *InsertUserMetadataRequest) String() string

func (*InsertUserMetadataRequest) UnmarshalJSON

func (x *InsertUserMetadataRequest) UnmarshalJSON(data []byte) error

type InsertUserMetadataResponse

type InsertUserMetadataResponse struct {
	MetadataKey string `protobuf:"bytes,1,opt,name=metadataKey,proto3" json:"metadataKey,omitempty"`
	UserId      string `protobuf:"bytes,2,opt,name=userId,proto3" json:"userId,omitempty"`
	NamespaceId uint32 `protobuf:"varint,3,opt,name=namespaceId,proto3" json:"namespaceId,omitempty"`
	Value       []byte `protobuf:"bytes,4,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Insertion of user metadata response

func (*InsertUserMetadataResponse) Descriptor deprecated

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

Deprecated: Use InsertUserMetadataResponse.ProtoReflect.Descriptor instead.

func (*InsertUserMetadataResponse) GetMetadataKey

func (x *InsertUserMetadataResponse) GetMetadataKey() string

func (*InsertUserMetadataResponse) GetNamespaceId

func (x *InsertUserMetadataResponse) GetNamespaceId() uint32

func (*InsertUserMetadataResponse) GetUserId

func (x *InsertUserMetadataResponse) GetUserId() string

func (*InsertUserMetadataResponse) GetValue

func (x *InsertUserMetadataResponse) GetValue() []byte

func (*InsertUserMetadataResponse) MarshalJSON

func (x *InsertUserMetadataResponse) MarshalJSON() ([]byte, error)

func (*InsertUserMetadataResponse) ProtoMessage

func (*InsertUserMetadataResponse) ProtoMessage()

func (*InsertUserMetadataResponse) ProtoReflect

func (*InsertUserMetadataResponse) Reset

func (x *InsertUserMetadataResponse) Reset()

func (*InsertUserMetadataResponse) String

func (x *InsertUserMetadataResponse) String() string

type KeysRequest

type KeysRequest struct {

	// Tigris project name
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// cache name
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// optional - cursor - skip this argument if no cursor is associated
	Cursor *uint64 `protobuf:"varint,3,opt,name=cursor,proto3,oneof" json:"cursor,omitempty"`
	// optional - count of keys to return a stream response line.
	Count *int64 `protobuf:"varint,4,opt,name=count,proto3,oneof" json:"count,omitempty"`
	// optional key pattern
	Pattern *string `protobuf:"bytes,5,opt,name=pattern,proto3,oneof" json:"pattern,omitempty"`
	// contains filtered or unexported fields
}

func (*KeysRequest) Descriptor deprecated

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

Deprecated: Use KeysRequest.ProtoReflect.Descriptor instead.

func (*KeysRequest) GetCount

func (x *KeysRequest) GetCount() int64

func (*KeysRequest) GetCursor

func (x *KeysRequest) GetCursor() uint64

func (*KeysRequest) GetName

func (x *KeysRequest) GetName() string

func (*KeysRequest) GetPattern

func (x *KeysRequest) GetPattern() string

func (*KeysRequest) GetProject

func (x *KeysRequest) GetProject() string

func (*KeysRequest) ProtoMessage

func (*KeysRequest) ProtoMessage()

func (*KeysRequest) ProtoReflect

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

func (*KeysRequest) Reset

func (x *KeysRequest) Reset()

func (*KeysRequest) String

func (x *KeysRequest) String() string

type KeysResponse

type KeysResponse struct {

	// keys
	Keys []string `protobuf:"bytes,1,rep,name=keys,proto3" json:"keys,omitempty"`
	// cursor - 0 is the keys scan is finished, non-zero cursor can be passed in next keys request to continue the scan
	// this is useful if streaming breaks and user wants to resume stream
	Cursor *uint64 `protobuf:"varint,2,opt,name=cursor,proto3,oneof" json:"cursor,omitempty"`
	// contains filtered or unexported fields
}

func (*KeysResponse) Descriptor deprecated

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

Deprecated: Use KeysResponse.ProtoReflect.Descriptor instead.

func (*KeysResponse) GetCursor

func (x *KeysResponse) GetCursor() uint64

func (*KeysResponse) GetKeys

func (x *KeysResponse) GetKeys() []string

func (*KeysResponse) ProtoMessage

func (*KeysResponse) ProtoMessage()

func (*KeysResponse) ProtoReflect

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

func (*KeysResponse) Reset

func (x *KeysResponse) Reset()

func (*KeysResponse) String

func (x *KeysResponse) String() string

type ListAppKeysRequest

type ListAppKeysRequest struct {

	// Project name filter
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// contains filtered or unexported fields
}

Request listing of all the app keys those are visible to requesting actor

func (*ListAppKeysRequest) Descriptor deprecated

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

Deprecated: Use ListAppKeysRequest.ProtoReflect.Descriptor instead.

func (*ListAppKeysRequest) GetProject

func (x *ListAppKeysRequest) GetProject() string

func (*ListAppKeysRequest) ProtoMessage

func (*ListAppKeysRequest) ProtoMessage()

func (*ListAppKeysRequest) ProtoReflect

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

func (*ListAppKeysRequest) Reset

func (x *ListAppKeysRequest) Reset()

func (*ListAppKeysRequest) String

func (x *ListAppKeysRequest) String() string

type ListAppKeysResponse

type ListAppKeysResponse struct {
	AppKeys []*AppKey `protobuf:"bytes,1,rep,name=app_keys,json=appKeys,proto3" json:"app_keys,omitempty"`
	// contains filtered or unexported fields
}

ListAppKeysResponse returns one or more visible app keys to user

func (*ListAppKeysResponse) Descriptor deprecated

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

Deprecated: Use ListAppKeysResponse.ProtoReflect.Descriptor instead.

func (*ListAppKeysResponse) GetAppKeys

func (x *ListAppKeysResponse) GetAppKeys() []*AppKey

func (*ListAppKeysResponse) ProtoMessage

func (*ListAppKeysResponse) ProtoMessage()

func (*ListAppKeysResponse) ProtoReflect

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

func (*ListAppKeysResponse) Reset

func (x *ListAppKeysResponse) Reset()

func (*ListAppKeysResponse) String

func (x *ListAppKeysResponse) String() string

type ListBranchesRequest

type ListBranchesRequest struct {

	// List database branches in this project
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// contains filtered or unexported fields
}

func (*ListBranchesRequest) Descriptor deprecated

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

Deprecated: Use ListBranchesRequest.ProtoReflect.Descriptor instead.

func (*ListBranchesRequest) GetProject

func (x *ListBranchesRequest) GetProject() string

func (*ListBranchesRequest) ProtoMessage

func (*ListBranchesRequest) ProtoMessage()

func (*ListBranchesRequest) ProtoReflect

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

func (*ListBranchesRequest) Reset

func (x *ListBranchesRequest) Reset()

func (*ListBranchesRequest) String

func (x *ListBranchesRequest) String() string

type ListBranchesResponse

type ListBranchesResponse struct {

	// List of all the branches in this database
	Branches []*BranchInfo `protobuf:"bytes,1,rep,name=branches,proto3" json:"branches,omitempty"`
	// contains filtered or unexported fields
}

func (*ListBranchesResponse) Descriptor deprecated

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

Deprecated: Use ListBranchesResponse.ProtoReflect.Descriptor instead.

func (*ListBranchesResponse) GetBranches

func (x *ListBranchesResponse) GetBranches() []*BranchInfo

func (*ListBranchesResponse) ProtoMessage

func (*ListBranchesResponse) ProtoMessage()

func (*ListBranchesResponse) ProtoReflect

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

func (*ListBranchesResponse) Reset

func (x *ListBranchesResponse) Reset()

func (*ListBranchesResponse) String

func (x *ListBranchesResponse) String() string

type ListCachesRequest

type ListCachesRequest struct {

	// Tigris project name
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// contains filtered or unexported fields
}

func (*ListCachesRequest) Descriptor deprecated

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

Deprecated: Use ListCachesRequest.ProtoReflect.Descriptor instead.

func (*ListCachesRequest) GetProject

func (x *ListCachesRequest) GetProject() string

func (*ListCachesRequest) ProtoMessage

func (*ListCachesRequest) ProtoMessage()

func (*ListCachesRequest) ProtoReflect

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

func (*ListCachesRequest) Reset

func (x *ListCachesRequest) Reset()

func (*ListCachesRequest) String

func (x *ListCachesRequest) String() string

type ListCachesResponse

type ListCachesResponse struct {

	// List of caches metadata
	Caches []*CacheMetadata `protobuf:"bytes,1,rep,name=caches,proto3" json:"caches,omitempty"`
	// contains filtered or unexported fields
}

func (*ListCachesResponse) Descriptor deprecated

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

Deprecated: Use ListCachesResponse.ProtoReflect.Descriptor instead.

func (*ListCachesResponse) GetCaches

func (x *ListCachesResponse) GetCaches() []*CacheMetadata

func (*ListCachesResponse) ProtoMessage

func (*ListCachesResponse) ProtoMessage()

func (*ListCachesResponse) ProtoReflect

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

func (*ListCachesResponse) Reset

func (x *ListCachesResponse) Reset()

func (*ListCachesResponse) String

func (x *ListCachesResponse) String() string

type ListCollectionsRequest

type ListCollectionsRequest struct {

	// Project name whose db is under target to list collections.
	Project string             `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	Options *CollectionOptions `protobuf:"bytes,2,opt,name=options,proto3" json:"options,omitempty"`
	// Optionally specify a database branch name to perform operation on
	Branch string `protobuf:"bytes,3,opt,name=branch,proto3" json:"branch,omitempty"`
	// contains filtered or unexported fields
}

func (*ListCollectionsRequest) Descriptor deprecated

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

Deprecated: Use ListCollectionsRequest.ProtoReflect.Descriptor instead.

func (*ListCollectionsRequest) GetBranch

func (x *ListCollectionsRequest) GetBranch() string

func (*ListCollectionsRequest) GetOptions

func (x *ListCollectionsRequest) GetOptions() *CollectionOptions

func (*ListCollectionsRequest) GetProject

func (x *ListCollectionsRequest) GetProject() string

func (*ListCollectionsRequest) ProtoMessage

func (*ListCollectionsRequest) ProtoMessage()

func (*ListCollectionsRequest) ProtoReflect

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

func (*ListCollectionsRequest) Reset

func (x *ListCollectionsRequest) Reset()

func (*ListCollectionsRequest) String

func (x *ListCollectionsRequest) String() string

type ListCollectionsResponse

type ListCollectionsResponse struct {

	// List of the collections info in the database.
	Collections []*CollectionInfo `protobuf:"bytes,2,rep,name=collections,proto3" json:"collections,omitempty"`
	// contains filtered or unexported fields
}

func (*ListCollectionsResponse) Descriptor deprecated

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

Deprecated: Use ListCollectionsResponse.ProtoReflect.Descriptor instead.

func (*ListCollectionsResponse) GetCollections

func (x *ListCollectionsResponse) GetCollections() []*CollectionInfo

func (*ListCollectionsResponse) ProtoMessage

func (*ListCollectionsResponse) ProtoMessage()

func (*ListCollectionsResponse) ProtoReflect

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

func (*ListCollectionsResponse) Reset

func (x *ListCollectionsResponse) Reset()

func (*ListCollectionsResponse) String

func (x *ListCollectionsResponse) String() string

type ListIndexesRequest

type ListIndexesRequest struct {

	// Tigris project name.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// Restrict the result to only return indexes matches the filter.
	Filter *IndexSource `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

func (*ListIndexesRequest) Descriptor deprecated

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

Deprecated: Use ListIndexesRequest.ProtoReflect.Descriptor instead.

func (*ListIndexesRequest) GetFilter

func (x *ListIndexesRequest) GetFilter() *IndexSource

func (*ListIndexesRequest) GetProject

func (x *ListIndexesRequest) GetProject() string

func (*ListIndexesRequest) ProtoMessage

func (*ListIndexesRequest) ProtoMessage()

func (*ListIndexesRequest) ProtoReflect

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

func (*ListIndexesRequest) Reset

func (x *ListIndexesRequest) Reset()

func (*ListIndexesRequest) String

func (x *ListIndexesRequest) String() string

type ListIndexesResponse

type ListIndexesResponse struct {

	// List of indexes.
	Indexes []*IndexInfo `protobuf:"bytes,1,rep,name=indexes,proto3" json:"indexes,omitempty"`
	// contains filtered or unexported fields
}

func (*ListIndexesResponse) Descriptor deprecated

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

Deprecated: Use ListIndexesResponse.ProtoReflect.Descriptor instead.

func (*ListIndexesResponse) GetIndexes

func (x *ListIndexesResponse) GetIndexes() []*IndexInfo

func (*ListIndexesResponse) ProtoMessage

func (*ListIndexesResponse) ProtoMessage()

func (*ListIndexesResponse) ProtoReflect

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

func (*ListIndexesResponse) Reset

func (x *ListIndexesResponse) Reset()

func (*ListIndexesResponse) String

func (x *ListIndexesResponse) String() string

type ListNamespacesRequest

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

func (*ListNamespacesRequest) Descriptor deprecated

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

Deprecated: Use ListNamespacesRequest.ProtoReflect.Descriptor instead.

func (*ListNamespacesRequest) ProtoMessage

func (*ListNamespacesRequest) ProtoMessage()

func (*ListNamespacesRequest) ProtoReflect

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

func (*ListNamespacesRequest) Reset

func (x *ListNamespacesRequest) Reset()

func (*ListNamespacesRequest) String

func (x *ListNamespacesRequest) String() string

type ListNamespacesResponse

type ListNamespacesResponse struct {
	Namespaces []*NamespaceInfo `protobuf:"bytes,1,rep,name=namespaces,proto3" json:"namespaces,omitempty"`
	// contains filtered or unexported fields
}

func (*ListNamespacesResponse) Descriptor deprecated

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

Deprecated: Use ListNamespacesResponse.ProtoReflect.Descriptor instead.

func (*ListNamespacesResponse) GetNamespaces

func (x *ListNamespacesResponse) GetNamespaces() []*NamespaceInfo

func (*ListNamespacesResponse) ProtoMessage

func (*ListNamespacesResponse) ProtoMessage()

func (*ListNamespacesResponse) ProtoReflect

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

func (*ListNamespacesResponse) Reset

func (x *ListNamespacesResponse) Reset()

func (*ListNamespacesResponse) String

func (x *ListNamespacesResponse) String() string

type ListProjectsRequest

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

func (*ListProjectsRequest) Descriptor deprecated

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

Deprecated: Use ListProjectsRequest.ProtoReflect.Descriptor instead.

func (*ListProjectsRequest) ProtoMessage

func (*ListProjectsRequest) ProtoMessage()

func (*ListProjectsRequest) ProtoReflect

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

func (*ListProjectsRequest) Reset

func (x *ListProjectsRequest) Reset()

func (*ListProjectsRequest) String

func (x *ListProjectsRequest) String() string

type ListProjectsResponse

type ListProjectsResponse struct {

	// List of the projects.
	Projects []*ProjectInfo `protobuf:"bytes,1,rep,name=projects,proto3" json:"projects,omitempty"`
	// contains filtered or unexported fields
}

func (*ListProjectsResponse) Descriptor deprecated

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

Deprecated: Use ListProjectsResponse.ProtoReflect.Descriptor instead.

func (*ListProjectsResponse) GetProjects

func (x *ListProjectsResponse) GetProjects() []*ProjectInfo

func (*ListProjectsResponse) ProtoMessage

func (*ListProjectsResponse) ProtoMessage()

func (*ListProjectsResponse) ProtoReflect

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

func (*ListProjectsResponse) Reset

func (x *ListProjectsResponse) Reset()

func (*ListProjectsResponse) String

func (x *ListProjectsResponse) String() string

type ListSubscriptionRequest

type ListSubscriptionRequest struct {
	Project  string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	Channel  string `protobuf:"bytes,2,opt,name=channel,proto3" json:"channel,omitempty"`
	PageSize int32  `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	Page     int32  `protobuf:"varint,4,opt,name=page,proto3" json:"page,omitempty"`
	// contains filtered or unexported fields
}

func (*ListSubscriptionRequest) Descriptor deprecated

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

Deprecated: Use ListSubscriptionRequest.ProtoReflect.Descriptor instead.

func (*ListSubscriptionRequest) GetChannel

func (x *ListSubscriptionRequest) GetChannel() string

func (*ListSubscriptionRequest) GetPage

func (x *ListSubscriptionRequest) GetPage() int32

func (*ListSubscriptionRequest) GetPageSize

func (x *ListSubscriptionRequest) GetPageSize() int32

func (*ListSubscriptionRequest) GetProject

func (x *ListSubscriptionRequest) GetProject() string

func (*ListSubscriptionRequest) ProtoMessage

func (*ListSubscriptionRequest) ProtoMessage()

func (*ListSubscriptionRequest) ProtoReflect

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

func (*ListSubscriptionRequest) Reset

func (x *ListSubscriptionRequest) Reset()

func (*ListSubscriptionRequest) String

func (x *ListSubscriptionRequest) String() string

type ListSubscriptionResponse

type ListSubscriptionResponse struct {
	Devices []string `protobuf:"bytes,1,rep,name=devices,proto3" json:"devices,omitempty"`
	// contains filtered or unexported fields
}

func (*ListSubscriptionResponse) Descriptor deprecated

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

Deprecated: Use ListSubscriptionResponse.ProtoReflect.Descriptor instead.

func (*ListSubscriptionResponse) GetDevices

func (x *ListSubscriptionResponse) GetDevices() []string

func (*ListSubscriptionResponse) ProtoMessage

func (*ListSubscriptionResponse) ProtoMessage()

func (*ListSubscriptionResponse) ProtoReflect

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

func (*ListSubscriptionResponse) Reset

func (x *ListSubscriptionResponse) Reset()

func (*ListSubscriptionResponse) String

func (x *ListSubscriptionResponse) String() string

type ManagementClient

type ManagementClient interface {
	// Creates a new namespace, if it does not exist
	CreateNamespace(ctx context.Context, in *CreateNamespaceRequest, opts ...grpc.CallOption) (*CreateNamespaceResponse, error)
	// Get details for all namespaces
	DescribeNamespaces(ctx context.Context, in *DescribeNamespacesRequest, opts ...grpc.CallOption) (*DescribeNamespacesResponse, error)
	// List all namespace
	ListNamespaces(ctx context.Context, in *ListNamespacesRequest, opts ...grpc.CallOption) (*ListNamespacesResponse, error)
	// insertUserMetadata inserts the user metadata object
	InsertUserMetadata(ctx context.Context, in *InsertUserMetadataRequest, opts ...grpc.CallOption) (*InsertUserMetadataResponse, error)
	// GetUserMetadata inserts the user metadata object
	GetUserMetadata(ctx context.Context, in *GetUserMetadataRequest, opts ...grpc.CallOption) (*GetUserMetadataResponse, error)
	// updateUserMetadata updates the user metadata object
	UpdateUserMetadata(ctx context.Context, in *UpdateUserMetadataRequest, opts ...grpc.CallOption) (*UpdateUserMetadataResponse, error)
	// InsertNamespaceMetadata inserts the namespace metadata object
	InsertNamespaceMetadata(ctx context.Context, in *InsertNamespaceMetadataRequest, opts ...grpc.CallOption) (*InsertNamespaceMetadataResponse, error)
	// GetNamespaceMetadata inserts the user metadata object
	GetNamespaceMetadata(ctx context.Context, in *GetNamespaceMetadataRequest, opts ...grpc.CallOption) (*GetNamespaceMetadataResponse, error)
	// UpdateNamespaceMetadata updates the user metadata object
	UpdateNamespaceMetadata(ctx context.Context, in *UpdateNamespaceMetadataRequest, opts ...grpc.CallOption) (*UpdateNamespaceMetadataResponse, error)
}

ManagementClient is the client API for Management 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 NewManagementClient

func NewManagementClient(cc grpc.ClientConnInterface) ManagementClient

type ManagementServer

type ManagementServer interface {
	// Creates a new namespace, if it does not exist
	CreateNamespace(context.Context, *CreateNamespaceRequest) (*CreateNamespaceResponse, error)
	// Get details for all namespaces
	DescribeNamespaces(context.Context, *DescribeNamespacesRequest) (*DescribeNamespacesResponse, error)
	// List all namespace
	ListNamespaces(context.Context, *ListNamespacesRequest) (*ListNamespacesResponse, error)
	// insertUserMetadata inserts the user metadata object
	InsertUserMetadata(context.Context, *InsertUserMetadataRequest) (*InsertUserMetadataResponse, error)
	// GetUserMetadata inserts the user metadata object
	GetUserMetadata(context.Context, *GetUserMetadataRequest) (*GetUserMetadataResponse, error)
	// updateUserMetadata updates the user metadata object
	UpdateUserMetadata(context.Context, *UpdateUserMetadataRequest) (*UpdateUserMetadataResponse, error)
	// InsertNamespaceMetadata inserts the namespace metadata object
	InsertNamespaceMetadata(context.Context, *InsertNamespaceMetadataRequest) (*InsertNamespaceMetadataResponse, error)
	// GetNamespaceMetadata inserts the user metadata object
	GetNamespaceMetadata(context.Context, *GetNamespaceMetadataRequest) (*GetNamespaceMetadataResponse, error)
	// UpdateNamespaceMetadata updates the user metadata object
	UpdateNamespaceMetadata(context.Context, *UpdateNamespaceMetadataRequest) (*UpdateNamespaceMetadataResponse, error)
}

ManagementServer is the server API for Management service. All implementations should embed UnimplementedManagementServer for forward compatibility

type Match

type Match struct {
	Fields []*MatchField `protobuf:"bytes,1,rep,name=fields,proto3" json:"fields,omitempty"`
	Score  string        `protobuf:"bytes,2,opt,name=score,proto3" json:"score,omitempty"`
	// contains filtered or unexported fields
}

func (*Match) Descriptor deprecated

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

Deprecated: Use Match.ProtoReflect.Descriptor instead.

func (*Match) GetFields

func (x *Match) GetFields() []*MatchField

func (*Match) GetScore

func (x *Match) GetScore() string

func (*Match) ProtoMessage

func (*Match) ProtoMessage()

func (*Match) ProtoReflect

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

func (*Match) Reset

func (x *Match) Reset()

func (*Match) String

func (x *Match) String() string

type MatchField

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

func (*MatchField) Descriptor deprecated

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

Deprecated: Use MatchField.ProtoReflect.Descriptor instead.

func (*MatchField) GetName

func (x *MatchField) GetName() string

func (*MatchField) ProtoMessage

func (*MatchField) ProtoMessage()

func (*MatchField) ProtoReflect

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

func (*MatchField) Reset

func (x *MatchField) Reset()

func (*MatchField) String

func (x *MatchField) String() string

type Message

type Message struct {

	// an optional id if idempotency is needed to ensure only a single time message
	// is published during retries. If not specified then server will automatically
	// add an id to message.
	Id       *string `protobuf:"bytes,1,opt,name=id,proto3,oneof" json:"id,omitempty"`
	Name     string  `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	Sequence string  `protobuf:"bytes,3,opt,name=sequence,proto3" json:"sequence,omitempty"`
	Data     []byte  `protobuf:"bytes,4,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*Message) Descriptor deprecated

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

Deprecated: Use Message.ProtoReflect.Descriptor instead.

func (*Message) GetData

func (x *Message) GetData() []byte

func (*Message) GetId

func (x *Message) GetId() string

func (*Message) GetName

func (x *Message) GetName() string

func (*Message) GetSequence

func (x *Message) GetSequence() string

func (*Message) ProtoMessage

func (*Message) ProtoMessage()

func (*Message) ProtoReflect

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

func (*Message) Reset

func (x *Message) Reset()

func (*Message) String

func (x *Message) String() string

type MessageEvent

type MessageEvent struct {
	Id      string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Name    string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	Channel string `protobuf:"bytes,3,opt,name=channel,proto3" json:"channel,omitempty"`
	Data    []byte `protobuf:"bytes,5,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*MessageEvent) Descriptor deprecated

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

Deprecated: Use MessageEvent.ProtoReflect.Descriptor instead.

func (*MessageEvent) GetChannel

func (x *MessageEvent) GetChannel() string

func (*MessageEvent) GetData

func (x *MessageEvent) GetData() []byte

func (*MessageEvent) GetId

func (x *MessageEvent) GetId() string

func (*MessageEvent) GetName

func (x *MessageEvent) GetName() string

func (*MessageEvent) ProtoMessage

func (*MessageEvent) ProtoMessage()

func (*MessageEvent) ProtoReflect

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

func (*MessageEvent) Reset

func (x *MessageEvent) Reset()

func (*MessageEvent) String

func (x *MessageEvent) String() string

type MessagesRequest

type MessagesRequest struct {
	Project  string     `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	Channel  string     `protobuf:"bytes,2,opt,name=channel,proto3" json:"channel,omitempty"`
	Messages []*Message `protobuf:"bytes,3,rep,name=messages,proto3" json:"messages,omitempty"`
	// contains filtered or unexported fields
}

func (*MessagesRequest) Descriptor deprecated

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

Deprecated: Use MessagesRequest.ProtoReflect.Descriptor instead.

func (*MessagesRequest) GetChannel

func (x *MessagesRequest) GetChannel() string

func (*MessagesRequest) GetMessages

func (x *MessagesRequest) GetMessages() []*Message

func (*MessagesRequest) GetProject

func (x *MessagesRequest) GetProject() string

func (*MessagesRequest) ProtoMessage

func (*MessagesRequest) ProtoMessage()

func (*MessagesRequest) ProtoReflect

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

func (*MessagesRequest) Reset

func (x *MessagesRequest) Reset()

func (*MessagesRequest) String

func (x *MessagesRequest) String() string

type MessagesResponse

type MessagesResponse struct {

	// ids of the published messages
	Ids []string `protobuf:"bytes,1,rep,name=ids,proto3" json:"ids,omitempty"`
	// contains filtered or unexported fields
}

func (*MessagesResponse) Descriptor deprecated

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

Deprecated: Use MessagesResponse.ProtoReflect.Descriptor instead.

func (*MessagesResponse) GetIds

func (x *MessagesResponse) GetIds() []string

func (*MessagesResponse) ProtoMessage

func (*MessagesResponse) ProtoMessage()

func (*MessagesResponse) ProtoReflect

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

func (*MessagesResponse) Reset

func (x *MessagesResponse) Reset()

func (*MessagesResponse) String

func (x *MessagesResponse) String() string

type Metadata

type Metadata struct {
	CreatedAt *time.Time `json:"created_at,omitempty"`
	UpdatedAt *time.Time `json:"updated_at,omitempty"`
	DeletedAt *time.Time `json:"deleted_at,omitempty"`
}

func CreateMDFromResponseMD

func CreateMDFromResponseMD(x *ResponseMetadata) Metadata

type MetricQueryFunction

type MetricQueryFunction int32

Function to apply on metrics query

const (
	MetricQueryFunction_RATE  MetricQueryFunction = 0
	MetricQueryFunction_COUNT MetricQueryFunction = 1
	MetricQueryFunction_NONE  MetricQueryFunction = 2
)

func (MetricQueryFunction) Descriptor

func (MetricQueryFunction) Enum

func (MetricQueryFunction) EnumDescriptor deprecated

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

Deprecated: Use MetricQueryFunction.Descriptor instead.

func (MetricQueryFunction) Number

func (MetricQueryFunction) String

func (x MetricQueryFunction) String() string

func (MetricQueryFunction) Type

type MetricQuerySpaceAggregation

type MetricQuerySpaceAggregation int32

Specifies how the metric should be aggregated for the time slices.

const (
	MetricQuerySpaceAggregation_AVG MetricQuerySpaceAggregation = 0
	MetricQuerySpaceAggregation_MIN MetricQuerySpaceAggregation = 1
	MetricQuerySpaceAggregation_MAX MetricQuerySpaceAggregation = 2
	MetricQuerySpaceAggregation_SUM MetricQuerySpaceAggregation = 3
)

func (MetricQuerySpaceAggregation) Descriptor

func (MetricQuerySpaceAggregation) Enum

func (MetricQuerySpaceAggregation) EnumDescriptor deprecated

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

Deprecated: Use MetricQuerySpaceAggregation.Descriptor instead.

func (MetricQuerySpaceAggregation) Number

func (MetricQuerySpaceAggregation) String

func (MetricQuerySpaceAggregation) Type

type MetricSeries

type MetricSeries struct {
	From       int64        `protobuf:"varint,1,opt,name=from,proto3" json:"from,omitempty"`
	To         int64        `protobuf:"varint,2,opt,name=to,proto3" json:"to,omitempty"`
	Metric     string       `protobuf:"bytes,3,opt,name=metric,proto3" json:"metric,omitempty"`
	Scope      string       `protobuf:"bytes,4,opt,name=scope,proto3" json:"scope,omitempty"`
	DataPoints []*DataPoint `protobuf:"bytes,5,rep,name=dataPoints,proto3" json:"dataPoints,omitempty"`
	// contains filtered or unexported fields
}

Represents series in timeseries based on input query.

func (*MetricSeries) Descriptor deprecated

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

Deprecated: Use MetricSeries.ProtoReflect.Descriptor instead.

func (*MetricSeries) GetDataPoints

func (x *MetricSeries) GetDataPoints() []*DataPoint

func (*MetricSeries) GetFrom

func (x *MetricSeries) GetFrom() int64

func (*MetricSeries) GetMetric

func (x *MetricSeries) GetMetric() string

func (*MetricSeries) GetScope

func (x *MetricSeries) GetScope() string

func (*MetricSeries) GetTo

func (x *MetricSeries) GetTo() int64

func (*MetricSeries) ProtoMessage

func (*MetricSeries) ProtoMessage()

func (*MetricSeries) ProtoReflect

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

func (*MetricSeries) Reset

func (x *MetricSeries) Reset()

func (*MetricSeries) String

func (x *MetricSeries) String() string

type NamespaceInfo

type NamespaceInfo struct {

	// The unique namespace code.
	Code int32 `protobuf:"varint,1,opt,name=code,proto3" json:"code,omitempty"`
	// The namespace unique id.
	Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	// The namespace display name.
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*NamespaceInfo) Descriptor deprecated

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

Deprecated: Use NamespaceInfo.ProtoReflect.Descriptor instead.

func (*NamespaceInfo) GetCode

func (x *NamespaceInfo) GetCode() int32

func (*NamespaceInfo) GetId

func (x *NamespaceInfo) GetId() string

func (*NamespaceInfo) GetName

func (x *NamespaceInfo) GetName() string

func (*NamespaceInfo) ProtoMessage

func (*NamespaceInfo) ProtoMessage()

func (*NamespaceInfo) ProtoReflect

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

func (*NamespaceInfo) Reset

func (x *NamespaceInfo) Reset()

func (*NamespaceInfo) String

func (x *NamespaceInfo) String() string

type ObservabilityClient

type ObservabilityClient interface {
	// Queries time series metrics
	QueryTimeSeriesMetrics(ctx context.Context, in *QueryTimeSeriesMetricsRequest, opts ...grpc.CallOption) (*QueryTimeSeriesMetricsResponse, error)
	// Returns current namespace quota limits
	QuotaLimits(ctx context.Context, in *QuotaLimitsRequest, opts ...grpc.CallOption) (*QuotaLimitsResponse, error)
	// Returns current namespace quota limits
	QuotaUsage(ctx context.Context, in *QuotaUsageRequest, opts ...grpc.CallOption) (*QuotaUsageResponse, error)
	// Provides the information about the server. This information includes returning the server version, etc.
	GetInfo(ctx context.Context, in *GetInfoRequest, opts ...grpc.CallOption) (*GetInfoResponse, error)
}

ObservabilityClient is the client API for Observability 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 ObservabilityServer

type ObservabilityServer interface {
	// Queries time series metrics
	QueryTimeSeriesMetrics(context.Context, *QueryTimeSeriesMetricsRequest) (*QueryTimeSeriesMetricsResponse, error)
	// Returns current namespace quota limits
	QuotaLimits(context.Context, *QuotaLimitsRequest) (*QuotaLimitsResponse, error)
	// Returns current namespace quota limits
	QuotaUsage(context.Context, *QuotaUsageRequest) (*QuotaUsageResponse, error)
	// Provides the information about the server. This information includes returning the server version, etc.
	GetInfo(context.Context, *GetInfoRequest) (*GetInfoResponse, error)
}

ObservabilityServer is the server API for Observability service. All implementations should embed UnimplementedObservabilityServer for forward compatibility

type Page

type Page struct {

	// Number representing the current page of results
	Current int32 `protobuf:"varint,1,opt,name=current,proto3" json:"current,omitempty"`
	// Maximum number of results per page
	Size int32 `protobuf:"varint,3,opt,name=size,proto3" json:"size,omitempty"`
	// contains filtered or unexported fields
}

Pagination metadata for SearchResponse

func (*Page) Descriptor deprecated

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

Deprecated: Use Page.ProtoReflect.Descriptor instead.

func (*Page) GetCurrent

func (x *Page) GetCurrent() int32

func (*Page) GetSize

func (x *Page) GetSize() int32

func (*Page) ProtoMessage

func (*Page) ProtoMessage()

func (*Page) ProtoReflect

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

func (*Page) Reset

func (x *Page) Reset()

func (*Page) String

func (x *Page) String() string

type PresenceActions

type PresenceActions int32
const (
	PresenceActions_present PresenceActions = 0
	PresenceActions_enter   PresenceActions = 1
	PresenceActions_leave   PresenceActions = 2
	PresenceActions_update  PresenceActions = 3
)

func (PresenceActions) Descriptor

func (PresenceActions) Enum

func (x PresenceActions) Enum() *PresenceActions

func (PresenceActions) EnumDescriptor deprecated

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

Deprecated: Use PresenceActions.Descriptor instead.

func (PresenceActions) Number

func (PresenceActions) String

func (x PresenceActions) String() string

func (PresenceActions) Type

type PresenceEvent

type PresenceEvent struct {
	Channel string          `protobuf:"bytes,1,opt,name=channel,proto3" json:"channel,omitempty"`
	Action  PresenceActions `protobuf:"varint,3,opt,name=action,proto3,enum=tigrisdata.realtime.v1.PresenceActions" json:"action,omitempty"`
	Data    []byte          `protobuf:"bytes,4,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*PresenceEvent) Descriptor deprecated

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

Deprecated: Use PresenceEvent.ProtoReflect.Descriptor instead.

func (*PresenceEvent) GetAction

func (x *PresenceEvent) GetAction() PresenceActions

func (*PresenceEvent) GetChannel

func (x *PresenceEvent) GetChannel() string

func (*PresenceEvent) GetData

func (x *PresenceEvent) GetData() []byte

func (*PresenceEvent) ProtoMessage

func (*PresenceEvent) ProtoMessage()

func (*PresenceEvent) ProtoReflect

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

func (*PresenceEvent) Reset

func (x *PresenceEvent) Reset()

func (*PresenceEvent) String

func (x *PresenceEvent) String() string

type PresenceMemberEvent

type PresenceMemberEvent struct {
	Channel  string           `protobuf:"bytes,1,opt,name=channel,proto3" json:"channel,omitempty"`
	Presence []*PresenceEvent `protobuf:"bytes,2,rep,name=presence,proto3" json:"presence,omitempty"`
	// contains filtered or unexported fields
}

func (*PresenceMemberEvent) Descriptor deprecated

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

Deprecated: Use PresenceMemberEvent.ProtoReflect.Descriptor instead.

func (*PresenceMemberEvent) GetChannel

func (x *PresenceMemberEvent) GetChannel() string

func (*PresenceMemberEvent) GetPresence

func (x *PresenceMemberEvent) GetPresence() []*PresenceEvent

func (*PresenceMemberEvent) ProtoMessage

func (*PresenceMemberEvent) ProtoMessage()

func (*PresenceMemberEvent) ProtoReflect

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

func (*PresenceMemberEvent) Reset

func (x *PresenceMemberEvent) Reset()

func (*PresenceMemberEvent) String

func (x *PresenceMemberEvent) String() string

type PresenceRequest

type PresenceRequest struct {
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	Channel string `protobuf:"bytes,2,opt,name=channel,proto3" json:"channel,omitempty"`
	// contains filtered or unexported fields
}

HTTP

func (*PresenceRequest) Descriptor deprecated

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

Deprecated: Use PresenceRequest.ProtoReflect.Descriptor instead.

func (*PresenceRequest) GetChannel

func (x *PresenceRequest) GetChannel() string

func (*PresenceRequest) GetProject

func (x *PresenceRequest) GetProject() string

func (*PresenceRequest) ProtoMessage

func (*PresenceRequest) ProtoMessage()

func (*PresenceRequest) ProtoReflect

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

func (*PresenceRequest) Reset

func (x *PresenceRequest) Reset()

func (*PresenceRequest) String

func (x *PresenceRequest) String() string

type PresenceResponse

type PresenceResponse struct {
	Response []byte `protobuf:"bytes,1,opt,name=response,proto3" json:"response,omitempty"`
	// contains filtered or unexported fields
}

func (*PresenceResponse) Descriptor deprecated

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

Deprecated: Use PresenceResponse.ProtoReflect.Descriptor instead.

func (*PresenceResponse) GetResponse

func (x *PresenceResponse) GetResponse() []byte

func (*PresenceResponse) ProtoMessage

func (*PresenceResponse) ProtoMessage()

func (*PresenceResponse) ProtoReflect

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

func (*PresenceResponse) Reset

func (x *PresenceResponse) Reset()

func (*PresenceResponse) String

func (x *PresenceResponse) String() string

type ProjectDescription

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

func (*ProjectDescription) Descriptor deprecated

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

Deprecated: Use ProjectDescription.ProtoReflect.Descriptor instead.

func (*ProjectDescription) ProtoMessage

func (*ProjectDescription) ProtoMessage()

func (*ProjectDescription) ProtoReflect

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

func (*ProjectDescription) Reset

func (x *ProjectDescription) Reset()

func (*ProjectDescription) String

func (x *ProjectDescription) String() string

type ProjectInfo

type ProjectInfo struct {

	// Project name.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// Metadata about the Project.
	Metadata *ProjectMetadata `protobuf:"bytes,2,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

func (*ProjectInfo) Descriptor deprecated

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

Deprecated: Use ProjectInfo.ProtoReflect.Descriptor instead.

func (*ProjectInfo) GetMetadata

func (x *ProjectInfo) GetMetadata() *ProjectMetadata

func (*ProjectInfo) GetProject

func (x *ProjectInfo) GetProject() string

func (*ProjectInfo) ProtoMessage

func (*ProjectInfo) ProtoMessage()

func (*ProjectInfo) ProtoReflect

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

func (*ProjectInfo) Reset

func (x *ProjectInfo) Reset()

func (*ProjectInfo) String

func (x *ProjectInfo) String() string

type ProjectMetadata

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

func (*ProjectMetadata) Descriptor deprecated

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

Deprecated: Use ProjectMetadata.ProtoReflect.Descriptor instead.

func (*ProjectMetadata) ProtoMessage

func (*ProjectMetadata) ProtoMessage()

func (*ProjectMetadata) ProtoReflect

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

func (*ProjectMetadata) Reset

func (x *ProjectMetadata) Reset()

func (*ProjectMetadata) String

func (x *ProjectMetadata) String() string

type QueryTimeSeriesMetricsRequest

type QueryTimeSeriesMetricsRequest struct {
	Db                  string                      `protobuf:"bytes,1,opt,name=db,proto3" json:"db,omitempty"`
	Branch              string                      `protobuf:"bytes,2,opt,name=branch,proto3" json:"branch,omitempty"`
	Collection          string                      `protobuf:"bytes,3,opt,name=collection,proto3" json:"collection,omitempty"`
	From                int64                       `protobuf:"varint,4,opt,name=from,proto3" json:"from,omitempty"`
	To                  int64                       `protobuf:"varint,5,opt,name=to,proto3" json:"to,omitempty"`
	MetricName          string                      `protobuf:"bytes,6,opt,name=metric_name,json=metricName,proto3" json:"metric_name,omitempty"`
	TigrisOperation     TigrisOperation             `` /* 156-byte string literal not displayed */
	SpaceAggregation    MetricQuerySpaceAggregation `` /* 171-byte string literal not displayed */
	SpaceAggregatedBy   []string                    `protobuf:"bytes,9,rep,name=space_aggregated_by,json=spaceAggregatedBy,proto3" json:"space_aggregated_by,omitempty"`
	Function            MetricQueryFunction         `protobuf:"varint,10,opt,name=function,proto3,enum=tigrisdata.observability.v1.MetricQueryFunction" json:"function,omitempty"`
	Quantile            float32                     `protobuf:"fixed32,11,opt,name=quantile,proto3" json:"quantile,omitempty"`
	AdditionalFunctions []*AdditionalFunction       `protobuf:"bytes,12,rep,name=additionalFunctions,proto3" json:"additionalFunctions,omitempty"`
	// contains filtered or unexported fields
}

Requests the time series metrics

func (*QueryTimeSeriesMetricsRequest) Descriptor deprecated

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

Deprecated: Use QueryTimeSeriesMetricsRequest.ProtoReflect.Descriptor instead.

func (*QueryTimeSeriesMetricsRequest) GetAdditionalFunctions

func (x *QueryTimeSeriesMetricsRequest) GetAdditionalFunctions() []*AdditionalFunction

func (*QueryTimeSeriesMetricsRequest) GetBranch

func (x *QueryTimeSeriesMetricsRequest) GetBranch() string

func (*QueryTimeSeriesMetricsRequest) GetCollection

func (x *QueryTimeSeriesMetricsRequest) GetCollection() string

func (*QueryTimeSeriesMetricsRequest) GetDb

func (*QueryTimeSeriesMetricsRequest) GetFrom

func (x *QueryTimeSeriesMetricsRequest) GetFrom() int64

func (*QueryTimeSeriesMetricsRequest) GetFunction

func (*QueryTimeSeriesMetricsRequest) GetMetricName

func (x *QueryTimeSeriesMetricsRequest) GetMetricName() string

func (*QueryTimeSeriesMetricsRequest) GetQuantile

func (x *QueryTimeSeriesMetricsRequest) GetQuantile() float32

func (*QueryTimeSeriesMetricsRequest) GetSpaceAggregatedBy

func (x *QueryTimeSeriesMetricsRequest) GetSpaceAggregatedBy() []string

func (*QueryTimeSeriesMetricsRequest) GetSpaceAggregation

func (*QueryTimeSeriesMetricsRequest) GetTigrisOperation

func (x *QueryTimeSeriesMetricsRequest) GetTigrisOperation() TigrisOperation

func (*QueryTimeSeriesMetricsRequest) GetTo

func (*QueryTimeSeriesMetricsRequest) ProtoMessage

func (*QueryTimeSeriesMetricsRequest) ProtoMessage()

func (*QueryTimeSeriesMetricsRequest) ProtoReflect

func (*QueryTimeSeriesMetricsRequest) Reset

func (x *QueryTimeSeriesMetricsRequest) Reset()

func (*QueryTimeSeriesMetricsRequest) String

func (*QueryTimeSeriesMetricsRequest) UnmarshalJSON

func (x *QueryTimeSeriesMetricsRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON on QueryTimeSeriesMetricsRequest. Handles enum.

type QueryTimeSeriesMetricsResponse

type QueryTimeSeriesMetricsResponse struct {
	From   int64           `protobuf:"varint,1,opt,name=from,proto3" json:"from,omitempty"`
	To     int64           `protobuf:"varint,2,opt,name=to,proto3" json:"to,omitempty"`
	Query  string          `protobuf:"bytes,3,opt,name=query,proto3" json:"query,omitempty"`
	Series []*MetricSeries `protobuf:"bytes,4,rep,name=series,proto3" json:"series,omitempty"`
	// contains filtered or unexported fields
}

QueryTimeSeriesMetric responds with this type.

func (*QueryTimeSeriesMetricsResponse) Descriptor deprecated

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

Deprecated: Use QueryTimeSeriesMetricsResponse.ProtoReflect.Descriptor instead.

func (*QueryTimeSeriesMetricsResponse) GetFrom

func (*QueryTimeSeriesMetricsResponse) GetQuery

func (x *QueryTimeSeriesMetricsResponse) GetQuery() string

func (*QueryTimeSeriesMetricsResponse) GetSeries

func (x *QueryTimeSeriesMetricsResponse) GetSeries() []*MetricSeries

func (*QueryTimeSeriesMetricsResponse) GetTo

func (*QueryTimeSeriesMetricsResponse) ProtoMessage

func (*QueryTimeSeriesMetricsResponse) ProtoMessage()

func (*QueryTimeSeriesMetricsResponse) ProtoReflect

func (*QueryTimeSeriesMetricsResponse) Reset

func (x *QueryTimeSeriesMetricsResponse) Reset()

func (*QueryTimeSeriesMetricsResponse) String

type QuotaLimitsRequest

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

Request current namespace quota limits

func (*QuotaLimitsRequest) Descriptor deprecated

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

Deprecated: Use QuotaLimitsRequest.ProtoReflect.Descriptor instead.

func (*QuotaLimitsRequest) ProtoMessage

func (*QuotaLimitsRequest) ProtoMessage()

func (*QuotaLimitsRequest) ProtoReflect

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

func (*QuotaLimitsRequest) Reset

func (x *QuotaLimitsRequest) Reset()

func (*QuotaLimitsRequest) String

func (x *QuotaLimitsRequest) String() string

type QuotaLimitsResponse

type QuotaLimitsResponse struct {

	// Number of allowed read units per second
	ReadUnits int64 `protobuf:"varint,1,opt,name=ReadUnits,proto3" json:"ReadUnits,omitempty"`
	// Number of allowed write units per second
	WriteUnits int64 `protobuf:"varint,2,opt,name=WriteUnits,proto3" json:"WriteUnits,omitempty"`
	// Maximum number of bytes allowed to store
	StorageSize int64 `protobuf:"varint,3,opt,name=StorageSize,proto3" json:"StorageSize,omitempty"`
	// contains filtered or unexported fields
}

Contains current quota limits

func (*QuotaLimitsResponse) Descriptor deprecated

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

Deprecated: Use QuotaLimitsResponse.ProtoReflect.Descriptor instead.

func (*QuotaLimitsResponse) GetReadUnits

func (x *QuotaLimitsResponse) GetReadUnits() int64

func (*QuotaLimitsResponse) GetStorageSize

func (x *QuotaLimitsResponse) GetStorageSize() int64

func (*QuotaLimitsResponse) GetWriteUnits

func (x *QuotaLimitsResponse) GetWriteUnits() int64

func (*QuotaLimitsResponse) ProtoMessage

func (*QuotaLimitsResponse) ProtoMessage()

func (*QuotaLimitsResponse) ProtoReflect

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

func (*QuotaLimitsResponse) Reset

func (x *QuotaLimitsResponse) Reset()

func (*QuotaLimitsResponse) String

func (x *QuotaLimitsResponse) String() string

type QuotaUsageRequest

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

Request current namespace quota usage

func (*QuotaUsageRequest) Descriptor deprecated

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

Deprecated: Use QuotaUsageRequest.ProtoReflect.Descriptor instead.

func (*QuotaUsageRequest) ProtoMessage

func (*QuotaUsageRequest) ProtoMessage()

func (*QuotaUsageRequest) ProtoReflect

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

func (*QuotaUsageRequest) Reset

func (x *QuotaUsageRequest) Reset()

func (*QuotaUsageRequest) String

func (x *QuotaUsageRequest) String() string

type QuotaUsageResponse

type QuotaUsageResponse struct {

	// Number of read units used per second
	ReadUnits int64 `protobuf:"varint,1,opt,name=ReadUnits,proto3" json:"ReadUnits,omitempty"`
	// Number of write units used per second
	WriteUnits int64 `protobuf:"varint,2,opt,name=WriteUnits,proto3" json:"WriteUnits,omitempty"`
	// Number of bytes stored
	StorageSize int64 `protobuf:"varint,3,opt,name=StorageSize,proto3" json:"StorageSize,omitempty"`
	// Number of read units throttled per second.
	// Units which was rejected with "resource exhausted error".
	ReadUnitsThrottled int64 `protobuf:"varint,4,opt,name=ReadUnitsThrottled,proto3" json:"ReadUnitsThrottled,omitempty"`
	// Number of write units throttled per second.
	// Units which was rejected with "resource exhausted error".
	WriteUnitsThrottled int64 `protobuf:"varint,5,opt,name=WriteUnitsThrottled,proto3" json:"WriteUnitsThrottled,omitempty"`
	// Number of bytes throttled.
	// Number of bytes which were attempted to write in excess of quota and were rejected.
	StorageSizeThrottled int64 `protobuf:"varint,6,opt,name=StorageSizeThrottled,proto3" json:"StorageSizeThrottled,omitempty"`
	// contains filtered or unexported fields
}

Contains current quota usage

func (*QuotaUsageResponse) Descriptor deprecated

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

Deprecated: Use QuotaUsageResponse.ProtoReflect.Descriptor instead.

func (*QuotaUsageResponse) GetReadUnits

func (x *QuotaUsageResponse) GetReadUnits() int64

func (*QuotaUsageResponse) GetReadUnitsThrottled

func (x *QuotaUsageResponse) GetReadUnitsThrottled() int64

func (*QuotaUsageResponse) GetStorageSize

func (x *QuotaUsageResponse) GetStorageSize() int64

func (*QuotaUsageResponse) GetStorageSizeThrottled

func (x *QuotaUsageResponse) GetStorageSizeThrottled() int64

func (*QuotaUsageResponse) GetWriteUnits

func (x *QuotaUsageResponse) GetWriteUnits() int64

func (*QuotaUsageResponse) GetWriteUnitsThrottled

func (x *QuotaUsageResponse) GetWriteUnitsThrottled() int64

func (*QuotaUsageResponse) ProtoMessage

func (*QuotaUsageResponse) ProtoMessage()

func (*QuotaUsageResponse) ProtoReflect

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

func (*QuotaUsageResponse) Reset

func (x *QuotaUsageResponse) Reset()

func (*QuotaUsageResponse) String

func (x *QuotaUsageResponse) String() string

type ReadMessagesRequest

type ReadMessagesRequest struct {
	Project   string  `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	Channel   string  `protobuf:"bytes,2,opt,name=channel,proto3" json:"channel,omitempty"`
	SessionId string  `protobuf:"bytes,3,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
	SocketId  string  `protobuf:"bytes,4,opt,name=socket_id,json=socketId,proto3" json:"socket_id,omitempty"`
	Event     string  `protobuf:"bytes,5,opt,name=event,proto3" json:"event,omitempty"`
	Start     *string `protobuf:"bytes,6,opt,name=start,proto3,oneof" json:"start,omitempty"`
	End       *string `protobuf:"bytes,7,opt,name=end,proto3,oneof" json:"end,omitempty"`
	Limit     *int64  `protobuf:"varint,8,opt,name=limit,proto3,oneof" json:"limit,omitempty"`
	// contains filtered or unexported fields
}

func (*ReadMessagesRequest) Descriptor deprecated

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

Deprecated: Use ReadMessagesRequest.ProtoReflect.Descriptor instead.

func (*ReadMessagesRequest) GetChannel

func (x *ReadMessagesRequest) GetChannel() string

func (*ReadMessagesRequest) GetEnd

func (x *ReadMessagesRequest) GetEnd() string

func (*ReadMessagesRequest) GetEvent

func (x *ReadMessagesRequest) GetEvent() string

func (*ReadMessagesRequest) GetLimit

func (x *ReadMessagesRequest) GetLimit() int64

func (*ReadMessagesRequest) GetProject

func (x *ReadMessagesRequest) GetProject() string

func (*ReadMessagesRequest) GetSessionId

func (x *ReadMessagesRequest) GetSessionId() string

func (*ReadMessagesRequest) GetSocketId

func (x *ReadMessagesRequest) GetSocketId() string

func (*ReadMessagesRequest) GetStart

func (x *ReadMessagesRequest) GetStart() string

func (*ReadMessagesRequest) ProtoMessage

func (*ReadMessagesRequest) ProtoMessage()

func (*ReadMessagesRequest) ProtoReflect

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

func (*ReadMessagesRequest) Reset

func (x *ReadMessagesRequest) Reset()

func (*ReadMessagesRequest) String

func (x *ReadMessagesRequest) String() string

type ReadMessagesResponse

type ReadMessagesResponse struct {
	Message *Message `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

func (*ReadMessagesResponse) Descriptor deprecated

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

Deprecated: Use ReadMessagesResponse.ProtoReflect.Descriptor instead.

func (*ReadMessagesResponse) GetMessage

func (x *ReadMessagesResponse) GetMessage() *Message

func (*ReadMessagesResponse) ProtoMessage

func (*ReadMessagesResponse) ProtoMessage()

func (*ReadMessagesResponse) ProtoReflect

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

func (*ReadMessagesResponse) Reset

func (x *ReadMessagesResponse) Reset()

func (*ReadMessagesResponse) String

func (x *ReadMessagesResponse) String() string

type ReadRequest

type ReadRequest struct {

	// Project name whose db is under target to read documents from.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// Collection name to read documents from.
	Collection string `protobuf:"bytes,2,opt,name=collection,proto3" json:"collection,omitempty"`
	// Returns documents matching this filter. A filter can simply be a key, value pair where a key is the field name and the value would be the value for this field.
	// Tigris also allows complex filtering by passing logical expressions. Logical filters are applied on two or more fields using `$or` and `$and`.
	// A few examples of filters:
	// <li> To read a user document where the id has a value 1: “`{"id": 1 }“`
	// <li> To read all the user documents where the key "id" has a value 1 or 2 or 3: `{"$or": [{"id": 1}, {"id": 2}, {"id": 3}]}`
	// Filter allows setting collation on an individual field level. To set collation for all the fields see options.
	// The detailed documentation of the filter is <a href="https://docs.tigrisdata.com/overview/query#specification-1" title="here">here</a>.
	Filter []byte `protobuf:"bytes,3,opt,name=filter,proto3" json:"filter,omitempty"`
	// To read specific fields from a document. Default is all.
	Fields []byte `protobuf:"bytes,4,opt,name=fields,proto3" json:"fields,omitempty"`
	// Options that can be used to modify the results, for example `limit` to control the number of documents
	// returned by the server.
	Options *ReadRequestOptions `protobuf:"bytes,5,opt,name=options,proto3" json:"options,omitempty"`
	// Array of fields and corresponding sort orders to order the results. Ex: 1 `[{ "salary": "$desc" }]`, Ex: 2  `[{ "salary": "$asc"}]`
	Sort []byte `protobuf:"bytes,6,opt,name=sort,proto3" json:"sort,omitempty"`
	// Optionally specify a database branch name to perform operation on
	Branch string `protobuf:"bytes,7,opt,name=branch,proto3" json:"branch,omitempty"`
	// contains filtered or unexported fields
}

func (*ReadRequest) Descriptor deprecated

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

Deprecated: Use ReadRequest.ProtoReflect.Descriptor instead.

func (*ReadRequest) GetBranch

func (x *ReadRequest) GetBranch() string

func (*ReadRequest) GetCollection

func (x *ReadRequest) GetCollection() string

func (*ReadRequest) GetFields

func (x *ReadRequest) GetFields() []byte

func (*ReadRequest) GetFilter

func (x *ReadRequest) GetFilter() []byte

func (*ReadRequest) GetOptions

func (x *ReadRequest) GetOptions() *ReadRequestOptions

func (*ReadRequest) GetProject

func (x *ReadRequest) GetProject() string

func (*ReadRequest) GetSort

func (x *ReadRequest) GetSort() []byte

func (*ReadRequest) ProtoMessage

func (*ReadRequest) ProtoMessage()

func (*ReadRequest) ProtoReflect

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

func (*ReadRequest) Reset

func (x *ReadRequest) Reset()

func (*ReadRequest) String

func (x *ReadRequest) String() string

func (*ReadRequest) UnmarshalJSON

func (x *ReadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON on ReadRequest avoids unmarshalling filter and instead this way we can write a custom struct to do the unmarshalling and will be avoiding any extra allocation/copying.

type ReadRequestOptions

type ReadRequestOptions struct {

	// Limit the number of documents returned by the read operation.
	Limit int64 `protobuf:"varint,2,opt,name=limit,proto3" json:"limit,omitempty"`
	// Number of documents to skip before starting to return resulting documents.
	Skip int64 `protobuf:"varint,3,opt,name=skip,proto3" json:"skip,omitempty"`
	// A cursor for use in pagination. The next streams will return documents after this offset.
	Offset []byte `protobuf:"bytes,4,opt,name=offset,proto3" json:"offset,omitempty"`
	// A collation allows you to specify string comparison rules. Default is case-sensitive, to override it you can set
	// this option to 'ci' that will apply to all the text fields in the filters.
	Collation *Collation `protobuf:"bytes,5,opt,name=collation,proto3" json:"collation,omitempty"`
	// contains filtered or unexported fields
}

Options that can be used to modify the results, for example "limit" to control the number of documents returned by the server.

func (*ReadRequestOptions) Descriptor deprecated

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

Deprecated: Use ReadRequestOptions.ProtoReflect.Descriptor instead.

func (*ReadRequestOptions) GetCollation

func (x *ReadRequestOptions) GetCollation() *Collation

func (*ReadRequestOptions) GetLimit

func (x *ReadRequestOptions) GetLimit() int64

func (*ReadRequestOptions) GetOffset

func (x *ReadRequestOptions) GetOffset() []byte

func (*ReadRequestOptions) GetSkip

func (x *ReadRequestOptions) GetSkip() int64

func (*ReadRequestOptions) ProtoMessage

func (*ReadRequestOptions) ProtoMessage()

func (*ReadRequestOptions) ProtoReflect

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

func (*ReadRequestOptions) Reset

func (x *ReadRequestOptions) Reset()

func (*ReadRequestOptions) String

func (x *ReadRequestOptions) String() string

type ReadResponse

type ReadResponse struct {

	// Object containing the collection document.
	Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// An internal key, used for pagination.
	ResumeToken []byte `protobuf:"bytes,2,opt,name=resume_token,json=resumeToken,proto3" json:"resume_token,omitempty"`
	// Has metadata related to the documents stored.
	Metadata *ResponseMetadata `protobuf:"bytes,3,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

func (*ReadResponse) Descriptor deprecated

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

Deprecated: Use ReadResponse.ProtoReflect.Descriptor instead.

func (*ReadResponse) GetData

func (x *ReadResponse) GetData() []byte

func (*ReadResponse) GetMetadata

func (x *ReadResponse) GetMetadata() *ResponseMetadata

func (*ReadResponse) GetResumeToken

func (x *ReadResponse) GetResumeToken() []byte

func (*ReadResponse) MarshalJSON

func (x *ReadResponse) MarshalJSON() ([]byte, error)

MarshalJSON on read response avoid any encoding/decoding on x.Data. With this approach we are not doing any extra marshaling/unmarshalling in returning the data from the database. The document returned from the database is stored in x.Data and will return as-is.

Note: This also means any changes in ReadResponse proto needs to make sure that we add that here and similarly the openAPI specs needs to be specified Data as object instead of bytes.

func (*ReadResponse) ProtoMessage

func (*ReadResponse) ProtoMessage()

func (*ReadResponse) ProtoReflect

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

func (*ReadResponse) Reset

func (x *ReadResponse) Reset()

func (*ReadResponse) String

func (x *ReadResponse) String() string

type RealTimeMessage

type RealTimeMessage struct {
	EventType EventType `` /* 127-byte string literal not displayed */
	Event     []byte    `protobuf:"bytes,2,opt,name=event,proto3" json:"event,omitempty"`
	// contains filtered or unexported fields
}

func (*RealTimeMessage) Descriptor deprecated

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

Deprecated: Use RealTimeMessage.ProtoReflect.Descriptor instead.

func (*RealTimeMessage) GetEvent

func (x *RealTimeMessage) GetEvent() []byte

func (*RealTimeMessage) GetEventType

func (x *RealTimeMessage) GetEventType() EventType

func (*RealTimeMessage) ProtoMessage

func (*RealTimeMessage) ProtoMessage()

func (*RealTimeMessage) ProtoReflect

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

func (*RealTimeMessage) Reset

func (x *RealTimeMessage) Reset()

func (*RealTimeMessage) String

func (x *RealTimeMessage) String() string

type RealtimeClient

type RealtimeClient interface {
	Presence(ctx context.Context, in *PresenceRequest, opts ...grpc.CallOption) (*PresenceResponse, error)
	GetRTChannel(ctx context.Context, in *GetRTChannelRequest, opts ...grpc.CallOption) (*GetRTChannelResponse, error)
	GetRTChannels(ctx context.Context, in *GetRTChannelsRequest, opts ...grpc.CallOption) (*GetRTChannelsResponse, error)
	ReadMessages(ctx context.Context, in *ReadMessagesRequest, opts ...grpc.CallOption) (Realtime_ReadMessagesClient, error)
	Messages(ctx context.Context, in *MessagesRequest, opts ...grpc.CallOption) (*MessagesResponse, error)
	ListSubscriptions(ctx context.Context, in *ListSubscriptionRequest, opts ...grpc.CallOption) (*ListSubscriptionResponse, error)
}

RealtimeClient is the client API for Realtime 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 NewRealtimeClient

func NewRealtimeClient(cc grpc.ClientConnInterface) RealtimeClient

type RealtimeServer

RealtimeServer is the server API for Realtime service. All implementations should embed UnimplementedRealtimeServer for forward compatibility

type Realtime_ReadMessagesClient

type Realtime_ReadMessagesClient interface {
	Recv() (*ReadMessagesResponse, error)
	grpc.ClientStream
}

type Realtime_ReadMessagesServer

type Realtime_ReadMessagesServer interface {
	Send(*ReadMessagesResponse) error
	grpc.ServerStream
}

type ReplaceRequest

type ReplaceRequest struct {

	// Project name whose db is under target to replace documents.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// Collection name where to replace documents.
	Collection string `protobuf:"bytes,2,opt,name=collection,proto3" json:"collection,omitempty"`
	// Array of documents to be replaced. Each document is a JSON object.
	Documents [][]byte               `protobuf:"bytes,3,rep,name=documents,proto3" json:"documents,omitempty"`
	Options   *ReplaceRequestOptions `protobuf:"bytes,4,opt,name=options,proto3" json:"options,omitempty"`
	// Optionally specify a database branch name to perform operation on
	Branch string `protobuf:"bytes,5,opt,name=branch,proto3" json:"branch,omitempty"`
	// contains filtered or unexported fields
}

func (*ReplaceRequest) Descriptor deprecated

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

Deprecated: Use ReplaceRequest.ProtoReflect.Descriptor instead.

func (*ReplaceRequest) GetBranch

func (x *ReplaceRequest) GetBranch() string

func (*ReplaceRequest) GetCollection

func (x *ReplaceRequest) GetCollection() string

func (*ReplaceRequest) GetDocuments

func (x *ReplaceRequest) GetDocuments() [][]byte

func (*ReplaceRequest) GetOptions

func (x *ReplaceRequest) GetOptions() *ReplaceRequestOptions

func (*ReplaceRequest) GetProject

func (x *ReplaceRequest) GetProject() string

func (*ReplaceRequest) ProtoMessage

func (*ReplaceRequest) ProtoMessage()

func (*ReplaceRequest) ProtoReflect

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

func (*ReplaceRequest) Reset

func (x *ReplaceRequest) Reset()

func (*ReplaceRequest) String

func (x *ReplaceRequest) String() string

func (*ReplaceRequest) UnmarshalJSON

func (x *ReplaceRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON on ReplaceRequest avoids unmarshalling user document. We only need to extract primary/index keys from the document and want to store the document as-is in the database. This way there is no extra cost of serialization/deserialization and also less error-prone because we are not touching the user document. The req handler needs to extract out the relevant keys from the user docs and should pass it as-is to the underlying engine.

type ReplaceRequestOptions

type ReplaceRequestOptions struct {
	WriteOptions *WriteOptions `protobuf:"bytes,1,opt,name=write_options,json=writeOptions,proto3" json:"write_options,omitempty"`
	// contains filtered or unexported fields
}

Additional options for replace requests.

func (*ReplaceRequestOptions) Descriptor deprecated

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

Deprecated: Use ReplaceRequestOptions.ProtoReflect.Descriptor instead.

func (*ReplaceRequestOptions) GetWriteOptions

func (x *ReplaceRequestOptions) GetWriteOptions() *WriteOptions

func (*ReplaceRequestOptions) ProtoMessage

func (*ReplaceRequestOptions) ProtoMessage()

func (*ReplaceRequestOptions) ProtoReflect

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

func (*ReplaceRequestOptions) Reset

func (x *ReplaceRequestOptions) Reset()

func (*ReplaceRequestOptions) String

func (x *ReplaceRequestOptions) String() string

type ReplaceResponse

type ReplaceResponse struct {

	// Has metadata related to the documents stored.
	Metadata *ResponseMetadata `protobuf:"bytes,1,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// an enum with value set as "replaced"
	Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// an array returns the value of the primary keys.
	Keys [][]byte `protobuf:"bytes,3,rep,name=keys,proto3" json:"keys,omitempty"`
	// contains filtered or unexported fields
}

func (*ReplaceResponse) Descriptor deprecated

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

Deprecated: Use ReplaceResponse.ProtoReflect.Descriptor instead.

func (*ReplaceResponse) GetKeys

func (x *ReplaceResponse) GetKeys() [][]byte

func (*ReplaceResponse) GetMetadata

func (x *ReplaceResponse) GetMetadata() *ResponseMetadata

func (*ReplaceResponse) GetStatus

func (x *ReplaceResponse) GetStatus() string

func (*ReplaceResponse) MarshalJSON

func (x *ReplaceResponse) MarshalJSON() ([]byte, error)

func (*ReplaceResponse) ProtoMessage

func (*ReplaceResponse) ProtoMessage()

func (*ReplaceResponse) ProtoReflect

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

func (*ReplaceResponse) Reset

func (x *ReplaceResponse) Reset()

func (*ReplaceResponse) String

func (x *ReplaceResponse) String() string

type ResponseMetadata

type ResponseMetadata struct {

	// Time at which the document was inserted/replaced. Measured in nano-seconds since the Unix epoch.
	CreatedAt *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// Time at which the document was updated. Measured in nano-seconds since the Unix epoch.
	UpdatedAt *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
	// Time at which the document was deleted. Measured in nano-seconds since the Unix epoch.
	DeletedAt *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=deleted_at,json=deletedAt,proto3" json:"deleted_at,omitempty"`
	// contains filtered or unexported fields
}

Has metadata related to the documents stored.

func (*ResponseMetadata) Descriptor deprecated

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

Deprecated: Use ResponseMetadata.ProtoReflect.Descriptor instead.

func (*ResponseMetadata) GetCreatedAt

func (x *ResponseMetadata) GetCreatedAt() *timestamppb.Timestamp

func (*ResponseMetadata) GetDeletedAt

func (x *ResponseMetadata) GetDeletedAt() *timestamppb.Timestamp

func (*ResponseMetadata) GetUpdatedAt

func (x *ResponseMetadata) GetUpdatedAt() *timestamppb.Timestamp

func (*ResponseMetadata) ProtoMessage

func (*ResponseMetadata) ProtoMessage()

func (*ResponseMetadata) ProtoReflect

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

func (*ResponseMetadata) Reset

func (x *ResponseMetadata) Reset()

func (*ResponseMetadata) String

func (x *ResponseMetadata) String() string

type RetryInfo

type RetryInfo struct {

	// retry delay advice in milliseconds
	Delay int32 `protobuf:"varint,3,opt,name=delay,proto3" json:"delay,omitempty"`
	// contains filtered or unexported fields
}

Contains retry information

func (*RetryInfo) Descriptor deprecated

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

Deprecated: Use RetryInfo.ProtoReflect.Descriptor instead.

func (*RetryInfo) GetDelay

func (x *RetryInfo) GetDelay() int32

func (*RetryInfo) ProtoMessage

func (*RetryInfo) ProtoMessage()

func (*RetryInfo) ProtoReflect

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

func (*RetryInfo) Reset

func (x *RetryInfo) Reset()

func (*RetryInfo) String

func (x *RetryInfo) String() string

type RollbackTransactionRequest

type RollbackTransactionRequest struct {

	// Project name whose DB this transaction belongs to.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// Optionally specify a database branch name to perform operation on
	Branch string `protobuf:"bytes,2,opt,name=branch,proto3" json:"branch,omitempty"`
	// contains filtered or unexported fields
}

Rollback transaction with the given ID

func (*RollbackTransactionRequest) Descriptor deprecated

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

Deprecated: Use RollbackTransactionRequest.ProtoReflect.Descriptor instead.

func (*RollbackTransactionRequest) GetBranch

func (x *RollbackTransactionRequest) GetBranch() string

func (*RollbackTransactionRequest) GetProject

func (x *RollbackTransactionRequest) GetProject() string

func (*RollbackTransactionRequest) ProtoMessage

func (*RollbackTransactionRequest) ProtoMessage()

func (*RollbackTransactionRequest) ProtoReflect

func (*RollbackTransactionRequest) Reset

func (x *RollbackTransactionRequest) Reset()

func (*RollbackTransactionRequest) String

func (x *RollbackTransactionRequest) String() string

type RollbackTransactionResponse

type RollbackTransactionResponse struct {

	// Status of rollback transaction operation.
	Status string `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*RollbackTransactionResponse) Descriptor deprecated

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

Deprecated: Use RollbackTransactionResponse.ProtoReflect.Descriptor instead.

func (*RollbackTransactionResponse) GetStatus

func (x *RollbackTransactionResponse) GetStatus() string

func (*RollbackTransactionResponse) ProtoMessage

func (*RollbackTransactionResponse) ProtoMessage()

func (*RollbackTransactionResponse) ProtoReflect

func (*RollbackTransactionResponse) Reset

func (x *RollbackTransactionResponse) Reset()

func (*RollbackTransactionResponse) String

func (x *RollbackTransactionResponse) String() string

type RollupAggregator

type RollupAggregator int32

Specifies how the initial query's result buckets should be processed in next stage.

const (
	RollupAggregator_ROLLUP_AGGREGATOR_SUM   RollupAggregator = 0
	RollupAggregator_ROLLUP_AGGREGATOR_COUNT RollupAggregator = 1
	RollupAggregator_ROLLUP_AGGREGATOR_MIN   RollupAggregator = 2
	RollupAggregator_ROLLUP_AGGREGATOR_MAX   RollupAggregator = 3
	RollupAggregator_ROLLUP_AGGREGATOR_AVG   RollupAggregator = 4
)

func (RollupAggregator) Descriptor

func (RollupAggregator) Enum

func (RollupAggregator) EnumDescriptor deprecated

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

Deprecated: Use RollupAggregator.Descriptor instead.

func (RollupAggregator) Number

func (RollupAggregator) String

func (x RollupAggregator) String() string

func (RollupAggregator) Type

type RollupFunction

type RollupFunction struct {
	Aggregator RollupAggregator `protobuf:"varint,1,opt,name=aggregator,proto3,enum=tigrisdata.observability.v1.RollupAggregator" json:"aggregator,omitempty"`
	Interval   int64            `protobuf:"varint,2,opt,name=interval,proto3" json:"interval,omitempty"`
	// contains filtered or unexported fields
}

Rollup function aggregates the slices of metrics returned by original query and lets you operate on the slices using aggregator and constructs the bigger slice of your choice of interval (specified in seconds).

func (*RollupFunction) Descriptor deprecated

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

Deprecated: Use RollupFunction.ProtoReflect.Descriptor instead.

func (*RollupFunction) GetAggregator

func (x *RollupFunction) GetAggregator() RollupAggregator

func (*RollupFunction) GetInterval

func (x *RollupFunction) GetInterval() int64

func (*RollupFunction) ProtoMessage

func (*RollupFunction) ProtoMessage()

func (*RollupFunction) ProtoReflect

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

func (*RollupFunction) Reset

func (x *RollupFunction) Reset()

func (*RollupFunction) String

func (x *RollupFunction) String() string

type RotateAppKeyRequest

type RotateAppKeyRequest struct {

	// app key id
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// project name
	Project string `protobuf:"bytes,2,opt,name=project,proto3" json:"project,omitempty"`
	// contains filtered or unexported fields
}

Request rotation of an app key secret

func (*RotateAppKeyRequest) Descriptor deprecated

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

Deprecated: Use RotateAppKeyRequest.ProtoReflect.Descriptor instead.

func (*RotateAppKeyRequest) GetId

func (x *RotateAppKeyRequest) GetId() string

func (*RotateAppKeyRequest) GetProject

func (x *RotateAppKeyRequest) GetProject() string

func (*RotateAppKeyRequest) ProtoMessage

func (*RotateAppKeyRequest) ProtoMessage()

func (*RotateAppKeyRequest) ProtoReflect

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

func (*RotateAppKeyRequest) Reset

func (x *RotateAppKeyRequest) Reset()

func (*RotateAppKeyRequest) String

func (x *RotateAppKeyRequest) String() string

type RotateAppKeyResponse

type RotateAppKeyResponse struct {

	// A new app key with rotated secret.
	AppKey *AppKey `protobuf:"bytes,1,opt,name=app_key,json=appKey,proto3" json:"app_key,omitempty"`
	// contains filtered or unexported fields
}

RotateAppKeyResponse returns the new app key with rotated secret

func (*RotateAppKeyResponse) Descriptor deprecated

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

Deprecated: Use RotateAppKeyResponse.ProtoReflect.Descriptor instead.

func (*RotateAppKeyResponse) GetAppKey

func (x *RotateAppKeyResponse) GetAppKey() *AppKey

func (*RotateAppKeyResponse) ProtoMessage

func (*RotateAppKeyResponse) ProtoMessage()

func (*RotateAppKeyResponse) ProtoReflect

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

func (*RotateAppKeyResponse) Reset

func (x *RotateAppKeyResponse) Reset()

func (*RotateAppKeyResponse) String

func (x *RotateAppKeyResponse) String() string

type SearchClient

type SearchClient interface {
	CreateOrUpdateIndex(ctx context.Context, in *CreateOrUpdateIndexRequest, opts ...grpc.CallOption) (*CreateOrUpdateIndexResponse, error)
	GetIndex(ctx context.Context, in *GetIndexRequest, opts ...grpc.CallOption) (*GetIndexResponse, error)
	DeleteIndex(ctx context.Context, in *DeleteIndexRequest, opts ...grpc.CallOption) (*DeleteIndexResponse, error)
	ListIndexes(ctx context.Context, in *ListIndexesRequest, opts ...grpc.CallOption) (*ListIndexesResponse, error)
	// Retrieves one or more documents by id. The response is an array of documents in the same order it is requests.
	// A null is returned for the documents that are not found.
	Get(ctx context.Context, in *GetDocumentRequest, opts ...grpc.CallOption) (*GetDocumentResponse, error)
	// CreateById is used for indexing a single document. The API expects a single document. An "id" is optional
	// and the server can automatically generate it for you in case it is missing. In cases an id is provided in
	// the document and the document already exists then that document will not be indexed and an error is returned
	// with HTTP status code 409.
	CreateById(ctx context.Context, in *CreateByIdRequest, opts ...grpc.CallOption) (*CreateByIdResponse, error)
	// Create is used for indexing a single or multiple documents. The API expects an array of documents.
	// Each document is a JSON object. An "id" is optional and the server can automatically generate it for you in
	// case it is missing. In cases when an id is provided in the document and the document already exists then that
	// document will not be indexed and in the response there will be an error corresponding to that document id other
	// documents will succeed. Returns an array of status indicating the status of each document.
	Create(ctx context.Context, in *CreateDocumentRequest, opts ...grpc.CallOption) (*CreateDocumentResponse, error)
	// Creates or replaces one or more documents. Each document is a JSON object. A document is replaced
	// if it already exists. An "id" is generated automatically in case it is missing in the document. The
	// document is created if "id" doesn't exists otherwise it is replaced. Returns an array of status indicating
	// the status of each document.
	CreateOrReplace(ctx context.Context, in *CreateOrReplaceDocumentRequest, opts ...grpc.CallOption) (*CreateOrReplaceDocumentResponse, error)
	// Updates one or more documents by "id". Each document is required to have the
	// "id" field in it. Returns an array of status indicating the status of each document. Each status
	// has an error field that is set to null in case document is updated successfully otherwise the error
	// field is set with a code and message.
	Update(ctx context.Context, in *UpdateDocumentRequest, opts ...grpc.CallOption) (*UpdateDocumentResponse, error)
	// Delete one or more documents by id. Returns an array of status indicating the status of each document. Each status
	// has an error field that is set to null in case document is deleted successfully otherwise it will non null with
	// an error code and message.
	Delete(ctx context.Context, in *DeleteDocumentRequest, opts ...grpc.CallOption) (*DeleteDocumentResponse, error)
	// DeleteByQuery is used to delete documents that match the filter. A filter is required. To delete document by id,
	// you can pass the filter as follows “`{"id": "test"}“`. Returns a count of number of documents deleted.
	DeleteByQuery(ctx context.Context, in *DeleteByQueryRequest, opts ...grpc.CallOption) (*DeleteByQueryResponse, error)
	// Searches an index for the documents matching the query. A search can be a term search or a phrase search.
	// Search API allows filtering the result set using filters as documented
	// <a href="https://docs.tigrisdata.com/overview/query#specification-1" title="here">here</a>. You can also perform
	// a faceted search by passing the fields in the facet parameter. You can find more detailed documentation of the
	// Search API with multiple examples <a href="https://docs.tigrisdata.com/overview/search" title="here">here</a>.
	Search(ctx context.Context, in *SearchIndexRequest, opts ...grpc.CallOption) (Search_SearchClient, 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 SearchFacet

type SearchFacet struct {
	Counts []*FacetCount `protobuf:"bytes,1,rep,name=counts,proto3" json:"counts,omitempty"`
	Stats  *FacetStats   `protobuf:"bytes,2,opt,name=stats,proto3" json:"stats,omitempty"`
	// contains filtered or unexported fields
}

func (*SearchFacet) Descriptor deprecated

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

Deprecated: Use SearchFacet.ProtoReflect.Descriptor instead.

func (*SearchFacet) GetCounts

func (x *SearchFacet) GetCounts() []*FacetCount

func (*SearchFacet) GetStats

func (x *SearchFacet) GetStats() *FacetStats

func (*SearchFacet) MarshalJSON

func (x *SearchFacet) MarshalJSON() ([]byte, error)

func (*SearchFacet) ProtoMessage

func (*SearchFacet) ProtoMessage()

func (*SearchFacet) ProtoReflect

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

func (*SearchFacet) Reset

func (x *SearchFacet) Reset()

func (*SearchFacet) String

func (x *SearchFacet) String() string

type SearchHit

type SearchHit struct {

	// Actual search document
	Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// Has metadata related to the search hit
	Metadata *SearchHitMeta `protobuf:"bytes,2,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

func (*SearchHit) Descriptor deprecated

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

Deprecated: Use SearchHit.ProtoReflect.Descriptor instead.

func (*SearchHit) GetData

func (x *SearchHit) GetData() []byte

func (*SearchHit) GetMetadata

func (x *SearchHit) GetMetadata() *SearchHitMeta

func (*SearchHit) MarshalJSON

func (x *SearchHit) MarshalJSON() ([]byte, error)

func (*SearchHit) ProtoMessage

func (*SearchHit) ProtoMessage()

func (*SearchHit) ProtoReflect

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

func (*SearchHit) Reset

func (x *SearchHit) Reset()

func (*SearchHit) String

func (x *SearchHit) String() string

type SearchHitMeta

type SearchHitMeta struct {

	// Time at which the document was inserted/replaced. Measured in nano-seconds since the Unix epoch.
	CreatedAt *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// Time at which the document was updated. Measured in nano-seconds since the Unix epoch.
	UpdatedAt *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
	// Match has the information about the matching document like the matched field, etc
	Match *Match `protobuf:"bytes,3,opt,name=match,proto3" json:"match,omitempty"`
	// contains filtered or unexported fields
}

Contains metadata related to the search hit, has information about document created_at/updated_at as well.

func (*SearchHitMeta) Descriptor deprecated

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

Deprecated: Use SearchHitMeta.ProtoReflect.Descriptor instead.

func (*SearchHitMeta) GetCreatedAt

func (x *SearchHitMeta) GetCreatedAt() *timestamppb.Timestamp

func (*SearchHitMeta) GetMatch

func (x *SearchHitMeta) GetMatch() *Match

func (*SearchHitMeta) GetUpdatedAt

func (x *SearchHitMeta) GetUpdatedAt() *timestamppb.Timestamp

func (*SearchHitMeta) ProtoMessage

func (*SearchHitMeta) ProtoMessage()

func (*SearchHitMeta) ProtoReflect

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

func (*SearchHitMeta) Reset

func (x *SearchHitMeta) Reset()

func (*SearchHitMeta) String

func (x *SearchHitMeta) String() string

type SearchHitMetadata

type SearchHitMetadata struct {
	CreatedAt *time.Time `json:"created_at,omitempty"`
	UpdatedAt *time.Time `json:"updated_at,omitempty"`
	Match     *Match     `json:"match,omitempty"`
}

func CreateMDFromSearchMD

func CreateMDFromSearchMD(x *SearchHitMeta) *SearchHitMetadata

type SearchIndexRequest

type SearchIndexRequest struct {

	// Project name whose db is under target to search documents from.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// The index name to search documents from.
	Index string `protobuf:"bytes,2,opt,name=index,proto3" json:"index,omitempty"`
	// Query string for searching across text fields
	Q string `protobuf:"bytes,3,opt,name=q,proto3" json:"q,omitempty"`
	// Array of fields to project search query against
	SearchFields []string `protobuf:"bytes,4,rep,name=search_fields,json=searchFields,proto3" json:"search_fields,omitempty"`
	// Filter stacks on top of query results to further narrow down the results. Similar to `ReadRequest.filter`
	Filter []byte `protobuf:"bytes,5,opt,name=filter,proto3" json:"filter,omitempty"`
	// Facet query to aggregate results on given fields. The field name for the facet search can be passed like this `{"brand": { "size": 10 }}`
	// where the size controls the total facets for this field.
	Facet []byte `protobuf:"bytes,6,opt,name=facet,proto3" json:"facet,omitempty"`
	// Array of fields and corresponding sort orders to order the results `[{ "salary": "$desc" }]`
	Sort []byte `protobuf:"bytes,7,opt,name=sort,proto3" json:"sort,omitempty"`
	// Array of document field names to include in results. By default, all fields are included.
	IncludeFields []string `protobuf:"bytes,8,rep,name=include_fields,json=includeFields,proto3" json:"include_fields,omitempty"`
	// Array of document field names to exclude from results. `include_fields`, if specified, takes precedence over `exclude_fields`.
	ExcludeFields []string `protobuf:"bytes,9,rep,name=exclude_fields,json=excludeFields,proto3" json:"exclude_fields,omitempty"`
	// Optionally can set the number of hits to be returned per page, default is 20.
	PageSize int32 `protobuf:"varint,10,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optionally can specify the page to retrieve. If page is set then only hits for this page is returned
	Page int32 `protobuf:"varint,11,opt,name=page,proto3" json:"page,omitempty"`
	// A collation allows you to specify string comparison rules. Default is case-sensitive, to override it you can set
	// this option to 'ci' that will apply to all the text fields in the filters.
	Collation *Collation `protobuf:"bytes,12,opt,name=collation,proto3" json:"collation,omitempty"`
	// Group by can be used to group search results. For example, to group by city field the
	// syntax would be: `{ "fields": ["city"]}`. Optionally a grouping limit can be set. By default it is 3 per group.
	GroupBy []byte `protobuf:"bytes,13,opt,name=group_by,json=groupBy,proto3" json:"group_by,omitempty"`
	// contains filtered or unexported fields
}

func (*SearchIndexRequest) Descriptor deprecated

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

Deprecated: Use SearchIndexRequest.ProtoReflect.Descriptor instead.

func (*SearchIndexRequest) GetCollation

func (x *SearchIndexRequest) GetCollation() *Collation

func (*SearchIndexRequest) GetExcludeFields

func (x *SearchIndexRequest) GetExcludeFields() []string

func (*SearchIndexRequest) GetFacet

func (x *SearchIndexRequest) GetFacet() []byte

func (*SearchIndexRequest) GetFilter

func (x *SearchIndexRequest) GetFilter() []byte

func (*SearchIndexRequest) GetGroupBy

func (x *SearchIndexRequest) GetGroupBy() []byte

func (*SearchIndexRequest) GetIncludeFields

func (x *SearchIndexRequest) GetIncludeFields() []string

func (*SearchIndexRequest) GetIndex

func (x *SearchIndexRequest) GetIndex() string

func (*SearchIndexRequest) GetPage

func (x *SearchIndexRequest) GetPage() int32

func (*SearchIndexRequest) GetPageSize

func (x *SearchIndexRequest) GetPageSize() int32

func (*SearchIndexRequest) GetProject

func (x *SearchIndexRequest) GetProject() string

func (*SearchIndexRequest) GetQ

func (x *SearchIndexRequest) GetQ() string

func (*SearchIndexRequest) GetSearchFields

func (x *SearchIndexRequest) GetSearchFields() []string

func (*SearchIndexRequest) GetSort

func (x *SearchIndexRequest) GetSort() []byte

func (*SearchIndexRequest) ProtoMessage

func (*SearchIndexRequest) ProtoMessage()

func (*SearchIndexRequest) ProtoReflect

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

func (*SearchIndexRequest) Reset

func (x *SearchIndexRequest) Reset()

func (*SearchIndexRequest) String

func (x *SearchIndexRequest) String() string

func (*SearchIndexRequest) UnmarshalJSON

func (x *SearchIndexRequest) UnmarshalJSON(data []byte) error

type SearchIndexResponse

type SearchIndexResponse struct {
	Hits   []*SearchHit            `protobuf:"bytes,1,rep,name=hits,proto3" json:"hits,omitempty"`
	Facets map[string]*SearchFacet `` /* 153-byte string literal not displayed */
	Meta   *SearchMetadata         `protobuf:"bytes,3,opt,name=meta,proto3" json:"meta,omitempty"`
	// Group is returned when group_by is used in the search request. In this case the above hits will be empty and
	// hits are returned by the group keys.
	Group []*GroupedSearchHits `protobuf:"bytes,4,rep,name=group,proto3" json:"group,omitempty"`
	// contains filtered or unexported fields
}

func (*SearchIndexResponse) Descriptor deprecated

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

Deprecated: Use SearchIndexResponse.ProtoReflect.Descriptor instead.

func (*SearchIndexResponse) GetFacets

func (x *SearchIndexResponse) GetFacets() map[string]*SearchFacet

func (*SearchIndexResponse) GetGroup

func (x *SearchIndexResponse) GetGroup() []*GroupedSearchHits

func (*SearchIndexResponse) GetHits

func (x *SearchIndexResponse) GetHits() []*SearchHit

func (*SearchIndexResponse) GetMeta

func (x *SearchIndexResponse) GetMeta() *SearchMetadata

func (*SearchIndexResponse) MarshalJSON

func (x *SearchIndexResponse) MarshalJSON() ([]byte, error)

func (*SearchIndexResponse) ProtoMessage

func (*SearchIndexResponse) ProtoMessage()

func (*SearchIndexResponse) ProtoReflect

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

func (*SearchIndexResponse) Reset

func (x *SearchIndexResponse) Reset()

func (*SearchIndexResponse) String

func (x *SearchIndexResponse) String() string

type SearchMetadata

type SearchMetadata struct {

	// Total number of search results across all pages
	Found int64 `protobuf:"varint,1,opt,name=found,proto3" json:"found,omitempty"`
	// Number representing the total pages of results
	TotalPages    int32    `protobuf:"varint,2,opt,name=total_pages,json=totalPages,proto3" json:"total_pages,omitempty"`
	Page          *Page    `protobuf:"bytes,3,opt,name=page,proto3" json:"page,omitempty"`
	MatchedFields []string `protobuf:"bytes,4,rep,name=matched_fields,json=matchedFields,proto3" json:"matched_fields,omitempty"`
	// contains filtered or unexported fields
}

func (*SearchMetadata) Descriptor deprecated

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

Deprecated: Use SearchMetadata.ProtoReflect.Descriptor instead.

func (*SearchMetadata) GetFound

func (x *SearchMetadata) GetFound() int64

func (*SearchMetadata) GetMatchedFields

func (x *SearchMetadata) GetMatchedFields() []string

func (*SearchMetadata) GetPage

func (x *SearchMetadata) GetPage() *Page

func (*SearchMetadata) GetTotalPages

func (x *SearchMetadata) GetTotalPages() int32

func (*SearchMetadata) MarshalJSON

func (x *SearchMetadata) MarshalJSON() ([]byte, error)

func (*SearchMetadata) ProtoMessage

func (*SearchMetadata) ProtoMessage()

func (*SearchMetadata) ProtoReflect

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

func (*SearchMetadata) Reset

func (x *SearchMetadata) Reset()

func (*SearchMetadata) String

func (x *SearchMetadata) String() string

type SearchRequest

type SearchRequest struct {

	// Project name whose db is under target to search documents from.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// Collection name to search documents from.
	Collection string `protobuf:"bytes,2,opt,name=collection,proto3" json:"collection,omitempty"`
	// Query string for searching across text fields
	Q string `protobuf:"bytes,3,opt,name=q,proto3" json:"q,omitempty"`
	// Array of fields to project search query against
	SearchFields []string `protobuf:"bytes,4,rep,name=search_fields,json=searchFields,proto3" json:"search_fields,omitempty"`
	// Filter stacks on top of query results to further narrow down the results. Similar to `ReadRequest.filter`
	Filter []byte `protobuf:"bytes,5,opt,name=filter,proto3" json:"filter,omitempty"`
	// Facet query to aggregate results on given fields. The field name for the facet search can be passed like this `{"brand": { "size": 10 }}`
	// where the size controls the total facets for this field.
	Facet []byte `protobuf:"bytes,6,opt,name=facet,proto3" json:"facet,omitempty"`
	// Array of fields and corresponding sort orders to order the results `[{ "salary": "$desc" }]`
	Sort []byte `protobuf:"bytes,7,opt,name=sort,proto3" json:"sort,omitempty"`
	// Array of document field names to include in results. By default, all fields are included.
	IncludeFields []string `protobuf:"bytes,8,rep,name=include_fields,json=includeFields,proto3" json:"include_fields,omitempty"`
	// Array of document field names to exclude from results. `include_fields`, if specified, takes precedence over `exclude_fields`.
	ExcludeFields []string `protobuf:"bytes,9,rep,name=exclude_fields,json=excludeFields,proto3" json:"exclude_fields,omitempty"`
	// Optionally can set the number of hits to be returned per page, default is 20.
	PageSize int32 `protobuf:"varint,10,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optionally can specify the page to retrieve. If page is set then only hits for this page is returned
	Page int32 `protobuf:"varint,11,opt,name=page,proto3" json:"page,omitempty"`
	// A collation allows you to specify string comparison rules. Default is case-sensitive, to override it you can set
	// this option to 'ci' that will apply to all the text fields in the filters.
	Collation *Collation `protobuf:"bytes,12,opt,name=collation,proto3" json:"collation,omitempty"`
	// Optionally specify a database branch name to perform operation on
	Branch string `protobuf:"bytes,13,opt,name=branch,proto3" json:"branch,omitempty"`
	// contains filtered or unexported fields
}

func (*SearchRequest) Descriptor deprecated

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

Deprecated: Use SearchRequest.ProtoReflect.Descriptor instead.

func (*SearchRequest) GetBranch

func (x *SearchRequest) GetBranch() string

func (*SearchRequest) GetCollation

func (x *SearchRequest) GetCollation() *Collation

func (*SearchRequest) GetCollection

func (x *SearchRequest) GetCollection() string

func (*SearchRequest) GetExcludeFields

func (x *SearchRequest) GetExcludeFields() []string

func (*SearchRequest) GetFacet

func (x *SearchRequest) GetFacet() []byte

func (*SearchRequest) GetFilter

func (x *SearchRequest) GetFilter() []byte

func (*SearchRequest) GetIncludeFields

func (x *SearchRequest) GetIncludeFields() []string

func (*SearchRequest) GetPage

func (x *SearchRequest) GetPage() int32

func (*SearchRequest) GetPageSize

func (x *SearchRequest) GetPageSize() int32

func (*SearchRequest) GetProject

func (x *SearchRequest) GetProject() string

func (*SearchRequest) GetQ

func (x *SearchRequest) GetQ() string

func (*SearchRequest) GetSearchFields

func (x *SearchRequest) GetSearchFields() []string

func (*SearchRequest) GetSort

func (x *SearchRequest) GetSort() []byte

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) UnmarshalJSON

func (x *SearchRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON for SearchRequest avoids unmarshalling filter, facets, sort and fields.

type SearchResponse

type SearchResponse struct {
	Hits   []*SearchHit            `protobuf:"bytes,1,rep,name=hits,proto3" json:"hits,omitempty"`
	Facets map[string]*SearchFacet `` /* 153-byte string literal not displayed */
	Meta   *SearchMetadata         `protobuf:"bytes,3,opt,name=meta,proto3" json:"meta,omitempty"`
	// contains filtered or unexported fields
}

Response struct for search

func (*SearchResponse) Descriptor deprecated

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

Deprecated: Use SearchResponse.ProtoReflect.Descriptor instead.

func (*SearchResponse) GetFacets

func (x *SearchResponse) GetFacets() map[string]*SearchFacet

func (*SearchResponse) GetHits

func (x *SearchResponse) GetHits() []*SearchHit

func (*SearchResponse) GetMeta

func (x *SearchResponse) GetMeta() *SearchMetadata

func (*SearchResponse) MarshalJSON

func (x *SearchResponse) MarshalJSON() ([]byte, error)

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

type SearchServer

type SearchServer interface {
	CreateOrUpdateIndex(context.Context, *CreateOrUpdateIndexRequest) (*CreateOrUpdateIndexResponse, error)
	GetIndex(context.Context, *GetIndexRequest) (*GetIndexResponse, error)
	DeleteIndex(context.Context, *DeleteIndexRequest) (*DeleteIndexResponse, error)
	ListIndexes(context.Context, *ListIndexesRequest) (*ListIndexesResponse, error)
	// Retrieves one or more documents by id. The response is an array of documents in the same order it is requests.
	// A null is returned for the documents that are not found.
	Get(context.Context, *GetDocumentRequest) (*GetDocumentResponse, error)
	// CreateById is used for indexing a single document. The API expects a single document. An "id" is optional
	// and the server can automatically generate it for you in case it is missing. In cases an id is provided in
	// the document and the document already exists then that document will not be indexed and an error is returned
	// with HTTP status code 409.
	CreateById(context.Context, *CreateByIdRequest) (*CreateByIdResponse, error)
	// Create is used for indexing a single or multiple documents. The API expects an array of documents.
	// Each document is a JSON object. An "id" is optional and the server can automatically generate it for you in
	// case it is missing. In cases when an id is provided in the document and the document already exists then that
	// document will not be indexed and in the response there will be an error corresponding to that document id other
	// documents will succeed. Returns an array of status indicating the status of each document.
	Create(context.Context, *CreateDocumentRequest) (*CreateDocumentResponse, error)
	// Creates or replaces one or more documents. Each document is a JSON object. A document is replaced
	// if it already exists. An "id" is generated automatically in case it is missing in the document. The
	// document is created if "id" doesn't exists otherwise it is replaced. Returns an array of status indicating
	// the status of each document.
	CreateOrReplace(context.Context, *CreateOrReplaceDocumentRequest) (*CreateOrReplaceDocumentResponse, error)
	// Updates one or more documents by "id". Each document is required to have the
	// "id" field in it. Returns an array of status indicating the status of each document. Each status
	// has an error field that is set to null in case document is updated successfully otherwise the error
	// field is set with a code and message.
	Update(context.Context, *UpdateDocumentRequest) (*UpdateDocumentResponse, error)
	// Delete one or more documents by id. Returns an array of status indicating the status of each document. Each status
	// has an error field that is set to null in case document is deleted successfully otherwise it will non null with
	// an error code and message.
	Delete(context.Context, *DeleteDocumentRequest) (*DeleteDocumentResponse, error)
	// DeleteByQuery is used to delete documents that match the filter. A filter is required. To delete document by id,
	// you can pass the filter as follows “`{"id": "test"}“`. Returns a count of number of documents deleted.
	DeleteByQuery(context.Context, *DeleteByQueryRequest) (*DeleteByQueryResponse, error)
	// Searches an index for the documents matching the query. A search can be a term search or a phrase search.
	// Search API allows filtering the result set using filters as documented
	// <a href="https://docs.tigrisdata.com/overview/query#specification-1" title="here">here</a>. You can also perform
	// a faceted search by passing the fields in the facet parameter. You can find more detailed documentation of the
	// Search API with multiple examples <a href="https://docs.tigrisdata.com/overview/search" title="here">here</a>.
	Search(*SearchIndexRequest, Search_SearchServer) error
}

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

type Search_SearchClient

type Search_SearchClient interface {
	Recv() (*SearchIndexResponse, error)
	grpc.ClientStream
}

type Search_SearchServer

type Search_SearchServer interface {
	Send(*SearchIndexResponse) error
	grpc.ServerStream
}

type SetRequest

type SetRequest struct {

	// Tigris project name
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// cache name
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// cache key
	Key string `protobuf:"bytes,3,opt,name=key,proto3" json:"key,omitempty"`
	// free form byte[] value
	Value []byte `protobuf:"bytes,4,opt,name=value,proto3" json:"value,omitempty"`
	// optional - ttl specific to this key in second
	Ex *uint64 `protobuf:"varint,5,opt,name=ex,proto3,oneof" json:"ex,omitempty"`
	// optional - ttl specific to this key in millisecond
	Px *uint64 `protobuf:"varint,6,opt,name=px,proto3,oneof" json:"px,omitempty"`
	// set only if the key doesn't exist
	Nx bool `protobuf:"varint,7,opt,name=nx,proto3" json:"nx,omitempty"`
	// set only if the key exist
	Xx bool `protobuf:"varint,8,opt,name=xx,proto3" json:"xx,omitempty"`
	// contains filtered or unexported fields
}

func (*SetRequest) Descriptor deprecated

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

Deprecated: Use SetRequest.ProtoReflect.Descriptor instead.

func (*SetRequest) GetEx

func (x *SetRequest) GetEx() uint64

func (*SetRequest) GetKey

func (x *SetRequest) GetKey() string

func (*SetRequest) GetName

func (x *SetRequest) GetName() string

func (*SetRequest) GetNx

func (x *SetRequest) GetNx() bool

func (*SetRequest) GetProject

func (x *SetRequest) GetProject() string

func (*SetRequest) GetPx

func (x *SetRequest) GetPx() uint64

func (*SetRequest) GetValue

func (x *SetRequest) GetValue() []byte

func (*SetRequest) GetXx

func (x *SetRequest) GetXx() bool

func (*SetRequest) ProtoMessage

func (*SetRequest) ProtoMessage()

func (*SetRequest) ProtoReflect

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

func (*SetRequest) Reset

func (x *SetRequest) Reset()

func (*SetRequest) String

func (x *SetRequest) String() string

type SetResponse

type SetResponse struct {

	// A detailed response message.
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// An enum with value set as "set"
	Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*SetResponse) Descriptor deprecated

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

Deprecated: Use SetResponse.ProtoReflect.Descriptor instead.

func (*SetResponse) GetMessage

func (x *SetResponse) GetMessage() string

func (*SetResponse) GetStatus

func (x *SetResponse) GetStatus() string

func (*SetResponse) ProtoMessage

func (*SetResponse) ProtoMessage()

func (*SetResponse) ProtoReflect

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

func (*SetResponse) Reset

func (x *SetResponse) Reset()

func (*SetResponse) String

func (x *SetResponse) String() string

type SubscribeEvent

type SubscribeEvent struct {
	Channel  string `protobuf:"bytes,1,opt,name=channel,proto3" json:"channel,omitempty"`
	Position string `protobuf:"bytes,2,opt,name=position,proto3" json:"position,omitempty"`
	// name here is what type of event
	// that the caller is interested in
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*SubscribeEvent) Descriptor deprecated

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

Deprecated: Use SubscribeEvent.ProtoReflect.Descriptor instead.

func (*SubscribeEvent) GetChannel

func (x *SubscribeEvent) GetChannel() string

func (*SubscribeEvent) GetName

func (x *SubscribeEvent) GetName() string

func (*SubscribeEvent) GetPosition

func (x *SubscribeEvent) GetPosition() string

func (*SubscribeEvent) ProtoMessage

func (*SubscribeEvent) ProtoMessage()

func (*SubscribeEvent) ProtoReflect

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

func (*SubscribeEvent) Reset

func (x *SubscribeEvent) Reset()

func (*SubscribeEvent) String

func (x *SubscribeEvent) String() string

type SubscribedEvent

type SubscribedEvent struct {
	Channel  string `protobuf:"bytes,1,opt,name=channel,proto3" json:"channel,omitempty"`
	Position string `protobuf:"bytes,2,opt,name=position,proto3" json:"position,omitempty"`
	// contains filtered or unexported fields
}

func (*SubscribedEvent) Descriptor deprecated

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

Deprecated: Use SubscribedEvent.ProtoReflect.Descriptor instead.

func (*SubscribedEvent) GetChannel

func (x *SubscribedEvent) GetChannel() string

func (*SubscribedEvent) GetPosition

func (x *SubscribedEvent) GetPosition() string

func (*SubscribedEvent) ProtoMessage

func (*SubscribedEvent) ProtoMessage()

func (*SubscribedEvent) ProtoReflect

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

func (*SubscribedEvent) Reset

func (x *SubscribedEvent) Reset()

func (*SubscribedEvent) String

func (x *SubscribedEvent) String() string

type TigrisClient

type TigrisClient interface {
	// Starts a new transaction and returns a transactional object. All reads/writes performed
	// within a transaction will run with serializable isolation. Tigris offers global transactions,
	// with ACID properties and strict serializability.
	BeginTransaction(ctx context.Context, in *BeginTransactionRequest, opts ...grpc.CallOption) (*BeginTransactionResponse, error)
	// Atomically commit all the changes performed in the context of the transaction. Commit provides all
	// or nothing semantics by ensuring no partial updates are in the project due to a transaction failure.
	CommitTransaction(ctx context.Context, in *CommitTransactionRequest, opts ...grpc.CallOption) (*CommitTransactionResponse, error)
	// Rollback transaction discards all the changes
	// performed in the transaction
	RollbackTransaction(ctx context.Context, in *RollbackTransactionRequest, opts ...grpc.CallOption) (*RollbackTransactionResponse, error)
	// Inserts new documents in the collection and returns an AlreadyExists error if any of the documents
	// in the request already exists. Insert provides idempotency by returning an error if the document
	// already exists. To replace documents, use REPLACE API instead of INSERT.
	Insert(ctx context.Context, in *InsertRequest, opts ...grpc.CallOption) (*InsertResponse, error)
	// Inserts the documents or replaces the existing documents in the collections.
	Replace(ctx context.Context, in *ReplaceRequest, opts ...grpc.CallOption) (*ReplaceResponse, error)
	// Delete a range of documents in the collection using the condition provided in the filter.
	Delete(ctx context.Context, in *DeleteRequest, opts ...grpc.CallOption) (*DeleteResponse, error)
	// Update a range of documents in the collection using the condition provided in the filter.
	Update(ctx context.Context, in *UpdateRequest, opts ...grpc.CallOption) (*UpdateResponse, error)
	// Reads a range of documents from the collection, or messages from a collection in case of event streaming. Tigris does not require you to
	// index any fields and automatically index all the fields which means you can filter by any field in the document.
	// An empty filter will trigger reading all the documents inside this collection. The API supports pagination that
	// can be used by passing `Limit/Skip` parameters. The `skip` parameter skips the number of documents from the start and
	// the `limit` parameter is used to specify the number of documents to read. You can find more detailed documentation
	// of the Read API <a href="https://docs.tigrisdata.com/overview/query" title="here">here</a>.
	Read(ctx context.Context, in *ReadRequest, opts ...grpc.CallOption) (Tigris_ReadClient, error)
	// Searches a collection for the documents matching the query, or messages in case of event streaming. A search can be
	// a term search or a phrase search. Search API allows filtering the result set using filters as documented <a href="https://docs.tigrisdata.com/overview/query#specification-1" title="here">here</a>.
	// You can also perform a faceted search by passing the fields in the facet parameter.
	// You can find more detailed documentation of the Search API with multiple examples <a href="https://docs.tigrisdata.com/overview/search" title="here">here</a>.
	Search(ctx context.Context, in *SearchRequest, opts ...grpc.CallOption) (Tigris_SearchClient, error)
	// Imports documents into the collection.
	//
	// It automatically:
	//   - Detects the schema of the documents in the batch
	//   - Evolves the schema as soon as it's backward compatible
	//   - Creates collection with inferred schema (if requested)
	Import(ctx context.Context, in *ImportRequest, opts ...grpc.CallOption) (*ImportResponse, error)
	// Creates a new collection or atomically upgrades the collection to the new schema provided in the request.
	// Schema changes are applied atomically and immediately without any downtime.
	// Tigris Offers two types of collections: <p></p>
	//
	//	<li> `DOCUMENTS`: Offers rich CRUD APIs.
	//	<li> `MESSAGES`: Offers event streaming APIs.
	CreateOrUpdateCollection(ctx context.Context, in *CreateOrUpdateCollectionRequest, opts ...grpc.CallOption) (*CreateOrUpdateCollectionResponse, error)
	// Drops the collection inside this project. This API deletes all of the
	// documents inside this collection and any metadata associated with it.
	DropCollection(ctx context.Context, in *DropCollectionRequest, opts ...grpc.CallOption) (*DropCollectionResponse, error)
	// List returns all the projects.
	ListProjects(ctx context.Context, in *ListProjectsRequest, opts ...grpc.CallOption) (*ListProjectsResponse, error)
	// List all the collections present in the project passed in the request.
	ListCollections(ctx context.Context, in *ListCollectionsRequest, opts ...grpc.CallOption) (*ListCollectionsResponse, error)
	// Creates a new project. Returns an AlreadyExists error with a status code 409 if the project already exists.
	CreateProject(ctx context.Context, in *CreateProjectRequest, opts ...grpc.CallOption) (*CreateProjectResponse, error)
	// Delete Project deletes all the collections in this project along with all of the documents, and associated metadata for these collections.
	DeleteProject(ctx context.Context, in *DeleteProjectRequest, opts ...grpc.CallOption) (*DeleteProjectResponse, error)
	// This API returns information related to the project along with all the collections inside the project.
	// This can be used to retrieve the size of the project or to retrieve schemas, branches and the size of all the collections present in this project.
	DescribeDatabase(ctx context.Context, in *DescribeDatabaseRequest, opts ...grpc.CallOption) (*DescribeDatabaseResponse, error)
	// Creates a new database branch, if not already existing.
	CreateBranch(ctx context.Context, in *CreateBranchRequest, opts ...grpc.CallOption) (*CreateBranchResponse, error)
	// Deletes a database branch, if exists.
	// Throws 400 Bad Request if "main" branch is being deleted
	DeleteBranch(ctx context.Context, in *DeleteBranchRequest, opts ...grpc.CallOption) (*DeleteBranchResponse, error)
	// List database branches
	ListBranches(ctx context.Context, in *ListBranchesRequest, opts ...grpc.CallOption) (*ListBranchesResponse, error)
	// Returns the information related to the collection. This can be used to retrieve the schema or size of the collection.
	DescribeCollection(ctx context.Context, in *DescribeCollectionRequest, opts ...grpc.CallOption) (*DescribeCollectionResponse, error)
	// Create an app key.
	CreateAppKey(ctx context.Context, in *CreateAppKeyRequest, opts ...grpc.CallOption) (*CreateAppKeyResponse, error)
	// Update the description of an app key.
	UpdateAppKey(ctx context.Context, in *UpdateAppKeyRequest, opts ...grpc.CallOption) (*UpdateAppKeyResponse, error)
	// Delete an app key.
	DeleteAppKey(ctx context.Context, in *DeleteAppKeyRequest, opts ...grpc.CallOption) (*DeleteAppKeyResponse, error)
	// Lists all app keys visible to requesting actor.
	ListAppKeys(ctx context.Context, in *ListAppKeysRequest, opts ...grpc.CallOption) (*ListAppKeysResponse, error)
	// Endpoint is used to rotate the secret for the app key.
	RotateAppKeySecret(ctx context.Context, in *RotateAppKeyRequest, opts ...grpc.CallOption) (*RotateAppKeyResponse, error)
}

TigrisClient is the client API for Tigris 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 NewTigrisClient

func NewTigrisClient(cc grpc.ClientConnInterface) TigrisClient

type TigrisError

type TigrisError struct {
	// Contains Tigris extended error code.
	// Codes upto Code_UNAUTHENTICATED are identical to GRPC error codes
	Code Code `json:"code,omitempty"`
	// A developer-facing error message.
	Message string `json:"message,omitempty"`

	// Contains extended error information.
	// For example retry information.
	Details []proto.Message `json:"details,omitempty"`
}

TigrisError is our Tigris HTTP counterpart of grpc status. All the APIs should use this Error to return as a user facing error. TigrisError will return grpcStatus to the muxer so that grpc client can see grpcStatus as the final output. For HTTP clients see the **MarshalStatus** method where we are returning the response by not the grpc code as that is not needed for HTTP clients.

func Errorf

func Errorf(c Code, format string, a ...interface{}) *TigrisError

Errorf constructs TigrisError.

func FromErrorDetails

func FromErrorDetails(e *ErrorDetails) *TigrisError

FromErrorDetails construct TigrisError from the ErrorDetails, which contains extended code, retry information, etc...

func FromStatusError

func FromStatusError(err error) *TigrisError

FromStatusError parses GRPC status from error into TigrisError.

func UnmarshalStatus

func UnmarshalStatus(b []byte) *TigrisError

UnmarshalStatus reconstruct TigrisError from HTTP error JSON body.

func (*TigrisError) As

func (e *TigrisError) As(i any) bool

As is used by runtime.DefaultHTTPErrorHandler to override HTTP status code.

func (*TigrisError) Error

func (e *TigrisError) Error() string

Error to return the underlying error message.

func (*TigrisError) GRPCStatus

func (e *TigrisError) GRPCStatus() *status.Status

GRPCStatus converts the TigrisError and return status.Status. This is used to return grpc status to the grpc clients.

func (*TigrisError) GetHTTPCode

func (e *TigrisError) GetHTTPCode() int

GetHTTPCode returns Tigris error code as a corresponding HTTP status code.

func (*TigrisError) RetryDelay

func (e *TigrisError) RetryDelay() time.Duration

RetryDelay retrieves retry delay if it's attached to the error.

func (*TigrisError) WithDetails

func (e *TigrisError) WithDetails(details ...proto.Message) *TigrisError

WithDetails a helper method for adding details to the TigrisError.

func (*TigrisError) WithRetry

func (e *TigrisError) WithRetry(d time.Duration) *TigrisError

WithRetry attached retry information to the error.

type TigrisOperation

type TigrisOperation int32

Represents Tigris operation category

const (
	TigrisOperation_ALL      TigrisOperation = 0
	TigrisOperation_READ     TigrisOperation = 1
	TigrisOperation_WRITE    TigrisOperation = 2
	TigrisOperation_METADATA TigrisOperation = 3
)

func (TigrisOperation) Descriptor

func (TigrisOperation) Enum

func (x TigrisOperation) Enum() *TigrisOperation

func (TigrisOperation) EnumDescriptor deprecated

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

Deprecated: Use TigrisOperation.Descriptor instead.

func (TigrisOperation) Number

func (TigrisOperation) String

func (x TigrisOperation) String() string

func (TigrisOperation) Type

type TigrisServer

type TigrisServer interface {
	// Starts a new transaction and returns a transactional object. All reads/writes performed
	// within a transaction will run with serializable isolation. Tigris offers global transactions,
	// with ACID properties and strict serializability.
	BeginTransaction(context.Context, *BeginTransactionRequest) (*BeginTransactionResponse, error)
	// Atomically commit all the changes performed in the context of the transaction. Commit provides all
	// or nothing semantics by ensuring no partial updates are in the project due to a transaction failure.
	CommitTransaction(context.Context, *CommitTransactionRequest) (*CommitTransactionResponse, error)
	// Rollback transaction discards all the changes
	// performed in the transaction
	RollbackTransaction(context.Context, *RollbackTransactionRequest) (*RollbackTransactionResponse, error)
	// Inserts new documents in the collection and returns an AlreadyExists error if any of the documents
	// in the request already exists. Insert provides idempotency by returning an error if the document
	// already exists. To replace documents, use REPLACE API instead of INSERT.
	Insert(context.Context, *InsertRequest) (*InsertResponse, error)
	// Inserts the documents or replaces the existing documents in the collections.
	Replace(context.Context, *ReplaceRequest) (*ReplaceResponse, error)
	// Delete a range of documents in the collection using the condition provided in the filter.
	Delete(context.Context, *DeleteRequest) (*DeleteResponse, error)
	// Update a range of documents in the collection using the condition provided in the filter.
	Update(context.Context, *UpdateRequest) (*UpdateResponse, error)
	// Reads a range of documents from the collection, or messages from a collection in case of event streaming. Tigris does not require you to
	// index any fields and automatically index all the fields which means you can filter by any field in the document.
	// An empty filter will trigger reading all the documents inside this collection. The API supports pagination that
	// can be used by passing `Limit/Skip` parameters. The `skip` parameter skips the number of documents from the start and
	// the `limit` parameter is used to specify the number of documents to read. You can find more detailed documentation
	// of the Read API <a href="https://docs.tigrisdata.com/overview/query" title="here">here</a>.
	Read(*ReadRequest, Tigris_ReadServer) error
	// Searches a collection for the documents matching the query, or messages in case of event streaming. A search can be
	// a term search or a phrase search. Search API allows filtering the result set using filters as documented <a href="https://docs.tigrisdata.com/overview/query#specification-1" title="here">here</a>.
	// You can also perform a faceted search by passing the fields in the facet parameter.
	// You can find more detailed documentation of the Search API with multiple examples <a href="https://docs.tigrisdata.com/overview/search" title="here">here</a>.
	Search(*SearchRequest, Tigris_SearchServer) error
	// Imports documents into the collection.
	//
	// It automatically:
	//   - Detects the schema of the documents in the batch
	//   - Evolves the schema as soon as it's backward compatible
	//   - Creates collection with inferred schema (if requested)
	Import(context.Context, *ImportRequest) (*ImportResponse, error)
	// Creates a new collection or atomically upgrades the collection to the new schema provided in the request.
	// Schema changes are applied atomically and immediately without any downtime.
	// Tigris Offers two types of collections: <p></p>
	//
	//	<li> `DOCUMENTS`: Offers rich CRUD APIs.
	//	<li> `MESSAGES`: Offers event streaming APIs.
	CreateOrUpdateCollection(context.Context, *CreateOrUpdateCollectionRequest) (*CreateOrUpdateCollectionResponse, error)
	// Drops the collection inside this project. This API deletes all of the
	// documents inside this collection and any metadata associated with it.
	DropCollection(context.Context, *DropCollectionRequest) (*DropCollectionResponse, error)
	// List returns all the projects.
	ListProjects(context.Context, *ListProjectsRequest) (*ListProjectsResponse, error)
	// List all the collections present in the project passed in the request.
	ListCollections(context.Context, *ListCollectionsRequest) (*ListCollectionsResponse, error)
	// Creates a new project. Returns an AlreadyExists error with a status code 409 if the project already exists.
	CreateProject(context.Context, *CreateProjectRequest) (*CreateProjectResponse, error)
	// Delete Project deletes all the collections in this project along with all of the documents, and associated metadata for these collections.
	DeleteProject(context.Context, *DeleteProjectRequest) (*DeleteProjectResponse, error)
	// This API returns information related to the project along with all the collections inside the project.
	// This can be used to retrieve the size of the project or to retrieve schemas, branches and the size of all the collections present in this project.
	DescribeDatabase(context.Context, *DescribeDatabaseRequest) (*DescribeDatabaseResponse, error)
	// Creates a new database branch, if not already existing.
	CreateBranch(context.Context, *CreateBranchRequest) (*CreateBranchResponse, error)
	// Deletes a database branch, if exists.
	// Throws 400 Bad Request if "main" branch is being deleted
	DeleteBranch(context.Context, *DeleteBranchRequest) (*DeleteBranchResponse, error)
	// List database branches
	ListBranches(context.Context, *ListBranchesRequest) (*ListBranchesResponse, error)
	// Returns the information related to the collection. This can be used to retrieve the schema or size of the collection.
	DescribeCollection(context.Context, *DescribeCollectionRequest) (*DescribeCollectionResponse, error)
	// Create an app key.
	CreateAppKey(context.Context, *CreateAppKeyRequest) (*CreateAppKeyResponse, error)
	// Update the description of an app key.
	UpdateAppKey(context.Context, *UpdateAppKeyRequest) (*UpdateAppKeyResponse, error)
	// Delete an app key.
	DeleteAppKey(context.Context, *DeleteAppKeyRequest) (*DeleteAppKeyResponse, error)
	// Lists all app keys visible to requesting actor.
	ListAppKeys(context.Context, *ListAppKeysRequest) (*ListAppKeysResponse, error)
	// Endpoint is used to rotate the secret for the app key.
	RotateAppKeySecret(context.Context, *RotateAppKeyRequest) (*RotateAppKeyResponse, error)
}

TigrisServer is the server API for Tigris service. All implementations should embed UnimplementedTigrisServer for forward compatibility

type Tigris_ReadClient

type Tigris_ReadClient interface {
	Recv() (*ReadResponse, error)
	grpc.ClientStream
}

type Tigris_ReadServer

type Tigris_ReadServer interface {
	Send(*ReadResponse) error
	grpc.ServerStream
}

type Tigris_SearchClient

type Tigris_SearchClient interface {
	Recv() (*SearchResponse, error)
	grpc.ClientStream
}

type Tigris_SearchServer

type Tigris_SearchServer interface {
	Send(*SearchResponse) error
	grpc.ServerStream
}

type TransactionCtx

type TransactionCtx struct {

	// Unique for a single transactional request.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Serves as an internal identifier.
	Origin string `protobuf:"bytes,2,opt,name=origin,proto3" json:"origin,omitempty"`
	// contains filtered or unexported fields
}

Contains ID which uniquely identifies transaction This context is returned by BeginTransaction request and should be passed in the metadata (headers) of subsequent requests in order to run them in the context of the same transaction.

func GetTransaction

func GetTransaction(ctx context.Context) *TransactionCtx

func (*TransactionCtx) Descriptor deprecated

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

Deprecated: Use TransactionCtx.ProtoReflect.Descriptor instead.

func (*TransactionCtx) GetId

func (x *TransactionCtx) GetId() string

func (*TransactionCtx) GetOrigin

func (x *TransactionCtx) GetOrigin() string

func (*TransactionCtx) ProtoMessage

func (*TransactionCtx) ProtoMessage()

func (*TransactionCtx) ProtoReflect

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

func (*TransactionCtx) Reset

func (x *TransactionCtx) Reset()

func (*TransactionCtx) String

func (x *TransactionCtx) String() string

type TransactionOptions

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

Options that can be used to modify the transaction semantics.

func (*TransactionOptions) Descriptor deprecated

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

Deprecated: Use TransactionOptions.ProtoReflect.Descriptor instead.

func (*TransactionOptions) ProtoMessage

func (*TransactionOptions) ProtoMessage()

func (*TransactionOptions) ProtoReflect

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

func (*TransactionOptions) Reset

func (x *TransactionOptions) Reset()

func (*TransactionOptions) String

func (x *TransactionOptions) String() string

type UnSubscribeRequest

type UnSubscribeRequest struct {
	Project  string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	Channel  string `protobuf:"bytes,2,opt,name=channel,proto3" json:"channel,omitempty"`
	DeviceId string `protobuf:"bytes,3,opt,name=device_id,json=deviceId,proto3" json:"device_id,omitempty"`
	// contains filtered or unexported fields
}

func (*UnSubscribeRequest) Descriptor deprecated

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

Deprecated: Use UnSubscribeRequest.ProtoReflect.Descriptor instead.

func (*UnSubscribeRequest) GetChannel

func (x *UnSubscribeRequest) GetChannel() string

func (*UnSubscribeRequest) GetDeviceId

func (x *UnSubscribeRequest) GetDeviceId() string

func (*UnSubscribeRequest) GetProject

func (x *UnSubscribeRequest) GetProject() string

func (*UnSubscribeRequest) ProtoMessage

func (*UnSubscribeRequest) ProtoMessage()

func (*UnSubscribeRequest) ProtoReflect

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

func (*UnSubscribeRequest) Reset

func (x *UnSubscribeRequest) Reset()

func (*UnSubscribeRequest) String

func (x *UnSubscribeRequest) String() string

type UnSubscribeResponse

type UnSubscribeResponse struct {
	Status string `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*UnSubscribeResponse) Descriptor deprecated

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

Deprecated: Use UnSubscribeResponse.ProtoReflect.Descriptor instead.

func (*UnSubscribeResponse) GetStatus

func (x *UnSubscribeResponse) GetStatus() string

func (*UnSubscribeResponse) ProtoMessage

func (*UnSubscribeResponse) ProtoMessage()

func (*UnSubscribeResponse) ProtoReflect

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

func (*UnSubscribeResponse) Reset

func (x *UnSubscribeResponse) Reset()

func (*UnSubscribeResponse) String

func (x *UnSubscribeResponse) String() string

type UnimplementedAuthServer

type UnimplementedAuthServer struct {
}

UnimplementedAuthServer should be embedded to have forward compatible implementations.

func (UnimplementedAuthServer) GetAccessToken

type UnimplementedCacheServer

type UnimplementedCacheServer struct {
}

UnimplementedCacheServer should be embedded to have forward compatible implementations.

func (UnimplementedCacheServer) CreateCache

func (UnimplementedCacheServer) Del

func (UnimplementedCacheServer) DeleteCache

func (UnimplementedCacheServer) Get

func (UnimplementedCacheServer) GetSet

func (UnimplementedCacheServer) Keys

func (UnimplementedCacheServer) ListCaches

func (UnimplementedCacheServer) Set

type UnimplementedHealthAPIServer

type UnimplementedHealthAPIServer struct {
}

UnimplementedHealthAPIServer should be embedded to have forward compatible implementations.

func (UnimplementedHealthAPIServer) Health

type UnimplementedManagementServer

type UnimplementedManagementServer struct {
}

UnimplementedManagementServer should be embedded to have forward compatible implementations.

func (UnimplementedManagementServer) CreateNamespace

func (UnimplementedManagementServer) GetUserMetadata

func (UnimplementedManagementServer) ListNamespaces

type UnimplementedObservabilityServer

type UnimplementedObservabilityServer struct {
}

UnimplementedObservabilityServer should be embedded to have forward compatible implementations.

func (UnimplementedObservabilityServer) GetInfo

func (UnimplementedObservabilityServer) QuotaLimits

func (UnimplementedObservabilityServer) QuotaUsage

type UnimplementedRealtimeServer

type UnimplementedRealtimeServer struct {
}

UnimplementedRealtimeServer should be embedded to have forward compatible implementations.

func (UnimplementedRealtimeServer) GetRTChannel

func (UnimplementedRealtimeServer) GetRTChannels

func (UnimplementedRealtimeServer) ListSubscriptions

func (UnimplementedRealtimeServer) Messages

func (UnimplementedRealtimeServer) Presence

func (UnimplementedRealtimeServer) ReadMessages

type UnimplementedSearchServer

type UnimplementedSearchServer struct {
}

UnimplementedSearchServer should be embedded to have forward compatible implementations.

func (UnimplementedSearchServer) CreateById

func (UnimplementedSearchServer) DeleteByQuery

func (UnimplementedSearchServer) DeleteIndex

func (UnimplementedSearchServer) Get

func (UnimplementedSearchServer) GetIndex

func (UnimplementedSearchServer) ListIndexes

func (UnimplementedSearchServer) Search

type UnimplementedTigrisServer

type UnimplementedTigrisServer struct {
}

UnimplementedTigrisServer should be embedded to have forward compatible implementations.

func (UnimplementedTigrisServer) BeginTransaction

func (UnimplementedTigrisServer) CreateAppKey

func (UnimplementedTigrisServer) CreateBranch

func (UnimplementedTigrisServer) CreateProject

func (UnimplementedTigrisServer) Delete

func (UnimplementedTigrisServer) DeleteAppKey

func (UnimplementedTigrisServer) DeleteBranch

func (UnimplementedTigrisServer) DeleteProject

func (UnimplementedTigrisServer) DescribeDatabase

func (UnimplementedTigrisServer) DropCollection

func (UnimplementedTigrisServer) Import

func (UnimplementedTigrisServer) Insert

func (UnimplementedTigrisServer) ListAppKeys

func (UnimplementedTigrisServer) ListBranches

func (UnimplementedTigrisServer) ListCollections

func (UnimplementedTigrisServer) ListProjects

func (UnimplementedTigrisServer) Read

func (UnimplementedTigrisServer) Replace

func (UnimplementedTigrisServer) RotateAppKeySecret

func (UnimplementedTigrisServer) Search

func (UnimplementedTigrisServer) Update

func (UnimplementedTigrisServer) UpdateAppKey

type UnsafeAuthServer

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

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

type UnsafeCacheServer

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

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

type UnsafeHealthAPIServer

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

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

type UnsafeManagementServer

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

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

type UnsafeObservabilityServer

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

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

type UnsafeRealtimeServer

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

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

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.

type UnsafeTigrisServer

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

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

type UnsubscribeEvent

type UnsubscribeEvent struct {
	Channel string `protobuf:"bytes,1,opt,name=channel,proto3" json:"channel,omitempty"`
	// contains filtered or unexported fields
}

func (*UnsubscribeEvent) Descriptor deprecated

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

Deprecated: Use UnsubscribeEvent.ProtoReflect.Descriptor instead.

func (*UnsubscribeEvent) GetChannel

func (x *UnsubscribeEvent) GetChannel() string

func (*UnsubscribeEvent) ProtoMessage

func (*UnsubscribeEvent) ProtoMessage()

func (*UnsubscribeEvent) ProtoReflect

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

func (*UnsubscribeEvent) Reset

func (x *UnsubscribeEvent) Reset()

func (*UnsubscribeEvent) String

func (x *UnsubscribeEvent) String() string

type UpdateAppKeyRequest

type UpdateAppKeyRequest struct {

	// app key id - this is not allowed to update
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// project name -  this is not allowed to update
	Project string `protobuf:"bytes,2,opt,name=project,proto3" json:"project,omitempty"`
	// A new human readable app name
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// A new human readable app description
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

To update the description of the app key

func (*UpdateAppKeyRequest) Descriptor deprecated

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

Deprecated: Use UpdateAppKeyRequest.ProtoReflect.Descriptor instead.

func (*UpdateAppKeyRequest) GetDescription

func (x *UpdateAppKeyRequest) GetDescription() string

func (*UpdateAppKeyRequest) GetId

func (x *UpdateAppKeyRequest) GetId() string

func (*UpdateAppKeyRequest) GetName

func (x *UpdateAppKeyRequest) GetName() string

func (*UpdateAppKeyRequest) GetProject

func (x *UpdateAppKeyRequest) GetProject() string

func (*UpdateAppKeyRequest) ProtoMessage

func (*UpdateAppKeyRequest) ProtoMessage()

func (*UpdateAppKeyRequest) ProtoReflect

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

func (*UpdateAppKeyRequest) Reset

func (x *UpdateAppKeyRequest) Reset()

func (*UpdateAppKeyRequest) String

func (x *UpdateAppKeyRequest) String() string

type UpdateAppKeyResponse

type UpdateAppKeyResponse struct {

	// updated app key object
	UpdatedAppKey *AppKey `protobuf:"bytes,1,opt,name=updated_app_key,json=updatedAppKey,proto3" json:"updated_app_key,omitempty"`
	// contains filtered or unexported fields
}

Returns response for updating the app key description

func (*UpdateAppKeyResponse) Descriptor deprecated

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

Deprecated: Use UpdateAppKeyResponse.ProtoReflect.Descriptor instead.

func (*UpdateAppKeyResponse) GetUpdatedAppKey

func (x *UpdateAppKeyResponse) GetUpdatedAppKey() *AppKey

func (*UpdateAppKeyResponse) ProtoMessage

func (*UpdateAppKeyResponse) ProtoMessage()

func (*UpdateAppKeyResponse) ProtoReflect

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

func (*UpdateAppKeyResponse) Reset

func (x *UpdateAppKeyResponse) Reset()

func (*UpdateAppKeyResponse) String

func (x *UpdateAppKeyResponse) String() string

type UpdateDocumentRequest

type UpdateDocumentRequest struct {

	// Project name whose db is under target to insert documents.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// Index name where to create documents.
	Index string `protobuf:"bytes,2,opt,name=index,proto3" json:"index,omitempty"`
	// An array of documents. Each document should have "id" present which will be used by Tigris for updating the document.
	Documents [][]byte `protobuf:"bytes,3,rep,name=documents,proto3" json:"documents,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateDocumentRequest) Descriptor deprecated

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

Deprecated: Use UpdateDocumentRequest.ProtoReflect.Descriptor instead.

func (*UpdateDocumentRequest) GetDocuments

func (x *UpdateDocumentRequest) GetDocuments() [][]byte

func (*UpdateDocumentRequest) GetIndex

func (x *UpdateDocumentRequest) GetIndex() string

func (*UpdateDocumentRequest) GetProject

func (x *UpdateDocumentRequest) GetProject() string

func (*UpdateDocumentRequest) ProtoMessage

func (*UpdateDocumentRequest) ProtoMessage()

func (*UpdateDocumentRequest) ProtoReflect

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

func (*UpdateDocumentRequest) Reset

func (x *UpdateDocumentRequest) Reset()

func (*UpdateDocumentRequest) String

func (x *UpdateDocumentRequest) String() string

func (*UpdateDocumentRequest) UnmarshalJSON

func (x *UpdateDocumentRequest) UnmarshalJSON(data []byte) error

type UpdateDocumentResponse

type UpdateDocumentResponse struct {

	// An array of statuses of all the documents received in the request. Order is same as it is received in the
	// request. Each item of this array has an “id” and “error” key. Id is set as document id and error will be null
	// in case of success, otherwise error is set with an error code and message.
	Status []*DocStatus `protobuf:"bytes,1,rep,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateDocumentResponse) Descriptor deprecated

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

Deprecated: Use UpdateDocumentResponse.ProtoReflect.Descriptor instead.

func (*UpdateDocumentResponse) GetStatus

func (x *UpdateDocumentResponse) GetStatus() []*DocStatus

func (*UpdateDocumentResponse) ProtoMessage

func (*UpdateDocumentResponse) ProtoMessage()

func (*UpdateDocumentResponse) ProtoReflect

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

func (*UpdateDocumentResponse) Reset

func (x *UpdateDocumentResponse) Reset()

func (*UpdateDocumentResponse) String

func (x *UpdateDocumentResponse) String() string

type UpdateNamespaceMetadataRequest

type UpdateNamespaceMetadataRequest struct {
	MetadataKey string `protobuf:"bytes,1,opt,name=metadataKey,proto3" json:"metadataKey,omitempty"`
	Value       []byte `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Request update of namespace metadata

func (*UpdateNamespaceMetadataRequest) Descriptor deprecated

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

Deprecated: Use UpdateNamespaceMetadataRequest.ProtoReflect.Descriptor instead.

func (*UpdateNamespaceMetadataRequest) GetMetadataKey

func (x *UpdateNamespaceMetadataRequest) GetMetadataKey() string

func (*UpdateNamespaceMetadataRequest) GetValue

func (x *UpdateNamespaceMetadataRequest) GetValue() []byte

func (*UpdateNamespaceMetadataRequest) ProtoMessage

func (*UpdateNamespaceMetadataRequest) ProtoMessage()

func (*UpdateNamespaceMetadataRequest) ProtoReflect

func (*UpdateNamespaceMetadataRequest) Reset

func (x *UpdateNamespaceMetadataRequest) Reset()

func (*UpdateNamespaceMetadataRequest) String

func (*UpdateNamespaceMetadataRequest) UnmarshalJSON

func (x *UpdateNamespaceMetadataRequest) UnmarshalJSON(data []byte) error

type UpdateNamespaceMetadataResponse

type UpdateNamespaceMetadataResponse struct {
	MetadataKey string `protobuf:"bytes,1,opt,name=metadataKey,proto3" json:"metadataKey,omitempty"`
	NamespaceId uint32 `protobuf:"varint,2,opt,name=namespaceId,proto3" json:"namespaceId,omitempty"`
	Value       []byte `protobuf:"bytes,3,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Update of namespace metadata response

func (*UpdateNamespaceMetadataResponse) Descriptor deprecated

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

Deprecated: Use UpdateNamespaceMetadataResponse.ProtoReflect.Descriptor instead.

func (*UpdateNamespaceMetadataResponse) GetMetadataKey

func (x *UpdateNamespaceMetadataResponse) GetMetadataKey() string

func (*UpdateNamespaceMetadataResponse) GetNamespaceId

func (x *UpdateNamespaceMetadataResponse) GetNamespaceId() uint32

func (*UpdateNamespaceMetadataResponse) GetValue

func (x *UpdateNamespaceMetadataResponse) GetValue() []byte

func (*UpdateNamespaceMetadataResponse) MarshalJSON

func (x *UpdateNamespaceMetadataResponse) MarshalJSON() ([]byte, error)

func (*UpdateNamespaceMetadataResponse) ProtoMessage

func (*UpdateNamespaceMetadataResponse) ProtoMessage()

func (*UpdateNamespaceMetadataResponse) ProtoReflect

func (*UpdateNamespaceMetadataResponse) Reset

func (*UpdateNamespaceMetadataResponse) String

type UpdateRequest

type UpdateRequest struct {

	// Project name whose db is under target  to update documents
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// Collection name where to update documents
	Collection string `protobuf:"bytes,2,opt,name=collection,proto3" json:"collection,omitempty"`
	// Fields contains set of fields
	// with the values which need to be updated.
	// Should be proper JSON object.
	Fields []byte `protobuf:"bytes,3,opt,name=fields,proto3" json:"fields,omitempty"`
	// Update documents which matching specified filter.
	// A filter can simply be key, value where key
	// is the field name and value would be the value for this field. Or a filter can be logical where
	// two or more fields can be logically joined using $or and $and. A few examples of filter:
	// <li> To update a user document where the id has a value 1: “`{"id": 1 }“`
	// <li> To update all the user documents where the key "id" has a value 1 or 2 or 3: `{"$or": [{"id": 1}, {"id": 2}, {"id": 3}]}`
	Filter  []byte                `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	Options *UpdateRequestOptions `protobuf:"bytes,5,opt,name=options,proto3" json:"options,omitempty"`
	// Optionally specify a database branch name to perform operation on
	Branch string `protobuf:"bytes,6,opt,name=branch,proto3" json:"branch,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateRequest) Descriptor deprecated

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

Deprecated: Use UpdateRequest.ProtoReflect.Descriptor instead.

func (*UpdateRequest) GetBranch

func (x *UpdateRequest) GetBranch() string

func (*UpdateRequest) GetCollection

func (x *UpdateRequest) GetCollection() string

func (*UpdateRequest) GetFields

func (x *UpdateRequest) GetFields() []byte

func (*UpdateRequest) GetFilter

func (x *UpdateRequest) GetFilter() []byte

func (*UpdateRequest) GetOptions

func (x *UpdateRequest) GetOptions() *UpdateRequestOptions

func (*UpdateRequest) GetProject

func (x *UpdateRequest) GetProject() string

func (*UpdateRequest) ProtoMessage

func (*UpdateRequest) ProtoMessage()

func (*UpdateRequest) ProtoReflect

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

func (*UpdateRequest) Reset

func (x *UpdateRequest) Reset()

func (*UpdateRequest) String

func (x *UpdateRequest) String() string

func (*UpdateRequest) UnmarshalJSON

func (x *UpdateRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON on UpdateRequest avoids unmarshalling filter and instead this way we can write a custom struct to do the unmarshalling and will be avoiding any extra allocation/copying.

type UpdateRequestOptions

type UpdateRequestOptions struct {
	WriteOptions *WriteOptions `protobuf:"bytes,1,opt,name=write_options,json=writeOptions,proto3" json:"write_options,omitempty"`
	// A collation allows you to specify string comparison rules. Default is case-sensitive, to override it you can set
	// this option to 'ci' that will apply to all the text fields in the filters.
	Collation *Collation `protobuf:"bytes,2,opt,name=collation,proto3" json:"collation,omitempty"`
	// Limit the number of documents to be updated
	Limit int64 `protobuf:"varint,3,opt,name=limit,proto3" json:"limit,omitempty"`
	// contains filtered or unexported fields
}

Additional options for update requests.

func (*UpdateRequestOptions) Descriptor deprecated

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

Deprecated: Use UpdateRequestOptions.ProtoReflect.Descriptor instead.

func (*UpdateRequestOptions) GetCollation

func (x *UpdateRequestOptions) GetCollation() *Collation

func (*UpdateRequestOptions) GetLimit

func (x *UpdateRequestOptions) GetLimit() int64

func (*UpdateRequestOptions) GetWriteOptions

func (x *UpdateRequestOptions) GetWriteOptions() *WriteOptions

func (*UpdateRequestOptions) ProtoMessage

func (*UpdateRequestOptions) ProtoMessage()

func (*UpdateRequestOptions) ProtoReflect

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

func (*UpdateRequestOptions) Reset

func (x *UpdateRequestOptions) Reset()

func (*UpdateRequestOptions) String

func (x *UpdateRequestOptions) String() string

type UpdateResponse

type UpdateResponse struct {

	// Has metadata related to the documents stored.
	Metadata *ResponseMetadata `protobuf:"bytes,1,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Returns the number of documents modified.
	ModifiedCount int32 `protobuf:"varint,2,opt,name=modified_count,json=modifiedCount,proto3" json:"modified_count,omitempty"`
	// an enum with value set as "updated".
	Status string `protobuf:"bytes,3,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateResponse) Descriptor deprecated

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

Deprecated: Use UpdateResponse.ProtoReflect.Descriptor instead.

func (*UpdateResponse) GetMetadata

func (x *UpdateResponse) GetMetadata() *ResponseMetadata

func (*UpdateResponse) GetModifiedCount

func (x *UpdateResponse) GetModifiedCount() int32

func (*UpdateResponse) GetStatus

func (x *UpdateResponse) GetStatus() string

func (*UpdateResponse) MarshalJSON

func (x *UpdateResponse) MarshalJSON() ([]byte, error)

func (*UpdateResponse) ProtoMessage

func (*UpdateResponse) ProtoMessage()

func (*UpdateResponse) ProtoReflect

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

func (*UpdateResponse) Reset

func (x *UpdateResponse) Reset()

func (*UpdateResponse) String

func (x *UpdateResponse) String() string

type UpdateUserMetadataRequest

type UpdateUserMetadataRequest struct {
	MetadataKey string `protobuf:"bytes,1,opt,name=metadataKey,proto3" json:"metadataKey,omitempty"`
	Value       []byte `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Request update of user metadata

func (*UpdateUserMetadataRequest) Descriptor deprecated

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

Deprecated: Use UpdateUserMetadataRequest.ProtoReflect.Descriptor instead.

func (*UpdateUserMetadataRequest) GetMetadataKey

func (x *UpdateUserMetadataRequest) GetMetadataKey() string

func (*UpdateUserMetadataRequest) GetValue

func (x *UpdateUserMetadataRequest) GetValue() []byte

func (*UpdateUserMetadataRequest) ProtoMessage

func (*UpdateUserMetadataRequest) ProtoMessage()

func (*UpdateUserMetadataRequest) ProtoReflect

func (*UpdateUserMetadataRequest) Reset

func (x *UpdateUserMetadataRequest) Reset()

func (*UpdateUserMetadataRequest) String

func (x *UpdateUserMetadataRequest) String() string

func (*UpdateUserMetadataRequest) UnmarshalJSON

func (x *UpdateUserMetadataRequest) UnmarshalJSON(data []byte) error

type UpdateUserMetadataResponse

type UpdateUserMetadataResponse struct {
	MetadataKey string `protobuf:"bytes,1,opt,name=metadataKey,proto3" json:"metadataKey,omitempty"`
	UserId      string `protobuf:"bytes,2,opt,name=userId,proto3" json:"userId,omitempty"`
	NamespaceId uint32 `protobuf:"varint,3,opt,name=namespaceId,proto3" json:"namespaceId,omitempty"`
	Value       []byte `protobuf:"bytes,4,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Update of user metadata response

func (*UpdateUserMetadataResponse) Descriptor deprecated

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

Deprecated: Use UpdateUserMetadataResponse.ProtoReflect.Descriptor instead.

func (*UpdateUserMetadataResponse) GetMetadataKey

func (x *UpdateUserMetadataResponse) GetMetadataKey() string

func (*UpdateUserMetadataResponse) GetNamespaceId

func (x *UpdateUserMetadataResponse) GetNamespaceId() uint32

func (*UpdateUserMetadataResponse) GetUserId

func (x *UpdateUserMetadataResponse) GetUserId() string

func (*UpdateUserMetadataResponse) GetValue

func (x *UpdateUserMetadataResponse) GetValue() []byte

func (*UpdateUserMetadataResponse) MarshalJSON

func (x *UpdateUserMetadataResponse) MarshalJSON() ([]byte, error)

func (*UpdateUserMetadataResponse) ProtoMessage

func (*UpdateUserMetadataResponse) ProtoMessage()

func (*UpdateUserMetadataResponse) ProtoReflect

func (*UpdateUserMetadataResponse) Reset

func (x *UpdateUserMetadataResponse) Reset()

func (*UpdateUserMetadataResponse) String

func (x *UpdateUserMetadataResponse) String() string

type WriteOptions

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

Additional options to modify write requests.

func (*WriteOptions) Descriptor deprecated

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

Deprecated: Use WriteOptions.ProtoReflect.Descriptor instead.

func (*WriteOptions) ProtoMessage

func (*WriteOptions) ProtoMessage()

func (*WriteOptions) ProtoReflect

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

func (*WriteOptions) Reset

func (x *WriteOptions) Reset()

func (*WriteOptions) String

func (x *WriteOptions) String() string

Jump to

Keyboard shortcuts

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