Class Service

java.lang.Object
software.amazon.awssdk.services.resiliencehubv2.model.Service
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Service.Builder,Service>
@Generated("software.amazon.awssdk:codegen") public final class Service extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Service.Builder,Service>

Represents a service in Resilience Hub. A service is the primary unit of resilience assessment.

See Also:

  • Method Details

    • serviceArn

      public final String serviceArn()
      Returns the value of the ServiceArn property for this object.
      Returns:
      The value of the ServiceArn property for this object.

    • name

      public final String name()
      Returns the value of the Name property for this object.
      Returns:
      The value of the Name property for this object.

    • description

      public final String description()
      Returns the value of the Description property for this object.
      Returns:
      The value of the Description property for this object.

    • hasAssociatedSystems

      public final boolean hasAssociatedSystems()
      For responses, this returns true if the service returned a value for the AssociatedSystems 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.

    • associatedSystems

      public final List<AssociatedSystem> associatedSystems()

      The systems associated with the service.

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

      Returns:
      The systems associated with the service.

    • policyArn

      public final String policyArn()
      Returns the value of the PolicyArn property for this object.
      Returns:
      The value of the PolicyArn property for this object.

    • hasRegions

      public final boolean hasRegions()
      For responses, this returns true if the service returned a value for the Regions 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.

    • regions

      public final List<String> regions()

      The AWS Regions where the service operates.

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

      Returns:
      The AWS Regions where the service operates.

    • permissionModel

      public final PermissionModel permissionModel()

      The permission model for the service.

      Returns:
      The permission model for the service.

    • dependencyDiscovery

      public final DependencyDiscoveryConfig dependencyDiscovery()

      The dependency discovery configuration for the service.

      Returns:
      The dependency discovery configuration for the service.

    • effectivePolicyValues

      public final EffectivePolicyValues effectivePolicyValues()

      The effective policy values for the service.

      Returns:
      The effective policy values for the service.

    • achievability

      public final Achievability achievability()

      The achievability status of the service's resilience targets.

      Returns:
      The achievability status of the service's resilience targets.

    • reportConfiguration

      public final ServiceReportConfiguration reportConfiguration()
      Returns the value of the ReportConfiguration property for this object.
      Returns:
      The value of the ReportConfiguration property for this object.

    • kmsKeyId

      public final String kmsKeyId()
      Returns the value of the KmsKeyId property for this object.
      Returns:
      The value of the KmsKeyId property for this object.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final Map<String,String> tags()
      Returns the value of the Tags property for this object.

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

      Returns:
      The value of the Tags property for this object.

    • estimatedAssessmentCost

      public final AssessmentCost estimatedAssessmentCost()

      The estimated cost of running an assessment on the service.

      Returns:
      The estimated cost of running an assessment on the service.

    • resourceDiscovery

      public final ResourceDiscoveryStatus resourceDiscovery()

      The resource discovery status for the service.

      Returns:
      The resource discovery status for the service.

    • assessmentStatus

      public final AssessmentStatus assessmentStatus()

      The current assessment status of the service.

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

      Returns:
      The current assessment status of the service.
      See Also:

    • assessmentStatusAsString

      public final String assessmentStatusAsString()

      The current assessment status of the service.

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

      Returns:
      The current assessment status of the service.
      See Also:

    • rerunAssessment

      public final Boolean rerunAssessment()

      Indicates whether the assessment should be rerun.

      Returns:
      Indicates whether the assessment should be rerun.

    • openFindingsCount

      public final Integer openFindingsCount()

      The number of open findings for the service.

      Returns:
      The number of open findings for the service.

    • resolvedFindingsCount

      public final Integer resolvedFindingsCount()

      The number of resolved findings for the service.

      Returns:
      The number of resolved findings for the service.

    • organizationId

      public final String organizationId()

      The AWS Organizations identifier for the service.

      Returns:
      The AWS Organizations identifier for the service.

    • ouId

      public final String ouId()

      The organizational unit (OU) identifier for the service.

      Returns:
      The organizational unit (OU) identifier for the service.

    • accountId

      public final String accountId()

      The AWS account ID that owns the service.

      Returns:
      The AWS account ID that owns the service.

    • createdAt

      public final Instant createdAt()

      The timestamp when the service was created.

      Returns:
      The timestamp when the service was created.

    • updatedAt

      public final Instant updatedAt()

      The timestamp when the service was last updated.

      Returns:
      The timestamp when the service was last updated.

    • toBuilder

      public Service.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<Service.Builder,Service>
      Returns:
      a builder for type T

    • builder

      public static Service.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.