Gcp/ftp

@swamp/gcp/ftpv2026.10.29.1· AGPL-3.0-or-later· 2d agoBEHAVIORS

01README

Google Cloud ftp infrastructure models

02Release Notes

Updated: servers

03Behaviors3

@swamp/gcp/ftp/locationsv2026.10.23.1locations.ts

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	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	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
name	string	yes	The resource that owns the locations collection, if applicable.

fn get(identifier: string)

Get a locations

Argument	Type	Required	Description
identifier	string	yes	The name of the locations

fn sync(identifier?: string)

Sync locations state from GCP

Argument	Type	Required	Description
identifier?	string	no	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	Required	Description
extraLocationTypes?	string	no	Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
filter?	string	no	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	no	The maximum number of results to return. If not set, the service selects a default.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— A resource that represents a Google Cloud location.

@swamp/gcp/ftp/serversv2026.10.29.1servers.ts

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	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	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
accessType?	enum	no	Required. The access type of the Server.
displayName?	string	no	Optional. Display name of the Server
externalConfig?	object	no	Configuration for external access.
internalConfig?	object	no	Configuration for internal access.
labels?	record	no	Optional. Labels as key value pairs
name?	string	no	Identifier. name of resource
requestId?	string	no	Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID w
serverId?	string	no	Required. A unique ID for the server. Must start with a lowercase letter, and end with a lowercase letter or number. Can contain lowercase letters, numbers, and hyphens. Can't begin with the prefix `goog` or contain the string `google`, including close misspellings such as `g00gle`. Maximum length is 30 characters.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create(waitForReady?: boolean)

Create a servers

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a servers

Argument	Type	Required	Description
identifier	string	yes	The name of the servers

fn update(identifier?: string, waitForReady?: boolean)

Update servers attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific servers by name (e.g. one discovered by list)
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn delete(identifier: string)

Delete the servers

Argument	Type	Required	Description
identifier	string	yes	The name of the servers

fn sync(identifier?: string)

Sync servers state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific servers by name (e.g. one discovered by list)

fn list(filter?: string, orderBy?: string, pageSize?: number, view?: string, maxPages?: number)

List servers resources

Argument	Type	Required	Description
filter?	string	no	Optional. Filtering results
orderBy?	string	no	Optional. Hint for how to order the results
pageSize?	number	no	Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
view?	string	no	Optional. The view of the Server resource to return.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn start()

start

fn stop()

stop

Resources

state(infinite)— Message describing Server object

@swamp/gcp/ftp/servers-usersv2026.10.23.1servers_users.ts

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	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	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
customerServiceAccount?	string	no	Required. Service account in customer project attached to this SFTP User.
labels?	record	no	Optional. Labels as key value pairs
name?	string	no	Identifier. User-friendly name via which User will be identified. projects/{project}/locations/{location}/servers/{server}/users/{user}
storageDirectoryMappings?	array	no	Required. Mapping of Cloud Storage buckets to directories where the user will land in the SFTP server.
userCredentials?	array	no	Required. User credential for the user. The maximum number of user credentials is 10.
requestId?	string	no	Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID w
userId?	string	no	Required. A unique user ID for the SFTP user. The user ID must start with a lowercase letter and can include lowercase letters, numbers, or hyphens.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create(waitForReady?: boolean)

Create a users

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a users

Argument	Type	Required	Description
identifier	string	yes	The name of the users

fn update(identifier?: string, waitForReady?: boolean)

Update users attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific users by name (e.g. one discovered by list)
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn delete(identifier: string)

Delete the users

Argument	Type	Required	Description
identifier	string	yes	The name of the users

fn sync(identifier?: string)

Sync users state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific users by name (e.g. one discovered by list)

fn list(filter?: string, orderBy?: string, pageSize?: number, view?: string, maxPages?: number)

List users resources

Argument	Type	Required	Description
filter?	string	no	Optional. Filtering results
orderBy?	string	no	Optional. Hint for how to order the results
pageSize?	number	no	Optional. Requested page size. User may return fewer items than requested. The maximum value is 1000; The default value is 50 if the field is omitted (or set to 0).
view?	string	no	Optional. The view of the User resource to return.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— Message describing User object

04Previous Versions5

2026.10.23.1AGPL-3.0-or-later(was none)Oct 24, 2026

Updated: locations, servers, servers_users

2026.10.13.1Oct 13, 2026

Updated: locations, servers, servers_users

2026.08.25.1Aug 25, 2026

Updated: servers

2026.08.12.2Aug 12, 2026

Updated: locations, servers, servers_users

2026.08.05.1Aug 5, 2026

Added: locations, servers, servers_users

05Stats

100 / 100

Downloads

Archive size

37.1 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
Docs keep secrets in a vault1/1earned
Has description1/1earned
Platform support declared (or universal)2/2earned
License2/2earned
Verified public repository2/2earned

Repository

https://github.com/swamp-club/swamp-extensions

06Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64 windows · x86_64

07Labels

#gcp #google-cloud #ftp #cloud #infrastructure