Package org.finos.tracdap.api

Class ResourceInfoResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
org.finos.tracdap.api.ResourceInfoResponse
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, ResourceInfoResponseOrBuilder
public final class ResourceInfoResponse extends com.google.protobuf.GeneratedMessage implements ResourceInfoResponseOrBuilder
 *
 Response object for a resourceInfo() API call.

 @see TracMetadataApi.resourceInfo
Protobuf type tracdap.api.ResourceInfoResponse
See Also:

  • Field Details

    • RESOURCETYPE_FIELD_NUMBER

      public static final int RESOURCETYPE_FIELD_NUMBER
      See Also:

    • RESOURCEKEY_FIELD_NUMBER

      public static final int RESOURCEKEY_FIELD_NUMBER
      See Also:

    • PROTOCOL_FIELD_NUMBER

      public static final int PROTOCOL_FIELD_NUMBER
      See Also:

    • PROPERTIES_FIELD_NUMBER

      public static final int PROPERTIES_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getResourceTypeValue

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

    • getResourceType

      public org.finos.tracdap.metadata.ResourceType getResourceType()
       / The type of selected resource.
      .tracdap.metadata.ResourceType resourceType = 1;
      Specified by:
      getResourceType in interface ResourceInfoResponseOrBuilder
      Returns:
      The resourceType.

    • getResourceKey

      public String getResourceKey()
       / Resource key of the selected resource.
      string resourceKey = 2;
      Specified by:
      getResourceKey in interface ResourceInfoResponseOrBuilder
      Returns:
      The resourceKey.

    • getResourceKeyBytes

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

    • getProtocol

      public 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;
      Specified by:
      getProtocol in interface ResourceInfoResponseOrBuilder
      Returns:
      The protocol.

    • getProtocolBytes

      public 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;
      Specified by:
      getProtocolBytes in interface ResourceInfoResponseOrBuilder
      Returns:
      The bytes for protocol.

    • getPropertiesCount

      public int getPropertiesCount()
      Description copied from interface: ResourceInfoResponseOrBuilder
       *
 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;
      Specified by:
      getPropertiesCount in interface ResourceInfoResponseOrBuilder

    • containsProperties

      public 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;
      Specified by:
      containsProperties in interface ResourceInfoResponseOrBuilder

    • getProperties

      @Deprecated public Map<String,String> getProperties()
      Deprecated.
      Use getPropertiesMap() instead.
      Specified by:
      getProperties in interface ResourceInfoResponseOrBuilder

    • getPropertiesMap

      public 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;
      Specified by:
      getPropertiesMap in interface ResourceInfoResponseOrBuilder

    • getPropertiesOrDefault

      public 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;
      Specified by:
      getPropertiesOrDefault in interface ResourceInfoResponseOrBuilder

    • getPropertiesOrThrow

      public 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;
      Specified by:
      getPropertiesOrThrow in interface ResourceInfoResponseOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ResourceInfoResponse parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ResourceInfoResponse parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ResourceInfoResponse parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ResourceInfoResponse parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ResourceInfoResponse parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ResourceInfoResponse parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ResourceInfoResponse parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ResourceInfoResponse parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ResourceInfoResponse parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ResourceInfoResponse parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ResourceInfoResponse parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ResourceInfoResponse parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ResourceInfoResponse.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ResourceInfoResponse.Builder newBuilder()

    • newBuilder

      public static ResourceInfoResponse.Builder newBuilder(ResourceInfoResponse prototype)

    • toBuilder

      public ResourceInfoResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ResourceInfoResponse.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ResourceInfoResponse getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ResourceInfoResponse> parser()

    • getParserForType

      public com.google.protobuf.Parser<ResourceInfoResponse> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public ResourceInfoResponse getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder