chore: Refactor object filter options and remove specific helpers

Author: nidhiii-27

google-cloud-storage/src/main/java/com/google/cloud/storage/Storage.java

@@ -2748,59 +2748,13 @@ public static BlobListOption softDeleted(boolean softDeleted) {
  }
 
  /**
- * Returns an option to filter list results to objects that have a context with the specified
- * key and value.
+ * Returns an option to filter list results based on object attributes, such as object contexts.
  *
- * @param key The context key to match.
- * @param value The context value to match.
+ * @param filter The filter string.
  */
  @TransportCompatibility({Transport.HTTP, Transport.GRPC})
- public static BlobListOption withContext(@NonNull String key, @NonNull String value) {
- requireNonNull(key, "Key must be non null");
- requireNonNull(value, "Value must be non null");
- String filter = String.format("contexts.\"%s\"=\"%s\"", key, value);
- return new BlobListOption(UnifiedOpts.objectContextsFilter(filter));
- }
-
- /**
- * Returns an option to filter list results to objects that DO NOT have a context with the
- * specified key and value.
- *
- * @param key The context key to check.
- * @param value The context value to check.
- */
- @TransportCompatibility({Transport.HTTP, Transport.GRPC})
- public static BlobListOption withoutContext(@NonNull String key, @NonNull String value) {
- requireNonNull(key, "Key must be non null");
- requireNonNull(value, "Value must be non null");
- String filter = String.format("NOT contexts.\"%s\"=\"%s\"", key, value);
- return new BlobListOption(UnifiedOpts.objectContextsFilter(filter));
- }
-
- /**
- * Returns an option to filter list results to objects that have a context with the specified
- * key, regardless of its value.
- *
- * @param key The context key to check for presence.
- */
- @TransportCompatibility({Transport.HTTP, Transport.GRPC})
- public static BlobListOption withContextKey(@NonNull String key) {
- requireNonNull(key, "Key must be non null");
- String filter = String.format("contexts.\"%s\":*", key);
- return new BlobListOption(UnifiedOpts.objectContextsFilter(filter));
- }
-
- /**
- * Returns an option to filter list results to objects that DO NOT have a context with the
- * specified key.
- *
- * @param key The context key to check for absence.
- */
- @TransportCompatibility({Transport.HTTP, Transport.GRPC})
- public static BlobListOption withoutContextKey(@NonNull String key) {
- requireNonNull(key, "Key must be non null");
- String filter = String.format("NOT contexts.\"%s\":*", key);
- return new BlobListOption(UnifiedOpts.objectContextsFilter(filter));
+ public static BlobListOption filter(String filter) {
+ return new BlobListOption(UnifiedOpts.objectFilter(filter));
  }
 
  /**

google-cloud-storage/src/main/java/com/google/cloud/storage/UnifiedOpts.java

@@ -581,8 +581,8 @@ static Md5MatchExtractor md5MatchExtractor() {
  return Md5MatchExtractor.INSTANCE;
  }
 
- static ObjectContextsFilter objectContextsFilter(String filter) {
- return new ObjectContextsFilter(filter);
+ static ObjectFilter objectFilter(String filter) {
+ return new ObjectFilter(filter);
  }
 
  static Headers extraHeaders(ImmutableMap<String, String> extraHeaders) {
@@ -2506,11 +2506,11 @@ private Object readResolve() {
  }
  }
 
- static final class ObjectContextsFilter extends RpcOptVal<String> implements ObjectListOpt {
+ static final class ObjectFilter extends RpcOptVal<String> implements ObjectListOpt {
  private static final long serialVersionUID = -892748218491324843L;
 
- private ObjectContextsFilter(String val) {
- super(StorageRpc.Option.OBJECT_CONTEXTS_FILTER, val);
+ private ObjectFilter(String val) {
+ super(StorageRpc.Option.OBJECT_FILTER, val);
  }
 
  @Override

google-cloud-storage/src/main/java/com/google/cloud/storage/spi/v1/HttpStorageRpc.java

@@ -498,7 +498,7 @@ public Tuple<String, Iterable<StorageObject>> list(final String bucket, Map<Opti
  .setSoftDeleted(Option.SOFT_DELETED.getBoolean(options))
  .setIncludeFoldersAsPrefixes(Option.INCLUDE_FOLDERS_AS_PREFIXES.getBoolean(options))
  .setIncludeTrailingDelimiter(Option.INCLUDE_TRAILING_DELIMITER.getBoolean(options))
- .setFilter(Option.OBJECT_CONTEXTS_FILTER.getString(options));
+ .setFilter(Option.OBJECT_FILTER.getString(options));
  setExtraHeaders(list, options);
  Objects objects = list.execute();
  Iterable<StorageObject> storageObjects =

google-cloud-storage/src/main/java/com/google/cloud/storage/spi/v1/StorageRpc.java

@@ -80,7 +80,7 @@ enum Option {
  INCLUDE_FOLDERS_AS_PREFIXES("includeFoldersAsPrefixes"),
  INCLUDE_TRAILING_DELIMITER("includeTrailingDelimiter"),
  X_UPLOAD_CONTENT_LENGTH("x-upload-content-length"),
- OBJECT_CONTEXTS_FILTER("objectContextsFilter"),
+ OBJECT_FILTER("objectFilter"),
  /**
  * An {@link com.google.common.collect.ImmutableMap ImmutableMap<String, String>} of values
  * which will be set as additional headers on the request.

samples/install-without-bom/pom.xml

@@ -30,20 +30,12 @@
  <dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-storage</artifactId>
-<<<<<<< HEAD
- <version>2.56.0</version>
-=======
- <version>2.55.1-SNAPSHOT</version>
->>>>>>> 6ded0abe (Add storage_set_object_contexts, storage_get_object_contexts and storage_list_object_contexts samples)
+ <version>2.56.1-SNAPSHOT</version>
  </dependency>
  <dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-storage-control</artifactId>
-<<<<<<< HEAD
- <version>2.56.0</version>
-=======
- <version>2.55.1-SNAPSHOT</version>
->>>>>>> 6ded0abe (Add storage_set_object_contexts, storage_get_object_contexts and storage_list_object_contexts samples)
+ <version>2.56.1-SNAPSHOT</version>
  </dependency>
  <!-- [END storage_install_without_bom] -->
 

samples/snippets/pom.xml

@@ -100,11 +100,7 @@
  <!-- tests jars aren't in the bom, manually include the version here -->
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-storage</artifactId>
-<<<<<<< HEAD
- <version>2.56.0</version>
-=======
- <version>2.55.1-SNAPSHOT</version>
->>>>>>> 6ded0abe (Add storage_set_object_contexts, storage_get_object_contexts and storage_list_object_contexts samples)
+ <version>2.56.1-SNAPSHOT</version>
  <classifier>tests</classifier>
  <scope>test</scope>
  </dependency>

samples/snippets/src/main/java/com/example/storage/object/ListObjectsWithContexts.java

@@ -41,8 +41,8 @@ public static void listObjectsWithContexts(
  // String contextValue = "context-value-to-filter";
 
  Storage storage = StorageOptions.newBuilder().setProjectId(projectId).build().getService();
- Page<Blob> blobs =
-  storage.list(bucketName, Storage.BlobListOption.withContext(contextKey, contextValue));
+ String filter = String.format("contexts.\"%s\"=\"%s\"", contextKey, contextValue);
+ Page<Blob> blobs = storage.list(bucketName, Storage.BlobListOption.filter(filter));
 
  System.out.println(
  String.format(