Package ai.pipestream.data.module.v1
Interface GetServiceRegistrationResponseOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
GetServiceRegistrationResponse,GetServiceRegistrationResponse.Builder
@Generated
public interface GetServiceRegistrationResponseOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionbooleancontainsMetadata(String key) Flexible key-value pairs for any other developer-defined metadata.Module capabilities for UI adaptationModule capabilities for UI adaptationgetDependencies(int index) List of critical external dependencies (e.g., "chunker module", "database.prod.acme.com", "OpenAI API").com.google.protobuf.ByteStringgetDependenciesBytes(int index) List of critical external dependencies (e.g., "chunker module", "database.prod.acme.com", "OpenAI API").intList of critical external dependencies (e.g., "chunker module", "database.prod.acme.com", "OpenAI API").List of critical external dependencies (e.g., "chunker module", "database.prod.acme.com", "OpenAI API").A brief summary of the module's purpose.com.google.protobuf.ByteStringA brief summary of the module's purpose.--- UI & Developer Experience (Human-Readable) --- A clean, human-friendly name for display in UIs (e.g., "Acme Text Chunker").com.google.protobuf.ByteString--- UI & Developer Experience (Human-Readable) --- A clean, human-friendly name for display in UIs (e.g., "Acme Text Chunker").A URL to more detailed documentation.com.google.protobuf.ByteStringA URL to more detailed documentation.Health check message - error details if failed, success message if passed.com.google.protobuf.ByteStringHealth check message - error details if failed, success message if passed.boolean--- Health & Operational Status --- Whether the health check passed (true if no test_request provided).JSON schema for validating the 'custom_json_config' in a pipeline step.com.google.protobuf.ByteStringJSON schema for validating the 'custom_json_config' in a pipeline step.Deprecated.intFlexible key-value pairs for any other developer-defined metadata.Flexible key-value pairs for any other developer-defined metadata.getMetadataOrDefault(String key, String defaultValue) Flexible key-value pairs for any other developer-defined metadata.getMetadataOrThrow(String key) Flexible key-value pairs for any other developer-defined metadata.--- Core Identity & Validation (Machine-Readable) --- Unique, machine-readable identifier for the module (e.g., "acme-text-chunker-v2").com.google.protobuf.ByteString--- Core Identity & Validation (Machine-Readable) --- Unique, machine-readable identifier for the module (e.g., "acme-text-chunker-v2").getOwner()The team or individual responsible for maintaining this module.com.google.protobuf.ByteStringThe team or individual responsible for maintaining this module.com.google.protobuf.TimestampTimestamp of when this registration data was generated.com.google.protobuf.TimestampOrBuilderTimestamp of when this registration data was generated.The version of the pipeline SDK the module was compiled against (e.g., "0.5.0").com.google.protobuf.ByteStringThe version of the pipeline SDK the module was compiled against (e.g., "0.5.0").--- Engine & Runtime Intelligence --- Information about the server process hosting the module (e.g., hostname, IP).com.google.protobuf.ByteString--- Engine & Runtime Intelligence --- Information about the server process hosting the module (e.g., hostname, IP).getTags(int index) Tags for filtering and categorization in UIs (e.g., "nlp", "enrichment").com.google.protobuf.ByteStringgetTagsBytes(int index) Tags for filtering and categorization in UIs (e.g., "nlp", "enrichment").intTags for filtering and categorization in UIs (e.g., "nlp", "enrichment").Tags for filtering and categorization in UIs (e.g., "nlp", "enrichment").Semantic version of the module itself (e.g., "1.2.1").com.google.protobuf.ByteStringSemantic version of the module itself (e.g., "1.2.1").booleanModule capabilities for UI adaptationbooleanA brief summary of the module's purpose.boolean--- UI & Developer Experience (Human-Readable) --- A clean, human-friendly name for display in UIs (e.g., "Acme Text Chunker").booleanA URL to more detailed documentation.booleanJSON schema for validating the 'custom_json_config' in a pipeline step.booleanhasOwner()The team or individual responsible for maintaining this module.booleanTimestamp of when this registration data was generated.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getModuleName
String getModuleName()--- Core Identity & Validation (Machine-Readable) --- Unique, machine-readable identifier for the module (e.g., "acme-text-chunker-v2").
string module_name = 1 [json_name = "moduleName"];- Returns:
- The moduleName.
-
getModuleNameBytes
com.google.protobuf.ByteString getModuleNameBytes()--- Core Identity & Validation (Machine-Readable) --- Unique, machine-readable identifier for the module (e.g., "acme-text-chunker-v2").
string module_name = 1 [json_name = "moduleName"];- Returns:
- The bytes for moduleName.
-
getVersion
String getVersion()Semantic version of the module itself (e.g., "1.2.1").
string version = 2 [json_name = "version"];- Returns:
- The version.
-
getVersionBytes
com.google.protobuf.ByteString getVersionBytes()Semantic version of the module itself (e.g., "1.2.1").
string version = 2 [json_name = "version"];- Returns:
- The bytes for version.
-
hasJsonConfigSchema
boolean hasJsonConfigSchema()JSON schema for validating the 'custom_json_config' in a pipeline step.
optional string json_config_schema = 3 [json_name = "jsonConfigSchema"];- Returns:
- Whether the jsonConfigSchema field is set.
-
getJsonConfigSchema
String getJsonConfigSchema()JSON schema for validating the 'custom_json_config' in a pipeline step.
optional string json_config_schema = 3 [json_name = "jsonConfigSchema"];- Returns:
- The jsonConfigSchema.
-
getJsonConfigSchemaBytes
com.google.protobuf.ByteString getJsonConfigSchemaBytes()JSON schema for validating the 'custom_json_config' in a pipeline step.
optional string json_config_schema = 3 [json_name = "jsonConfigSchema"];- Returns:
- The bytes for jsonConfigSchema.
-
hasDisplayName
boolean hasDisplayName()--- UI & Developer Experience (Human-Readable) --- A clean, human-friendly name for display in UIs (e.g., "Acme Text Chunker").
optional string display_name = 4 [json_name = "displayName"];- Returns:
- Whether the displayName field is set.
-
getDisplayName
String getDisplayName()--- UI & Developer Experience (Human-Readable) --- A clean, human-friendly name for display in UIs (e.g., "Acme Text Chunker").
optional string display_name = 4 [json_name = "displayName"];- Returns:
- The displayName.
-
getDisplayNameBytes
com.google.protobuf.ByteString getDisplayNameBytes()--- UI & Developer Experience (Human-Readable) --- A clean, human-friendly name for display in UIs (e.g., "Acme Text Chunker").
optional string display_name = 4 [json_name = "displayName"];- Returns:
- The bytes for displayName.
-
hasDescription
boolean hasDescription()A brief summary of the module's purpose.
optional string description = 5 [json_name = "description"];- Returns:
- Whether the description field is set.
-
getDescription
String getDescription()A brief summary of the module's purpose.
optional string description = 5 [json_name = "description"];- Returns:
- The description.
-
getDescriptionBytes
com.google.protobuf.ByteString getDescriptionBytes()A brief summary of the module's purpose.
optional string description = 5 [json_name = "description"];- Returns:
- The bytes for description.
-
hasOwner
boolean hasOwner()The team or individual responsible for maintaining this module.
optional string owner = 6 [json_name = "owner"];- Returns:
- Whether the owner field is set.
-
getOwner
String getOwner()The team or individual responsible for maintaining this module.
optional string owner = 6 [json_name = "owner"];- Returns:
- The owner.
-
getOwnerBytes
com.google.protobuf.ByteString getOwnerBytes()The team or individual responsible for maintaining this module.
optional string owner = 6 [json_name = "owner"];- Returns:
- The bytes for owner.
-
hasDocumentationUrl
boolean hasDocumentationUrl()A URL to more detailed documentation.
optional string documentation_url = 7 [json_name = "documentationUrl"];- Returns:
- Whether the documentationUrl field is set.
-
getDocumentationUrl
String getDocumentationUrl()A URL to more detailed documentation.
optional string documentation_url = 7 [json_name = "documentationUrl"];- Returns:
- The documentationUrl.
-
getDocumentationUrlBytes
com.google.protobuf.ByteString getDocumentationUrlBytes()A URL to more detailed documentation.
optional string documentation_url = 7 [json_name = "documentationUrl"];- Returns:
- The bytes for documentationUrl.
-
getTagsList
Tags for filtering and categorization in UIs (e.g., "nlp", "enrichment").
repeated string tags = 8 [json_name = "tags"];- Returns:
- A list containing the tags.
-
getTagsCount
int getTagsCount()Tags for filtering and categorization in UIs (e.g., "nlp", "enrichment").
repeated string tags = 8 [json_name = "tags"];- Returns:
- The count of tags.
-
getTags
Tags for filtering and categorization in UIs (e.g., "nlp", "enrichment").
repeated string tags = 8 [json_name = "tags"];- Parameters:
index- The index of the element to return.- Returns:
- The tags at the given index.
-
getTagsBytes
com.google.protobuf.ByteString getTagsBytes(int index) Tags for filtering and categorization in UIs (e.g., "nlp", "enrichment").
repeated string tags = 8 [json_name = "tags"];- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the tags at the given index.
-
getHealthCheckPassed
boolean getHealthCheckPassed()--- Health & Operational Status --- Whether the health check passed (true if no test_request provided).
bool health_check_passed = 9 [json_name = "healthCheckPassed"];- Returns:
- The healthCheckPassed.
-
getHealthCheckMessage
String getHealthCheckMessage()Health check message - error details if failed, success message if passed.
string health_check_message = 10 [json_name = "healthCheckMessage"];- Returns:
- The healthCheckMessage.
-
getHealthCheckMessageBytes
com.google.protobuf.ByteString getHealthCheckMessageBytes()Health check message - error details if failed, success message if passed.
string health_check_message = 10 [json_name = "healthCheckMessage"];- Returns:
- The bytes for healthCheckMessage.
-
hasRegistrationTimestamp
boolean hasRegistrationTimestamp()Timestamp of when this registration data was generated.
.google.protobuf.Timestamp registration_timestamp = 11 [json_name = "registrationTimestamp"];- Returns:
- Whether the registrationTimestamp field is set.
-
getRegistrationTimestamp
com.google.protobuf.Timestamp getRegistrationTimestamp()Timestamp of when this registration data was generated.
.google.protobuf.Timestamp registration_timestamp = 11 [json_name = "registrationTimestamp"];- Returns:
- The registrationTimestamp.
-
getRegistrationTimestampOrBuilder
com.google.protobuf.TimestampOrBuilder getRegistrationTimestampOrBuilder()Timestamp of when this registration data was generated.
.google.protobuf.Timestamp registration_timestamp = 11 [json_name = "registrationTimestamp"]; -
getServerInfo
String getServerInfo()--- Engine & Runtime Intelligence --- Information about the server process hosting the module (e.g., hostname, IP).
string server_info = 12 [json_name = "serverInfo"];- Returns:
- The serverInfo.
-
getServerInfoBytes
com.google.protobuf.ByteString getServerInfoBytes()--- Engine & Runtime Intelligence --- Information about the server process hosting the module (e.g., hostname, IP).
string server_info = 12 [json_name = "serverInfo"];- Returns:
- The bytes for serverInfo.
-
getSdkVersion
String getSdkVersion()The version of the pipeline SDK the module was compiled against (e.g., "0.5.0").
string sdk_version = 13 [json_name = "sdkVersion"];- Returns:
- The sdkVersion.
-
getSdkVersionBytes
com.google.protobuf.ByteString getSdkVersionBytes()The version of the pipeline SDK the module was compiled against (e.g., "0.5.0").
string sdk_version = 13 [json_name = "sdkVersion"];- Returns:
- The bytes for sdkVersion.
-
getDependenciesList
List of critical external dependencies (e.g., "chunker module", "database.prod.acme.com", "OpenAI API").
repeated string dependencies = 14 [json_name = "dependencies"];- Returns:
- A list containing the dependencies.
-
getDependenciesCount
int getDependenciesCount()List of critical external dependencies (e.g., "chunker module", "database.prod.acme.com", "OpenAI API").
repeated string dependencies = 14 [json_name = "dependencies"];- Returns:
- The count of dependencies.
-
getDependencies
List of critical external dependencies (e.g., "chunker module", "database.prod.acme.com", "OpenAI API").
repeated string dependencies = 14 [json_name = "dependencies"];- Parameters:
index- The index of the element to return.- Returns:
- The dependencies at the given index.
-
getDependenciesBytes
com.google.protobuf.ByteString getDependenciesBytes(int index) List of critical external dependencies (e.g., "chunker module", "database.prod.acme.com", "OpenAI API").
repeated string dependencies = 14 [json_name = "dependencies"];- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the dependencies at the given index.
-
getMetadataCount
int getMetadataCount()Flexible key-value pairs for any other developer-defined metadata.
map<string, string> metadata = 15 [json_name = "metadata"]; -
containsMetadata
Flexible key-value pairs for any other developer-defined metadata.
map<string, string> metadata = 15 [json_name = "metadata"]; -
getMetadata
Deprecated.UsegetMetadataMap()instead. -
getMetadataMap
Flexible key-value pairs for any other developer-defined metadata.
map<string, string> metadata = 15 [json_name = "metadata"]; -
getMetadataOrDefault
Flexible key-value pairs for any other developer-defined metadata.
map<string, string> metadata = 15 [json_name = "metadata"]; -
getMetadataOrThrow
Flexible key-value pairs for any other developer-defined metadata.
map<string, string> metadata = 15 [json_name = "metadata"]; -
hasCapabilities
boolean hasCapabilities()Module capabilities for UI adaptation
.ai.pipestream.data.module.v1.Capabilities capabilities = 16 [json_name = "capabilities"];- Returns:
- Whether the capabilities field is set.
-
getCapabilities
Capabilities getCapabilities()Module capabilities for UI adaptation
.ai.pipestream.data.module.v1.Capabilities capabilities = 16 [json_name = "capabilities"];- Returns:
- The capabilities.
-
getCapabilitiesOrBuilder
CapabilitiesOrBuilder getCapabilitiesOrBuilder()Module capabilities for UI adaptation
.ai.pipestream.data.module.v1.Capabilities capabilities = 16 [json_name = "capabilities"];
-