Class PatchBody

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

Projected content for a PATCH artifact: the remediation patch for one repository, with the descriptors needed to verify and apply it and the state of its delivery to the customer's own bucket or repository.

See Also:

  • Method Details

    • patch

      public final String patch()

      The patch exactly as stored, unmodified. Control Plane accepted it only as a text unified diff, so git apply applies it.

      Returns:
      The patch exactly as stored, unmodified. Control Plane accepted it only as a text unified diff, so git apply applies it.

    • format

      public final PatchFormat format()

      The patch's wire format, read from the patch itself, which determines how to apply it. Absent when the patch starts with neither a git mailbox header nor a diff --git header.

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

      Returns:
      The patch's wire format, read from the patch itself, which determines how to apply it. Absent when the patch starts with neither a git mailbox header nor a diff --git header.
      See Also:

    • formatAsString

      public final String formatAsString()

      The patch's wire format, read from the patch itself, which determines how to apply it. Absent when the patch starts with neither a git mailbox header nor a diff --git header.

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

      Returns:
      The patch's wire format, read from the patch itself, which determines how to apply it. Absent when the patch starts with neither a git mailbox header nor a diff --git header.
      See Also:

    • repositoryName

      public final String repositoryName()

      The repository the patch applies to, as named in the source snapshot it was generated against.

      Returns:
      The repository the patch applies to, as named in the source snapshot it was generated against.

    • patchSha256

      public final String patchSha256()

      SHA-256 of the patch's UTF-8 bytes in lowercase hex, computed by Control Plane when it stored the patch.

      Lets a caller confirm the patch it applies is byte-for-byte the one that was reviewed. Computed over the patch bytes, so it is verifiable against patch without trusting this value.

      Returns:
      SHA-256 of the patch's UTF-8 bytes in lowercase hex, computed by Control Plane when it stored the patch.

      Lets a caller confirm the patch it applies is byte-for-byte the one that was reviewed. Computed over the patch bytes, so it is verifiable against patch without trusting this value.

    • sizeBytes

      public final Long sizeBytes()

      Size of the patch in UTF-8 bytes, the unit the digest is computed over.

      Returns:
      Size of the patch in UTF-8 bytes, the unit the digest is computed over.

    • delivery

      public final PatchDelivery delivery()

      Delivery of the patch to the customer's bucket or repository. Absent when the artifact has no delivery destination.

      Returns:
      Delivery of the patch to the customer's bucket or repository. Absent when the artifact has no delivery destination.

    • toBuilder

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

    • builder

      public static PatchBody.Builder builder()

    • serializableBuilderClass

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