Package org.finos.tracdap.api

Class PlatformInfoResponse

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, PlatformInfoResponseOrBuilder
    public final class PlatformInfoResponse
extends com.google.protobuf.GeneratedMessageV3
implements PlatformInfoResponseOrBuilder
    
 Response object for the platformInfo() API call.
 Contains some general information about the TRAC platform.
    Protobuf type tracdap.api.PlatformInfoResponse
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  PlatformInfoResponse.Builder
      Response object for the platformInfo() API call.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Detail

      • TRACVERSION_FIELD_NUMBER

        public static final int TRACVERSION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENVIRONMENT_FIELD_NUMBER

        public static final int ENVIRONMENT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PRODUCTION_FIELD_NUMBER

        public static final int PRODUCTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DEPLOYMENTINFO_FIELD_NUMBER

        public static final int DEPLOYMENTINFO_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

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

      • getTracVersion

        public java.lang.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 java.lang.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​(java.lang.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

      • getDeploymentInfoMap

        public java.util.Map<java.lang.String,​java.lang.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 java.lang.String getDeploymentInfoOrDefault​(java.lang.String key,
                                                   java.lang.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 java.lang.String getDeploymentInfoOrThrow​(java.lang.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.GeneratedMessageV3

      • writeTo

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

      • getSerializedSize

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

      • equals

        public boolean equals​(java.lang.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​(java.nio.ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PlatformInfoResponse parseFrom​(java.nio.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​(java.io.InputStream input)
                                      throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • parseDelimitedFrom

        public static PlatformInfoResponse parseDelimitedFrom​(java.io.InputStream input)
                                               throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • 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.GeneratedMessageV3

      • getDefaultInstanceForType

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