Class GetModelCustomizationJobResponse
- java.lang.Object
-
- software.amazon.awssdk.core.SdkResponse
-
- software.amazon.awssdk.awscore.AwsResponse
-
- software.amazon.awssdk.services.bedrock.model.BedrockResponse
-
- software.amazon.awssdk.services.bedrock.model.GetModelCustomizationJobResponse
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<GetModelCustomizationJobResponse.Builder,GetModelCustomizationJobResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetModelCustomizationJobResponse extends BedrockResponse implements ToCopyableBuilder<GetModelCustomizationJobResponse.Builder,GetModelCustomizationJobResponse>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGetModelCustomizationJobResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringbaseModelArn()Amazon Resource Name (ARN) of the base model.static GetModelCustomizationJobResponse.Builderbuilder()StringclientRequestToken()The token that you specified in theCreateCustomizationJobrequest.InstantcreationTime()Time that the resource was created.CustomizationConfigcustomizationConfig()The customization configuration for the model customization job.CustomizationTypecustomizationType()The type of model customization.StringcustomizationTypeAsString()The type of model customization.InstantendTime()Time that the resource transitioned to terminal state.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringfailureMessage()Information about why the job failed.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasHyperParameters()For responses, this returns true if the service returned a value for the HyperParameters property.booleanhasValidationMetrics()For responses, this returns true if the service returned a value for the ValidationMetrics property.Map<String,String>hyperParameters()The hyperparameter values for the job.StringjobArn()The Amazon Resource Name (ARN) of the customization job.StringjobName()The name of the customization job.InstantlastModifiedTime()Time that the resource was last modified.OutputDataConfigoutputDataConfig()Output data configurationStringoutputModelArn()The Amazon Resource Name (ARN) of the output model.StringoutputModelKmsKeyArn()The custom model is encrypted at rest using this key.StringoutputModelName()The name of the output model.StringroleArn()The Amazon Resource Name (ARN) of the IAM role.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends GetModelCustomizationJobResponse.Builder>serializableBuilderClass()ModelCustomizationJobStatusstatus()The status of the job.StringstatusAsString()The status of the job.StatusDetailsstatusDetails()For a Distillation job, the details about the statuses of the sub-tasks of the customization job.GetModelCustomizationJobResponse.BuildertoBuilder()StringtoString()Returns a string representation of this object.TrainingDataConfigtrainingDataConfig()Contains information about the training dataset.TrainingMetricstrainingMetrics()Contains training metrics from the job creation.ValidationDataConfigvalidationDataConfig()Contains information about the validation dataset.List<ValidatorMetric>validationMetrics()The loss metric for each validator that you provided in the createjob request.VpcConfigvpcConfig()VPC configuration for the custom model job.-
Methods inherited from class software.amazon.awssdk.services.bedrock.model.BedrockResponse
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
-
jobArn
public final String jobArn()
The Amazon Resource Name (ARN) of the customization job.
- Returns:
- The Amazon Resource Name (ARN) of the customization job.
-
jobName
public final String jobName()
The name of the customization job.
- Returns:
- The name of the customization job.
-
outputModelName
public final String outputModelName()
The name of the output model.
- Returns:
- The name of the output model.
-
outputModelArn
public final String outputModelArn()
The Amazon Resource Name (ARN) of the output model.
- Returns:
- The Amazon Resource Name (ARN) of the output model.
-
clientRequestToken
public final String clientRequestToken()
The token that you specified in the
CreateCustomizationJobrequest.- Returns:
- The token that you specified in the
CreateCustomizationJobrequest.
-
roleArn
public final String roleArn()
The Amazon Resource Name (ARN) of the IAM role.
- Returns:
- The Amazon Resource Name (ARN) of the IAM role.
-
status
public final ModelCustomizationJobStatus status()
The status of the job. A successful job transitions from in-progress to completed when the output model is ready to use. If the job failed, the failure message contains information about why the job failed.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnModelCustomizationJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the job. A successful job transitions from in-progress to completed when the output model is ready to use. If the job failed, the failure message contains information about why the job failed.
- See Also:
ModelCustomizationJobStatus
-
statusAsString
public final String statusAsString()
The status of the job. A successful job transitions from in-progress to completed when the output model is ready to use. If the job failed, the failure message contains information about why the job failed.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnModelCustomizationJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the job. A successful job transitions from in-progress to completed when the output model is ready to use. If the job failed, the failure message contains information about why the job failed.
- See Also:
ModelCustomizationJobStatus
-
statusDetails
public final StatusDetails statusDetails()
For a Distillation job, the details about the statuses of the sub-tasks of the customization job.
- Returns:
- For a Distillation job, the details about the statuses of the sub-tasks of the customization job.
-
failureMessage
public final String failureMessage()
Information about why the job failed.
- Returns:
- Information about why the job failed.
-
creationTime
public final Instant creationTime()
Time that the resource was created.
- Returns:
- Time that the resource was created.
-
lastModifiedTime
public final Instant lastModifiedTime()
Time that the resource was last modified.
- Returns:
- Time that the resource was last modified.
-
endTime
public final Instant endTime()
Time that the resource transitioned to terminal state.
- Returns:
- Time that the resource transitioned to terminal state.
-
baseModelArn
public final String baseModelArn()
Amazon Resource Name (ARN) of the base model.
- Returns:
- Amazon Resource Name (ARN) of the base model.
-
hasHyperParameters
public final boolean hasHyperParameters()
For responses, this returns true if the service returned a value for the HyperParameters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
hyperParameters
public final Map<String,String> hyperParameters()
The hyperparameter values for the job. For details on the format for different models, see Custom model hyperparameters.
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
hasHyperParameters()method.- Returns:
- The hyperparameter values for the job. For details on the format for different models, see Custom model hyperparameters.
-
trainingDataConfig
public final TrainingDataConfig trainingDataConfig()
Contains information about the training dataset.
- Returns:
- Contains information about the training dataset.
-
validationDataConfig
public final ValidationDataConfig validationDataConfig()
Contains information about the validation dataset.
- Returns:
- Contains information about the validation dataset.
-
outputDataConfig
public final OutputDataConfig outputDataConfig()
Output data configuration
- Returns:
- Output data configuration
-
customizationType
public final CustomizationType customizationType()
The type of model customization.
If the service returns an enum value that is not available in the current SDK version,
customizationTypewill returnCustomizationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcustomizationTypeAsString().- Returns:
- The type of model customization.
- See Also:
CustomizationType
-
customizationTypeAsString
public final String customizationTypeAsString()
The type of model customization.
If the service returns an enum value that is not available in the current SDK version,
customizationTypewill returnCustomizationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcustomizationTypeAsString().- Returns:
- The type of model customization.
- See Also:
CustomizationType
-
outputModelKmsKeyArn
public final String outputModelKmsKeyArn()
The custom model is encrypted at rest using this key.
- Returns:
- The custom model is encrypted at rest using this key.
-
trainingMetrics
public final TrainingMetrics trainingMetrics()
Contains training metrics from the job creation.
- Returns:
- Contains training metrics from the job creation.
-
hasValidationMetrics
public final boolean hasValidationMetrics()
For responses, this returns true if the service returned a value for the ValidationMetrics property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
validationMetrics
public final List<ValidatorMetric> validationMetrics()
The loss metric for each validator that you provided in the createjob request.
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
hasValidationMetrics()method.- Returns:
- The loss metric for each validator that you provided in the createjob request.
-
vpcConfig
public final VpcConfig vpcConfig()
VPC configuration for the custom model job.
- Returns:
- VPC configuration for the custom model job.
-
customizationConfig
public final CustomizationConfig customizationConfig()
The customization configuration for the model customization job.
- Returns:
- The customization configuration for the model customization job.
-
toBuilder
public GetModelCustomizationJobResponse.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<GetModelCustomizationJobResponse.Builder,GetModelCustomizationJobResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static GetModelCustomizationJobResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetModelCustomizationJobResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-