Class PutSigningProfileRequest

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

  • Method Details

    • profileName

      public final String profileName()

      The name of the signing profile to be created.

      Returns:
      The name of the signing profile to be created.

    • signingMaterial

      public final SigningMaterial signingMaterial()

      The AWS Certificate Manager certificate that will be used to sign code with the new signing profile.

      Returns:
      The AWS Certificate Manager certificate that will be used to sign code with the new signing profile.

    • signatureValidityPeriod

      public final SignatureValidityPeriod signatureValidityPeriod()

      The default validity period override for any signature generated using this signing profile. If unspecified, the default is 135 months.

      Returns:
      The default validity period override for any signature generated using this signing profile. If unspecified, the default is 135 months.

    • platformId

      public final String platformId()

      The ID of the signing platform to be created.

      Returns:
      The ID of the signing platform to be created.

    • overrides

      public final SigningPlatformOverrides overrides()

      A subfield of platform. This specifies any different configuration options that you want to apply to the chosen platform (such as a different hash-algorithm or signing-algorithm).

      Returns:
      A subfield of platform. This specifies any different configuration options that you want to apply to the chosen platform (such as a different hash-algorithm or signing-algorithm).

    • 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 key-value pairs for signing. These can include any information that you want to use during signing.

      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 key-value pairs for signing. These can include any information that you want to use during signing.

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

      Tags to be associated with the signing profile that is being created.

      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:
      Tags to be associated with the signing profile that is being created.

    • toBuilder

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

    • builder

      public static PutSigningProfileRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.