Package software.amazon.awssdk.services.iotthingsgraph.model

Class SystemInstanceDescription

java.lang.Object

software.amazon.awssdk.services.iotthingsgraph.model.SystemInstanceDescription

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SystemInstanceDescription.Builder,SystemInstanceDescription>

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

An object that contains a system instance definition and summary information.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SystemInstanceDescription.Builder

Method Summary

Modifier and Type	Method	Description
static SystemInstanceDescription.Builder	builder()
DefinitionDocument	definition()	Returns the value of the Definition property for this object.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	flowActionsRoleArn()	The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a cloud deployment.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValidatedDependencyRevisions()	For responses, this returns true if the service returned a value for the ValidatedDependencyRevisions property.
MetricsConfiguration	metricsConfiguration()	Returns the value of the MetricsConfiguration property for this object.
String	s3BucketName()	The Amazon Simple Storage Service bucket where information about a system instance is stored.
List<SdkField<?>>	sdkFields()
static Class<? extends SystemInstanceDescription.Builder>	serializableBuilderClass()
SystemInstanceSummary	summary()	An object that contains summary information about a system instance.
SystemInstanceDescription.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<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.
Long	validatedNamespaceVersion()	The version of the user's namespace against which the system instance was validated.

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

summary

public final SystemInstanceSummary summary()

An object that contains summary information about a system instance.

Returns:

An object that contains summary information about a system instance.

definition

public final DefinitionDocument definition()

Returns the value of the Definition property for this object.

Returns:

The value of the Definition property for this object.

s3BucketName

public final String s3BucketName()

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.

metricsConfiguration

public final MetricsConfiguration metricsConfiguration()

Returns the value of the MetricsConfiguration property for this object.

Returns:

The value of the MetricsConfiguration property for this object.

validatedNamespaceVersion

public final Long validatedNamespaceVersion()

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.

hasValidatedDependencyRevisions

public final boolean hasValidatedDependencyRevisions()

For responses, this returns true if the service returned a value for the ValidatedDependencyRevisions 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.

validatedDependencyRevisions

public final List<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.

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 hasValidatedDependencyRevisions() method.

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.

flowActionsRoleArn

public final 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.

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.

toBuilder

public SystemInstanceDescription.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SystemInstanceDescription.Builder,SystemInstanceDescription>

builder

public static SystemInstanceDescription.Builder builder()

serializableBuilderClass

public static Class<? extends SystemInstanceDescription.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