Class BucketsRequestBuilder

Namespace

Autodesk.DataManagement.OSS.Oss.V2.Buckets

Assembly

Autodesk.DataManagement.dll

Builds and executes requests for operations under \oss\v2\buckets

public class BucketsRequestBuilder : BaseRequestBuilder

Inheritance

object

BaseRequestBuilder

BucketsRequestBuilder

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

BucketsRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new BucketsRequestBuilder and sets the default values.

public BucketsRequestBuilder(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.

BucketsRequestBuilder(string, IRequestAdapter)

Instantiates a new BucketsRequestBuilder and sets the default values.

public BucketsRequestBuilder(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.

Properties

this[string]

Gets an item from the Autodesk.DataManagement.OSS.oss.v2.buckets.item collection

public WithBucketKeyItemRequestBuilder this[string position] { get; }

Parameters

position string

URL-encoded bucket key

Property Value

WithBucketKeyItemRequestBuilder

A WithBucketKeyItemRequestBuilder

Methods

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

This endpoint will return the buckets owned by the application. This endpoint supports pagination.

public Task<Buckets?> GetAsync(Action<RequestConfiguration<BucketsRequestBuilder.BucketsRequestBuilderGetQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

requestConfiguration Action<RequestConfiguration<BucketsRequestBuilder.BucketsRequestBuilderGetQueryParameters>>

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

cancellationToken CancellationToken

Cancellation token to use when cancelling requests

Returns

Task<Buckets>

A Buckets

PostAsync(Create_buckets_payload, Action<RequestConfiguration<DefaultQueryParameters>>?, CancellationToken)

Use this endpoint to create a bucket. Buckets are arbitrary spaces created and owned by applications. Bucket keys are globally unique across all regions, regardless of where they were created, and they cannot be changed. The application creating the bucket is the owner of the bucket.

public Task<Bucket?> PostAsync(Create_buckets_payload body, Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

body Create_buckets_payload

Bucket Payload Body Structure

requestConfiguration Action<RequestConfiguration<DefaultQueryParameters>>

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

cancellationToken CancellationToken

Cancellation token to use when cancelling requests

Returns

Task<Bucket>

A Bucket

Exceptions

Reason

When receiving a 409 status code

ToGetRequestInformation(Action<RequestConfiguration<BucketsRequestBuilderGetQueryParameters>>?)

This endpoint will return the buckets owned by the application. This endpoint supports pagination.

public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<BucketsRequestBuilder.BucketsRequestBuilderGetQueryParameters>>? requestConfiguration = null)

Parameters

requestConfiguration Action<RequestConfiguration<BucketsRequestBuilder.BucketsRequestBuilderGetQueryParameters>>

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

Returns

RequestInformation

A Microsoft.Kiota.Abstractions.RequestInformation

ToPostRequestInformation(Create_buckets_payload, Action<RequestConfiguration<DefaultQueryParameters>>?)

Use this endpoint to create a bucket. Buckets are arbitrary spaces created and owned by applications. Bucket keys are globally unique across all regions, regardless of where they were created, and they cannot be changed. The application creating the bucket is the owner of the bucket.

public RequestInformation ToPostRequestInformation(Create_buckets_payload body, Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null)

Parameters

body Create_buckets_payload

Bucket Payload Body Structure

requestConfiguration Action<RequestConfiguration<DefaultQueryParameters>>

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 BucketsRequestBuilder WithUrl(string rawUrl)

Parameters

rawUrl string

The raw URL to use for the request builder.

Returns

BucketsRequestBuilder

A BucketsRequestBuilder