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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CheckoutBorrowLicenseRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CheckoutBorrowLicenseRequest.Builder	builder()
List<Metadata>	checkoutMetadata()	Information about constraints.
String	clientToken()	Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
DigitalSignatureMethod	digitalSignatureMethod()	Digital signature method.
String	digitalSignatureMethodAsString()	Digital signature method.
List<EntitlementData>	entitlements()	License entitlements.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCheckoutMetadata()	For responses, this returns true if the service returned a value for the CheckoutMetadata property.
boolean	hasEntitlements()	For responses, this returns true if the service returned a value for the Entitlements property.
int	hashCode()
String	licenseArn()	Amazon Resource Name (ARN) of the license.
String	nodeId()	Node ID.
List<SdkField<?>>	sdkFields()
static Class<? extends CheckoutBorrowLicenseRequest.Builder>	serializableBuilderClass()
CheckoutBorrowLicenseRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

DigitalSignatureMethod

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:

DigitalSignatureMethod

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

Specified by:

toBuilder in interface ToCopyableBuilder<CheckoutBorrowLicenseRequest.Builder,CheckoutBorrowLicenseRequest>

Specified by:

toBuilder in class LicenseManagerRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo