StackServiceComponentResponse (Ambari Server 3.0.0.0-SNAPSHOT API)

java.lang.Object
- org.apache.ambari.server.controller.StackServiceComponentResponse

public class StackServiceComponentResponse
extends Object

Stack service component response.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`StackServiceComponentResponse.StackServiceComponentResponseSwagger` Interface to help correct Swagger documentation generation

Constructor Summary

Constructors
Constructor and Description

StackServiceComponentResponse(ComponentInfo component)
Constructor.

Constructors
Constructor and Description
`StackServiceComponentResponse(ComponentInfo component)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AutoDeployInfo`	`getAutoDeploy()` Get auto deploy information.
`String`	`getBulkCommandsDisplayName()`
`String`	`getBulkCommandsMasterComponentName()`
`String`	`getCardinality()` Get cardinality requirement of component.
`String`	`getComponentCategory()` Get component category.
`String`	`getComponentDisplayName()` Get component display name.
`String`	`getComponentName()` Get component name.
`String`	`getComponentType()`
`List<String>`	`getCustomCommands()` Gets the names of all of the custom commands for this component.
`String`	`getServiceName()` Get service name.
`String`	`getStackName()` Get stack name.
`String`	`getStackVersion()` Get stack version.
`List<String>`	`getVisibleCustomCommands()`
`boolean`	`hasBulkCommands()`
`boolean`	`isClient()` Determine whether the component is a client component.
`boolean`	`isDecommissionAlllowed()` Get whether the components can be decommissioned.
`boolean`	`isMaster()` Determine whether the component is a master component.
`boolean`	`isReassignAlllowed()` Get whether the components can be reassigned.
`boolean`	`isRecoveryEnabled()` Get whether auto start is enabled.
`boolean`	`isRollingRestartSupported()` Get whether the component supports rolling restart
`boolean`	`isVersionAdvertised()` Get whether the components needs to advertise a version.
`void`	`setAutoDeploy(AutoDeployInfo autoDeploy)` Set auto deploy information.
`void`	`setCardinality(String cardinality)` Set component cardinality requirement.
`void`	`setClient(boolean isClient)` Set whether the component is a client component.
`void`	`setComponentCategory(String componentCategory)` Set the component category.
`void`	`setComponentDisplayName(String componentDisplayName)` Set component display name.
`void`	`setComponentName(String componentName)` Set component name.
`void`	`setDecommissionAllowed(String decommissionAllowed)` Set whether the component can be decommissioned.
`void`	`setMaster(boolean isMaster)` Set whether the component is a master component.
`void`	`setReassignAllowed(String reassignAllowed)` Set whether the component can be reassigned.
`void`	`setRecoveryEnabled(boolean recoveryEnabled)` Set whether auto start is enabled.
`void`	`setServiceName(String serviceName)` Set service name.
`void`	`setStackName(String stackName)` Set stack name.
`void`	`setStackVersion(String stackVersion)` Set stack version.
`void`	`setVersionAdvertised(boolean versionAdvertised)` Set whether the component needs to advertise a version.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - StackServiceComponentResponse
```
public StackServiceComponentResponse(ComponentInfo component)
```
    Constructor.
    
    Parameters:
    
    component - the component to generate the response from (not null).
- Method Detail
  - getStackName
```
public String getStackName()
```
    Get stack name.
    
    Returns:
    
    stack name
  - setStackName
```
public void setStackName(String stackName)
```
    Set stack name.
    
    Parameters:
    
    stackName - stack name
  - getStackVersion
```
public String getStackVersion()
```
    Get stack version.
    
    Returns:
    
    stack version
  - setStackVersion
```
public void setStackVersion(String stackVersion)
```
    Set stack version.
    
    Parameters:
    
    stackVersion - stack version
  - getServiceName
```
public String getServiceName()
```
    Get service name.
    
    Returns:
    
    service name
  - setServiceName
```
public void setServiceName(String serviceName)
```
    Set service name.
    
    Parameters:
    
    serviceName - service name
  - getComponentName
```
public String getComponentName()
```
    Get component name.
    
    Returns:
    
    component name
  - setComponentName
```
public void setComponentName(String componentName)
```
    Set component name.
    
    Parameters:
    
    componentName - component name
  - getComponentDisplayName
```
public String getComponentDisplayName()
```
    Get component display name.
    
    Returns:
    
    component display name
  - setComponentDisplayName
```
public void setComponentDisplayName(String componentDisplayName)
```
    Set component display name.
    
    Parameters:
    
    componentDisplayName - component display name
  - getComponentCategory
```
public String getComponentCategory()
```
    Get component category.
    
    Returns:
    
    component category
  - setComponentCategory
```
public void setComponentCategory(String componentCategory)
```
    Set the component category.
    
    Parameters:
    
    componentCategory - component category
  - isClient
```
public boolean isClient()
```
    Determine whether the component is a client component.
    
    Returns:
    
    whether the component is a client component
  - setClient
```
public void setClient(boolean isClient)
```
    Set whether the component is a client component.
    
    Parameters:
    
    isClient - whether the component is a client
  - isMaster
```
public boolean isMaster()
```
    Determine whether the component is a master component.
    
    Returns:
    
    whether the component is a master component
  - setMaster
```
public void setMaster(boolean isMaster)
```
    Set whether the component is a master component.
    
    Parameters:
    
    isMaster - whether the component is a master
  - getCardinality
```
public String getCardinality()
```
    Get cardinality requirement of component.
    
    Returns:
    
    component cardinality requirement
  - setCardinality
```
public void setCardinality(String cardinality)
```
    Set component cardinality requirement.
    
    Parameters:
    
    cardinality - cardinality requirement
  - isVersionAdvertised
```
public boolean isVersionAdvertised()
```
    Get whether the components needs to advertise a version.
    
    Returns:
    
    Whether the components needs to advertise a version
  - setVersionAdvertised
```
public void setVersionAdvertised(boolean versionAdvertised)
```
    Set whether the component needs to advertise a version.
    
    Parameters:
    
    versionAdvertised - whether the component needs to advertise a version
  - isDecommissionAlllowed
```
public boolean isDecommissionAlllowed()
```
    Get whether the components can be decommissioned.
    
    Returns:
    
    Whether the components can be decommissioned
  - setDecommissionAllowed
```
public void setDecommissionAllowed(String decommissionAllowed)
```
    Set whether the component can be decommissioned.
    
    Parameters:
    
    decommissionAllowed - whether the component can be decommissioned
  - isRollingRestartSupported
```
public boolean isRollingRestartSupported()
```
    Get whether the component supports rolling restart
    
    Returns:
    
    whether the component supports rolling restart
  - isReassignAlllowed
```
public boolean isReassignAlllowed()
```
    Get whether the components can be reassigned.
    
    Returns:
    
    Whether the components can be reassigned
  - setReassignAllowed
```
public void setReassignAllowed(String reassignAllowed)
```
    Set whether the component can be reassigned.
    
    Parameters:
    
    reassignAllowed - whether the component can be reassigned
  - isRecoveryEnabled
```
public boolean isRecoveryEnabled()
```
    Get whether auto start is enabled.
    
    Returns:
    
    True or false.
  - setRecoveryEnabled
```
public void setRecoveryEnabled(boolean recoveryEnabled)
```
    Set whether auto start is enabled.
    
    Parameters:
    
    recoveryEnabled - True or false.
  - getAutoDeploy
```
public AutoDeployInfo getAutoDeploy()
```
    Get auto deploy information.
    
    Returns:
    
    auto deploy information
  - setAutoDeploy
```
public void setAutoDeploy(AutoDeployInfo autoDeploy)
```
    Set auto deploy information.
    
    Parameters:
    
    autoDeploy - auto deploy info
  - getCustomCommands
```
public List<String> getCustomCommands()
```
    Gets the names of all of the custom commands for this component.
    
    Returns:
    
    the commands or an empty list (never null).
  - getVisibleCustomCommands
```
public List<String> getVisibleCustomCommands()
```
  - hasBulkCommands
```
public boolean hasBulkCommands()
```
  - getBulkCommandsDisplayName
```
public String getBulkCommandsDisplayName()
```
  - getBulkCommandsMasterComponentName
```
public String getBulkCommandsMasterComponentName()
```
  - getComponentType
```
public String getComponentType()
```

Class StackServiceComponentResponse

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StackServiceComponentResponse

Method Detail

getStackName

setStackName

getStackVersion

setStackVersion

getServiceName

setServiceName

getComponentName

setComponentName

getComponentDisplayName

setComponentDisplayName

getComponentCategory

setComponentCategory

isClient

setClient

isMaster

setMaster

getCardinality

setCardinality

isVersionAdvertised

setVersionAdvertised

isDecommissionAlllowed

setDecommissionAllowed

isRollingRestartSupported

isReassignAlllowed

setReassignAllowed

isRecoveryEnabled

setRecoveryEnabled

getAutoDeploy

setAutoDeploy

getCustomCommands

getVisibleCustomCommands

hasBulkCommands

getBulkCommandsDisplayName

getBulkCommandsMasterComponentName

getComponentType