live.radix.gateway.model.TransactionPreviewV2OptIns Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of babylon-gateway-client Show documentation
A generated Client library for Radix Babylon Gateway API.
There is a newer version: 1.9.0
Show newest version
/*
 * Radix Gateway API - Babylon
 * This API is exposed by the Babylon Radix Gateway to enable clients to efficiently query current and historic state on the RadixDLT ledger, and intelligently handle transaction submission.  It is designed for use by wallets and explorers, and for light queries from front-end dApps. For exchange/asset integrations, back-end dApp integrations, or simple use cases, you should consider using the Core API on a Node. A Gateway is only needed for reading historic snapshots of ledger states or a more robust set-up.  The Gateway API is implemented by the [Network Gateway](https://github.com/radixdlt/babylon-gateway), which is configured to read from [full node(s)](https://github.com/radixdlt/babylon-node) to extract and index data from the network.  This document is an API reference documentation, visit [User Guide](https://docs.radixdlt.com/) to learn more about how to run a Gateway of your own.  ## Migration guide  Please see [the latest release notes](https://github.com/radixdlt/babylon-gateway/releases).  ## Integration and forward compatibility guarantees  All responses may have additional fields added at any release, so clients are advised to use JSON parsers which ignore unknown fields on JSON objects.  When the Radix protocol is updated, new functionality may be added, and so discriminated unions returned by the API may need to be updated to have new variants added, corresponding to the updated data. Clients may need to update in advance to be able to handle these new variants when a protocol update comes out.  On the very rare occasions we need to make breaking changes to the API, these will be warned in advance with deprecation notices on previous versions. These deprecation notices will include a safe migration path. Deprecation notes or breaking changes will be flagged clearly in release notes for new versions of the Gateway.  The Gateway DB schema is not subject to any compatibility guarantees, and may be changed at any release. DB changes will be flagged in the release notes so clients doing custom DB integrations can prepare. 
 *
 * The version of the OpenAPI document: v1.9.2-L
 * 
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */


package live.radix.gateway.model;

import java.util.Objects;
import java.util.Arrays;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.fasterxml.jackson.annotation.JsonValue;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.util.StringJoiner;

/**
 * A set of flags to configure the response of the transaction preview v2 endpoint.
 */
@JsonPropertyOrder({
  TransactionPreviewV2OptIns.JSON_PROPERTY_CORE_API_RECEIPT,
  TransactionPreviewV2OptIns.JSON_PROPERTY_RADIX_ENGINE_TOOLKIT_RECEIPT,
  TransactionPreviewV2OptIns.JSON_PROPERTY_LOGS
})
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-12-12T19:38:04.213407200+02:00[Europe/Kiev]", comments = "Generator version: 7.7.0")
public class TransactionPreviewV2OptIns {
  public static final String JSON_PROPERTY_CORE_API_RECEIPT = "core_api_receipt";
  private Boolean coreApiReceipt = false;

  public static final String JSON_PROPERTY_RADIX_ENGINE_TOOLKIT_RECEIPT = "radix_engine_toolkit_receipt";
  private Boolean radixEngineToolkitReceipt = false;

  public static final String JSON_PROPERTY_LOGS = "logs";
  private Boolean logs = false;

  public TransactionPreviewV2OptIns() {
  }

  public TransactionPreviewV2OptIns coreApiReceipt(Boolean coreApiReceipt) {
    
    this.coreApiReceipt = coreApiReceipt;
    return this;
  }

  /**
   * This flag controls whether the preview response will include a Core API receipt or not. If not provided, this defaults to `false` and no core api receipt is provided in the response. 
   * @return coreApiReceipt
   */
  @javax.annotation.Nullable
  @JsonProperty(JSON_PROPERTY_CORE_API_RECEIPT)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Boolean isCoreApiReceipt() {
    return coreApiReceipt;
  }


  @JsonProperty(JSON_PROPERTY_CORE_API_RECEIPT)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setCoreApiReceipt(Boolean coreApiReceipt) {
    this.coreApiReceipt = coreApiReceipt;
  }

  public TransactionPreviewV2OptIns radixEngineToolkitReceipt(Boolean radixEngineToolkitReceipt) {
    
    this.radixEngineToolkitReceipt = radixEngineToolkitReceipt;
    return this;
  }

  /**
   * This flag controls whether the preview response will include a Radix Engine Toolkit serializable receipt or not. If not provided, this defaults to `false` and no toolkit receipt is provided in the response. 
   * @return radixEngineToolkitReceipt
   */
  @javax.annotation.Nullable
  @JsonProperty(JSON_PROPERTY_RADIX_ENGINE_TOOLKIT_RECEIPT)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Boolean isRadixEngineToolkitReceipt() {
    return radixEngineToolkitReceipt;
  }


