Interface PurgeDocumentsRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    PurgeDocumentsRequest, PurgeDocumentsRequest.Builder

    public interface PurgeDocumentsRequestOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getFilter()
      Required.
      com.google.protobuf.ByteString getFilterBytes()
      Required.
      boolean getForce()
      Actually performs the purge.
      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 Detail

      • getParent

        String getParent()
         Required. The parent resource name, such as
         `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The parent.
      • getParentBytes

        com.google.protobuf.ByteString getParentBytes()
         Required. The parent resource name, such as
         `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for parent.
      • getFilter

        String getFilter()
         Required. Filter matching documents to purge. Only currently supported
         value is
         `*` (all items).
         
        string filter = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The filter.
      • getFilterBytes

        com.google.protobuf.ByteString getFilterBytes()
         Required. Filter matching documents to purge. Only currently supported
         value is
         `*` (all items).
         
        string filter = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for filter.
      • getForce

        boolean getForce()
         Actually performs the purge. If `force` is set to false, return the
         expected purge count without deleting any documents.
         
        bool force = 3;
        Returns:
        The force.