Package software.amazon.awssdk.services.sagemaker.model

Class ModelPackageGroup

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.ModelPackageGroup

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ModelPackageGroup.Builder,ModelPackageGroup>

@Generated("software.amazon.awssdk:codegen")
public final class ModelPackageGroup
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ModelPackageGroup.Builder,ModelPackageGroup>

A group of versioned models in the model registry.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ModelPackageGroup.Builder

Method Summary

Modifier and Type	Method	Description
static ModelPackageGroup.Builder	builder()
UserContext	createdBy()	Returns the value of the CreatedBy property for this object.
Instant	creationTime()	The time that the model group was created.
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	modelPackageGroupArn()	The Amazon Resource Name (ARN) of the model group.
String	modelPackageGroupDescription()	The description for the model group.
String	modelPackageGroupName()	The name of the model group.
ModelPackageGroupStatus	modelPackageGroupStatus()	The status of the model group.
String	modelPackageGroupStatusAsString()	The status of the model group.
List<SdkField<?>>	sdkFields()
static Class<? extends ModelPackageGroup.Builder>	serializableBuilderClass()
List<Tag>	tags()	A list of the tags associated with the model group.
ModelPackageGroup.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

modelPackageGroupName

public final String modelPackageGroupName()

The name of the model group.

Returns:

The name of the model group.

modelPackageGroupArn

public final String modelPackageGroupArn()

The Amazon Resource Name (ARN) of the model group.

Returns:

The Amazon Resource Name (ARN) of the model group.

modelPackageGroupDescription

public final String modelPackageGroupDescription()

The description for the model group.

Returns:

The description for the model group.

creationTime

public final Instant creationTime()

The time that the model group was created.

Returns:

The time that the model group was created.

createdBy

public final UserContext createdBy()

Returns the value of the CreatedBy property for this object.

Returns:

The value of the CreatedBy property for this object.

modelPackageGroupStatus

public final ModelPackageGroupStatus modelPackageGroupStatus()

The status of the model group. This can be one of the following values.

• PENDING - The model group is pending being created.

• IN_PROGRESS - The model group is in the process of being created.

• COMPLETED - The model group was successfully created.

• FAILED - The model group failed.

• DELETING - The model group is in the process of being deleted.

• DELETE_FAILED - SageMaker failed to delete the model group.

If the service returns an enum value that is not available in the current SDK version, modelPackageGroupStatus will return ModelPackageGroupStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modelPackageGroupStatusAsString().

Returns:

The status of the model group. This can be one of the following values.

• PENDING - The model group is pending being created.

• IN_PROGRESS - The model group is in the process of being created.

• COMPLETED - The model group was successfully created.

• FAILED - The model group failed.

• DELETING - The model group is in the process of being deleted.

• DELETE_FAILED - SageMaker failed to delete the model group.

See Also:

ModelPackageGroupStatus

modelPackageGroupStatusAsString

public final String modelPackageGroupStatusAsString()

The status of the model group. This can be one of the following values.

• PENDING - The model group is pending being created.

• IN_PROGRESS - The model group is in the process of being created.

• COMPLETED - The model group was successfully created.

• FAILED - The model group failed.

• DELETING - The model group is in the process of being deleted.

• DELETE_FAILED - SageMaker failed to delete the model group.

If the service returns an enum value that is not available in the current SDK version, modelPackageGroupStatus will return ModelPackageGroupStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modelPackageGroupStatusAsString().

Returns:

The status of the model group. This can be one of the following values.

• PENDING - The model group is pending being created.

• IN_PROGRESS - The model group is in the process of being created.

• COMPLETED - The model group was successfully created.

• FAILED - The model group failed.

• DELETING - The model group is in the process of being deleted.

• DELETE_FAILED - SageMaker failed to delete the model group.

See Also:

ModelPackageGroupStatus

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

tags

public final List<Tag> tags()

A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

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:

A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

toBuilder

public ModelPackageGroup.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ModelPackageGroup.Builder,ModelPackageGroup>

builder

public static ModelPackageGroup.Builder builder()

serializableBuilderClass

public static Class<? extends ModelPackageGroup.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo