Package org.finos.tracdap.api

Class DataWriteRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
org.finos.tracdap.api.DataWriteRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, DataWriteRequestOrBuilder
public final class DataWriteRequest extends com.google.protobuf.GeneratedMessage 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:

  • Nested Class Summary

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

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CONTENT_FIELD_NUMBER
     
    static final int
    FORMAT_FIELD_NUMBER
     
    static final int
    PRIORVERSION_FIELD_NUMBER
     
    static final int
    SCHEMA_FIELD_NUMBER
     
    static final int
    SCHEMAID_FIELD_NUMBER
     
    static final int
    TAGUPDATES_FIELD_NUMBER
     
    static final int
    TENANT_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    com.google.protobuf.ByteString
    getContent()
    * The content of the dataset, encoded as per the "format" field.
    static DataWriteRequest
    getDefaultInstance()
     
    DataWriteRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.
    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.
    List<? extends org.finos.tracdap.metadata.TagUpdateOrBuilder>
    getTagUpdatesOrBuilderList()
    * Tag update operations to be applied.
    String
    getTenant()
    * Tenant code for the requested operation, always required.
    com.google.protobuf.ByteString
    getTenantBytes()
    * Tenant code for the requested operation, always required.
    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.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static DataWriteRequest.Builder
    newBuilder()
     
    static DataWriteRequest.Builder
    newBuilder(DataWriteRequest prototype)
     
    DataWriteRequest.Builder
    newBuilderForType()
     
    protected DataWriteRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static DataWriteRequest
    parseDelimitedFrom(InputStream input)
     
    static DataWriteRequest
    parseDelimitedFrom(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(InputStream input)
     
    static DataWriteRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DataWriteRequest
    parseFrom(ByteBuffer data)
     
    static DataWriteRequest
    parseFrom(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.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    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, getUnknownFields, hasField, hasOneof

  • Field Details

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getSchemaSpecifierCase

      public DataWriteRequest.SchemaSpecifierCase getSchemaSpecifierCase()
      Specified by:
      getSchemaSpecifierCase in interface DataWriteRequestOrBuilder

    • getTenant

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

    • parseFrom

      public static DataWriteRequest parseFrom(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static DataWriteRequest.Builder newBuilder()

    • newBuilder

      public static DataWriteRequest.Builder newBuilder(DataWriteRequest prototype)

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

    • getDefaultInstance

      public static DataWriteRequest getDefaultInstance()

    • parser

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

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

    • getDefaultInstanceForType

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