Class DownloadRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.soulfiremc.grpc.generated.DownloadRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, DownloadRequestOrBuilder, Serializable
@Generated public final class DownloadRequest extends com.google.protobuf.GeneratedMessage implements DownloadRequestOrBuilder
Request message for downloading content from a URL through the SoulFire server.
This allows clients to fetch remote resources using the server's network connection,
optionally through a proxy, which is useful for accessing resources that may be
blocked or rate-limited from the client's network.
Protobuf type soulfire.v1.DownloadRequest
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    DownloadRequest.Builder
    Request message for downloading content from a URL through the SoulFire server.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT, 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
    HEADERS_FIELD_NUMBER
     
    static final int
    INSTANCE_ID_FIELD_NUMBER
     
    static final int
    PROXY_FIELD_NUMBER
     
    static final int
    URI_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, 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 DownloadRequest
    getDefaultInstance()
     
    DownloadRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    HeaderPair
    getHeaders(int index)
    Optional HTTP headers to include in the request to the target server.
    int
    getHeadersCount()
    Optional HTTP headers to include in the request to the target server.
    List<HeaderPair>
    getHeadersList()
    Optional HTTP headers to include in the request to the target server.
    HeaderPairOrBuilder
    getHeadersOrBuilder(int index)
    Optional HTTP headers to include in the request to the target server.
    List<? extends HeaderPairOrBuilder>
    getHeadersOrBuilderList()
    Optional HTTP headers to include in the request to the target server.
    String
    getInstanceId()
    The UUID of the SoulFire instance to associate this download with.
    com.google.protobuf.ByteString
    getInstanceIdBytes()
    The UUID of the SoulFire instance to associate this download with.
    com.google.protobuf.Parser<DownloadRequest>
    getParserForType()
     
    ProxyProto
    getProxy()
    Optional proxy configuration for the download request.
    ProxyProtoOrBuilder
    getProxyOrBuilder()
    Optional proxy configuration for the download request.
    int
    getSerializedSize()
     
    String
    getUri()
    The URI to download content from.
    com.google.protobuf.ByteString
    getUriBytes()
    The URI to download content from.
    int
    hashCode()
     
    boolean
    hasProxy()
    Optional proxy configuration for the download request.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static DownloadRequest.Builder
    newBuilder()
     
    static DownloadRequest.Builder
    newBuilder(DownloadRequest prototype)
     
    DownloadRequest.Builder
    newBuilderForType()
     
    protected DownloadRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static DownloadRequest
    parseDelimitedFrom(InputStream input)
     
    static DownloadRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DownloadRequest
    parseFrom(byte[] data)
     
    static DownloadRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DownloadRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static DownloadRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DownloadRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static DownloadRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DownloadRequest
    parseFrom(InputStream input)
     
    static DownloadRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DownloadRequest
    parseFrom(ByteBuffer data)
     
    static DownloadRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<DownloadRequest>
    parser()
     
    DownloadRequest.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, makeExtensionsImmutable, 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 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

  • 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

    • getInstanceId

      public String getInstanceId()
      The UUID of the SoulFire instance to associate this download with.
Used for permission checking - the caller must have DOWNLOAD_URL permission
for this instance. Must be a valid UUID string (e.g., "550e8400-e29b-41d4-a716-446655440000").
      string instance_id = 1;
      Specified by:
      getInstanceId in interface DownloadRequestOrBuilder
      Returns:
      The instanceId.

    • getInstanceIdBytes

      public com.google.protobuf.ByteString getInstanceIdBytes()
      The UUID of the SoulFire instance to associate this download with.
Used for permission checking - the caller must have DOWNLOAD_URL permission
for this instance. Must be a valid UUID string (e.g., "550e8400-e29b-41d4-a716-446655440000").
      string instance_id = 1;
      Specified by:
      getInstanceIdBytes in interface DownloadRequestOrBuilder
      Returns:
      The bytes for instanceId.

    • getUri

      public String getUri()
      The URI to download content from. Must be a valid, fully-formed URI
