Class: Google::Cloud::DiscoveryEngine::V1::PurgeDocumentsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/purge_config.rb

Overview

Request message for DocumentService.PurgeDocuments method.

Defined Under Namespace

Classes: InlineSource

Instance Attribute Summary collapse

Instance Attribute Details

#error_config ⇒ ::Google::Cloud::DiscoveryEngine::V1::PurgeErrorConfig

Returns The desired location of errors incurred during the purge.

Returns:



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'proto_docs/google/cloud/discoveryengine/v1/purge_config.rb', line 149

class PurgeDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The inline source for the input config for
  # {::Google::Cloud::DiscoveryEngine::V1::DocumentService::Client#purge_documents DocumentService.PurgeDocuments}
  # method.
  # @!attribute [rw] documents
  #   @return [::Array<::String>]
  #     Required. A list of full resource name of documents to purge. In the
  #     format
  #     `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
  #     Recommended max of 100 items.
  class InlineSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#filter ⇒ ::String

Returns Required. Filter matching documents to purge. Only currently supported value is * (all items).

Returns:

  • (::String) —

    Required. Filter matching documents to purge. Only currently supported value is * (all items).



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'proto_docs/google/cloud/discoveryengine/v1/purge_config.rb', line 149

class PurgeDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The inline source for the input config for
  # {::Google::Cloud::DiscoveryEngine::V1::DocumentService::Client#purge_documents DocumentService.PurgeDocuments}
  # method.
  # @!attribute [rw] documents
  #   @return [::Array<::String>]
  #     Required. A list of full resource name of documents to purge. In the
  #     format
  #     `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
  #     Recommended max of 100 items.
  class InlineSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#force ⇒ ::Boolean

Returns Actually performs the purge. If force is set to false, return the expected purge count without deleting any documents.

Returns:

  • (::Boolean) —

    Actually performs the purge. If force is set to false, return the expected purge count without deleting any documents.



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'proto_docs/google/cloud/discoveryengine/v1/purge_config.rb', line 149

class PurgeDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The inline source for the input config for
  # {::Google::Cloud::DiscoveryEngine::V1::DocumentService::Client#purge_documents DocumentService.PurgeDocuments}
  # method.
  # @!attribute [rw] documents
  #   @return [::Array<::String>]
  #     Required. A list of full resource name of documents to purge. In the
  #     format
  #     `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
  #     Recommended max of 100 items.
  class InlineSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#gcs_source ⇒ ::Google::Cloud::DiscoveryEngine::V1::GcsSource

Returns Cloud Storage location for the input content. Supported data_schema:

Note: The following fields are mutually exclusive: gcs_source, inline_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::DiscoveryEngine::V1::GcsSource) —

    Cloud Storage location for the input content. Supported data_schema:

    Note: The following fields are mutually exclusive: gcs_source, inline_source. If a field in that set is populated, all other fields in the set will automatically be cleared.



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'proto_docs/google/cloud/discoveryengine/v1/purge_config.rb', line 149

class PurgeDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The inline source for the input config for
  # {::Google::Cloud::DiscoveryEngine::V1::DocumentService::Client#purge_documents DocumentService.PurgeDocuments}
  # method.
  # @!attribute [rw] documents
  #   @return [::Array<::String>]
  #     Required. A list of full resource name of documents to purge. In the
  #     format
  #     `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
  #     Recommended max of 100 items.
  class InlineSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#inline_source ⇒ ::Google::Cloud::DiscoveryEngine::V1::PurgeDocumentsRequest::InlineSource

Returns Inline source for the input content for purge.

Note: The following fields are mutually exclusive: inline_source, gcs_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'proto_docs/google/cloud/discoveryengine/v1/purge_config.rb', line 149

class PurgeDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The inline source for the input config for
  # {::Google::Cloud::DiscoveryEngine::V1::DocumentService::Client#purge_documents DocumentService.PurgeDocuments}
  # method.
  # @!attribute [rw] documents
  #   @return [::Array<::String>]
  #     Required. A list of full resource name of documents to purge. In the
  #     format
  #     `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
  #     Recommended max of 100 items.
  class InlineSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#parent ⇒ ::String

Returns Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.

Returns:

  • (::String) —

    Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'proto_docs/google/cloud/discoveryengine/v1/purge_config.rb', line 149

class PurgeDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The inline source for the input config for
  # {::Google::Cloud::DiscoveryEngine::V1::DocumentService::Client#purge_documents DocumentService.PurgeDocuments}
  # method.
  # @!attribute [rw] documents
  #   @return [::Array<::String>]
  #     Required. A list of full resource name of documents to purge. In the
  #     format
  #     `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
  #     Recommended max of 100 items.
  class InlineSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end