Class Location

java.lang.Object
software.amazon.awssdk.services.codecommit.model.Location
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Location.Builder,Location>
@Generated("software.amazon.awssdk:codegen") public final class Location extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Location.Builder,Location>

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

See Also:

  • Method Details

    • filePath

      public final String filePath()

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

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

    • filePosition

      public final Long filePosition()

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

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

    • relativeFileVersion

      public final RelativeFileVersionEnum relativeFileVersion()

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

      If the service returns an enum value that is not available in the current SDK version, relativeFileVersion will return RelativeFileVersionEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from relativeFileVersionAsString().

      Returns:
      In a comparison of commits or a pull request, whether the change is in the before or after of that comparison.
      See Also:

    • relativeFileVersionAsString

      public final String relativeFileVersionAsString()

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

      If the service returns an enum value that is not available in the current SDK version, relativeFileVersion will return RelativeFileVersionEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from relativeFileVersionAsString().

      Returns:
      In a comparison of commits or a pull request, whether the change is in the before or after of that comparison.
      See Also:

    • toBuilder

      public Location.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Location.Builder,Location>
      Returns:
      a builder for type T

    • builder

      public static Location.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Location.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.