google.protobuf.descriptor.ServiceDescriptor Class Reference

Inheritance diagram for google.protobuf.descriptor.ServiceDescriptor:

Public Member Functions
def	__init__ (self, name, full_name, index, methods, options=None, serialized_options=None, file=None, serialized_start=None, serialized_end=None)
def	__new__ (cls, name, full_name, index, methods, options=None, serialized_options=None, file=None, serialized_start=None, serialized_end=None)
def	CopyToProto (self, proto)
def	FindMethodByName (self, name)
Public Member Functions inherited from google.protobuf.descriptor.DescriptorBase
def	__init__ (self, options, serialized_options, options_class_name)
def	GetOptions (self)
Public Member Functions inherited from google.protobuf.descriptor.DescriptorMetaclass
def	__instancecheck__ (cls, obj)

Public Attributes
	index
	methods
	methods_by_name
Public Attributes inherited from google.protobuf.descriptor._NestedDescriptorBase
	containing_type
	file
	full_name
	name
Public Attributes inherited from google.protobuf.descriptor.DescriptorBase
	has_options

Static Private Attributes
	_C_DESCRIPTOR_CLASS = _message.ServiceDescriptor

Detailed Description

Descriptor for a service.

  name: (str) Name of the service.
  full_name: (str) Full name of the service, including package name.
  index: (int) 0-indexed index giving the order that this services
    definition appears withing the .proto file.
  methods: (list of MethodDescriptor) List of methods provided by this
    service.
  methods_by_name: (dict str -> MethodDescriptor) Same MethodDescriptor
    objects as in |methods_by_name|, but indexed by "name" attribute in each
    MethodDescriptor.
  options: (descriptor_pb2.ServiceOptions) Service options message or
    None to use default service options.
  file: (FileDescriptor) Reference to file info.

Definition at line 749 of file descriptor.py.

Constructor & Destructor Documentation

__init__()

def google.protobuf.descriptor.ServiceDescriptor.__init__	(		self,
			options,
			options_class_name,
			name,
			full_name,
			file = None,
			containing_type = None,
			serialized_start = None,
			serialized_end = None,
			serialized_options = None
	)

Constructor.

Args:
  options: Protocol message options or None
to use default message options.
  options_class_name: (str) The class name of the above options.

  name: (str) Name of this protocol message type.
  full_name: (str) Fully-qualified name of this protocol message type,
which will include protocol "package" name and the name of any
enclosing types.
  file: (FileDescriptor) Reference to file info.
  containing_type: if provided, this is a nested descriptor, with this
descriptor as parent, otherwise None.
  serialized_start: The start index (inclusive) in block in the
file.serialized_pb that describes this descriptor.
  serialized_end: The end index (exclusive) in block in the
file.serialized_pb that describes this descriptor.
  serialized_options: Protocol message serilized options or None.

Reimplemented from google.protobuf.descriptor._NestedDescriptorBase.

Definition at line 776 of file descriptor.py.

Member Function Documentation

__new__()

def google.protobuf.descriptor.ServiceDescriptor.__new__	(		cls,
			name,
			full_name,
			index,
			methods,
			options = None,
			serialized_options = None,
			file = None,
			serialized_start = None,
			serialized_end = None
	)

Definition at line 770 of file descriptor.py.

CopyToProto()

def google.protobuf.descriptor.ServiceDescriptor.CopyToProto	(		self,
			proto
	)

Copies this to a descriptor_pb2.ServiceDescriptorProto.

Args:
  proto: An empty descriptor_pb2.ServiceDescriptorProto.

Reimplemented from google.protobuf.descriptor._NestedDescriptorBase.

Definition at line 794 of file descriptor.py.

FindMethodByName()

def google.protobuf.descriptor.ServiceDescriptor.FindMethodByName	(		self,
			name
	)

Searches for the specified method, and returns its descriptor.

Definition at line 790 of file descriptor.py.

Member Data Documentation

_C_DESCRIPTOR_CLASS

google.protobuf.descriptor.ServiceDescriptor._C_DESCRIPTOR_CLASS = _message.ServiceDescriptor

staticprivate

Definition at line 768 of file descriptor.py.

index

google.protobuf.descriptor.ServiceDescriptor.index

Definition at line 781 of file descriptor.py.

methods

google.protobuf.descriptor.ServiceDescriptor.methods

Definition at line 782 of file descriptor.py.

methods_by_name

google.protobuf.descriptor.ServiceDescriptor.methods_by_name

Definition at line 783 of file descriptor.py.

---

The documentation for this class was generated from the following file:

• descriptor.py