sosscli::GetMetadataOptions Class Reference

The GetMetadataOptions class contains options that control behavior of metadata retrieval operations. More...

#include <object_metadata.h>

Public Member Functions
	GetMetadataOptions ()
	Default constructor. Creates a GetMetadataOptions object that throws exceptions on error if the ScaleOut StateServer service returns an error.
	GetMetadataOptions (bool throw_on_error)
	Constructor. More...
virtual	~GetMetadataOptions ()
	Destructor.
bool	throw_on_error () const
	Returns a boolean indicating whether a method will throw an exception derived from sosscli::exceptions::StateServerException if the ScaleOut StateServer service returns an error. More...
GetMetadataOptions &	set_throw_on_error (bool throw_on_error)
	Sets whether a method will throw an exception derived from sosscli::exceptions::StateServerException if the ScaleOut StateServer service returns an error. More...

Static Public Attributes
static const GetMetadataOptions	CACHE_DEFAULTS
	GetMetadataOptions constant that indicates that a get_metadata operation should use the cache's default options. More...

Detailed Description

The GetMetadataOptions class contains options that control behavior of metadata retrieval operations.

Constructor & Destructor Documentation

sosscli::GetMetadataOptions::GetMetadataOptions ( bool  throw_on_error)

inline

Constructor.

Parameters

throw_on_error

Determines whether a method will throw an exception derived from sosscli::exceptions::StateServerException if the ScaleOut StateServer service returns an error. If false, error code information will be available in the returned GetResult.

Member Function Documentation

GetMetadataOptions& sosscli::GetMetadataOptions::set_throw_on_error ( bool  throw_on_error)

inline

Sets whether a method will throw an exception derived from sosscli::exceptions::StateServerException if the ScaleOut StateServer service returns an error.

If false, error code information will be available in the returned GetResult.

Parameters

throw_on_error

Determines whether a method will throw an exception derived from sosscli::exceptions::StateServerException if the ScaleOut StateServer service returns an error. If false, error code information will be available in the returned GetResult.

Returns

*this by reference to allow for chained setter method calls.

bool sosscli::GetMetadataOptions::throw_on_error ( ) const

inline

Returns a boolean indicating whether a method will throw an exception derived from sosscli::exceptions::StateServerException if the ScaleOut StateServer service returns an error.

If false, error code information will be available in the returned GetResult.

Member Data Documentation

const GetMetadataOptions sosscli::GetMetadataOptions::CACHE_DEFAULTS

static

GetMetadataOptions constant that indicates that a get_metadata operation should use the cache's default options.

---

The documentation for this class was generated from the following file:

• include/soss_client/object_metadata.h