Package software.amazon.awssdk.services.resiliencehub.model

Class PhysicalResource

java.lang.Object

software.amazon.awssdk.services.resiliencehub.model.PhysicalResource

All Implemented Interfaces:

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

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

Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or an Resilience Hub-native identifier.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PhysicalResource.Builder

Method Summary

Modifier and Type	Method	Description
Map<String,List<String>>	additionalInfo()	Additional configuration parameters for an Resilience Hub application.
List<AppComponent>	appComponents()	The application components that belong to this resource.
static PhysicalResource.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	excluded()	Indicates if a resource is included or excluded from the assessment.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAdditionalInfo()	For responses, this returns true if the service returned a value for the AdditionalInfo property.
boolean	hasAppComponents()	For responses, this returns true if the service returned a value for the AppComponents property.
int	hashCode()
LogicalResourceId	logicalResourceId()	Logical identifier of the resource.
String	parentResourceName()	Name of the parent resource.
PhysicalResourceId	physicalResourceId()	Identifier of the physical resource.
String	resourceName()	The name of the resource.
String	resourceType()	The type of resource.
List<SdkField<?>>	sdkFields()
static Class<? extends PhysicalResource.Builder>	serializableBuilderClass()
ResourceSourceType	sourceType()	Type of input source.
String	sourceTypeAsString()	Type of input source.
PhysicalResource.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

hasAdditionalInfo

public final boolean hasAdditionalInfo()

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

additionalInfo

public final Map<String,List<String>> additionalInfo()

Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

Key: "failover-regions"

Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

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

Returns:

Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

Key: "failover-regions"

Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

hasAppComponents

public final boolean hasAppComponents()

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

appComponents

public final List<AppComponent> appComponents()

The application components that belong to this resource.

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

Returns:

The application components that belong to this resource.

excluded

public final Boolean excluded()

Indicates if a resource is included or excluded from the assessment.

Returns:

Indicates if a resource is included or excluded from the assessment.

logicalResourceId

public final LogicalResourceId logicalResourceId()

Logical identifier of the resource.

Returns:

Logical identifier of the resource.

parentResourceName

public final String parentResourceName()

Name of the parent resource.

Returns:

Name of the parent resource.

physicalResourceId

public final PhysicalResourceId physicalResourceId()

Identifier of the physical resource.

Returns:

Identifier of the physical resource.

resourceName

public final String resourceName()

The name of the resource.

Returns:

The name of the resource.

resourceType

public final String resourceType()

The type of resource.

Returns:

The type of resource.

sourceType

public final ResourceSourceType sourceType()

Type of input source.

If the service returns an enum value that is not available in the current SDK version, sourceType will return ResourceSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceTypeAsString().

Returns:

Type of input source.

See Also:

ResourceSourceType

sourceTypeAsString

public final String sourceTypeAsString()

Type of input source.

If the service returns an enum value that is not available in the current SDK version, sourceType will return ResourceSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceTypeAsString().

Returns:

Type of input source.

See Also:

ResourceSourceType

toBuilder

public PhysicalResource.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PhysicalResource.Builder,PhysicalResource>

builder

public static PhysicalResource.Builder builder()

serializableBuilderClass

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