software.amazon.awssdk.services.storagegateway.model

Class BandwidthRateLimitInterval

java.lang.Object

software.amazon.awssdk.services.storagegateway.model.BandwidthRateLimitInterval

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<BandwidthRateLimitInterval.Builder,BandwidthRateLimitInterval>

@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BandwidthRateLimitInterval.Builder

Method Summary

Modifier and Type	Method and Description
Long	averageDownloadRateLimitInBitsPerSec() The average download rate limit component of the bandwidth rate limit interval, in bits per second.
Long	averageUploadRateLimitInBitsPerSec() The average upload rate limit component of the bandwidth rate limit interval, in bits per second.
static BandwidthRateLimitInterval.Builder	builder()
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.
Integer	endHourOfDay() The hour of the day to end the bandwidth rate limit interval.
Integer	endMinuteOfHour() The minute of the hour to end the bandwidth rate limit interval.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDaysOfWeek() For responses, this returns true if the service returned a value for the DaysOfWeek property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends BandwidthRateLimitInterval.Builder>	serializableBuilderClass()
Integer	startHourOfDay() The hour of the day to start the bandwidth rate limit interval.
Integer	startMinuteOfHour() The minute of the hour to start the bandwidth rate limit interval.
BandwidthRateLimitInterval.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

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.

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.

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.

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.

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.

averageDownloadRateLimitInBitsPerSec

public final Long averageDownloadRateLimitInBitsPerSec()

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

Returns:

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

toBuilder

public BandwidthRateLimitInterval.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BandwidthRateLimitInterval.Builder,BandwidthRateLimitInterval>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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