Class Signeds3downloadRequestBuilder

Namespace

Autodesk.DataManagement.OSS.Oss.V2.Buckets.Item.Objects.Item.Signeds3download

Assembly

Autodesk.DataManagement.dll

Builds and executes requests for operations under \oss\v2\buckets{bucketKey}\objects{objectKey}\signeds3download

public class Signeds3downloadRequestBuilder : BaseRequestBuilder

Inheritance

object

BaseRequestBuilder

Signeds3downloadRequestBuilder

Inherited Members

BaseRequestBuilder.PathParameters

BaseRequestBuilder.RequestAdapter

BaseRequestBuilder.UrlTemplate

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Signeds3downloadRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new Signeds3downloadRequestBuilder and sets the default values.

public Signeds3downloadRequestBuilder(Dictionary<string, object> pathParameters, IRequestAdapter requestAdapter)

Parameters

pathParameters Dictionary<string, object>

Path parameters for the request

requestAdapter IRequestAdapter

The request adapter to use to execute the requests.

Signeds3downloadRequestBuilder(string, IRequestAdapter)

Instantiates a new Signeds3downloadRequestBuilder and sets the default values.

public Signeds3downloadRequestBuilder(string rawUrl, IRequestAdapter requestAdapter)

Parameters

rawUrl string

The raw URL to use for the request builder.

requestAdapter IRequestAdapter

The request adapter to use to execute the requests.

Methods

GetAsync(Action<RequestConfiguration<Signeds3downloadRequestBuilderGetQueryParameters>>?, CancellationToken)

Gets a signed URL to a download an object directly from S3, bypassing OSS servers. This signed URL expires in 60 seconds, so the request must begin within that time frame; the actual data transfer can take longer. Note that resumable uploads store each chunk individually; after the upload completes, an async process merges all the chunks and creates the definitive OSS file. If you request a signed URL before the async process completes, the response returns a map of S3 URLs, one per chunk; the key is the byte range of the total file to which the chunk corresponds. If you need a single URL in the response, you can use OSS signed resource functionality by setting the 'public-resource-fallback' query parameter to true. Lastly, note that ranged downloads can be used with the returned URL.

public Task<Signeds3download_response?> GetAsync(Action<RequestConfiguration<Signeds3downloadRequestBuilder.Signeds3downloadRequestBuilderGetQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

requestConfiguration Action<RequestConfiguration<Signeds3downloadRequestBuilder.Signeds3downloadRequestBuilderGetQueryParameters>>

Configuration for the request such as headers, query parameters, and middleware options.

cancellationToken CancellationToken

Cancellation token to use when cancelling requests

Returns

Task<Signeds3download_response>

A Signeds3download_response

ToGetRequestInformation(Action<RequestConfiguration<Signeds3downloadRequestBuilderGetQueryParameters>>?)

Gets a signed URL to a download an object directly from S3, bypassing OSS servers. This signed URL expires in 60 seconds, so the request must begin within that time frame; the actual data transfer can take longer. Note that resumable uploads store each chunk individually; after the upload completes, an async process merges all the chunks and creates the definitive OSS file. If you request a signed URL before the async process completes, the response returns a map of S3 URLs, one per chunk; the key is the byte range of the total file to which the chunk corresponds. If you need a single URL in the response, you can use OSS signed resource functionality by setting the 'public-resource-fallback' query parameter to true. Lastly, note that ranged downloads can be used with the returned URL.

public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<Signeds3downloadRequestBuilder.Signeds3downloadRequestBuilderGetQueryParameters>>? requestConfiguration = null)

Parameters

requestConfiguration Action<RequestConfiguration<Signeds3downloadRequestBuilder.Signeds3downloadRequestBuilderGetQueryParameters>>

Configuration for the request such as headers, query parameters, and middleware options.

Returns

RequestInformation

A Microsoft.Kiota.Abstractions.RequestInformation

WithUrl(string)

Returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored.

public Signeds3downloadRequestBuilder WithUrl(string rawUrl)

Parameters

rawUrl string

The raw URL to use for the request builder.

Returns

Signeds3downloadRequestBuilder

A Signeds3downloadRequestBuilder