younifyd
Menu

Storage.objects.watch All

Watch for changes on all objects in a bucket.

POST/b/{bucket}/o/watch

Use it in a workflow

  1. Add a step and choose the Google Cloud Storage connector.
  2. Pick the Storage.objects.watch All action (under objects).
  3. Fill in the fields below, then reference the result from later steps as {{storageObjectsWatchAll.response.data}}.

Request

Path parameters

bucketstringrequired

Name of the bucket in which to look for objects.

Query parameters

altstring

Data format for the response.

One ofjson

fieldsstring

Selector specifying which fields to include in a partial response.

keystring

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.

oauth_tokenstring

OAuth 2.0 token for the current user.

prettyPrintboolean

Returns response with indentations and line breaks.

quotaUserstring

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

uploadTypestring

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

userIpstring

Deprecated. Please use quotaUser instead.

delimiterstring

Returns results in a directory-like mode. items 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 prefixes. Duplicate prefixes are omitted.

endOffsetstring

Filter results to objects whose names are lexicographically before endOffset. If startOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).

includeTrailingDelimiterboolean

If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes.

maxResultsinteger

Maximum number of items plus prefixes to return in a single page of responses. As duplicate prefixes are omitted, fewer total results may be returned than requested. The service will use this parameter or 1,000 items, whichever is smaller.

pageTokenstring

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

prefixstring

Filter results to objects whose names begin with this prefix.

projectionstring

Set of properties to return. Defaults to noAcl.

One offullnoAcl

startOffsetstring

Filter results to objects whose names are lexicographically equal to or after startOffset. If endOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).

userProjectstring

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

versionsboolean

If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.

Request body

Enter the body as JSON in the step's Body field.

addressstring

The address where notifications are delivered for this channel.

expirationstring (int64)

Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

idstring

A UUID or similar unique string that identifies this channel.

kindstring

Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

Default "api#channel"

paramsobject

Additional parameters controlling delivery channel behavior. Optional.

payloadboolean

A Boolean value to indicate whether payload is wanted. Optional.

resourceIdstring

An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

resourceUristring

A version-specific identifier for the watched resource.

tokenstring

An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

typestring

The type of delivery mechanism used for this channel.

json
{
  "address": "string",
  "expiration": "string",
  "id": "string",
  "kind": "api#channel",
  "params": {},
  "payload": false,
  "resourceId": "string",
  "resourceUri": "string",
  "token": "string",
  "type": "string"
}

Response

Returns 200 with an object. Read it in later steps with {{storageObjectsWatchAll.response.data.<field>}}.

addressstring

The address where notifications are delivered for this channel.

expirationstring (int64)

Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

idstring

A UUID or similar unique string that identifies this channel.

kindstring

Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

Default "api#channel"

paramsobject

Additional parameters controlling delivery channel behavior. Optional.

payloadboolean

A Boolean value to indicate whether payload is wanted. Optional.

resourceIdstring

An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

resourceUristring

A version-specific identifier for the watched resource.

tokenstring

An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

typestring

The type of delivery mechanism used for this channel.

json
{
  "address": "string",
  "expiration": "string",
  "id": "string",
  "kind": "api#channel",
  "params": {},
  "payload": false,
  "resourceId": "string",
  "resourceUri": "string",
  "token": "string",
  "type": "string"
}

Need more? See the Google Cloud Storage guide for connection setup and behaviour shared by every action.

Storage.objects.watch All — Google Cloud Storage — Documentation