• Home
• com.amazonaws
• aws-java-sdk-gamelift
• 1.12.231
• source code
• DesiredPlayerSession.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.amazonaws.services.gamelift.model.DesiredPlayerSession Maven / Gradle / Ivy

/*
 * Copyright 2017-2022 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.gamelift.model;

import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;

/**
 * 

 * Player information for use when creating player sessions using a game session placement request with
 * StartGameSessionPlacement.
 * 
 * 
 * @see AWS API
 *      Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DesiredPlayerSession implements Serializable, Cloneable, StructuredPojo {

    /**
     * 

     * A unique identifier for a player to associate with the player session.
     * 
     */
    private String playerId;
    /**
     * 

     * Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as
     * needed for use in the game.
     * 
     */
    private String playerData;

    /**
     * 

     * A unique identifier for a player to associate with the player session.
     * 
     * 
     * @param playerId
     *        A unique identifier for a player to associate with the player session.
     */

    public void setPlayerId(String playerId) {
        this.playerId = playerId;
    }

    /**
     * 

     * A unique identifier for a player to associate with the player session.
     * 
     * 
     * @return A unique identifier for a player to associate with the player session.
     */

    public String getPlayerId() {
        return this.playerId;
    }

    /**
     * 

     * A unique identifier for a player to associate with the player session.
     * 
     * 
     * @param playerId
     *        A unique identifier for a player to associate with the player session.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public DesiredPlayerSession withPlayerId(String playerId) {
        setPlayerId(playerId);
        return this;
    }

    /**
     * 

     * Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as
     * needed for use in the game.
     * 
     * 
     * @param playerData
     *        Developer-defined information related to a player. GameLift does not use this data, so it can be formatted
     *        as needed for use in the game.
     */

    public void setPlayerData(String playerData) {
        this.playerData = playerData;
    }

    /**
     * 

     * Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as
     * needed for use in the game.
     * 
     * 
     * @return Developer-defined information related to a player. GameLift does not use this data, so it can be
     *         formatted as needed for use in the game.
     */

    public String getPlayerData() {
        return this.playerData;
    }

    /**
     * 

     * Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as
     * needed for use in the game.
     * 
     * 
     * @param playerData
     *        Developer-defined information related to a player. GameLift does not use this data, so it can be formatted
     *        as needed for use in the game.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public DesiredPlayerSession withPlayerData(String playerData) {
        setPlayerData(playerData);
        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 (getPlayerId() != null)
            sb.append("PlayerId: ").append(getPlayerId()).append(",");
        if (getPlayerData() != null)
            sb.append("PlayerData: ").append(getPlayerData());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof DesiredPlayerSession == false)
            return false;
        DesiredPlayerSession other = (DesiredPlayerSession) obj;
        if (other.getPlayerId() == null ^ this.getPlayerId() == null)
            return false;
        if (other.getPlayerId() != null && other.getPlayerId().equals(this.getPlayerId()) == false)
            return false;
        if (other.getPlayerData() == null ^ this.getPlayerData() == null)
            return false;
        if (other.getPlayerData() != null && other.getPlayerData().equals(this.getPlayerData()) == false)
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime * hashCode + ((getPlayerId() == null) ? 0 : getPlayerId().hashCode());
        hashCode = prime * hashCode + ((getPlayerData() == null) ? 0 : getPlayerData().hashCode());
        return hashCode;
    }

    @Override
    public DesiredPlayerSession clone() {
        try {
            return (DesiredPlayerSession) 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.gamelift.model.transform.DesiredPlayerSessionMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}