Package org.finos.tracdap.api

Interface PlatformInfoResponseOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
PlatformInfoResponse, PlatformInfoResponse.Builder
public interface PlatformInfoResponseOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsDeploymentInfo(String key)
    * Additional information about the current TRAC environment.
    Map<String,String>
    getDeploymentInfo()
    Deprecated.
    int
    getDeploymentInfoCount()
    * Additional information about the current TRAC environment.
    Map<String,String>
    getDeploymentInfoMap()
    * Additional information about the current TRAC environment.
    String
    getDeploymentInfoOrDefault(String key, String defaultValue)
    * Additional information about the current TRAC environment.
    String
    getDeploymentInfoOrThrow(String key)
    * Additional information about the current TRAC environment.
    String
    getEnvironment()
    / Name of the current TRAC environment.
    com.google.protobuf.ByteString
    getEnvironmentBytes()
    / Name of the current TRAC environment.
    boolean
    getProduction()
    / Flag indicating whether the current environment is a production environment or not.
    String
    getTracVersion()
    / Version string for the version of TRAC currently deployed in the platform.
    com.google.protobuf.ByteString
    getTracVersionBytes()
    / Version string for the version of TRAC currently deployed in the platform.

    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

    • getTracVersion

      String getTracVersion()
       / Version string for the version of TRAC currently deployed in the platform.
      string tracVersion = 1;
      Returns:
      The tracVersion.

    • getTracVersionBytes

      com.google.protobuf.ByteString getTracVersionBytes()
       / Version string for the version of TRAC currently deployed in the platform.
      string tracVersion = 1;
      Returns:
      The bytes for tracVersion.

    • getEnvironment

      String getEnvironment()
       / Name of the current TRAC environment.
      string environment = 2;
      Returns:
      The environment.

    • getEnvironmentBytes

      com.google.protobuf.ByteString getEnvironmentBytes()
       / Name of the current TRAC environment.
      string environment = 2;
      Returns:
      The bytes for environment.

    • getProduction

      boolean getProduction()
       / Flag indicating whether the current environment is a production environment or not.
      bool production = 3;
      Returns:
      The production.

    • getDeploymentInfoCount

      int getDeploymentInfoCount()
       *
 Additional information about the current TRAC environment.

 The particular information relevant to a deployment of TRAC can vary between organizations.
 Useful information might include: region, business division, brand etc.
 This information is optional and may not be present for smaller deployments.
      map<string, string> deploymentInfo = 4;

    • containsDeploymentInfo

      boolean containsDeploymentInfo(String key)
       *
 Additional information about the current TRAC environment.

 The particular information relevant to a deployment of TRAC can vary between organizations.
 Useful information might include: region, business division, brand etc.
 This information is optional and may not be present for smaller deployments.
      map<string, string> deploymentInfo = 4;

    • getDeploymentInfo

      @Deprecated Map<String,String> getDeploymentInfo()
      Deprecated.
      Use getDeploymentInfoMap() instead.

    • getDeploymentInfoMap

      Map<String,String> getDeploymentInfoMap()
       *
 Additional information about the current TRAC environment.

 The particular information relevant to a deployment of TRAC can vary between organizations.
 Useful information might include: region, business division, brand etc.
 This information is optional and may not be present for smaller deployments.
      map<string, string> deploymentInfo = 4;

    • getDeploymentInfoOrDefault

      String getDeploymentInfoOrDefault(String key, String defaultValue)
       *
 Additional information about the current TRAC environment.

 The particular information relevant to a deployment of TRAC can vary between organizations.
 Useful information might include: region, business division, brand etc.
 This information is optional and may not be present for smaller deployments.
      map<string, string> deploymentInfo = 4;

    • getDeploymentInfoOrThrow

      String getDeploymentInfoOrThrow(String key)
       *
 Additional information about the current TRAC environment.

 The particular information relevant to a deployment of TRAC can vary between organizations.
 Useful information might include: region, business division, brand etc.
 This information is optional and may not be present for smaller deployments.
      map<string, string> deploymentInfo = 4;