com.amazonaws.services.robomaker.model.RobotApplicationConfig Maven / Gradle / Ivy
Show all versions of aws-java-sdk-robomaker Show documentation
/*
* Copyright 2019-2024 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 com.amazonaws.services.robomaker.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Application configuration information for a robot.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class RobotApplicationConfig implements Serializable, Cloneable, StructuredPojo {
/**
*
* The application information for the robot application.
*
*/
private String application;
/**
*
* The version of the robot application.
*
*/
private String applicationVersion;
/**
*
* The launch configuration for the robot application.
*
*/
private LaunchConfig launchConfig;
/**
*
* The upload configurations for the robot application.
*
*/
private java.util.List uploadConfigurations;
/**
*
* 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.
*
*
*
* This API is no longer supported and will throw an error if used.
*
*
*/
@Deprecated
private Boolean useDefaultUploadConfigurations;
/**
*
* Information about tools configured for the robot application.
*
*/
private java.util.List tools;
/**
*
* A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal
* and rosbag record. The default is False.
*
*
*
* This API is no longer supported and will throw an error if used.
*
*
*/
@Deprecated
private Boolean useDefaultTools;
/**
*
* The application information for the robot application.
*
*
* @param application
* The application information for the robot application.
*/
public void setApplication(String application) {
this.application = application;
}
/**
*
* The application information for the robot application.
*
*
* @return The application information for the robot application.
*/
public String getApplication() {
return this.application;
}
/**
*
* The application information for the robot application.
*
*
* @param application
* The application information for the robot application.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RobotApplicationConfig withApplication(String application) {
setApplication(application);
return this;
}
/**
*
* The version of the robot application.
*
*
* @param applicationVersion
* The version of the robot application.
*/
public void setApplicationVersion(String applicationVersion) {
this.applicationVersion = applicationVersion;
}
/**
*
* The version of the robot application.
*
*
* @return The version of the robot application.
*/
public String getApplicationVersion() {
return this.applicationVersion;
}
/**
*
* The version of the robot application.
*
*
* @param applicationVersion
* The version of the robot application.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RobotApplicationConfig withApplicationVersion(String applicationVersion) {
setApplicationVersion(applicationVersion);
return this;
}
/**
*
* The launch configuration for the robot application.
*
*
* @param launchConfig
* The launch configuration for the robot application.
*/
public void setLaunchConfig(LaunchConfig launchConfig) {
this.launchConfig = launchConfig;
}
/**
*
* The launch configuration for the robot application.
*
*
* @return The launch configuration for the robot application.
*/
public LaunchConfig getLaunchConfig() {
return this.launchConfig;
}
/**
*
* The launch configuration for the robot application.
*
*
* @param launchConfig
* The launch configuration for the robot application.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RobotApplicationConfig withLaunchConfig(LaunchConfig launchConfig) {
setLaunchConfig(launchConfig);
return this;
}
/**
*
* The upload configurations for the robot application.
*
*
* @return The upload configurations for the robot application.
*/
public java.util.List getUploadConfigurations() {
return uploadConfigurations;
}
/**
*
* The upload configurations for the robot application.
*
*
* @param uploadConfigurations
* The upload configurations for the robot application.
*/
public void setUploadConfigurations(java.util.Collection uploadConfigurations) {
if (uploadConfigurations == null) {
this.uploadConfigurations = null;
return;
}
this.uploadConfigurations = new java.util.ArrayList(uploadConfigurations);
}
/**
*
* The upload configurations for the robot application.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setUploadConfigurations(java.util.Collection)} or {@link #withUploadConfigurations(java.util.Collection)}
* if you want to override the existing values.
*
*
* @param uploadConfigurations
* The upload configurations for the robot application.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RobotApplicationConfig withUploadConfigurations(UploadConfiguration... uploadConfigurations) {
if (this.uploadConfigurations == null) {
setUploadConfigurations(new java.util.ArrayList(uploadConfigurations.length));
}
for (UploadConfiguration ele : uploadConfigurations) {
this.uploadConfigurations.add(ele);
}
return this;
}
/**
*
* The upload configurations for the robot application.
*
*
* @param uploadConfigurations
* The upload configurations for the robot application.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RobotApplicationConfig withUploadConfigurations(java.util.Collection uploadConfigurations) {
setUploadConfigurations(uploadConfigurations);
return this;
}
/**
*
* 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.
*
*
*
* This API is no longer supported and will throw an error if used.
*
*
*
* @param 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.
*
*
*
* This API is no longer supported and will throw an error if used.
*
*/
@Deprecated
public void setUseDefaultUploadConfigurations(Boolean useDefaultUploadConfigurations) {
this.useDefaultUploadConfigurations = 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.
*
*
*
* This API is no longer supported and will throw an error if used.
*
*
*
* @return 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.
*
*
*
* This API is no longer supported and will throw an error if used.
*
*/
@Deprecated
public Boolean getUseDefaultUploadConfigurations() {
return this.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.
*
*
*
* This API is no longer supported and will throw an error if used.
*
*
*
* @param 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.
*
*
*
* This API is no longer supported and will throw an error if used.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
@Deprecated
public RobotApplicationConfig withUseDefaultUploadConfigurations(Boolean useDefaultUploadConfigurations) {
setUseDefaultUploadConfigurations(useDefaultUploadConfigurations);
return this;
}
/**
*
* 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.
*
*
*
* This API is no longer supported and will throw an error if used.
*
*
*
* @return 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.
*
*
*
* This API is no longer supported and will throw an error if used.
*
*/
@Deprecated
public Boolean isUseDefaultUploadConfigurations() {
return this.useDefaultUploadConfigurations;
}
/**
*
* Information about tools configured for the robot application.
*
*
* @return Information about tools configured for the robot application.
*/
public java.util.List getTools() {
return tools;
}
/**
*
* Information about tools configured for the robot application.
*
*
* @param tools
* Information about tools configured for the robot application.
*/
public void setTools(java.util.Collection tools) {
if (tools == null) {
this.tools = null;
return;
}
this.tools = new java.util.ArrayList(tools);
}
/**
*
* Information about tools configured for the robot application.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTools(java.util.Collection)} or {@link #withTools(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tools
* Information about tools configured for the robot application.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RobotApplicationConfig withTools(Tool... tools) {
if (this.tools == null) {
setTools(new java.util.ArrayList(tools.length));
}
for (Tool ele : tools) {
this.tools.add(ele);
}
return this;
}
/**
*
* Information about tools configured for the robot application.
*
*
* @param tools
* Information about tools configured for the robot application.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RobotApplicationConfig withTools(java.util.Collection tools) {
setTools(tools);
return this;
}
/**
*
* A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal
* and rosbag record. The default is False.
*
*
*
* This API is no longer supported and will throw an error if used.
*
*
*
* @param 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.
*
* This API is no longer supported and will throw an error if used.
*
*/
@Deprecated
public void setUseDefaultTools(Boolean useDefaultTools) {
this.useDefaultTools = 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.
*
*
*
* This API is no longer supported and will throw an error if used.
*
*
*
* @return A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt,
* terminal and rosbag record. The default is False.
*
* This API is no longer supported and will throw an error if used.
*
*/
@Deprecated
public Boolean getUseDefaultTools() {
return this.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.
*
*
*
* This API is no longer supported and will throw an error if used.
*
*
*
* @param 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.
*
* This API is no longer supported and will throw an error if used.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
@Deprecated
public RobotApplicationConfig withUseDefaultTools(Boolean useDefaultTools) {
setUseDefaultTools(useDefaultTools);
return this;
}
/**
*
* A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal
* and rosbag record. The default is False.
*
*
*
* This API is no longer supported and will throw an error if used.
*
*
*
* @return A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt,
* terminal and rosbag record. The default is False.
*
* This API is no longer supported and will throw an error if used.
*
*/
@Deprecated
public Boolean isUseDefaultTools() {
return this.useDefaultTools;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getApplication() != null)
sb.append("Application: ").append(getApplication()).append(",");
if (getApplicationVersion() != null)
sb.append("ApplicationVersion: ").append(getApplicationVersion()).append(",");
if (getLaunchConfig() != null)
sb.append("LaunchConfig: ").append(getLaunchConfig()).append(",");
if (getUploadConfigurations() != null)
sb.append("UploadConfigurations: ").append(getUploadConfigurations()).append(",");
if (getUseDefaultUploadConfigurations() != null)
sb.append("UseDefaultUploadConfigurations: ").append(getUseDefaultUploadConfigurations()).append(",");
if (getTools() != null)
sb.append("Tools: ").append(getTools()).append(",");
if (getUseDefaultTools() != null)
sb.append("UseDefaultTools: ").append(getUseDefaultTools());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof RobotApplicationConfig == false)
return false;
RobotApplicationConfig other = (RobotApplicationConfig) obj;
if (other.getApplication() == null ^ this.getApplication() == null)
return false;
if (other.getApplication() != null && other.getApplication().equals(this.getApplication()) == false)
return false;
if (other.getApplicationVersion() == null ^ this.getApplicationVersion() == null)
return false;
if (other.getApplicationVersion() != null && other.getApplicationVersion().equals(this.getApplicationVersion()) == false)
return false;
if (other.getLaunchConfig() == null ^ this.getLaunchConfig() == null)
return false;
if (other.getLaunchConfig() != null && other.getLaunchConfig().equals(this.getLaunchConfig()) == false)
return false;
if (other.getUploadConfigurations() == null ^ this.getUploadConfigurations() == null)
return false;
if (other.getUploadConfigurations() != null && other.getUploadConfigurations().equals(this.getUploadConfigurations()) == false)
return false;
if (other.getUseDefaultUploadConfigurations() == null ^ this.getUseDefaultUploadConfigurations() == null)
return false;
if (other.getUseDefaultUploadConfigurations() != null
&& other.getUseDefaultUploadConfigurations().equals(this.getUseDefaultUploadConfigurations()) == false)
return false;
if (other.getTools() == null ^ this.getTools() == null)
return false;
if (other.getTools() != null && other.getTools().equals(this.getTools()) == false)
return false;
if (other.getUseDefaultTools() == null ^ this.getUseDefaultTools() == null)
return false;
if (other.getUseDefaultTools() != null && other.getUseDefaultTools().equals(this.getUseDefaultTools()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getApplication() == null) ? 0 : getApplication().hashCode());
hashCode = prime * hashCode + ((getApplicationVersion() == null) ? 0 : getApplicationVersion().hashCode());
hashCode = prime * hashCode + ((getLaunchConfig() == null) ? 0 : getLaunchConfig().hashCode());
hashCode = prime * hashCode + ((getUploadConfigurations() == null) ? 0 : getUploadConfigurations().hashCode());
hashCode = prime * hashCode + ((getUseDefaultUploadConfigurations() == null) ? 0 : getUseDefaultUploadConfigurations().hashCode());
hashCode = prime * hashCode + ((getTools() == null) ? 0 : getTools().hashCode());
hashCode = prime * hashCode + ((getUseDefaultTools() == null) ? 0 : getUseDefaultTools().hashCode());
return hashCode;
}
@Override
public RobotApplicationConfig clone() {
try {
return (RobotApplicationConfig) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.robomaker.model.transform.RobotApplicationConfigMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}