java.lang.Object
- software.amazon.awssdk.services.ssmsap.model.Component

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Component.Builder,Component>

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

The SAP component of your application.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Component.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`String`	`applicationId()`	The ID of the application.
`String`	`arn()`	The Amazon Resource Name (ARN) of the component.
`AssociatedHost`	`associatedHost()`	The associated host of the component.
`static Component.Builder`	`builder()`
`List<String>`	`childComponents()`	The child components of a highly available environment.
`String`	`componentId()`	The ID of the component.
`ComponentType`	`componentType()`	The type of the component.
`String`	`componentTypeAsString()`	The type of the component.
`DatabaseConnection`	`databaseConnection()`	The connection specifications for the database of the component.
`List<String>`	`databases()`	The SAP HANA databases of the component.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasChildComponents()`	For responses, this returns true if the service returned a value for the ChildComponents property.
`boolean`	`hasDatabases()`	For responses, this returns true if the service returned a value for the Databases property.
`int`	`hashCode()`
`boolean`	`hasHosts()`	Deprecated. This shape is no longer used.
`String`	`hdbVersion()`	The SAP HANA version of the component.
`List<Host>`	`hosts()`	Deprecated. This shape is no longer used.
`Instant`	`lastUpdated()`	The time at which the component was last updated.
`String`	`parentComponent()`	The parent component of a highly available environment.
`String`	`primaryHost()`	Deprecated. This shape is no longer used.
`Resilience`	`resilience()`	Details of the SAP HANA system replication for the component.
`String`	`sapFeature()`	The SAP feature of the component.
`String`	`sapHostname()`	The hostname of the component.
`String`	`sapKernelVersion()`	The kernel version of the component.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Component.Builder>`	`serializableBuilderClass()`
`String`	`sid()`	The SAP System Identifier of the application component.
`ComponentStatus`	`status()`	The status of the component.
`String`	`statusAsString()`	The status of the component.
`String`	`systemNumber()`	The SAP system number of the application component.
`Component.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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
  - componentId
```
public final String componentId()
```
    The ID of the component.
    
    Returns:
    
    The ID of the component.
  - sid
```
public final String sid()
```
    The SAP System Identifier of the application component.
    
    Returns:
    
    The SAP System Identifier of the application component.
  - systemNumber
```
public final String systemNumber()
```
    The SAP system number of the application component.
    
    Returns:
    
    The SAP system number of the application component.
  - parentComponent
```
public final String parentComponent()
```
    The parent component of a highly available environment. For example, in a highly available SAP on AWS workload, the parent component consists of the entire setup, including the child components.
    
    Returns:
    
    The parent component of a highly available environment. For example, in a highly available SAP on AWS workload, the parent component consists of the entire setup, including the child components.
  - hasChildComponents
```
public final boolean hasChildComponents()
```
    For responses, this returns true if the service returned a value for the ChildComponents 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.
  - childComponents
```
public final List<String> childComponents()
```
    The child components of a highly available environment. For example, in a highly available SAP on AWS workload, the child component consists of the primary and secondar instances.
    
    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 hasChildComponents() method.
    
    Returns:
    
    The child components of a highly available environment. For example, in a highly available SAP on AWS workload, the child component consists of the primary and secondar instances.
  - applicationId
```
public final String applicationId()
```
    The ID of the application.
    
    Returns:
    
    The ID of the application.
  - componentType
```
public final ComponentType componentType()
```
    The type of the component.
    
    If the service returns an enum value that is not available in the current SDK version, componentType will return ComponentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from componentTypeAsString().
    
    Returns:
    
    The type of the component.
    
    See Also:
    
    ComponentType
  - componentTypeAsString
```
public final String componentTypeAsString()
```
    The type of the component.
    
    If the service returns an enum value that is not available in the current SDK version, componentType will return ComponentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from componentTypeAsString().
    
    Returns:
    
    The type of the component.
    
    See Also:
    
    ComponentType
  - status
```
public final ComponentStatus status()
```
    The status of the component.
    
    ACTIVATED - this status has been deprecated.
    
    STARTING - the component is in the process of being started.
    
    STOPPED - the component is not running.
    
    STOPPING - the component is in the process of being stopped.
    
    RUNNING - the component is running.
    
    RUNNING_WITH_ERROR - one or more child component(s) of the parent component is not running. Call GetComponent to review the status of each child component.
    
    UNDEFINED - AWS Systems Manager for SAP cannot provide the component status based on the discovered information. Verify your SAP application.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ComponentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    
    The status of the component.
    
    ACTIVATED - this status has been deprecated.
    
    STARTING - the component is in the process of being started.
    
    STOPPED - the component is not running.
    
    STOPPING - the component is in the process of being stopped.
    
    RUNNING - the component is running.
    
    RUNNING_WITH_ERROR - one or more child component(s) of the parent component is not running. Call GetComponent to review the status of each child component.
    
    UNDEFINED - AWS Systems Manager for SAP cannot provide the component status based on the discovered information. Verify your SAP application.
    
    See Also:
    
    ComponentStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of the component.
    
    ACTIVATED - this status has been deprecated.
    
    STARTING - the component is in the process of being started.
    
    STOPPED - the component is not running.
    
    STOPPING - the component is in the process of being stopped.
    
    RUNNING - the component is running.
    
    RUNNING_WITH_ERROR - one or more child component(s) of the parent component is not running. Call GetComponent to review the status of each child component.
    
    UNDEFINED - AWS Systems Manager for SAP cannot provide the component status based on the discovered information. Verify your SAP application.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ComponentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    
    The status of the component.
    
    ACTIVATED - this status has been deprecated.
    
    STARTING - the component is in the process of being started.
    
    STOPPED - the component is not running.
    
    STOPPING - the component is in the process of being stopped.
    
    RUNNING - the component is running.
    
    RUNNING_WITH_ERROR - one or more child component(s) of the parent component is not running. Call GetComponent to review the status of each child component.
    
    UNDEFINED - AWS Systems Manager for SAP cannot provide the component status based on the discovered information. Verify your SAP application.
    
    See Also:
    
    ComponentStatus
  - sapHostname
```
public final String sapHostname()
```
    The hostname of the component.
    
    Returns:
    
    The hostname of the component.
  - sapFeature
```
public final String sapFeature()
```
    The SAP feature of the component.
    
    Returns:
    
    The SAP feature of the component.
  - sapKernelVersion
```
public final String sapKernelVersion()
```
    The kernel version of the component.
    
    Returns:
    
    The kernel version of the component.
  - hdbVersion
```
public final String hdbVersion()
```
    The SAP HANA version of the component.
    
    Returns:
    
    The SAP HANA version of the component.
  - resilience
```
public final Resilience resilience()
```
    Details of the SAP HANA system replication for the component.
    
    Returns:
    
    Details of the SAP HANA system replication for the component.
  - associatedHost
```
public final AssociatedHost associatedHost()
```
    The associated host of the component.
    
    Returns:
    
    The associated host of the component.
  - hasDatabases
```
public final boolean hasDatabases()
```
    For responses, this returns true if the service returned a value for the Databases 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.
  - databases
```
public final List<String> databases()
```
    The SAP HANA databases of 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 hasDatabases() method.
    
    Returns:
    
    The SAP HANA databases of the component.
  - hasHosts
```
@Deprecated
public final boolean hasHosts()
```
    Deprecated.
    This shape is no longer used. Please use AssociatedHost.
    
    For responses, this returns true if the service returned a value for the Hosts 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.
  - hosts
```
@Deprecated
public final List<Host> hosts()
```
    Deprecated.
    This shape is no longer used. Please use AssociatedHost.
    
    The hosts of 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 hasHosts() method.
    
    Returns:
    
    The hosts of the component.
  - primaryHost
```
@Deprecated
public final String primaryHost()
```
    Deprecated.
    This shape is no longer used. Please use AssociatedHost.
    
    The primary host of the component.
    
    Returns:
    
    The primary host of the component.
  - databaseConnection
```
public final DatabaseConnection databaseConnection()
```
    The connection specifications for the database of the component.
    
    Returns:
    
    The connection specifications for the database of the component.
  - lastUpdated
```
public final Instant lastUpdated()
```
    The time at which the component was last updated.
    
    Returns:
    
    The time at which the component was last updated.
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the component.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the component.
  - toBuilder
```
public Component.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Component.Builder,Component>
  - builder
```
public static Component.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Component.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

Class Component

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

componentId

sid

systemNumber

parentComponent

hasChildComponents

childComponents

applicationId

componentType

componentTypeAsString

status

statusAsString

sapHostname

sapFeature

sapKernelVersion

hdbVersion

resilience

associatedHost

hasDatabases

databases

hasHosts

hosts

primaryHost

databaseConnection

lastUpdated

arn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields