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

Class CreateDeviceFleetRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDeviceFleetRequest.Builder,CreateDeviceFleetRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateDeviceFleetRequest
extends SageMakerRequest
implements ToCopyableBuilder<CreateDeviceFleetRequest.Builder,CreateDeviceFleetRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateDeviceFleetRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateDeviceFleetRequest.Builder	builder()
String	description()	A description of the fleet.
String	deviceFleetName()	The name of the fleet that the device belongs to.
Boolean	enableIotRoleAlias()	Whether to create an Amazon Web Services IoT Role Alias during device fleet creation.
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.
EdgeOutputConfig	outputConfig()	The output configuration for storing sample data collected by the fleet.
String	roleArn()	The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDeviceFleetRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	Creates tags for the specified fleet.
CreateDeviceFleetRequest.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

deviceFleetName

public final String deviceFleetName()

The name of the fleet that the device belongs to.

Returns:

The name of the fleet that the device belongs to.

roleArn

public final String roleArn()

The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).

Returns:

The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).

description

public final String description()

A description of the fleet.

Returns:

A description of the fleet.

outputConfig

public final EdgeOutputConfig outputConfig()

The output configuration for storing sample data collected by the fleet.

Returns:

The output configuration for storing sample data collected by the fleet.

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()

Creates tags for the specified fleet.

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:

Creates tags for the specified fleet.

enableIotRoleAlias

public final Boolean enableIotRoleAlias()

Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of the role alias generated will match this pattern: "SageMakerEdge-{DeviceFleetName}".

For example, if your device fleet is called "demo-fleet", the name of the role alias will be "SageMakerEdge-demo-fleet".

Returns:

Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of the role alias generated will match this pattern: "SageMakerEdge-{DeviceFleetName}".

For example, if your device fleet is called "demo-fleet", the name of the role alias will be "SageMakerEdge-demo-fleet".

toBuilder

public CreateDeviceFleetRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDeviceFleetRequest.Builder,CreateDeviceFleetRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static CreateDeviceFleetRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

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