Class ComponentSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ComponentSummary.Builder,
ComponentSummary>
An object that returns information about a component summary.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ComponentSummary.Builder
builder()
final String
The name of the component.final String
This string specifies the path to the composite component, starting from the top-level component.final String
The ID of the component type.final String
The name of the property definition set in the request.final String
The description of the component request.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 PropertyGroups property.The property groups.static Class
<? extends ComponentSummary.Builder> final Status
status()
The status of the component type.final String
ThesyncSource
of the sync job, if this entity was created by a sync job.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
-
componentName
The name of the component.
- Returns:
- The name of the component.
-
componentTypeId
The ID of the component type.
- Returns:
- The ID of the component type.
-
definedIn
The name of the property definition set in the request.
- Returns:
- The name of the property definition set in the request.
-
description
The description of the component request.
- Returns:
- The description of the component request.
-
hasPropertyGroups
public final boolean hasPropertyGroups()For responses, this returns true if the service returned a value for the PropertyGroups 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. -
propertyGroups
The property groups.
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
hasPropertyGroups()
method.- Returns:
- The property groups.
-
status
The status of the component type.
- Returns:
- The status of the component type.
-
syncSource
The
syncSource
of the sync job, if this entity was created by a sync job.- Returns:
- The
syncSource
of the sync job, if this entity was created by a sync job.
-
componentPath
This string specifies the path to the composite component, starting from the top-level component.
- Returns:
- This string specifies the path to the composite component, starting from the top-level component.
-
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
-