Class MultiLocationConfig

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

A structure that contains information about the multi-location configuration of a canary, including whether it is a primary or replica, the primary location, and the list of replicas.

See Also:

  • Method Details

    • locationType

      public final LocationType locationType()

      Indicates whether this canary is the Primary or a Replica in the multi-location configuration.

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

      Returns:
      Indicates whether this canary is the Primary or a Replica in the multi-location configuration.
      See Also:

    • locationTypeAsString

      public final String locationTypeAsString()

      Indicates whether this canary is the Primary or a Replica in the multi-location configuration.

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

      Returns:
      Indicates whether this canary is the Primary or a Replica in the multi-location configuration.
      See Also:

    • primaryLocation

      public final String primaryLocation()

      The Amazon Web Services Region where the primary canary is located.

      Returns:
      The Amazon Web Services Region where the primary canary is located.

    • hasReplicas

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

    • replicas

      public final List<Replica> replicas()

      A list of replicas for this canary. This field is present only for the primary location canary.

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

      Returns:
      A list of replicas for this canary. This field is present only for the primary location canary.

    • replicationState

      public final ReplicationState replicationState()

      The overall replication state of the canary across all replica locations. This field is present only for the primary location canary. Valid values are InProgress, InSync, and Inconsistent.

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

      Returns:
      The overall replication state of the canary across all replica locations. This field is present only for the primary location canary. Valid values are InProgress, InSync, and Inconsistent.
      See Also:

    • replicationStateAsString

      public final String replicationStateAsString()

      The overall replication state of the canary across all replica locations. This field is present only for the primary location canary. Valid values are InProgress, InSync, and Inconsistent.

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

      Returns:
      The overall replication state of the canary across all replica locations. This field is present only for the primary location canary. Valid values are InProgress, InSync, and Inconsistent.
      See Also:

    • toBuilder

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

    • builder

      public static MultiLocationConfig.Builder builder()

    • serializableBuilderClass

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