software.amazon.awssdk.services.robomaker.model

Class RobotApplicationConfig

java.lang.Object

software.amazon.awssdk.services.robomaker.model.RobotApplicationConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RobotApplicationConfig.Builder,RobotApplicationConfig>

@Generated(value="software.amazon.awssdk:codegen")
public final class RobotApplicationConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RobotApplicationConfig.Builder,RobotApplicationConfig>

Application configuration information for a robot.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RobotApplicationConfig.Builder

Method Summary

Modifier and Type	Method and Description
String	application() The application information for the robot application.
String	applicationVersion() The version of the robot application.
static RobotApplicationConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTools() For responses, this returns true if the service returned a value for the Tools property.
boolean	hasUploadConfigurations() For responses, this returns true if the service returned a value for the UploadConfigurations property.
LaunchConfig	launchConfig() The launch configuration for the robot application.
List<SdkField<?>>	sdkFields()
static Class<? extends RobotApplicationConfig.Builder>	serializableBuilderClass()
RobotApplicationConfig.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
List<Tool>	tools() Information about tools configured for the robot application.
String	toString() Returns a string representation of this object.
List<UploadConfiguration>	uploadConfigurations() The upload configurations for the robot application.
Boolean	useDefaultTools() A Boolean indicating whether to use default robot application tools.
Boolean	useDefaultUploadConfigurations() A Boolean indicating whether to use default upload configurations.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

application

public final String application()

The application information for the robot application.

Returns:

The application information for the robot application.

applicationVersion

public final String applicationVersion()

The version of the robot application.

Returns:

The version of the robot application.

launchConfig

public final LaunchConfig launchConfig()

The launch configuration for the robot application.

Returns:

The launch configuration for the robot application.

hasUploadConfigurations

public final boolean hasUploadConfigurations()

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

uploadConfigurations

public final List<UploadConfiguration> uploadConfigurations()

The upload configurations for the robot application.

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

Returns:

The upload configurations for the robot application.

useDefaultUploadConfigurations

public final Boolean useDefaultUploadConfigurations()

A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.

If you set this value, you must specify an outputLocation.

Returns:

A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.

If you set this value, you must specify an outputLocation.

hasTools

public final boolean hasTools()

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

tools

public final List<Tool> tools()

Information about tools configured for the robot application.

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

Returns:

Information about tools configured for the robot application.

useDefaultTools

public final Boolean useDefaultTools()

A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False.

Returns:

A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False.

toBuilder

public RobotApplicationConfig.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<RobotApplicationConfig.Builder,RobotApplicationConfig>

Returns:

a builder for type T

builder

public static RobotApplicationConfig.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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.