Global

The Acl Objects.

The full API response.

The new rules will be appended to any pre-existing rules.

Whether the Bucket exists.

Resource name of the Cloud KMS key, of the form projects/my-project/locations/location/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overwrites the object metadata's kms_key_name value, if any.

The ID of the project which will be billed for the request.

The new File.

The full API response.

Resource name of the Cloud KMS key, of the form projects/my-project/locations/location/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overwrites the object metadata's kms_key_name value, if any.

Set the ACL for the new file.

A previously-returned rewriteToken from an unfinished rewrite request.

The ID of the project which will be billed for the request.

The copied File.

The full API response.

Specify the storage class as Archive.

Specify the storage class as Coldline.

Specify the CORS configuration to use.

Specify the storage class as Durable Reduced Availability.

Specify the storage class as Multi-Regional.

Specify the storage class as Nearline.

Specify the storage class as Regional.

Early Access Testers Only Force the use of the User Project metadata field to assign operational costs when an operation is made on a Bucket and its objects.

Specify the storage class as Standard.

Specify the versioning status.

The ID of the project which will be billed for the request.

The new Bucket.

The full API response.

The address where notifications are delivered for this channel.

The ID of the project which will be billed for the request.

The new Channel.

The full API response.

The project ID of the project that owns the service account of the requested HMAC key. If not provided, the project ID used to instantiate the Storage client will be used.

This parameter is currently ignored.

The HmacKey instance created from API response.

The HMAC key's secret used to access the XML API.

The raw API response.

An optional list of additional attributes to attach to each Cloud PubSub message published for this notification subscription.

If present, only send notifications about listed event types. If empty, sent notifications for all event types.

If present, only apply this notification configuration to object names that begin with this prefix.

The desired content of the Payload. Defaults to JSON_API_V1.

Acceptable values are:
- `JSON_API_V1`

- `NONE`

The ID of the project which will be billed for the request.

The new Notification.

The full API response.

The ID of the project which will be billed for the request.

Possible values: "md5", "crc32c", or false. By default, data integrity is validated with a CRC32c checksum. You may use MD5 if preferred, but that hash is not supported for composite objects. An error will be raised if MD5 is specified but is not available. You may also choose to skip validation completely, however this is not recommended.

A byte offset to begin the file's download from. Default is 0. NOTE: Byte ranges are inclusive; that is, options.start = 0 and options.end = 999 represent the first 1000 bytes in a file or object. NOTE: when specifying a byte range, data integrity is not available.

A byte offset to stop reading the file at. NOTE: Byte ranges are inclusive; that is, options.start = 0 and options.end = 999 represent the first 1000 bytes in a file or object. NOTE: when specifying a byte range, data integrity is not available.

Disable auto decompression of the received data. By default this option is set to true. Applicable in cases where the data was uploaded with gzip: true option. See File#createWriteStream.

A full JSON file path to use with gcs-resumable-upload. This maps to the configstore option by the same name.

Metadata to set on the file.

Origin header to set for the upload.

Apply a predefined set of access controls to this object.

Acceptable values are:
- **`authenticatedRead`** - Object owner gets `OWNER` access, and
  `allAuthenticatedUsers` get `READER` access.

- **`bucketOwnerFullControl`** - Object owner gets `OWNER` access, and
  project team owners get `OWNER` access.

- **`bucketOwnerRead`** - Object owner gets `OWNER` access, and project
  team owners get `READER` access.

- **`private`** - Object owner gets `OWNER` access.

- **`projectPrivate`** - Object owner gets `OWNER` access, and project
  team members get access according to their roles.

- **`publicRead`** - Object owner gets `OWNER` access, and `allUsers`

get READER access.

Make the uploaded file private. (Alias for options.predefinedAcl = 'private')

Make the uploaded file public. (Alias for options.predefinedAcl = 'publicRead')

The ID of the project which will be billed for the request.

The resumable upload's unique session URI.

This only applies to resumable uploads. A full JSON file path to use with gcs-resumable-upload. This maps to the configstore option by the same name.

Alias for options.metadata.contentType. If set to auto, the file name is used to determine the contentType.

If true, automatically gzip the file. If set to auto, the contentType is used to determine if the file should be gzipped. This will set options.metadata.contentEncoding to gzip if necessary.

See the examples below or Objects: insert request body for more details.

The starting byte of the upload stream, for resuming an interrupted upload. Defaults to 0.

Apply a predefined set of access controls to this object.

Acceptable values are:
- **`authenticatedRead`** - Object owner gets `OWNER` access, and
  `allAuthenticatedUsers` get `READER` access.

- **`bucketOwnerFullControl`** - Object owner gets `OWNER` access, and
  project team owners get `OWNER` access.

- **`bucketOwnerRead`** - Object owner gets `OWNER` access, and project
  team owners get `READER` access.

- **`private`** - Object owner gets `OWNER` access.

- **`projectPrivate`** - Object owner gets `OWNER` access, and project
  team members get access according to their roles.

- **`publicRead`** - Object owner gets `OWNER` access, and `allUsers`

get READER access.

Make the uploaded file private. (Alias for options.predefinedAcl = 'private')

Make the uploaded file public. (Alias for options.predefinedAcl = 'publicRead')

Force a resumable upload. NOTE: When working with streams, the file format and size is unknown until it's completely consumed. Because of this, it's best for you to be explicit for what makes sense given your input.

The URI for an already-created resumable upload. See File#createResumableUpload.

The ID of the project which will be billed for the request.

