Package com.smartsheet.api.models

Class CreateReportRequest

  • public class CreateReportRequest
extends java.lang.Object
    Represents the request object for creating a new report.

    • Constructor Detail

      • CreateReportRequest

        public CreateReportRequest()

    • Method Detail

      • getName

        public java.lang.String getName()
        Gets the report name.
        Returns:
        the report name

      • setName

        public CreateReportRequest setName​(java.lang.String name)
        Sets the report name.
        Parameters:
        name - the report name (1-50 characters)
        Returns:
        this CreateReportRequest object for method chaining

      • getColumns

        public java.util.List<ReportColumn> getColumns()
        Gets the columns for the report.
        Returns:
        the list of report columns

      • setColumns

        public CreateReportRequest setColumns​(java.util.List<ReportColumn> columns)
        Sets the columns for the report.
        Parameters:
        columns - the list of report columns (1-400 items)
        Returns:
        this CreateReportRequest object for method chaining

      • getScope

        public java.util.List<ReportScopeInclusion> getScope()
        Gets the scope of the report.
        Returns:
        the list of report scope inclusions

      • setScope

        public CreateReportRequest setScope​(java.util.List<ReportScopeInclusion> scope)
        Sets the scope of the report.
        Parameters:
        scope - the list of sheets and/or workspaces (1-100 items)
        Returns:
        this CreateReportRequest object for method chaining

      • getReportDefinition

        public ReportDefinition getReportDefinition()
        Gets the report definition.
        Returns:
        the report definition

      • setReportDefinition

        public CreateReportRequest setReportDefinition​(ReportDefinition reportDefinition)
        Sets the report definition.
        Parameters:
        reportDefinition - the report definition including filters, grouping, summarizing, and sorting
        Returns:
        this CreateReportRequest object for method chaining

      • getIsSummaryReport

        public java.lang.Boolean getIsSummaryReport()
        Gets whether this is a summary report.
        Returns:
        true if this is a sheet summary report, false if it is a row report

      • setIsSummaryReport

        public CreateReportRequest setIsSummaryReport​(java.lang.Boolean isSummaryReport)
        Sets whether this is a summary report.
        Parameters:
        isSummaryReport - true for sheet summary report, false for row report
        Returns:
        this CreateReportRequest object for method chaining

      • getDestination

        public ReportDestination getDestination()
        Gets the destination container for the report.
        Returns:
        the destination container

      • setDestination

        public CreateReportRequest setDestination​(ReportDestination destination)
        Sets the destination container for the report.
        Parameters:
        destination - the destination folder or workspace
        Returns:
        this CreateReportRequest object for method chaining