types.h File Reference

#include <cstdint>
#include <memory>
#include <optional>
#include <string>
#include <string_view>
#include <unordered_map>
#include <vector>
#include "iceberg/catalog/rest/endpoint.h"
#include "iceberg/catalog/rest/iceberg_rest_export.h"
#include "iceberg/result.h"
#include "iceberg/storage_credential.h"
#include "iceberg/table_identifier.h"
#include "iceberg/type_fwd.h"
#include "iceberg/util/macros.h"

Go to the source code of this file.

Classes
struct	iceberg::rest::CatalogConfig
	Server-provided configuration for the catalog. More...
struct	iceberg::rest::ErrorResponse
	JSON error payload returned in a response with further details on the error. More...
struct	iceberg::rest::CreateNamespaceRequest
	Request to create a namespace. More...
struct	iceberg::rest::UpdateNamespacePropertiesRequest
	Update or delete namespace properties request. More...
struct	iceberg::rest::RegisterTableRequest
	Request to register a table. More...
struct	iceberg::rest::RenameTableRequest
	Request to rename a table. More...
struct	iceberg::rest::CreateTableRequest
	Request to create a table. More...
struct	iceberg::rest::LoadTableResult
	Result body for table create/load/register APIs. More...
struct	iceberg::rest::ListNamespacesResponse
	Response body for listing namespaces. More...
struct	iceberg::rest::CreateNamespaceResponse
	Response body after creating a namespace. More...
struct	iceberg::rest::GetNamespaceResponse
	Response body for loading namespace properties. More...
struct	iceberg::rest::UpdateNamespacePropertiesResponse
	Response body after updating namespace properties. More...
struct	iceberg::rest::ListTablesResponse
	Response body for listing tables in a namespace. More...
struct	iceberg::rest::CommitTableRequest
	Request to commit changes to a table. More...
struct	iceberg::rest::CommitTableResponse
	Response from committing changes to a table. More...
struct	iceberg::rest::OAuthTokenResponse
	Response from an OAuth2 token endpoint. More...
struct	iceberg::rest::PlanTableScanRequest
	Request to initiate a server-side scan planning operation. More...
struct	iceberg::rest::PlanTableScanResponse
	Response from initiating a scan planning operation, including plan status and initial scan tasks. More...
struct	iceberg::rest::FetchPlanningResultResponse
	Response from polling an asynchronous scan plan, including current status and available scan tasks. More...
struct	iceberg::rest::FetchScanTasksRequest
	Request to fetch the scan tasks for a given plan task token. More...
struct	iceberg::rest::FetchScanTasksResponse
	Response containing the file scan tasks for a given plan task token. More...

Typedefs
using	iceberg::rest::PageToken = std::string
	An opaque token that allows clients to make use of pagination for list APIs.
using	iceberg::rest::CreateTableResponse = LoadTableResult
	Alias of LoadTableResult used as the body of CreateTableResponse.
using	iceberg::rest::LoadTableResponse = LoadTableResult
	Alias of LoadTableResult used as the body of LoadTableResponse.

Enumerations
enum class	iceberg::rest::PlanStatus { kSubmitted , kCompleted , kCancelled , kFailed }
	Status of a REST server-side scan planning operation.

Functions
std::string_view	iceberg::rest::ToString (PlanStatus status)
Result< PlanStatus >	iceberg::rest::PlanStatusFromString (std::string_view status_str)

Detailed Description

Request and response types for Iceberg REST Catalog API.