Class: Aws::CodeBuild::Types::ListReportsInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb

Overview

Note:

When making an API call, you may pass ListReportsInput data as a hash:

{
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  next_token: "String",
  max_results: 1,
  filter: {
    status: "GENERATING", # accepts GENERATING, SUCCEEDED, FAILED, INCOMPLETE, DELETING
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filterTypes::ReportFilter

A ReportFilter object used to filter the returned reports.

Returns:



3290
3291
3292
3293
3294
3295
3296
3297
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 3290

class ListReportsInput < Struct.new(
  :sort_order,
  :next_token,
  :max_results,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of paginated reports returned per response. Use nextToken to iterate pages in the list of returned Report objects. The default value is 100.

Returns:

  • (Integer)


3290
3291
3292
3293
3294
3295
3296
3297
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 3290

class ListReportsInput < Struct.new(
  :sort_order,
  :next_token,
  :max_results,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

Returns:

  • (String)


3290
3291
3292
3293
3294
3295
3296
3297
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 3290

class ListReportsInput < Struct.new(
  :sort_order,
  :next_token,
  :max_results,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#sort_orderString

Specifies the sort order for the list of returned reports. Valid values are:

  • ASCENDING: return reports in chronological order based on their creation date.

  • DESCENDING: return reports in the reverse chronological order based on their creation date.

Returns:

  • (String)


3290
3291
3292
3293
3294
3295
3296
3297
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 3290

class ListReportsInput < Struct.new(
  :sort_order,
  :next_token,
  :max_results,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end