Package org.finos.tracdap.api

Interface MetadataWriteRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    org.finos.tracdap.metadata.ObjectDefinition
    getDefinition()
    * New object definition to save.
    org.finos.tracdap.metadata.ObjectDefinitionOrBuilder
    getDefinitionOrBuilder()
    * New object definition to save.
    org.finos.tracdap.metadata.ObjectType
    getObjectType()
    * Object type for the requested operation, always required.
    int
    getObjectTypeValue()
    * Object type for the requested operation, always required.
    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.TagUpdate
    getTagUpdates(int index)
    * Tag update operations to be applied.
    int
    getTagUpdatesCount()
    * Tag update operations to be applied.
    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.
    List<? extends org.finos.tracdap.metadata.TagUpdateOrBuilder>
    getTagUpdatesOrBuilderList()
    * Tag update operations to be applied.
    String
    getTenant()
    * Tenant code for the requested operation, always required.
    com.google.protobuf.ByteString
    getTenantBytes()
    * Tenant code for the requested operation, always required.
    boolean
    hasDefinition()
    * New object definition to save.
    boolean
    hasPriorVersion()
    * Prior object/tag version to use for update operations.

    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.

    • getObjectTypeValue

      int getObjectTypeValue()
       *
 Object type for the requested operation, always required.
      .tracdap.metadata.ObjectType objectType = 2;
      Returns:
      The enum numeric value on the wire for objectType.

    • getObjectType

      org.finos.tracdap.metadata.ObjectType getObjectType()
       *
 Object type for the requested operation, always required.
      .tracdap.metadata.ObjectType objectType = 2;
      Returns:
      The objectType.

    • hasPriorVersion

      boolean hasPriorVersion()
       *
 Prior object/tag version to use for update operations.

 This field should be omitted when creating a new object.
      optional .tracdap.metadata.TagSelector priorVersion = 3;
      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 object.
      optional .tracdap.metadata.TagSelector priorVersion = 3;
      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 object.
      optional .tracdap.metadata.TagSelector priorVersion = 3;

    • hasDefinition

      boolean hasDefinition()
       *
 New object definition to save.

 A definition is required to create or update an object, for tag updates
 the definition field should be left blank.

 This field should be omitted for tag update operations.
      optional .tracdap.metadata.ObjectDefinition definition = 4;
      Returns:
      Whether the definition field is set.

    • getDefinition

      org.finos.tracdap.metadata.ObjectDefinition getDefinition()
       *
 New object definition to save.

 A definition is required to create or update an object, for tag updates
 the definition field should be left blank.

 This field should be omitted for tag update operations.
      optional .tracdap.metadata.ObjectDefinition definition = 4;
      Returns:
      The definition.

    • getDefinitionOrBuilder

      org.finos.tracdap.metadata.ObjectDefinitionOrBuilder getDefinitionOrBuilder()
       *
 New object definition to save.

 A definition is required to create or update an object, for tag updates
 the definition field should be left blank.

 This field should be omitted for tag update operations.
      optional .tracdap.metadata.ObjectDefinition definition = 4;

    • getTagUpdatesList

      List<org.finos.tracdap.metadata.TagUpdate> getTagUpdatesList()
       *
 Tag update operations to be applied.

 The updates are applied in order and must all succeeded in order for the
 request to be successful. If the API call fails for any reason, none of
 the requested tag updates will be applied.
      repeated .tracdap.metadata.TagUpdate tagUpdates = 5;

    • getTagUpdates

      org.finos.tracdap.metadata.TagUpdate getTagUpdates(int index)
       *
 Tag update operations to be applied.

 The updates are applied in order and must all succeeded in order for the
 request to be successful. If the API call fails for any reason, none of
 the requested tag updates will be applied.
      repeated .tracdap.metadata.TagUpdate tagUpdates = 5;

    • getTagUpdatesCount

      int getTagUpdatesCount()
       *
 Tag update operations to be applied.

 The updates are applied in order and must all succeeded in order for the
 request to be successful. If the API call fails for any reason, none of
 the requested tag updates will be applied.
      repeated .tracdap.metadata.TagUpdate tagUpdates = 5;

    • getTagUpdatesOrBuilderList

      List<? extends org.finos.tracdap.metadata.TagUpdateOrBuilder> getTagUpdatesOrBuilderList()
       *
 Tag update operations to be applied.

 The updates are applied in order and must all succeeded in order for the
 request to be successful. If the API call fails for any reason, none of
 the requested tag updates will be applied.
      repeated .tracdap.metadata.TagUpdate tagUpdates = 5;

    • getTagUpdatesOrBuilder

      org.finos.tracdap.metadata.TagUpdateOrBuilder getTagUpdatesOrBuilder(int index)
       *
 Tag update operations to be applied.

 The updates are applied in order and must all succeeded in order for the
 request to be successful. If the API call fails for any reason, none of
 the requested tag updates will be applied.
      repeated .tracdap.metadata.TagUpdate tagUpdates = 5;