Gcp/storagebatchoperations
@swamp/gcp/storagebatchoperationsv2026.07.21.4
01README
Google Cloud storagebatchoperations infrastructure models
02Release Notes
- Updated: locations, jobs
03Models
@swamp/gcp/storagebatchoperations/jobsv2026.07.21.4jobs.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| bucketList? | object | Specifies a list of buckets and their objects to be transformed. |
| deleteObject? | object | Delete objects. |
| description? | string | Optional. A user-provided description for the job. Maximum length: 1024 bytes when unicode-encoded. |
| dryRun? | boolean | Optional. If true, the job runs in dry run mode, returning the total object count and, if the object configuration is a prefix list, the bytes found from source. No transformations are performed. |
| loggingConfig? | object | Optional. Logging configuration. |
| name? | string | Identifier. The resource name of the job. Format: `projects/{project_id}/locations/global/jobs/{job_id}`. For example: `projects/123456/locations/global/jobs/job01`. `job_id` is unique in a given project. |
| projectSource? | object | Specifies a project source and filters to identify objects to be transformed. |
| putMetadata? | object | Updates object metadata. Allows updating fixed-key and custom metadata. For example, `Cache-Control`, `Content-Disposition`, `Content-Encoding`, `Content-Language`, `Content-Type`, `Custom-Time`, and `Retention configuration`. |
| putObjectHold? | object | Changes object hold status. |
| rewriteObject? | object | Rewrite the object and updates metadata like KMS key. |
| setObjectAcls? | object | Updates object ACLs. |
| updateObjectCustomContext? | object | Update object custom context. |
| jobId? | string | Required. A unique identifier for the job. `job_id` must be up to 128 characters and must include only characters available in DNS names, as defined by RFC-1123. |
| requestId? | string | Optional. An optional request ID to identify requests. Specify a unique request ID in case you need to retry your request. Requests with same `request_id` are ignored for at least 60 minutes since the first request. The request ID must be a valid UUID with the exception that zero UUID isn't supported (00000000-0000-0000-0000-000000000000). |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create(waitForReady?: boolean)
Create a jobs
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a jobs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the jobs |
fn delete(identifier: string)
Delete the jobs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the jobs |
fn sync(identifier?: string)
Sync jobs state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific jobs by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List jobs resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filters results as defined by https://google.aip.dev/160. |
| orderBy? | string | Optional. Field to sort by. Supported fields are `name` and `create_time`. |
| pageSize? | number | Optional. The list page size. The default page size is 100. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn cancel(requestId?: any)
cancel
| Argument | Type | Description |
|---|---|---|
| requestId? | any |
Resources
state(infinite)— The storage batch operations job description.
@swamp/gcp/storagebatchoperations/locationsv2026.07.21.3locations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| name | string | The resource that owns the locations collection, if applicable. |
fn get(identifier: string)
Get a locations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the locations |
fn sync(identifier?: string)
Sync locations state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific locations by name (e.g. one discovered by list) |
fn list(extraLocationTypes?: string, filter?: string, pageSize?: number, maxPages?: number)
List locations resources
| Argument | Type | Description |
|---|---|---|
| extraLocationTypes? | string | Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. |
| filter? | string | A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). |
| pageSize? | number | The maximum number of results to return. If not set, the service selects a default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A resource that represents a Google Cloud location.
04Previous Versions
2026.07.21.1
- Updated: jobs
2026.07.20.2
- Updated: locations, jobs
2026.07.20.1
- Updated: locations, jobs
2026.07.19.2
- Updated: locations
2026.07.19.1
- Updated: locations, jobs
2026.07.18.2
- Updated: locations, jobs
2026.07.17.2
- Updated: jobs
2026.07.17.1
- Updated: jobs
Added 2, removed 1 models
2026.06.08.2
- Updated: locations, jobs
2026.06.07.1
- Updated: locations, jobs
2026.06.03.1
- Updated: jobs
2026.05.26.1
- Updated: locations, jobs
2026.05.25.1
- Updated: locations, jobs
Modified 2 models
2026.05.24.1
- Updated: locations, jobs
2026.05.21.2
- Updated: locations, jobs
2026.05.21.1
2026.05.20.1
- Updated: jobs
2026.05.19.2
2026.05.19.1
05Stats
A
100 / 100
Downloads
0
Archive size
44.0 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels