Package com.sap.cloud.sdk.datamodel.odata.client.request

Class ODataRequestReadByKey

java.lang.Object

com.sap.cloud.sdk.datamodel.odata.client.request.ODataRequestGeneric

com.sap.cloud.sdk.datamodel.odata.client.request.ODataRequestReadByKey

All Implemented Interfaces:

ODataRequestExecutable

public class ODataRequestReadByKey
extends ODataRequestGeneric

The result type of the OData read by key request.

Field Summary

Fields inherited from class com.sap.cloud.sdk.datamodel.odata.client.request.ODataRequestGeneric

csrfTokenRetriever, resourcePath, servicePath

Constructor Summary

Constructors

Constructor	Description
ODataRequestReadByKey(String servicePath, ODataResourcePath entityPath, ODataEntityKey entityKey, StructuredQuery query)	Constructor with StructuredQuery for OData read requests on entity collections directly.
ODataRequestReadByKey(String servicePath, ODataResourcePath entityPath, String encodedQuery, ODataProtocol protocol)	Default constructor for OData Read requests.
ODataRequestReadByKey(String servicePath, String entityName, ODataEntityKey entityKey, String encodedQuery, ODataProtocol protocol)	Convenience constructor for OData read requests on entity collections directly.

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
ODataRequestResultGeneric	execute(org.apache.http.client.HttpClient httpClient)	Execute the OData request with the provided HttpClient reference.
String	getQueryString()
URI	getRelativeUri(UriEncodingStrategy strategy)	Get the static request URI of the OData resource.
String	getRequestQuery()	Use all OData query information to construct a HTTP request query String.
int	hashCode()
ODataRequestResultResource.Executable	withoutResponseBuffering()	Disable pre-buffering of http response entity.

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.client.request.ODataRequestGeneric

addHeader, addHeaderIfAbsent, addListener, addQueryParameter, getHeaders, getListeners, getProtocol, getQueryParameters, getRelativeUri, getResourcePath, getServicePath, setCsrfTokenRetriever, setHeader, setHeader, tryExecute, tryExecuteWithCsrfToken

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ODataRequestReadByKey

public ODataRequestReadByKey(@Nonnull
 String servicePath,
 @Nonnull
 String entityName,
 @Nonnull
 ODataEntityKey entityKey,
 @Nullable
 String encodedQuery,
 @Nonnull
 ODataProtocol protocol)

Convenience constructor for OData read requests on entity collections directly. For operations on nested entities use ODataRequestReadByKey(String, ODataResourcePath, String, ODataProtocol).

Parameters:

servicePath - The OData service path.

entityName - The OData entity name.

entityKey - The entity key.

encodedQuery - Optional: The encoded HTTP query, if any.

protocol - The OData protocol to use.

ODataRequestReadByKey

public ODataRequestReadByKey(@Nonnull
 String servicePath,
 @Nonnull
 ODataResourcePath entityPath,
 @Nullable
 String encodedQuery,
 @Nonnull
 ODataProtocol protocol)

Default constructor for OData Read requests.

Parameters:

servicePath - The OData service path.

entityPath - The ODataResourcePath that identifies the entity to read.

encodedQuery - Optional: The encoded HTTP query, if any.

protocol - The OData protocol to use.

ODataRequestReadByKey

public ODataRequestReadByKey(@Nonnull
 String servicePath,
 @Nonnull
 ODataResourcePath entityPath,
 @Nonnull
 ODataEntityKey entityKey,
 @Nonnull
 StructuredQuery query)

Constructor with StructuredQuery for OData read requests on entity collections directly. For operations on nested entity collections use #ODataRequestRead(String, ODataResourcePath, String, ODataProtocol).

Parameters:

servicePath - The OData service path.

entityPath - The ODataResourcePath that identifies the collection of entities or properties to read.

entityKey - The entity key.

query - The structured query.

Method Details

getRelativeUri

@Nonnull
public URI getRelativeUri(@Nonnull
 UriEncodingStrategy strategy)

Description copied from class: ODataRequestGeneric

Get the static request URI of the OData resource.

Specified by:

getRelativeUri in class ODataRequestGeneric

Parameters:

strategy - URI encoding strategy.

Returns:

The String representation of the request URI.

getRequestQuery

@Nonnull
public String getRequestQuery()

Description copied from class: ODataRequestGeneric

Use all OData query information to construct a HTTP request query String.

Overrides:

getRequestQuery in class ODataRequestGeneric

Returns:

The request query.

execute

@Nonnull
public ODataRequestResultGeneric execute(@Nonnull
 org.apache.http.client.HttpClient httpClient)

Description copied from interface: ODataRequestExecutable

Execute the OData request with the provided HttpClient reference.

Parameters:

httpClient - The HttpClient.

Returns:

An OData request result.

withoutResponseBuffering

@Beta
@Nonnull
public ODataRequestResultResource.Executable withoutResponseBuffering()

Disable pre-buffering of http response entity.

Since:

5.21.0

getQueryString

@Nonnull
public String getQueryString()

equals

public boolean equals(@Nullable
 Object o)

Overrides:

equals in class ODataRequestGeneric

canEqual

protected boolean canEqual(@Nullable
 Object other)

Overrides:

canEqual in class ODataRequestGeneric

hashCode

public int hashCode()

Overrides:

hashCode in class ODataRequestGeneric