Package org.finos.tracdap.api

Class DataReadRequest

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, DataReadRequestOrBuilder
    public final class DataReadRequest
extends com.google.protobuf.GeneratedMessageV3
implements DataReadRequestOrBuilder
    
 Request to read a dataset stored in the TRAC platform.
 @see TracDataApi.readDataset
    Protobuf type tracdap.api.DataReadRequest
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  DataReadRequest.Builder
      Request to read a dataset stored in the TRAC platform.

      • 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 Summary

      Fields 
      Modifier and Type Field Description
      static int FORMAT_FIELD_NUMBER  
      static int SELECTOR_FIELD_NUMBER  
      static int TENANT_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      static DataReadRequest getDefaultInstance()  
      DataReadRequest getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      java.lang.String getFormat()
      Format that the dataset will be returned in.
      com.google.protobuf.ByteString getFormatBytes()
      Format that the dataset will be returned in.
      com.google.protobuf.Parser<DataReadRequest> getParserForType()  
      org.finos.tracdap.metadata.TagSelector getSelector()
      Selector for the dataset being read
      org.finos.tracdap.metadata.TagSelectorOrBuilder getSelectorOrBuilder()
      Selector for the dataset being read
      int getSerializedSize()  
      java.lang.String getTenant()
      Tenant code for the requested operation, always required.
      com.google.protobuf.ByteString getTenantBytes()
      Tenant code for the requested operation, always required.
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      int hashCode()  
      boolean hasSelector()
      Selector for the dataset being read
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static DataReadRequest.Builder newBuilder()  
      static DataReadRequest.Builder newBuilder​(DataReadRequest prototype)  
      DataReadRequest.Builder newBuilderForType()  
      protected DataReadRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static DataReadRequest parseDelimitedFrom​(java.io.InputStream input)  
      static DataReadRequest parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static DataReadRequest parseFrom​(byte[] data)  
      static DataReadRequest parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static DataReadRequest parseFrom​(com.google.protobuf.ByteString data)  
      static DataReadRequest parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static DataReadRequest parseFrom​(com.google.protobuf.CodedInputStream input)  
      static DataReadRequest parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static DataReadRequest parseFrom​(java.io.InputStream input)  
      static DataReadRequest parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static DataReadRequest parseFrom​(java.nio.ByteBuffer data)  
      static DataReadRequest parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<DataReadRequest> parser()  
      DataReadRequest.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

    • 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()

      • internalGetFieldAccessorTable

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

      • getTenant

        public java.lang.String getTenant()
        
 Tenant code for the requested operation, always required.
        string tenant = 1;
        Specified by:
        getTenant in interface DataReadRequestOrBuilder
        Returns:
        The tenant.

      • getTenantBytes

        public com.google.protobuf.ByteString getTenantBytes()
        
 Tenant code for the requested operation, always required.
        string tenant = 1;
        Specified by:
        getTenantBytes in interface DataReadRequestOrBuilder
        Returns:
        The bytes for tenant.

      • hasSelector

        public boolean hasSelector()
        
 Selector for the dataset being read
        .tracdap.metadata.TagSelector selector = 2;
        Specified by:
        hasSelector in interface DataReadRequestOrBuilder
        Returns:
        Whether the selector field is set.

      • getSelector

        public org.finos.tracdap.metadata.TagSelector getSelector()
        
 Selector for the dataset being read
        .tracdap.metadata.TagSelector selector = 2;
        Specified by:
        getSelector in interface DataReadRequestOrBuilder
        Returns:
        The selector.

      • getSelectorOrBuilder

        public org.finos.tracdap.metadata.TagSelectorOrBuilder getSelectorOrBuilder()
        
 Selector for the dataset being read
        .tracdap.metadata.TagSelector selector = 2;
        Specified by:
        getSelectorOrBuilder in interface DataReadRequestOrBuilder

      • getFormat

        public java.lang.String getFormat()
        
 Format that the dataset will be returned in.
 The format must be the mime type of a supported data format.
 Data will be encoded in this format before it is sent back.
        string format = 3;
        Specified by:
        getFormat in interface DataReadRequestOrBuilder
        Returns:
        The format.

      • getFormatBytes

        public com.google.protobuf.ByteString getFormatBytes()
        
 Format that the dataset will be returned in.
 The format must be the mime type of a supported data format.
 Data will be encoded in this format before it is sent back.
        string format = 3;
        Specified by:
        getFormatBytes in interface DataReadRequestOrBuilder
        Returns:
        The bytes for format.

      • 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 DataReadRequest parseFrom​(java.nio.ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DataReadRequest parseFrom​(java.nio.ByteBuffer data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static DataReadRequest parseFrom​(java.io.InputStream input)
                                 throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected DataReadRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<DataReadRequest> 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 DataReadRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder