RequestConditions Class

  • Reference
Package:
com.azure.core.http
Maven Artifact:
com.azure:azure-core:1.54.0

public class RequestConditions
extends MatchConditions

Specifies HTTP options for conditional requests based on modification time and ETag matching.

This class extends MatchConditions and adds conditions based on the modification time of the resource. It encapsulates conditions such as If-Modified-Since and If-Unmodified-Since, in addition to If-Match and If-None-Match from MatchConditions.

This class is useful when you want to create an HTTP request with conditional headers based on the modification time of the resource and ETag matching. For example, you can use it to create a GET request that only retrieves the resource if it has been modified since a specific time, or a PUT request that only updates the resource if it has not been modified by another client since a specific time.

Constructor Summary

Constructor Description
RequestConditions()

Creates a new instance of RequestConditions.

Method Summary

Modifier and Type Method and Description
OffsetDateTime getIfModifiedSince()

Gets the datetime that resources must have been modified since.
OffsetDateTime getIfUnmodifiedSince()

Gets the datetime that resources must have remained unmodified since.
RequestConditions setIfMatch(String ifMatch)

Optionally limit requests to resources that match the passed ETag.
RequestConditions setIfModifiedSince(OffsetDateTime ifModifiedSince)

Optionally limit requests to resources that have only been modified since the passed datetime.
RequestConditions setIfNoneMatch(String ifNoneMatch)

Optionally limit requests to resources that do not match the passed ETag.
RequestConditions setIfUnmodifiedSince(OffsetDateTime ifUnmodifiedSince)

Optionally limit requests to resources that have remained unmodified since the passed datetime.

Methods inherited from MatchConditions

getIfMatch getIfNoneMatch setIfMatch setIfNoneMatch

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

RequestConditions

public RequestConditions()

Creates a new instance of RequestConditions.

Method Details

getIfModifiedSince

public OffsetDateTime getIfModifiedSince()

Gets the datetime that resources must have been modified since.

Returns:

The datetime that resources must have been modified since.

getIfUnmodifiedSince

public OffsetDateTime getIfUnmodifiedSince()

Gets the datetime that resources must have remained unmodified since.

Returns:

The datetime that resources must have remained unmodified since.

setIfMatch

public RequestConditions setIfMatch(String ifMatch)

Optionally limit requests to resources that match the passed ETag.

Overrides:

RequestConditions.setIfMatch(String ifMatch)

Parameters:

ifMatch - ETag that resources must match.

Returns:

The updated ResourceConditions object.

setIfModifiedSince

public RequestConditions setIfModifiedSince(OffsetDateTime ifModifiedSince)

Optionally limit requests to resources that have only been modified since the passed datetime.

Parameters:

ifModifiedSince - The datetime that resources must have been modified since.

Returns:

The updated ResourceConditions object.

setIfNoneMatch

public RequestConditions setIfNoneMatch(String ifNoneMatch)

Optionally limit requests to resources that do not match the passed ETag.

Overrides:

RequestConditions.setIfNoneMatch(String ifNoneMatch)

Parameters:

ifNoneMatch - ETag that resources must not match.

Returns:

The updated ResourceConditions object.

setIfUnmodifiedSince

public RequestConditions setIfUnmodifiedSince(OffsetDateTime ifUnmodifiedSince)

Optionally limit requests to resources that have remained unmodified since the passed datetime.

Parameters:

ifUnmodifiedSince - The datetime that resources must have remained unmodified since.

Returns:

The updated ResourceConditions object.

Applies to