Class CreateModelCardRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.sagemaker.model.SageMakerRequest
-
- software.amazon.awssdk.services.sagemaker.model.CreateModelCardRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateModelCardRequest.Builder,CreateModelCardRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateModelCardRequest extends SageMakerRequest implements ToCopyableBuilder<CreateModelCardRequest.Builder,CreateModelCardRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
CreateModelCardRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateModelCardRequest.Builder
builder()
String
content()
The content of the model card.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.String
modelCardName()
The unique name of the model card.ModelCardStatus
modelCardStatus()
The approval status of the model card within your organization.String
modelCardStatusAsString()
The approval status of the model card within your organization.List<SdkField<?>>
sdkFields()
ModelCardSecurityConfig
securityConfig()
An optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data.static Class<? extends CreateModelCardRequest.Builder>
serializableBuilderClass()
List<Tag>
tags()
Key-value pairs used to manage metadata for model cards.CreateModelCardRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
modelCardName
public final String modelCardName()
The unique name of the model card.
- Returns:
- The unique name of the model card.
-
securityConfig
public final ModelCardSecurityConfig securityConfig()
An optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data.
- Returns:
- An optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data.
-
content
public final String content()
The content of the model card. Content must be in model card JSON schema and provided as a string.
- Returns:
- The content of the model card. Content must be in model card JSON schema and provided as a string.
-
modelCardStatus
public final ModelCardStatus modelCardStatus()
The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
-
Draft
: The model card is a work in progress. -
PendingReview
: The model card is pending review. -
Approved
: The model card is approved. -
Archived
: The model card is archived. No more updates should be made to the model card, but it can still be exported.
If the service returns an enum value that is not available in the current SDK version,
modelCardStatus
will returnModelCardStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommodelCardStatusAsString()
.- Returns:
- The approval status of the model card within your organization. Different organizations might have
different criteria for model card review and approval.
-
Draft
: The model card is a work in progress. -
PendingReview
: The model card is pending review. -
Approved
: The model card is approved. -
Archived
: The model card is archived. No more updates should be made to the model card, but it can still be exported.
-
- See Also:
ModelCardStatus
-
-
modelCardStatusAsString
public final String modelCardStatusAsString()
The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
-
Draft
: The model card is a work in progress. -
PendingReview
: The model card is pending review. -
Approved
: The model card is approved. -
Archived
: The model card is archived. No more updates should be made to the model card, but it can still be exported.
If the service returns an enum value that is not available in the current SDK version,
modelCardStatus
will returnModelCardStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommodelCardStatusAsString()
.- Returns:
- The approval status of the model card within your organization. Different organizations might have
different criteria for model card review and approval.
-
Draft
: The model card is a work in progress. -
PendingReview
: The model card is pending review. -
Approved
: The model card is approved. -
Archived
: The model card is archived. No more updates should be made to the model card, but it can still be exported.
-
- See Also:
ModelCardStatus
-
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags 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.
-
tags
public final List<Tag> tags()
Key-value pairs used to manage metadata for model cards.
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
hasTags()
method.- Returns:
- Key-value pairs used to manage metadata for model cards.
-
toBuilder
public CreateModelCardRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateModelCardRequest.Builder,CreateModelCardRequest>
- Specified by:
toBuilder
in classSageMakerRequest
-
builder
public static CreateModelCardRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateModelCardRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in 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:
getValueForField
in classSdkRequest
-
-