Class TrafficSplitRequestOptions

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

The traffic shift to perform for a cloned blue/green upgrade.

See Also:

  • Method Details

    • strategy

      public final TrafficStrategy strategy()

      The traffic shifting strategy. The only valid value is ShiftReadTrafficPercent.

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

      Returns:
      The traffic shifting strategy. The only valid value is ShiftReadTrafficPercent.
      See Also:

    • strategyAsString

      public final String strategyAsString()

      The traffic shifting strategy. The only valid value is ShiftReadTrafficPercent.

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

      Returns:
      The traffic shifting strategy. The only valid value is ShiftReadTrafficPercent.
      See Also:

    • cloneReadTrafficPercent

      public final Integer cloneReadTrafficPercent()

      The percentage of search traffic, from 0 to 100, to send to the cloned cluster. The rest goes to the primary cluster.

      Returns:
      The percentage of search traffic, from 0 to 100, to send to the cloned cluster. The rest goes to the primary cluster.

    • toBuilder

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

    • builder

      public static TrafficSplitRequestOptions.Builder builder()

    • serializableBuilderClass

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