Class DownloadRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<DownloadRequest.Builder>
com.google.protobuf.GeneratedMessage.Builder<DownloadRequest.Builder>
com.soulfiremc.grpc.generated.DownloadRequest.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, DownloadRequestOrBuilder, Cloneable
Enclosing class:
DownloadRequest
public static final class DownloadRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<DownloadRequest.Builder> 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

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

    • clear

      public DownloadRequest.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<DownloadRequest.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<DownloadRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public DownloadRequest.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<DownloadRequest.Builder>

    • mergeFrom

      public DownloadRequest.Builder mergeFrom(DownloadRequest other)

    • isInitialized

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

    • mergeFrom

      public DownloadRequest.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<DownloadRequest.Builder>
      Throws:
      IOException

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

    • setInstanceId

      public DownloadRequest.Builder setInstanceId(String value)
      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;
      Parameters:
      value - The instanceId to set.
      Returns:
      This builder for chaining.

    • clearInstanceId

      public DownloadRequest.Builder clearInstanceId()
      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;
      Returns:
      This builder for chaining.

    • setInstanceIdBytes

      public DownloadRequest.Builder setInstanceIdBytes(com.google.protobuf.ByteString value)
      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;
      Parameters:
      value - The bytes for instanceId to set.
      Returns:
      This builder for chaining.

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

    • setUri

      public DownloadRequest.Builder setUri(String value)
      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;
      Parameters:
      value - The uri to set.
      Returns:
      This builder for chaining.

    • clearUri

      public DownloadRequest.Builder clearUri()
      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;
      Returns:
      This builder for chaining.

    • setUriBytes

      public DownloadRequest.Builder setUriBytes(com.google.protobuf.ByteString value)
      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;
      Parameters:
      value - The bytes for uri to set.
      Returns:
      This builder for chaining.

    • 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

    • 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

    • setHeaders

      public DownloadRequest.Builder setHeaders(int index, HeaderPair value)
      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;

    • setHeaders

      public DownloadRequest.Builder setHeaders(int index, HeaderPair.Builder builderForValue)
      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;

    • addHeaders

      public DownloadRequest.Builder addHeaders(HeaderPair value)
      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;

    • addHeaders

      public DownloadRequest.Builder addHeaders(int index, HeaderPair value)
      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;

    • addHeaders

      public DownloadRequest.Builder addHeaders(HeaderPair.Builder builderForValue)
      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;

    • addHeaders

      public DownloadRequest.Builder addHeaders(int index, HeaderPair.Builder builderForValue)
      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;

    • addAllHeaders

      public DownloadRequest.Builder addAllHeaders(Iterable<? extends HeaderPair> values)
      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;

    • clearHeaders

      public DownloadRequest.Builder clearHeaders()
      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;

    • removeHeaders

      public DownloadRequest.Builder removeHeaders(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;

    • getHeadersBuilder

      public HeaderPair.Builder getHeadersBuilder(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;

    • 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

    • 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

    • addHeadersBuilder

      public HeaderPair.Builder addHeadersBuilder()
      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;

    • addHeadersBuilder

      public HeaderPair.Builder addHeadersBuilder(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;

    • getHeadersBuilderList

      public List<HeaderPair.Builder> getHeadersBuilderList()
      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;

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

    • setProxy

      public DownloadRequest.Builder setProxy(ProxyProto value)
      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;

    • setProxy

      public DownloadRequest.Builder setProxy(ProxyProto.Builder builderForValue)
      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;

    • mergeProxy

      public DownloadRequest.Builder mergeProxy(ProxyProto value)
      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;

    • clearProxy

      public DownloadRequest.Builder clearProxy()
      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;

    • getProxyBuilder

      public ProxyProto.Builder getProxyBuilder()
      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;

    • 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