software.amazon.awssdk.services.sagemaker.model.DescribeFeatureGroupResponse Maven / Gradle / Ivy
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.sagemaker.model;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeFeatureGroupResponse extends SageMakerResponse implements
ToCopyableBuilder {
private static final SdkField FEATURE_GROUP_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("FeatureGroupArn").getter(getter(DescribeFeatureGroupResponse::featureGroupArn))
.setter(setter(Builder::featureGroupArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FeatureGroupArn").build()).build();
private static final SdkField FEATURE_GROUP_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("FeatureGroupName").getter(getter(DescribeFeatureGroupResponse::featureGroupName))
.setter(setter(Builder::featureGroupName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FeatureGroupName").build()).build();
private static final SdkField RECORD_IDENTIFIER_FEATURE_NAME_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("RecordIdentifierFeatureName")
.getter(getter(DescribeFeatureGroupResponse::recordIdentifierFeatureName))
.setter(setter(Builder::recordIdentifierFeatureName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RecordIdentifierFeatureName")
.build()).build();
private static final SdkField EVENT_TIME_FEATURE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EventTimeFeatureName").getter(getter(DescribeFeatureGroupResponse::eventTimeFeatureName))
.setter(setter(Builder::eventTimeFeatureName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EventTimeFeatureName").build())
.build();
private static final SdkField> FEATURE_DEFINITIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("FeatureDefinitions")
.getter(getter(DescribeFeatureGroupResponse::featureDefinitions))
.setter(setter(Builder::featureDefinitions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FeatureDefinitions").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(FeatureDefinition::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField CREATION_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("CreationTime").getter(getter(DescribeFeatureGroupResponse::creationTime))
.setter(setter(Builder::creationTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreationTime").build()).build();
private static final SdkField ONLINE_STORE_CONFIG_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("OnlineStoreConfig")
.getter(getter(DescribeFeatureGroupResponse::onlineStoreConfig)).setter(setter(Builder::onlineStoreConfig))
.constructor(OnlineStoreConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OnlineStoreConfig").build()).build();
private static final SdkField OFFLINE_STORE_CONFIG_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("OfflineStoreConfig")
.getter(getter(DescribeFeatureGroupResponse::offlineStoreConfig)).setter(setter(Builder::offlineStoreConfig))
.constructor(OfflineStoreConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OfflineStoreConfig").build())
.build();
private static final SdkField ROLE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("RoleArn").getter(getter(DescribeFeatureGroupResponse::roleArn)).setter(setter(Builder::roleArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RoleArn").build()).build();
private static final SdkField FEATURE_GROUP_STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("FeatureGroupStatus").getter(getter(DescribeFeatureGroupResponse::featureGroupStatusAsString))
.setter(setter(Builder::featureGroupStatus))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FeatureGroupStatus").build())
.build();
private static final SdkField OFFLINE_STORE_STATUS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("OfflineStoreStatus")
.getter(getter(DescribeFeatureGroupResponse::offlineStoreStatus)).setter(setter(Builder::offlineStoreStatus))
.constructor(OfflineStoreStatus::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OfflineStoreStatus").build())
.build();
private static final SdkField FAILURE_REASON_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("FailureReason").getter(getter(DescribeFeatureGroupResponse::failureReason))
.setter(setter(Builder::failureReason))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FailureReason").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(DescribeFeatureGroupResponse::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(DescribeFeatureGroupResponse::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(FEATURE_GROUP_ARN_FIELD,
FEATURE_GROUP_NAME_FIELD, RECORD_IDENTIFIER_FEATURE_NAME_FIELD, EVENT_TIME_FEATURE_NAME_FIELD,
FEATURE_DEFINITIONS_FIELD, CREATION_TIME_FIELD, ONLINE_STORE_CONFIG_FIELD, OFFLINE_STORE_CONFIG_FIELD,
ROLE_ARN_FIELD, FEATURE_GROUP_STATUS_FIELD, OFFLINE_STORE_STATUS_FIELD, FAILURE_REASON_FIELD, DESCRIPTION_FIELD,
NEXT_TOKEN_FIELD));
private final String featureGroupArn;
private final String featureGroupName;
private final String recordIdentifierFeatureName;
private final String eventTimeFeatureName;
private final List featureDefinitions;
private final Instant creationTime;
private final OnlineStoreConfig onlineStoreConfig;
private final OfflineStoreConfig offlineStoreConfig;
private final String roleArn;
private final String featureGroupStatus;
private final OfflineStoreStatus offlineStoreStatus;
private final String failureReason;
private final String description;
private final String nextToken;
private DescribeFeatureGroupResponse(BuilderImpl builder) {
super(builder);
this.featureGroupArn = builder.featureGroupArn;
this.featureGroupName = builder.featureGroupName;
this.recordIdentifierFeatureName = builder.recordIdentifierFeatureName;
this.eventTimeFeatureName = builder.eventTimeFeatureName;
this.featureDefinitions = builder.featureDefinitions;
this.creationTime = builder.creationTime;
this.onlineStoreConfig = builder.onlineStoreConfig;
this.offlineStoreConfig = builder.offlineStoreConfig;
this.roleArn = builder.roleArn;
this.featureGroupStatus = builder.featureGroupStatus;
this.offlineStoreStatus = builder.offlineStoreStatus;
this.failureReason = builder.failureReason;
this.description = builder.description;
this.nextToken = builder.nextToken;
}
/**
*
* The Amazon Resource Name (ARN) of the FeatureGroup.
*
*
* @return The Amazon Resource Name (ARN) of the FeatureGroup.
*/
public final String featureGroupArn() {
return featureGroupArn;
}
/**
*
* he name of the FeatureGroup.
*
*
* @return he name of the FeatureGroup.
*/
public final String featureGroupName() {
return featureGroupName;
}
/**
*
* The name of the Feature used for RecordIdentifier, whose value uniquely identifies a
* record stored in the feature store.
*
*
* @return The name of the Feature used for RecordIdentifier, whose value uniquely
* identifies a record stored in the feature store.
*/
public final String recordIdentifierFeatureName() {
return recordIdentifierFeatureName;
}
/**
*
* The name of the feature that stores the EventTime of a Record in a FeatureGroup.
*
*
* An EventTime is a point in time when a new event occurs that corresponds to the creation or update
* of a Record in a FeatureGroup. All Records in the
* FeatureGroup have a corresponding EventTime.
*
*
* @return The name of the feature that stores the EventTime of a Record in a FeatureGroup
* .
*
* An EventTime is a point in time when a new event occurs that corresponds to the creation or
* update of a Record in a FeatureGroup. All Records in the
* FeatureGroup have a corresponding EventTime.
*/
public final String eventTimeFeatureName() {
return eventTimeFeatureName;
}
/**
* Returns true if the FeatureDefinitions property was specified by the sender (it may be empty), or false if the
* sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS
* service.
*/
public final boolean hasFeatureDefinitions() {
return featureDefinitions != null && !(featureDefinitions instanceof SdkAutoConstructList);
}
/**
*
* A list of the Features in the FeatureGroup. Each feature is defined by a
* FeatureName and FeatureType.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasFeatureDefinitions()} to see if a value was sent in this field.
*
*
* @return A list of the Features in the FeatureGroup. Each feature is defined by a
* FeatureName and FeatureType.
*/
public final List featureDefinitions() {
return featureDefinitions;
}
/**
*
* A timestamp indicating when SageMaker created the FeatureGroup.
*
*
* @return A timestamp indicating when SageMaker created the FeatureGroup.
*/
public final Instant creationTime() {
return creationTime;
}
/**
*
* The configuration for the OnlineStore.
*
*
* @return The configuration for the OnlineStore.
*/
public final OnlineStoreConfig onlineStoreConfig() {
return onlineStoreConfig;
}
/**
*
* The configuration of the OfflineStore, inducing the S3 location of the OfflineStore,
* AWS Glue or AWS Hive data catalogue configurations, and the security configuration.
*
*
* @return The configuration of the OfflineStore, inducing the S3 location of the
* OfflineStore, AWS Glue or AWS Hive data catalogue configurations, and the security
* configuration.
*/
public final OfflineStoreConfig offlineStoreConfig() {
return offlineStoreConfig;
}
/**
*
* The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore
* if an OfflineStoreConfig is provided.
*
*
* @return The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the
* OfflineStore if an OfflineStoreConfig is provided.
*/
public final String roleArn() {
return roleArn;
}
/**
*
* The status of the feature group.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #featureGroupStatus} will return {@link FeatureGroupStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned
* by the service is available from {@link #featureGroupStatusAsString}.
*
*
* @return The status of the feature group.
* @see FeatureGroupStatus
*/
public final FeatureGroupStatus featureGroupStatus() {
return FeatureGroupStatus.fromValue(featureGroupStatus);
}
/**
*
* The status of the feature group.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #featureGroupStatus} will return {@link FeatureGroupStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned
* by the service is available from {@link #featureGroupStatusAsString}.
*
*
* @return The status of the feature group.
* @see FeatureGroupStatus
*/
public final String featureGroupStatusAsString() {
return featureGroupStatus;
}
/**
*
* The status of the OfflineStore. Notifies you if replicating data into the OfflineStore
* has failed. Returns either: Active or Blocked
*
*
* @return The status of the OfflineStore. Notifies you if replicating data into the
* OfflineStore has failed. Returns either: Active or Blocked
*/
public final OfflineStoreStatus offlineStoreStatus() {
return offlineStoreStatus;
}
/**
*
* The reason that the FeatureGroup failed to be replicated in the OfflineStore. This is
* failure can occur because:
*
*
* -
*
* The FeatureGroup could not be created in the OfflineStore.
*
*
* -
*
* The FeatureGroup could not be deleted from the OfflineStore.
*
*
*
*
* @return The reason that the FeatureGroup failed to be replicated in the OfflineStore.
* This is failure can occur because:
*
* -
*
* The FeatureGroup could not be created in the OfflineStore.
*
*
* -
*
* The FeatureGroup could not be deleted from the OfflineStore.
*
*
*/
public final String failureReason() {
return failureReason;
}
/**
*
* A free form description of the feature group.
*
*
* @return A free form description of the feature group.
*/
public final String description() {
return description;
}
/**
*
* A token to resume pagination of the list of Features (FeatureDefinitions).
*
*
* @return A token to resume pagination of the list of Features (FeatureDefinitions).
*/
public final String nextToken() {
return nextToken;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(featureGroupArn());
hashCode = 31 * hashCode + Objects.hashCode(featureGroupName());
hashCode = 31 * hashCode + Objects.hashCode(recordIdentifierFeatureName());
hashCode = 31 * hashCode + Objects.hashCode(eventTimeFeatureName());
hashCode = 31 * hashCode + Objects.hashCode(hasFeatureDefinitions() ? featureDefinitions() : null);
hashCode = 31 * hashCode + Objects.hashCode(creationTime());
hashCode = 31 * hashCode + Objects.hashCode(onlineStoreConfig());
hashCode = 31 * hashCode + Objects.hashCode(offlineStoreConfig());
hashCode = 31 * hashCode + Objects.hashCode(roleArn());
hashCode = 31 * hashCode + Objects.hashCode(featureGroupStatusAsString());
hashCode = 31 * hashCode + Objects.hashCode(offlineStoreStatus());
hashCode = 31 * hashCode + Objects.hashCode(failureReason());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeFeatureGroupResponse)) {
return false;
}
DescribeFeatureGroupResponse other = (DescribeFeatureGroupResponse) obj;
return Objects.equals(featureGroupArn(), other.featureGroupArn())
&& Objects.equals(featureGroupName(), other.featureGroupName())
&& Objects.equals(recordIdentifierFeatureName(), other.recordIdentifierFeatureName())
&& Objects.equals(eventTimeFeatureName(), other.eventTimeFeatureName())
&& hasFeatureDefinitions() == other.hasFeatureDefinitions()
&& Objects.equals(featureDefinitions(), other.featureDefinitions())
&& Objects.equals(creationTime(), other.creationTime())
&& Objects.equals(onlineStoreConfig(), other.onlineStoreConfig())
&& Objects.equals(offlineStoreConfig(), other.offlineStoreConfig()) && Objects.equals(roleArn(), other.roleArn())
&& Objects.equals(featureGroupStatusAsString(), other.featureGroupStatusAsString())
&& Objects.equals(offlineStoreStatus(), other.offlineStoreStatus())
&& Objects.equals(failureReason(), other.failureReason()) && Objects.equals(description(), other.description())
&& Objects.equals(nextToken(), other.nextToken());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("DescribeFeatureGroupResponse").add("FeatureGroupArn", featureGroupArn())
.add("FeatureGroupName", featureGroupName()).add("RecordIdentifierFeatureName", recordIdentifierFeatureName())
.add("EventTimeFeatureName", eventTimeFeatureName())
.add("FeatureDefinitions", hasFeatureDefinitions() ? featureDefinitions() : null)
.add("CreationTime", creationTime()).add("OnlineStoreConfig", onlineStoreConfig())
.add("OfflineStoreConfig", offlineStoreConfig()).add("RoleArn", roleArn())
.add("FeatureGroupStatus", featureGroupStatusAsString()).add("OfflineStoreStatus", offlineStoreStatus())
.add("FailureReason", failureReason()).add("Description", description()).add("NextToken", nextToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "FeatureGroupArn":
return Optional.ofNullable(clazz.cast(featureGroupArn()));
case "FeatureGroupName":
return Optional.ofNullable(clazz.cast(featureGroupName()));
case "RecordIdentifierFeatureName":
return Optional.ofNullable(clazz.cast(recordIdentifierFeatureName()));
case "EventTimeFeatureName":
return Optional.ofNullable(clazz.cast(eventTimeFeatureName()));
case "FeatureDefinitions":
return Optional.ofNullable(clazz.cast(featureDefinitions()));
case "CreationTime":
return Optional.ofNullable(clazz.cast(creationTime()));
case "OnlineStoreConfig":
return Optional.ofNullable(clazz.cast(onlineStoreConfig()));
case "OfflineStoreConfig":
return Optional.ofNullable(clazz.cast(offlineStoreConfig()));
case "RoleArn":
return Optional.ofNullable(clazz.cast(roleArn()));
case "FeatureGroupStatus":
return Optional.ofNullable(clazz.cast(featureGroupStatusAsString()));
case "OfflineStoreStatus":
return Optional.ofNullable(clazz.cast(offlineStoreStatus()));
case "FailureReason":
return Optional.ofNullable(clazz.cast(failureReason()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeFeatureGroupResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SageMakerResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* The Amazon Resource Name (ARN) of the FeatureGroup.
*
*
* @param featureGroupArn
* The Amazon Resource Name (ARN) of the FeatureGroup.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder featureGroupArn(String featureGroupArn);
/**
*
* he name of the FeatureGroup.
*
*
* @param featureGroupName
* he name of the FeatureGroup.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder featureGroupName(String featureGroupName);
/**
*
* The name of the Feature used for RecordIdentifier, whose value uniquely identifies
* a record stored in the feature store.
*
*
* @param recordIdentifierFeatureName
* The name of the Feature used for RecordIdentifier, whose value uniquely
* identifies a record stored in the feature store.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder recordIdentifierFeatureName(String recordIdentifierFeatureName);
/**
*
* The name of the feature that stores the EventTime of a Record in a FeatureGroup.
*
*
* An EventTime is a point in time when a new event occurs that corresponds to the creation or
* update of a Record in a FeatureGroup. All Records in the
* FeatureGroup have a corresponding EventTime.
*
*
* @param eventTimeFeatureName
* The name of the feature that stores the EventTime of a Record in a
* FeatureGroup.
*
* An EventTime is a point in time when a new event occurs that corresponds to the creation
* or update of a Record in a FeatureGroup. All Records in the
* FeatureGroup have a corresponding EventTime.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder eventTimeFeatureName(String eventTimeFeatureName);
/**
*
* A list of the Features in the FeatureGroup. Each feature is defined by a
* FeatureName and FeatureType.
*
*
* @param featureDefinitions
* A list of the Features in the FeatureGroup. Each feature is defined by a
* FeatureName and FeatureType.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder featureDefinitions(Collection featureDefinitions);
/**
*
* A list of the Features in the FeatureGroup. Each feature is defined by a
* FeatureName and FeatureType.
*
*
* @param featureDefinitions
* A list of the Features in the FeatureGroup. Each feature is defined by a
* FeatureName and FeatureType.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder featureDefinitions(FeatureDefinition... featureDefinitions);
/**
*
* A list of the Features in the FeatureGroup. Each feature is defined by a
* FeatureName and FeatureType.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the
* need to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately
* and its result is passed to {@link #featureDefinitions(List)}.
*
* @param featureDefinitions
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #featureDefinitions(List)
*/
Builder featureDefinitions(Consumer... featureDefinitions);
/**
*
* A timestamp indicating when SageMaker created the FeatureGroup.
*
*
* @param creationTime
* A timestamp indicating when SageMaker created the FeatureGroup.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder creationTime(Instant creationTime);
/**
*
* The configuration for the OnlineStore.
*
*
* @param onlineStoreConfig
* The configuration for the OnlineStore.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder onlineStoreConfig(OnlineStoreConfig onlineStoreConfig);
/**
*
* The configuration for the OnlineStore.
*
* This is a convenience that creates an instance of the {@link OnlineStoreConfig.Builder} avoiding the need to
* create one manually via {@link OnlineStoreConfig#builder()}.
*
* When the {@link Consumer} completes, {@link OnlineStoreConfig.Builder#build()} is called immediately and its
* result is passed to {@link #onlineStoreConfig(OnlineStoreConfig)}.
*
* @param onlineStoreConfig
* a consumer that will call methods on {@link OnlineStoreConfig.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #onlineStoreConfig(OnlineStoreConfig)
*/
default Builder onlineStoreConfig(Consumer onlineStoreConfig) {
return onlineStoreConfig(OnlineStoreConfig.builder().applyMutation(onlineStoreConfig).build());
}
/**
*
* The configuration of the OfflineStore, inducing the S3 location of the OfflineStore
* , AWS Glue or AWS Hive data catalogue configurations, and the security configuration.
*
*
* @param offlineStoreConfig
* The configuration of the OfflineStore, inducing the S3 location of the
* OfflineStore, AWS Glue or AWS Hive data catalogue configurations, and the security
* configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder offlineStoreConfig(OfflineStoreConfig offlineStoreConfig);
/**
*
* The configuration of the OfflineStore, inducing the S3 location of the OfflineStore
* , AWS Glue or AWS Hive data catalogue configurations, and the security configuration.
*
* This is a convenience that creates an instance of the {@link OfflineStoreConfig.Builder} avoiding the need to
* create one manually via {@link OfflineStoreConfig#builder()}.
*
* When the {@link Consumer} completes, {@link OfflineStoreConfig.Builder#build()} is called immediately and its
* result is passed to {@link #offlineStoreConfig(OfflineStoreConfig)}.
*
* @param offlineStoreConfig
* a consumer that will call methods on {@link OfflineStoreConfig.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #offlineStoreConfig(OfflineStoreConfig)
*/
default Builder offlineStoreConfig(Consumer offlineStoreConfig) {
return offlineStoreConfig(OfflineStoreConfig.builder().applyMutation(offlineStoreConfig).build());
}
/**
*
* The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the
* OfflineStore if an OfflineStoreConfig is provided.
*
*
* @param roleArn
* The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the
* OfflineStore if an OfflineStoreConfig is provided.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder roleArn(String roleArn);
/**
*
* The status of the feature group.
*
*
* @param featureGroupStatus
* The status of the feature group.
* @see FeatureGroupStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see FeatureGroupStatus
*/
Builder featureGroupStatus(String featureGroupStatus);
/**
*
* The status of the feature group.
*
*
* @param featureGroupStatus
* The status of the feature group.
* @see FeatureGroupStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see FeatureGroupStatus
*/
Builder featureGroupStatus(FeatureGroupStatus featureGroupStatus);
/**
*
* The status of the OfflineStore. Notifies you if replicating data into the
* OfflineStore has failed. Returns either: Active or Blocked
*
*
* @param offlineStoreStatus
* The status of the OfflineStore. Notifies you if replicating data into the
* OfflineStore has failed. Returns either: Active or Blocked
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder offlineStoreStatus(OfflineStoreStatus offlineStoreStatus);
/**
*
* The status of the OfflineStore. Notifies you if replicating data into the
* OfflineStore has failed. Returns either: Active or Blocked
*
* This is a convenience that creates an instance of the {@link OfflineStoreStatus.Builder} avoiding the need to
* create one manually via {@link OfflineStoreStatus#builder()}.
*
* When the {@link Consumer} completes, {@link OfflineStoreStatus.Builder#build()} is called immediately and its
* result is passed to {@link #offlineStoreStatus(OfflineStoreStatus)}.
*
* @param offlineStoreStatus
* a consumer that will call methods on {@link OfflineStoreStatus.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #offlineStoreStatus(OfflineStoreStatus)
*/
default Builder offlineStoreStatus(Consumer offlineStoreStatus) {
return offlineStoreStatus(OfflineStoreStatus.builder().applyMutation(offlineStoreStatus).build());
}
/**
*
* The reason that the FeatureGroup failed to be replicated in the OfflineStore. This
* is failure can occur because:
*
*
* -
*
* The FeatureGroup could not be created in the OfflineStore.
*
*
* -
*
* The FeatureGroup could not be deleted from the OfflineStore.
*
*
*
*
* @param failureReason
* The reason that the FeatureGroup failed to be replicated in the OfflineStore
* . This is failure can occur because:
*
* -
*
* The FeatureGroup could not be created in the OfflineStore.
*
*
* -
*
* The FeatureGroup could not be deleted from the OfflineStore.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder failureReason(String failureReason);
/**
*
* A free form description of the feature group.
*
*
* @param description
* A free form description of the feature group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* A token to resume pagination of the list of Features (FeatureDefinitions).
*
*
* @param nextToken
* A token to resume pagination of the list of Features (FeatureDefinitions).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
}
static final class BuilderImpl extends SageMakerResponse.BuilderImpl implements Builder {
private String featureGroupArn;
private String featureGroupName;
private String recordIdentifierFeatureName;
private String eventTimeFeatureName;
private List featureDefinitions = DefaultSdkAutoConstructList.getInstance();
private Instant creationTime;
private OnlineStoreConfig onlineStoreConfig;
private OfflineStoreConfig offlineStoreConfig;
private String roleArn;
private String featureGroupStatus;
private OfflineStoreStatus offlineStoreStatus;
private String failureReason;
private String description;
private String nextToken;
private BuilderImpl() {
}
private BuilderImpl(DescribeFeatureGroupResponse model) {
super(model);
featureGroupArn(model.featureGroupArn);
featureGroupName(model.featureGroupName);
recordIdentifierFeatureName(model.recordIdentifierFeatureName);
eventTimeFeatureName(model.eventTimeFeatureName);
featureDefinitions(model.featureDefinitions);
creationTime(model.creationTime);
onlineStoreConfig(model.onlineStoreConfig);
offlineStoreConfig(model.offlineStoreConfig);
roleArn(model.roleArn);
featureGroupStatus(model.featureGroupStatus);
offlineStoreStatus(model.offlineStoreStatus);
failureReason(model.failureReason);
description(model.description);
nextToken(model.nextToken);
}
public final String getFeatureGroupArn() {
return featureGroupArn;
}
@Override
public final Builder featureGroupArn(String featureGroupArn) {
this.featureGroupArn = featureGroupArn;
return this;
}
public final void setFeatureGroupArn(String featureGroupArn) {
this.featureGroupArn = featureGroupArn;
}
public final String getFeatureGroupName() {
return featureGroupName;
}
@Override
public final Builder featureGroupName(String featureGroupName) {
this.featureGroupName = featureGroupName;
return this;
}
public final void setFeatureGroupName(String featureGroupName) {
this.featureGroupName = featureGroupName;
}
public final String getRecordIdentifierFeatureName() {
return recordIdentifierFeatureName;
}
@Override
public final Builder recordIdentifierFeatureName(String recordIdentifierFeatureName) {
this.recordIdentifierFeatureName = recordIdentifierFeatureName;
return this;
}
public final void setRecordIdentifierFeatureName(String recordIdentifierFeatureName) {
this.recordIdentifierFeatureName = recordIdentifierFeatureName;
}
public final String getEventTimeFeatureName() {
return eventTimeFeatureName;
}
@Override
public final Builder eventTimeFeatureName(String eventTimeFeatureName) {
this.eventTimeFeatureName = eventTimeFeatureName;
return this;
}
public final void setEventTimeFeatureName(String eventTimeFeatureName) {
this.eventTimeFeatureName = eventTimeFeatureName;
}
public final List getFeatureDefinitions() {
List result = FeatureDefinitionsCopier.copyToBuilder(this.featureDefinitions);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
@Override
public final Builder featureDefinitions(Collection featureDefinitions) {
this.featureDefinitions = FeatureDefinitionsCopier.copy(featureDefinitions);
return this;
}
@Override
@SafeVarargs
public final Builder featureDefinitions(FeatureDefinition... featureDefinitions) {
featureDefinitions(Arrays.asList(featureDefinitions));
return this;
}
@Override
@SafeVarargs
public final Builder featureDefinitions(Consumer... featureDefinitions) {
featureDefinitions(Stream.of(featureDefinitions).map(c -> FeatureDefinition.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final void setFeatureDefinitions(Collection featureDefinitions) {
this.featureDefinitions = FeatureDefinitionsCopier.copyFromBuilder(featureDefinitions);
}
public final Instant getCreationTime() {
return creationTime;
}
@Override
public final Builder creationTime(Instant creationTime) {
this.creationTime = creationTime;
return this;
}
public final void setCreationTime(Instant creationTime) {
this.creationTime = creationTime;
}
public final OnlineStoreConfig.Builder getOnlineStoreConfig() {
return onlineStoreConfig != null ? onlineStoreConfig.toBuilder() : null;
}
@Override
public final Builder onlineStoreConfig(OnlineStoreConfig onlineStoreConfig) {
this.onlineStoreConfig = onlineStoreConfig;
return this;
}
public final void setOnlineStoreConfig(OnlineStoreConfig.BuilderImpl onlineStoreConfig) {
this.onlineStoreConfig = onlineStoreConfig != null ? onlineStoreConfig.build() : null;
}
public final OfflineStoreConfig.Builder getOfflineStoreConfig() {
return offlineStoreConfig != null ? offlineStoreConfig.toBuilder() : null;
}
@Override
public final Builder offlineStoreConfig(OfflineStoreConfig offlineStoreConfig) {
this.offlineStoreConfig = offlineStoreConfig;
return this;
}
public final void setOfflineStoreConfig(OfflineStoreConfig.BuilderImpl offlineStoreConfig) {
this.offlineStoreConfig = offlineStoreConfig != null ? offlineStoreConfig.build() : null;
}
public final String getRoleArn() {
return roleArn;
}
@Override
public final Builder roleArn(String roleArn) {
this.roleArn = roleArn;
return this;
}
public final void setRoleArn(String roleArn) {
this.roleArn = roleArn;
}
public final String getFeatureGroupStatus() {
return featureGroupStatus;
}
@Override
public final Builder featureGroupStatus(String featureGroupStatus) {
this.featureGroupStatus = featureGroupStatus;
return this;
}
@Override
public final Builder featureGroupStatus(FeatureGroupStatus featureGroupStatus) {
this.featureGroupStatus(featureGroupStatus == null ? null : featureGroupStatus.toString());
return this;
}
public final void setFeatureGroupStatus(String featureGroupStatus) {
this.featureGroupStatus = featureGroupStatus;
}
public final OfflineStoreStatus.Builder getOfflineStoreStatus() {
return offlineStoreStatus != null ? offlineStoreStatus.toBuilder() : null;
}
@Override
public final Builder offlineStoreStatus(OfflineStoreStatus offlineStoreStatus) {
this.offlineStoreStatus = offlineStoreStatus;
return this;
}
public final void setOfflineStoreStatus(OfflineStoreStatus.BuilderImpl offlineStoreStatus) {
this.offlineStoreStatus = offlineStoreStatus != null ? offlineStoreStatus.build() : null;
}
public final String getFailureReason() {
return failureReason;
}
@Override
public final Builder failureReason(String failureReason) {
this.failureReason = failureReason;
return this;
}
public final void setFailureReason(String failureReason) {
this.failureReason = failureReason;
}
public final String getDescription() {
return description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
public final void setDescription(String description) {
this.description = description;
}
public final String getNextToken() {
return nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public DescribeFeatureGroupResponse build() {
return new DescribeFeatureGroupResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy