concrete.annotate.AnnotateCommunicationService module¶
-
class
concrete.annotate.AnnotateCommunicationService.
Client
(iprot, oprot=None)¶ Bases:
concrete.annotate.AnnotateCommunicationService.Iface
Annotator service methods. For concrete analytics thatare to be stood up as independent services, accessiblefrom any programming language.-
annotate
(original)¶ - Main annotation method. Takes a communication as inputand returns a new one as output.It is up to the implementing service to verify thatthe input communication is valid.Can throw a ConcreteThriftException upon error(invalid input, analytic exception, etc.).Parameters:- original
-
getDocumentation
()¶ - Return a detailed description of what the particular tooldoes, what inputs and outputs to expect, etc.Developers whom are not familiar with the particularanalytic should be able to read this string andunderstand the essential functions of the analytic.
-
getMetadata
()¶ - Return the tool’s AnnotationMetadata.
-
recv_annotate
()¶
-
recv_getDocumentation
()¶
-
recv_getMetadata
()¶
-
send_annotate
(original)¶
-
send_getDocumentation
()¶
-
send_getMetadata
()¶
-
send_shutdown
()¶
-
shutdown
()¶ - Indicate to the server it should shut down.
-
-
class
concrete.annotate.AnnotateCommunicationService.
Iface
¶ Bases:
object
Annotator service methods. For concrete analytics thatare to be stood up as independent services, accessiblefrom any programming language.-
annotate
(original)¶ - Main annotation method. Takes a communication as inputand returns a new one as output.It is up to the implementing service to verify thatthe input communication is valid.Can throw a ConcreteThriftException upon error(invalid input, analytic exception, etc.).Parameters:- original
-
getDocumentation
()¶ - Return a detailed description of what the particular tooldoes, what inputs and outputs to expect, etc.Developers whom are not familiar with the particularanalytic should be able to read this string andunderstand the essential functions of the analytic.
-
getMetadata
()¶ - Return the tool’s AnnotationMetadata.
-
shutdown
()¶ - Indicate to the server it should shut down.
-
-
class
concrete.annotate.AnnotateCommunicationService.
Processor
(handler)¶ Bases:
concrete.annotate.AnnotateCommunicationService.Iface
,thrift.Thrift.TProcessor
-
process
(iprot, oprot)¶
-
process_annotate
(seqid, iprot, oprot)¶
-
process_getDocumentation
(seqid, iprot, oprot)¶
-
process_getMetadata
(seqid, iprot, oprot)¶
-
process_shutdown
(seqid, iprot, oprot)¶
-
-
class
concrete.annotate.AnnotateCommunicationService.
annotate_args
(original=None)¶ Bases:
object
Attributes:- original-
read
(iprot)¶
-
validate
()¶
-
write
(oprot)¶
-
-
class
concrete.annotate.AnnotateCommunicationService.
annotate_result
(success=None, ex=None)¶ Bases:
object
Attributes:- success- ex-
read
(iprot)¶
-
validate
()¶
-
write
(oprot)¶
-
-
class
concrete.annotate.AnnotateCommunicationService.
getDocumentation_args
¶ Bases:
object
-
read
(iprot)¶
-
validate
()¶
-
write
(oprot)¶
-
-
class
concrete.annotate.AnnotateCommunicationService.
getDocumentation_result
(success=None)¶ Bases:
object
Attributes:- success-
read
(iprot)¶
-
validate
()¶
-
write
(oprot)¶
-
-
class
concrete.annotate.AnnotateCommunicationService.
getMetadata_args
¶ Bases:
object
-
read
(iprot)¶
-
validate
()¶
-
write
(oprot)¶
-