Class ManagedResourceSummary

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

A complex structure for a managed resource in an Amazon Web Services account with information about zonal shifts and autoshifts.

You can start a zonal shift in ARC for a managed resource to temporarily move traffic for the resource away from an Availability Zone in an Amazon Web Services Region. You can also configure zonal autoshift for a managed resource.

At this time, managed resources are Amazon EC2 Auto Scaling groups, Amazon Elastic Kubernetes Service, Network Load Balancers, and Application Load Balancer.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) for the managed resource.

      Returns:
      The Amazon Resource Name (ARN) for the managed resource.

    • name

      public final String name()

      The name of the managed resource.

      Returns:
      The name of the managed resource.

    • hasAvailabilityZones

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

    • availabilityZones

      public final List<String> availabilityZones()

      The Availability Zones that a resource is deployed in.

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

      Returns:
      The Availability Zones that a resource is deployed in.

    • hasAppliedWeights

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

    • appliedWeights

      public final Map<String,Float> appliedWeights()

      A collection of key-value pairs that indicate whether resources are active in Availability Zones or not. The key name is the Availability Zone where the resource is deployed. The value is 1 or 0.

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

      Returns:
      A collection of key-value pairs that indicate whether resources are active in Availability Zones or not. The key name is the Availability Zone where the resource is deployed. The value is 1 or 0.

    • hasZonalShifts

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

    • zonalShifts

      public final List<ZonalShiftInResource> zonalShifts()

      An array of the zonal shifts for a 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 hasZonalShifts() method.

      Returns:
      An array of the zonal shifts for a resource.

    • hasAutoshifts

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

    • autoshifts

      public final List<AutoshiftInResource> autoshifts()

      An array of the autoshifts that have been completed for a 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 hasAutoshifts() method.

      Returns:
      An array of the autoshifts that have been completed for a resource.

    • zonalAutoshiftStatus

      public final ZonalAutoshiftStatus zonalAutoshiftStatus()

      The status of autoshift for a resource. When you configure zonal autoshift for a resource, you can set the value of the status to ENABLED or DISABLED.

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

      Returns:
      The status of autoshift for a resource. When you configure zonal autoshift for a resource, you can set the value of the status to ENABLED or DISABLED.
      See Also:

    • zonalAutoshiftStatusAsString

      public final String zonalAutoshiftStatusAsString()

      The status of autoshift for a resource. When you configure zonal autoshift for a resource, you can set the value of the status to ENABLED or DISABLED.

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

      Returns:
      The status of autoshift for a resource. When you configure zonal autoshift for a resource, you can set the value of the status to ENABLED or DISABLED.
      See Also:

    • practiceRunStatus

      public final ZonalAutoshiftStatus practiceRunStatus()

      This status tracks whether a practice run configuration exists for a resource. When you configure a practice run for a resource so that a practice run configuration exists, ARC sets this value to ENABLED. If a you have not configured a practice run for the resource, or delete a practice run configuration, ARC sets the value to DISABLED.

      ARC updates this status; you can't set a practice run status to ENABLED or DISABLED.

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

      Returns:
      This status tracks whether a practice run configuration exists for a resource. When you configure a practice run for a resource so that a practice run configuration exists, ARC sets this value to ENABLED. If a you have not configured a practice run for the resource, or delete a practice run configuration, ARC sets the value to DISABLED.

      ARC updates this status; you can't set a practice run status to ENABLED or DISABLED.

      See Also:

    • practiceRunStatusAsString

      public final String practiceRunStatusAsString()

      This status tracks whether a practice run configuration exists for a resource. When you configure a practice run for a resource so that a practice run configuration exists, ARC sets this value to ENABLED. If a you have not configured a practice run for the resource, or delete a practice run configuration, ARC sets the value to DISABLED.

      ARC updates this status; you can't set a practice run status to ENABLED or DISABLED.

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

      Returns:
      This status tracks whether a practice run configuration exists for a resource. When you configure a practice run for a resource so that a practice run configuration exists, ARC sets this value to ENABLED. If a you have not configured a practice run for the resource, or delete a practice run configuration, ARC sets the value to DISABLED.

      ARC updates this status; you can't set a practice run status to ENABLED or DISABLED.

      See Also:

    • toBuilder

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

    • builder

      public static ManagedResourceSummary.Builder builder()

    • serializableBuilderClass

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