Package org.finos.tracdap.api

Class FileReadResponse.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<FileReadResponse.Builder>
com.google.protobuf.GeneratedMessage.Builder<FileReadResponse.Builder>
org.finos.tracdap.api.FileReadResponse.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, FileReadResponseOrBuilder
Enclosing class:
FileReadResponse
public static final class FileReadResponse.Builder extends com.google.protobuf.GeneratedMessage.Builder<FileReadResponse.Builder> implements FileReadResponseOrBuilder
 *
 Response to a request to read a FILE, i.e. retrieve its content from the platform.

 @see TracDataApi.readFile
Protobuf type tracdap.api.FileReadResponse

  • Method Summary

    Modifier and Type
    Method
    Description
    FileReadResponse
    build()
     
    FileReadResponse
    buildPartial()
     
    FileReadResponse.Builder
    clear()
     
    FileReadResponse.Builder
    clearContent()
    * A chunk of the file content The file content will be sent as a stream of chunks (byte buffers), with one chunk in each message.
    FileReadResponse.Builder
    clearFileDefinition()
    * Definition of the FILE being read
    com.google.protobuf.ByteString
    getContent()
    * A chunk of the file content The file content will be sent as a stream of chunks (byte buffers), with one chunk in each message.
    FileReadResponse
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    org.finos.tracdap.metadata.FileDefinition
    getFileDefinition()
    * Definition of the FILE being read
    org.finos.tracdap.metadata.FileDefinition.Builder
    getFileDefinitionBuilder()
    * Definition of the FILE being read
    org.finos.tracdap.metadata.FileDefinitionOrBuilder
    getFileDefinitionOrBuilder()
    * Definition of the FILE being read
    boolean
    hasFileDefinition()
    * Definition of the FILE being read
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    FileReadResponse.Builder
    mergeFileDefinition(org.finos.tracdap.metadata.FileDefinition value)
    * Definition of the FILE being read
    FileReadResponse.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    FileReadResponse.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    FileReadResponse.Builder
    mergeFrom(FileReadResponse other)
     
    FileReadResponse.Builder
    setContent(com.google.protobuf.ByteString value)
    * A chunk of the file content The file content will be sent as a stream of chunks (byte buffers), with one chunk in each message.
    FileReadResponse.Builder
    setFileDefinition(org.finos.tracdap.metadata.FileDefinition value)
    * Definition of the FILE being read
    FileReadResponse.Builder
    setFileDefinition(org.finos.tracdap.metadata.FileDefinition.Builder builderForValue)
    * Definition of the FILE being read

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • 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.Builder<FileReadResponse.Builder>

    • clear

      public FileReadResponse.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<FileReadResponse.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<FileReadResponse.Builder>

    • getDefaultInstanceForType

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

    • build

      public FileReadResponse build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public FileReadResponse buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public FileReadResponse.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FileReadResponse.Builder>

    • mergeFrom

      public FileReadResponse.Builder mergeFrom(FileReadResponse other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<FileReadResponse.Builder>

    • mergeFrom

      public FileReadResponse.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FileReadResponse.Builder>
      Throws:
      IOException

    • hasFileDefinition

      public boolean hasFileDefinition()
       *
 Definition of the FILE being read
      optional .tracdap.metadata.FileDefinition fileDefinition = 1;
      Specified by:
      hasFileDefinition in interface FileReadResponseOrBuilder
      Returns:
      Whether the fileDefinition field is set.

    • getFileDefinition

      public org.finos.tracdap.metadata.FileDefinition getFileDefinition()
       *
 Definition of the FILE being read
      optional .tracdap.metadata.FileDefinition fileDefinition = 1;
      Specified by:
      getFileDefinition in interface FileReadResponseOrBuilder
      Returns:
      The fileDefinition.

    • setFileDefinition

      public FileReadResponse.Builder setFileDefinition(org.finos.tracdap.metadata.FileDefinition value)
       *
 Definition of the FILE being read
      optional .tracdap.metadata.FileDefinition fileDefinition = 1;

    • setFileDefinition

      public FileReadResponse.Builder setFileDefinition(org.finos.tracdap.metadata.FileDefinition.Builder builderForValue)
       *
 Definition of the FILE being read
      optional .tracdap.metadata.FileDefinition fileDefinition = 1;

    • mergeFileDefinition

      public FileReadResponse.Builder mergeFileDefinition(org.finos.tracdap.metadata.FileDefinition value)
       *
 Definition of the FILE being read
      optional .tracdap.metadata.FileDefinition fileDefinition = 1;

    • clearFileDefinition

      public FileReadResponse.Builder clearFileDefinition()
       *
 Definition of the FILE being read
      optional .tracdap.metadata.FileDefinition fileDefinition = 1;

    • getFileDefinitionBuilder

      public org.finos.tracdap.metadata.FileDefinition.Builder getFileDefinitionBuilder()
       *
 Definition of the FILE being read
      optional .tracdap.metadata.FileDefinition fileDefinition = 1;

    • getFileDefinitionOrBuilder

      public org.finos.tracdap.metadata.FileDefinitionOrBuilder getFileDefinitionOrBuilder()
       *
 Definition of the FILE being read
      optional .tracdap.metadata.FileDefinition fileDefinition = 1;
      Specified by:
      getFileDefinitionOrBuilder in interface FileReadResponseOrBuilder

    • getContent

      public com.google.protobuf.ByteString getContent()
       *
 A chunk of the file content

 The file content will be sent as a stream of chunks (byte buffers), with one chunk in each message.
 Empty chunks may be included at any point in the response stream and should be ignored.
 In particular, TRAC guarantees that the chunk in the first message will always be an empty chunk.
      bytes content = 1000;
      Specified by:
      getContent in interface FileReadResponseOrBuilder
      Returns:
      The content.

    • setContent

      public FileReadResponse.Builder setContent(com.google.protobuf.ByteString value)
       *
 A chunk of the file content

 The file content will be sent as a stream of chunks (byte buffers), with one chunk in each message.
 Empty chunks may be included at any point in the response stream and should be ignored.
 In particular, TRAC guarantees that the chunk in the first message will always be an empty chunk.
      bytes content = 1000;
      Parameters:
      value - The content to set.
      Returns:
      This builder for chaining.

    • clearContent

      public FileReadResponse.Builder clearContent()
       *
 A chunk of the file content

 The file content will be sent as a stream of chunks (byte buffers), with one chunk in each message.
 Empty chunks may be included at any point in the response stream and should be ignored.
 In particular, TRAC guarantees that the chunk in the first message will always be an empty chunk.
      bytes content = 1000;
      Returns:
      This builder for chaining.