Package org.finos.tracdap.api

Class FileWriteRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
org.finos.tracdap.api.FileWriteRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, FileWriteRequestOrBuilder
public final class FileWriteRequest extends com.google.protobuf.GeneratedMessage implements FileWriteRequestOrBuilder
 *
 Request to create or update a FILE and store content to the platform.

 @see TracDataApi.createFile
 @see TracDataApi.updateFile
Protobuf type tracdap.api.FileWriteRequest
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    FileWriteRequest.Builder
    * Request to create or update a FILE and store content to the platform.

    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
    MIMETYPE_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    PRIORVERSION_FIELD_NUMBER
     
    static final int
    SIZE_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()
    * 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.
    static FileWriteRequest
    getDefaultInstance()
     
    FileWriteRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.
    com.google.protobuf.Parser<FileWriteRequest>
    getParserForType()
     
    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.
    int
    getSerializedSize()
     
    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
    int
    hashCode()
     
    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.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static FileWriteRequest.Builder
    newBuilder()
     
    static FileWriteRequest.Builder
    newBuilder(FileWriteRequest prototype)
     
    FileWriteRequest.Builder
    newBuilderForType()
     
    protected FileWriteRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static FileWriteRequest
    parseDelimitedFrom(InputStream input)
     
    static FileWriteRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FileWriteRequest
    parseFrom(byte[] data)
     
    static FileWriteRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FileWriteRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static FileWriteRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FileWriteRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static FileWriteRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FileWriteRequest
    parseFrom(InputStream input)
     
    static FileWriteRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FileWriteRequest
    parseFrom(ByteBuffer data)
     
    static FileWriteRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<FileWriteRequest>
    parser()
     
    FileWriteRequest.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

    • getTenant

      public String getTenant()
       *
 Tenant code for the requested operation, always required
      string tenant = 1;
      Specified by:
      getTenant in interface FileWriteRequestOrBuilder
      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 FileWriteRequestOrBuilder
      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 file.
      optional .tracdap.metadata.TagSelector priorVersion = 2;
      Specified by:
      hasPriorVersion in interface FileWriteRequestOrBuilder
      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 file.
      optional .tracdap.metadata.TagSelector priorVersion = 2;
      Specified by:
      getPriorVersion in interface FileWriteRequestOrBuilder
      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 file.
      optional .tracdap.metadata.TagSelector priorVersion = 2;
      Specified by:
      getPriorVersionOrBuilder in interface FileWriteRequestOrBuilder

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

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

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

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

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

    • getName

      public 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;
      Specified by:
      getName in interface FileWriteRequestOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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;
      Specified by:
      getNameBytes in interface FileWriteRequestOrBuilder
      Returns:
      The bytes for name.

    • getMimeType

      public 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;
      Specified by:
      getMimeType in interface FileWriteRequestOrBuilder
      Returns:
      The mimeType.

    • getMimeTypeBytes

      public 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;
      Specified by:
      getMimeTypeBytes in interface FileWriteRequestOrBuilder
      Returns:
      The bytes for mimeType.

    • hasSize

      public 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;
      Specified by:
      hasSize in interface FileWriteRequestOrBuilder
      Returns:
      Whether the size field is set.

    • getSize

      public 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;
      Specified by:
      getSize in interface FileWriteRequestOrBuilder
      Returns:
      The size.

    • getContent

      public 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;
      Specified by:
      getContent in interface FileWriteRequestOrBuilder
      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 FileWriteRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FileWriteRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static FileWriteRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static FileWriteRequest.Builder newBuilder()

    • newBuilder

      public static FileWriteRequest.Builder newBuilder(FileWriteRequest prototype)

    • toBuilder

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

    • newBuilderForType

      protected FileWriteRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static FileWriteRequest getDefaultInstance()

    • parser

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

    • getParserForType

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