org.finos.tracdap.api.DataWriteRequestOrBuilder 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 DataWriteRequestOrBuilder extends
// @@protoc_insertion_point(interface_extends:tracdap.api.DataWriteRequest)
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 dataset.
*
*
* 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 dataset.
*
*
* 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 dataset.
*
*
* 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);
/**
*
**
* 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;
* @return Whether the schemaId field is set.
*/
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;
* @return The schemaId.
*/
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;
*/
org.finos.tracdap.metadata.TagSelectorOrBuilder getSchemaIdOrBuilder();
/**
*
**
* 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;
* @return Whether the schema field is set.
*/
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;
* @return The schema.
*/
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;
*/
org.finos.tracdap.metadata.SchemaDefinitionOrBuilder getSchemaOrBuilder();
/**
*
**
* 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;
* @return The format.
*/
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;
* @return The bytes for format.
*/
com.google.protobuf.ByteString
getFormatBytes();
/**
*
**
* 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;
* @return The content.
*/
com.google.protobuf.ByteString getContent();
org.finos.tracdap.api.DataWriteRequest.SchemaSpecifierCase getSchemaSpecifierCase();
}