Retrieves an object or its metadata.

Scopes

You will need authorization for at least one of the following scopes to make a valid call:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/devstorage.full_control
  • https://www.googleapis.com/auth/devstorage.read_only
  • https://www.googleapis.com/auth/devstorage.read_write

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: storage1 --scope <scope> objects get ...

Required Scalar Arguments

  • <bucket> (string)
    • Name of the bucket in which the object resides.
  • <object> (string)
    • Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

As this method supports media download, you may specify the -p alt=media flag to set the output to be an octet stream of the underlying media. In that case, you will not receive JSON output anymore.

  • -o out
    • out specifies the destination to which to write the server's result to. It will either be a JSON-encoded structure, or the media file you are downloading. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p generation=string

    • If present, selects a specific revision of this object (as opposed to the latest version, the default).

  • -p if-generation-match=string

    • 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.

  • -p if-generation-not-match=string

    • 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.

  • -p if-metageneration-match=string

    • Makes the operation conditional on whether the object's current metageneration matches the given value.

  • -p if-metageneration-not-match=string

    • Makes the operation conditional on whether the object's current metageneration does not match the given value.

  • -p projection=string

    • Set of properties to return. Defaults to noAcl.

  • -p soft-deleted=boolean

    • If true, only soft-deleted object versions will be listed. The default is false. For more information, see Soft Delete.

  • -p user-project=string

    • The project to be billed for this request. Required for Requester Pays buckets.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p alt=string

    • Data format for the response.

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • -p upload-type=string

    • Upload protocol for media (e.g. "media", "multipart", "resumable").

  • -p user-ip=string

    • Deprecated. Please use quotaUser instead.