com.google.api.services.games.model.TurnBasedMatchTurn Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-games Show documentation
There is a newer version: v1-rev20240701-2.0.0
Show newest version
/*
 * Copyright 2010 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * 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.
 */
/*
 * This code was generated by https://code.google.com/p/google-apis-client-generator/
 * (build: 2015-01-14 17:53:03 UTC)
 * on 2015-03-12 at 21:37:46 UTC 
 * Modify at your own risk.
 */

package com.google.api.services.games.model;

/**
 * This is a JSON template for the object representing a turn.
 *
 *  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the Google Play Game Services API. For a detailed
 * explanation see:
 * http://code.google.com/p/google-http-java-client/wiki/JSON
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class TurnBasedMatchTurn extends com.google.api.client.json.GenericJson {

  /**
   * The shared game state data after the turn is over.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private TurnBasedMatchDataRequest data;

  /**
   * Uniquely identifies the type of this resource. Value is always the fixed string
   * games#turnBasedMatchTurn.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String kind;

  /**
   * The version of this match: an increasing counter, used to avoid out-of-date updates to the
   * match.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer matchVersion;

  /**
   * The ID of the participant who should take their turn next. May be set to the current player's
   * participant ID to update match state without changing the turn. If not set, the match will wait
   * for other player(s) to join via automatching; this is only valid if automatch criteria is set
   * on the match with remaining slots for automatched players.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String pendingParticipantId;

  /**
   * The match results for the participants in the match.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List results;

  static {
    // hack to force ProGuard to consider ParticipantResult used, since otherwise it would be stripped out
    // see http://code.google.com/p/google-api-java-client/issues/detail?id=528
    com.google.api.client.util.Data.nullOf(ParticipantResult.class);
  }

  /**
   * The shared game state data after the turn is over.
   * @return value or {@code null} for none
   */
  public TurnBasedMatchDataRequest getData() {
    return data;
  }

  /**
   * The shared game state data after the turn is over.
   * @param data data or {@code null} for none
   */
  public TurnBasedMatchTurn setData(TurnBasedMatchDataRequest data) {
    this.data = data;
    return this;
  }

  /**
   * Uniquely identifies the type of this resource. Value is always the fixed string
   * games#turnBasedMatchTurn.
   * @return value or {@code null} for none
   */
  public java.lang.String getKind() {
    return kind;
  }

  /**
   * Uniquely identifies the type of this resource. Value is always the fixed string
   * games#turnBasedMatchTurn.
   * @param kind kind or {@code null} for none
   */
  public TurnBasedMatchTurn setKind(java.lang.String kind) {
    this.kind = kind;
    return this;
  }

  /**
   * The version of this match: an increasing counter, used to avoid out-of-date updates to the
   * match.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getMatchVersion() {
    return matchVersion;
  }

  /**
   * The version of this match: an increasing counter, used to avoid out-of-date updates to the
   * match.
   * @param matchVersion matchVersion or {@code null} for none
   */
  public TurnBasedMatchTurn setMatchVersion(java.lang.Integer matchVersion) {
    this.matchVersion = matchVersion;
    return this;
  }

  /**
   * The ID of the participant who should take their turn next. May be set to the current player's
   * participant ID to update match state without changing the turn. If not set, the match will wait
   * for other player(s) to join via automatching; this is only valid if automatch criteria is set
   * on the match with remaining slots for automatched players.
   * @return value or {@code null} for none
   */
  public java.lang.String getPendingParticipantId() {
    return pendingParticipantId;
  }

  /**
   * The ID of the participant who should take their turn next. May be set to the current player's
   * participant ID to update match state without changing the turn. If not set, the match will wait
   * for other player(s) to join via automatching; this is only valid if automatch criteria is set
   * on the match with remaining slots for automatched players.
   * @param pendingParticipantId pendingParticipantId or {@code null} for none
   */
  public TurnBasedMatchTurn setPendingParticipantId(java.lang.String pendingParticipantId) {
    this.pendingParticipantId = pendingParticipantId;
    return this;
  }

  /**
   * The match results for the participants in the match.
   * @return value or {@code null} for none
   */
  public java.util.List getResults() {
    return results;
  }

  /**
   * The match results for the participants in the match.
   * @param results results or {@code null} for none
   */
  public TurnBasedMatchTurn setResults(java.util.List results) {
    this.results = results;
    return this;
  }

  @Override
  public TurnBasedMatchTurn set(String fieldName, Object value) {
    return (TurnBasedMatchTurn) super.set(fieldName, value);
  }

  @Override
  public TurnBasedMatchTurn clone() {
    return (TurnBasedMatchTurn) super.clone();
  }

}