com.sap.cloud.sdk.odatav2.connectivity

Class ODataReadMediaBuilder

java.lang.Object

com.sap.cloud.sdk.odatav2.connectivity.ODataReadMediaBuilder

public class ODataReadMediaBuilder
extends Object

Method Summary

Modifier and Type	Method and Description
ODataReadMediaRequest	build() Builds the final OData query for retrieving the media resource
ODataReadMediaBuilder	enableMetadataCache() Enables caching of the metadata of an OData V2 data source.
ODataReadMediaBuilder	enableMetadataCache(com.sap.cloud.sdk.cloudplatform.cache.CacheKey cacheKey) Enables caching of the metadata of an OData V2 data source.
ODataReadMediaBuilder	param(String key, Object value) Adds additional query parameters to the OData request
ODataReadMediaBuilder	withCacheRefresh() Replaces the existing metadata in the cache with the latest version from the OData V2 data source.
static ODataReadMediaBuilder	withEntity(String servicePath, String entitySetName, Map<String,Object> keys) Adds the name of the service and entity set, containing the media resource, to the ODataMediaRequestBuilder object
ODataReadMediaBuilder	withHeader(String key, String value) Adds a header to the OData request for querying media resources
ODataReadMediaBuilder	withHeader(String key, String value, boolean passInAllRequests) Adds a header to the OData request for querying media resources
ODataReadMediaBuilder	withMetadata(URL metadataFilePath) Gets the metadata from the specified path.
ODataReadMediaBuilder	withoutMetadata() Prevents the metadata being retrieved before the actual query.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

withEntity

public static ODataReadMediaBuilder withEntity(String servicePath,
                                               String entitySetName,
                                               Map<String,Object> keys)

Adds the name of the service and entity set, containing the media resource, to the ODataMediaRequestBuilder object

Parameters:

servicePath - Name of the service including the relative path. For example, in the case of OData V2, the service path is odata/v2/EPMSampleService

entitySetName - Name of the entity set

keys - Keys identifying the entity that contains the media resource

Returns:

ODataReadMediaBuilder

enableMetadataCache

public ODataReadMediaBuilder enableMetadataCache()

Enables caching of the metadata of an OData V2 data source. If your application is running on a tenant, then the tenant ID along with the metadata URL is used to form the cache key.

Returns:

ODataReadMediaBuilder

enableMetadataCache

public ODataReadMediaBuilder enableMetadataCache(com.sap.cloud.sdk.cloudplatform.cache.CacheKey cacheKey)

Enables caching of the metadata of an OData V2 data source.

Parameters:

key - Cache key containing the ID of the tenant where the application runs. You can also include the user name in the cache key.

Returns:

ODataReadMediaBuilder

withCacheRefresh

public ODataReadMediaBuilder withCacheRefresh()

Replaces the existing metadata in the cache with the latest version from the OData V2 data source.

Returns:

ODataReadMediaBuilder

withMetadata

public ODataReadMediaBuilder withMetadata(URL metadataFilePath)

Gets the metadata from the specified path.

Parameters:

metadataFilePath - URL pointing to the metadata information

Returns:

ODataReadMediaBuilder A builder for forming the Create

withHeader

public ODataReadMediaBuilder withHeader(String key,
                                        String value)

Adds a header to the OData request for querying media resources

Parameters:

key - Name of the header

value - Value of the header

Returns:

ODataReadMediaBuilder

withHeader

public ODataReadMediaBuilder withHeader(String key,
                                        String value,
                                        boolean passInAllRequests)

Adds a header to the OData request for querying media resources

Parameters:

key - Name of the header

value - Value of the header

passInAllRequests - Boolean value indicating whether the header must be passed in all the requests to the backend, for example, in a $metadata call

Returns:

ODataReadMediaBuilder

withoutMetadata

public ODataReadMediaBuilder withoutMetadata()

Prevents the metadata being retrieved before the actual query. However, if the keys are set then the metadata is fetched irrespective of whether this method was called.

Returns:

ODataReadMediaBuilder

param

public ODataReadMediaBuilder param(String key,
                                   Object value)

Adds additional query parameters to the OData request

Parameters:

key - Name of the parameter

value - Value of the parameter

Returns:

ODataReadMediaBuilder

build

public ODataReadMediaRequest build()

Builds the final OData query for retrieving the media resource

Returns:

ODataReadMediaRequest