FramesV3 (h2o-bindings 3.46.0 API)

java.lang.Object
- water.bindings.pojos.SchemaV3
- - water.bindings.pojos.RequestSchemaV3
  - - water.bindings.pojos.FramesV3

public class FramesV3
extends RequestSchemaV3

Field Summary

Fields
Modifier and Type	Field and Description
`java.lang.String`	`column` Name of column of interest
`int`	`columnCount` Number of columns to return
`int`	`columnOffset` Column offset to return
`ModelSchemaV3[]`	`compatibleModels` Compatible models
`java.lang.String`	`compression` Compression method (default none; gzip, bzip2, zstd and snappy available depending on runtime environment)
`java.lang.String[][]`	`domain` Domains
`boolean`	`findCompatibleModels` Find and return compatible models?
`boolean`	`force` Overwrite existing file
`UtilExportFileFormat`	`format` Output file format.
`FrameKeyV3`	`frameId` Name of Frame of interest
`FrameV3[]`	`frames` Frames
`int`	`fullColumnCount` Number of full columns to return.
`boolean`	`header` Use header (default true)
`JobV3`	`job` Job for export file
`int`	`numParts` Number of part files to use (1=single file,-1=automatic)
`boolean`	`parallel` Use parallel export to a single file (doesn't apply when num_parts != 1, creates temporary files in the destination directory)
`java.lang.String`	`path` File output path
`boolean`	`quoteHeader` Quote column names in header line (default true)
`int`	`rowCount` Number of rows to return
`long`	`rowOffset` Row offset to return
`byte`	`separator` Field separator (default ',')
`boolean`	`tzAdjustFromLocal` Specifies if the timezone should be adjusted from local to UTC timezone (parquet only).
`boolean`	`writeChecksum` Specifies if checksum should be written next to data files on export (if supported by export format).

Fields inherited from class water.bindings.pojos.RequestSchemaV3
_excludeFields

Constructor Summary

Constructors
Constructor and Description

FramesV3()
Public constructor

Constructors
Constructor and Description
`FramesV3()` Public constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method and Description

java.lang.String toString()
Return the contents of this object as a JSON String.
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`toString()` Return the contents of this object as a JSON String.

- Field Detail
  - frameId
```
@SerializedName(value="frame_id")
public FrameKeyV3 frameId
```
    Name of Frame of interest
  - column
```
public java.lang.String column
```
    Name of column of interest
  - rowOffset
```
@SerializedName(value="row_offset")
public long rowOffset
```
    Row offset to return
  - rowCount
```
@SerializedName(value="row_count")
public int rowCount
```
    Number of rows to return
  - columnOffset
```
@SerializedName(value="column_offset")
public int columnOffset
```
    Column offset to return
  - fullColumnCount
```
@SerializedName(value="full_column_count")
public int fullColumnCount
```
    Number of full columns to return. The columns between full_column_count and column_count will be returned without the data
  - columnCount
```
@SerializedName(value="column_count")
public int columnCount
```
    Number of columns to return
  - findCompatibleModels
```
@SerializedName(value="find_compatible_models")
public boolean findCompatibleModels
```
    Find and return compatible models?
  - path
```
public java.lang.String path
```
    File output path
  - force
```
public boolean force
```
    Overwrite existing file
  - numParts
```
@SerializedName(value="num_parts")
public int numParts
```
    Number of part files to use (1=single file,-1=automatic)
  - parallel
```
public boolean parallel
```
    Use parallel export to a single file (doesn't apply when num_parts != 1, creates temporary files in the destination directory)
  - format
```
public UtilExportFileFormat format
```
    Output file format. Defaults to 'csv'.
  - compression
```
public java.lang.String compression
```
    Compression method (default none; gzip, bzip2, zstd and snappy available depending on runtime environment)
  - writeChecksum
```
@SerializedName(value="write_checksum")
public boolean writeChecksum
```
    Specifies if checksum should be written next to data files on export (if supported by export format).
  - tzAdjustFromLocal
```
@SerializedName(value="tz_adjust_from_local")
public boolean tzAdjustFromLocal
```
    Specifies if the timezone should be adjusted from local to UTC timezone (parquet only).
  - separator
```
public byte separator
```
    Field separator (default ',')
  - header
```
public boolean header
```
    Use header (default true)
  - quoteHeader
```
@SerializedName(value="quote_header")
public boolean quoteHeader
```
    Quote column names in header line (default true)
  - job
```
public JobV3 job
```
    Job for export file
  - frames
```
public FrameV3[] frames
```
    Frames
  - compatibleModels
```
@SerializedName(value="compatible_models")
public ModelSchemaV3[] compatibleModels
```
    Compatible models
  - domain
```
public java.lang.String[][] domain
```
    Domains
- Constructor Detail
  - FramesV3
```
public FramesV3()
```
    Public constructor
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Return the contents of this object as a JSON String.
    
    Overrides:
    
    toString in class RequestSchemaV3

Class FramesV3

Field Summary

Fields inherited from class water.bindings.pojos.RequestSchemaV3

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

frameId

column

rowOffset

rowCount

columnOffset

fullColumnCount

columnCount

findCompatibleModels

path

force

numParts

parallel

format

compression

writeChecksum

tzAdjustFromLocal

separator

header

quoteHeader

job

frames

compatibleModels

domain

Constructor Detail

FramesV3

Method Detail

toString