deephaven_enterprise.proto.config_pb2

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

Module Contents

class AuthenticationPropertiesRequest[source]

Bases: google.protobuf.message.Message

Returns a GetPropertiesResponse with the set of properties required to authenticate to Deephaven. You do not need to be authenticated to make this request.

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]
class DeleteFilesRequest(*, name=...)[source]

Bases: google.protobuf.message.Message

Delete one or more properties files

Parameters:

name (collections.abc.Iterable[str] | 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

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

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

class DeleteFilesResponse[source]

Bases: google.protobuf.message.Message

response to DeleteFilesRequest just success or an exception

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]
class GetAllFilesRequest[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]
class GetFileRequest(*, name=...)[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:

name (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]
NAME_FIELD_NUMBER: int[source]
name: str[source]
class GetFileResponse(*, name=..., contentBytes=...)[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

CONTENTBYTES_FIELD_NUMBER: int[source]
DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]
NAME_FIELD_NUMBER: int[source]
contentBytes: bytes[source]
name: str[source]
class GetPropertiesRequest(*, root_file=..., context=..., property_names=...)[source]

Bases: google.protobuf.message.Message

Returns a GetPropertiesResponse with the requested set of properties. You must be authenticated to make this request.

Parameters:
class ContextEntry(*, key=..., value=...)[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]
KEY_FIELD_NUMBER: int[source]
VALUE_FIELD_NUMBER: int[source]
key: str[source]
value: str[source]
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

CONTEXT_FIELD_NUMBER: int[source]
DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]
PROPERTY_NAMES_FIELD_NUMBER: int[source]
ROOT_FILE_FIELD_NUMBER: int[source]
property context: google.protobuf.internal.containers.ScalarMap[str, str][source]

the context keys and values for processing the property files

Return type:

google.protobuf.internal.containers.ScalarMap[str, str]

property property_names: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str][source]

the names of the properties to retrieve, leave empty to retrieve all properties

Return type:

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

root_file: str[source]

the name of the property file to parse at the root, leave unset to use the default property file

class GetPropertiesResponse(*, properties=...)[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:

properties (collections.abc.Mapping[str, str] | None)

class PropertiesEntry(*, key=..., value=...)[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]
KEY_FIELD_NUMBER: int[source]
VALUE_FIELD_NUMBER: int[source]
key: str[source]
value: str[source]
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]
PROPERTIES_FIELD_NUMBER: int[source]
property properties: google.protobuf.internal.containers.ScalarMap[str, str][source]

The responsive properties to the request

Return type:

google.protobuf.internal.containers.ScalarMap[str, str]

class UpdateFileRequest(*, name=..., contentBytes=..., updateOnSameContents=...)[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:

  • name (str)

  • contentBytes (bytes)

  • updateOnSameContents (bool)

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

CONTENTBYTES_FIELD_NUMBER: int[source]
DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]
NAME_FIELD_NUMBER: int[source]
UPDATEONSAMECONTENTS_FIELD_NUMBER: int[source]
contentBytes: bytes[source]
name: str[source]
updateOnSameContents: bool[source]
class UpdateFileResponse[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]
class UpdateFilesRequest(*, updateFileRequest=...)[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:

updateFileRequest (collections.abc.Iterable[Global___UpdateFileRequest] | 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

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]
UPDATEFILEREQUEST_FIELD_NUMBER: int[source]
property updateFileRequest: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___UpdateFileRequest][source]
Return type:

google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___UpdateFileRequest]

DESCRIPTOR: google.protobuf.descriptor.FileDescriptor[source]
type Global___AuthenticationPropertiesRequest = AuthenticationPropertiesRequest[source]
type Global___DeleteFilesRequest = DeleteFilesRequest[source]
type Global___DeleteFilesResponse = DeleteFilesResponse[source]
type Global___GetAllFilesRequest = GetAllFilesRequest[source]
type Global___GetFileRequest = GetFileRequest[source]
type Global___GetFileResponse = GetFileResponse[source]
type Global___GetPropertiesRequest = GetPropertiesRequest[source]
type Global___GetPropertiesResponse = GetPropertiesResponse[source]
type Global___UpdateFileRequest = UpdateFileRequest[source]
type Global___UpdateFileResponse = UpdateFileResponse[source]
type Global___UpdateFilesRequest = UpdateFilesRequest[source]