Class WithIndexItemRequestBuilder

Namespace

Autodesk.ACC.ModelProperties.V2.Projects.Item.Indexes.Item

Assembly

Autodesk.ACC.ModelProperties.dll

Builds and executes requests for operations under \v2\projects{projectId}\indexes{indexId}

public class WithIndexItemRequestBuilder : BaseRequestBuilder

Inheritance

object

BaseRequestBuilder

WithIndexItemRequestBuilder

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

WithIndexItemRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new WithIndexItemRequestBuilder and sets the default values.

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

WithIndexItemRequestBuilder(string, IRequestAdapter)

Instantiates a new WithIndexItemRequestBuilder and sets the default values.

public WithIndexItemRequestBuilder(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

Fields

The fields property

public FieldsRequestBuilder Fields { get; }

Property Value

FieldsRequestBuilder

Manifest

The manifest property

public ManifestRequestBuilder Manifest { get; }

Property Value

ManifestRequestBuilder

Properties

The properties property

public PropertiesRequestBuilder Properties { get; }

Property Value

PropertiesRequestBuilder

Queries

The queries property

public QueriesRequestBuilder Queries { get; }

Property Value

QueriesRequestBuilder

Methods

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

Retrieve the indexing status for the given index ID.Depending on the state different properties might be present or missing.E.g., if the indexing job is not finished yet, the manifest, fields, andproperties links might be missing, but the retryAt property will be present.Or if the processing failed for some reason, the errors property will containsome information.Once the final result of the indexing job has been determined (either finished or failed),the status is assumed to be immutable and the response will set a long expiration HTTP headerfor efficient client side caching.

public Task<IndexJobStatus?> GetAsync(Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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<IndexJobStatus>

A IndexJobStatus

Exceptions

ResourceError

When receiving a 401 status code

ResourceError

When receiving a 404 status code

ToGetRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>?)

Retrieve the indexing status for the given index ID.Depending on the state different properties might be present or missing.E.g., if the indexing job is not finished yet, the manifest, fields, andproperties links might be missing, but the retryAt property will be present.Or if the processing failed for some reason, the errors property will containsome information.Once the final result of the indexing job has been determined (either finished or failed),the status is assumed to be immutable and the response will set a long expiration HTTP headerfor efficient client side caching.

public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null)

Parameters

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

Parameters

rawUrl string

The raw URL to use for the request builder.

Returns

WithIndexItemRequestBuilder

A WithIndexItemRequestBuilder