Package software.amazon.awssdk.services.sagemakeredge.model

Class SendHeartbeatRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sagemakeredge.model.SagemakerEdgeRequest

software.amazon.awssdk.services.sagemakeredge.model.SendHeartbeatRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SendHeartbeatRequest.Builder,SendHeartbeatRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SendHeartbeatRequest.Builder

Method Summary

Modifier and Type	Method	Description
List<EdgeMetric>	agentMetrics()	For internal use.
String	agentVersion()	Returns the version of the agent.
static SendHeartbeatRequest.Builder	builder()
DeploymentResult	deploymentResult()	Returns the result of a deployment on the device.
String	deviceFleetName()	The name of the fleet that the device belongs to.
String	deviceName()	The unique name of the device.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAgentMetrics()	For responses, this returns true if the service returned a value for the AgentMetrics property.
int	hashCode()
boolean	hasModels()	For responses, this returns true if the service returned a value for the Models property.
List<Model>	models()	Returns a list of models deployed on the the device.
List<SdkField<?>>	sdkFields()
static Class<? extends SendHeartbeatRequest.Builder>	serializableBuilderClass()
SendHeartbeatRequest.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

hasAgentMetrics

public final boolean hasAgentMetrics()

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

agentMetrics

public final List<EdgeMetric> agentMetrics()

For internal use. Returns a list of SageMaker Edge Manager agent operating metrics.

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

Returns:

For internal use. Returns a list of SageMaker Edge Manager agent operating metrics.

hasModels

public final boolean hasModels()

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

models

public final List<Model> models()

Returns a list of models deployed on the the device.

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

Returns:

Returns a list of models deployed on the the device.

agentVersion

public final String agentVersion()

Returns the version of the agent.

Returns:

Returns the version of the agent.

deviceName

public final String deviceName()

The unique name of the device.

Returns:

The unique name of the device.

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.

deploymentResult

public final DeploymentResult deploymentResult()

Returns the result of a deployment on the device.

Returns:

Returns the result of a deployment on the device.

toBuilder

public SendHeartbeatRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SendHeartbeatRequest.Builder,SendHeartbeatRequest>

Specified by:

toBuilder in class SagemakerEdgeRequest

builder

public static SendHeartbeatRequest.Builder builder()

serializableBuilderClass

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