Package com.oracle.coherence.grpc

Class Requests

java.lang.Object
com.oracle.coherence.grpc.Requests
public final class Requests extends Object
A factory to simplify creating proto-buffer requests.
Since:
20.06
Author:
Jonathan Knight 2019.11.01

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CREDENTIALS_INSECURE
    The value used for the PROP_CREDENTIALS system property to indicate an insecure server.
    static final String
    CREDENTIALS_PLAINTEXT
    The credentials to use to connect to a non-TLS enabled server.
    static final String
    CREDENTIALS_TLS
    The value used for the PROP_CREDENTIALS system property to indicate the server should use TLS.
    static final String
    PROP_CREDENTIALS
    The system property that sets the credentials type.
    static final String
    PROP_TLS_CA
    The system property that sets the location of the TLS CA file.
    static final String
    PROP_TLS_CERT
    The system property that sets the location of the TLS cert file.
    static final String
    PROP_TLS_CLIENT_AUTH
    The system property that sets whether mutual TLS is enabled.
    static final String
    PROP_TLS_KEY
    The system property that sets the location of the TLS key file.
    static final String
    PROP_TLS_KEYPASS
    The system property that sets the password for the TLS key file.
    static final String
    PROP_TLS_KEYPASS_URI
    The system property that sets the URI of a file to read to obtain the password for the TLS key file.

  • Method Summary

    Modifier and Type
    Method
    Description
    static com.oracle.coherence.grpc.MapListenerRequest
    addFilterMapListener(String scope, String cacheName, String format, com.google.protobuf.ByteString filter, long filterId, boolean lite, boolean priming, com.google.protobuf.ByteString mapTrigger)
    Create a MapListenerRequest that will subscribe to MapEvents for all entries in a cache matching a filter.
    static com.oracle.coherence.grpc.AddIndexRequest
    addIndex(String scope, String cacheName, String format, com.google.protobuf.ByteString extractor)
    Create a AddIndexRequest.
    static com.oracle.coherence.grpc.AddIndexRequest
    addIndex(String scope, String cacheName, String format, com.google.protobuf.ByteString extractor, boolean sorted)
    Create a AddIndexRequest.
    static com.oracle.coherence.grpc.AddIndexRequest
    addIndex(String scope, String cacheName, String format, com.google.protobuf.ByteString extractor, boolean sorted, com.google.protobuf.ByteString comparator)
    Create a AddIndexRequest.
    static com.oracle.coherence.grpc.MapListenerRequest
    addKeyMapListener(String scope, String cacheName, String format, com.google.protobuf.ByteString key, boolean lite, boolean priming, com.google.protobuf.ByteString mapTrigger)
    Create a MapListenerRequest that will subscribe to MapEvents for a single entry in a cache.
    static com.oracle.coherence.grpc.AggregateRequest
    aggregate(String scope, String cacheName, String format, com.google.protobuf.ByteString filter, com.google.protobuf.ByteString aggregator)
    Create a AggregateRequest.
    static com.oracle.coherence.grpc.AggregateRequest
    aggregate(String scope, String cacheName, String format, Iterable<com.google.protobuf.ByteString> keys, com.google.protobuf.ByteString aggregator)
    Create a AggregateRequest.
    static com.oracle.coherence.grpc.ClearRequest
    clear(String scope, String cacheName)
    Create a ClearRequest.
    static com.oracle.coherence.grpc.ContainsEntryRequest
    containsEntry(String scope, String cacheName, String format, com.google.protobuf.ByteString key, com.google.protobuf.ByteString value)
    Create a ContainsEntryRequest.
    static com.oracle.coherence.grpc.ContainsKeyRequest
    containsKey(String scope, String cacheName, String format, com.google.protobuf.ByteString key)
    Create a ClearRequest.
    static com.oracle.coherence.grpc.ContainsValueRequest
    containsValue(String scope, String cacheName, String format, com.google.protobuf.ByteString value)
    Create a ContainsValueRequest.
    static com.oracle.coherence.grpc.DestroyRequest
    destroy(String scope, String cacheName)
    Create a DestroyRequest.
    static com.oracle.coherence.grpc.EntrySetRequest
    entrySet(String scope, String cacheName, String format, com.google.protobuf.ByteString filter)
    Create an EntrySetRequest.
    static com.oracle.coherence.grpc.EntrySetRequest
    entrySet(String scope, String cacheName, String format, com.google.protobuf.ByteString filter, com.google.protobuf.ByteString comparator)
    Create an EntrySetRequest.
    static com.oracle.coherence.grpc.GetRequest
    get(String scope, String cacheName, String format, com.google.protobuf.ByteString key)
    Create a GetRequest.
    static com.oracle.coherence.grpc.GetAllRequest
    getAll(String scope, String cacheName, String format, Iterable<com.google.protobuf.ByteString> keys)
    Create a GetAllRequest.
    static com.oracle.coherence.grpc.MapListenerRequest
    initListenerChannel(String scope, String cacheName, String format)
    Create a MapListenerRequest that will initialise the bidirectional channel.
    static com.oracle.coherence.grpc.InvokeRequest
    invoke(String scope, String cacheName, String format, com.google.protobuf.ByteString key, com.google.protobuf.ByteString processor)
    Create a InvokeRequest.
    static com.oracle.coherence.grpc.InvokeAllRequest
    invokeAll(String scope, String cacheName, String format, com.google.protobuf.ByteString filter, com.google.protobuf.ByteString processor)
    Create a InvokeAllRequest.
    static com.oracle.coherence.grpc.InvokeAllRequest
    invokeAll(String scope, String cacheName, String format, Iterable<com.google.protobuf.ByteString> keys, com.google.protobuf.ByteString processor)
    Create a InvokeAllRequest.
    static com.oracle.coherence.grpc.IsEmptyRequest
    isEmpty(String scope, String cacheName)
    Create a IsEmptyRequest.
    static com.oracle.coherence.grpc.KeySetRequest
    keySet(String scope, String cacheName, String format, com.google.protobuf.ByteString filter)
    Create an KeySetRequest.
    static com.oracle.coherence.grpc.PageRequest
    page(String scope, String cacheName, String format, com.google.protobuf.ByteString cookie)
    Create a PageRequest.
    static com.oracle.coherence.grpc.PutRequest
    put(String scope, String cacheName, String format, com.google.protobuf.ByteString key, com.google.protobuf.ByteString value)
    Create a PutRequest.
    static com.oracle.coherence.grpc.PutRequest
    put(String scope, String cacheName, String format, com.google.protobuf.ByteString key, com.google.protobuf.ByteString value, long ttl)
    Create a PutRequest.
    static com.oracle.coherence.grpc.PutAllRequest
    putAll(String scope, String cacheName, String format, Iterable<com.oracle.coherence.grpc.Entry> entries)
    Create a PutAllRequest.
    static com.oracle.coherence.grpc.PutAllRequest
    putAll(String scope, String cacheName, String format, Iterable<com.oracle.coherence.grpc.Entry> entries, long cMillis)
    Create a PutAllRequest.
    static com.oracle.coherence.grpc.PutIfAbsentRequest
    putIfAbsent(String scope, String cacheName, String format, com.google.protobuf.ByteString key, com.google.protobuf.ByteString value)
    Create a PutIfAbsentRequest.
    static com.oracle.coherence.grpc.IsReadyRequest
    ready(String scope, String cacheName)
    Create a ClearRequest.
    static com.oracle.coherence.grpc.RemoveRequest
    remove(String scope, String cacheName, String format, com.google.protobuf.ByteString key)
    Create a RemoveRequest.
    static com.oracle.coherence.grpc.RemoveMappingRequest
    remove(String scope, String cacheName, String format, com.google.protobuf.ByteString key, com.google.protobuf.ByteString value)
    Create a RemoveMappingRequest.
    static com.oracle.coherence.grpc.MapListenerRequest
    removeFilterMapListener(String scope, String cacheName, String format, com.google.protobuf.ByteString filter, long filterId, boolean lite, boolean priming, com.google.protobuf.ByteString mapTrigger)
    Create a MapListenerRequest that will subscribe to MapEvents for all entries in a cache matching a filter.
    static com.oracle.coherence.grpc.RemoveIndexRequest
    removeIndex(String scope, String cacheName, String format, com.google.protobuf.ByteString extractor)
    Create a RemoveIndexRequest.
    static com.oracle.coherence.grpc.MapListenerRequest
    removeKeyMapListener(String scope, String cacheName, String format, com.google.protobuf.ByteString key, boolean priming, com.google.protobuf.ByteString mapTrigger)
    Create a MapListenerRequest that will subscribe to MapEvents for a single entry in a cache.
    static com.oracle.coherence.grpc.ReplaceRequest
    replace(String scope, String cacheName, String format, com.google.protobuf.ByteString key, com.google.protobuf.ByteString value)
    Create a ReplaceRequest.
    static com.oracle.coherence.grpc.ReplaceMappingRequest
    replace(String scope, String cacheName, String format, com.google.protobuf.ByteString key, com.google.protobuf.ByteString previousValue, com.google.protobuf.ByteString newValue)
    Create a ReplaceMappingRequest.
    static com.oracle.coherence.grpc.SizeRequest
    size(String scope, String cacheName)
    Create a SizeRequest.
    static com.oracle.coherence.grpc.TruncateRequest
    truncate(String scope, String cacheName)
    Create a TruncateRequest.
    static com.oracle.coherence.grpc.ValuesRequest
    values(String scope, String cacheName, String format, com.google.protobuf.ByteString filter)
    Create a ValuesRequest.
    static com.oracle.coherence.grpc.ValuesRequest
    values(String scope, String cacheName, String format, com.google.protobuf.ByteString filter, com.google.protobuf.ByteString comparator)
    Create a ValuesRequest.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • PROP_TLS_CLIENT_AUTH

      public static final String PROP_TLS_CLIENT_AUTH
      The system property that sets whether mutual TLS is enabled.
      See Also:

    • PROP_TLS_KEY

      public static final String PROP_TLS_KEY
      The system property that sets the location of the TLS key file.
      See Also:

    • PROP_TLS_KEYPASS

      public static final String PROP_TLS_KEYPASS
      The system property that sets the password for the TLS key file.
      See Also:

    • PROP_TLS_KEYPASS_URI

      public static final String PROP_TLS_KEYPASS_URI
      The system property that sets the URI of a file to read to obtain the password for the TLS key file.
      See Also:

    • PROP_TLS_CERT

      public static final String PROP_TLS_CERT
      The system property that sets the location of the TLS cert file.
      See Also:

    • PROP_TLS_CA

      public static final String PROP_TLS_CA
      The system property that sets the location of the TLS CA file.
      See Also:

    • PROP_CREDENTIALS

      public static final String PROP_CREDENTIALS
      The system property that sets the credentials type.
      See Also:

    • CREDENTIALS_INSECURE

      public static final String CREDENTIALS_INSECURE
      The value used for the PROP_CREDENTIALS system property to indicate an insecure server.
      See Also:

    • CREDENTIALS_TLS

      public static final String CREDENTIALS_TLS
      The value used for the PROP_CREDENTIALS system property to indicate the server should use TLS.
      See Also:

    • CREDENTIALS_PLAINTEXT

      public static final String CREDENTIALS_PLAINTEXT
      The credentials to use to connect to a non-TLS enabled server.
      See Also:

  • Method Details

    • addIndex

      public static com.oracle.coherence.grpc.AddIndexRequest addIndex(String scope, String cacheName, String format, com.google.protobuf.ByteString extractor)
      Create a AddIndexRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache
      format - the serialization format used
      extractor - the serialized ValueExtractor to use to create the index
      Returns:
      a AddIndexRequest

    • addIndex

      public static com.oracle.coherence.grpc.AddIndexRequest addIndex(String scope, String cacheName, String format, com.google.protobuf.ByteString extractor, boolean sorted)
      Create a AddIndexRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache
      format - the serialization format used
      extractor - the serialized ValueExtractor to use to create the index
      sorted - a flag indicating whether the index will be sorted
      Returns:
      a AddIndexRequest

    • addIndex

      public static com.oracle.coherence.grpc.AddIndexRequest addIndex(String scope, String cacheName, String format, com.google.protobuf.ByteString extractor, boolean sorted, com.google.protobuf.ByteString comparator)
      Create a AddIndexRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache
      format - the serialization format used
      extractor - the serialized ValueExtractor to use to create the index
      sorted - a flag indicating whether the index will be sorted
      comparator - an optional serialized Comparator to use to sort the index
      Returns:
      a AddIndexRequest

    • initListenerChannel

      public static com.oracle.coherence.grpc.MapListenerRequest initListenerChannel(String scope, String cacheName, String format)
      Create a MapListenerRequest that will initialise the bidirectional channel.

      After this request has been sent the response observer will receive responses if the underlying cache is released on the proxy, destroyed or truncated.

      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache
      format - the serialization format used
      Returns:
      an MapListenerRequest that will subscribe to MapEvents for all entries in a cache

    • addKeyMapListener

      public static com.oracle.coherence.grpc.MapListenerRequest addKeyMapListener(String scope, String cacheName, String format, com.google.protobuf.ByteString key, boolean lite, boolean priming, com.google.protobuf.ByteString mapTrigger)
      Create a MapListenerRequest that will subscribe to MapEvents for a single entry in a cache.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache
      format - the serialization format used
      key - the serialized key that identifies the entry for which to raise events
      lite - true to indicate that the MapEvent objects do not have to include the OldValue and NewValue property values in order to allow optimizations
      priming - a flag set to
      invalid @link 
      {@link true
      } to indicate that this is a priming listener
      mapTrigger - an optional serialized MapTrigger
      Returns:
      an MapListenerRequest that will subscribe to MapEvents for all entries in a cache

    • addFilterMapListener

      public static com.oracle.coherence.grpc.MapListenerRequest addFilterMapListener(String scope, String cacheName, String format, com.google.protobuf.ByteString filter, long filterId, boolean lite, boolean priming, com.google.protobuf.ByteString mapTrigger)
      Create a MapListenerRequest that will subscribe to MapEvents for all entries in a cache matching a filter.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache
      format - the serialization format used
      filter - the serialized filter that identifies the entries for which to raise events
      filterId - a unique identifier to identify this filter to the client
      lite - true to indicate that the MapEvent objects do not have to include the OldValue and NewValue property values in order to allow optimizations
      priming - a flag set to
      invalid @link 
      {@link true
      } to indicate that this is a priming listener
      mapTrigger - an optional serialized MapTrigger
      Returns:
      an MapListenerRequest that will subscribe to MapEvents for all entries in a cache

    • aggregate

      public static com.oracle.coherence.grpc.AggregateRequest aggregate(String scope, String cacheName, String format, com.google.protobuf.ByteString filter, com.google.protobuf.ByteString aggregator)
      Create a AggregateRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache to clear
      format - the serialization format used
      filter - the serialized Filter or ByteString.EMPTY to represent an AlwaysFilter
      aggregator - the serialized InvocableMap.EntryAggregator
      Returns:
      a AggregateRequest

    • aggregate

      public static com.oracle.coherence.grpc.AggregateRequest aggregate(String scope, String cacheName, String format, Iterable<com.google.protobuf.ByteString> keys, com.google.protobuf.ByteString aggregator)
      Create a AggregateRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache to clear
      format - the serialization format used
      keys - the serialized entry keys
      aggregator - the serialized InvocableMap.EntryAggregator
      Returns:
      a AggregateRequest

    • clear

      public static com.oracle.coherence.grpc.ClearRequest clear(String scope, String cacheName)
      Create a ClearRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache to clear
      Returns:
      a ClearRequest

    • containsEntry

      public static com.oracle.coherence.grpc.ContainsEntryRequest containsEntry(String scope, String cacheName, String format, com.google.protobuf.ByteString key, com.google.protobuf.ByteString value)
      Create a ContainsEntryRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache to check
      format - the serialization format used
      key - the key of the entry to check if the mapping exists
      value - the value of the entry to check if the mapping exists
      Returns:
      a ContainsEntryRequest

    • containsKey

      public static com.oracle.coherence.grpc.ContainsKeyRequest containsKey(String scope, String cacheName, String format, com.google.protobuf.ByteString key)
      Create a ClearRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache to clear
      format - the serialization format used
      key - the key of the entry to check if the mapping exists
      Returns:
      a ContainsKeyRequest

    • containsValue

      public static com.oracle.coherence.grpc.ContainsValueRequest containsValue(String scope, String cacheName, String format, com.google.protobuf.ByteString value)
      Create a ContainsValueRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache to check
      format - the serialization format used
      value - the value of the entry to check if the mapping exists
      Returns:
      a ContainsValueRequest

    • destroy

      public static com.oracle.coherence.grpc.DestroyRequest destroy(String scope, String cacheName)
      Create a DestroyRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache
      Returns:
      a DestroyRequest

    • entrySet

      public static com.oracle.coherence.grpc.EntrySetRequest entrySet(String scope, String cacheName, String format, com.google.protobuf.ByteString filter)
      Create an EntrySetRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache
      format - the serialization format used
      filter - the serialized Filter
      Returns:
      an EntrySetRequest

    • entrySet

      public static com.oracle.coherence.grpc.EntrySetRequest entrySet(String scope, String cacheName, String format, com.google.protobuf.ByteString filter, com.google.protobuf.ByteString comparator)
      Create an EntrySetRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache
      format - the serialization format used
      filter - the serialized Filter
      comparator - the serialized Comparator
      Returns:
      an EntrySetRequest

    • get

      public static com.oracle.coherence.grpc.GetRequest get(String scope, String cacheName, String format, com.google.protobuf.ByteString key)
      Create a GetRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache to clear
      format - the serialization format used
      key - the key of the entry to get the value for
      Returns:
      a GetRequest

    • getAll

      public static com.oracle.coherence.grpc.GetAllRequest getAll(String scope, String cacheName, String format, Iterable<com.google.protobuf.ByteString> keys)
      Create a GetAllRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache to clear
      format - the serialization format used
      keys - the keys of the entries to get the values for
      Returns:
      a GetAllRequest

    • invoke

      public static com.oracle.coherence.grpc.InvokeRequest invoke(String scope, String cacheName, String format, com.google.protobuf.ByteString key, com.google.protobuf.ByteString processor)
      Create a InvokeRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache to clear
      format - the serialization format used
      key - the serialized key of the entry to invoke the entry processor against
      processor - the serialized entry processor
      Returns:
      a InvokeRequest

    • invokeAll

      public static com.oracle.coherence.grpc.InvokeAllRequest invokeAll(String scope, String cacheName, String format, Iterable<com.google.protobuf.ByteString> keys, com.google.protobuf.ByteString processor)
      Create a InvokeAllRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache to clear
      format - the serialization format used
      keys - the serialized keys of the entries to invoke the entry processor against
      processor - the serialized entry processor
      Returns:
      a InvokeAllRequest

    • invokeAll

      public static com.oracle.coherence.grpc.InvokeAllRequest invokeAll(String scope, String cacheName, String format, com.google.protobuf.ByteString filter, com.google.protobuf.ByteString processor)
      Create a InvokeAllRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache to clear
      format - the serialization format used
      filter - the serialized filter to identify of the entries to invoke the entry processor against
      processor - the serialized entry processor
      Returns:
      a InvokeAllRequest

    • isEmpty

      public static com.oracle.coherence.grpc.IsEmptyRequest isEmpty(String scope, String cacheName)
      Create a IsEmptyRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache to clear
      Returns:
      a IsEmptyRequest

    • keySet

      public static com.oracle.coherence.grpc.KeySetRequest keySet(String scope, String cacheName, String format, com.google.protobuf.ByteString filter)
      Create an KeySetRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache
      format - the serialization format used
      filter - the serialized Filter
      Returns:
      an KeySetRequest

    • page

      public static com.oracle.coherence.grpc.PageRequest page(String scope, String cacheName, String format, com.google.protobuf.ByteString cookie)
      Create a PageRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache
      format - the serialization format used
      cookie - the opaque cookie used to track the page being requested
      Returns:
      a PageRequest

    • put

      public static com.oracle.coherence.grpc.PutRequest put(String scope, String cacheName, String format, com.google.protobuf.ByteString key, com.google.protobuf.ByteString value)
      Create a PutRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache to put the value into
      format - the serialization format used
      key - the key of the entry to update
      value - the value to map to the key in the cache
      Returns:
      a PutRequest to update the value mapped to a key in a cache

    • put

      public static com.oracle.coherence.grpc.PutRequest put(String scope, String cacheName, String format, com.google.protobuf.ByteString key, com.google.protobuf.ByteString value, long ttl)
      Create a PutRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache to put the value into
      format - the serialization format used
      key - the key of the entry to update
      value - the value to map to the key in the cache
      ttl - the time to live for the cache entry
      Returns:
      a PutRequest to update the value mapped to a key in a cache

    • putAll

      public static com.oracle.coherence.grpc.PutAllRequest putAll(String scope, String cacheName, String format, Iterable<com.oracle.coherence.grpc.Entry> entries)
      Create a PutAllRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache to put the values into
      format - the serialization format used
      entries - the entries to put into the cache
      Returns:
      a PutAllRequest

    • putAll

      public static com.oracle.coherence.grpc.PutAllRequest putAll(String scope, String cacheName, String format, Iterable<com.oracle.coherence.grpc.Entry> entries, long cMillis)
      Create a PutAllRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache to put the values into
      format - the serialization format used
      entries - the entries to put into the cache
      cMillis - the expiry delay to apply to the entries
      Returns:
      a PutAllRequest

    • putIfAbsent

      public static com.oracle.coherence.grpc.PutIfAbsentRequest putIfAbsent(String scope, String cacheName, String format, com.google.protobuf.ByteString key, com.google.protobuf.ByteString value)
      Create a PutIfAbsentRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache to put the value into
      format - the serialization format used
      key - the key of the entry to update
      value - the value to map to the key in the cache
      Returns:
      a PutIfAbsentRequest to update the value mapped to a key in a cache if no mapping exists for the key

    • ready

      public static com.oracle.coherence.grpc.IsReadyRequest ready(String scope, String cacheName)
      Create a ClearRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache to clear
      Returns:
      a ClearRequest
      Since:
      14.1.1.2206.5

    • remove

      public static com.oracle.coherence.grpc.RemoveRequest remove(String scope, String cacheName, String format, com.google.protobuf.ByteString key)
      Create a RemoveRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache to remove the value
      format - the serialization format used
      key - the key of the entry to remove
      Returns:
      a RemoveRequest to update the value mapped to a key in a cache if no mapping exists for the key

    • remove

      public static com.oracle.coherence.grpc.RemoveMappingRequest remove(String scope, String cacheName, String format, com.google.protobuf.ByteString key, com.google.protobuf.ByteString value)
      Create a RemoveMappingRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache to remove the mapping
      format - the serialization format used
      key - the key of the entry to remove
      value - the value of the existing mapping
      Returns:
      a RemoveMappingRequest to update the value mapped to a key in a cache if no mapping exists for the key

    • removeIndex

      public static com.oracle.coherence.grpc.RemoveIndexRequest removeIndex(String scope, String cacheName, String format, com.google.protobuf.ByteString extractor)
      Create a RemoveIndexRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache
      format - the serialization format used
      extractor - the serialized ValueExtractor to use to remove the index
      Returns:
      a RemoveIndexRequest

    • removeKeyMapListener

      public static com.oracle.coherence.grpc.MapListenerRequest removeKeyMapListener(String scope, String cacheName, String format, com.google.protobuf.ByteString key, boolean priming, com.google.protobuf.ByteString mapTrigger)
      Create a MapListenerRequest that will subscribe to MapEvents for a single entry in a cache.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache
      format - the serialization format used
      key - the serialized key that identifies the entry for which to raise events
      priming - a flag set to
      invalid @link 
      {@link true
      } to indicate that this is a priming listener
      mapTrigger - an optional serialized MapTrigger
      Returns:
      an MapListenerRequest that will subscribe to MapEvents for all entries in a cache

    • removeFilterMapListener

      public static com.oracle.coherence.grpc.MapListenerRequest removeFilterMapListener(String scope, String cacheName, String format, com.google.protobuf.ByteString filter, long filterId, boolean lite, boolean priming, com.google.protobuf.ByteString mapTrigger)
      Create a MapListenerRequest that will subscribe to MapEvents for all entries in a cache matching a filter.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache
      format - the serialization format used
      filter - the serialized filter that identifies the entries for which to raise events
      filterId - a unique identifier to identify this filter to the client
      lite - true to indicate that the MapEvent objects do not have to include the OldValue and NewValue property values in order to allow optimizations
      priming - a flag set to
      invalid @link 
      {@link true
      } to indicate that this is a priming listener
      mapTrigger - an optional serialized MapTrigger
      Returns:
      an MapListenerRequest that will subscribe to MapEvents for all entries in a cache

    • replace

      public static com.oracle.coherence.grpc.ReplaceRequest replace(String scope, String cacheName, String format, com.google.protobuf.ByteString key, com.google.protobuf.ByteString value)
      Create a ReplaceRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache to remove the mapping
      format - the serialization format used
      key - the key of the entry to remove
      value - the value of the new mapping
      Returns:
      a ReplaceRequestto update the value mapped to a key in a cache if no mapping exists for the key

    • replace

      public static com.oracle.coherence.grpc.ReplaceMappingRequest replace(String scope, String cacheName, String format, com.google.protobuf.ByteString key, com.google.protobuf.ByteString previousValue, com.google.protobuf.ByteString newValue)
      Create a ReplaceMappingRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache to remove the mapping
      format - the serialization format used
      key - the key of the entry to remove
      previousValue - the value of the existing mapping
      newValue - the new value of the new mapping
      Returns:
      a ReplaceMappingRequest to update the value mapped to a key in a cache if no mapping exists for the key

    • size

      public static com.oracle.coherence.grpc.SizeRequest size(String scope, String cacheName)
      Create a SizeRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache to clear
      Returns:
      a SizeRequest

    • truncate

      public static com.oracle.coherence.grpc.TruncateRequest truncate(String scope, String cacheName)
      Create a TruncateRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache
      Returns:
      a TruncateRequest

    • values

      public static com.oracle.coherence.grpc.ValuesRequest values(String scope, String cacheName, String format, com.google.protobuf.ByteString filter)
      Create a ValuesRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache
      format - the serialization format used
      filter - the serialized Filter
      Returns:
      an ValuesRequest

    • values

      public static com.oracle.coherence.grpc.ValuesRequest values(String scope, String cacheName, String format, com.google.protobuf.ByteString filter, com.google.protobuf.ByteString comparator)
      Create a ValuesRequest.
      Parameters:
      scope - the scope name to use to obtain the cache from.
      cacheName - the name of the cache
      format - the serialization format used
      filter - the serialized Filter
      comparator - the serialized Comparator
      Returns:
      an ValuesRequest