Package com.google.cloud.storage

Class Storage.BlobSourceOption

java.lang.Object
com.google.cloud.storage.Option<com.google.cloud.storage.UnifiedOpts.ObjectSourceOpt>
com.google.cloud.storage.Storage.BlobSourceOption
All Implemented Interfaces:
Serializable
Enclosing interface:
Storage
public static class Storage.BlobSourceOption extends Option<com.google.cloud.storage.UnifiedOpts.ObjectSourceOpt>
Class for specifying blob source options.
See Also:

  • Method Details

    • generationMatch

      @TransportCompatibility({HTTP,GRPC}) public static Storage.BlobSourceOption generationMatch()
      Returns an option for blob's data generation match. If this option is used the request will fail if blob's generation does not match. The generation value to compare with the actual blob's generation is taken from a source BlobId object. When this option is passed to a Storage method and BlobId.getGeneration() is null or no BlobId is provided an exception is thrown.

    • generationMatch

      @TransportCompatibility({HTTP,GRPC}) public static Storage.BlobSourceOption generationMatch(long generation)
      Returns an option for blob's data generation match. If this option is used the request will fail if blob's generation does not match the provided value.

    • generationNotMatch

      @Deprecated @TransportCompatibility({HTTP,GRPC}) public static Storage.BlobSourceOption generationNotMatch()
      Deprecated.
      This option is invalid, and can never result in a valid response from the server. use generationNotMatch(long) instead.
      Returns an option for blob's data generation mismatch. If this option is used the request will fail if blob's generation matches. The generation value to compare with the actual blob's generation is taken from a source BlobId object. When this option is passed to a Storage method and BlobId.getGeneration() is null or no BlobId is provided an exception is thrown.

    • generationNotMatch

      @TransportCompatibility({HTTP,GRPC}) public static Storage.BlobSourceOption generationNotMatch(long generation)
      Returns an option for blob's data generation mismatch. If this option is used the request will fail if blob's generation matches the provided value.

    • metagenerationMatch

      @TransportCompatibility({HTTP,GRPC}) public static Storage.BlobSourceOption metagenerationMatch(long metageneration)
      Returns an option for blob's metageneration match. If this option is used the request will fail if blob's metageneration does not match the provided value.

    • metagenerationNotMatch

      @TransportCompatibility({HTTP,GRPC}) public static Storage.BlobSourceOption metagenerationNotMatch(long metageneration)
      Returns an option for blob's metageneration mismatch. If this option is used the request will fail if blob's metageneration matches the provided value.

    • decryptionKey

      @TransportCompatibility({HTTP,GRPC}) public static Storage.BlobSourceOption decryptionKey(@NonNull Key key)
      Returns an option to set a customer-supplied AES256 key for server-side encryption of the blob.

    • decryptionKey

      @TransportCompatibility({HTTP,GRPC}) public static Storage.BlobSourceOption decryptionKey(@NonNull String key)
      Returns an option to set a customer-supplied AES256 key for server-side encryption of the blob.
      Parameters:
      key - the AES256 encoded in base64

    • userProject

      @TransportCompatibility({HTTP,GRPC}) public static Storage.BlobSourceOption userProject(@NonNull String userProject)
      Returns an option for blob's billing user project. This option is only used by the buckets with 'requester_pays' flag.

    • shouldReturnRawInputStream

      @TransportCompatibility({HTTP,GRPC}) public static Storage.BlobSourceOption shouldReturnRawInputStream(boolean shouldReturnRawInputStream)
      Returns an option for whether the request should return the raw input stream, instead of automatically decompressing the content. By default, this is false for Blob.downloadTo(), but true for ReadChannel.read().

    • extraHeaders

      @TransportCompatibility({HTTP,GRPC}) public static Storage.BlobSourceOption extraHeaders(@NonNull com.google.common.collect.ImmutableMap<String,String> extraHeaders)
      A set of extra headers to be set for all requests performed within the scope of the operation this option is passed to (a get, read, resumable upload etc).

      If the same header name is specified across multiple options provided to a method, the first occurrence will be the value included in the request(s).

      The following headers are not allowed to be specified, and will result in an IllegalArgumentException.

      1. Accept-Encoding
      2. Cache-Control
      3. Connection
      4. Content-ID
      5. Content-Length
      6. Content-Range
      7. Content-Transfer-Encoding
      8. Content-Type
      9. Date
      10. ETag
      11. If-Match
      12. If-None-Match
      13. Keep-Alive
      14. Range
      15. TE
      16. Trailer
      17. Transfer-Encoding
      18. User-Agent
      19. X-Goog-Api-Client
      20. X-Goog-Content-Length-Range
      21. X-Goog-Copy-Source-Encryption-Algorithm
      22. X-Goog-Copy-Source-Encryption-Key
      23. X-Goog-Copy-Source-Encryption-Key-Sha256
      24. X-Goog-Encryption-Algorithm
      25. X-Goog-Encryption-Key
      26. X-Goog-Encryption-Key-Sha256
      27. X-Goog-Gcs-Idempotency-Token
      28. X-Goog-Meta-*
      29. X-Goog-User-Project
      30. X-HTTP-Method-Override
      31. X-Upload-Content-Length
      32. X-Upload-Content-Type
      Since:
      2.49.0

    • dedupe

      public static Storage.BlobSourceOption[] dedupe(Storage.BlobSourceOption... os)
      Deduplicate any options which are the same parameter. The value which comes last in os will be the value included in the return.

    • dedupe

      public static Storage.BlobSourceOption[] dedupe(Collection<Storage.BlobSourceOption> collection, Storage.BlobSourceOption... os)
      Deduplicate any options which are the same parameter.

      The value which comes last in collection and os will be the value included in the return. All options from os will override their counterparts in collection.

    • dedupe

      public static Storage.BlobSourceOption[] dedupe(Storage.BlobSourceOption[] array, Storage.BlobSourceOption... os)
      Deduplicate any options which are the same parameter.

      The value which comes last in collection and os will be the value included in the return. All options from os will override their counterparts in collection.

    • equals

      public boolean equals(Object o)
      Deprecated.
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Deprecated.
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class Object