Class File

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

Returns information about a file in a repository.

See Also:

  • Method Details

    • blobId

      public final String blobId()

      The blob ID that contains the file information.

      Returns:
      The blob ID that contains the file information.

    • absolutePath

      public final String absolutePath()

      The fully qualified path to the file in the repository.

      Returns:
      The fully qualified path to the file in the repository.

    • relativePath

      public final String relativePath()

      The relative path of the file from the folder where the query originated.

      Returns:
      The relative path of the file from the folder where the query originated.

    • fileMode

      public final FileModeTypeEnum fileMode()

      The extrapolated file mode permissions for the file. Valid values include EXECUTABLE and NORMAL.

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

      Returns:
      The extrapolated file mode permissions for the file. Valid values include EXECUTABLE and NORMAL.
      See Also:

    • fileModeAsString

      public final String fileModeAsString()

      The extrapolated file mode permissions for the file. Valid values include EXECUTABLE and NORMAL.

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

      Returns:
      The extrapolated file mode permissions for the file. Valid values include EXECUTABLE and NORMAL.
      See Also:

    • toBuilder

      public File.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<File.Builder,File>
      Returns:
      a builder for type T

    • builder

      public static File.Builder builder()

    • serializableBuilderClass

      public static Class<? extends File.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.