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:

  • Method Details

    • 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()

      Type of resource.

      Returns:
      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:

    • 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:

    • toBuilder

      public PhysicalResource.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PhysicalResource.Builder,PhysicalResource>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.