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 Type
    Method
    Description
    boolean
    containsMetadata(String key)
    Flexible key-value pairs for any other developer-defined metadata.
    Capabilities
    getCapabilities()
    Module capabilities for UI adaptation
    CapabilitiesOrBuilder
    getCapabilitiesOrBuilder()
    Module capabilities for UI adaptation
    String
    getDependencies(int index)
    List of critical external dependencies (e.g., "chunker module", "database.prod.acme.com", "OpenAI API").
    com.google.protobuf.ByteString
    getDependenciesBytes(int index)
    List of critical external dependencies (e.g., "chunker module", "database.prod.acme.com", "OpenAI API").
    int
    getDependenciesCount()
    List of critical external dependencies (e.g., "chunker module", "database.prod.acme.com", "OpenAI API").
    List<String>
    getDependenciesList()
    List of critical external dependencies (e.g., "chunker module", "database.prod.acme.com", "OpenAI API").
    String
    getDescription()
    A brief summary of the module's purpose.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    A brief summary of the module's purpose.
    String
    getDisplayName()
    --- UI & Developer Experience (Human-Readable) --- A clean, human-friendly name for display in UIs (e.g., "Acme Text Chunker").
    com.google.protobuf.ByteString
    getDisplayNameBytes()
    --- UI & Developer Experience (Human-Readable) --- A clean, human-friendly name for display in UIs (e.g., "Acme Text Chunker").
    String
    getDocumentationUrl()
    A URL to more detailed documentation.
    com.google.protobuf.ByteString
    getDocumentationUrlBytes()
    A URL to more detailed documentation.
    String
    getHealthCheckMessage()
    Health check message - error details if failed, success message if passed.
    com.google.protobuf.ByteString
    getHealthCheckMessageBytes()
    Health check message - error details if failed, success message if passed.
    boolean
    getHealthCheckPassed()
    --- Health & Operational Status --- Whether the health check passed (true if no test_request provided).
    String
    getJsonConfigSchema()
    JSON schema for validating the 'custom_json_config' in a pipeline step.
    com.google.protobuf.ByteString
    getJsonConfigSchemaBytes()
    JSON schema for validating the 'custom_json_config' in a pipeline step.
    Map<String,String>
    getMetadata()
    Deprecated.
    int
    getMetadataCount()
    Flexible key-value pairs for any other developer-defined metadata.
    Map<String,String>
    getMetadataMap()
    Flexible key-value pairs for any other developer-defined metadata.
    String
    getMetadataOrDefault(String key, String defaultValue)
    Flexible key-value pairs for any other developer-defined metadata.
    String
    getMetadataOrThrow(String key)
    Flexible key-value pairs for any other developer-defined metadata.
    String
    getModuleName()
    --- Core Identity & Validation (Machine-Readable) --- Unique, machine-readable identifier for the module (e.g., "acme-text-chunker-v2").
    com.google.protobuf.ByteString
    getModuleNameBytes()
    --- Core Identity & Validation (Machine-Readable) --- Unique, machine-readable identifier for the module (e.g., "acme-text-chunker-v2").
    String
    getOwner()
    The team or individual responsible for maintaining this module.
    com.google.protobuf.ByteString
    getOwnerBytes()
    The team or individual responsible for maintaining this module.
    com.google.protobuf.Timestamp
    getRegistrationTimestamp()
    Timestamp of when this registration data was generated.
    com.google.protobuf.TimestampOrBuilder
    getRegistrationTimestampOrBuilder()
    Timestamp of when this registration data was generated.
    String
    getSdkVersion()
    The version of the pipeline SDK the module was compiled against (e.g., "0.5.0").
    com.google.protobuf.ByteString
    getSdkVersionBytes()
    The version of the pipeline SDK the module was compiled against (e.g., "0.5.0").
    String
    getServerInfo()
    --- Engine & Runtime Intelligence --- Information about the server process hosting the module (e.g., hostname, IP).
    com.google.protobuf.ByteString
    getServerInfoBytes()
    --- Engine & Runtime Intelligence --- Information about the server process hosting the module (e.g., hostname, IP).
    String
    getTags(int index)
    Tags for filtering and categorization in UIs (e.g., "nlp", "enrichment").
    com.google.protobuf.ByteString
    getTagsBytes(int index)
    Tags for filtering and categorization in UIs (e.g., "nlp", "enrichment").
    int
    getTagsCount()
    Tags for filtering and categorization in UIs (e.g., "nlp", "enrichment").
    List<String>
    getTagsList()
    Tags for filtering and categorization in UIs (e.g., "nlp", "enrichment").
    String
    getVersion()
    Semantic version of the module itself (e.g., "1.2.1").
    com.google.protobuf.ByteString
    getVersionBytes()
    Semantic version of the module itself (e.g., "1.2.1").
    boolean
    hasCapabilities()
    Module capabilities for UI adaptation
    boolean
    hasDescription()
    A brief summary of the module's purpose.
    boolean
    hasDisplayName()
    --- UI & Developer Experience (Human-Readable) --- A clean, human-friendly name for display in UIs (e.g., "Acme Text Chunker").
    boolean
    hasDocumentationUrl()
    A URL to more detailed documentation.
    boolean
    hasJsonConfigSchema()
    JSON schema for validating the 'custom_json_config' in a pipeline step.
    boolean
    hasOwner()
    The team or individual responsible for maintaining this module.
    boolean
    hasRegistrationTimestamp()
    Timestamp of when this registration data was generated.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods 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;
      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;
      Returns:
      The bytes for moduleName.

    • getVersion

      String getVersion()
       Semantic version of the module itself (e.g., "1.2.1").
      string version = 2;
      Returns:
      The version.

    • getVersionBytes

      com.google.protobuf.ByteString getVersionBytes()
       Semantic version of the module itself (e.g., "1.2.1").
      string version = 2;
      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;
      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;
      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;
      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;
      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;
      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;
      Returns:
      The bytes for displayName.

    • hasDescription

      boolean hasDescription()
       A brief summary of the module's purpose.
      optional string description = 5;
      Returns:
      Whether the description field is set.

    • getDescription

      String getDescription()
       A brief summary of the module's purpose.
      optional string description = 5;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       A brief summary of the module's purpose.
      optional string description = 5;
      Returns:
      The bytes for description.

    • hasOwner

      boolean hasOwner()
       The team or individual responsible for maintaining this module.
      optional string owner = 6;
      Returns:
      Whether the owner field is set.

    • getOwner

      String getOwner()
       The team or individual responsible for maintaining this module.
      optional string owner = 6;
      Returns:
      The owner.

    • getOwnerBytes

      com.google.protobuf.ByteString getOwnerBytes()
       The team or individual responsible for maintaining this module.
      optional string owner = 6;
      Returns:
      The bytes for owner.

    • hasDocumentationUrl

      boolean hasDocumentationUrl()
       A URL to more detailed documentation.
      optional string documentation_url = 7;
      Returns:
      Whether the documentationUrl field is set.

    • getDocumentationUrl

      String getDocumentationUrl()
       A URL to more detailed documentation.
      optional string documentation_url = 7;
      Returns:
      The documentationUrl.

    • getDocumentationUrlBytes

      com.google.protobuf.ByteString getDocumentationUrlBytes()
       A URL to more detailed documentation.
      optional string documentation_url = 7;
      Returns:
      The bytes for documentationUrl.

    • getTagsList

      List<String> getTagsList()
       Tags for filtering and categorization in UIs (e.g., "nlp", "enrichment").
      repeated string tags = 8;
      Returns:
      A list containing the tags.

    • getTagsCount

      int getTagsCount()
       Tags for filtering and categorization in UIs (e.g., "nlp", "enrichment").
      repeated string tags = 8;
      Returns:
      The count of tags.

    • getTags

      String getTags(int index)
       Tags for filtering and categorization in UIs (e.g., "nlp", "enrichment").
      repeated string tags = 8;
      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;
      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;
      Returns:
      The healthCheckPassed.

    • getHealthCheckMessage

      String getHealthCheckMessage()
       Health check message - error details if failed, success message if passed.
      string health_check_message = 10;
      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;
      Returns:
      The bytes for healthCheckMessage.

    • hasRegistrationTimestamp

      boolean hasRegistrationTimestamp()
       Timestamp of when this registration data was generated.
      .google.protobuf.Timestamp registration_timestamp = 11;
      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;
      Returns:
      The registrationTimestamp.

    • getRegistrationTimestampOrBuilder

      com.google.protobuf.TimestampOrBuilder getRegistrationTimestampOrBuilder()
       Timestamp of when this registration data was generated.
      .google.protobuf.Timestamp registration_timestamp = 11;

    • getServerInfo

      String getServerInfo()
       --- Engine & Runtime Intelligence ---
 Information about the server process hosting the module (e.g., hostname, IP).
      string server_info = 12;
      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;
      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;
      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;
      Returns:
      The bytes for sdkVersion.

    • getDependenciesList

      List<String> getDependenciesList()
       List of critical external dependencies (e.g., "chunker module", "database.prod.acme.com", "OpenAI API").
      repeated string dependencies = 14;
      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;
      Returns:
      The count of dependencies.

    • getDependencies

      String getDependencies(int index)
       List of critical external dependencies (e.g., "chunker module", "database.prod.acme.com", "OpenAI API").
      repeated string dependencies = 14;
      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;
      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;

    • containsMetadata

      boolean containsMetadata(String key)
       Flexible key-value pairs for any other developer-defined metadata.
      map<string, string> metadata = 15;

    • getMetadata

      @Deprecated Map<String,String> getMetadata()
      Deprecated.
      Use getMetadataMap() instead.

    • getMetadataMap

      Map<String,String> getMetadataMap()
       Flexible key-value pairs for any other developer-defined metadata.
      map<string, string> metadata = 15;

    • getMetadataOrDefault

      String getMetadataOrDefault(String key, String defaultValue)
       Flexible key-value pairs for any other developer-defined metadata.
      map<string, string> metadata = 15;

    • getMetadataOrThrow

      String getMetadataOrThrow(String key)
       Flexible key-value pairs for any other developer-defined metadata.
      map<string, string> metadata = 15;

    • hasCapabilities

      boolean hasCapabilities()
       Module capabilities for UI adaptation
      .ai.pipestream.data.module.v1.Capabilities capabilities = 16;
      Returns:
      Whether the capabilities field is set.

    • getCapabilities

      Capabilities getCapabilities()
       Module capabilities for UI adaptation
      .ai.pipestream.data.module.v1.Capabilities capabilities = 16;
      Returns:
      The capabilities.

    • getCapabilitiesOrBuilder

      CapabilitiesOrBuilder getCapabilitiesOrBuilder()
       Module capabilities for UI adaptation
      .ai.pipestream.data.module.v1.Capabilities capabilities = 16;