(e.g., "https://example.com/resource.json"). The server will make an HTTP GET
request to this URI.
      string uri = 2;
      Specified by:
      getUri in interface DownloadRequestOrBuilder
      Returns:
      The uri.

    • getUriBytes

      public com.google.protobuf.ByteString getUriBytes()
      The URI to download content from. Must be a valid, fully-formed URI
(e.g., "https://example.com/resource.json"). The server will make an HTTP GET
request to this URI.
      string uri = 2;
      Specified by:
      getUriBytes in interface DownloadRequestOrBuilder
      Returns:
      The bytes for uri.

    • getHeadersList

      public List<HeaderPair> getHeadersList()
      Optional HTTP headers to include in the request to the target server.
These headers are added on top of the default headers set by the server
(Accept, Accept-Language, User-Agent). Custom headers can override defaults.
      repeated .soulfire.v1.HeaderPair headers = 3;
      Specified by:
      getHeadersList in interface DownloadRequestOrBuilder

    • getHeadersOrBuilderList

      public List<? extends HeaderPairOrBuilder> getHeadersOrBuilderList()
      Optional HTTP headers to include in the request to the target server.
These headers are added on top of the default headers set by the server
(Accept, Accept-Language, User-Agent). Custom headers can override defaults.
      repeated .soulfire.v1.HeaderPair headers = 3;
      Specified by:
      getHeadersOrBuilderList in interface DownloadRequestOrBuilder

    • getHeadersCount

      public int getHeadersCount()
      Optional HTTP headers to include in the request to the target server.
These headers are added on top of the default headers set by the server
(Accept, Accept-Language, User-Agent). Custom headers can override defaults.
      repeated .soulfire.v1.HeaderPair headers = 3;
      Specified by:
      getHeadersCount in interface DownloadRequestOrBuilder

    • getHeaders

      public HeaderPair getHeaders(int index)
      Optional HTTP headers to include in the request to the target server.
These headers are added on top of the default headers set by the server
(Accept, Accept-Language, User-Agent). Custom headers can override defaults.
      repeated .soulfire.v1.HeaderPair headers = 3;
      Specified by:
      getHeaders in interface DownloadRequestOrBuilder

    • getHeadersOrBuilder

      public HeaderPairOrBuilder getHeadersOrBuilder(int index)
      Optional HTTP headers to include in the request to the target server.
These headers are added on top of the default headers set by the server
(Accept, Accept-Language, User-Agent). Custom headers can override defaults.
      repeated .soulfire.v1.HeaderPair headers = 3;
      Specified by:
      getHeadersOrBuilder in interface DownloadRequestOrBuilder

    • hasProxy

      public boolean hasProxy()
      Optional proxy configuration for the download request.
If not provided, the request will be made directly from the server.
Supports HTTP, SOCKS4, and SOCKS5 proxies with optional authentication.
      optional .soulfire.v1.ProxyProto proxy = 4;
      Specified by:
      hasProxy in interface DownloadRequestOrBuilder
      Returns:
      Whether the proxy field is set.

    • getProxy

      public ProxyProto getProxy()
      Optional proxy configuration for the download request.
If not provided, the request will be made directly from the server.
Supports HTTP, SOCKS4, and SOCKS5 proxies with optional authentication.
      optional .soulfire.v1.ProxyProto proxy = 4;
      Specified by:
      getProxy in interface DownloadRequestOrBuilder
      Returns:
      The proxy.

    • getProxyOrBuilder

      public ProxyProtoOrBuilder getProxyOrBuilder()
      Optional proxy configuration for the download request.
If not provided, the request will be made directly from the server.
Supports HTTP, SOCKS4, and SOCKS5 proxies with optional authentication.
      optional .soulfire.v1.ProxyProto proxy = 4;
      Specified by:
      getProxyOrBuilder in interface DownloadRequestOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static DownloadRequest.Builder newBuilder()

    • newBuilder

      public static DownloadRequest.Builder newBuilder(DownloadRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static DownloadRequest getDefaultInstance()

    • parser

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

    • getParserForType

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