com.amazonaws.services.apigatewaymanagementapi.model.PostToConnectionRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-apigatewaymanagementapi 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.apigatewaymanagementapi.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PostToConnectionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The data to be sent to the client specified by its connection id.
*
*/
private java.nio.ByteBuffer data;
/**
*
* The identifier of the connection that a specific client is using.
*
*/
private String connectionId;
/**
*
* The data to be sent to the client specified by its connection id.
*
*
* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service.
* Users of the SDK should not perform Base64 encoding on this field.
*
*
* Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will
* be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or
* ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future
* major version of the SDK.
*
*
* @param data
* The data to be sent to the client specified by its connection id.
*/
public void setData(java.nio.ByteBuffer data) {
this.data = data;
}
/**
*
* The data to be sent to the client specified by its connection id.
*
*
* {@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend
* using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent
* {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}.
* Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the
* {@code position}.
*
*
* @return The data to be sent to the client specified by its connection id.
*/
public java.nio.ByteBuffer getData() {
return this.data;
}
/**
*
* The data to be sent to the client specified by its connection id.
*
*
* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service.
* Users of the SDK should not perform Base64 encoding on this field.
*
*
* Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will
* be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or
* ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future
* major version of the SDK.
*
*
* @param data
* The data to be sent to the client specified by its connection id.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PostToConnectionRequest withData(java.nio.ByteBuffer data) {
setData(data);
return this;
}
/**
*
* The identifier of the connection that a specific client is using.
*
*
* @param connectionId
* The identifier of the connection that a specific client is using.
*/
public void setConnectionId(String connectionId) {
this.connectionId = connectionId;
}
/**
*
* The identifier of the connection that a specific client is using.
*
*
* @return The identifier of the connection that a specific client is using.
*/
public String getConnectionId() {
return this.connectionId;
}
/**
*
* The identifier of the connection that a specific client is using.
*
*
* @param connectionId
* The identifier of the connection that a specific client is using.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PostToConnectionRequest withConnectionId(String connectionId) {
setConnectionId(connectionId);
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 (getData() != null)
sb.append("Data: ").append(getData()).append(",");
if (getConnectionId() != null)
sb.append("ConnectionId: ").append(getConnectionId());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PostToConnectionRequest == false)
return false;
PostToConnectionRequest other = (PostToConnectionRequest) obj;
if (other.getData() == null ^ this.getData() == null)
return false;
if (other.getData() != null && other.getData().equals(this.getData()) == false)
return false;
if (other.getConnectionId() == null ^ this.getConnectionId() == null)
return false;
if (other.getConnectionId() != null && other.getConnectionId().equals(this.getConnectionId()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getData() == null) ? 0 : getData().hashCode());
hashCode = prime * hashCode + ((getConnectionId() == null) ? 0 : getConnectionId().hashCode());
return hashCode;
}
@Override
public PostToConnectionRequest clone() {
return (PostToConnectionRequest) super.clone();
}
}