Class GetPackageVersionReadmeResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.codeartifact.model.CodeartifactResponse
software.amazon.awssdk.services.codeartifact.model.GetPackageVersionReadmeResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetPackageVersionReadmeResponse.Builder,GetPackageVersionReadmeResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetPackageVersionReadmeResponse extends CodeartifactResponse implements ToCopyableBuilder<GetPackageVersionReadmeResponse.Builder,GetPackageVersionReadmeResponse>

  • Method Details

    • format

      public final PackageFormat format()

      The format of the package with the requested readme file.

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

      Returns:
      The format of the package with the requested readme file.
      See Also:

    • formatAsString

      public final String formatAsString()

      The format of the package with the requested readme file.

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

      Returns:
      The format of the package with the requested readme file.
      See Also:

    • namespace

      public final String namespace()

      The namespace of the package version with the requested readme file. The package component that specifies its namespace depends on its type. For example:

      • The namespace of a Maven package version is its groupId.

      • The namespace of an npm or Swift package version is its scope.

      • The namespace of a generic package is its namespace.

      • Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

      Returns:
      The namespace of the package version with the requested readme file. The package component that specifies its namespace depends on its type. For example:

      • The namespace of a Maven package version is its groupId.

      • The namespace of an npm or Swift package version is its scope.

      • The namespace of a generic package is its namespace.

      • Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

    • packageValue

      public final String packageValue()

      The name of the package that contains the returned readme file.

      Returns:
      The name of the package that contains the returned readme file.

    • version

      public final String version()

      The version of the package with the requested readme file.

      Returns:
      The version of the package with the requested readme file.

    • versionRevision

      public final String versionRevision()

      The current revision associated with the package version.

      Returns:
      The current revision associated with the package version.

    • readme

      public final String readme()

      The text of the returned readme file.

      Returns:
      The text of the returned readme file.

    • toBuilder

      public GetPackageVersionReadmeResponse.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<GetPackageVersionReadmeResponse.Builder,GetPackageVersionReadmeResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetPackageVersionReadmeResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.