software.amazon.awssdk.services.redshift.model

Class CreateUsageLimitRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.redshift.model.RedshiftRequest

software.amazon.awssdk.services.redshift.model.CreateUsageLimitRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateUsageLimitRequest.Builder,CreateUsageLimitRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateUsageLimitRequest
extends RedshiftRequest
implements ToCopyableBuilder<CreateUsageLimitRequest.Builder,CreateUsageLimitRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateUsageLimitRequest.Builder

Method Summary

Modifier and Type	Method and Description
Long	amount() The limit amount.
UsageLimitBreachAction	breachAction() The action that Amazon Redshift takes when the limit is reached.
String	breachActionAsString() The action that Amazon Redshift takes when the limit is reached.
static CreateUsageLimitRequest.Builder	builder()
String	clusterIdentifier() The identifier of the cluster that you want to limit usage.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
UsageLimitFeatureType	featureType() The Amazon Redshift feature that you want to limit.
String	featureTypeAsString() The Amazon Redshift feature that you want to limit.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
UsageLimitLimitType	limitType() The type of limit.
String	limitTypeAsString() The type of limit.
UsageLimitPeriod	period() The time period that the amount applies to.
String	periodAsString() The time period that the amount applies to.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateUsageLimitRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() A list of tag instances.
CreateUsageLimitRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

clusterIdentifier

public String clusterIdentifier()

The identifier of the cluster that you want to limit usage.

Returns:

The identifier of the cluster that you want to limit usage.

featureType

public UsageLimitFeatureType featureType()

The Amazon Redshift feature that you want to limit.

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

Returns:

The Amazon Redshift feature that you want to limit.

See Also:

UsageLimitFeatureType

featureTypeAsString

public String featureTypeAsString()

The Amazon Redshift feature that you want to limit.

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

Returns:

The Amazon Redshift feature that you want to limit.

See Also:

UsageLimitFeatureType

limitType

public UsageLimitLimitType limitType()

The type of limit. Depending on the feature type, this can be based on a time duration or data size. If FeatureType is spectrum, then LimitType must be data-scanned. If FeatureType is concurrency-scaling, then LimitType must be time.

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

Returns:

The type of limit. Depending on the feature type, this can be based on a time duration or data size. If FeatureType is spectrum, then LimitType must be data-scanned. If FeatureType is concurrency-scaling, then LimitType must be time.

See Also:

UsageLimitLimitType

limitTypeAsString

public String limitTypeAsString()

The type of limit. Depending on the feature type, this can be based on a time duration or data size. If FeatureType is spectrum, then LimitType must be data-scanned. If FeatureType is concurrency-scaling, then LimitType must be time.

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

Returns:

The type of limit. Depending on the feature type, this can be based on a time duration or data size. If FeatureType is spectrum, then LimitType must be data-scanned. If FeatureType is concurrency-scaling, then LimitType must be time.

See Also:

UsageLimitLimitType

amount

public Long amount()

The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB). The value must be a positive number.

Returns:

The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB). The value must be a positive number.

period

public UsageLimitPeriod period()

The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

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

Returns:

The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

See Also:

UsageLimitPeriod

periodAsString

public String periodAsString()

The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

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

Returns:

The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

See Also:

UsageLimitPeriod

breachAction

public UsageLimitBreachAction breachAction()

The action that Amazon Redshift takes when the limit is reached. The default is log. For more information about this parameter, see UsageLimit.

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

Returns:

The action that Amazon Redshift takes when the limit is reached. The default is log. For more information about this parameter, see UsageLimit.

See Also:

UsageLimitBreachAction

breachActionAsString

public String breachActionAsString()

The action that Amazon Redshift takes when the limit is reached. The default is log. For more information about this parameter, see UsageLimit.

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

Returns:

The action that Amazon Redshift takes when the limit is reached. The default is log. For more information about this parameter, see UsageLimit.

See Also:

UsageLimitBreachAction

hasTags

public boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public List<Tag> tags()

A list of tag instances.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

Returns:

A list of tag instances.

toBuilder

public CreateUsageLimitRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateUsageLimitRequest.Builder,CreateUsageLimitRequest>

Specified by:

toBuilder in class RedshiftRequest

builder

public static CreateUsageLimitRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateUsageLimitRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo