{ "protocol": "rest", "title": "Cloud FTP API", "servicePath": "", "batchPath": "batch", "kind": "discovery#restDescription", "revision": "20260729", "resources": { "projects": { "resources": { "locations": { "methods": { "list": { "httpMethod": "GET", "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "id": "ftp.projects.locations.list", "response": { "$ref": "ListLocationsResponse" }, "parameterOrder": [ "name" ], "parameters": { "pageToken": { "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "location": "query", "type": "string" }, "extraLocationTypes": { "location": "query", "type": "string", "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "repeated": true }, "name": { "type": "string", "description": "The resource that owns the locations collection, if applicable.", "pattern": "^projects/[^/]+$", "location": "path", "required": true }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "The maximum number of results to return. If not set, the service selects a default." }, "filter": { "location": "query", "type": "string", "description": "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)." } }, "flatPath": "v1alpha/projects/{projectsId}/locations", "path": "v1alpha/{+name}/locations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}", "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Resource name for the location.", "type": "string" } }, "path": "v1alpha/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "ftp.projects.locations.get", "description": "Gets information about a location.", "httpMethod": "GET", "parameterOrder": [ "name" ], "response": { "$ref": "Location" } } }, "resources": { "servers": { "methods": { "get": { "id": "ftp.projects.locations.servers.get", "description": "Gets details of a single Server.", "httpMethod": "GET", "parameterOrder": [ "name" ], "response": { "$ref": "Server" }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/servers/{serversId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/servers/[^/]+$", "type": "string", "description": "Required. Name of the resource", "location": "path", "required": true }, "view": { "location": "query", "enum": [ "SERVER_VIEW_UNSPECIFIED", "SERVER_VIEW_BASIC", "SERVER_VIEW_FULL" ], "enumDescriptions": [ "Default value. Equivalent to SERVER_VIEW_BASIC.", "Basic view. Excludes heavy configurations (internal_config, external_config, google_managed_server_credential).", "Full view. Includes all fields." ], "type": "string", "description": "Optional. The view of the Server resource to return." } }, "path": "v1alpha/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "stop": { "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/servers/{serversId}:stop", "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/servers/[^/]+$", "type": "string", "description": "Required. Name of the resource. Format: `projects/{project}/locations/{location}/servers/{server}`" } }, "path": "v1alpha/{+name}:stop", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "ftp.projects.locations.servers.stop", "description": "Stops an active Server.", "httpMethod": "POST", "parameterOrder": [ "name" ], "request": { "$ref": "StopServerRequest" }, "response": { "$ref": "Operation" } }, "create": { "path": "v1alpha/{+parent}/servers", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "serverId": { "description": "Required. Id of the requesting object If auto-generating Id server-side, remove this field and server_id from the method_signature of Create RPC", "location": "query", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. Value for parent.", "type": "string", "location": "path", "required": true }, "requestId": { "description": "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 was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/servers", "response": { "$ref": "Operation" }, "parameterOrder": [ "parent" ], "request": { "$ref": "Server" }, "httpMethod": "POST", "description": "Creates a new Server in a given project and location.", "id": "ftp.projects.locations.servers.create" }, "delete": { "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/servers/{serversId}", "parameters": { "name": { "location": "path", "required": true, "description": "Required. Name of the resource", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/servers/[^/]+$" } }, "path": "v1alpha/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "ftp.projects.locations.servers.delete", "description": "Deletes a single Server.", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" } }, "list": { "path": "v1alpha/{+parent}/servers", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "filter": { "location": "query", "type": "string", "description": "Optional. Filtering results" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "orderBy": { "location": "query", "type": "string", "description": "Optional. Hint for how to order the results" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "view": { "type": "string", "description": "Optional. The view of the Server resource to return.", "location": "query", "enum": [ "SERVER_VIEW_UNSPECIFIED", "SERVER_VIEW_BASIC", "SERVER_VIEW_FULL" ], "enumDescriptions": [ "Default value. Equivalent to SERVER_VIEW_BASIC.", "Basic view. Excludes heavy configurations (internal_config, external_config, google_managed_server_credential).", "Full view. Includes all fields." ] }, "parent": { "description": "Required. Parent value for ListServersRequest", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true } }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/servers", "response": { "$ref": "ListServersResponse" }, "parameterOrder": [ "parent" ], "httpMethod": "GET", "description": "Lists Servers in a given project and location.", "id": "ftp.projects.locations.servers.list" }, "patch": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/servers/[^/]+$", "description": "Identifier. name of resource", "type": "string", "location": "path", "required": true }, "updateMask": { "format": "google-fieldmask", "description": "Optional. Field mask is used to specify the fields to be overwritten in the Server resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.", "location": "query", "type": "string" }, "requestId": { "description": "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 was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/servers/{serversId}", "path": "v1alpha/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "description": "Updates the parameters of a single Server.", "id": "ftp.projects.locations.servers.patch", "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ], "request": { "$ref": "Server" } }, "start": { "path": "v1alpha/{+name}:start", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/servers/{serversId}:start", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/servers/[^/]+$", "description": "Required. Name of the resource Format: `projects/{project}/locations/{location}/servers/{server}`", "type": "string", "location": "path", "required": true } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ], "request": { "$ref": "StartServerRequest" }, "description": "Starts a stopping/stopped Server.", "id": "ftp.projects.locations.servers.start", "httpMethod": "POST" } }, "resources": { "users": { "methods": { "delete": { "httpMethod": "DELETE", "id": "ftp.projects.locations.servers.users.delete", "description": "Deletes a single User.", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "parameters": { "name": { "description": "Required. Name of the resource", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/servers/[^/]+/users/[^/]+$", "location": "path", "required": true }, "force": { "description": "Optional. If set to true, the request will force the deletion of the User.", "location": "query", "type": "boolean" } }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/servers/{serversId}/users/{usersId}", "path": "v1alpha/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "httpMethod": "POST", "description": "Creates a new User in a given project and location and Server.", "id": "ftp.projects.locations.servers.users.create", "response": { "$ref": "Operation" }, "parameterOrder": [ "parent" ], "request": { "$ref": "User" }, "parameters": { "userId": { "location": "query", "type": "string", "description": "Required. Id of the requesting object If auto-generating Id server-side, remove this field and server_id from the method_signature of Create RPC" }, "requestId": { "description": "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 was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/servers/[^/]+$", "description": "Required. Value for parent.", "type": "string", "location": "path", "required": true } }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/servers/{serversId}/users", "path": "v1alpha/{+parent}/users", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "path": "v1alpha/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "updateMask": { "location": "query", "type": "string", "description": "Optional. Field mask is used to specify the fields to be overwritten in the User resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.", "format": "google-fieldmask" }, "name": { "location": "path", "required": true, "type": "string", "description": "Identifier. User-friendly name via which User will be identified. projects/{project}/locations/{location}/servers/{server}/users/{user}", "pattern": "^projects/[^/]+/locations/[^/]+/servers/[^/]+/users/[^/]+$" } }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/servers/{serversId}/users/{usersId}", "parameterOrder": [ "name" ], "request": { "$ref": "User" }, "response": { "$ref": "Operation" }, "httpMethod": "PATCH", "id": "ftp.projects.locations.servers.users.patch", "description": "Updates the parameters of a single User." }, "list": { "response": { "$ref": "ListUsersResponse" }, "parameterOrder": [ "parent" ], "httpMethod": "GET", "description": "Lists Users in a given project and location.", "id": "ftp.projects.locations.servers.users.list", "path": "v1alpha/{+parent}/users", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "pageToken": { "description": "Optional. A token identifying a page of results the user should return.", "location": "query", "type": "string" }, "view": { "description": "Optional. The view of the User resource to return.", "type": "string", "enumDescriptions": [ "Default value. Equivalent to USER_VIEW_BASIC.", "Basic view. Excludes heavy configurations (user_credentials, storage_directory_mappings).", "Full view. Includes all fields." ], "location": "query", "enum": [ "USER_VIEW_UNSPECIFIED", "USER_VIEW_BASIC", "USER_VIEW_FULL" ] }, "parent": { "description": "Required. Parent value for ListUsersRequest", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/servers/[^/]+$", "location": "path", "required": true }, "filter": { "location": "query", "type": "string", "description": "Optional. Filtering results" }, "pageSize": { "format": "int32", "description": "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).", "location": "query", "type": "integer" }, "orderBy": { "location": "query", "type": "string", "description": "Optional. Hint for how to order the results" } }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/servers/{serversId}/users" }, "get": { "path": "v1alpha/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "view": { "description": "Optional. The view of the User resource to return.", "type": "string", "location": "query", "enum": [ "USER_VIEW_UNSPECIFIED", "USER_VIEW_BASIC", "USER_VIEW_FULL" ], "enumDescriptions": [ "Default value. Equivalent to USER_VIEW_BASIC.", "Basic view. Excludes heavy configurations (user_credentials, storage_directory_mappings).", "Full view. Includes all fields." ] }, "name": { "description": "Required. Name of the resource", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/servers/[^/]+/users/[^/]+$", "location": "path", "required": true } }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/servers/{serversId}/users/{usersId}", "response": { "$ref": "User" }, "parameterOrder": [ "name" ], "httpMethod": "GET", "description": "Gets details of a single User.", "id": "ftp.projects.locations.servers.users.get" } } } } }, "operations": { "methods": { "list": { "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations", "parameters": { "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "filter": { "location": "query", "type": "string", "description": "The standard list filter." }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "name": { "location": "path", "required": true, "description": "The name of the operation's parent resource.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "path": "v1alpha/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "ftp.projects.locations.operations.list", "httpMethod": "GET", "response": { "$ref": "ListOperationsResponse" }, "parameterOrder": [ "name" ] }, "cancel": { "httpMethod": "POST", "id": "ftp.projects.locations.operations.cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameterOrder": [ "name" ], "request": { "$ref": "CancelOperationRequest" }, "response": { "$ref": "Empty" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource to be cancelled.", "location": "path", "required": true } }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "path": "v1alpha/{+name}:cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "description": "The name of the operation resource.", "type": "string" } }, "path": "v1alpha/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "id": "ftp.projects.locations.operations.get", "httpMethod": "GET", "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ] }, "delete": { "path": "v1alpha/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource to be deleted." } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "id": "ftp.projects.locations.operations.delete", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "httpMethod": "DELETE" } } } } } } } }, "rootUrl": "https://ftp.googleapis.com/", "documentationLink": "https://cloud.google.com/cloud-ftp/overview", "version_module": true, "baseUrl": "https://ftp.googleapis.com/", "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "description": "Cloud FTP is a managed service that allows transferring files directly to Google Cloud Storage using SFTP.", "id": "ftp:v1alpha", "ownerDomain": "google.com", "canonicalName": "Cloud FTP", "ownerName": "Google", "parameters": { "prettyPrint": { "default": "true", "description": "Returns response with indentations and line breaks.", "type": "boolean", "location": "query" }, "oauth_token": { "type": "string", "location": "query", "description": "OAuth 2.0 token for the current user." }, "$.xgafv": { "enum": [ "1", "2" ], "location": "query", "enumDescriptions": [ "v1 error format", "v2 error format" ], "description": "V1 error format.", "type": "string" }, "upload_protocol": { "type": "string", "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "callback": { "description": "JSONP", "type": "string", "location": "query" }, "fields": { "type": "string", "location": "query", "description": "Selector specifying which fields to include in a partial response." }, "uploadType": { "type": "string", "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "key": { "description": "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.", "type": "string", "location": "query" }, "quotaUser": { "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "type": "string", "location": "query" }, "alt": { "default": "json", "type": "string", "description": "Data format for response.", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "enum": [ "json", "media", "proto" ], "location": "query" }, "access_token": { "type": "string", "location": "query", "description": "OAuth access token." } }, "discoveryVersion": "v1", "mtlsRootUrl": "https://ftp.mtls.googleapis.com/", "schemas": { "Status": { "id": "Status", "type": "object", "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "properties": { "details": { "type": "array", "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } } }, "code": { "type": "integer", "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32" }, "message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" } } }, "ListUsersResponse": { "id": "ListUsersResponse", "type": "object", "description": "Message for response to listing Users", "properties": { "nextPageToken": { "description": "A token identifying a page of results the user should return.", "type": "string" }, "unreachable": { "items": { "type": "string" }, "type": "array", "description": "Unordered list. Locations that could not be reached." }, "users": { "items": { "$ref": "User" }, "description": "The list of User", "type": "array" } } }, "OperationMetadata": { "description": "Represents the metadata of the long-running operation.", "properties": { "endTime": { "readOnly": true, "type": "string", "description": "Output only. The time the operation finished running.", "format": "google-datetime" }, "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string" }, "requestedCancellation": { "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "readOnly": true, "type": "boolean" }, "target": { "readOnly": true, "type": "string", "description": "Output only. Server-defined resource path for the target of the operation." }, "statusMessage": { "readOnly": true, "type": "string", "description": "Output only. Human-readable status of the operation, if any." }, "apiVersion": { "description": "Output only. API version used to start the operation.", "readOnly": true, "type": "string" }, "verb": { "readOnly": true, "type": "string", "description": "Output only. Name of the verb executed by the operation." } }, "id": "OperationMetadata", "type": "object" }, "Operation": { "id": "Operation", "type": "object", "description": "This resource represents a long-running operation that is the result of a network API call.", "properties": { "metadata": { "type": "object", "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "name": { "type": "string", "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`." }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" }, "done": { "type": "boolean", "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available." }, "response": { "type": "object", "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } } } }, "ServerCredential": { "description": "Represents credentials of an FTP Server.", "properties": { "fingerprint": { "readOnly": true, "type": "string", "description": "Output only. The fingerprint is a hash of the public key, and is displayed when clients access the server for the first time to verify the server's identity." }, "asymmetricAlgorithm": { "readOnly": true, "type": "string", "description": "Output only. Asymmetric algorithm used by the public key. Possible values (can be expanded in future): - ssh-ed25519" } }, "id": "ServerCredential", "type": "object" }, "UserCredential": { "id": "UserCredential", "type": "object", "description": "Message describing UserCredential object", "properties": { "sshPublicKeyBody": { "type": "string", "description": "Optional. SSH public key body in OpenSSH format. Example: \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ...\"" }, "credentialName": { "type": "string", "description": "Required. Name of the user credential." }, "credentialType": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "PUBLIC_KEY" ], "description": "Required. Type of credential.", "enumDescriptions": [ "Type unspecified.", "Public key credential." ] } } }, "DeniedConsumer": { "description": "A consumer project or network that is denied to connect to the server via PSC.", "properties": { "project": { "type": "string", "description": "The project ID or number of the consumer project. Must be in the format: `projects/{project}`." } }, "id": "DeniedConsumer", "type": "object" }, "ListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "properties": { "operations": { "type": "array", "description": "A list of operations that matches the specified filter in the request.", "items": { "$ref": "Operation" } }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." }, "unreachable": { "type": "array", "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" } } }, "id": "ListOperationsResponse", "type": "object" }, "ExternalServerConfig": { "id": "ExternalServerConfig", "type": "object", "description": "Configuration for external server.", "properties": { "ipAddress": { "description": "Output only. IP address of the LB via which clients will connect.", "readOnly": true, "type": "string" }, "allowedCidrBlocks": { "description": "Optional. List of CIDR blocks that are allowed to access the Server. A CIDR range consists of an IP Address and a prefix length to construct the subnet mask. By default, the prefix length is 32 (i.e. matches a single IP address). For now, only IPV4 addresses are supported. Examples: \"203.0.113.0/24\" - matches with the IP addresses in the range 203.0.113.0 - 203.0.113.255. \"0.0.0.0/0\" - matches against any IP address. This field must contain at least one entry if the access type is EXTERNAL. The number of allowed CIDR blocks cannot exceed 500. Example: 192.168.0.0/16", "type": "array", "items": { "type": "string" } } } }, "User": { "description": "Message describing User object", "properties": { "customerServiceAccount": { "description": "Required. Service account in customer project attached to this SFTP User.", "type": "string" }, "storageDirectoryMappings": { "type": "array", "description": "Required. Mapping of Cloud Storage buckets to directories where the user will land in the SFTP server.", "items": { "$ref": "StorageDirectoryMapping" } }, "name": { "description": "Identifier. User-friendly name via which User will be identified. projects/{project}/locations/{location}/servers/{server}/users/{user}", "type": "string" }, "updateTime": { "readOnly": true, "type": "string", "description": "Output only. [Output only] Update time stamp", "format": "google-datetime" }, "username": { "description": "Output only. [Output only] The username of the user.", "readOnly": true, "type": "string" }, "labels": { "description": "Optional. Labels as key value pairs", "type": "object", "additionalProperties": { "type": "string" } }, "state": { "enumDescriptions": [ "State unspecified.", "User is being created.", "User is ready to be used.", "User creation failed.", "The resource is being updated.", "The resource is being deleted." ], "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "ERROR", "UPDATING", "DELETING" ], "description": "Output only. Tracks user creation.", "type": "string" }, "userCredentials": { "items": { "$ref": "UserCredential" }, "description": "Required. User credential for the user. The maximum number of user credentials is 10.", "type": "array" }, "createTime": { "format": "google-datetime", "description": "Output only. [Output only] Create time stamp", "readOnly": true, "type": "string" } }, "id": "User", "type": "object" }, "StorageDirectoryMapping": { "description": "Mapping of backing Cloud Storage path to the directory where the user lands in the SFTP server. If directory is not specified, it'll default to '/'. Eg 1 - (bucket_name: bucket, bucket_prefix: path1/path2, directory: /abc/def/username) The user will land at /abcd/def/username, and the view there will match that of /bucket/path1/path2. The user will not be aware of Cloud Storage prefix '/bucket/path1' and there will be no such directory in the view. Eg 2 - (bucket_name: bucket, bucket_prefix: path1/path2, directory: '') The user will land at '/', and the view there will match that of /bucket/path1/path2. The user will not be aware of Cloud Storage prefix '/bucket/path1/path2' and there will be no such directory in the view.", "properties": { "bucket": { "type": "string", "description": "Required. Name of the bucket." }, "bucketPrefix": { "type": "string", "description": "Optional. Prefix inside the bucket." }, "permission": { "type": "string", "enum": [ "PERMISSION_UNSPECIFIED", "READ_ONLY", "READ_WRITE" ], "description": "Required. Permission to the bucket.", "enumDescriptions": [ "Permission unspecified.", "Read only permission.", "Read write permission." ] }, "directory": { "description": "Required. Directory where the user lands in the SFTP server.", "type": "string" } }, "id": "StorageDirectoryMapping", "type": "object" }, "InternalServerConfig": { "description": "Configuration for private server accessible via PSC.", "properties": { "consumerAcceptList": { "type": "array", "description": "Required. A list of projects that are permitted to connect. At least one project is required in the allow list.", "items": { "$ref": "AllowedConsumer" } }, "serviceAttachment": { "description": "Output only. The resource name of the service attachment. Format: `projects/{project}/regions/{region}/serviceAttachments/{service_attachment}`", "readOnly": true, "type": "string" }, "consumerRejectList": { "description": "Optional. A list of projects that are denied connection. Format: \"projects/sample_project_id\" or \"projects/1234567890\" Projects in this list will be denied access, even if they are included in the `allow_list`. If this list is empty, no projects are explicitly rejected.", "type": "array", "items": { "$ref": "DeniedConsumer" } }, "pscEndpoints": { "items": { "$ref": "PscEndpoint" }, "description": "Output only. Details of endpoints created by the customer.", "readOnly": true, "type": "array" } }, "id": "InternalServerConfig", "type": "object" }, "ListLocationsResponse": { "id": "ListLocationsResponse", "type": "object", "description": "The response message for Locations.ListLocations.", "properties": { "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "locations": { "type": "array", "description": "A list of locations that matches the specified filter in the request.", "items": { "$ref": "Location" } } } }, "AllowedConsumer": { "description": "A consumer project or network that is permitted to connect to the server via PSC.", "properties": { "project": { "type": "string", "description": "The project ID or number of the consumer project. Must be in the format: `projects/{project}`." }, "connectionLimit": { "type": "string", "description": "Required. The connection limit for the consumer. Value must be greater than 0.", "format": "int64" } }, "id": "AllowedConsumer", "type": "object" }, "StartServerRequest": { "id": "StartServerRequest", "type": "object", "description": "Request message for starting a Server.", "properties": {} }, "CancelOperationRequest": { "id": "CancelOperationRequest", "type": "object", "description": "The request message for Operations.CancelOperation.", "properties": {} }, "ListServersResponse": { "id": "ListServersResponse", "type": "object", "description": "Message for response to listing Servers", "properties": { "servers": { "type": "array", "description": "The list of Server", "items": { "$ref": "Server" } }, "nextPageToken": { "type": "string", "description": "A token identifying a page of results the server should return." }, "unreachable": { "items": { "type": "string" }, "description": "Unordered list. Locations that could not be reached.", "type": "array" } } }, "Server": { "description": "Message describing Server object", "properties": { "externalConfig": { "description": "Configuration for external access.", "$ref": "ExternalServerConfig" }, "internalConfig": { "description": "Configuration for internal access.", "$ref": "InternalServerConfig" }, "createTime": { "description": "Output only. [Output only] Create time stamp", "readOnly": true, "type": "string", "format": "google-datetime" }, "accessType": { "description": "Required. The access type of the Server.", "type": "string", "enum": [ "ACCESS_TYPE_UNSPECIFIED", "EXTERNAL", "INTERNAL" ], "enumDescriptions": [ "Default value. This value is unused.", "Server is assigned a public IP.", "Server is assigned an internal IP." ] }, "displayName": { "type": "string", "description": "Optional. Display name of the Server" }, "googleManagedServerCredential": { "readOnly": true, "description": "Output only. Credentials of the FTP Server.", "$ref": "ServerCredential" }, "name": { "type": "string", "description": "Identifier. name of resource" }, "labels": { "description": "Optional. Labels as key value pairs", "type": "object", "additionalProperties": { "type": "string" } }, "state": { "type": "string", "description": "Output only. The state of the server.", "enumDescriptions": [ "Default value. This value is unused.", "Server is being created.", "Server is starting.", "Server is ready to be used.", "Server is stopping.", "Server is stopped.", "Server is being deleted.", "Server is in error state.", "Server is being updated." ], "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "CREATING", "STARTING", "ACTIVE", "STOPPING", "STOPPED", "DELETING", "ERROR", "UPDATING" ] }, "serviceAgent": { "readOnly": true, "type": "string", "description": "Output only. Service agent used to access the customer bucket." }, "updateTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. [Output only] Update time stamp" } }, "id": "Server", "type": "object" }, "Location": { "id": "Location", "type": "object", "description": "A resource that represents a Google Cloud location.", "properties": { "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}" }, "name": { "type": "string", "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`" }, "locationId": { "type": "string", "description": "The canonical id for this location. For example: `\"us-east1\"`." }, "metadata": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object", "description": "Service-specific metadata. For example the available capacity at the given location." } } }, "StopServerRequest": { "description": "Request message for stopping a Server.", "properties": {}, "id": "StopServerRequest", "type": "object" }, "Empty": { "id": "Empty", "type": "object", "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "properties": {} }, "PscEndpoint": { "id": "PscEndpoint", "type": "object", "description": "Details of PSC endpoint created by customer.", "properties": { "network": { "description": "Output only. The consumer network. Format: `projects/{project}/locations/{location}/networks/{network}`", "readOnly": true, "type": "string" }, "status": { "readOnly": true, "type": "string", "description": "Output only. The status of the connected endpoint." }, "endpoint": { "readOnly": true, "type": "string", "description": "Output only. This is a Resource name for Private Service Connect endpoint. Format: `projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}`" } } } }, "name": "ftp", "basePath": "", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "fullyEncodeReservedExpansion": true, "version": "v1alpha" }