deephaven_enterprise.proto.controller_common_pb2

Copyright (c) 2016-2022 Deephaven Data Labs and Patent Pending

Module Contents

class ErrorResponse(*, message=...)[source]

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

message (str)

ClearField(field_name)[source]

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Raises:

ValueError – if the field_name is not a member of this message.

Return type:

None

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]
MESSAGE_FIELD_NUMBER: int[source]
message: str[source]
class NamedStringList(*, name=..., values=...)[source]

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:
ClearField(field_name)[source]

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Raises:

ValueError – if the field_name is not a member of this message.

Return type:

None

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]
NAME_FIELD_NUMBER: int[source]
VALUES_FIELD_NUMBER: int[source]
name: str[source]
property values: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str][source]
Return type:

google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

class PingRequest(*, cookie=...)[source]

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

cookie (bytes | None)

ClearField(field_name)[source]

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Raises:

ValueError – if the field_name is not a member of this message.

Return type:

None

HasField(field_name)[source]

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group)[source]

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

COOKIE_FIELD_NUMBER: int[source]
DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]
cookie: bytes[source]
class PingResponse[source]

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]
DESCRIPTOR: google.protobuf.descriptor.FileDescriptor[source]
type Global___ErrorResponse = ErrorResponse[source]
type Global___NamedStringList = NamedStringList[source]
type Global___PingRequest = PingRequest[source]
type Global___PingResponse = PingResponse[source]