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>

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SendHeartbeatRequest.Builder,SendHeartbeatRequest>
      Specified by:
      toBuilder in class SagemakerEdgeRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.