ni.measurementlink.discovery.v1.discovery_service_pb2
Attributes
Classes
Description of a registered service. This information can be used to display information to the user |
|
Represents the location of a service. The location generally includes the IP address and port number for the service |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Represents a location capable resolving and running a service. |
|
Message sent to enumerate the active (currently running) service instances. |
|
Combines a service descriptor with its location to describe an active service. |
|
Message returned from the EnumerateActiveServices method. |
|
Message sent to enumerate the compute nodes that have registered themselves in the current session. |
|
Message returned from the EnumerateComputeNodes method. |
Package Contents
- ni.measurementlink.discovery.v1.discovery_service_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
- class ni.measurementlink.discovery.v1.discovery_service_pb2.ServiceDescriptor(*, display_name=..., description_url=..., provided_interfaces=..., service_class=..., annotations=..., versions=...)
Bases:
google.protobuf.message.MessageDescription of a registered service. This information can be used to display information to the user about the service when services are being developed for a plugin architecture
- Parameters:
display_name (str)
description_url (str)
provided_interfaces (collections.abc.Iterable[str] | None)
service_class (str)
annotations (collections.abc.Mapping[str, str] | None)
versions (collections.abc.Iterable[str] | None)
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
- class AnnotationsEntry(*, key=..., value=...)
Bases:
google.protobuf.message.MessageAbstract 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
- ClearField(field_name)
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,
ValueErroris 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
- service_class: str
Required. The “class” of a service. The value of this field should be unique for all services. In effect, the .proto service declaration defines the interface, and this field defines a class or concrete type of the interface.
- property provided_interfaces: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]
Required. The service interfaces provided by the service. This is the gRPC Full Name of the service. Registration can use the gRPC metadata to provide these names.
- property annotations: google.protobuf.internal.containers.ScalarMap[str, str]
Optional. Represents a set of annotations on the service.
Well-known annotations:
Description
Key: “ni/service.description”
Expected format: string
Example: “Measure inrush current with a shorted load and validate results against configured limits.”
Collection
Key: “ni/service.collection”
Expected format: “.” delimited namespace/hierarchy case-insensitive string
Example: “CurrentTests.Inrush”
Tags
Key: “ni/service.tags”
Expected format: serialized JSON string of an array of strings
Example: “["powerup", "current"]”
- Return type:
- property versions: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]
This field is used differently based on the message in which it is used.
When used in a RegisterServiceRequest, this field must contain a single version, and that version must follow the major.minor.patch format. The version 0.0.1 is reserved for internal use, and cannot be specified. If no version is specified, the version 0.0.1 will be used internally for the registered service.
When returned from EnumerateServicesResponse, this field will contain the list of versions that are available for the associated service.
When returned from ResolveServiceWithInformationResponse, this field will contain the version of the resolved service.
- ClearField(field_name)
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,
ValueErroris 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
- ni.measurementlink.discovery.v1.discovery_service_pb2.global___ServiceDescriptor
- class ni.measurementlink.discovery.v1.discovery_service_pb2.ServiceLocation(*, location=..., insecure_port=..., ssl_authenticated_port=...)
Bases:
google.protobuf.message.MessageRepresents the location of a service. The location generally includes the IP address and port number for the service which can be used to establish communication with the service.
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
- location: str
The location of the service. This is typically an IP address or DNS name.
- Type:
Required
- insecure_port: str
The port to use when communicating with the service for insecure HTTP connections. At least one of insecure_port or ssl_authenticated_port is required.
- ssl_authenticated_port: str
The port to use when communicating with the service for secure SSL authenticated connections. At least one of insecure_port or ssl_authenticated_port is required.
- ClearField(field_name)
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,
ValueErroris 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
- ni.measurementlink.discovery.v1.discovery_service_pb2.global___ServiceLocation
- class ni.measurementlink.discovery.v1.discovery_service_pb2.RegisterServiceRequest(*, service_description=..., location=...)
Bases:
google.protobuf.message.MessageAbstract 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:
service_description (global___ServiceDescriptor | None)
location (global___ServiceLocation | None)
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
- property service_description: global___ServiceDescriptor
Required. The description of the service.
- Return type:
- property location: global___ServiceLocation
Required. The canonical location information for the service.
- Return type:
- HasField(field_name)
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,
ValueErrorwill 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:
- Raises:
ValueError – if the field_name is not a member of this message.
- ClearField(field_name)
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,
ValueErroris 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
- ni.measurementlink.discovery.v1.discovery_service_pb2.global___RegisterServiceRequest
- class ni.measurementlink.discovery.v1.discovery_service_pb2.RegisterServiceResponse(*, registration_id=...)
Bases:
google.protobuf.message.MessageAbstract 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:
registration_id (str)
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
- ClearField(field_name)
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,
ValueErroris 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
- ni.measurementlink.discovery.v1.discovery_service_pb2.global___RegisterServiceResponse
- class ni.measurementlink.discovery.v1.discovery_service_pb2.UnregisterServiceRequest(*, registration_id=...)
Bases:
google.protobuf.message.MessageAbstract 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:
registration_id (str)
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
- ClearField(field_name)
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,
ValueErroris 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
- ni.measurementlink.discovery.v1.discovery_service_pb2.global___UnregisterServiceRequest
- class ni.measurementlink.discovery.v1.discovery_service_pb2.UnregisterServiceResponse
Bases:
google.protobuf.message.MessageAbstract 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
- ni.measurementlink.discovery.v1.discovery_service_pb2.global___UnregisterServiceResponse
- class ni.measurementlink.discovery.v1.discovery_service_pb2.EnumerateServicesRequest(*, provided_interface=..., service_class=...)
Bases:
google.protobuf.message.MessageAbstract 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
- provided_interface: str
Optional. The gRPC full name of the service interface that is needed. If empty, information for all services registered with the discovery service will be returned.
- service_class: str
Optional. The “class” of the service that should be matched. Using this field can be a useful way to determine the available versions of a specific service. If used in conjunction with the ‘provided_interface’ field, the ‘service_class’ field will be used to filter the results to only those services that match the provided interface and service class.
- ClearField(field_name)
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,
ValueErroris 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
- ni.measurementlink.discovery.v1.discovery_service_pb2.global___EnumerateServicesRequest
- class ni.measurementlink.discovery.v1.discovery_service_pb2.EnumerateServicesResponse(*, available_services=..., unreachable=...)
Bases:
google.protobuf.message.MessageAbstract 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:
available_services (collections.abc.Iterable[global___ServiceDescriptor] | None)
unreachable (collections.abc.Iterable[str] | None)
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
- property available_services: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___ServiceDescriptor]
The list of available services which implement the specified service interface.
- property unreachable: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]
Information about any unreachable resources. Each string in the list will be a ‘ServiceDescriptor.service_class’ entry for each of the unreachable resources. To get extended information about the unreachable resources, use ResolveService and handle the resulting error.
- ClearField(field_name)
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,
ValueErroris 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
- ni.measurementlink.discovery.v1.discovery_service_pb2.global___EnumerateServicesResponse
- class ni.measurementlink.discovery.v1.discovery_service_pb2.ResolveServiceRequest(*, provided_interface=..., service_class=..., deployment_target=..., version=...)
Bases:
google.protobuf.message.MessageAbstract 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
- provided_interface: str
Required. This corresponds to the gRPC Full Name of the service and should match the information that was supplied in the RegisterServiceRequest message.
- service_class: str
Optional. The service “class” that should be matched. If the value of this field is not specified and there is more than one matching service registered, an error is returned.
- deployment_target: str
Optional. Indicates the deployment target from which the service should be resolved. The value of this field can be obtained from the results of the EnumerateComputeNodes method. If the value of this field is not specified, the service will be resolved from the local deployment target. If the service cannot be resolved from the specified deployment target, an error is returned.
- version: str
Optional. The version of the service to resolve. If not specified, the latest version will be resolved.
- ClearField(field_name)
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,
ValueErroris 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
- ni.measurementlink.discovery.v1.discovery_service_pb2.global___ResolveServiceRequest
- class ni.measurementlink.discovery.v1.discovery_service_pb2.ResolveServiceWithInformationRequest(*, provided_interface=..., service_class=..., deployment_target=..., version=...)
Bases:
google.protobuf.message.MessageAbstract 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
- provided_interface: str
Required. This corresponds to the gRPC Full Name of the service and should match the information that was supplied in the RegisterServiceRequest message.
- service_class: str
Optional. The service “class” that should be matched. If the value of this field is not specified and there is more than one matching service registered, an error is returned.
- deployment_target: str
Optional. Indicates the deployment target from which the service should be resolved. The value of this field can be obtained from the results of the EnumerateComputeNodes method. If the value of this field is not specified, the service will be resolved from the local deployment target. If the service cannot be resolved from the specified deployment target, an error is returned.
- version: str
Optional. The version of the service to resolve. If not specified, the latest version will be resolved.
- ClearField(field_name)
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,
ValueErroris 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
- ni.measurementlink.discovery.v1.discovery_service_pb2.global___ResolveServiceWithInformationRequest
- class ni.measurementlink.discovery.v1.discovery_service_pb2.ResolveServiceWithInformationResponse(*, service_location=..., service_descriptor=...)
Bases:
google.protobuf.message.MessageAbstract 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:
service_location (global___ServiceLocation | None)
service_descriptor (global___ServiceDescriptor | None)
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
- property service_location: global___ServiceLocation
The canonical location information of the service.
- Return type:
- property service_descriptor: global___ServiceDescriptor
The description of the service.
- Return type:
- HasField(field_name)
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,
ValueErrorwill 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:
- Raises:
ValueError – if the field_name is not a member of this message.
- ClearField(field_name)
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,
ValueErroris 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
- ni.measurementlink.discovery.v1.discovery_service_pb2.global___ResolveServiceWithInformationResponse
- class ni.measurementlink.discovery.v1.discovery_service_pb2.ComputeNodeDescriptor(*, url=..., is_local=...)
Bases:
google.protobuf.message.MessageRepresents a location capable resolving and running a service.
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
- ClearField(field_name)
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,
ValueErroris 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
- ni.measurementlink.discovery.v1.discovery_service_pb2.global___ComputeNodeDescriptor
- class ni.measurementlink.discovery.v1.discovery_service_pb2.EnumerateActiveServicesRequest(*, provided_interface=..., service_class=...)
Bases:
google.protobuf.message.MessageMessage sent to enumerate the active (currently running) service instances.
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
- provided_interface: str
Optional. The gRPC full name of the service interface that is needed. If empty, information for all active services registered with the discovery service will be, returned, unless the ‘service_class’ field has been specified.
- service_class: str
Optional. The “class” of the service that should be matched. If used in conjunction with the ‘provided_interface’ field, the ‘service_class’ field will be used to filter the results to only those services that match the provided interface and service class.
- ClearField(field_name)
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,
ValueErroris 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
- ni.measurementlink.discovery.v1.discovery_service_pb2.global___EnumerateActiveServicesRequest
- class ni.measurementlink.discovery.v1.discovery_service_pb2.ActiveServiceInformation(*, service_descriptor=..., service_location=...)
Bases:
google.protobuf.message.MessageCombines a service descriptor with its location to describe an active service. Used in EnumerateActiveServicesResponse to represent a single active service instance.
- Parameters:
service_descriptor (global___ServiceDescriptor | None)
service_location (global___ServiceLocation | None)
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
- property service_descriptor: global___ServiceDescriptor
The description of the service.
- Return type:
- property service_location: global___ServiceLocation
The location of the service.
- Return type:
- HasField(field_name)
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,
ValueErrorwill 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:
- Raises:
ValueError – if the field_name is not a member of this message.
- ClearField(field_name)
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,
ValueErroris 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
- ni.measurementlink.discovery.v1.discovery_service_pb2.global___ActiveServiceInformation
- class ni.measurementlink.discovery.v1.discovery_service_pb2.EnumerateActiveServicesResponse(*, active_services=...)
Bases:
google.protobuf.message.MessageMessage returned from the EnumerateActiveServices method.
- Parameters:
active_services (collections.abc.Iterable[global___ActiveServiceInformation] | None)
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
- property active_services: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___ActiveServiceInformation]
The list of currently active service instances which implement the specified service interface. This information is intended for diagnostic and informational purposes only. To communicate with a service, use ResolveService or ResolveServiceWithInformation instead. Unlike EnumerateServices, multiple entries may share the same service_class when multiple versions of the same service are running side by side.
- ClearField(field_name)
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,
ValueErroris 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
- ni.measurementlink.discovery.v1.discovery_service_pb2.global___EnumerateActiveServicesResponse
- class ni.measurementlink.discovery.v1.discovery_service_pb2.EnumerateComputeNodesRequest
Bases:
google.protobuf.message.MessageMessage sent to enumerate the compute nodes that have registered themselves in the current session.
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
- ni.measurementlink.discovery.v1.discovery_service_pb2.global___EnumerateComputeNodesRequest
- class ni.measurementlink.discovery.v1.discovery_service_pb2.EnumerateComputeNodesResponse(*, compute_nodes=...)
Bases:
google.protobuf.message.MessageMessage returned from the EnumerateComputeNodes method.
- Parameters:
compute_nodes (collections.abc.Iterable[global___ComputeNodeDescriptor] | None)
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
- property compute_nodes: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___ComputeNodeDescriptor]
The list of compute nodes that have registered themselves in the current session.
- ClearField(field_name)
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,
ValueErroris 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
- ni.measurementlink.discovery.v1.discovery_service_pb2.global___EnumerateComputeNodesResponse