olp::dataservice::write::model::StartBatchRequest Class Reference

Starts a versioned batch operation. More...

#include <StartBatchRequest.h>

Public Member Functions
	StartBatchRequest (const StartBatchRequest &)=default
	StartBatchRequest (StartBatchRequest &&)=default
StartBatchRequest &	operator= (const StartBatchRequest &)=default
StartBatchRequest &	operator= (StartBatchRequest &&)=default
StartBatchRequest &	WithLayers (std::vector< std::string > layers)
	Sets the layers used in the batch operation. More...
const boost::optional< std::vector< std::string > > &	GetLayers () const
	Gets the layers used in the batch operation. More...
StartBatchRequest &	WithVersionDependencies (std::vector< VersionDependency > versionDependencies)
	Sets the version dependencies used in the batch operation. More...
const boost::optional< std::vector< VersionDependency > > &	GetVersionDependencies () const
	Gets the version dependencies used in the batch operation. More...
const boost::optional< std::string > &	GetBillingTag () const
	Gets the billing tag to group billing records together. More...
StartBatchRequest &	WithBillingTag (std::string billing_tag)
	Sets the billing tag for the request. More...

Detailed Description

Starts a versioned batch operation.

Member Function Documentation

GetBillingTag()

const boost::optional<std::string>& olp::dataservice::write::model::StartBatchRequest::GetBillingTag ( ) const

inline

Gets the billing tag to group billing records together.

The billing tag is an optional free-form tag that is used for grouping billing records together. If supplied, it must be 4–16 characters long and contain only alphanumeric ASCII characters [A-Za-z0-9].

Returns

The BillingTag string or boost::none if the billing tag is not set.

GetLayers()

const boost::optional<std::vector<std::string> >& olp::dataservice::write::model::StartBatchRequest::GetLayers ( ) const

inline

Gets the layers used in the batch operation.

Returns

The layer IDs.

GetVersionDependencies()

const boost::optional<std::vector<VersionDependency> >& olp::dataservice::write::model::StartBatchRequest::GetVersionDependencies ( ) const

inline

Gets the version dependencies used in the batch operation.

Returns

The version dependencies.

WithBillingTag()

StartBatchRequest& olp::dataservice::write::model::StartBatchRequest::WithBillingTag ( std::string  billing_tag )

inline

Sets the billing tag for the request.

See also

GetBillingTag() for information on usage and format.

Parameters

billing_tag

The BillingTag string or boost::none.

WithLayers()

StartBatchRequest& olp::dataservice::write::model::StartBatchRequest::WithLayers ( std::vector< std::string >  layers )

inline

Sets the layers used in the batch operation.

Parameters

layers

The layer IDs.

WithVersionDependencies()

StartBatchRequest& olp::dataservice::write::model::StartBatchRequest::WithVersionDependencies ( std::vector< VersionDependency >  versionDependencies )

inline

Sets the version dependencies used in the batch operation.

Parameters

versionDependencies

The version dependencies.

---

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

• olp-cpp-sdk-dataservice-write/include/olp/dataservice/write/model/StartBatchRequest.h