Package org.finos.tracdap.api

Interface ResourceInfoResponseOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ResourceInfoResponse, ResourceInfoResponse.Builder
public interface ResourceInfoResponseOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsProperties(String key)
    * Public properties of the selected resource.
    Map<String,String>
    getProperties()
    Deprecated.
    int
    getPropertiesCount()
    * Public properties of the selected resource.
    Map<String,String>
    getPropertiesMap()
    * Public properties of the selected resource.
    String
    getPropertiesOrDefault(String key, String defaultValue)
    * Public properties of the selected resource.
    String
    getPropertiesOrThrow(String key)
    * Public properties of the selected resource.
    String
    getProtocol()
    * Protocol of the selected resource.
    com.google.protobuf.ByteString
    getProtocolBytes()
    * Protocol of the selected resource.
    String
    getResourceKey()
    / Resource key of the selected resource.
    com.google.protobuf.ByteString
    getResourceKeyBytes()
    / Resource key of the selected resource.
    org.finos.tracdap.metadata.ResourceType
    getResourceType()
    / The type of selected resource.
    int
    getResourceTypeValue()
    / The type of selected resource.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getResourceTypeValue

      int getResourceTypeValue()
       / The type of selected resource.
      .tracdap.metadata.ResourceType resourceType = 1;
      Returns:
      The enum numeric value on the wire for resourceType.

    • getResourceType

      org.finos.tracdap.metadata.ResourceType getResourceType()
       / The type of selected resource.
      .tracdap.metadata.ResourceType resourceType = 1;
      Returns:
      The resourceType.

    • getResourceKey

      String getResourceKey()
       / Resource key of the selected resource.
      string resourceKey = 2;
      Returns:
      The resourceKey.

    • getResourceKeyBytes

      com.google.protobuf.ByteString getResourceKeyBytes()
       / Resource key of the selected resource.
      string resourceKey = 2;
      Returns:
      The bytes for resourceKey.

    • getProtocol

      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;
      Returns:
      The protocol.

    • getProtocolBytes

      com.google.protobuf.ByteString getProtocolBytes()
       *
 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;
      Returns:
      The bytes for protocol.

    • getPropertiesCount

      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;

    • containsProperties

      boolean containsProperties(String key)
       *
 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;

    • getProperties

      @Deprecated Map<String,String> getProperties()
      Deprecated.
      Use getPropertiesMap() instead.

    • getPropertiesMap

      Map<String,String> 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;

    • getPropertiesOrDefault

      String getPropertiesOrDefault(String key, 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;

    • getPropertiesOrThrow

      String getPropertiesOrThrow(String key)
       *
 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;