DescribeAlgorithmResponse (AWS SDK for Java

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(value="software.amazon.awssdk:codegen")
public final class DescribeAlgorithmResponse
extends SageMakerResponse
implements ToCopyableBuilder<DescribeAlgorithmResponse.Builder,DescribeAlgorithmResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeAlgorithmResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeAlgorithmResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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 AWS Marektplace.
`Instant`	`creationTime()` A timestamp specifying when the algorithm was created.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkResponse`.
`int`	`hashCode()`
`InferenceSpecification`	`inferenceSpecification()` Details about inference jobs that the algorithm runs.
`String`	`productId()` The product identifier of the algorithm.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeAlgorithmResponse.Builder>`	`serializableBuilderClass()`
`DescribeAlgorithmResponse.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`TrainingSpecification`	`trainingSpecification()` Details about training jobs run by this algorithm.
`AlgorithmValidationSpecification`	`validationSpecification()` Details about configurations for one or more training jobs that Amazon 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
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - algorithmName
```
public String algorithmName()
```
    The name of the algorithm being described.
    
    Returns:
    
    The name of the algorithm being described.
  - algorithmArn
```
public String algorithmArn()
```
    The Amazon Resource Name (ARN) of the algorithm.>
    
    Returns:
    
    The Amazon Resource Name (ARN) of the algorithm.>
  - algorithmDescription
```
public String algorithmDescription()
```
    A brief summary about the algorithm.
    
    Returns:
    
    A brief summary about the algorithm.
  - creationTime
```
public Instant creationTime()
```
    A timestamp specifying when the algorithm was created.
    
    Returns:
    
    A timestamp specifying when the algorithm was created.
  - trainingSpecification
```
public TrainingSpecification trainingSpecification()
```
    Details about training jobs run by this algorithm.
    
    Returns:
    
    Details about training jobs run by this algorithm.
  - inferenceSpecification
```
public InferenceSpecification inferenceSpecification()
```
    Details about inference jobs that the algorithm runs.
    
    Returns:
    
    Details about inference jobs that the algorithm runs.
  - validationSpecification
```
public AlgorithmValidationSpecification validationSpecification()
```
    Details about configurations for one or more training jobs that Amazon SageMaker runs to test the algorithm.
    
    Returns:
    
    Details about configurations for one or more training jobs that Amazon SageMaker runs to test the algorithm.
  - algorithmStatus
```
public 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 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 AlgorithmStatusDetails algorithmStatusDetails()
```
    Details about the current status of the algorithm.
    
    Returns:
    
    Details about the current status of the algorithm.
  - productId
```
public String productId()
```
    The product identifier of the algorithm.
    
    Returns:
    
    The product identifier of the algorithm.
  - certifyForMarketplace
```
public Boolean certifyForMarketplace()
```
    Whether the algorithm is certified to be listed in AWS Marektplace.
    
    Returns:
    
    Whether the algorithm is certified to be listed in AWS Marektplace.
  - toBuilder
```
public DescribeAlgorithmResponse.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeAlgorithmResponse.Builder,DescribeAlgorithmResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
    
    Returns:
    
    a builder for type T
  - builder
```
public static DescribeAlgorithmResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeAlgorithmResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkResponse
    
    Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkResponse
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class DescribeAlgorithmResponse

Nested Class Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

algorithmName

algorithmArn

algorithmDescription

creationTime

trainingSpecification

inferenceSpecification

validationSpecification

algorithmStatus

algorithmStatusAsString

algorithmStatusDetails

productId

certifyForMarketplace

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields