com.amazonaws.services.simplesystemsmanagement.model.StartSessionResult Maven / Gradle / Ivy
/*
* 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.simplesystemsmanagement.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class StartSessionResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The ID of the session.
*
*/
private String sessionId;
/**
*
* An encrypted token value containing session and caller information. This token is used to authenticate the
* connection to the managed node, and is valid only long enough to ensure the connection is successful. Never share
* your session's token.
*
*/
private String tokenValue;
/**
*
* A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and receive
* output from the node. Format:
* wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)
*
*
* region represents the Region identifier for an Amazon Web Services Region supported by Amazon Web Services
* Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported
* region values, see the Region column in Systems Manager service endpoints in
* the Amazon Web Services General Reference.
*
*
* session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.
*
*/
private String streamUrl;
/**
*
* The ID of the session.
*
*
* @param sessionId
* The ID of the session.
*/
public void setSessionId(String sessionId) {
this.sessionId = sessionId;
}
/**
*
* The ID of the session.
*
*
* @return The ID of the session.
*/
public String getSessionId() {
return this.sessionId;
}
/**
*
* The ID of the session.
*
*
* @param sessionId
* The ID of the session.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartSessionResult withSessionId(String sessionId) {
setSessionId(sessionId);
return this;
}
/**
*
* An encrypted token value containing session and caller information. This token is used to authenticate the
* connection to the managed node, and is valid only long enough to ensure the connection is successful. Never share
* your session's token.
*
*
* @param tokenValue
* An encrypted token value containing session and caller information. This token is used to authenticate the
* connection to the managed node, and is valid only long enough to ensure the connection is successful.
* Never share your session's token.
*/
public void setTokenValue(String tokenValue) {
this.tokenValue = tokenValue;
}
/**
*
* An encrypted token value containing session and caller information. This token is used to authenticate the
* connection to the managed node, and is valid only long enough to ensure the connection is successful. Never share
* your session's token.
*
*
* @return An encrypted token value containing session and caller information. This token is used to authenticate
* the connection to the managed node, and is valid only long enough to ensure the connection is successful.
* Never share your session's token.
*/
public String getTokenValue() {
return this.tokenValue;
}
/**
*
* An encrypted token value containing session and caller information. This token is used to authenticate the
* connection to the managed node, and is valid only long enough to ensure the connection is successful. Never share
* your session's token.
*
*
* @param tokenValue
* An encrypted token value containing session and caller information. This token is used to authenticate the
* connection to the managed node, and is valid only long enough to ensure the connection is successful.
* Never share your session's token.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartSessionResult withTokenValue(String tokenValue) {
setTokenValue(tokenValue);
return this;
}
/**
*
* A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and receive
* output from the node. Format:
* wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)
*
*
* region represents the Region identifier for an Amazon Web Services Region supported by Amazon Web Services
* Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported
* region values, see the Region column in Systems Manager service endpoints in
* the Amazon Web Services General Reference.
*
*
* session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.
*
*
* @param streamUrl
* A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and
* receive output from the node. Format:
* wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)
*
*
* region represents the Region identifier for an Amazon Web Services Region supported by Amazon Web
* Services Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of
* supported region values, see the Region column in Systems Manager service
* endpoints in the Amazon Web Services General Reference.
*
*
* session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.
*/
public void setStreamUrl(String streamUrl) {
this.streamUrl = streamUrl;
}
/**
*
* A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and receive
* output from the node. Format:
* wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)
*
*
* region represents the Region identifier for an Amazon Web Services Region supported by Amazon Web Services
* Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported
* region values, see the Region column in Systems Manager service endpoints in
* the Amazon Web Services General Reference.
*
*
* session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.
*
*
* @return A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and
* receive output from the node. Format:
* wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)
*
*
* region represents the Region identifier for an Amazon Web Services Region supported by Amazon Web
* Services Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of
* supported region values, see the Region column in Systems Manager service
* endpoints in the Amazon Web Services General Reference.
*
*
* session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.
*/
public String getStreamUrl() {
return this.streamUrl;
}
/**
*
* A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and receive
* output from the node. Format:
* wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)
*
*
* region represents the Region identifier for an Amazon Web Services Region supported by Amazon Web Services
* Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported
* region values, see the Region column in Systems Manager service endpoints in
* the Amazon Web Services General Reference.
*
*
* session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.
*
*
* @param streamUrl
* A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and
* receive output from the node. Format:
* wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)
*
*
* region represents the Region identifier for an Amazon Web Services Region supported by Amazon Web
* Services Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of
* supported region values, see the Region column in Systems Manager service
* endpoints in the Amazon Web Services General Reference.
*
*
* session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartSessionResult withStreamUrl(String streamUrl) {
setStreamUrl(streamUrl);
return this;
}
/**
* 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 (getSessionId() != null)
sb.append("SessionId: ").append(getSessionId()).append(",");
if (getTokenValue() != null)
sb.append("TokenValue: ").append(getTokenValue()).append(",");
if (getStreamUrl() != null)
sb.append("StreamUrl: ").append(getStreamUrl());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof StartSessionResult == false)
return false;
StartSessionResult other = (StartSessionResult) obj;
if (other.getSessionId() == null ^ this.getSessionId() == null)
return false;
if (other.getSessionId() != null && other.getSessionId().equals(this.getSessionId()) == false)
return false;
if (other.getTokenValue() == null ^ this.getTokenValue() == null)
return false;
if (other.getTokenValue() != null && other.getTokenValue().equals(this.getTokenValue()) == false)
return false;
if (other.getStreamUrl() == null ^ this.getStreamUrl() == null)
return false;
if (other.getStreamUrl() != null && other.getStreamUrl().equals(this.getStreamUrl()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSessionId() == null) ? 0 : getSessionId().hashCode());
hashCode = prime * hashCode + ((getTokenValue() == null) ? 0 : getTokenValue().hashCode());
hashCode = prime * hashCode + ((getStreamUrl() == null) ? 0 : getStreamUrl().hashCode());
return hashCode;
}
@Override
public StartSessionResult clone() {
try {
return (StartSessionResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}