PlanTableScanResponse

java.lang.Object

org.apache.iceberg.rest.responses.BaseScanTaskResponse

org.apache.iceberg.rest.responses.PlanTableScanResponse

All Implemented Interfaces:: RESTMessage, RESTResponse

public class PlanTableScanResponse extends BaseScanTaskResponse

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

PlanTableScanResponse.Builder
Method Summary

Modifier and Type

Method

Description

static PlanTableScanResponse.Builder

builder()

static PlanTableScanResponse.Builder

builder(Map<Integer,PartitionSpec> specsById)

Returns a new builder pre-populated with the given partition specs map.

List<Credential>

credentials()

ErrorResponse

errorResponse()

String

planId()

PlanStatus

planStatus()

PlanTableScanResponse.Builder

toBuilder()

Returns a builder pre-populated with this response's fields, suitable for producing a copy with one or more fields modified.

String

toString()

void

validate()

Ensures that a constructed instance of a REST message is valid according to the REST spec.

Methods inherited from class org.apache.iceberg.rest.responses.BaseScanTaskResponse
deleteFiles, fileScanTasks, planTasks, specsById

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details
- planStatus
  
  public PlanStatus planStatus()
- planId
  
  public String planId()
- errorResponse
  
  public ErrorResponse errorResponse()
- credentials
  
  public List<Credential> credentials()
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object
- validate
  
  public void validate()
  
  Description copied from interface: RESTMessage
  
  Ensures that a constructed instance of a REST message is valid according to the REST spec.
  This is needed when parsing data that comes from external sources and the object might have been constructed without all the required fields present.
- builder
  
  public static PlanTableScanResponse.Builder builder()
- builder
  
  public static PlanTableScanResponse.Builder builder(Map<Integer,PartitionSpec> specsById)
  
  Returns a new builder pre-populated with the given partition specs map. Required for server responses that serialize fileScanTasks or deleteFiles; the specs are used only to serialize partition data and are never written to the response payload.
- toBuilder
  
  public PlanTableScanResponse.Builder toBuilder()
  
  Returns a builder pre-populated with this response's fields, suitable for producing a copy with one or more fields modified.