software.amazon.awssdk.services.licensemanager.model

Class GrantedLicense

java.lang.Object

software.amazon.awssdk.services.licensemanager.model.GrantedLicense

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<GrantedLicense.Builder,GrantedLicense>

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

Describes a license that is granted to a grantee.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GrantedLicense.Builder

Method Summary

Modifier and Type	Method and Description
String	beneficiary() Granted license beneficiary.
static GrantedLicense.Builder	builder()
ConsumptionConfiguration	consumptionConfiguration() Configuration for consumption of the license.
String	createTime() Creation time of the granted license.
List<Entitlement>	entitlements() License entitlements.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEntitlements() For responses, this returns true if the service returned a value for the Entitlements property.
int	hashCode()
boolean	hasLicenseMetadata() For responses, this returns true if the service returned a value for the LicenseMetadata property.
String	homeRegion() Home Region of the granted license.
IssuerDetails	issuer() Granted license issuer.
String	licenseArn() Amazon Resource Name (ARN) of the license.
List<Metadata>	licenseMetadata() Granted license metadata.
String	licenseName() License name.
String	productName() Product name.
String	productSKU() Product SKU.
ReceivedMetadata	receivedMetadata() Granted license received metadata.
List<SdkField<?>>	sdkFields()
static Class<? extends GrantedLicense.Builder>	serializableBuilderClass()
LicenseStatus	status() Granted license status.
String	statusAsString() Granted license status.
GrantedLicense.Builder	toBuilder()
String	toString() Returns a string representation of this object.
DatetimeRange	validity() Date and time range during which the granted license is valid, in ISO8601-UTC format.
String	version() Version of the granted license.

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.

Returns:

Amazon Resource Name (ARN) of the license.

licenseName

public final String licenseName()

License name.

Returns:

License name.

productName

public final String productName()

Product name.

Returns:

Product name.

productSKU

public final String productSKU()

Product SKU.

Returns:

Product SKU.

issuer

public final IssuerDetails issuer()

Granted license issuer.

Returns:

Granted license issuer.

homeRegion

public final String homeRegion()

Home Region of the granted license.

Returns:

Home Region of the granted license.

status

public final LicenseStatus status()

Granted license status.

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

Returns:

Granted license status.

See Also:

LicenseStatus

statusAsString

public final String statusAsString()

Granted license status.

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

Returns:

Granted license status.

See Also:

LicenseStatus

validity

public final DatetimeRange validity()

Date and time range during which the granted license is valid, in ISO8601-UTC format.

Returns:

Date and time range during which the granted license is valid, in ISO8601-UTC format.

beneficiary

public final String beneficiary()

Granted license beneficiary.

Returns:

Granted license beneficiary.

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

License entitlements.

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.

consumptionConfiguration

public final ConsumptionConfiguration consumptionConfiguration()

Configuration for consumption of the license.

Returns:

Configuration for consumption of the license.

hasLicenseMetadata

public final boolean hasLicenseMetadata()

For responses, this returns true if the service returned a value for the LicenseMetadata 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.

licenseMetadata

public final List<Metadata> licenseMetadata()

Granted license metadata.

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

Returns:

Granted license metadata.

createTime

public final String createTime()

Creation time of the granted license.

Returns:

Creation time of the granted license.

version

public final String version()

Version of the granted license.

Returns:

Version of the granted license.

receivedMetadata

public final ReceivedMetadata receivedMetadata()

Granted license received metadata.

Returns:

Granted license received metadata.

toBuilder

public GrantedLicense.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GrantedLicense.Builder,GrantedLicense>

builder

public static GrantedLicense.Builder builder()

serializableBuilderClass

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

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo