SystemInstanceDescription (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.iotthingsgraph.model

Class SystemInstanceDescription

java.lang.Object
- com.amazonaws.services.iotthingsgraph.model.SystemInstanceDescription

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SystemInstanceDescription
extends Object
implements Serializable, Cloneable, StructuredPojo 
```
An object that contains a system instance definition and summary information.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SystemInstanceDescription ()

Constructors
Constructor and Description
`SystemInstanceDescription ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`SystemInstanceDescription`	`clone ()`
`boolean`	`equals (Object obj)`
`DefinitionDocument`	`getDefinition ()`
`String`	`getFlowActionsRoleArn ()` The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a cloud deployment.
`MetricsConfiguration`	`getMetricsConfiguration ()`
`String`	`getS3BucketName ()` The Amazon Simple Storage Service bucket where information about a system instance is stored.
`SystemInstanceSummary`	`getSummary ()` An object that contains summary information about a system instance.
`List<DependencyRevision>`	`getValidatedDependencyRevisions ()` A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.
`Long`	`getValidatedNamespaceVersion ()` The version of the user's namespace against which the system instance was validated.
`int`	`hashCode ()`
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDefinition (DefinitionDocument definition)`
`void`	`setFlowActionsRoleArn (String flowActionsRoleArn)` The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a cloud deployment.
`void`	`setMetricsConfiguration (MetricsConfiguration metricsConfiguration)`
`void`	`setS3BucketName (String s3BucketName)` The Amazon Simple Storage Service bucket where information about a system instance is stored.
`void`	`setSummary (SystemInstanceSummary summary)` An object that contains summary information about a system instance.
`void`	`setValidatedDependencyRevisions (Collection<DependencyRevision> validatedDependencyRevisions)` A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.
`void`	`setValidatedNamespaceVersion (Long validatedNamespaceVersion)` The version of the user's namespace against which the system instance was validated.
`String`	`toString ()` Returns a string representation of this object.
`SystemInstanceDescription`	`withDefinition (DefinitionDocument definition)`
`SystemInstanceDescription`	`withFlowActionsRoleArn (String flowActionsRoleArn)` The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a cloud deployment.
`SystemInstanceDescription`	`withMetricsConfiguration (MetricsConfiguration metricsConfiguration)`
`SystemInstanceDescription`	`withS3BucketName (String s3BucketName)` The Amazon Simple Storage Service bucket where information about a system instance is stored.
`SystemInstanceDescription`	`withSummary (SystemInstanceSummary summary)` An object that contains summary information about a system instance.
`SystemInstanceDescription`	`withValidatedDependencyRevisions (Collection<DependencyRevision> validatedDependencyRevisions)` A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.
`SystemInstanceDescription`	`withValidatedDependencyRevisions (DependencyRevision... validatedDependencyRevisions)` A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.
`SystemInstanceDescription`	`withValidatedNamespaceVersion (Long validatedNamespaceVersion)` The version of the user's namespace against which the system instance was validated.

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

- Constructor Detail
  - SystemInstanceDescription
```
public SystemInstanceDescription()
```
- Method Detail
  - setSummary
```
public void setSummary(SystemInstanceSummary summary)
```
    An object that contains summary information about a system instance.
    
    Parameters:
    
    summary - An object that contains summary information about a system instance.
  - getSummary
```
public SystemInstanceSummary getSummary()
```
    An object that contains summary information about a system instance.
    
    Returns:
    
    An object that contains summary information about a system instance.
  - withSummary
```
public SystemInstanceDescription withSummary(SystemInstanceSummary summary)
```
    An object that contains summary information about a system instance.
    
    Parameters:
    
    summary - An object that contains summary information about a system instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefinition
```
public void setDefinition(DefinitionDocument definition)
```
    Parameters:
    
    definition -
  - getDefinition
```
public DefinitionDocument getDefinition()
```
    Returns:
  - withDefinition
```
public SystemInstanceDescription withDefinition(DefinitionDocument definition)
```
    Parameters:
    
    definition -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setS3BucketName
```
public void setS3BucketName(String s3BucketName)
```
    The Amazon Simple Storage Service bucket where information about a system instance is stored.
    
    Parameters:
    
    s3BucketName - The Amazon Simple Storage Service bucket where information about a system instance is stored.
  - getS3BucketName
```
public String getS3BucketName()
```
    The Amazon Simple Storage Service bucket where information about a system instance is stored.
    
    Returns:
    
    The Amazon Simple Storage Service bucket where information about a system instance is stored.
  - withS3BucketName
```
public SystemInstanceDescription withS3BucketName(String s3BucketName)
```
    The Amazon Simple Storage Service bucket where information about a system instance is stored.
    
    Parameters:
    
    s3BucketName - The Amazon Simple Storage Service bucket where information about a system instance is stored.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetricsConfiguration
```
public void setMetricsConfiguration(MetricsConfiguration metricsConfiguration)
```
    Parameters:
    
    metricsConfiguration -
  - getMetricsConfiguration
```
public MetricsConfiguration getMetricsConfiguration()
```
    Returns:
  - withMetricsConfiguration
```
public SystemInstanceDescription withMetricsConfiguration(MetricsConfiguration metricsConfiguration)
```
    Parameters:
    
    metricsConfiguration -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setValidatedNamespaceVersion
```
public void setValidatedNamespaceVersion(Long validatedNamespaceVersion)
```
    The version of the user's namespace against which the system instance was validated.
    
    Parameters:
    
    validatedNamespaceVersion - The version of the user's namespace against which the system instance was validated.
  - getValidatedNamespaceVersion
```
public Long getValidatedNamespaceVersion()
```
    The version of the user's namespace against which the system instance was validated.
    
    Returns:
    
    The version of the user's namespace against which the system instance was validated.
  - withValidatedNamespaceVersion
```
public SystemInstanceDescription withValidatedNamespaceVersion(Long validatedNamespaceVersion)
```
    The version of the user's namespace against which the system instance was validated.
    
    Parameters:
    
    validatedNamespaceVersion - The version of the user's namespace against which the system instance was validated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getValidatedDependencyRevisions
```
public List<DependencyRevision> getValidatedDependencyRevisions()
```
    A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.
    
    Returns:
    
    A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.
  - setValidatedDependencyRevisions
```
public void setValidatedDependencyRevisions(Collection<DependencyRevision> validatedDependencyRevisions)
```
    A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.
    
    Parameters:
    
    validatedDependencyRevisions - A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.
  - withValidatedDependencyRevisions
```
public SystemInstanceDescription withValidatedDependencyRevisions(DependencyRevision... validatedDependencyRevisions)
```
    A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.
    
    NOTE: This method appends the values to the existing list (if any). Use setValidatedDependencyRevisions(java.util.Collection) or withValidatedDependencyRevisions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    validatedDependencyRevisions - A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withValidatedDependencyRevisions
```
public SystemInstanceDescription withValidatedDependencyRevisions(Collection<DependencyRevision> validatedDependencyRevisions)
```
    A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.
    
    Parameters:
    
    validatedDependencyRevisions - A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFlowActionsRoleArn
```
public void setFlowActionsRoleArn(String flowActionsRoleArn)
```
    The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a cloud deployment. This role must have read and write permissionss to AWS Lambda and AWS IoT and to any other AWS services that the flow uses.
    
    Parameters:
    
    flowActionsRoleArn - The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a cloud deployment. This role must have read and write permissionss to AWS Lambda and AWS IoT and to any other AWS services that the flow uses.
  - getFlowActionsRoleArn
```
public String getFlowActionsRoleArn()
```
    The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a cloud deployment. This role must have read and write permissionss to AWS Lambda and AWS IoT and to any other AWS services that the flow uses.
    
    Returns:
    
    The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a cloud deployment. This role must have read and write permissionss to AWS Lambda and AWS IoT and to any other AWS services that the flow uses.
  - withFlowActionsRoleArn
```
public SystemInstanceDescription withFlowActionsRoleArn(String flowActionsRoleArn)
```
    The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a cloud deployment. This role must have read and write permissionss to AWS Lambda and AWS IoT and to any other AWS services that the flow uses.
    
    Parameters:
    
    flowActionsRoleArn - The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a cloud deployment. This role must have read and write permissionss to AWS Lambda and AWS IoT and to any other AWS services that the flow uses.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 SystemInstanceDescription 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.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class SystemInstanceDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SystemInstanceDescription

Method Detail

setSummary

getSummary

withSummary

setDefinition

getDefinition

withDefinition

setS3BucketName

getS3BucketName

withS3BucketName

setMetricsConfiguration

getMetricsConfiguration

withMetricsConfiguration

setValidatedNamespaceVersion

getValidatedNamespaceVersion

withValidatedNamespaceVersion

getValidatedDependencyRevisions

setValidatedDependencyRevisions

withValidatedDependencyRevisions

withValidatedDependencyRevisions

setFlowActionsRoleArn

getFlowActionsRoleArn

withFlowActionsRoleArn

toString

equals

hashCode

clone

marshall