Interface ResultSet.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ResultSet.Builder,ResultSet>, SdkBuilder<ResultSet.Builder,ResultSet>, SdkPojo
Enclosing class:
ResultSet

public static interface ResultSet.Builder extends SdkPojo, CopyableBuilder<ResultSet.Builder,ResultSet>
  • Method Details

    • headers

      List of headers for all the data cells in the block. The header identifies the name and default format of the data cell. Data cells appear in the same order in all rows as defined in the header. The names and formats are not repeated in the rows. If a particular row does not have a value for a data cell, a blank value is used.

      For example, a task list that displays the task name, due date and assigned person might have headers [ { "name": "Task Name"}, {"name": "Due Date", "format": "DATE"}, {"name": "Assigned", "format": "CONTACT"} ]. Every row in the result will have the task name as the first item, due date as the second item and assigned person as the third item. If a particular task does not have a due date, that row will still have a blank value in the second element and the assigned person will still be in the third element.

      Parameters:
      headers - List of headers for all the data cells in the block. The header identifies the name and default format of the data cell. Data cells appear in the same order in all rows as defined in the header. The names and formats are not repeated in the rows. If a particular row does not have a value for a data cell, a blank value is used.

      For example, a task list that displays the task name, due date and assigned person might have headers [ { "name": "Task Name"}, {"name": "Due Date", "format": "DATE"}, {"name": "Assigned", "format": "CONTACT"} ]. Every row in the result will have the task name as the first item, due date as the second item and assigned person as the third item. If a particular task does not have a due date, that row will still have a blank value in the second element and the assigned person will still be in the third element.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • headers

      ResultSet.Builder headers(ColumnMetadata... headers)

      List of headers for all the data cells in the block. The header identifies the name and default format of the data cell. Data cells appear in the same order in all rows as defined in the header. The names and formats are not repeated in the rows. If a particular row does not have a value for a data cell, a blank value is used.

      For example, a task list that displays the task name, due date and assigned person might have headers [ { "name": "Task Name"}, {"name": "Due Date", "format": "DATE"}, {"name": "Assigned", "format": "CONTACT"} ]. Every row in the result will have the task name as the first item, due date as the second item and assigned person as the third item. If a particular task does not have a due date, that row will still have a blank value in the second element and the assigned person will still be in the third element.

      Parameters:
      headers - List of headers for all the data cells in the block. The header identifies the name and default format of the data cell. Data cells appear in the same order in all rows as defined in the header. The names and formats are not repeated in the rows. If a particular row does not have a value for a data cell, a blank value is used.

      For example, a task list that displays the task name, due date and assigned person might have headers [ { "name": "Task Name"}, {"name": "Due Date", "format": "DATE"}, {"name": "Assigned", "format": "CONTACT"} ]. Every row in the result will have the task name as the first item, due date as the second item and assigned person as the third item. If a particular task does not have a due date, that row will still have a blank value in the second element and the assigned person will still be in the third element.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • headers

      List of headers for all the data cells in the block. The header identifies the name and default format of the data cell. Data cells appear in the same order in all rows as defined in the header. The names and formats are not repeated in the rows. If a particular row does not have a value for a data cell, a blank value is used.

      For example, a task list that displays the task name, due date and assigned person might have headers [ { "name": "Task Name"}, {"name": "Due Date", "format": "DATE"}, {"name": "Assigned", "format": "CONTACT"} ]. Every row in the result will have the task name as the first item, due date as the second item and assigned person as the third item. If a particular task does not have a due date, that row will still have a blank value in the second element and the assigned person will still be in the third element.

      This is a convenience method that creates an instance of the ColumnMetadata.Builder avoiding the need to create one manually via ColumnMetadata.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to headers(List<ColumnMetadata>).

      Parameters:
      headers - a consumer that will call methods on ColumnMetadata.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • rows

      List of rows returned by the request. Each row has a row Id and a list of data cells in that row. The data cells will be present in the same order as they are defined in the header.

      Parameters:
      rows - List of rows returned by the request. Each row has a row Id and a list of data cells in that row. The data cells will be present in the same order as they are defined in the header.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • rows

      List of rows returned by the request. Each row has a row Id and a list of data cells in that row. The data cells will be present in the same order as they are defined in the header.

      Parameters:
      rows - List of rows returned by the request. Each row has a row Id and a list of data cells in that row. The data cells will be present in the same order as they are defined in the header.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • rows

      List of rows returned by the request. Each row has a row Id and a list of data cells in that row. The data cells will be present in the same order as they are defined in the header.

      This is a convenience method that creates an instance of the ResultRow.Builder avoiding the need to create one manually via ResultRow.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rows(List<ResultRow>).

      Parameters:
      rows - a consumer that will call methods on ResultRow.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: