com.amazonaws.services.sagemaker.model

Class ThroughputConfig

java.lang.Object

com.amazonaws.services.sagemaker.model.ThroughputConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ThroughputConfig
extends Object
implements Serializable, Cloneable, StructuredPojo

Used to set feature group throughput configuration. There are two modes: ON_DEMAND and PROVISIONED. With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.

Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ThroughputConfig()

Method Summary

Modifier and Type	Method and Description
ThroughputConfig	clone()
boolean	equals(Object obj)
Integer	getProvisionedReadCapacityUnits() For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.
Integer	getProvisionedWriteCapacityUnits() For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.
String	getThroughputMode() The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setProvisionedReadCapacityUnits(Integer provisionedReadCapacityUnits) For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.
void	setProvisionedWriteCapacityUnits(Integer provisionedWriteCapacityUnits) For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.
void	setThroughputMode(String throughputMode) The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.
String	toString() Returns a string representation of this object.
ThroughputConfig	withProvisionedReadCapacityUnits(Integer provisionedReadCapacityUnits) For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.
ThroughputConfig	withProvisionedWriteCapacityUnits(Integer provisionedWriteCapacityUnits) For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.
ThroughputConfig	withThroughputMode(String throughputMode) The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.
ThroughputConfig	withThroughputMode(ThroughputMode throughputMode) The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ThroughputConfig

public ThroughputConfig()

Method Detail

setThroughputMode

public void setThroughputMode(String throughputMode)

The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.

Parameters:

throughputMode - The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.

See Also:

ThroughputMode

getThroughputMode

public String getThroughputMode()

The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.

Returns:

The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.

See Also:

ThroughputMode

withThroughputMode

public ThroughputConfig withThroughputMode(String throughputMode)

The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.

Parameters:

throughputMode - The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ThroughputMode

withThroughputMode

public ThroughputConfig withThroughputMode(ThroughputMode throughputMode)

The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.

Parameters:

throughputMode - The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ThroughputMode

setProvisionedReadCapacityUnits

public void setProvisionedReadCapacityUnits(Integer provisionedReadCapacityUnits)

For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

Parameters:

provisionedReadCapacityUnits - For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

getProvisionedReadCapacityUnits

public Integer getProvisionedReadCapacityUnits()

For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

Returns:

For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

withProvisionedReadCapacityUnits

public ThroughputConfig withProvisionedReadCapacityUnits(Integer provisionedReadCapacityUnits)

For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

Parameters:

provisionedReadCapacityUnits - For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

Returns:

Returns a reference to this object so that method calls can be chained together.

setProvisionedWriteCapacityUnits

public void setProvisionedWriteCapacityUnits(Integer provisionedWriteCapacityUnits)

For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

Parameters:

provisionedWriteCapacityUnits - For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

getProvisionedWriteCapacityUnits

public Integer getProvisionedWriteCapacityUnits()

For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

Returns:

For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

withProvisionedWriteCapacityUnits

public ThroughputConfig withProvisionedWriteCapacityUnits(Integer provisionedWriteCapacityUnits)

For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

Parameters:

provisionedWriteCapacityUnits - For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

Returns:

Returns a reference to this object so that method calls can be chained together.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ThroughputConfig clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.