Package org.finos.tracdap.api

Class MetadataWriteRequest

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, MetadataWriteRequestOrBuilder
    public final class MetadataWriteRequest
extends com.google.protobuf.GeneratedMessageV3
implements MetadataWriteRequestOrBuilder
    
 Request to create or update an object in the TRAC metadata store.
 @see TracMetadataApi
    Protobuf type tracdap.api.MetadataWriteRequest
    See Also:
    Serialized Form

    • Nested Class Summary

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

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getTenant

        public java.lang.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 java.util.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 java.util.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.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(java.lang.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​(java.nio.ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MetadataWriteRequest parseFrom​(java.nio.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​(java.io.InputStream input)
                                      throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • parseDelimitedFrom

        public static MetadataWriteRequest parseDelimitedFrom​(java.io.InputStream input)
                                               throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • 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.GeneratedMessageV3

      • getDefaultInstanceForType

        public MetadataWriteRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder