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

Class CollectionConfiguration

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.CollectionConfiguration

All Implemented Interfaces:

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

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

Configuration information for the Amazon SageMaker Debugger output tensor collections.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CollectionConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static CollectionConfiguration.Builder	builder()
String	collectionName()	The name of the tensor collection.
Map<String,String>	collectionParameters()	Parameter values for the tensor collection.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCollectionParameters()	For responses, this returns true if the service returned a value for the CollectionParameters property.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CollectionConfiguration.Builder>	serializableBuilderClass()
CollectionConfiguration.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

collectionName

public final String collectionName()

The name of the tensor collection. The name must be unique relative to other rule configuration names.

Returns:

The name of the tensor collection. The name must be unique relative to other rule configuration names.

hasCollectionParameters

public final boolean hasCollectionParameters()

For responses, this returns true if the service returned a value for the CollectionParameters 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.

collectionParameters

public final Map<String,String> collectionParameters()

Parameter values for the tensor collection. The allowed parameters are "name", "include_regex", "reduction_config", "save_config", "tensor_names", and "save_histogram".

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 hasCollectionParameters() method.

Returns:

Parameter values for the tensor collection. The allowed parameters are "name", "include_regex", "reduction_config", "save_config", "tensor_names", and "save_histogram".

toBuilder

public CollectionConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CollectionConfiguration.Builder,CollectionConfiguration>

builder

public static CollectionConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends CollectionConfiguration.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo