Package org.finos.tracdap.api

Interface DataWriteRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    DataWriteRequest, DataWriteRequest.Builder
    public interface DataWriteRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.google.protobuf.ByteString getContent()
      The content of the dataset, encoded as per the "format" field.
      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.
      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()  
      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.
      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.

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

        isInitialized

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

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

    • Method Detail

      • getTenant

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

      • getTenantBytes

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

      • hasPriorVersion

        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;
        Returns:
        Whether the priorVersion field is set.

      • getPriorVersion

        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;
        Returns:
        The priorVersion.

      • getPriorVersionOrBuilder

        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;

      • getTagUpdatesList

        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;

      • getTagUpdates

        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;

      • getTagUpdatesCount

        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;

      • getTagUpdatesOrBuilderList

        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;

      • getTagUpdatesOrBuilder

        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;

      • hasSchemaId

        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;
        Returns:
        Whether the schemaId field is set.

      • getSchemaId

        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;
        Returns:
        The schemaId.

      • getSchemaIdOrBuilder

        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;

      • hasSchema

        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;
        Returns:
        Whether the schema field is set.

      • getSchema

        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;
        Returns:
        The schema.

      • getSchemaOrBuilder

        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;

      • getFormat

        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;
        Returns:
        The format.

      • getFormatBytes

        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;
        Returns:
        The bytes for format.

      • getContent

        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;
        Returns:
        The content.