DescribeInferenceExperimentResponse (AWS Java SDK :: Services

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.DescribeInferenceExperimentResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeInferenceExperimentResponse.Builder,DescribeInferenceExperimentResponse>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeInferenceExperimentResponse.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The ARN of the inference experiment being described.
`static DescribeInferenceExperimentResponse.Builder`	`builder()`
`Instant`	`completionTime()` The timestamp at which the inference experiment was completed.
`Instant`	`creationTime()` The timestamp at which you created the inference experiment.
`InferenceExperimentDataStorageConfig`	`dataStorageConfig()` The Amazon S3 location and configuration for storing inference request and response data.
`String`	`description()` The description of the inference experiment.
`EndpointMetadata`	`endpointMetadata()` The metadata of the endpoint on which the inference experiment ran.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasModelVariants()` For responses, this returns true if the service returned a value for the ModelVariants property.
`String`	`kmsKey()` The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.
`Instant`	`lastModifiedTime()` The timestamp at which you last modified the inference experiment.
`List<ModelVariantConfigSummary>`	`modelVariants()` An array of `ModelVariantConfigSummary` objects.
`String`	`name()` The name of the inference experiment.
`String`	`roleArn()` The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.
`InferenceExperimentSchedule`	`schedule()` The duration for which the inference experiment ran or will run.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeInferenceExperimentResponse.Builder>`	`serializableBuilderClass()`
`ShadowModeConfig`	`shadowModeConfig()` The configuration of `ShadowMode` inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests.
`InferenceExperimentStatus`	`status()` The status of the inference experiment.
`String`	`statusAsString()` The status of the inference experiment.
`String`	`statusReason()` The error message or client-specified `Reason` from the StopInferenceExperiment API, that explains the status of the inference experiment.
`DescribeInferenceExperimentResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`InferenceExperimentType`	`type()` The type of the inference experiment.
`String`	`typeAsString()` The type of the inference experiment.

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
  - arn
```
public final String arn()
```
    The ARN of the inference experiment being described.
    
    Returns:
    
    The ARN of the inference experiment being described.
  - name
```
public final String name()
```
    The name of the inference experiment.
    
    Returns:
    
    The name of the inference experiment.
  - type
```
public final InferenceExperimentType type()
```
    The type of the inference experiment.
    
    If the service returns an enum value that is not available in the current SDK version, type will return InferenceExperimentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of the inference experiment.
    
    See Also:
    
    InferenceExperimentType
  - typeAsString
```
public final String typeAsString()
```
    The type of the inference experiment.
    
    If the service returns an enum value that is not available in the current SDK version, type will return InferenceExperimentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of the inference experiment.
    
    See Also:
    
    InferenceExperimentType
  - schedule
```
public final InferenceExperimentSchedule schedule()
```
    The duration for which the inference experiment ran or will run.
    
    Returns:
    
    The duration for which the inference experiment ran or will run.
  - status
```
public final InferenceExperimentStatus status()
```
    The status of the inference experiment. The following are the possible statuses for an inference experiment:
    - Creating - Amazon SageMaker is creating your experiment.
    - Created - Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time.
    - Updating - When you make changes to your experiment, your experiment shows as updating.
    - Starting - Amazon SageMaker is beginning your experiment.
    - Running - Your experiment is in progress.
    - Stopping - Amazon SageMaker is stopping your experiment.
    - Completed - Your experiment has completed.
    - Cancelled - When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows as cancelled.
    If the service returns an enum value that is not available in the current SDK version, status will return InferenceExperimentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    The status of the inference experiment. The following are the possible statuses for an inference experiment:
    
    Creating - Amazon SageMaker is creating your experiment.
    
    Created - Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time.
    
    Updating - When you make changes to your experiment, your experiment shows as updating.
    
    Starting - Amazon SageMaker is beginning your experiment.
    
    Running - Your experiment is in progress.
    
    Stopping - Amazon SageMaker is stopping your experiment.
    
    Completed - Your experiment has completed.
    
    Cancelled - When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows as cancelled.
    See Also:
    
    InferenceExperimentStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of the inference experiment. The following are the possible statuses for an inference experiment:
    - Creating - Amazon SageMaker is creating your experiment.
    - Created - Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time.
    - Updating - When you make changes to your experiment, your experiment shows as updating.
    - Starting - Amazon SageMaker is beginning your experiment.
    - Running - Your experiment is in progress.
    - Stopping - Amazon SageMaker is stopping your experiment.
    - Completed - Your experiment has completed.
    - Cancelled - When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows as cancelled.
    If the service returns an enum value that is not available in the current SDK version, status will return InferenceExperimentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    The status of the inference experiment. The following are the possible statuses for an inference experiment:
    
    Creating - Amazon SageMaker is creating your experiment.
    
    Created - Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time.
    
    Updating - When you make changes to your experiment, your experiment shows as updating.
    
    Starting - Amazon SageMaker is beginning your experiment.
    
    Running - Your experiment is in progress.
    
    Stopping - Amazon SageMaker is stopping your experiment.
    
    Completed - Your experiment has completed.
    
    Cancelled - When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows as cancelled.
    See Also:
    
    InferenceExperimentStatus
  - statusReason
```
public final String statusReason()
```
    The error message or client-specified Reason from the StopInferenceExperiment API, that explains the status of the inference experiment.
    
    Returns:
    
    The error message or client-specified Reason from the StopInferenceExperiment API, that explains the status of the inference experiment.
  - description
```
public final String description()
```
    The description of the inference experiment.
    
    Returns:
    
    The description of the inference experiment.
  - creationTime
```
public final Instant creationTime()
```
    The timestamp at which you created the inference experiment.
    
    Returns:
    
    The timestamp at which you created the inference experiment.
  - completionTime
```
public final Instant completionTime()
```
    The timestamp at which the inference experiment was completed.
    
    Returns:
    
    The timestamp at which the inference experiment was completed.
  - lastModifiedTime
```
public final Instant lastModifiedTime()
```
    The timestamp at which you last modified the inference experiment.
    
    Returns:
    
    The timestamp at which you last modified the inference experiment.
  - roleArn
```
public final String roleArn()
```
    The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.
    
    Returns:
    
    The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.
  - endpointMetadata
```
public final EndpointMetadata endpointMetadata()
```
    The metadata of the endpoint on which the inference experiment ran.
    
    Returns:
    
    The metadata of the endpoint on which the inference experiment ran.
  - hasModelVariants
```
public final boolean hasModelVariants()
```
    For responses, this returns true if the service returned a value for the ModelVariants 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.
  - modelVariants
```
public final List<ModelVariantConfigSummary> modelVariants()
```
    An array of ModelVariantConfigSummary objects. There is one for each variant in the inference experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure configuration for deploying the corresponding variant.
    
    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 hasModelVariants() method.
    
    Returns:
    
    An array of ModelVariantConfigSummary objects. There is one for each variant in the inference experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure configuration for deploying the corresponding variant.
  - dataStorageConfig
```
public final InferenceExperimentDataStorageConfig dataStorageConfig()
```
    The Amazon S3 location and configuration for storing inference request and response data.
    
    Returns:
    
    The Amazon S3 location and configuration for storing inference request and response data.
  - shadowModeConfig
```
public final ShadowModeConfig shadowModeConfig()
```
    The configuration of ShadowMode inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.
    
    Returns:
    
    The configuration of ShadowMode inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.
  - kmsKey
```
public final String kmsKey()
```
    The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see CreateInferenceExperiment.
    
    Returns:
    
    The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see CreateInferenceExperiment.
  - toBuilder
```
public DescribeInferenceExperimentResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeInferenceExperimentResponse.Builder,DescribeInferenceExperimentResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeInferenceExperimentResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeInferenceExperimentResponse.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

Class DescribeInferenceExperimentResponse

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

arn

name

type

typeAsString

schedule

status

statusAsString

statusReason

description

creationTime

completionTime

lastModifiedTime

roleArn

endpointMetadata

hasModelVariants

modelVariants

dataStorageConfig

shadowModeConfig

kmsKey

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields