Package software.amazon.awssdk.services.licensemanager.model

Class CheckoutBorrowLicenseRequest

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

  • Method Details

    • licenseArn

      public final String licenseArn()

      Amazon Resource Name (ARN) of the license. The license must use the borrow consumption configuration.

      Returns:
      Amazon Resource Name (ARN) of the license. The license must use the borrow consumption configuration.

    • hasEntitlements

      public final boolean hasEntitlements()
      For responses, this returns true if the service returned a value for the Entitlements 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.

    • entitlements

      public final List<EntitlementData> entitlements()

      License entitlements. Partial checkouts are not supported.

      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 hasEntitlements() method.

      Returns:
      License entitlements. Partial checkouts are not supported.

    • digitalSignatureMethod

      public final DigitalSignatureMethod digitalSignatureMethod()

      Digital signature method. The possible value is JSON Web Signature (JWS) algorithm PS384. For more information, see RFC 7518 Digital Signature with RSASSA-PSS.

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

      Returns:
      Digital signature method. The possible value is JSON Web Signature (JWS) algorithm PS384. For more information, see RFC 7518 Digital Signature with RSASSA-PSS.
      See Also:

    • digitalSignatureMethodAsString

      public final String digitalSignatureMethodAsString()

      Digital signature method. The possible value is JSON Web Signature (JWS) algorithm PS384. For more information, see RFC 7518 Digital Signature with RSASSA-PSS.

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

      Returns:
      Digital signature method. The possible value is JSON Web Signature (JWS) algorithm PS384. For more information, see RFC 7518 Digital Signature with RSASSA-PSS.
      See Also:

    • nodeId

      public final String nodeId()

      Node ID.

      Returns:
      Node ID.

    • hasCheckoutMetadata

      public final boolean hasCheckoutMetadata()
      For responses, this returns true if the service returned a value for the CheckoutMetadata 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.

    • checkoutMetadata

      public final List<Metadata> checkoutMetadata()

      Information about constraints.

      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 hasCheckoutMetadata() method.

      Returns:
      Information about constraints.

    • clientToken

      public final String clientToken()

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

      Returns:
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    • toBuilder

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

    • builder

      public static CheckoutBorrowLicenseRequest.Builder builder()

    • serializableBuilderClass

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