Package software.amazon.awssdk.services.forecast.model

Class DescribeDatasetGroupResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.forecast.model.ForecastResponse

software.amazon.awssdk.services.forecast.model.DescribeDatasetGroupResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDatasetGroupResponse.Builder,DescribeDatasetGroupResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeDatasetGroupResponse
extends ForecastResponse
implements ToCopyableBuilder<DescribeDatasetGroupResponse.Builder,DescribeDatasetGroupResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeDatasetGroupResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeDatasetGroupResponse.Builder	builder()
Instant	creationTime()	When the dataset group was created.
List<String>	datasetArns()	An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset group.
String	datasetGroupArn()	The ARN of the dataset group.
String	datasetGroupName()	The name of 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()	For responses, this returns true if the service returned a value for the DatasetArns property.
int	hashCode()
Instant	lastModificationTime()	When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDatasetGroupResponse.Builder>	serializableBuilderClass()
String	status()	The status of the dataset group.
DescribeDatasetGroupResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.forecast.model.ForecastResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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 final String datasetGroupName()

The name of the dataset group.

Returns:

The name of the dataset group.

datasetGroupArn

public final String datasetGroupArn()

The ARN of the dataset group.

Returns:

The ARN of the dataset group.

hasDatasetArns

public final boolean hasDatasetArns()

For responses, this returns true if the service returned a value for the DatasetArns 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.

datasetArns

public final List<String> datasetArns()

An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset group.

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

Returns:

An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset group.

domain

public final Domain domain()

The domain associated with the dataset group.

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.

See Also:

Domain

domainAsString

public final String domainAsString()

The domain associated with the dataset group.

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.

See Also:

Domain

status

public final String status()

The status of the dataset group. States include:

• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

• UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED

The UPDATE states apply when you call the UpdateDatasetGroup operation.

The Status of the dataset group must be ACTIVE before you can use the dataset group to create a predictor.

Returns:

The status of the dataset group. States include:

• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

• UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED

The UPDATE states apply when you call the UpdateDatasetGroup operation.

The Status of the dataset group must be ACTIVE before you can use the dataset group to create a predictor.

creationTime

public final Instant creationTime()

When the dataset group was created.

Returns:

When the dataset group was created.

lastModificationTime

public final Instant lastModificationTime()

When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While the dataset group is being updated, LastModificationTime is the current time of the DescribeDatasetGroup call.

Returns:

When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While the dataset group is being updated, LastModificationTime is the current time of the DescribeDatasetGroup call.

toBuilder

public DescribeDatasetGroupResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDatasetGroupResponse.Builder,DescribeDatasetGroupResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeDatasetGroupResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo