Class CreateFeatureGroupRequest
- 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.CreateFeatureGroupRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateFeatureGroupRequest.Builder,CreateFeatureGroupRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateFeatureGroupRequest extends SageMakerRequest implements ToCopyableBuilder<CreateFeatureGroupRequest.Builder,CreateFeatureGroupRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
CreateFeatureGroupRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateFeatureGroupRequest.Builder
builder()
String
description()
A free-form description of aFeatureGroup
.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
String
eventTimeFeatureName()
The name of the feature that stores theEventTime
of aRecord
in aFeatureGroup
.List<FeatureDefinition>
featureDefinitions()
A list ofFeature
names and types.String
featureGroupName()
The name of theFeatureGroup
.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasFeatureDefinitions()
For responses, this returns true if the service returned a value for the FeatureDefinitions property.int
hashCode()
boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.OfflineStoreConfig
offlineStoreConfig()
Use this to configure anOfflineFeatureStore
.OnlineStoreConfig
onlineStoreConfig()
You can turn theOnlineStore
on or off by specifyingTrue
for theEnableOnlineStore
flag inOnlineStoreConfig
.String
recordIdentifierFeatureName()
The name of theFeature
whose value uniquely identifies aRecord
defined in theFeatureStore
.String
roleArn()
The Amazon Resource Name (ARN) of the IAM execution role used to persist data into theOfflineStore
if anOfflineStoreConfig
is provided.List<SdkField<?>>
sdkFields()
static Class<? extends CreateFeatureGroupRequest.Builder>
serializableBuilderClass()
List<Tag>
tags()
Tags used to identifyFeatures
in eachFeatureGroup
.CreateFeatureGroupRequest.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
-
featureGroupName
public final String featureGroupName()
The name of the
FeatureGroup
. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account. The name:-
Must start and end with an alphanumeric character.
-
Can only contain alphanumeric character and hyphens. Spaces are not allowed.
- Returns:
- The name of the
FeatureGroup
. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account. The name:-
Must start and end with an alphanumeric character.
-
Can only contain alphanumeric character and hyphens. Spaces are not allowed.
-
-
-
recordIdentifierFeatureName
public final String recordIdentifierFeatureName()
The name of the
Feature
whose value uniquely identifies aRecord
defined in theFeatureStore
. Only the latest record per identifier value will be stored in theOnlineStore
.RecordIdentifierFeatureName
must be one of feature definitions' names.You use the
RecordIdentifierFeatureName
to access data in aFeatureStore
.This name:
-
Must start and end with an alphanumeric character.
-
Can only contains alphanumeric characters, hyphens, underscores. Spaces are not allowed.
- Returns:
- The name of the
Feature
whose value uniquely identifies aRecord
defined in theFeatureStore
. Only the latest record per identifier value will be stored in theOnlineStore
.RecordIdentifierFeatureName
must be one of feature definitions' names.You use the
RecordIdentifierFeatureName
to access data in aFeatureStore
.This name:
-
Must start and end with an alphanumeric character.
-
Can only contains alphanumeric characters, hyphens, underscores. Spaces are not allowed.
-
-
-
eventTimeFeatureName
public final String eventTimeFeatureName()
The name of the feature that stores the
EventTime
of aRecord
in aFeatureGroup
.An
EventTime
is a point in time when a new event occurs that corresponds to the creation or update of aRecord
in aFeatureGroup
. AllRecords
in theFeatureGroup
must have a correspondingEventTime
.An
EventTime
can be aString
orFractional
.-
Fractional
:EventTime
feature values must be a Unix timestamp in seconds. -
String
:EventTime
feature values must be an ISO-8601 string in the format. The following formats are supportedyyyy-MM-dd'T'HH:mm:ssZ
andyyyy-MM-dd'T'HH:mm:ss.SSSZ
whereyyyy
,MM
, anddd
represent the year, month, and day respectively andHH
,mm
,ss
, and if applicable,SSS
represent the hour, month, second and milliseconds respsectively.'T'
andZ
are constants.
- Returns:
- The name of the feature that stores the
EventTime
of aRecord
in aFeatureGroup
.An
EventTime
is a point in time when a new event occurs that corresponds to the creation or update of aRecord
in aFeatureGroup
. AllRecords
in theFeatureGroup
must have a correspondingEventTime
.An
EventTime
can be aString
orFractional
.-
Fractional
:EventTime
feature values must be a Unix timestamp in seconds. -
String
:EventTime
feature values must be an ISO-8601 string in the format. The following formats are supportedyyyy-MM-dd'T'HH:mm:ssZ
andyyyy-MM-dd'T'HH:mm:ss.SSSZ
whereyyyy
,MM
, anddd
represent the year, month, and day respectively andHH
,mm
,ss
, and if applicable,SSS
represent the hour, month, second and milliseconds respsectively.'T'
andZ
are constants.
-
-
-
hasFeatureDefinitions
public final boolean hasFeatureDefinitions()
For responses, this returns true if the service returned a value for the FeatureDefinitions 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.
-
featureDefinitions
public final List<FeatureDefinition> featureDefinitions()
A list of
Feature
names and types.Name
andType
is compulsory perFeature
.Valid feature
FeatureType
s areIntegral
,Fractional
andString
.FeatureName
s cannot be any of the following:is_deleted
,write_time
,api_invocation_time
You can create up to 2,500
FeatureDefinition
s perFeatureGroup
.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
hasFeatureDefinitions()
method.- Returns:
- A list of
Feature
names and types.Name
andType
is compulsory perFeature
.Valid feature
FeatureType
s areIntegral
,Fractional
andString
.FeatureName
s cannot be any of the following:is_deleted
,write_time
,api_invocation_time
You can create up to 2,500
FeatureDefinition
s perFeatureGroup
.
-
onlineStoreConfig
public final OnlineStoreConfig onlineStoreConfig()
You can turn the
OnlineStore
on or off by specifyingTrue
for theEnableOnlineStore
flag inOnlineStoreConfig
.You can also include an Amazon Web Services KMS key ID (
KMSKeyId
) for at-rest encryption of theOnlineStore
.The default value is
False
.- Returns:
- You can turn the
OnlineStore
on or off by specifyingTrue
for theEnableOnlineStore
flag inOnlineStoreConfig
.You can also include an Amazon Web Services KMS key ID (
KMSKeyId
) for at-rest encryption of theOnlineStore
.The default value is
False
.
-
offlineStoreConfig
public final OfflineStoreConfig offlineStoreConfig()
Use this to configure an
OfflineFeatureStore
. This parameter allows you to specify:-
The Amazon Simple Storage Service (Amazon S3) location of an
OfflineStore
. -
A configuration for an Amazon Web Services Glue or Amazon Web Services Hive data catalog.
-
An KMS encryption key to encrypt the Amazon S3 location used for
OfflineStore
. If KMS encryption key is not specified, by default we encrypt all data at rest using Amazon Web Services KMS key. By defining your bucket-level key for SSE, you can reduce Amazon Web Services KMS requests costs by up to 99 percent. -
Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.
To learn more about this parameter, see OfflineStoreConfig.
- Returns:
- Use this to configure an
OfflineFeatureStore
. This parameter allows you to specify:-
The Amazon Simple Storage Service (Amazon S3) location of an
OfflineStore
. -
A configuration for an Amazon Web Services Glue or Amazon Web Services Hive data catalog.
-
An KMS encryption key to encrypt the Amazon S3 location used for
OfflineStore
. If KMS encryption key is not specified, by default we encrypt all data at rest using Amazon Web Services KMS key. By defining your bucket-level key for SSE, you can reduce Amazon Web Services KMS requests costs by up to 99 percent. -
Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.
To learn more about this parameter, see OfflineStoreConfig.
-
-
-
roleArn
public final String roleArn()
The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the
OfflineStore
if anOfflineStoreConfig
is provided.- Returns:
- The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the
OfflineStore
if anOfflineStoreConfig
is provided.
-
description
public final String description()
A free-form description of a
FeatureGroup
.- Returns:
- A free-form description of a
FeatureGroup
.
-
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()
Tags used to identify
Features
in eachFeatureGroup
.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:
- Tags used to identify
Features
in eachFeatureGroup
.
-
toBuilder
public CreateFeatureGroupRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateFeatureGroupRequest.Builder,CreateFeatureGroupRequest>
- Specified by:
toBuilder
in classSageMakerRequest
-
builder
public static CreateFeatureGroupRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateFeatureGroupRequest.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
-
-