Class DescribeSigningJobResponse

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

  • Method Details

    • jobId

      public final String jobId()

      The ID of the signing job on output.

      Returns:
      The ID of the signing job on output.

    • source

      public final Source source()

      The object that contains the name of your S3 bucket or your raw code.

      Returns:
      The object that contains the name of your S3 bucket or your raw code.

    • signingMaterial

      public final SigningMaterial signingMaterial()

      The Amazon Resource Name (ARN) of your code signing certificate.

      Returns:
      The Amazon Resource Name (ARN) of your code signing certificate.

    • platformId

      public final String platformId()

      The microcontroller platform to which your signed code image will be distributed.

      Returns:
      The microcontroller platform to which your signed code image will be distributed.

    • platformDisplayName

      public final String platformDisplayName()

      A human-readable name for the signing platform associated with the signing job.

      Returns:
      A human-readable name for the signing platform associated with the signing job.

    • profileName

      public final String profileName()

      The name of the profile that initiated the signing operation.

      Returns:
      The name of the profile that initiated the signing operation.

    • profileVersion

      public final String profileVersion()

      The version of the signing profile used to initiate the signing job.

      Returns:
      The version of the signing profile used to initiate the signing job.

    • overrides

      public final SigningPlatformOverrides overrides()

      A list of any overrides that were applied to the signing operation.

      Returns:
      A list of any overrides that were applied to the signing operation.

    • 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()

      Map of user-assigned key-value pairs used during signing. These values contain any information that you specified for use in your signing job.

      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:
      Map of user-assigned key-value pairs used during signing. These values contain any information that you specified for use in your signing job.

    • createdAt

      public final Instant createdAt()

      Date and time that the signing job was created.

      Returns:
      Date and time that the signing job was created.

    • completedAt

      public final Instant completedAt()

      Date and time that the signing job was completed.

      Returns:
      Date and time that the signing job was completed.

    • signatureExpiresAt

      public final Instant signatureExpiresAt()

      Thr expiration timestamp for the signature generated by the signing job.

      Returns:
      Thr expiration timestamp for the signature generated by the signing job.

    • requestedBy

      public final String requestedBy()

      The IAM principal that requested the signing job.

      Returns:
      The IAM principal that requested the signing job.

    • status

      public final SigningStatus status()

      Status of the signing job.

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

      Returns:
      Status of the signing job.
      See Also:

    • statusAsString

      public final String statusAsString()

      Status of the signing job.

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

      Returns:
      Status of the signing job.
      See Also:

    • statusReason

      public final String statusReason()

      String value that contains the status reason.

      Returns:
      String value that contains the status reason.

    • revocationRecord

      public final SigningJobRevocationRecord revocationRecord()

      A revocation record if the signature generated by the signing job has been revoked. Contains a timestamp and the ID of the IAM entity that revoked the signature.

      Returns:
      A revocation record if the signature generated by the signing job has been revoked. Contains a timestamp and the ID of the IAM entity that revoked the signature.

    • signedObject

      public final SignedObject signedObject()

      Name of the S3 bucket where the signed code image is saved by AWS Signer.

      Returns:
      Name of the S3 bucket where the signed code image is saved by AWS Signer.

    • jobOwner

      public final String jobOwner()

      The AWS account ID of the job owner.

      Returns:
      The AWS account ID of the job owner.

    • jobInvoker

      public final String jobInvoker()

      The IAM entity that initiated the signing job.

      Returns:
      The IAM entity that initiated the signing job.

    • toBuilder

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

    • builder

      public static DescribeSigningJobResponse.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

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