cloudvision.Connector.gen package

Submodules

cloudvision.Connector.gen.ca_pb2 module

Generated protocol buffer code.

cloudvision.Connector.gen.ca_pb2_grpc module

Client and server classes corresponding to protobuf-defined services.

class cloudvision.Connector.gen.ca_pb2_grpc.CertificateAuthority

Bases: object

Missing associated documentation comment in .proto file.

static Enroll(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static Reenroll(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

class cloudvision.Connector.gen.ca_pb2_grpc.CertificateAuthorityServicer

Bases: object

Missing associated documentation comment in .proto file.

Enroll(request, context)

Enroll is called by client passing Certificate Signing Request (CSR) containing its personal certificate to be signed. The server returns back the certificate (CRT) to authenticate into IngestGateway or Router.

Reenroll(request, context)

Reenroll is called by client passing Certificate Signing Request (CSR) when it wants to renew its personal certificate. The server returns a new certificate (CRT).

class cloudvision.Connector.gen.ca_pb2_grpc.CertificateAuthorityStub(channel)

Bases: object

Missing associated documentation comment in .proto file.

cloudvision.Connector.gen.ca_pb2_grpc.add_CertificateAuthorityServicer_to_server(servicer, server)

cloudvision.Connector.gen.notification_pb2 module

Generated protocol buffer code.

cloudvision.Connector.gen.notification_pb2_grpc module

Client and server classes corresponding to protobuf-defined services.

cloudvision.Connector.gen.router_pb2 module

Generated protocol buffer code.

cloudvision.Connector.gen.router_pb2_grpc module

Client and server classes corresponding to protobuf-defined services.

class cloudvision.Connector.gen.router_pb2_grpc.Alpha

Bases: object

Alpha services are deprecated. Please use SearchV1

static DeleteCustomSchema(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static Search(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static SearchSubscribe(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static SearchWithAggregation(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static SearchWithAggregationStream(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static SetCustomSchema(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

class cloudvision.Connector.gen.router_pb2_grpc.AlphaServicer

Bases: object

Alpha services are deprecated. Please use SearchV1

DeleteCustomSchema(request, context)

for custom schema deletion This is alpha version of this api and doesn’t synchronize across apiserver instances. apiserver restart is needed to get updated schema information from hbase.

Search(request, context)

you know, for search…

SearchSubscribe(request, context)

SearchSubscribe allows the client to request a live stream of updates based on client search request

SearchWithAggregation(request, context)

for search with aggregation

SearchWithAggregationStream(request, context)

SearchWithAggregationStream sends the protobuf-serialized form of AggrResponse as in a stream of byteArrays. Receiver needs to append the “bytearrays”, and protobuf-deserialize to obtain the result. Intended for messages exceeding the grpc size limit

SetCustomSchema(request, context)

for custom schema configuration

class cloudvision.Connector.gen.router_pb2_grpc.AlphaStub(channel)

Bases: object

Alpha services are deprecated. Please use SearchV1

class cloudvision.Connector.gen.router_pb2_grpc.Auth

Bases: object

Missing associated documentation comment in .proto file.

static CreateDataset(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static CreateSession(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static GetPermissionSet(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static SetPassword(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static SetPermission(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

class cloudvision.Connector.gen.router_pb2_grpc.AuthServicer

Bases: object

Missing associated documentation comment in .proto file.

CreateDataset(request, context)

CreateDataset from a given Dataset wrapped in a CreateDatasetRequest

CreateSession(request, context)

CreateSession creates session for user

GetPermissionSet(request, context)

GetPermissionSet returns the set of all permissions present for the datasets specified in the ‘query’(s) of the GetRequest.

SetPassword(request, context)

SetPassword sets the password for a user.

SetPermission(request, context)

SetPermission sets a permission for a dataset using a SetPermissionRequest.

class cloudvision.Connector.gen.router_pb2_grpc.AuthStub(channel)

Bases: object

Missing associated documentation comment in .proto file.

class cloudvision.Connector.gen.router_pb2_grpc.Cluster

Bases: object

Cluster service gives some descriptions about the cluster where the service is running.

static ClusterInfo(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

class cloudvision.Connector.gen.router_pb2_grpc.ClusterServicer

Bases: object

Cluster service gives some descriptions about the cluster where the service is running.

ClusterInfo(request, context)

Missing associated documentation comment in .proto file.

class cloudvision.Connector.gen.router_pb2_grpc.ClusterStub(channel)

Bases: object

Cluster service gives some descriptions about the cluster where the service is running.

class cloudvision.Connector.gen.router_pb2_grpc.Querier

Bases: object

Missing associated documentation comment in .proto file.

static SQL(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

class cloudvision.Connector.gen.router_pb2_grpc.QuerierServicer

Bases: object

Missing associated documentation comment in .proto file.

SQL(request, context)

Missing associated documentation comment in .proto file.

class cloudvision.Connector.gen.router_pb2_grpc.QuerierStub(channel)

Bases: object

Missing associated documentation comment in .proto file.

class cloudvision.Connector.gen.router_pb2_grpc.RouterV1

Bases: object

Missing associated documentation comment in .proto file.

static Get(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static GetAndSubscribe(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static GetDatasets(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static Publish(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static Subscribe(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

class cloudvision.Connector.gen.router_pb2_grpc.RouterV1Servicer

Bases: object

Missing associated documentation comment in .proto file.

Get(request, context)

Get is used to request notifications for a given path over a specified time range. Wildcards are supported with Get requests, but when given a range of time the server will resolve all wildcard paths at the starting timestamp of the given range, so any pointers and/or paths that are created after the given start timestamp will not be accounted for during wildcard resolution. The client may receive duplicate notifications.

GetAndSubscribe(request, context)

GetAndSubscribe allows the client to issue one request to do both Get and Subscribe requests. The server will first send a mix of subscribe and get batches, and there’s no distinction between which batches are subscribe or get batches. Then the server will send a sync signal signaling that the Get stream has finished. After that, server will stream out only subscribe batches. There’s no order guarantee for batches received by client. The end of get stream sync signal will be in the Metadata field in the NotificationBatch, as 1 key, value pair: [GetRequest:EOF]. If there are batches returned from Get request, this metadata will be in the last Get batch; if there’s no results from Get, it will be sent in an empty NotificationBatch with only the Metadata field.

GetDatasets(request, context)

Missing associated documentation comment in .proto file.

Publish(request, context)

Publish is used to send notifications to Cloudvision. They will be saved into the storage and sent to all the clients subscribing to the same device/path.

• Publish guarantees atomicity of the data saved per {timestamp+path+key}.

For Notification => For one Notification having multiple keys, each key is ensured to be saved atomically but atomicity is not guaranteed for the entire notification. For NotificationBatch => if Notif[1] and Notif[5] both have updates for a {timestamp+path+key} either the update of Notif[1] will be saved, or the update of Notif[5] will be saved. The value will be one or the other, not a corrupted combination of both requests.

• There is no guarantee for write order within a single publish request.

When sending multiple notifications where multiple notification will have the same timestamp, path and keys, Publish does not guarantee that Notif[1] will be processed before Notif[5] This means that for two notifications in the same Publish call having the same {timestamp+path+key}, the result is undefined and will randomly vary (i.e. the first notif data will be saved, or the second one). The client must send two synchronous Publish requests to guarantee the write order at which the requests are processed.

• Publish is asynchronous by default:

When the call to Publish ends without error, it means the data has been correctly received by Cloudvision but not stored yet. So, if a “get” call is done right after the Publish call, the get might not return the data just published. When the “sync” field is set to true in PublishRequest, the Publish will be synchronous: When the call to Publish ends without error, it means the data has been correctly received AND stored by Cloudvision. So, if a “get” call is done right after the synchronous Publish call, the get will return the data just published (unless someone else stored more recent data of course).

• Client-side and Server-side timestamping:

The notification object has a timestamp that can be populated by the client. In case the Client sends a notification with a “null” timestamp as the Notification.timestamp field, the server will populate the timestamp with the current time of the node with the server process is running. This “current time” will be queried once at the beginning of the Publish request and will be used as the Notification.timestamp for all the notification having this field as null.

Subscribe(request, context)

Subscribe allows the client to request a live stream of updates (V1: either based on regexp or exact match, V2: based on exact match)

There is no order guarantee for batches received by subscribers. It means that two batches A and B published synchronously (B is published after A) the subscribers can receive batch A first or B second, OR batch B first and A second. This is also true for notifications within a batch. The backend can decide to split a batch and reorder notifications so subscribers might receive notifications within a batch in a different order that they were published.

class cloudvision.Connector.gen.router_pb2_grpc.RouterV1Stub(channel)

Bases: object

Missing associated documentation comment in .proto file.

class cloudvision.Connector.gen.router_pb2_grpc.Search

Bases: object

Search provides methods to query CloudVision using the Search service.

static DeleteCustomSchema(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static Search(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static SearchSubscribe(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static SearchWithAggregation(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static SearchWithAggregationStream(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static SetCustomSchema(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

class cloudvision.Connector.gen.router_pb2_grpc.SearchServicer

Bases: object

Search provides methods to query CloudVision using the Search service.

DeleteCustomSchema(request, context)

for custom schema deletion This is alpha version of this api and doesn’t synchronize across apiserver instances. apiserver restart is needed to get updated schema information from hbase.

Search(request, context)

you know, for search…

SearchSubscribe(request, context)

SearchSubscribe allows the client to request a live stream of updates based on client search request

SearchWithAggregation(request, context)

for search with aggregation

SearchWithAggregationStream(request, context)

SearchWithAggregationStream sends the protobuf-serialized form of AggrResponse as in a stream of byteArrays. Receiver needs to append the “bytearrays”, and protobuf-deserialize to obtain the result. Intended for messages exceeding the grpc size limit

SetCustomSchema(request, context)

for custom schema configuration

class cloudvision.Connector.gen.router_pb2_grpc.SearchStub(channel)

Bases: object

Search provides methods to query CloudVision using the Search service.

cloudvision.Connector.gen.router_pb2_grpc.add_AlphaServicer_to_server(servicer, server)

cloudvision.Connector.gen.router_pb2_grpc.add_AuthServicer_to_server(servicer, server)

cloudvision.Connector.gen.router_pb2_grpc.add_ClusterServicer_to_server(servicer, server)

cloudvision.Connector.gen.router_pb2_grpc.add_QuerierServicer_to_server(servicer, server)

cloudvision.Connector.gen.router_pb2_grpc.add_RouterV1Servicer_to_server(servicer, server)

cloudvision.Connector.gen.router_pb2_grpc.add_SearchServicer_to_server(servicer, server)

cloudvision.Connector.gen.sharding_pb2 module

Generated protocol buffer code.

cloudvision.Connector.gen.sharding_pb2_grpc module

Client and server classes corresponding to protobuf-defined services.

Module contents