Package org.finos.tracdap.api

Class DataWriteRequest

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, DataWriteRequestOrBuilder
    public final class DataWriteRequest
extends com.google.protobuf.GeneratedMessageV3
implements DataWriteRequestOrBuilder
    
 Request to create of update a dataset stored in the TRAC platform.
 @see TracDataApi.createDataset
 @see TracDataApi.updateDataset
    Protobuf type tracdap.api.DataWriteRequest
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  DataWriteRequest.Builder
      Request to create of update a dataset stored in the TRAC platform.
      static class  DataWriteRequest.SchemaSpecifierCase  

      • 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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      com.google.protobuf.ByteString getContent()
      The content of the dataset, encoded as per the "format" field.
      static DataWriteRequest getDefaultInstance()  
      DataWriteRequest getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      java.lang.String getFormat()
      Format that will be used for uploading data.
      com.google.protobuf.ByteString getFormatBytes()
      Format that will be used for uploading data.
      com.google.protobuf.Parser<DataWriteRequest> getParserForType()  
      org.finos.tracdap.metadata.TagSelector getPriorVersion()
      Prior object/tag version to use for update operations.
      org.finos.tracdap.metadata.TagSelectorOrBuilder getPriorVersionOrBuilder()
      Prior object/tag version to use for update operations.
      org.finos.tracdap.metadata.SchemaDefinition getSchema()
      Specify the schema with an explicit schema definition.
      org.finos.tracdap.metadata.TagSelector getSchemaId()
      Specify the schema using an external schema definition.
      org.finos.tracdap.metadata.TagSelectorOrBuilder getSchemaIdOrBuilder()
      Specify the schema using an external schema definition.
      org.finos.tracdap.metadata.SchemaDefinitionOrBuilder getSchemaOrBuilder()
      Specify the schema with an explicit schema definition.
      DataWriteRequest.SchemaSpecifierCase getSchemaSpecifierCase()  
      int getSerializedSize()  
      org.finos.tracdap.metadata.TagUpdate getTagUpdates​(int index)
      Tag update operations to be applied.
      int getTagUpdatesCount()
      Tag update operations to be applied.
      java.util.List<org.finos.tracdap.metadata.TagUpdate> getTagUpdatesList()
      Tag update operations to be applied.
      org.finos.tracdap.metadata.TagUpdateOrBuilder getTagUpdatesOrBuilder​(int index)
      Tag update operations to be applied.
      java.util.List<? extends org.finos.tracdap.metadata.TagUpdateOrBuilder> getTagUpdatesOrBuilderList()
      Tag update operations to be applied.
      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 hasPriorVersion()
      Prior object/tag version to use for update operations.
      boolean hasSchema()
      Specify the schema with an explicit schema definition.
      boolean hasSchemaId()
      Specify the schema using an external schema definition.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static DataWriteRequest.Builder newBuilder()  
      static DataWriteRequest.Builder newBuilder​(DataWriteRequest prototype)  
      DataWriteRequest.Builder newBuilderForType()  
      protected DataWriteRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static DataWriteRequest parseDelimitedFrom​(java.io.InputStream input)  
      static DataWriteRequest parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static DataWriteRequest parseFrom​(byte[] data)  
      static DataWriteRequest parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static DataWriteRequest parseFrom​(com.google.protobuf.ByteString data)  
      static DataWriteRequest parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static DataWriteRequest parseFrom​(com.google.protobuf.CodedInputStream input)  
      static DataWriteRequest parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static DataWriteRequest parseFrom​(java.io.InputStream input)  
      static DataWriteRequest parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static DataWriteRequest parseFrom​(java.nio.ByteBuffer data)  
      static DataWriteRequest parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<DataWriteRequest> parser()  
      DataWriteRequest.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 DataWriteRequestOrBuilder
        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 DataWriteRequestOrBuilder
        Returns:
        The bytes for tenant.

      • hasPriorVersion

        public boolean hasPriorVersion()
        
 Prior object/tag version to use for update operations.
 This field should be omitted when creating a new dataset.
        optional .tracdap.metadata.TagSelector priorVersion = 2;
        Specified by:
        hasPriorVersion in interface DataWriteRequestOrBuilder
        Returns:
        Whether the priorVersion field is set.

      • getPriorVersion

        public org.finos.tracdap.metadata.TagSelector getPriorVersion()
        
 Prior object/tag version to use for update operations.
 This field should be omitted when creating a new dataset.
        optional .tracdap.metadata.TagSelector priorVersion = 2;
        Specified by:
        getPriorVersion in interface DataWriteRequestOrBuilder
        Returns:
        The priorVersion.

      • getPriorVersionOrBuilder

        public org.finos.tracdap.metadata.TagSelectorOrBuilder getPriorVersionOrBuilder()
        
 Prior object/tag version to use for update operations.
 This field should be omitted when creating a new dataset.
        optional .tracdap.metadata.TagSelector priorVersion = 2;
        Specified by:
        getPriorVersionOrBuilder in interface DataWriteRequestOrBuilder

      • getTagUpdatesList

        public java.util.List<org.finos.tracdap.metadata.TagUpdate> getTagUpdatesList()
        
 Tag update operations to be applied.
 Tag updates are applied in exactly the same way as for metadata write requests.
 @see MetadataWriteRequest
 @see TracMetadataApi
        repeated .tracdap.metadata.TagUpdate tagUpdates = 3;
        Specified by:
        getTagUpdatesList in interface DataWriteRequestOrBuilder

      • getTagUpdatesOrBuilderList

        public java.util.List<? extends org.finos.tracdap.metadata.TagUpdateOrBuilder> getTagUpdatesOrBuilderList()
        
 Tag update operations to be applied.
 Tag updates are applied in exactly the same way as for metadata write requests.
 @see MetadataWriteRequest
 @see TracMetadataApi
        repeated .tracdap.metadata.TagUpdate tagUpdates = 3;
        Specified by:
        getTagUpdatesOrBuilderList in interface DataWriteRequestOrBuilder

      • getTagUpdatesCount

        public int getTagUpdatesCount()
        
 Tag update operations to be applied.
 Tag updates are applied in exactly the same way as for metadata write requests.
 @see MetadataWriteRequest
 @see TracMetadataApi
        repeated .tracdap.metadata.TagUpdate tagUpdates = 3;
        Specified by:
        getTagUpdatesCount in interface DataWriteRequestOrBuilder

      • getTagUpdates

        public org.finos.tracdap.metadata.TagUpdate getTagUpdates​(int index)
        
 Tag update operations to be applied.
 Tag updates are applied in exactly the same way as for metadata write requests.
 @see MetadataWriteRequest
 @see TracMetadataApi
        repeated .tracdap.metadata.TagUpdate tagUpdates = 3;
        Specified by:
        getTagUpdates in interface DataWriteRequestOrBuilder

      • getTagUpdatesOrBuilder

        public org.finos.tracdap.metadata.TagUpdateOrBuilder getTagUpdatesOrBuilder​(int index)
        
 Tag update operations to be applied.
 Tag updates are applied in exactly the same way as for metadata write requests.
 @see MetadataWriteRequest
 @see TracMetadataApi
        repeated .tracdap.metadata.TagUpdate tagUpdates = 3;
        Specified by:
        getTagUpdatesOrBuilder in interface DataWriteRequestOrBuilder

      • hasSchemaId

        public boolean hasSchemaId()
        
 Specify the schema using an external schema definition.
 If a schema ID is supplied, it must be a valid tag selector for an existing SCHEMA object.
 All future versions of the dataset must use either the same schema ID or a later version
 of the same schema object.
 TRAC will look up the external schema and validate incoming data to make sure it is conformant.
        .tracdap.metadata.TagSelector schemaId = 4;
        Specified by:
        hasSchemaId in interface DataWriteRequestOrBuilder
        Returns:
        Whether the schemaId field is set.

      • getSchemaId

        public org.finos.tracdap.metadata.TagSelector getSchemaId()
        
 Specify the schema using an external schema definition.
 If a schema ID is supplied, it must be a valid tag selector for an existing SCHEMA object.
 All future versions of the dataset must use either the same schema ID or a later version
 of the same schema object.
 TRAC will look up the external schema and validate incoming data to make sure it is conformant.
        .tracdap.metadata.TagSelector schemaId = 4;
        Specified by:
        getSchemaId in interface DataWriteRequestOrBuilder
        Returns:
        The schemaId.

      • getSchemaIdOrBuilder

        public org.finos.tracdap.metadata.TagSelectorOrBuilder getSchemaIdOrBuilder()
        
 Specify the schema using an external schema definition.
 If a schema ID is supplied, it must be a valid tag selector for an existing SCHEMA object.
 All future versions of the dataset must use either the same schema ID or a later version
 of the same schema object.
 TRAC will look up the external schema and validate incoming data to make sure it is conformant.
        .tracdap.metadata.TagSelector schemaId = 4;
        Specified by:
        getSchemaIdOrBuilder in interface DataWriteRequestOrBuilder

      • hasSchema

        public boolean hasSchema()
        
 Specify the schema with an explicit schema definition.
 If an explicit schema is supplied TRAC will save the schema as part of the DATA object,
 creating an embedded schema this individual dataset. All future versions of the dataset
 must also use an embedded schema which can either be the same schema or a compatible
 one, with compatibility following the rules of schema versioning (fields can be added
 but not removed or materially altered).
 TRAC will validate incoming data to make sure it is conformant with the schema.
        .tracdap.metadata.SchemaDefinition schema = 5;
        Specified by:
        hasSchema in interface DataWriteRequestOrBuilder
        Returns:
        Whether the schema field is set.

      • getSchema

        public org.finos.tracdap.metadata.SchemaDefinition getSchema()
        
 Specify the schema with an explicit schema definition.
 If an explicit schema is supplied TRAC will save the schema as part of the DATA object,
 creating an embedded schema this individual dataset. All future versions of the dataset
 must also use an embedded schema which can either be the same schema or a compatible
 one, with compatibility following the rules of schema versioning (fields can be added
 but not removed or materially altered).
 TRAC will validate incoming data to make sure it is conformant with the schema.
        .tracdap.metadata.SchemaDefinition schema = 5;
        Specified by:
        getSchema in interface DataWriteRequestOrBuilder
        Returns:
        The schema.

      • getSchemaOrBuilder

        public org.finos.tracdap.metadata.SchemaDefinitionOrBuilder getSchemaOrBuilder()
        
 Specify the schema with an explicit schema definition.
 If an explicit schema is supplied TRAC will save the schema as part of the DATA object,
 creating an embedded schema this individual dataset. All future versions of the dataset
 must also use an embedded schema which can either be the same schema or a compatible
 one, with compatibility following the rules of schema versioning (fields can be added
 but not removed or materially altered).
 TRAC will validate incoming data to make sure it is conformant with the schema.
        .tracdap.metadata.SchemaDefinition schema = 5;
        Specified by:
        getSchemaOrBuilder in interface DataWriteRequestOrBuilder

      • getFormat

        public java.lang.String getFormat()
        
 Format that will be used for uploading data.
 This field tells TRAC what format the data will be sent in, it must be the mime type
 of a supported data format. Data provided in the "content" field can then be encoded
 in this format.
 The "format" field does not affect how TRAC stores data. Incoming data is decoded and
 translated into a format recognised by the underlying data platform.
        string format = 9;
        Specified by:
        getFormat in interface DataWriteRequestOrBuilder
        Returns:
        The format.

      • getFormatBytes

        public com.google.protobuf.ByteString getFormatBytes()
        
 Format that will be used for uploading data.
 This field tells TRAC what format the data will be sent in, it must be the mime type
 of a supported data format. Data provided in the "content" field can then be encoded
 in this format.
 The "format" field does not affect how TRAC stores data. Incoming data is decoded and
 translated into a format recognised by the underlying data platform.
        string format = 9;
        Specified by:
        getFormatBytes in interface DataWriteRequestOrBuilder
        Returns:
        The bytes for format.

      • getContent

        public com.google.protobuf.ByteString getContent()
        
 The content of the dataset, encoded as per the "format" field.
 For client streaming requests, each message contains a chunk of the encoded dataset.
 Empty (i.e. zero-length) chunks can be included in the stream and will be ignored.
 For unary requests (createSmallDataset, updateSmallDataset) the encoded content of
 the dataset must be included in the request as a single blob.
        bytes content = 1000;
        Specified by:
        getContent in interface DataWriteRequestOrBuilder
        Returns:
        The content.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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