Class PutRecordRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.sagemakerfeaturestoreruntime.model.SageMakerFeatureStoreRuntimeRequest
-
- software.amazon.awssdk.services.sagemakerfeaturestoreruntime.model.PutRecordRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<PutRecordRequest.Builder,PutRecordRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutRecordRequest extends SageMakerFeatureStoreRuntimeRequest implements ToCopyableBuilder<PutRecordRequest.Builder,PutRecordRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfacePutRecordRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static PutRecordRequest.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringfeatureGroupName()The name or Amazon Resource Name (ARN) of the feature group that you want to insert the record into.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasRecord()For responses, this returns true if the service returned a value for the Record property.booleanhasTargetStores()For responses, this returns true if the service returned a value for the TargetStores property.List<FeatureValue>record()List of FeatureValues to be inserted.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends PutRecordRequest.Builder>serializableBuilderClass()List<TargetStore>targetStores()A list of stores to which you're adding the record.List<String>targetStoresAsStrings()A list of stores to which you're adding the record.PutRecordRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.TtlDurationttlDuration()Time to live duration, where the record is hard deleted after the expiration time is reached;ExpiresAt=EventTime+TtlDuration.-
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
-
featureGroupName
public final String featureGroupName()
The name or Amazon Resource Name (ARN) of the feature group that you want to insert the record into.
- Returns:
- The name or Amazon Resource Name (ARN) of the feature group that you want to insert the record into.
-
hasRecord
public final boolean hasRecord()
For responses, this returns true if the service returned a value for the Record 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.
-
record
public final List<FeatureValue> record()
List of FeatureValues to be inserted. This will be a full over-write. If you only want to update few of the feature values, do the following:
-
Use
GetRecordto retrieve the latest record. -
Update the record returned from
GetRecord. -
Use
PutRecordto update feature values.
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
hasRecord()method.- Returns:
- List of FeatureValues to be inserted. This will be a full over-write. If you only want to update few of
the feature values, do the following:
-
Use
GetRecordto retrieve the latest record. -
Update the record returned from
GetRecord. -
Use
PutRecordto update feature values.
-
-
-
targetStores
public final List<TargetStore> targetStores()
A list of stores to which you're adding the record. By default, Feature Store adds the record to all of the stores that you're using for the
FeatureGroup.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
hasTargetStores()method.- Returns:
- A list of stores to which you're adding the record. By default, Feature Store adds the record to all of
the stores that you're using for the
FeatureGroup.
-
hasTargetStores
public final boolean hasTargetStores()
For responses, this returns true if the service returned a value for the TargetStores 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.
-
targetStoresAsStrings
public final List<String> targetStoresAsStrings()
A list of stores to which you're adding the record. By default, Feature Store adds the record to all of the stores that you're using for the
FeatureGroup.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
hasTargetStores()method.- Returns:
- A list of stores to which you're adding the record. By default, Feature Store adds the record to all of
the stores that you're using for the
FeatureGroup.
-
ttlDuration
public final TtlDuration ttlDuration()
Time to live duration, where the record is hard deleted after the expiration time is reached;
ExpiresAt=EventTime+TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.- Returns:
- Time to live duration, where the record is hard deleted after the expiration time is reached;
ExpiresAt=EventTime+TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
-
toBuilder
public PutRecordRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<PutRecordRequest.Builder,PutRecordRequest>- Specified by:
toBuilderin classSageMakerFeatureStoreRuntimeRequest
-
builder
public static PutRecordRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends PutRecordRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
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 classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-