Class SigningProfile

java.lang.Object
software.amazon.awssdk.services.signer.model.SigningProfile
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SigningProfile.Builder,SigningProfile>

@Generated("software.amazon.awssdk:codegen") public final class SigningProfile extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SigningProfile.Builder,SigningProfile>

Contains information about the ACM certificates and signing configuration parameters that can be used by a given code signing user.

See Also:
  • Method Details

    • profileName

      public final String profileName()

      The name of the signing profile.

      Returns:
      The name of the signing profile.
    • profileVersion

      public final String profileVersion()

      The version of a signing profile.

      Returns:
      The version of a signing profile.
    • profileVersionArn

      public final String profileVersionArn()

      The ARN of a signing profile, including the profile version.

      Returns:
      The ARN of a signing profile, including the profile version.
    • signingMaterial

      public final SigningMaterial signingMaterial()

      The ACM certificate that is available for use by a signing profile.

      Returns:
      The ACM certificate that is available for use by a signing profile.
    • signatureValidityPeriod

      public final SignatureValidityPeriod signatureValidityPeriod()

      The validity period for a signing job created using this signing profile.

      Returns:
      The validity period for a signing job created using this signing profile.
    • platformId

      public final String platformId()

      The ID of a platform that is available for use by a signing profile.

      Returns:
      The ID of a platform that is available for use by a signing profile.
    • platformDisplayName

      public final String platformDisplayName()

      The name of the signing platform.

      Returns:
      The name of the signing platform.
    • hasSigningParameters

      public final boolean hasSigningParameters()
      For responses, this returns true if the service returned a value for the SigningParameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • signingParameters

      public final Map<String,String> signingParameters()

      The parameters that are available for use by a Signer user.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSigningParameters() method.

      Returns:
      The parameters that are available for use by a Signer user.
    • status

      public final SigningProfileStatus status()

      The status of a signing profile.

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

      Returns:
      The status of a signing profile.
      See Also:
    • statusAsString

      public final String statusAsString()

      The status of a signing profile.

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

      Returns:
      The status of a signing profile.
      See Also:
    • arn

      public final String arn()

      The Amazon Resource Name (ARN) for the signing profile.

      Returns:
      The Amazon Resource Name (ARN) for the signing profile.
    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • tags

      public final Map<String,String> tags()

      A list of tags associated with the signing profile.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      A list of tags associated with the signing profile.
    • toBuilder

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

      public static SigningProfile.Builder builder()
    • serializableBuilderClass

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