Package com.google.cloud.storage

Class Storage.BlobGetOption

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

  • Method Details

    • generationMatch

      @TransportCompatibility({HTTP,GRPC}) public static Storage.BlobGetOption 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.BlobGetOption 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.BlobGetOption 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.BlobGetOption 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.BlobGetOption 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.BlobGetOption 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.

    • fields

      @TransportCompatibility({HTTP,GRPC}) public static Storage.BlobGetOption fields(Storage.BlobField... fields)
      Returns an option to specify the blob's fields to be returned by the RPC call. If this option is not provided all blob's fields are returned. BlobGetOption.fields) can be used to specify only the fields of interest. Blob name and bucket are always returned, even if not specified.

    • userProject

      @TransportCompatibility({HTTP,GRPC}) public static Storage.BlobGetOption 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.

    • decryptionKey

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

    • decryptionKey

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

    • shouldReturnRawInputStream

      @TransportCompatibility({HTTP,GRPC}) public static Storage.BlobGetOption 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().

    • softDeleted

      @TransportCompatibility({HTTP,GRPC}) public static Storage.BlobGetOption softDeleted(boolean softDeleted)
      Returns an option for whether the request should return a soft-deleted object. If an object has been soft-deleted (Deleted while a Soft Delete Policy) is in place, this must be true or the request will return null.

    • dedupe

      public static Storage.BlobGetOption[] dedupe(Storage.BlobGetOption... 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.BlobGetOption[] dedupe(Collection<Storage.BlobGetOption> collection, Storage.BlobGetOption... 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.BlobGetOption[] dedupe(Storage.BlobGetOption[] array, Storage.BlobGetOption... 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