software.amazon.awssdk.services.forecast.model

Class CreateDatasetGroupRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.forecast.model.ForecastRequest

software.amazon.awssdk.services.forecast.model.CreateDatasetGroupRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDatasetGroupRequest.Builder,CreateDatasetGroupRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateDatasetGroupRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateDatasetGroupRequest.Builder	builder()
List<String>	datasetArns() An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.
String	datasetGroupName() A name for the dataset group.
Domain	domain() The domain associated with the dataset group.
String	domainAsString() The domain associated with the dataset group.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDatasetArns() Returns true if the DatasetArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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).
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDatasetGroupRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() The optional metadata that you apply to the dataset group to help you categorize and organize them.
CreateDatasetGroupRequest.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

datasetGroupName

public String datasetGroupName()

A name for the dataset group.

Returns:

A name for the dataset group.

domain

public Domain domain()

The domain associated with the dataset group. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDataset operation must match.

The Domain and DatasetType that you choose determine the fields that must be present in training data that you import to a dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires that item_id, timestamp, and demand fields are present in your data. For more information, see howitworks-datasets-groups.

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

Returns:

The domain associated with the dataset group. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDataset operation must match.

The Domain and DatasetType that you choose determine the fields that must be present in training data that you import to a dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires that item_id, timestamp, and demand fields are present in your data. For more information, see howitworks-datasets-groups.

See Also:

Domain

domainAsString

public String domainAsString()

The domain associated with the dataset group. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDataset operation must match.

The Domain and DatasetType that you choose determine the fields that must be present in training data that you import to a dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires that item_id, timestamp, and demand fields are present in your data. For more information, see howitworks-datasets-groups.

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

Returns:

The domain associated with the dataset group. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDataset operation must match.

The Domain and DatasetType that you choose determine the fields that must be present in training data that you import to a dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires that item_id, timestamp, and demand fields are present in your data. For more information, see howitworks-datasets-groups.

See Also:

Domain

hasDatasetArns

public boolean hasDatasetArns()

Returns true if the DatasetArns 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.

datasetArns

public List<String> datasetArns()

An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.

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

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

Returns:

An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.

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()

The optional metadata that you apply to the dataset group to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50.

• For each resource, each tag key must be unique, and each tag key can have only one value.

• Maximum key length - 128 Unicode characters in UTF-8.

• Maximum value length - 256 Unicode characters in UTF-8.

• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

• Tag keys and values are case sensitive.

• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

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:

The optional metadata that you apply to the dataset group to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50.

• For each resource, each tag key must be unique, and each tag key can have only one value.

• Maximum key length - 128 Unicode characters in UTF-8.

• Maximum value length - 256 Unicode characters in UTF-8.

• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

• Tag keys and values are case sensitive.

• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

toBuilder

public CreateDatasetGroupRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDatasetGroupRequest.Builder,CreateDatasetGroupRequest>

Specified by:

toBuilder in class ForecastRequest

builder

public static CreateDatasetGroupRequest.Builder builder()

serializableBuilderClass

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