Package org.finos.tracdap.api

Class MetadataWriteRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
org.finos.tracdap.api.MetadataWriteRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, MetadataWriteRequestOrBuilder
public final class MetadataWriteRequest extends com.google.protobuf.GeneratedMessage implements MetadataWriteRequestOrBuilder
 *
 Request to create or update an object in the TRAC metadata store.

 @see TracMetadataApi
Protobuf type tracdap.api.MetadataWriteRequest
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    MetadataWriteRequest.Builder
    * Request to create or update an object in the TRAC metadata store.

    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
    DEFINITION_FIELD_NUMBER
     
    static final int
    OBJECTTYPE_FIELD_NUMBER
     
    static final int
    PRIORVERSION_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)
     
    static MetadataWriteRequest
    getDefaultInstance()
     
    MetadataWriteRequest
    getDefaultInstanceForType()
     
    org.finos.tracdap.metadata.ObjectDefinition
    getDefinition()
    * New object definition to save.
    org.finos.tracdap.metadata.ObjectDefinitionOrBuilder
    getDefinitionOrBuilder()
    * New object definition to save.
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    org.finos.tracdap.metadata.ObjectType
    getObjectType()
    * Object type for the requested operation, always required.
    int
    getObjectTypeValue()
    * Object type for the requested operation, always required.
    com.google.protobuf.Parser<MetadataWriteRequest>
    getParserForType()
     
    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.
    int
    getSerializedSize()
     
    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.
    int
    hashCode()
     
    boolean
    hasPriorVersion()
    * Prior object/tag version to use for update operations.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static MetadataWriteRequest.Builder
    newBuilder()
     
    static MetadataWriteRequest.Builder
    newBuilder(MetadataWriteRequest prototype)
     
    MetadataWriteRequest.Builder
    newBuilderForType()
     
    protected MetadataWriteRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static MetadataWriteRequest
    parseDelimitedFrom(InputStream input)
     
    static MetadataWriteRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MetadataWriteRequest
    parseFrom(byte[] data)
     
    static MetadataWriteRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MetadataWriteRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static MetadataWriteRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MetadataWriteRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static MetadataWriteRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MetadataWriteRequest
    parseFrom(InputStream input)
     
    static MetadataWriteRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MetadataWriteRequest
    parseFrom(ByteBuffer data)
     
    static MetadataWriteRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<MetadataWriteRequest>
    parser()
     
    MetadataWriteRequest.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

    • TENANT_FIELD_NUMBER

      public static final int TENANT_FIELD_NUMBER
      See Also:

    • OBJECTTYPE_FIELD_NUMBER

      public static final int OBJECTTYPE_FIELD_NUMBER
      See Also:

    • PRIORVERSION_FIELD_NUMBER

      public static final int PRIORVERSION_FIELD_NUMBER
      See Also:

    • DEFINITION_FIELD_NUMBER

      public static final int DEFINITION_FIELD_NUMBER
      See Also:

    • TAGUPDATES_FIELD_NUMBER

      public static final int TAGUPDATES_FIELD_NUMBER
      See Also:

  • 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 MetadataWriteRequestOrBuilder
      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 MetadataWriteRequestOrBuilder
      Returns:
      The bytes for tenant.

    • getObjectTypeValue

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

    • getObjectType

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

    • hasPriorVersion

      public 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;
      Specified by:
      hasPriorVersion in interface MetadataWriteRequestOrBuilder
      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 object.
      optional .tracdap.metadata.TagSelector priorVersion = 3;
      Specified by:
      getPriorVersion in interface MetadataWriteRequestOrBuilder
      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 object.
      optional .tracdap.metadata.TagSelector priorVersion = 3;
      Specified by:
      getPriorVersionOrBuilder in interface MetadataWriteRequestOrBuilder

    • hasDefinition

      public 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;
      Specified by:
      hasDefinition in interface MetadataWriteRequestOrBuilder
      Returns:
      Whether the definition field is set.

    • getDefinition

      public 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;
      Specified by:
      getDefinition in interface MetadataWriteRequestOrBuilder
      Returns:
      The definition.

    • getDefinitionOrBuilder

      public 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;
      Specified by:
      getDefinitionOrBuilder in interface MetadataWriteRequestOrBuilder

    • getTagUpdatesList

      public 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;
      Specified by:
      getTagUpdatesList in interface MetadataWriteRequestOrBuilder

    • getTagUpdatesOrBuilderList

      public 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;
      Specified by:
      getTagUpdatesOrBuilderList in interface MetadataWriteRequestOrBuilder

    • getTagUpdatesCount

      public 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;
      Specified by:
      getTagUpdatesCount in interface MetadataWriteRequestOrBuilder

    • getTagUpdates

      public 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;
      Specified by:
      getTagUpdates in interface MetadataWriteRequestOrBuilder

    • getTagUpdatesOrBuilder

      public 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;
      Specified by:
      getTagUpdatesOrBuilder in interface MetadataWriteRequestOrBuilder

    • 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 MetadataWriteRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static MetadataWriteRequest.Builder newBuilder()

    • newBuilder

      public static MetadataWriteRequest.Builder newBuilder(MetadataWriteRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static MetadataWriteRequest getDefaultInstance()

    • parser

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

    • getParserForType

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