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.
A managed resource is a load balancer that has been registered with Route 53 ARC by Elastic Load Balancing. You can start a zonal shift in Route 53 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 Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceManagedResourceSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Map<String,Float>appliedWeights()A collection of key-value pairs that indicate whether resources are active in Availability Zones or not.Stringarn()The Amazon Resource Name (ARN) for the managed resource.List<AutoshiftInResource>autoshifts()An array of the autoshifts that have been completed for a resource.List<String>availabilityZones()The Availability Zones that a resource is deployed in.static ManagedResourceSummary.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAppliedWeights()For responses, this returns true if the service returned a value for the AppliedWeights property.booleanhasAutoshifts()For responses, this returns true if the service returned a value for the Autoshifts property.booleanhasAvailabilityZones()For responses, this returns true if the service returned a value for the AvailabilityZones property.inthashCode()booleanhasZonalShifts()For responses, this returns true if the service returned a value for the ZonalShifts property.Stringname()The name of the managed resource.ZonalAutoshiftStatuspracticeRunStatus()This status tracks whether a practice run configuration exists for a resource.StringpracticeRunStatusAsString()This status tracks whether a practice run configuration exists for a resource.List<SdkField<?>>sdkFields()static Class<? extends ManagedResourceSummary.Builder>serializableBuilderClass()ManagedResourceSummary.BuildertoBuilder()StringtoString()Returns a string representation of this object.ZonalAutoshiftStatuszonalAutoshiftStatus()The status of autoshift for a resource.StringzonalAutoshiftStatusAsString()The status of autoshift for a resource.List<ZonalShiftInResource>zonalShifts()An array of the zonal shifts for a resource.-
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
-
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 theisEmpty()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.
-
arn
public final String arn()
The Amazon Resource Name (ARN) for the managed resource.
- Returns:
- The Amazon Resource Name (ARN) for the managed 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 theisEmpty()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.
-
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 theisEmpty()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.
-
name
public final String name()
The name of the managed resource.
- Returns:
- The name of the managed resource.
-
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, Route 53 ARC sets this value to
ENABLED. If a you have not configured a practice run for the resource, or delete a practice run configuration, Route 53 ARC sets the value toDISABLED.Route 53 ARC updates this status; you can't set a practice run status to
ENABLEDorDISABLED.If the service returns an enum value that is not available in the current SDK version,
practiceRunStatuswill returnZonalAutoshiftStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompracticeRunStatusAsString().- 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, Route 53 ARC sets this value to
ENABLED. If a you have not configured a practice run for the resource, or delete a practice run configuration, Route 53 ARC sets the value toDISABLED.Route 53 ARC updates this status; you can't set a practice run status to
ENABLEDorDISABLED. - See Also:
ZonalAutoshiftStatus
-
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, Route 53 ARC sets this value to
ENABLED. If a you have not configured a practice run for the resource, or delete a practice run configuration, Route 53 ARC sets the value toDISABLED.Route 53 ARC updates this status; you can't set a practice run status to
ENABLEDorDISABLED.If the service returns an enum value that is not available in the current SDK version,
practiceRunStatuswill returnZonalAutoshiftStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompracticeRunStatusAsString().- 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, Route 53 ARC sets this value to
ENABLED. If a you have not configured a practice run for the resource, or delete a practice run configuration, Route 53 ARC sets the value toDISABLED.Route 53 ARC updates this status; you can't set a practice run status to
ENABLEDorDISABLED. - See Also:
ZonalAutoshiftStatus
-
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
ENABLEDorDISABLED.If the service returns an enum value that is not available in the current SDK version,
zonalAutoshiftStatuswill returnZonalAutoshiftStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromzonalAutoshiftStatusAsString().- 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
ENABLEDorDISABLED. - See Also:
ZonalAutoshiftStatus
-
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
ENABLEDorDISABLED.If the service returns an enum value that is not available in the current SDK version,
zonalAutoshiftStatuswill returnZonalAutoshiftStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromzonalAutoshiftStatusAsString().- 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
ENABLEDorDISABLED. - See Also:
ZonalAutoshiftStatus
-
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 theisEmpty()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.
-
toBuilder
public ManagedResourceSummary.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ManagedResourceSummary.Builder,ManagedResourceSummary>
-
builder
public static ManagedResourceSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends ManagedResourceSummary.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-