Package org.finos.tracdap.api

Interface FileWriteRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
FileWriteRequest, FileWriteRequest.Builder
public interface FileWriteRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.ByteString
    getContent()
    * A chunk of the file content The file content should be sent as a stream of chunks (byte buffers), with one chunk in each message.
    String
    getMimeType()
    * Mime type of the file being saved, always required Must be a valid mime type.
    com.google.protobuf.ByteString
    getMimeTypeBytes()
    * Mime type of the file being saved, always required Must be a valid mime type.
    String
    getName()
    * File name of the file being saved, always required Must be a valid file name with no path component (i.e.
    com.google.protobuf.ByteString
    getNameBytes()
    * File name of the file being saved, always required Must be a valid file name with no path component (i.e.
    org.finos.tracdap.metadata.TagSelector
    getPriorVersion()
    * Prior object/tag version to use for update operations This field should be omitted when creating a new file.
    org.finos.tracdap.metadata.TagSelectorOrBuilder
    getPriorVersionOrBuilder()
    * Prior object/tag version to use for update operations This field should be omitted when creating a new file.
    long
    getSize()
    * Size of the file being saved, if known in advance When a size is supplied, TRAC will check the size against the number of bytes stored.
    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.
    int
    getTagUpdatesCount()
    * Tag update operations to be applied Tag updates are applied in exactly the same way as for metadata write requests.
    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.
    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.
    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.
    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 This field should be omitted when creating a new file.
    boolean
    hasSize()
    * Size of the file being saved, if known in advance When a size is supplied, TRAC will check the size against the number of bytes stored.

    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 Details

    • getTenant

      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 file.
      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 file.
      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 file.
      optional .tracdap.metadata.TagSelector priorVersion = 2;

    • getTagUpdatesList

      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

      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;

    • getName

      String getName()
       *
 File name of the file being saved, always required

 Must be a valid file name with no path component (i.e. the name may not contain slashes).

 If the name contains a period character, the file extension will be set as the
 portion of the name following the last period. Otherwise the file extension will be blank.

 For update requests the name may change but the extension must stay the same. E.g. a file
 can be created as "my_file_v1.txt" and updated as "my_file_v2.txt", but updating with the
 name as "my_file_v1.doc" would not be allowed. Attempting to change the extension in an
 update will result in an error status of FAILED_PRECONDITION.

 Fle name and extension are stored in the file definition, and in the trac_file_name
 and trac_file_extension attributes.
      string name = 4;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       *
 File name of the file being saved, always required

 Must be a valid file name with no path component (i.e. the name may not contain slashes).

 If the name contains a period character, the file extension will be set as the
 portion of the name following the last period. Otherwise the file extension will be blank.

 For update requests the name may change but the extension must stay the same. E.g. a file
 can be created as "my_file_v1.txt" and updated as "my_file_v2.txt", but updating with the
 name as "my_file_v1.doc" would not be allowed. Attempting to change the extension in an
 update will result in an error status of FAILED_PRECONDITION.

 Fle name and extension are stored in the file definition, and in the trac_file_name
 and trac_file_extension attributes.
      string name = 4;
      Returns:
      The bytes for name.

    • getMimeType

      String getMimeType()
       *
 Mime type of the file being saved, always required

 Must be a valid mime type. For update requests, the mime type must match exactly
 with the mime type supplied when the file was originally created. Attempting to change
 the mime type in an update will result in an error status of FAILED_PRECONDITION.

 Mime type is stored in the file definition and in the trac_file_mime_type attribute.
      string mimeType = 5;
      Returns:
      The mimeType.

    • getMimeTypeBytes

      com.google.protobuf.ByteString getMimeTypeBytes()
       *
 Mime type of the file being saved, always required

 Must be a valid mime type. For update requests, the mime type must match exactly
 with the mime type supplied when the file was originally created. Attempting to change
 the mime type in an update will result in an error status of FAILED_PRECONDITION.

 Mime type is stored in the file definition and in the trac_file_mime_type attribute.
      string mimeType = 5;
      Returns:
      The bytes for mimeType.

    • hasSize

      boolean hasSize()
       *
 Size of the file being saved, if known in advance

 When a size is supplied, TRAC will check the size against the number of bytes stored.
 If the stored file size does not match the supplied value, the error will be reported
 with an error status of DATA_LOSS. When no size is supplied the check cannot be performed.

 File size is stored in the created file definition and in the trac_file_size attribute.
      optional uint64 size = 6;
      Returns:
      Whether the size field is set.

    • getSize

      long getSize()
       *
 Size of the file being saved, if known in advance

 When a size is supplied, TRAC will check the size against the number of bytes stored.
 If the stored file size does not match the supplied value, the error will be reported
 with an error status of DATA_LOSS. When no size is supplied the check cannot be performed.

 File size is stored in the created file definition and in the trac_file_size attribute.
      optional uint64 size = 6;
      Returns:
      The size.

    • getContent

      com.google.protobuf.ByteString getContent()
       *
 A chunk of the file content

 The file content should be sent as a stream of chunks (byte buffers), with one chunk in each message.
 Empty chunks can be included at any point in the request stream and will be ignored.
      bytes content = 1000;
      Returns:
      The content.