Class BandwidthRateLimitInterval

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

Describes a bandwidth rate limit interval for a gateway. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both.

See Also:

  • Method Details

    • averageUploadRateLimitInBitsPerSec

      public final Long averageUploadRateLimitInBitsPerSec()

      The average upload rate limit component of the bandwidth rate limit interval, in bits per second. This field does not appear in the response if the upload rate limit is not set.

      For Backup Gateway, the minimum value is (Value).

      Returns:
      The average upload rate limit component of the bandwidth rate limit interval, in bits per second. This field does not appear in the response if the upload rate limit is not set.

      For Backup Gateway, the minimum value is (Value).

    • hasDaysOfWeek

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

    • daysOfWeek

      public final List<Integer> daysOfWeek()

      The days of the week component of the bandwidth rate limit interval, represented as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 represents Saturday.

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

      Returns:
      The days of the week component of the bandwidth rate limit interval, represented as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 represents Saturday.

    • endHourOfDay

      public final Integer endHourOfDay()

      The hour of the day to end the bandwidth rate limit interval.

      Returns:
      The hour of the day to end the bandwidth rate limit interval.

    • endMinuteOfHour

      public final Integer endMinuteOfHour()

      The minute of the hour to end the bandwidth rate limit interval.

      The bandwidth rate limit interval ends at the end of the minute. To end an interval at the end of an hour, use the value 59.

      Returns:
      The minute of the hour to end the bandwidth rate limit interval.

      The bandwidth rate limit interval ends at the end of the minute. To end an interval at the end of an hour, use the value 59.

    • startHourOfDay

      public final Integer startHourOfDay()

      The hour of the day to start the bandwidth rate limit interval.

      Returns:
      The hour of the day to start the bandwidth rate limit interval.

    • startMinuteOfHour

      public final Integer startMinuteOfHour()

      The minute of the hour to start the bandwidth rate limit interval. The interval begins at the start of that minute. To begin an interval exactly at the start of the hour, use the value 0.

      Returns:
      The minute of the hour to start the bandwidth rate limit interval. The interval begins at the start of that minute. To begin an interval exactly at the start of the hour, use the value 0.

    • toBuilder

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

    • builder

      public static BandwidthRateLimitInterval.Builder builder()

    • serializableBuilderClass

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