ComponentSummary (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.imagebuilder.model.ComponentSummary

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ComponentSummary
extends Object
implements Serializable, Cloneable, StructuredPojo

A high-level summary of a component.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ComponentSummary()

Constructors
Constructor and Description
`ComponentSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ComponentSummary`	`addTagsEntry(String key, String value)` Add a single Tags entry
`ComponentSummary`	`clearTagsEntries()` Removes all the entries added into Tags.
`ComponentSummary`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) of the component.
`String`	`getChangeDescription()` The change description for the current version of the component.
`String`	`getDateCreated()` The original creation date of the component.
`String`	`getDescription()` The description of the component.
`String`	`getName()` The name of the component.
`Boolean`	`getObfuscate()` Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.
`String`	`getOwner()` The owner of the component.
`String`	`getPlatform()` The operating system platform of the component.
`String`	`getPublisher()` Contains the name of the publisher if this is a third-party component.
`ComponentState`	`getState()` Describes the current status of the component.
`List<String>`	`getSupportedOsVersions()` The operating system (OS) version that the component supports.
`Map<String,String>`	`getTags()` The tags that apply to the component.
`String`	`getType()` The component type specifies whether Image Builder uses the component to build the image or only to test it.
`String`	`getVersion()` The version of the component.
`int`	`hashCode()`
`Boolean`	`isObfuscate()` Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the component.
`void`	`setChangeDescription(String changeDescription)` The change description for the current version of the component.
`void`	`setDateCreated(String dateCreated)` The original creation date of the component.
`void`	`setDescription(String description)` The description of the component.
`void`	`setName(String name)` The name of the component.
`void`	`setObfuscate(Boolean obfuscate)` Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.
`void`	`setOwner(String owner)` The owner of the component.
`void`	`setPlatform(String platform)` The operating system platform of the component.
`void`	`setPublisher(String publisher)` Contains the name of the publisher if this is a third-party component.
`void`	`setState(ComponentState state)` Describes the current status of the component.
`void`	`setSupportedOsVersions(Collection<String> supportedOsVersions)` The operating system (OS) version that the component supports.
`void`	`setTags(Map<String,String> tags)` The tags that apply to the component.
`void`	`setType(String type)` The component type specifies whether Image Builder uses the component to build the image or only to test it.
`void`	`setVersion(String version)` The version of the component.
`String`	`toString()` Returns a string representation of this object.
`ComponentSummary`	`withArn(String arn)` The Amazon Resource Name (ARN) of the component.
`ComponentSummary`	`withChangeDescription(String changeDescription)` The change description for the current version of the component.
`ComponentSummary`	`withDateCreated(String dateCreated)` The original creation date of the component.
`ComponentSummary`	`withDescription(String description)` The description of the component.
`ComponentSummary`	`withName(String name)` The name of the component.
`ComponentSummary`	`withObfuscate(Boolean obfuscate)` Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.
`ComponentSummary`	`withOwner(String owner)` The owner of the component.
`ComponentSummary`	`withPlatform(Platform platform)` The operating system platform of the component.
`ComponentSummary`	`withPlatform(String platform)` The operating system platform of the component.
`ComponentSummary`	`withPublisher(String publisher)` Contains the name of the publisher if this is a third-party component.
`ComponentSummary`	`withState(ComponentState state)` Describes the current status of the component.
`ComponentSummary`	`withSupportedOsVersions(Collection<String> supportedOsVersions)` The operating system (OS) version that the component supports.
`ComponentSummary`	`withSupportedOsVersions(String... supportedOsVersions)` The operating system (OS) version that the component supports.
`ComponentSummary`	`withTags(Map<String,String> tags)` The tags that apply to the component.
`ComponentSummary`	`withType(ComponentType type)` The component type specifies whether Image Builder uses the component to build the image or only to test it.
`ComponentSummary`	`withType(String type)` The component type specifies whether Image Builder uses the component to build the image or only to test it.
`ComponentSummary`	`withVersion(String version)` The version of the component.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ComponentSummary
```
public ComponentSummary()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the component.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the component.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the component.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the component.
  - withArn
```
public ComponentSummary withArn(String arn)
```
    The Amazon Resource Name (ARN) of the component.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the component.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the component.
    
    Parameters:
    
    name - The name of the component.
  - getName
```
public String getName()
```
    The name of the component.
    
    Returns:
    
    The name of the component.
  - withName
```
public ComponentSummary withName(String name)
```
    The name of the component.
    
    Parameters:
    
    name - The name of the component.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersion
```
public void setVersion(String version)
```
    The version of the component.
    
    Parameters:
    
    version - The version of the component.
  - getVersion
```
public String getVersion()
```
    The version of the component.
    
    Returns:
    
    The version of the component.
  - withVersion
```
public ComponentSummary withVersion(String version)
```
    The version of the component.
    
    Parameters:
    
    version - The version of the component.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPlatform
```
public void setPlatform(String platform)
```
    The operating system platform of the component.
    
    Parameters:
    
    platform - The operating system platform of the component.
    
    See Also:
    
    Platform
  - getPlatform
```
public String getPlatform()
```
    The operating system platform of the component.
    
    Returns:
    
    The operating system platform of the component.
    
    See Also:
    
    Platform
  - withPlatform
```
public ComponentSummary withPlatform(String platform)
```
    The operating system platform of the component.
    
    Parameters:
    
    platform - The operating system platform of the component.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Platform
  - withPlatform
```
public ComponentSummary withPlatform(Platform platform)
```
    The operating system platform of the component.
    
    Parameters:
    
    platform - The operating system platform of the component.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Platform
  - getSupportedOsVersions
```
public List<String> getSupportedOsVersions()
```
    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.
    
    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.
  - setSupportedOsVersions
```
public void setSupportedOsVersions(Collection<String> 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.
    
    Parameters:
    
    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.
  - withSupportedOsVersions
```
public ComponentSummary withSupportedOsVersions(String... 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setSupportedOsVersions(java.util.Collection) or withSupportedOsVersions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSupportedOsVersions
```
public ComponentSummary withSupportedOsVersions(Collection<String> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(ComponentState state)
```
    Describes the current status of the component.
    
    Parameters:
    
    state - Describes the current status of the component.
  - getState
```
public ComponentState getState()
```
    Describes the current status of the component.
    
    Returns:
    
    Describes the current status of the component.
  - withState
```
public ComponentSummary withState(ComponentState state)
```
    Describes the current status of the component.
    
    Parameters:
    
    state - Describes the current status of the component.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The component type specifies whether Image Builder uses the component to build the image or only to test it.
    
    Parameters:
    
    type - The component type specifies whether Image Builder uses the component to build the image or only to test it.
    
    See Also:
    
    ComponentType
  - getType
```
public String getType()
```
    The component type specifies whether Image Builder uses the component to build the image or only to test it.
    
    Returns:
    
    The component type specifies whether Image Builder uses the component to build the image or only to test it.
    
    See Also:
    
    ComponentType
  - withType
```
public ComponentSummary withType(String type)
```
    The component type specifies whether Image Builder uses the component to build the image or only to test it.
    
    Parameters:
    
    type - The component type specifies whether Image Builder uses the component to build the image or only to test it.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ComponentType
  - withType
```
public ComponentSummary withType(ComponentType type)
```
    The component type specifies whether Image Builder uses the component to build the image or only to test it.
    
    Parameters:
    
    type - The component type specifies whether Image Builder uses the component to build the image or only to test it.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ComponentType
  - setOwner
```
public void setOwner(String owner)
```
    The owner of the component.
    
    Parameters:
    
    owner - The owner of the component.
  - getOwner
```
public String getOwner()
```
    The owner of the component.
    
    Returns:
    
    The owner of the component.
  - withOwner
```
public ComponentSummary withOwner(String owner)
```
    The owner of the component.
    
    Parameters:
    
    owner - The owner of the component.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description of the component.
    
    Parameters:
    
    description - The description of the component.
  - getDescription
```
public String getDescription()
```
    The description of the component.
    
    Returns:
    
    The description of the component.
  - withDescription
```
public ComponentSummary withDescription(String description)
```
    The description of the component.
    
    Parameters:
    
    description - The description of the component.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setChangeDescription
```
public void setChangeDescription(String changeDescription)
```
    The change description for the current version of the component.
    
    Parameters:
    
    changeDescription - The change description for the current version of the component.
  - getChangeDescription
```
public String getChangeDescription()
```
    The change description for the current version of the component.
    
    Returns:
    
    The change description for the current version of the component.
  - withChangeDescription
```
public ComponentSummary withChangeDescription(String changeDescription)
```
    The change description for the current version of the component.
    
    Parameters:
    
    changeDescription - The change description for the current version of the component.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDateCreated
```
public void setDateCreated(String dateCreated)
```
    The original creation date of the component.
    
    Parameters:
    
    dateCreated - The original creation date of the component.
  - getDateCreated
```
public String getDateCreated()
```
    The original creation date of the component.
    
    Returns:
    
    The original creation date of the component.
  - withDateCreated
```
public ComponentSummary withDateCreated(String dateCreated)
```
    The original creation date of the component.
    
    Parameters:
    
    dateCreated - The original creation date of the component.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    The tags that apply to the component.
    
    Returns:
    
    The tags that apply to the component.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The tags that apply to the component.
    
    Parameters:
    
    tags - The tags that apply to the component.
  - withTags
```
public ComponentSummary withTags(Map<String,String> tags)
```
    The tags that apply to the component.
    
    Parameters:
    
    tags - The tags that apply to the component.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public ComponentSummary addTagsEntry(String key,
                                     String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public ComponentSummary clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPublisher
```
public void setPublisher(String publisher)
```
    Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.
    
    Parameters:
    
    publisher - Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.
  - getPublisher
```
public String getPublisher()
```
    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.
  - withPublisher
```
public ComponentSummary withPublisher(String publisher)
```
    Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.
    
    Parameters:
    
    publisher - Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setObfuscate
```
public void setObfuscate(Boolean obfuscate)
```
    Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.
    
    Parameters:
    
    obfuscate - Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.
  - getObfuscate
```
public Boolean getObfuscate()
```
    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.
  - withObfuscate
```
public ComponentSummary withObfuscate(Boolean obfuscate)
```
    Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.
    
    Parameters:
    
    obfuscate - Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isObfuscate
```
public Boolean isObfuscate()
```
    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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ComponentSummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class ComponentSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ComponentSummary

Method Detail

setArn

getArn

withArn

setName

getName

withName

setVersion

getVersion

withVersion

setPlatform

getPlatform

withPlatform

withPlatform

getSupportedOsVersions

setSupportedOsVersions

withSupportedOsVersions

withSupportedOsVersions

setState

getState

withState

setType

getType

withType

withType

setOwner

getOwner

withOwner

setDescription

getDescription

withDescription

setChangeDescription

getChangeDescription

withChangeDescription

setDateCreated

getDateCreated

withDateCreated

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setPublisher

getPublisher

withPublisher

setObfuscate

getObfuscate

withObfuscate

isObfuscate

toString

equals

hashCode

clone

marshall