google.protobuf.type_pb2¶
Generated protocol buffer code.
-
class
google.protobuf.type_pb2.
Enum
(**kwargs)¶ -
ByteSize
()¶
-
Clear
()¶
-
ClearExtension
(extension_handle)¶ Clears the contents of a given extension.
- Parameters:
extension_handle – The handle for the extension to clear.
-
ClearField
(field_name)¶
-
CopyFrom
(other_msg)¶ Copies the content of the specified message into the current message.
The method clears the current message and then merges the specified message using MergeFrom.
- Parameters:
other_msg (Message) – A message to copy into the current one.
-
DESCRIPTOR
= <google.protobuf.descriptor.Descriptor object>¶
-
DiscardUnknownFields
()¶
-
ENUMVALUE_FIELD_NUMBER
= 2¶
-
FindInitializationErrors
()¶ Finds required fields which are not initialized.
- Returns:
A list of strings. Each string is a path to an uninitialized field from the top-level message, e.g. “foo.bar[5].baz”.
-
static
FromString
(s)¶
-
HasExtension
(extension_handle)¶ Checks if a certain extension is present for this message.
Extensions are retrieved using the
Extensions
mapping (if present).- Parameters:
extension_handle – The handle for the extension to check.
- Returns:
Whether the extension is present for this message.
- Return type:
- Raises:
KeyError – if the extension is repeated. Similar to repeated fields, there is no separate notion of presence: a “not present” repeated extension is an empty list.
-
HasField
(field_name)¶
-
IsInitialized
(errors=None)¶ Checks if all required fields of a message are set.
- Parameters:
errors – A list which, if provided, will be populated with the field paths of all missing required fields.
- Returns:
True iff the specified message has all required fields set.
-
ListFields
()¶
-
MergeFrom
(msg)¶
-
MergeFromString
(serialized)¶
-
NAME_FIELD_NUMBER
= 1¶
-
OPTIONS_FIELD_NUMBER
= 3¶
-
ParseFromString
(serialized)¶ Parse serialized protocol buffer data into this message.
Like
MergeFromString()
, except we clear the object first.- Raises:
message.DecodeError if the input cannot be parsed. –
-
static
RegisterExtension
(extension_handle)¶
-
SOURCE_CONTEXT_FIELD_NUMBER
= 4¶
-
SYNTAX_FIELD_NUMBER
= 5¶
-
SerializePartialToString
(**kwargs)¶
-
SerializeToString
(**kwargs)¶
-
SetInParent
()¶ Sets the _cached_byte_size_dirty bit to true, and propagates this to our listener iff this was a state change.
-
UnknownFields
()¶
-
WhichOneof
(oneof_name)¶ Returns the name of the currently set field inside a oneof, or None.
-
property
enumvalue
¶
-
property
name
¶
-
property
options
¶
-
property
source_context
¶
-
property
syntax
¶
-
-
class
google.protobuf.type_pb2.
EnumValue
(**kwargs)¶ -
ByteSize
()¶
-
Clear
()¶
-
ClearExtension
(extension_handle)¶ Clears the contents of a given extension.
- Parameters:
extension_handle – The handle for the extension to clear.
-
ClearField
(field_name)¶
-
CopyFrom
(other_msg)¶ Copies the content of the specified message into the current message.
The method clears the current message and then merges the specified message using MergeFrom.
- Parameters:
other_msg (Message) – A message to copy into the current one.
-
DESCRIPTOR
= <google.protobuf.descriptor.Descriptor object>¶
-
DiscardUnknownFields
()¶
-
FindInitializationErrors
()¶ Finds required fields which are not initialized.
- Returns:
A list of strings. Each string is a path to an uninitialized field from the top-level message, e.g. “foo.bar[5].baz”.
-
static
FromString
(s)¶
-
HasExtension
(extension_handle)¶ Checks if a certain extension is present for this message.
Extensions are retrieved using the
Extensions
mapping (if present).- Parameters:
extension_handle – The handle for the extension to check.
- Returns:
Whether the extension is present for this message.
- Return type:
- Raises:
KeyError – if the extension is repeated. Similar to repeated fields, there is no separate notion of presence: a “not present” repeated extension is an empty list.
-
HasField
(field_name)¶
-
IsInitialized
(errors=None)¶ Checks if all required fields of a message are set.
- Parameters:
errors – A list which, if provided, will be populated with the field paths of all missing required fields.
- Returns:
True iff the specified message has all required fields set.
-
ListFields
()¶
-
MergeFrom
(msg)¶
-
MergeFromString
(serialized)¶
-
NAME_FIELD_NUMBER
= 1¶
-
NUMBER_FIELD_NUMBER
= 2¶
-
OPTIONS_FIELD_NUMBER
= 3¶
-
ParseFromString
(serialized)¶ Parse serialized protocol buffer data into this message.
Like
MergeFromString()
, except we clear the object first.- Raises:
message.DecodeError if the input cannot be parsed. –
-
static
RegisterExtension
(extension_handle)¶
-
SerializePartialToString
(**kwargs)¶
-
SerializeToString
(**kwargs)¶
-
SetInParent
()¶ Sets the _cached_byte_size_dirty bit to true, and propagates this to our listener iff this was a state change.
-
UnknownFields
()¶
-
WhichOneof
(oneof_name)¶ Returns the name of the currently set field inside a oneof, or None.
-
property
name
¶
-
property
number
¶
-
property
options
¶
-
-
class
google.protobuf.type_pb2.
Field
(**kwargs)¶ -
ByteSize
()¶
-
CARDINALITY_FIELD_NUMBER
= 2¶
-
CARDINALITY_OPTIONAL
= 1¶
-
CARDINALITY_REPEATED
= 3¶
-
CARDINALITY_REQUIRED
= 2¶
-
CARDINALITY_UNKNOWN
= 0¶
-
Cardinality
= <google.protobuf.internal.enum_type_wrapper.EnumTypeWrapper object>¶
-
Clear
()¶
-
ClearExtension
(extension_handle)¶ Clears the contents of a given extension.
- Parameters:
extension_handle – The handle for the extension to clear.
-
ClearField
(field_name)¶
-
CopyFrom
(other_msg)¶ Copies the content of the specified message into the current message.
The method clears the current message and then merges the specified message using MergeFrom.
- Parameters:
other_msg (Message) – A message to copy into the current one.
-
DEFAULT_VALUE_FIELD_NUMBER
= 11¶
-
DESCRIPTOR
= <google.protobuf.descriptor.Descriptor object>¶
-
DiscardUnknownFields
()¶
-
FindInitializationErrors
()¶ Finds required fields which are not initialized.
- Returns:
A list of strings. Each string is a path to an uninitialized field from the top-level message, e.g. “foo.bar[5].baz”.
-
static
FromString
(s)¶
-
HasExtension
(extension_handle)¶ Checks if a certain extension is present for this message.
Extensions are retrieved using the
Extensions
mapping (if present).- Parameters:
extension_handle – The handle for the extension to check.
- Returns:
Whether the extension is present for this message.
- Return type:
- Raises:
KeyError – if the extension is repeated. Similar to repeated fields, there is no separate notion of presence: a “not present” repeated extension is an empty list.
-
HasField
(field_name)¶
-
IsInitialized
(errors=None)¶ Checks if all required fields of a message are set.
- Parameters:
errors – A list which, if provided, will be populated with the field paths of all missing required fields.
- Returns:
True iff the specified message has all required fields set.
-
JSON_NAME_FIELD_NUMBER
= 10¶
-
KIND_FIELD_NUMBER
= 1¶
-
Kind
= <google.protobuf.internal.enum_type_wrapper.EnumTypeWrapper object>¶
-
ListFields
()¶
-
MergeFrom
(msg)¶
-
MergeFromString
(serialized)¶
-
NAME_FIELD_NUMBER
= 4¶
-
NUMBER_FIELD_NUMBER
= 3¶
-
ONEOF_INDEX_FIELD_NUMBER
= 7¶
-
OPTIONS_FIELD_NUMBER
= 9¶
-
PACKED_FIELD_NUMBER
= 8¶
-
ParseFromString
(serialized)¶ Parse serialized protocol buffer data into this message.
Like
MergeFromString()
, except we clear the object first.- Raises:
message.DecodeError if the input cannot be parsed. –
-
static
RegisterExtension
(extension_handle)¶
-
SerializePartialToString
(**kwargs)¶
-
SerializeToString
(**kwargs)¶
-
SetInParent
()¶ Sets the _cached_byte_size_dirty bit to true, and propagates this to our listener iff this was a state change.
-
TYPE_BOOL
= 8¶
-
TYPE_BYTES
= 12¶
-
TYPE_DOUBLE
= 1¶
-
TYPE_ENUM
= 14¶
-
TYPE_FIXED32
= 7¶
-
TYPE_FIXED64
= 6¶
-
TYPE_FLOAT
= 2¶
-
TYPE_GROUP
= 10¶
-
TYPE_INT32
= 5¶
-
TYPE_INT64
= 3¶
-
TYPE_MESSAGE
= 11¶
-
TYPE_SFIXED32
= 15¶
-
TYPE_SFIXED64
= 16¶
-
TYPE_SINT32
= 17¶
-
TYPE_SINT64
= 18¶
-
TYPE_STRING
= 9¶
-
TYPE_UINT32
= 13¶
-
TYPE_UINT64
= 4¶
-
TYPE_UNKNOWN
= 0¶
-
TYPE_URL_FIELD_NUMBER
= 6¶
-
UnknownFields
()¶
-
WhichOneof
(oneof_name)¶ Returns the name of the currently set field inside a oneof, or None.
-
property
cardinality
¶
-
property
default_value
¶
-
property
json_name
¶
-
property
kind
¶
-
property
name
¶
-
property
number
¶
-
property
oneof_index
¶
-
property
options
¶
-
property
packed
¶
-
property
type_url
¶
-
-
class
google.protobuf.type_pb2.
Option
(**kwargs)¶ -
ByteSize
()¶
-
Clear
()¶
-
ClearExtension
(extension_handle)¶ Clears the contents of a given extension.
- Parameters:
extension_handle – The handle for the extension to clear.
-
ClearField
(field_name)¶
-
CopyFrom
(other_msg)¶ Copies the content of the specified message into the current message.
The method clears the current message and then merges the specified message using MergeFrom.
- Parameters:
other_msg (Message) – A message to copy into the current one.
-
DESCRIPTOR
= <google.protobuf.descriptor.Descriptor object>¶
-
DiscardUnknownFields
()¶
-
FindInitializationErrors
()¶ Finds required fields which are not initialized.
- Returns:
A list of strings. Each string is a path to an uninitialized field from the top-level message, e.g. “foo.bar[5].baz”.
-
static
FromString
(s)¶
-
HasExtension
(extension_handle)¶ Checks if a certain extension is present for this message.
Extensions are retrieved using the
Extensions
mapping (if present).- Parameters:
extension_handle – The handle for the extension to check.
- Returns:
Whether the extension is present for this message.
- Return type:
- Raises:
KeyError – if the extension is repeated. Similar to repeated fields, there is no separate notion of presence: a “not present” repeated extension is an empty list.
-
HasField
(field_name)¶
-
IsInitialized
(errors=None)¶ Checks if all required fields of a message are set.
- Parameters:
errors – A list which, if provided, will be populated with the field paths of all missing required fields.
- Returns:
True iff the specified message has all required fields set.
-
ListFields
()¶
-
MergeFrom
(msg)¶
-
MergeFromString
(serialized)¶
-
NAME_FIELD_NUMBER
= 1¶
-
ParseFromString
(serialized)¶ Parse serialized protocol buffer data into this message.
Like
MergeFromString()
, except we clear the object first.- Raises:
message.DecodeError if the input cannot be parsed. –
-
static
RegisterExtension
(extension_handle)¶
-
SerializePartialToString
(**kwargs)¶
-
SerializeToString
(**kwargs)¶
-
SetInParent
()¶ Sets the _cached_byte_size_dirty bit to true, and propagates this to our listener iff this was a state change.
-
UnknownFields
()¶
-
VALUE_FIELD_NUMBER
= 2¶
-
WhichOneof
(oneof_name)¶ Returns the name of the currently set field inside a oneof, or None.
-
property
name
¶
-
property
value
¶
-
-
class
google.protobuf.type_pb2.
Type
(**kwargs)¶ -
ByteSize
()¶
-
Clear
()¶
-
ClearExtension
(extension_handle)¶ Clears the contents of a given extension.
- Parameters:
extension_handle – The handle for the extension to clear.
-
ClearField
(field_name)¶
-
CopyFrom
(other_msg)¶ Copies the content of the specified message into the current message.
The method clears the current message and then merges the specified message using MergeFrom.
- Parameters:
other_msg (Message) – A message to copy into the current one.
-
DESCRIPTOR
= <google.protobuf.descriptor.Descriptor object>¶
-
DiscardUnknownFields
()¶
-
FIELDS_FIELD_NUMBER
= 2¶
-
FindInitializationErrors
()¶ Finds required fields which are not initialized.
- Returns:
A list of strings. Each string is a path to an uninitialized field from the top-level message, e.g. “foo.bar[5].baz”.
-
static
FromString
(s)¶
-
HasExtension
(extension_handle)¶ Checks if a certain extension is present for this message.
Extensions are retrieved using the
Extensions
mapping (if present).- Parameters:
extension_handle – The handle for the extension to check.
- Returns:
Whether the extension is present for this message.
- Return type:
- Raises:
KeyError – if the extension is repeated. Similar to repeated fields, there is no separate notion of presence: a “not present” repeated extension is an empty list.
-
HasField
(field_name)¶
-
IsInitialized
(errors=None)¶ Checks if all required fields of a message are set.
- Parameters:
errors – A list which, if provided, will be populated with the field paths of all missing required fields.
- Returns:
True iff the specified message has all required fields set.
-
ListFields
()¶
-
MergeFrom
(msg)¶
-
MergeFromString
(serialized)¶
-
NAME_FIELD_NUMBER
= 1¶
-
ONEOFS_FIELD_NUMBER
= 3¶
-
OPTIONS_FIELD_NUMBER
= 4¶
-
ParseFromString
(serialized)¶ Parse serialized protocol buffer data into this message.
Like
MergeFromString()
, except we clear the object first.- Raises:
message.DecodeError if the input cannot be parsed. –
-
static
RegisterExtension
(extension_handle)¶
-
SOURCE_CONTEXT_FIELD_NUMBER
= 5¶
-
SYNTAX_FIELD_NUMBER
= 6¶
-
SerializePartialToString
(**kwargs)¶
-
SerializeToString
(**kwargs)¶
-
SetInParent
()¶ Sets the _cached_byte_size_dirty bit to true, and propagates this to our listener iff this was a state change.
-
UnknownFields
()¶
-
WhichOneof
(oneof_name)¶ Returns the name of the currently set field inside a oneof, or None.
-
property
fields
¶
-
property
name
¶
-
property
oneofs
¶
-
property
options
¶
-
property
source_context
¶
-
property
syntax
¶
-