Class ComponentSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ComponentSummary.Builder,
ComponentSummary>
A high-level summary of a component.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) of the component.static ComponentSummary.Builder
builder()
final String
The change description for the current version of the component.final String
The original creation date of the component.final String
The description of the component.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 int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SupportedOsVersions property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
name()
The name of the component.final Boolean
Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.final String
owner()
The owner of the component.final Platform
platform()
The operating system platform of the component.final String
The operating system platform of the component.final String
Contains the name of the publisher if this is a third-party component.static Class
<? extends ComponentSummary.Builder> final ComponentState
state()
Describes the current status of the component.The operating system (OS) version that the component supports.tags()
The tags that apply to the component.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.final ComponentType
type()
The component type specifies whether Image Builder uses the component to build the image or only to test it.final String
The component type specifies whether Image Builder uses the component to build the image or only to test it.final String
version()
The version of the component.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
The Amazon Resource Name (ARN) of the component.
- Returns:
- The Amazon Resource Name (ARN) of the component.
-
name
The name of the component.
- Returns:
- The name of the component.
-
version
The version of the component.
- Returns:
- The version of the component.
-
platform
The operating system platform of the component.
If the service returns an enum value that is not available in the current SDK version,
platform
will returnPlatform.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplatformAsString()
.- Returns:
- The operating system platform of the component.
- See Also:
-
platformAsString
The operating system platform of the component.
If the service returns an enum value that is not available in the current SDK version,
platform
will returnPlatform.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplatformAsString()
.- Returns:
- The operating system platform of the component.
- See Also:
-
hasSupportedOsVersions
public final boolean hasSupportedOsVersions()For responses, this returns true if the service returned a value for the SupportedOsVersions 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. -
supportedOsVersions
The operating system (OS) version that the component supports. If the OS information is available, Image Builder performs a prefix match against the base image OS version during image recipe creation.
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
hasSupportedOsVersions()
method.- Returns:
- The operating system (OS) version that the component supports. If the OS information is available, Image Builder performs a prefix match against the base image OS version during image recipe creation.
-
state
Describes the current status of the component.
- Returns:
- Describes the current status of the component.
-
type
The component type specifies whether Image Builder uses the component to build the image or only to test it.
If the service returns an enum value that is not available in the current SDK version,
type
will returnComponentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The component type specifies whether Image Builder uses the component to build the image or only to test it.
- See Also:
-
typeAsString
The component type specifies whether Image Builder uses the component to build the image or only to test it.
If the service returns an enum value that is not available in the current SDK version,
type
will returnComponentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The component type specifies whether Image Builder uses the component to build the image or only to test it.
- See Also:
-
owner
The owner of the component.
- Returns:
- The owner of the component.
-
description
The description of the component.
- Returns:
- The description of the component.
-
changeDescription
The change description for the current version of the component.
- Returns:
- The change description for the current version of the component.
-
dateCreated
The original creation date of the component.
- Returns:
- The original creation date of the component.
-
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 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. -
tags
The tags that apply to the component.
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:
- The tags that apply to the component.
-
publisher
Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.
- Returns:
- Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.
-
obfuscate
Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.
- Returns:
- Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.
-
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<ComponentSummary.Builder,
ComponentSummary> - 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
-