Class TrafficPolicy

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

A complex type that contains settings for a traffic policy.

See Also:

  • Method Details

    • id

      public final String id()

      The ID that Amazon Route 53 assigned to a traffic policy when you created it.

      Returns:
      The ID that Amazon Route 53 assigned to a traffic policy when you created it.

    • version

      public final Integer version()

      The version number that Amazon Route 53 assigns to a traffic policy. For a new traffic policy, the value of Version is always 1.

      Returns:
      The version number that Amazon Route 53 assigns to a traffic policy. For a new traffic policy, the value of Version is always 1.

    • name

      public final String name()

      The name that you specified when you created the traffic policy.

      Returns:
      The name that you specified when you created the traffic policy.

    • type

      public final RRType type()

      The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy to create a traffic policy instance.

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

      Returns:
      The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy to create a traffic policy instance.
      See Also:

    • typeAsString

      public final String typeAsString()

      The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy to create a traffic policy instance.

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

      Returns:
      The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy to create a traffic policy instance.
      See Also:

    • document

      public final String document()

      The definition of a traffic policy in JSON format. You specify the JSON document to use for a new traffic policy in the CreateTrafficPolicy request. For more information about the JSON format, see Traffic Policy Document Format.

      Returns:
      The definition of a traffic policy in JSON format. You specify the JSON document to use for a new traffic policy in the CreateTrafficPolicy request. For more information about the JSON format, see Traffic Policy Document Format.

    • comment

      public final String comment()

      The comment that you specify in the CreateTrafficPolicy request, if any.

      Returns:
      The comment that you specify in the CreateTrafficPolicy request, if any.

    • toBuilder

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

    • builder

      public static TrafficPolicy.Builder builder()

    • serializableBuilderClass

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