org.finos.tracdap.api.ResourceInfoResponseOrBuilder 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 ResourceInfoResponseOrBuilder extends
    // @@protoc_insertion_point(interface_extends:tracdap.api.ResourceInfoResponse)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * / The type of selected resource.
   * 
   *
   * .tracdap.metadata.ResourceType resourceType = 1;
   * @return The enum numeric value on the wire for resourceType.
   */
  int getResourceTypeValue();
  /**
   *    * / The type of selected resource.
   * 
   *
   * .tracdap.metadata.ResourceType resourceType = 1;
   * @return The resourceType.
   */
  org.finos.tracdap.metadata.ResourceType getResourceType();

  /**
   *    * / Resource key of the selected resource.
   * 
   *
   * string resourceKey = 2;
   * @return The resourceKey.
   */
  java.lang.String getResourceKey();
  /**
   *    * / Resource key of the selected resource.
   * 
   *
   * string resourceKey = 2;
   * @return The bytes for resourceKey.
   */
  com.google.protobuf.ByteString
      getResourceKeyBytes();

  /**
   *    * *
   * Protocol of the selected resource.
   *
   * Resource protocols correspond to TRAC technology plugins. For example, a storage resource
   * might have protocol LOCAL or S3, and would accordingly require the LOCAL or S3 storage
   * plugin to be installed.
   * 
   *
   * string protocol = 3;
   * @return The protocol.
   */
  java.lang.String getProtocol();
  /**
   *    * *
   * Protocol of the selected resource.
   *
   * Resource protocols correspond to TRAC technology plugins. For example, a storage resource
   * might have protocol LOCAL or S3, and would accordingly require the LOCAL or S3 storage
   * plugin to be installed.
   * 
   *
   * string protocol = 3;
   * @return The bytes for protocol.
   */
  com.google.protobuf.ByteString
      getProtocolBytes();

  /**
   *    * *
   * Public properties of the selected resource.
   *
   * These properties are set in the resource configuration. Certain resource types require
   * certain properties depending on the protocol, however additional arbitrary properties
   * can be added to support client applications.
   * 
   *
   * map<string, string> properties = 4;
   */
  int getPropertiesCount();
  /**
   *    * *
   * Public properties of the selected resource.
   *
   * These properties are set in the resource configuration. Certain resource types require
   * certain properties depending on the protocol, however additional arbitrary properties
   * can be added to support client applications.
   * 
   *
   * map<string, string> properties = 4;
   */
  boolean containsProperties(
      java.lang.String key);
  /**
   * Use {@link #getPropertiesMap()} instead.
   */
  @java.lang.Deprecated
  java.util.Map
  getProperties();
  /**
   *    * *
   * Public properties of the selected resource.
   *
   * These properties are set in the resource configuration. Certain resource types require
   * certain properties depending on the protocol, however additional arbitrary properties
   * can be added to support client applications.
   * 
   *
   * map<string, string> properties = 4;
   */
  java.util.Map
  getPropertiesMap();
  /**
   *    * *
   * Public properties of the selected resource.
   *
   * These properties are set in the resource configuration. Certain resource types require
   * certain properties depending on the protocol, however additional arbitrary properties
   * can be added to support client applications.
   * 
   *
   * map<string, string> properties = 4;
   */
  /* nullable */
java.lang.String getPropertiesOrDefault(
      java.lang.String key,
      /* nullable */
java.lang.String defaultValue);
  /**
   *    * *
   * Public properties of the selected resource.
   *
   * These properties are set in the resource configuration. Certain resource types require
   * certain properties depending on the protocol, however additional arbitrary properties
   * can be added to support client applications.
   * 
   *
   * map<string, string> properties = 4;
   */
  java.lang.String getPropertiesOrThrow(
      java.lang.String key);
}