| { |
| "auth": { |
| "oauth2": { |
| "scopes": { |
| "https://www.googleapis.com/auth/cloud-platform": { |
| "description": "View and manage your data across Google Cloud Platform services" |
| } |
| } |
| } |
| }, |
| "basePath": "", |
| "baseUrl": "https://file.googleapis.com/", |
| "batchPath": "batch", |
| "canonicalName": "Cloud Filestore", |
| "description": "The Cloud Filestore API is used for creating and managing cloud file servers.", |
| "discoveryVersion": "v1", |
| "documentationLink": "https://cloud.google.com/filestore/", |
| "fullyEncodeReservedExpansion": true, |
| "icons": { |
| "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| }, |
| "id": "file:v1beta1", |
| "kind": "discovery#restDescription", |
| "name": "file", |
| "ownerDomain": "google.com", |
| "ownerName": "Google", |
| "parameters": { |
| "$.xgafv": { |
| "description": "V1 error format.", |
| "enum": [ |
| "1", |
| "2" |
| ], |
| "enumDescriptions": [ |
| "v1 error format", |
| "v2 error format" |
| ], |
| "location": "query", |
| "type": "string" |
| }, |
| "access_token": { |
| "description": "OAuth access token.", |
| "location": "query", |
| "type": "string" |
| }, |
| "alt": { |
| "default": "json", |
| "description": "Data format for response.", |
| "enum": [ |
| "json", |
| "media", |
| "proto" |
| ], |
| "enumDescriptions": [ |
| "Responses with Content-Type of application/json", |
| "Media download with context-dependent Content-Type", |
| "Responses with Content-Type of application/x-protobuf" |
| ], |
| "location": "query", |
| "type": "string" |
| }, |
| "callback": { |
| "description": "JSONP", |
| "location": "query", |
| "type": "string" |
| }, |
| "fields": { |
| "description": "Selector specifying which fields to include in a partial response.", |
| "location": "query", |
| "type": "string" |
| }, |
| "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.", |
| "location": "query", |
| "type": "string" |
| }, |
| "oauth_token": { |
| "description": "OAuth 2.0 token for the current user.", |
| "location": "query", |
| "type": "string" |
| }, |
| "prettyPrint": { |
| "default": "true", |
| "description": "Returns response with indentations and line breaks.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "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.", |
| "location": "query", |
| "type": "string" |
| }, |
| "uploadType": { |
| "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
| "location": "query", |
| "type": "string" |
| }, |
| "upload_protocol": { |
| "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "protocol": "rest", |
| "resources": { |
| "projects": { |
| "resources": { |
| "locations": { |
| "methods": { |
| "get": { |
| "description": "Gets information about a location.", |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}", |
| "httpMethod": "GET", |
| "id": "file.projects.locations.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Resource name for the location.", |
| "location": "path", |
| "pattern": "^projects/[^/]+/locations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1beta1/{+name}", |
| "response": { |
| "$ref": "Location" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "list": { |
| "description": "Lists information about the supported locations for this service.", |
| "flatPath": "v1beta1/projects/{projectsId}/locations", |
| "httpMethod": "GET", |
| "id": "file.projects.locations.list", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "filter": { |
| "description": "The standard list filter.", |
| "location": "query", |
| "type": "string" |
| }, |
| "name": { |
| "description": "The resource that owns the locations collection, if applicable.", |
| "location": "path", |
| "pattern": "^projects/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "pageSize": { |
| "description": "The standard list page size.", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "The standard list page token.", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1beta1/{+name}/locations", |
| "response": { |
| "$ref": "ListLocationsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| }, |
| "resources": { |
| "instances": { |
| "methods": { |
| "create": { |
| "description": "Creates an instance.", |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/instances", |
| "httpMethod": "POST", |
| "id": "file.projects.locations.instances.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "instanceId": { |
| "description": "The name of the instance to create.\nThe name must be unique for the specified project and location.", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "The instance's project and location, in the format\nprojects/{project_id}/locations/{location}. In Cloud Filestore,\nlocations map to GCP zones, for example **us-west1-b**.", |
| "location": "path", |
| "pattern": "^projects/[^/]+/locations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1beta1/{+parent}/instances", |
| "request": { |
| "$ref": "Instance" |
| }, |
| "response": { |
| "$ref": "Operation" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes an instance.", |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}", |
| "httpMethod": "DELETE", |
| "id": "file.projects.locations.instances.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "The instance resource name, in the format\nprojects/{project_id}/locations/{location}/instances/{instance_id}", |
| "location": "path", |
| "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1beta1/{+name}", |
| "response": { |
| "$ref": "Operation" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Gets the details of a specific instance.", |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}", |
| "httpMethod": "GET", |
| "id": "file.projects.locations.instances.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "The instance resource name, in the format\nprojects/{project_id}/locations/{location}/instances/{instance_id}.", |
| "location": "path", |
| "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1beta1/{+name}", |
| "response": { |
| "$ref": "Instance" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "list": { |
| "description": "Lists all instances in a project for either a specified location\nor for all locations.", |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/instances", |
| "httpMethod": "GET", |
| "id": "file.projects.locations.instances.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "filter": { |
| "description": "List filter.", |
| "location": "query", |
| "type": "string" |
| }, |
| "orderBy": { |
| "description": "Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).", |
| "location": "query", |
| "type": "string" |
| }, |
| "pageSize": { |
| "description": "The maximum number of items to return.", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "The next_page_token value to use if there are additional\nresults to retrieve for this list request.", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "The project and location for which to retrieve instance information,\nin the format projects/{project_id}/locations/{location}. In Cloud\nFilestore, locations map to GCP zones, for example **us-west1-b**. To\nretrieve instance information for all locations, use \"-\" for the {location}\nvalue.", |
| "location": "path", |
| "pattern": "^projects/[^/]+/locations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1beta1/{+parent}/instances", |
| "response": { |
| "$ref": "ListInstancesResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "patch": { |
| "description": "Updates the settings of a specific instance.", |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}", |
| "httpMethod": "PATCH", |
| "id": "file.projects.locations.instances.patch", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Output only.\nThe resource name of the instance, in the format\nprojects/{project_id}/locations/{location_id}/instances/{instance_id}.", |
| "location": "path", |
| "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "updateMask": { |
| "description": "Mask of fields to update. At least one path must be supplied in this\nfield. The elements of the repeated paths field may only include these\nfields:\n\"description\"", |
| "format": "google-fieldmask", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1beta1/{+name}", |
| "request": { |
| "$ref": "Instance" |
| }, |
| "response": { |
| "$ref": "Operation" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| }, |
| "operations": { |
| "methods": { |
| "cancel": { |
| "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", |
| "httpMethod": "POST", |
| "id": "file.projects.locations.operations.cancel", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "The name of the operation resource to be cancelled.", |
| "location": "path", |
| "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1beta1/{+name}:cancel", |
| "request": { |
| "$ref": "CancelOperationRequest" |
| }, |
| "response": { |
| "$ref": "Empty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.", |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", |
| "httpMethod": "DELETE", |
| "id": "file.projects.locations.operations.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "The name of the operation resource to be deleted.", |
| "location": "path", |
| "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1beta1/{+name}", |
| "response": { |
| "$ref": "Empty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.", |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", |
| "httpMethod": "GET", |
| "id": "file.projects.locations.operations.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "The name of the operation resource.", |
| "location": "path", |
| "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1beta1/{+name}", |
| "response": { |
| "$ref": "Operation" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "list": { |
| "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.", |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations", |
| "httpMethod": "GET", |
| "id": "file.projects.locations.operations.list", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "filter": { |
| "description": "The standard list filter.", |
| "location": "query", |
| "type": "string" |
| }, |
| "name": { |
| "description": "The name of the operation's parent resource.", |
| "location": "path", |
| "pattern": "^projects/[^/]+/locations/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "pageSize": { |
| "description": "The standard list page size.", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "The standard list page token.", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1beta1/{+name}/operations", |
| "response": { |
| "$ref": "ListOperationsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "revision": "20180925", |
| "rootUrl": "https://file.googleapis.com/", |
| "schemas": { |
| "CancelOperationRequest": { |
| "description": "The request message for Operations.CancelOperation.", |
| "id": "CancelOperationRequest", |
| "properties": {}, |
| "type": "object" |
| }, |
| "Empty": { |
| "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", |
| "id": "Empty", |
| "properties": {}, |
| "type": "object" |
| }, |
| "FileShareConfig": { |
| "description": "File share configuration for the instance.", |
| "id": "FileShareConfig", |
| "properties": { |
| "capacityGb": { |
| "description": "File share capacity in gigabytes (GB).\nCloud Filestore defines 1 GB as 1024^3 bytes.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "name": { |
| "description": "The name of the file share (must be 16 characters or less).", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "Instance": { |
| "description": "A Cloud Filestore instance.", |
| "id": "Instance", |
| "properties": { |
| "createTime": { |
| "description": "Output only.\nThe time when the instance was created.", |
| "format": "google-datetime", |
| "type": "string" |
| }, |
| "description": { |
| "description": "Optional. A description of the instance (2048 characters or less).", |
| "type": "string" |
| }, |
| "etag": { |
| "description": "Server-specified ETag for the instance resource to prevent simultaneous\nupdates from overwriting each other.", |
| "type": "string" |
| }, |
| "fileShares": { |
| "description": "File system shares on the instance.\nFor this version, only a single file share is supported.", |
| "items": { |
| "$ref": "FileShareConfig" |
| }, |
| "type": "array" |
| }, |
| "labels": { |
| "additionalProperties": { |
| "type": "string" |
| }, |
| "description": "Resource labels to represent user provided metadata.", |
| "type": "object" |
| }, |
| "name": { |
| "description": "Output only.\nThe resource name of the instance, in the format\nprojects/{project_id}/locations/{location_id}/instances/{instance_id}.", |
| "type": "string" |
| }, |
| "networks": { |
| "description": "VPC networks to which the instance is connected.\nFor this version, only a single network is supported.", |
| "items": { |
| "$ref": "NetworkConfig" |
| }, |
| "type": "array" |
| }, |
| "state": { |
| "description": "Output only.\nThe instance state.", |
| "enum": [ |
| "STATE_UNSPECIFIED", |
| "CREATING", |
| "READY", |
| "REPAIRING", |
| "DELETING", |
| "ERROR" |
| ], |
| "enumDescriptions": [ |
| "State not set.", |
| "The instance is being created.", |
| "The instance is available for use.", |
| "Work is being done on the instance. You can get further details from the\n`statusMessage` field of the `Instance` resource.", |
| "The instance is shutting down.", |
| "The instance is experiencing an issue and might be unusable. You can get\nfurther details from the `statusMessage` field of the `Instance`\nresource." |
| ], |
| "type": "string" |
| }, |
| "statusMessage": { |
| "description": "Output only.\nAdditional information about the instance state, if available.", |
| "type": "string" |
| }, |
| "tier": { |
| "description": "The service tier of the instance.", |
| "enum": [ |
| "TIER_UNSPECIFIED", |
| "STANDARD", |
| "PREMIUM" |
| ], |
| "enumDescriptions": [ |
| "Not set.", |
| "STANDARD tier.", |
| "PREMIUM tier." |
| ], |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "ListInstancesResponse": { |
| "description": "ListInstancesResponse is the result of ListInstancesRequest.", |
| "id": "ListInstancesResponse", |
| "properties": { |
| "instances": { |
| "description": "A list of instances in the project for the specified location.\n\nIf the {location} value in the request is \"-\", the response contains a list\nof instances from all locations. If any location is unreachable, the\nresponse will only return instances in reachable locations and the\n\"unreachable\" field will be populated with a list of unreachable locations.", |
| "items": { |
| "$ref": "Instance" |
| }, |
| "type": "array" |
| }, |
| "nextPageToken": { |
| "description": "The token you can use to retrieve the next page of results. Not returned\nif there are no more results in the list.", |
| "type": "string" |
| }, |
| "unreachable": { |
| "description": "Locations that could not be reached.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "ListLocationsResponse": { |
| "description": "The response message for Locations.ListLocations.", |
| "id": "ListLocationsResponse", |
| "properties": { |
| "locations": { |
| "description": "A list of locations that matches the specified filter in the request.", |
| "items": { |
| "$ref": "Location" |
| }, |
| "type": "array" |
| }, |
| "nextPageToken": { |
| "description": "The standard List next-page token.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "ListOperationsResponse": { |
| "description": "The response message for Operations.ListOperations.", |
| "id": "ListOperationsResponse", |
| "properties": { |
| "nextPageToken": { |
| "description": "The standard List next-page token.", |
| "type": "string" |
| }, |
| "operations": { |
| "description": "A list of operations that matches the specified filter in the request.", |
| "items": { |
| "$ref": "Operation" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "Location": { |
| "description": "A resource that represents Google Cloud Platform location.", |
| "id": "Location", |
| "properties": { |
| "displayName": { |
| "description": "The friendly name for this location, typically a nearby city name.\nFor example, \"Tokyo\".", |
| "type": "string" |
| }, |
| "labels": { |
| "additionalProperties": { |
| "type": "string" |
| }, |
| "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}", |
| "type": "object" |
| }, |
| "locationId": { |
| "description": "The canonical id for this location. For example: `\"us-east1\"`.", |
| "type": "string" |
| }, |
| "metadata": { |
| "additionalProperties": { |
| "description": "Properties of the object. Contains field @type with type URL.", |
| "type": "any" |
| }, |
| "description": "Service-specific metadata. For example the available capacity at the given\nlocation.", |
| "type": "object" |
| }, |
| "name": { |
| "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "NetworkConfig": { |
| "description": "Network configuration for the instance.", |
| "id": "NetworkConfig", |
| "properties": { |
| "ipAddresses": { |
| "description": "Output only.\nIPv4 addresses in the format\n{octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format\n{block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block 7}:{block 8}.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "modes": { |
| "description": "Internet protocol versions for which the instance has IP addresses\nassigned. For this version, only MODE_IPV4 is supported.", |
| "enumDescriptions": [ |
| "Internet protocol not set.", |
| "Use the IPv4 internet protocol." |
| ], |
| "items": { |
| "enum": [ |
| "ADDRESS_MODE_UNSPECIFIED", |
| "MODE_IPV4" |
| ], |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "network": { |
| "description": "The name of the Google Compute Engine\n[VPC network](/compute/docs/networks-and-firewalls#networks) to which the\ninstance is connected.", |
| "type": "string" |
| }, |
| "reservedIpRange": { |
| "description": "A /29 CIDR block in one of the\n[internal IP address ranges](https://www.arin.net/knowledge/address_filters.html)\nthat identifies the range of IP addresses reserved for this\ninstance. For example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify\ncan't overlap with either existing subnets or assigned IP address ranges\nfor other Cloud Filestore instances in the selected VPC network.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "Operation": { |
| "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", |
| "id": "Operation", |
| "properties": { |
| "done": { |
| "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.", |
| "type": "boolean" |
| }, |
| "error": { |
| "$ref": "Status", |
| "description": "The error result of the operation in case of failure or cancellation." |
| }, |
| "metadata": { |
| "additionalProperties": { |
| "description": "Properties of the object. Contains field @type with type URL.", |
| "type": "any" |
| }, |
| "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", |
| "type": "object" |
| }, |
| "name": { |
| "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.", |
| "type": "string" |
| }, |
| "response": { |
| "additionalProperties": { |
| "description": "Properties of the object. Contains field @type with type URL.", |
| "type": "any" |
| }, |
| "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.", |
| "type": "object" |
| } |
| }, |
| "type": "object" |
| }, |
| "OperationMetadata": { |
| "description": "Represents the metadata of the long-running operation.", |
| "id": "OperationMetadata", |
| "properties": { |
| "apiVersion": { |
| "description": "[Output only] API version used to start the operation.", |
| "type": "string" |
| }, |
| "cancelRequested": { |
| "description": "[Output only] Identifies whether the user has requested cancellation\nof the operation. Operations that have successfully been cancelled\nhave Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", |
| "type": "boolean" |
| }, |
| "createTime": { |
| "description": "[Output only] The time the operation was created.", |
| "format": "google-datetime", |
| "type": "string" |
| }, |
| "endTime": { |
| "description": "[Output only] The time the operation finished running.", |
| "format": "google-datetime", |
| "type": "string" |
| }, |
| "statusDetail": { |
| "description": "[Output only] Human-readable status of the operation, if any.", |
| "type": "string" |
| }, |
| "target": { |
| "description": "[Output only] Server-defined resource path for the target of the operation.", |
| "type": "string" |
| }, |
| "verb": { |
| "description": "[Output only] Name of the verb executed by the operation.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "Status": { |
| "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.", |
| "id": "Status", |
| "properties": { |
| "code": { |
| "description": "The status code, which should be an enum value of google.rpc.Code.", |
| "format": "int32", |
| "type": "integer" |
| }, |
| "details": { |
| "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", |
| "items": { |
| "additionalProperties": { |
| "description": "Properties of the object. Contains field @type with type URL.", |
| "type": "any" |
| }, |
| "type": "object" |
| }, |
| "type": "array" |
| }, |
| "message": { |
| "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| } |
| }, |
| "servicePath": "", |
| "title": "Cloud Filestore API", |
| "version": "v1beta1", |
| "version_module": true |
| } |