Possible values: "md5", "crc32c", or false. By default, data integrity is validated with a CRC32c checksum. You may use MD5 if preferred, but that hash is not supported for composite objects. An error will be raised if MD5 is specified but is not available. You may also choose to skip validation completely, however this is not recommended. NOTE: Validation is automatically skipped for objects that were uploaded using the gzip option and have already compressed content.

The full API response.

The full API response.

Suppress errors until all files have been processed.

This parameter is currently ignored.

The full API response.

The full API response.

The full API response.

The full API response.

The contents of a File.

The bucket for the log entries. By default, the current bucket is used.

A unique prefix for log object names.

The full API response.

An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported.The condition that is associated with this binding.

Whether the File exists.

A custom encryption key.

Generation to scope the file to.

Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key. Limited availability; usable only by enabled projects.

The ID of the project which will be billed for all requests made from File object.

The document policy.

An object containing the request URL and form fields.

Single or array of Acl Objects.

The full API response.

The ID of the project which will be billed for the request.

The bucket metadata.

The full API response.

Automatically create the object if it does not exist. Default: false

The ID of the project which will be billed for the request.

The Bucket.

The full API response.

Currently only supports "list" (HTTP: GET).

A timestamp when this link will expire. Any value given is passed to new Date(). Note: 'v4' supports maximum duration of 7 days (604800 seconds) from now.

The signing version to use, either 'v2' or 'v4'.

The cname for this bucket, i.e., "https://cdn.example.com". See reference

If these headers are used, the server will check to make sure that the client provides matching values. See Canonical extension headers for the requirements of this feature, most notably: - The header name must be prefixed with x-goog- - The header name must be all lowercase Note: Multi-valued header passed as an array in the extensionHeaders object is converted into a string, delimited by , with no space. Requests made using the signed URL will need to delimit multi-valued headers using a single , as well, or else the server will report a mismatched signature.

Have pagination handled automatically.

Maximum number of API calls to make.

Maximum number of items plus prefixes to return.

A previously-returned page token representing part of the larger set of results to view.

The ID of the project which will be billed for the request.

Array of Bucket instances.

A Date object representing the earliest time this file's retention policy will expire.

The File metadata.

The full API response.

The File.

The full API response.

Have pagination handled automatically.

Results will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name truncated after the delimiter, returned in apiResponse.prefixes. Duplicate prefixes are omitted.

Filter results based on a directory name, or more technically, a "prefix".

Filter results to objects whose names begin with this prefix.

Maximum number of API calls to make.

Maximum number of items plus prefixes to return.

A previously-returned page token representing part of the larger set of results to view.

The ID of the project which will be billed for the request.

If true, returns File objects scoped to their versions.

Array of File instances.

This parameter is currently ignored.

This parameter is currently ignored.

This HmacKey instance.

The full API response.

Object of labels currently set on this bucket.

The ID of the project which will be billed for the request.

Array of Notification instances.

The full API response.

The version of IAM policies to request. If a policy with a condition is requested without setting this, the server will return an error. This must be set to a value of 3 to retrieve IAM policies containing conditions. This is to prevent client code that isn't aware of IAM conditions from interpreting and modifying policies incorrectly. The service might return a policy with version lower than the one that was requested, based on the feature syntax in the policy fetched.

The ID of the project which will be billed for the request.

The policy.

The full API response.

The service account resource.

The full API response.

The document policy.

The signed URL.

The signed URL.

The access id identifies which HMAC key was used to sign a request when authenticating with HMAC.

Used to perform a read-modify-write of the key.

The resource name of the HMAC key.

The project ID.

The service account's email this HMAC key is created for.

The state of this HMAC key. One of "ACTIVE", "INACTIVE" or "DELETED".

The creation time of the HMAC key in RFC 3339 format.

The time this HMAC key was last updated in RFC 3339 format.

The updated HmacKeyMetadata object.

The full API response.

The project ID of the project that owns the service account of the requested HMAC key. If not provided, the project ID used to instantiate the Storage client will be used.

Whether file is public or not.

List of files affected.

List of files made private.

List of files made public.

If true, set the file to be private to only the owner user. Otherwise, it will be private to the project.

The ID of the project which will be billed for the request.

The full API response.

The full API response.

The destination File.

The full API response.

Whether the notification exists or not.

Bindings associate members with roles.

Etags are used to perform a read-modify-write.

The syntax schema version of the Policy. To set an IAM policy with conditional binding, this field must be set to 3 or greater.

Role that is assigned to members.

Specifies the identities requesting access for the bucket.

The condition that is associated with this binding.

The full API response.

The ID of the project which will be billed for the request.

The full API response.

The full API response.

New state of the HmacKey. Either 'ACTIVE' or 'INACTIVE'.

Include an etag from a previous get HMAC key request to perform safe read-modify-write.

This parameter is currently ignored.

The ID of the project which will be billed for the request.

The bucket metadata.

The ID of the project which will be billed for the request.

The full API response.

The request URL.

The form fields to include in the POST request.

The full API response.

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option above is not necessary. NOTE: .pem and .p12 require you to specify the email option as well.

Account email address. Required when using a .pem or .p12 keyFilename.

Credentials object.

Properties

Automatically retry requests if the response is related to rate limits or certain intermittent server errors. We will exponentially backoff subsequent requests by default.

Maximum number of automatic retries attempted before returning the error.

Custom promise module to use instead of native Promises.

The updated Acl Objects.

The full API response.

The uploaded File.

The full API response.