Package com.google.firestore.admin.v1

Interface ListBackupsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListBackupsRequest, ListBackupsRequest.Builder
@Generated public interface ListBackupsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    An expression that filters the list of returned backups.
    com.google.protobuf.ByteString
    getFilterBytes()
    An expression that filters the list of returned backups.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.

    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

    • getParent

      String getParent()
       Required. The location to list backups from.

 Format is `projects/{project}/locations/{location}`.
 Use `{location} = '-'` to list backups from all locations for the given
 project. This allows listing backups from a single location or from all
 locations.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The parent.

    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       Required. The location to list backups from.

 Format is `projects/{project}/locations/{location}`.
 Use `{location} = '-'` to list backups from all locations for the given
 project. This allows listing backups from a single location or from all
 locations.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.

    • getFilter

      String getFilter()
       An expression that filters the list of returned backups.

 A filter expression consists of a field name, a comparison operator, and a
 value for filtering.
 The value must be a string, a number, or a boolean. The comparison operator
 must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
 Colon `:` is the contains operator. Filter rules are not case sensitive.

 The following fields in the [Backup][google.firestore.admin.v1.Backup] are
 eligible for filtering:

 * `database_uid` (supports `=` only)
      string filter = 2;
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       An expression that filters the list of returned backups.

 A filter expression consists of a field name, a comparison operator, and a
 value for filtering.
 The value must be a string, a number, or a boolean. The comparison operator
 must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
 Colon `:` is the contains operator. Filter rules are not case sensitive.

 The following fields in the [Backup][google.firestore.admin.v1.Backup] are
 eligible for filtering:

 * `database_uid` (supports `=` only)
      string filter = 2;
      Returns:
      The bytes for filter.