org.finos.tracdap.api.PlatformInfoResponseOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tracdap-api-services Show documentation
TRAC D.A.P. platform API, contains service API definitions for the TRAC platform services
There is a newer version: 0.6.3
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// NO CHECKED-IN PROTOBUF GENCODE
// source: tracdap/api/metadata.proto
// Protobuf Java Version: 4.28.2

package org.finos.tracdap.api;

public interface PlatformInfoResponseOrBuilder extends
    // @@protoc_insertion_point(interface_extends:tracdap.api.PlatformInfoResponse)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * / Version string for the version of TRAC currently deployed in the platform.
   * 
   *
   * string tracVersion = 1;
   * @return The tracVersion.
   */
  java.lang.String getTracVersion();
  /**
   *    * / Version string for the version of TRAC currently deployed in the platform.
   * 
   *
   * string tracVersion = 1;
   * @return The bytes for tracVersion.
   */
  com.google.protobuf.ByteString
      getTracVersionBytes();

  /**
   *    * / Name of the current TRAC environment.
   * 
   *
   * string environment = 2;
   * @return The environment.
   */
  java.lang.String getEnvironment();
  /**
   *    * / Name of the current TRAC environment.
   * 
   *
   * string environment = 2;
   * @return The bytes for environment.
   */
  com.google.protobuf.ByteString
      getEnvironmentBytes();

  /**
   *    * / Flag indicating whether the current environment is a production environment or not.
   * 
   *
   * bool production = 3;
   * @return The production.
   */
  boolean getProduction();

  /**
   *    * *
   * Additional information about the current TRAC environment.
   *
   * The particular information relevant to a deployment of TRAC can vary between organizations.
   * Useful information might include: region, business division, brand etc.
   * This information is optional and may not be present for smaller deployments.
   * 
   *
   * map<string, string> deploymentInfo = 4;
   */
  int getDeploymentInfoCount();
  /**
   *    * *
   * Additional information about the current TRAC environment.
   *
   * The particular information relevant to a deployment of TRAC can vary between organizations.
   * Useful information might include: region, business division, brand etc.
   * This information is optional and may not be present for smaller deployments.
   * 
   *
   * map<string, string> deploymentInfo = 4;
   */
  boolean containsDeploymentInfo(
      java.lang.String key);
  /**
   * Use {@link #getDeploymentInfoMap()} instead.
   */
  @java.lang.Deprecated
  java.util.Map
  getDeploymentInfo();
  /**
   *    * *
   * Additional information about the current TRAC environment.
   *
   * The particular information relevant to a deployment of TRAC can vary between organizations.
   * Useful information might include: region, business division, brand etc.
   * This information is optional and may not be present for smaller deployments.
   * 
   *
   * map<string, string> deploymentInfo = 4;
   */
  java.util.Map
  getDeploymentInfoMap();
  /**
   *    * *
   * Additional information about the current TRAC environment.
   *
   * The particular information relevant to a deployment of TRAC can vary between organizations.
   * Useful information might include: region, business division, brand etc.
   * This information is optional and may not be present for smaller deployments.
   * 
   *
   * map<string, string> deploymentInfo = 4;
   */
  /* nullable */
java.lang.String getDeploymentInfoOrDefault(
      java.lang.String key,
      /* nullable */
java.lang.String defaultValue);
  /**
   *    * *
   * Additional information about the current TRAC environment.
   *
   * The particular information relevant to a deployment of TRAC can vary between organizations.
   * Useful information might include: region, business division, brand etc.
   * This information is optional and may not be present for smaller deployments.
   * 
   *
   * map<string, string> deploymentInfo = 4;
   */
  java.lang.String getDeploymentInfoOrThrow(
      java.lang.String key);
}