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

Class: Aws::CodeCommit::Types::Location

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

{
  file_path: "Path",
  file_position: 1,
  relative_file_version: "BEFORE", # accepts BEFORE, AFTER
}

Returns information about the location of a change or comment in the comparison between two commits or a pull request.

Instance Attribute Summary collapse

Instance Attribute Details

#file_pathString

The name of the file being compared, including its extension and subdirectory, if any.

Returns:

  • (String)


1406
1407
1408
1409
1410
1411
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1406

class Location < Struct.new(
  :file_path,
  :file_position,
  :relative_file_version)
  include Aws::Structure
end

#file_positionInteger

The position of a change within a compared file, in line number format.

Returns:

  • (Integer)


1406
1407
1408
1409
1410
1411
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1406

class Location < Struct.new(
  :file_path,
  :file_position,
  :relative_file_version)
  include Aws::Structure
end

#relative_file_versionString

In a comparison of commits or a pull request, whether the change is in the 'before' or 'after' of that comparison.

Returns:

  • (String)


1406
1407
1408
1409
1410
1411
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1406

class Location < Struct.new(
  :file_path,
  :file_position,
  :relative_file_version)
  include Aws::Structure
end