Class LicenseConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<LicenseConfiguration.Builder,
LicenseConfiguration>
A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (licensing by instance, socket, CPU, or vCPU), allowed tenancy (shared tenancy, Dedicated Instance, Dedicated Host, or all of these), host affinity (how long a VM must be associated with a host), and the number of licenses purchased and used.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionAutomated discovery information.static LicenseConfiguration.Builder
builder()
final Long
Number of licenses consumed.final List
<ConsumedLicenseSummary> Summaries for licenses consumed by various resources.final String
Description of the license configuration.final Boolean
When true, disassociates a resource when software is uninstalled.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the ConsumedLicenseSummaryList property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the LicenseRules property.final boolean
For responses, this returns true if the service returned a value for the ManagedResourceSummaryList property.final boolean
For responses, this returns true if the service returned a value for the ProductInformationList property.final String
Amazon Resource Name (ARN) of the license configuration.final String
Unique ID of the license configuration.final Long
Number of licenses managed by the license configuration.final Boolean
Number of available licenses as a hard limit.final LicenseCountingType
Dimension to use to track the license inventory.final String
Dimension to use to track the license inventory.License rules.final List
<ManagedResourceSummary> Summaries for managed resources.final String
name()
Name of the license configuration.final String
Account ID of the license configuration's owner.final List
<ProductInformation> Product information.static Class
<? extends LicenseConfiguration.Builder> final String
status()
Status of the license configuration.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
licenseConfigurationId
Unique ID of the license configuration.
- Returns:
- Unique ID of the license configuration.
-
licenseConfigurationArn
Amazon Resource Name (ARN) of the license configuration.
- Returns:
- Amazon Resource Name (ARN) of the license configuration.
-
name
Name of the license configuration.
- Returns:
- Name of the license configuration.
-
description
Description of the license configuration.
- Returns:
- Description of the license configuration.
-
licenseCountingType
Dimension to use to track the license inventory.
If the service returns an enum value that is not available in the current SDK version,
licenseCountingType
will returnLicenseCountingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlicenseCountingTypeAsString()
.- Returns:
- Dimension to use to track the license inventory.
- See Also:
-
licenseCountingTypeAsString
Dimension to use to track the license inventory.
If the service returns an enum value that is not available in the current SDK version,
licenseCountingType
will returnLicenseCountingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlicenseCountingTypeAsString()
.- Returns:
- Dimension to use to track the license inventory.
- See Also:
-
hasLicenseRules
public final boolean hasLicenseRules()For responses, this returns true if the service returned a value for the LicenseRules property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
licenseRules
License rules.
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
hasLicenseRules()
method.- Returns:
- License rules.
-
licenseCount
Number of licenses managed by the license configuration.
- Returns:
- Number of licenses managed by the license configuration.
-
licenseCountHardLimit
Number of available licenses as a hard limit.
- Returns:
- Number of available licenses as a hard limit.
-
disassociateWhenNotFound
When true, disassociates a resource when software is uninstalled.
- Returns:
- When true, disassociates a resource when software is uninstalled.
-
consumedLicenses
Number of licenses consumed.
- Returns:
- Number of licenses consumed.
-
status
Status of the license configuration.
- Returns:
- Status of the license configuration.
-
ownerAccountId
Account ID of the license configuration's owner.
- Returns:
- Account ID of the license configuration's owner.
-
hasConsumedLicenseSummaryList
public final boolean hasConsumedLicenseSummaryList()For responses, this returns true if the service returned a value for the ConsumedLicenseSummaryList property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
consumedLicenseSummaryList
Summaries for licenses consumed by various resources.
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
hasConsumedLicenseSummaryList()
method.- Returns:
- Summaries for licenses consumed by various resources.
-
hasManagedResourceSummaryList
public final boolean hasManagedResourceSummaryList()For responses, this returns true if the service returned a value for the ManagedResourceSummaryList property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
managedResourceSummaryList
Summaries for managed resources.
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
hasManagedResourceSummaryList()
method.- Returns:
- Summaries for managed resources.
-
hasProductInformationList
public final boolean hasProductInformationList()For responses, this returns true if the service returned a value for the ProductInformationList property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
productInformationList
Product information.
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
hasProductInformationList()
method.- Returns:
- Product information.
-
automatedDiscoveryInformation
Automated discovery information.
- Returns:
- Automated discovery information.
-
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 interfaceToCopyableBuilder<LicenseConfiguration.Builder,
LicenseConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-