Class: Aws::CodeBuild::Types::ListReportGroupsInput

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 ListReportGroupsInput data as a hash:

{
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  sort_by: "NAME", # accepts NAME, CREATED_TIME, LAST_MODIFIED_TIME
  next_token: "String",
  max_results: 1,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

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

Returns:

  • (Integer)


3134
3135
3136
3137
3138
3139
3140
3141
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 3134

class ListReportGroupsInput < Struct.new(
  :sort_order,
  :sort_by,
  :next_token,
  :max_results)
  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)


3134
3135
3136
3137
3138
3139
3140
3141
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 3134

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

#sort_byString

The criterion to be used to list build report groups. Valid values include:

  • CREATED_TIME: List based on when each report group was created.

  • LAST_MODIFIED_TIME: List based on when each report group was last changed.

  • NAME: List based on each report group's name.

Returns:

  • (String)


3134
3135
3136
3137
3138
3139
3140
3141
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 3134

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

#sort_orderString

Used to specify the order to sort the list of returned report groups. Valid values are ASCENDING and DESCENDING.

Returns:

  • (String)


3134
3135
3136
3137
3138
3139
3140
3141
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 3134

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