org.yamcs.protobuf.ListObjectsRequestOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yamcs-api Show documentation
Used by external clients to communicate with Yamcs
There is a newer version: 5.10.9
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: yamcs/protobuf/buckets/buckets.proto

package org.yamcs.protobuf;

public interface ListObjectsRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:yamcs.protobuf.buckets.ListObjectsRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Yamcs instance name. Or _global.
   * 
   *
   * optional string instance = 1 [deprecated = true];
   * @deprecated
   * @return Whether the instance field is set.
   */
  @java.lang.Deprecated boolean hasInstance();
  /**
   *    * Yamcs instance name. Or _global.
   * 
   *
   * optional string instance = 1 [deprecated = true];
   * @deprecated
   * @return The instance.
   */
  @java.lang.Deprecated java.lang.String getInstance();
  /**
   *    * Yamcs instance name. Or _global.
   * 
   *
   * optional string instance = 1 [deprecated = true];
   * @deprecated
   * @return The bytes for instance.
   */
  @java.lang.Deprecated com.google.protobuf.ByteString
      getInstanceBytes();

  /**
   *    * Bucket name
   * 
   *
   * optional string bucketName = 2;
   * @return Whether the bucketName field is set.
   */
  boolean hasBucketName();
  /**
   *    * Bucket name
   * 
   *
   * optional string bucketName = 2;
   * @return The bucketName.
   */
  java.lang.String getBucketName();
  /**
   *    * Bucket name
   * 
   *
   * optional string bucketName = 2;
   * @return The bytes for bucketName.
   */
  com.google.protobuf.ByteString
      getBucketNameBytes();

  /**
   *    * Return only objects whose name do not contain the delimiter after the
   * prefix. For the other objects, the response contains (in the prefix
   * response parameter) the name truncated after the delimiter. Duplicates
   * are omitted.
   * Together with ``prefix`` this parameter provides filtering capabilities.
   * These work similar to Google Cloud Storage and Amazon S3.
   * The ``delimiter`` allows the list to work in a directory mode despite
   * the object namespace being flat. For example if the delimiter is set to
   * "/", then listing the bucket containing objects "a/b", "a/c", "d", "e"
   * and "e/f" returns objects "d" and "e" and prefixes "a/" and "e/".
   * 
   *
   * optional string delimiter = 3;
   * @return Whether the delimiter field is set.
   */
  boolean hasDelimiter();
  /**
   *    * Return only objects whose name do not contain the delimiter after the
   * prefix. For the other objects, the response contains (in the prefix
   * response parameter) the name truncated after the delimiter. Duplicates
   * are omitted.
   * Together with ``prefix`` this parameter provides filtering capabilities.
   * These work similar to Google Cloud Storage and Amazon S3.
   * The ``delimiter`` allows the list to work in a directory mode despite
   * the object namespace being flat. For example if the delimiter is set to
   * "/", then listing the bucket containing objects "a/b", "a/c", "d", "e"
   * and "e/f" returns objects "d" and "e" and prefixes "a/" and "e/".
   * 
   *
   * optional string delimiter = 3;
   * @return The delimiter.
   */
  java.lang.String getDelimiter();
  /**
   *    * Return only objects whose name do not contain the delimiter after the
   * prefix. For the other objects, the response contains (in the prefix
   * response parameter) the name truncated after the delimiter. Duplicates
   * are omitted.
   * Together with ``prefix`` this parameter provides filtering capabilities.
   * These work similar to Google Cloud Storage and Amazon S3.
   * The ``delimiter`` allows the list to work in a directory mode despite
   * the object namespace being flat. For example if the delimiter is set to
   * "/", then listing the bucket containing objects "a/b", "a/c", "d", "e"
   * and "e/f" returns objects "d" and "e" and prefixes "a/" and "e/".
   * 
   *
   * optional string delimiter = 3;
   * @return The bytes for delimiter.
   */
  com.google.protobuf.ByteString
      getDelimiterBytes();

  /**
   *    * List only objects whose name start with prefix
   * 
   *
   * optional string prefix = 4;
   * @return Whether the prefix field is set.
   */
  boolean hasPrefix();
  /**
   *    * List only objects whose name start with prefix
   * 
   *
   * optional string prefix = 4;
   * @return The prefix.
   */
  java.lang.String getPrefix();
  /**
   *    * List only objects whose name start with prefix
   * 
   *
   * optional string prefix = 4;
   * @return The bytes for prefix.
   */
  com.google.protobuf.ByteString
      getPrefixBytes();
}