ApiOperations
Stay organized with collections
Save and categorize content based on your preferences.
A factory for creating ApiOperation instances.
This class consists exclusively of static methods that operate on or return specific
ApiOperation instances used in template classes (such as Repository).
Inherited Method Summary
From class
java.lang.Object
|
boolean
|
equals(Object arg0)
|
|
final
Class<?>
|
getClass()
|
|
int
|
hashCode()
|
|
final
void
|
notify()
|
|
final
void
|
notifyAll()
|
|
String
|
toString()
|
|
final
void
|
wait(long arg0, int arg1)
|
|
final
void
|
wait(long arg0)
|
|
final
void
|
wait()
|
Public Methods
Creates a DeleteItem instance with a custom version.
Parameters
| id |
to delete |
| version |
item version for delete |
| requestMode |
mode for request |
public
static
ApiOperation
deleteQueueItems
(String queueName)
Parameters
| queueName |
items with this queue name will be deleted |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-18 UTC.
[null,null,["Last updated 2025-03-18 UTC."],[],[],null,["# ApiOperations\n\npublic class **ApiOperations** extends Object \nA factory for creating [ApiOperation](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/template/ApiOperation) instances.\n\nThis class consists exclusively of static methods that operate on or return specific\n[ApiOperation](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/template/ApiOperation) instances used in template classes (such as [Repository](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/template/Repository)). \n\n### Public Method Summary\n\n|----------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| static [ApiOperation](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/template/ApiOperation) | [batch](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/template/ApiOperations#batch(java.util.Iterator\u003ccom.google.enterprise.cloudsearch.sdk.indexing.template.ApiOperation\u003e))(Iterator\\\u003c[ApiOperation](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/template/ApiOperation)\\\u003e operations) Creates a [BatchApiOperation](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/template/BatchApiOperation) instance. |\n| static [ApiOperation](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/template/ApiOperation) | [deleteItem](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/template/ApiOperations#deleteItem(java.lang.String, byte[], com.google.enterprise.cloudsearch.sdk.indexing.IndexingService.RequestMode))(String id, byte\\[\\] version, [IndexingService.RequestMode](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/IndexingService.RequestMode) requestMode) Creates a [DeleteItem](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/template/DeleteItem) instance with a custom version. |\n| static [ApiOperation](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/template/ApiOperation) | [deleteItem](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/template/ApiOperations#deleteItem(java.lang.String))(String id) Creates a [DeleteItem](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/template/DeleteItem) instance. |\n| static [ApiOperation](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/template/ApiOperation) | [deleteQueueItems](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/template/ApiOperations#deleteQueueItems(java.lang.String))(String queueName) Creates a [DeleteQueueItems](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/template/DeleteQueueItems) instance. |\n\n### Inherited Method Summary\n\nFrom class java.lang.Object \n\n|------------------|---------------------------|\n| boolean | equals(Object arg0) |\n| final Class\\\u003c?\\\u003e | getClass() |\n| int | hashCode() |\n| final void | notify() |\n| final void | notifyAll() |\n| String | toString() |\n| final void | wait(long arg0, int arg1) |\n| final void | wait(long arg0) |\n| final void | wait() |\n\nPublic Methods\n--------------\n\n#### public static [ApiOperation](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/template/ApiOperation)\n**batch**\n(Iterator\\\u003c[ApiOperation](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/template/ApiOperation)\\\u003e operations)\n\nCreates a [BatchApiOperation](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/template/BatchApiOperation) instance.\n\nUse this method to batch multiple [ApiOperation](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/template/ApiOperation) instances in a single operation. \n\n##### Parameters\n\n| operations | to batch |\n|------------|----------|\n\n##### Returns\n\n- [BatchApiOperation](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/template/BatchApiOperation) \n\n#### public static [ApiOperation](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/template/ApiOperation)\n**deleteItem**\n(String id, byte\\[\\] version, [IndexingService.RequestMode](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/IndexingService.RequestMode) requestMode)\n\nCreates a [DeleteItem](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/template/DeleteItem) instance with a custom version. \n\n##### Parameters\n\n| id | to delete |\n| version | item version for delete |\n| requestMode | mode for request |\n|-------------|-------------------------|\n\n##### Returns\n\n- [DeleteItem](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/template/DeleteItem) \n\n#### public static [ApiOperation](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/template/ApiOperation)\n**deleteItem**\n(String id)\n\nCreates a [DeleteItem](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/template/DeleteItem) instance. \n\n##### Parameters\n\n| id | to delete |\n|----|-----------|\n\n##### Returns\n\n- [DeleteItem](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/template/DeleteItem) \n\n#### public static [ApiOperation](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/template/ApiOperation)\n**deleteQueueItems**\n(String queueName)\n\nCreates a [DeleteQueueItems](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/template/DeleteQueueItems) instance. \n\n##### Parameters\n\n| queueName | items with this queue name will be deleted |\n|-----------|--------------------------------------------|\n\n##### Returns\n\n- [DeleteQueueItems](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/template/DeleteQueueItems)"]]