  @JsonProperty(JSON_PROPERTY_RADIX_ENGINE_TOOLKIT_RECEIPT)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setRadixEngineToolkitReceipt(Boolean radixEngineToolkitReceipt) {
    this.radixEngineToolkitReceipt = radixEngineToolkitReceipt;
  }

  public TransactionPreviewV2OptIns logs(Boolean logs) {
    
    this.logs = logs;
    return this;
  }

  /**
   * This flag controls whether the preview response will include execution logs. If not provided, this defaults to `false` and no logs will be provided in the response. 
   * @return logs
   */
  @javax.annotation.Nullable
  @JsonProperty(JSON_PROPERTY_LOGS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Boolean isLogs() {
    return logs;
  }


  @JsonProperty(JSON_PROPERTY_LOGS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setLogs(Boolean logs) {
    this.logs = logs;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    TransactionPreviewV2OptIns transactionPreviewV2OptIns = (TransactionPreviewV2OptIns) o;
    return Objects.equals(this.coreApiReceipt, transactionPreviewV2OptIns.coreApiReceipt) &&
        Objects.equals(this.radixEngineToolkitReceipt, transactionPreviewV2OptIns.radixEngineToolkitReceipt) &&
        Objects.equals(this.logs, transactionPreviewV2OptIns.logs);
  }

  @Override
  public int hashCode() {
    return Objects.hash(coreApiReceipt, radixEngineToolkitReceipt, logs);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class TransactionPreviewV2OptIns {\n");
    sb.append("    coreApiReceipt: ").append(toIndentedString(coreApiReceipt)).append("\n");
    sb.append("    radixEngineToolkitReceipt: ").append(toIndentedString(radixEngineToolkitReceipt)).append("\n");
    sb.append("    logs: ").append(toIndentedString(logs)).append("\n");
    sb.append("}");
    return sb.toString();
  }

  /**
   * Convert the given object to string with each line indented by 4 spaces
   * (except the first line).
   */
  private String toIndentedString(Object o) {
    if (o == null) {
      return "null";
    }
    return o.toString().replace("\n", "\n    ");
  }

  /**
   * Convert the instance into URL query string.
   *
   * @return URL query string
   */
  public String toUrlQueryString() {
    return toUrlQueryString(null);
  }

  /**
   * Convert the instance into URL query string.
   *
   * @param prefix prefix of the query string
   * @return URL query string
   */
  public String toUrlQueryString(String prefix) {
    String suffix = "";
    String containerSuffix = "";
    String containerPrefix = "";
    if (prefix == null) {
      // style=form, explode=true, e.g. /pet?name=cat&type=manx
      prefix = "";
    } else {
      // deepObject style e.g. /pet?id[name]=cat&id[type]=manx
      prefix = prefix + "[";
      suffix = "]";
      containerSuffix = "]";
      containerPrefix = "[";
    }

    StringJoiner joiner = new StringJoiner("&");

    // add `core_api_receipt` to the URL query string
    if (isCoreApiReceipt() != null) {
      try {
        joiner.add(String.format("%score_api_receipt%s=%s", prefix, suffix, URLEncoder.encode(String.valueOf(isCoreApiReceipt()), "UTF-8").replaceAll("\\+", "%20")));
      } catch (UnsupportedEncodingException e) {
        // Should never happen, UTF-8 is always supported
        throw new RuntimeException(e);
      }
    }

    // add `radix_engine_toolkit_receipt` to the URL query string
    if (isRadixEngineToolkitReceipt() != null) {
      try {
        joiner.add(String.format("%sradix_engine_toolkit_receipt%s=%s", prefix, suffix, URLEncoder.encode(String.valueOf(isRadixEngineToolkitReceipt()), "UTF-8").replaceAll("\\+", "%20")));
      } catch (UnsupportedEncodingException e) {
        // Should never happen, UTF-8 is always supported
        throw new RuntimeException(e);
      }
    }

    // add `logs` to the URL query string
    if (isLogs() != null) {
      try {
        joiner.add(String.format("%slogs%s=%s", prefix, suffix, URLEncoder.encode(String.valueOf(isLogs()), "UTF-8").replaceAll("\\+", "%20")));
      } catch (UnsupportedEncodingException e) {
        // Should never happen, UTF-8 is always supported
        throw new RuntimeException(e);
      }
    }

    return joiner.toString();
  }

}