net.accelbyte.sdk.api.session.operations.game_session.PublicQueryGameSessionsByAttributes Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of module-session Show documentation

AccelByte Gaming Services Java Extend SDK generated from OpenAPI specs

There is a newer version: 0.11.0

/*
 * Copyright (c) 2022 AccelByte Inc. All Rights Reserved
 * This is licensed software from AccelByte Inc, for limitations
 * and restrictions contact your company contract manager.
 *
 * Code generated. DO NOT EDIT.
 */

package net.accelbyte.sdk.api.session.operations.game_session;

import java.io.*;
import java.util.*;
import lombok.Builder;
import lombok.Getter;
import lombok.Setter;
import net.accelbyte.sdk.api.session.models.*;
import net.accelbyte.sdk.core.HttpResponseException;
import net.accelbyte.sdk.core.Operation;
import net.accelbyte.sdk.core.util.Helper;

/**
 * publicQueryGameSessionsByAttributes
 *
 * Query game sessions.
 *
 * 
By default, API will return a list of available game sessions (joinability: open). Session
 * service has several DSInformation status to track DS request to DSMC: - NEED_TO_REQUEST: number
 * of active players hasn't reached session's minPlayers therefore DS has not yet requested. -
 * REQUESTED: DS is being requested to DSMC. - AVAILABLE: DS is ready to use. The DSMC status for
 * this DS is either READY/BUSY. - FAILED_TO_REQUEST: DSMC fails to create the DS.
 *
 * query parameter "availability" to filter sessions' availability: all: return all sessions
 * regardless it's full full: only return active sessions default behavior (unset or else): return
 * only available sessions (not full)
 */
@Getter
@Setter
public class PublicQueryGameSessionsByAttributes extends Operation {
  /** generated field's value */
  private String path = "/session/v1/public/namespaces/{namespace}/gamesessions";

  private String method = "POST";
  private List consumes = Arrays.asList("application/json");
  private List produces = Arrays.asList("application/json");
  private String locationQuery = null;

  /** fields as input parameter */
  private String namespace;

  private Map body;

  /**
   * @param namespace required
   * @param body required
   */
  @Builder
  // @deprecated 2022-08-29 - All args constructor may cause problems. Use builder instead.
  @Deprecated
  public PublicQueryGameSessionsByAttributes(String namespace, Map body) {
    this.namespace = namespace;
    this.body = body;

    securities.add("Bearer");
  }

  @Override
  public Map getPathParams() {
    Map pathParams = new HashMap<>();
    if (this.namespace != null) {
      pathParams.put("namespace", this.namespace);
    }
    return pathParams;
  }

  @Override
  public Map getBodyParams() {
    return this.body;
  }

  @Override
  public boolean isValid() {
    if (this.namespace == null) {
      return false;
    }
    return true;
  }

  public ApimodelsGameSessionQueryResponse parseResponse(
      int code, String contentType, InputStream payload) throws HttpResponseException, IOException {
    if (code != 200) {
      final String json = Helper.convertInputStreamToString(payload);
      throw new HttpResponseException(code, json);
    }
    final String json = Helper.convertInputStreamToString(payload);
    return new ApimodelsGameSessionQueryResponse().createFromJson(json);
  }
}