Package org.finos.tracdap.api

Class PlatformInfoResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
org.finos.tracdap.api.PlatformInfoResponse
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, PlatformInfoResponseOrBuilder
public final class PlatformInfoResponse extends com.google.protobuf.GeneratedMessage implements PlatformInfoResponseOrBuilder
 *
 Response object for the platformInfo() API call.

 Contains some general information about the TRAC platform.
Protobuf type tracdap.api.PlatformInfoResponse
See Also:

  • Field Details

    • TRACVERSION_FIELD_NUMBER

      public static final int TRACVERSION_FIELD_NUMBER
      See Also:

    • ENVIRONMENT_FIELD_NUMBER

      public static final int ENVIRONMENT_FIELD_NUMBER
      See Also:

    • PRODUCTION_FIELD_NUMBER

      public static final int PRODUCTION_FIELD_NUMBER
      See Also:

    • DEPLOYMENTINFO_FIELD_NUMBER

      public static final int DEPLOYMENTINFO_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getTracVersion

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

    • getTracVersionBytes

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

    • getEnvironment

      public String getEnvironment()
       / Name of the current TRAC environment.
      string environment = 2;
      Specified by:
      getEnvironment in interface PlatformInfoResponseOrBuilder
      Returns:
      The environment.

    • getEnvironmentBytes

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

    • getProduction

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

    • getDeploymentInfoCount

      public int getDeploymentInfoCount()
      Description copied from interface: PlatformInfoResponseOrBuilder
       *
 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;
      Specified by:
      getDeploymentInfoCount in interface PlatformInfoResponseOrBuilder

    • containsDeploymentInfo

      public 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;
      Specified by:
      containsDeploymentInfo in interface PlatformInfoResponseOrBuilder

    • getDeploymentInfo

      @Deprecated public Map<String,String> getDeploymentInfo()
      Deprecated.
      Use getDeploymentInfoMap() instead.
      Specified by:
      getDeploymentInfo in interface PlatformInfoResponseOrBuilder

    • getDeploymentInfoMap

      public 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;
      Specified by:
      getDeploymentInfoMap in interface PlatformInfoResponseOrBuilder

    • getDeploymentInfoOrDefault

      public 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;
      Specified by:
      getDeploymentInfoOrDefault in interface PlatformInfoResponseOrBuilder

    • getDeploymentInfoOrThrow

      public 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;
      Specified by:
      getDeploymentInfoOrThrow in interface PlatformInfoResponseOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static PlatformInfoResponse parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PlatformInfoResponse parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PlatformInfoResponse parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PlatformInfoResponse parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PlatformInfoResponse parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PlatformInfoResponse parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PlatformInfoResponse parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PlatformInfoResponse parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PlatformInfoResponse parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PlatformInfoResponse parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PlatformInfoResponse parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PlatformInfoResponse parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public PlatformInfoResponse.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static PlatformInfoResponse.Builder newBuilder()

    • newBuilder

      public static PlatformInfoResponse.Builder newBuilder(PlatformInfoResponse prototype)

    • toBuilder

      public PlatformInfoResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected PlatformInfoResponse.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static PlatformInfoResponse getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<PlatformInfoResponse> parser()

    • getParserForType

      public com.google.protobuf.Parser<PlatformInfoResponse> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public PlatformInfoResponse getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder