Skip to content

Overview

//trimblecloud-fileservice/trimblecloud.fileservice.models/RequestHeader

RequestHeader

[JVM]
open class RequestHeader

Enables optimistic concurrency control by validating the resource’s current state. Name Validation (on create/copy): When creating/copying a file, If-Match:* or If-None-Match:* supports file name matching. For all other operations, If-Match:* allows the request to proceed with the latest state of the resource. Version Validation: Validates the resource’s current version. Note: The copy operation only supports name matching conditions and does not support version matching. Only one of If-Match or If-None-Match may be included in a request. Providing both headers will result in a bad request.

Constructors

RequestHeader[JVM]
constructor(ifMatch: String, ifNoneMatch: String, customHeaders: Map<String, List<String>>)

Types

NameSummary
RequestHeaderBuilder[JVM]
open class RequestHeaderBuilder

Properties

NameSummary
customHeaders[JVM]
open val customHeaders: Map<String, List<String>>
Custom headers that can be added to the request.
ifMatch[JVM]
open val ifMatch: String
Executes the request only if the provided value matches the current state of the resource.
ifNoneMatch[JVM]
open val ifNoneMatch: String
Executes the request only if the provided value does not match the current state of the resource.

Functions

NameSummary
builder[JVM]
open fun builder(): RequestHeader.RequestHeaderBuilder
isValid[JVM]
open fun isValid(resourceType: ResourceType): Boolean
toString[JVM]
open fun toString(): String