Class GetModelCustomizationJobResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetModelCustomizationJobResponse.Builder,
GetModelCustomizationJobResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
Amazon Resource Name (ARN) of the base model.builder()
final String
The token that you specified in theCreateCustomizationJob
request.final Instant
Time that the resource was created.final CustomizationType
The type of model customization.final String
The type of model customization.final Instant
endTime()
Time that the resource transitioned to terminal state.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
Information about why the job failed.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the HyperParameters property.final boolean
For responses, this returns true if the service returned a value for the ValidationMetrics property.The hyperparameter values for the job.final String
jobArn()
The Amazon Resource Name (ARN) of the customization job.final String
jobName()
The name of the customization job.final Instant
Time that the resource was last modified.final OutputDataConfig
Output data configurationfinal String
The Amazon Resource Name (ARN) of the output model.final String
The custom model is encrypted at rest using this key.final String
The name of the output model.final String
roleArn()
The Amazon Resource Name (ARN) of the IAM role.static Class
<? extends GetModelCustomizationJobResponse.Builder> status()
The status of the job.final String
The status of the job.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final TrainingDataConfig
Contains information about the training dataset.final TrainingMetrics
Contains training metrics from the job creation.final ValidationDataConfig
Contains information about the validation dataset.final List
<ValidatorMetric> The loss metric for each validator that you provided in the createjob request.final VpcConfig
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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
jobArn
The Amazon Resource Name (ARN) of the customization job.
- Returns:
- The Amazon Resource Name (ARN) of the customization job.
-
jobName
The name of the customization job.
- Returns:
- The name of the customization job.
-
outputModelName
The name of the output model.
- Returns:
- The name of the output model.
-
outputModelArn
The Amazon Resource Name (ARN) of the output model.
- Returns:
- The Amazon Resource Name (ARN) of the output model.
-
clientRequestToken
The token that you specified in the
CreateCustomizationJob
request.- Returns:
- The token that you specified in the
CreateCustomizationJob
request.
-
roleArn
The Amazon Resource Name (ARN) of the IAM role.
- Returns:
- The Amazon Resource Name (ARN) of the IAM role.
-
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,
status
will 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:
-
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,
status
will 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:
-
failureMessage
Information about why the job failed.
- Returns:
- Information about why the job failed.
-
creationTime
Time that the resource was created.
- Returns:
- Time that the resource was created.
-
lastModifiedTime
Time that the resource was last modified.
- Returns:
- Time that the resource was last modified.
-
endTime
Time that the resource transitioned to terminal state.
- Returns:
- Time that the resource transitioned to terminal state.
-
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
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
Contains information about the training dataset.
- Returns:
- Contains information about the training dataset.
-
validationDataConfig
Contains information about the validation dataset.
- Returns:
- Contains information about the validation dataset.
-
outputDataConfig
Output data configuration
- Returns:
- Output data configuration
-
customizationType
The type of model customization.
If the service returns an enum value that is not available in the current SDK version,
customizationType
will returnCustomizationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcustomizationTypeAsString()
.- Returns:
- The type of model customization.
- See Also:
-
customizationTypeAsString
The type of model customization.
If the service returns an enum value that is not available in the current SDK version,
customizationType
will returnCustomizationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcustomizationTypeAsString()
.- Returns:
- The type of model customization.
- See Also:
-
outputModelKmsKeyArn
The custom model is encrypted at rest using this key.
- Returns:
- The custom model is encrypted at rest using this key.
-
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
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
VPC configuration for the custom model job.
- Returns:
- VPC configuration for the custom model job.
-
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 interfaceToCopyableBuilder<GetModelCustomizationJobResponse.Builder,
GetModelCustomizationJobResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-