You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CodeCommit::Types::DescribePullRequestEventsInput

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

Overview

Note:

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

{
  pull_request_id: "PullRequestId", # required
  pull_request_event_type: "PULL_REQUEST_CREATED", # accepts PULL_REQUEST_CREATED, PULL_REQUEST_STATUS_CHANGED, PULL_REQUEST_SOURCE_REFERENCE_UPDATED, PULL_REQUEST_MERGE_STATE_CHANGED
  actor_arn: "Arn",
  next_token: "NextToken",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#actor_arnString

The Amazon Resource Name (ARN) of the user whose actions resulted in the event. Examples include updating the pull request with additional commits or changing the status of a pull request.

Returns:

  • (String)


628
629
630
631
632
633
634
635
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 628

class DescribePullRequestEventsInput < Struct.new(
  :pull_request_id,
  :pull_request_event_type,
  :actor_arn,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_resultsInteger

A non-negative integer used to limit the number of returned results. The default is 100 events, which is also the maximum number of events that can be returned in a result.

Returns:

  • (Integer)


628
629
630
631
632
633
634
635
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 628

class DescribePullRequestEventsInput < Struct.new(
  :pull_request_id,
  :pull_request_event_type,
  :actor_arn,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_tokenString

An enumeration token that when provided in a request, returns the next batch of the results.

Returns:

  • (String)


628
629
630
631
632
633
634
635
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 628

class DescribePullRequestEventsInput < Struct.new(
  :pull_request_id,
  :pull_request_event_type,
  :actor_arn,
  :next_token,
  :max_results)
  include Aws::Structure
end

#pull_request_event_typeString

Optional. The pull request event type about which you want to return information.

Returns:

  • (String)


628
629
630
631
632
633
634
635
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 628

class DescribePullRequestEventsInput < Struct.new(
  :pull_request_id,
  :pull_request_event_type,
  :actor_arn,
  :next_token,
  :max_results)
  include Aws::Structure
end

#pull_request_idString

The system-generated ID of the pull request. To get this ID, use ListPullRequests.

Returns:

  • (String)


628
629
630
631
632
633
634
635
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 628

class DescribePullRequestEventsInput < Struct.new(
  :pull_request_id,
  :pull_request_event_type,
  :actor_arn,
  :next_token,
  :max_results)
  include Aws::Structure
end