Package software.amazon.awssdk.services.sagemaker.model

Class DescribeAlgorithmResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.sagemaker.model.SageMakerResponse

software.amazon.awssdk.services.sagemaker.model.DescribeAlgorithmResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeAlgorithmResponse.Builder,DescribeAlgorithmResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeAlgorithmResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	algorithmArn()	The Amazon Resource Name (ARN) of the algorithm.
String	algorithmDescription()	A brief summary about the algorithm.
String	algorithmName()	The name of the algorithm being described.
AlgorithmStatus	algorithmStatus()	The current status of the algorithm.
String	algorithmStatusAsString()	The current status of the algorithm.
AlgorithmStatusDetails	algorithmStatusDetails()	Details about the current status of the algorithm.
static DescribeAlgorithmResponse.Builder	builder()
Boolean	certifyForMarketplace()	Whether the algorithm is certified to be listed in Amazon Web Services Marketplace.
Instant	creationTime()	A timestamp specifying when the algorithm was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
InferenceSpecification	inferenceSpecification()	Details about inference jobs that the algorithm runs.
String	productId()	The product identifier of the algorithm.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeAlgorithmResponse.Builder>	serializableBuilderClass()
DescribeAlgorithmResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
TrainingSpecification	trainingSpecification()	Details about training jobs run by this algorithm.
AlgorithmValidationSpecification	validationSpecification()	Details about configurations for one or more training jobs that SageMaker runs to test the algorithm.

Methods inherited from class software.amazon.awssdk.services.sagemaker.model.SageMakerResponse

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

algorithmName

public final String algorithmName()

The name of the algorithm being described.

Returns:

The name of the algorithm being described.

algorithmArn

public final String algorithmArn()

The Amazon Resource Name (ARN) of the algorithm.

Returns:

The Amazon Resource Name (ARN) of the algorithm.

algorithmDescription

public final String algorithmDescription()

A brief summary about the algorithm.

Returns:

A brief summary about the algorithm.

creationTime

public final Instant creationTime()

A timestamp specifying when the algorithm was created.

Returns:

A timestamp specifying when the algorithm was created.

trainingSpecification

public final TrainingSpecification trainingSpecification()

Details about training jobs run by this algorithm.

Returns:

Details about training jobs run by this algorithm.

inferenceSpecification

public final InferenceSpecification inferenceSpecification()

Details about inference jobs that the algorithm runs.

Returns:

Details about inference jobs that the algorithm runs.

validationSpecification

public final AlgorithmValidationSpecification validationSpecification()

Details about configurations for one or more training jobs that SageMaker runs to test the algorithm.

Returns:

Details about configurations for one or more training jobs that SageMaker runs to test the algorithm.

algorithmStatus

public final AlgorithmStatus algorithmStatus()

The current status of the algorithm.

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

Returns:

The current status of the algorithm.

See Also:

AlgorithmStatus

algorithmStatusAsString

public final String algorithmStatusAsString()

The current status of the algorithm.

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

Returns:

The current status of the algorithm.

See Also:

AlgorithmStatus

algorithmStatusDetails

public final AlgorithmStatusDetails algorithmStatusDetails()

Details about the current status of the algorithm.

Returns:

Details about the current status of the algorithm.

productId

public final String productId()

The product identifier of the algorithm.

Returns:

The product identifier of the algorithm.

certifyForMarketplace

public final Boolean certifyForMarketplace()

Whether the algorithm is certified to be listed in Amazon Web Services Marketplace.

Returns:

Whether the algorithm is certified to be listed in Amazon Web Services Marketplace.

toBuilder

public DescribeAlgorithmResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeAlgorithmResponse.Builder,DescribeAlgorithmResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeAlgorithmResponse.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo