software.amazon.awssdk.services.sagemakeredge.model.SendHeartbeatRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sagemakeredge Show documentation
Show all versions of sagemakeredge Show documentation
The AWS Java SDK for Sagemaker Edge module holds the client classes that are used for
communicating with Sagemaker Edge.
/*
* 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.sagemakeredge.model;
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.awscore.AwsRequestOverrideConfiguration;
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 SendHeartbeatRequest extends SagemakerEdgeRequest implements
ToCopyableBuilder {
private static final SdkField> AGENT_METRICS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("AgentMetrics")
.getter(getter(SendHeartbeatRequest::agentMetrics))
.setter(setter(Builder::agentMetrics))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AgentMetrics").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(EdgeMetric::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> MODELS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Models")
.getter(getter(SendHeartbeatRequest::models))
.setter(setter(Builder::models))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Models").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Model::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField AGENT_VERSION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AgentVersion").getter(getter(SendHeartbeatRequest::agentVersion)).setter(setter(Builder::agentVersion))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AgentVersion").build()).build();
private static final SdkField DEVICE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DeviceName").getter(getter(SendHeartbeatRequest::deviceName)).setter(setter(Builder::deviceName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DeviceName").build()).build();
private static final SdkField DEVICE_FLEET_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DeviceFleetName").getter(getter(SendHeartbeatRequest::deviceFleetName))
.setter(setter(Builder::deviceFleetName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DeviceFleetName").build()).build();
private static final SdkField DEPLOYMENT_RESULT_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("DeploymentResult")
.getter(getter(SendHeartbeatRequest::deploymentResult)).setter(setter(Builder::deploymentResult))
.constructor(DeploymentResult::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DeploymentResult").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(AGENT_METRICS_FIELD,
MODELS_FIELD, AGENT_VERSION_FIELD, DEVICE_NAME_FIELD, DEVICE_FLEET_NAME_FIELD, DEPLOYMENT_RESULT_FIELD));
private final List agentMetrics;
private final List models;
private final String agentVersion;
private final String deviceName;
private final String deviceFleetName;
private final DeploymentResult deploymentResult;
private SendHeartbeatRequest(BuilderImpl builder) {
super(builder);
this.agentMetrics = builder.agentMetrics;
this.models = builder.models;
this.agentVersion = builder.agentVersion;
this.deviceName = builder.deviceName;
this.deviceFleetName = builder.deviceFleetName;
this.deploymentResult = builder.deploymentResult;
}
/**
* 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 {@code 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.
*/
public final boolean hasAgentMetrics() {
return agentMetrics != null && !(agentMetrics instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasAgentMetrics} method.
*
*
* @return For internal use. Returns a list of SageMaker Edge Manager agent operating metrics.
*/
public final List agentMetrics() {
return agentMetrics;
}
/**
* 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 {@code 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.
*/
public final boolean hasModels() {
return models != null && !(models instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasModels} method.
*
*
* @return Returns a list of models deployed on the the device.
*/
public final List models() {
return models;
}
/**
*
* Returns the version of the agent.
*
*
* @return Returns the version of the agent.
*/
public final String agentVersion() {
return agentVersion;
}
/**
*
* The unique name of the device.
*
*
* @return The unique name of the device.
*/
public final String deviceName() {
return deviceName;
}
/**
*
* The name of the fleet that the device belongs to.
*
*
* @return The name of the fleet that the device belongs to.
*/
public final String deviceFleetName() {
return deviceFleetName;
}
/**
*
* Returns the result of a deployment on the device.
*
*
* @return Returns the result of a deployment on the device.
*/
public final DeploymentResult deploymentResult() {
return deploymentResult;
}
@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(hasAgentMetrics() ? agentMetrics() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasModels() ? models() : null);
hashCode = 31 * hashCode + Objects.hashCode(agentVersion());
hashCode = 31 * hashCode + Objects.hashCode(deviceName());
hashCode = 31 * hashCode + Objects.hashCode(deviceFleetName());
hashCode = 31 * hashCode + Objects.hashCode(deploymentResult());
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 SendHeartbeatRequest)) {
return false;
}
SendHeartbeatRequest other = (SendHeartbeatRequest) obj;
return hasAgentMetrics() == other.hasAgentMetrics() && Objects.equals(agentMetrics(), other.agentMetrics())
&& hasModels() == other.hasModels() && Objects.equals(models(), other.models())
&& Objects.equals(agentVersion(), other.agentVersion()) && Objects.equals(deviceName(), other.deviceName())
&& Objects.equals(deviceFleetName(), other.deviceFleetName())
&& Objects.equals(deploymentResult(), other.deploymentResult());
}
/**
* 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("SendHeartbeatRequest").add("AgentMetrics", hasAgentMetrics() ? agentMetrics() : null)
.add("Models", hasModels() ? models() : null).add("AgentVersion", agentVersion()).add("DeviceName", deviceName())
.add("DeviceFleetName", deviceFleetName()).add("DeploymentResult", deploymentResult()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AgentMetrics":
return Optional.ofNullable(clazz.cast(agentMetrics()));
case "Models":
return Optional.ofNullable(clazz.cast(models()));
case "AgentVersion":
return Optional.ofNullable(clazz.cast(agentVersion()));
case "DeviceName":
return Optional.ofNullable(clazz.cast(deviceName()));
case "DeviceFleetName":
return Optional.ofNullable(clazz.cast(deviceFleetName()));
case "DeploymentResult":
return Optional.ofNullable(clazz.cast(deploymentResult()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SendHeartbeatRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SagemakerEdgeRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* For internal use. Returns a list of SageMaker Edge Manager agent operating metrics.
*
*
* @param agentMetrics
* For internal use. Returns a list of SageMaker Edge Manager agent operating metrics.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder agentMetrics(Collection agentMetrics);
/**
*
* For internal use. Returns a list of SageMaker Edge Manager agent operating metrics.
*
*
* @param agentMetrics
* For internal use. Returns a list of SageMaker Edge Manager agent operating metrics.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder agentMetrics(EdgeMetric... agentMetrics);
/**
*
* For internal use. Returns a list of SageMaker Edge Manager agent operating metrics.
*
* This is a convenience method 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 #agentMetrics(List)}.
*
* @param agentMetrics
* 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 #agentMetrics(List)
*/
Builder agentMetrics(Consumer... agentMetrics);
/**
*
* Returns a list of models deployed on the the device.
*
*
* @param models
* Returns a list of models deployed on the the device.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder models(Collection models);
/**
*
* Returns a list of models deployed on the the device.
*
*
* @param models
* Returns a list of models deployed on the the device.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder models(Model... models);
/**
*
* Returns a list of models deployed on the the device.
*
* This is a convenience method 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 #models(List)}.
*
* @param models
* 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 #models(List)
*/
Builder models(Consumer... models);
/**
*
* Returns the version of the agent.
*
*
* @param agentVersion
* Returns the version of the agent.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder agentVersion(String agentVersion);
/**
*
* The unique name of the device.
*
*
* @param deviceName
* The unique name of the device.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder deviceName(String deviceName);
/**
*
* The name of the fleet that the device belongs to.
*
*
* @param deviceFleetName
* The name of the fleet that the device belongs to.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder deviceFleetName(String deviceFleetName);
/**
*
* Returns the result of a deployment on the device.
*
*
* @param deploymentResult
* Returns the result of a deployment on the device.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder deploymentResult(DeploymentResult deploymentResult);
/**
*
* Returns the result of a deployment on the device.
*
* This is a convenience method that creates an instance of the {@link DeploymentResult.Builder} avoiding the
* need to create one manually via {@link DeploymentResult#builder()}.
*
* When the {@link Consumer} completes, {@link DeploymentResult.Builder#build()} is called immediately and its
* result is passed to {@link #deploymentResult(DeploymentResult)}.
*
* @param deploymentResult
* a consumer that will call methods on {@link DeploymentResult.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #deploymentResult(DeploymentResult)
*/
default Builder deploymentResult(Consumer deploymentResult) {
return deploymentResult(DeploymentResult.builder().applyMutation(deploymentResult).build());
}
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends SagemakerEdgeRequest.BuilderImpl implements Builder {
private List agentMetrics = DefaultSdkAutoConstructList.getInstance();
private List models = DefaultSdkAutoConstructList.getInstance();
private String agentVersion;
private String deviceName;
private String deviceFleetName;
private DeploymentResult deploymentResult;
private BuilderImpl() {
}
private BuilderImpl(SendHeartbeatRequest model) {
super(model);
agentMetrics(model.agentMetrics);
models(model.models);
agentVersion(model.agentVersion);
deviceName(model.deviceName);
deviceFleetName(model.deviceFleetName);
deploymentResult(model.deploymentResult);
}
public final List getAgentMetrics() {
List result = EdgeMetricsCopier.copyToBuilder(this.agentMetrics);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setAgentMetrics(Collection agentMetrics) {
this.agentMetrics = EdgeMetricsCopier.copyFromBuilder(agentMetrics);
}
@Override
public final Builder agentMetrics(Collection agentMetrics) {
this.agentMetrics = EdgeMetricsCopier.copy(agentMetrics);
return this;
}
@Override
@SafeVarargs
public final Builder agentMetrics(EdgeMetric... agentMetrics) {
agentMetrics(Arrays.asList(agentMetrics));
return this;
}
@Override
@SafeVarargs
public final Builder agentMetrics(Consumer... agentMetrics) {
agentMetrics(Stream.of(agentMetrics).map(c -> EdgeMetric.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final List getModels() {
List result = ModelsCopier.copyToBuilder(this.models);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setModels(Collection models) {
this.models = ModelsCopier.copyFromBuilder(models);
}
@Override
public final Builder models(Collection models) {
this.models = ModelsCopier.copy(models);
return this;
}
@Override
@SafeVarargs
public final Builder models(Model... models) {
models(Arrays.asList(models));
return this;
}
@Override
@SafeVarargs
public final Builder models(Consumer... models) {
models(Stream.of(models).map(c -> Model.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final String getAgentVersion() {
return agentVersion;
}
public final void setAgentVersion(String agentVersion) {
this.agentVersion = agentVersion;
}
@Override
public final Builder agentVersion(String agentVersion) {
this.agentVersion = agentVersion;
return this;
}
public final String getDeviceName() {
return deviceName;
}
public final void setDeviceName(String deviceName) {
this.deviceName = deviceName;
}
@Override
public final Builder deviceName(String deviceName) {
this.deviceName = deviceName;
return this;
}
public final String getDeviceFleetName() {
return deviceFleetName;
}
public final void setDeviceFleetName(String deviceFleetName) {
this.deviceFleetName = deviceFleetName;
}
@Override
public final Builder deviceFleetName(String deviceFleetName) {
this.deviceFleetName = deviceFleetName;
return this;
}
public final DeploymentResult.Builder getDeploymentResult() {
return deploymentResult != null ? deploymentResult.toBuilder() : null;
}
public final void setDeploymentResult(DeploymentResult.BuilderImpl deploymentResult) {
this.deploymentResult = deploymentResult != null ? deploymentResult.build() : null;
}
@Override
public final Builder deploymentResult(DeploymentResult deploymentResult) {
this.deploymentResult = deploymentResult;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public SendHeartbeatRequest build() {
return new SendHeartbeatRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy