org.finos.tracdap.api.FileWriteRequestOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tracdap-api-services Show documentation
Show all versions of tracdap-api-services Show documentation
TRAC D.A.P. platform API, contains service API definitions for the TRAC platform services
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: tracdap/api/data.proto
// Protobuf Java Version: 3.25.3
package org.finos.tracdap.api;
public interface FileWriteRequestOrBuilder extends
// @@protoc_insertion_point(interface_extends:tracdap.api.FileWriteRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
**
* Tenant code for the requested operation, always required
*
*
* string tenant = 1;
* @return The tenant.
*/
java.lang.String getTenant();
/**
*
**
* Tenant code for the requested operation, always required
*
*
* string tenant = 1;
* @return The bytes for tenant.
*/
com.google.protobuf.ByteString
getTenantBytes();
/**
*
**
* 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;
* @return Whether the priorVersion field is set.
*/
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;
* @return The priorVersion.
*/
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;
*/
org.finos.tracdap.metadata.TagSelectorOrBuilder getPriorVersionOrBuilder();
/**
*
**
* 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;
*/
java.util.List
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;
*/
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;
*/
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;
*/
java.util.List
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;
*/
org.finos.tracdap.metadata.TagUpdateOrBuilder getTagUpdatesOrBuilder(
int index);
/**
*
**
* 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;
* @return The name.
*/
java.lang.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;
* @return The bytes for name.
*/
com.google.protobuf.ByteString
getNameBytes();
/**
*
**
* 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;
* @return The mimeType.
*/
java.lang.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;
* @return The bytes for mimeType.
*/
com.google.protobuf.ByteString
getMimeTypeBytes();
/**
*
**
* 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;
* @return Whether the size field is set.
*/
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;
* @return The size.
*/
long getSize();
/**
*
**
* 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;
* @return The content.
*/
com.google.protobuf.ByteString getContent();
}