Method: googleapis.storage.v1.objects.get

Note: You should URL-encode object names to be path safe. You can use the url_encode and url_encode_plus functions to encode applicable characters when they appear in either the object name or query string of a request URL. If you don't url-encode your object name and your storage bucket has folders, the request will fail. For more information, see Encoding URL path parts and Cloud Storage naming considerations.

Note that Workflows supports a number of library functions for data type and format conversions. For example, if you specify alt=media as the response data format, you can use the text.decode function to decode data in bytes to string.

Retrieves an object or its metadata.

Arguments

Parameters
bucket	string Required. Name of the bucket in which the object resides.
object	string Required. Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
generation	string (int64 format) If present, selects a specific revision of this object (as opposed to the latest version, the default).
ifGenerationMatch	string (int64 format) Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
ifGenerationNotMatch	string (int64 format) Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
ifMetagenerationMatch	string (int64 format) Makes the operation conditional on whether the object's current metageneration matches the given value.
ifMetagenerationNotMatch	string (int64 format) Makes the operation conditional on whether the object's current metageneration does not match the given value.
projection	enum Set of properties to return. Defaults to noAcl.
Enum type. Can be one of the following:
full	Include all properties.
noAcl	Omit the owner, acl property.
userProject	string The project to be billed for this request. Required for Requester Pays buckets.
alt	enum Data format for the response.
Enum type. Can be one of the following:
json	Responses with Content-Type of application/json
media	Return object data.

Raised exceptions

Exceptions
ConnectionError	In case of a network problem (such as DNS failure or refused connection).
HttpError	If the response status is >= 400 (excluding 429 and 503).
TimeoutError	If a long-running operation takes longer to finish than the specified timeout limit.
TypeError	If an operation or function receives an argument of the wrong type.
ValueError	If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of Object.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

- get:
    call: googleapis.storage.v1.objects.get
    args:
      bucket: "BUCKET_NAME"
      # Encode object name using `text.url_encode`
      # to ensure it is path safe
      object: '${text.url_encode("file 1.txt")}'
      alt: "json" # optional, retrieves metadata
      # Use `alt: "media"` to retrieve the object
    result: getResult
- return_result:
    return: ${getResult}