Liking cljdoc? Tell your friends :D

happygapi.file.projects

Cloud Filestore API: projects. The Cloud Filestore API is used for creating and managing cloud file servers. See: https://cloud.google.com/filestore/api/reference/rest/v1/projects

Cloud Filestore API: projects.
The Cloud Filestore API is used for creating and managing cloud file servers.
See: https://cloud.google.com/filestore/api/reference/rest/v1/projects
raw docstring

locations-backups-create$clj

(locations-backups-create$ auth parameters body)

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/backups/create

Required parameters: parent

Optional parameters: backupId

Body:

{:description string, :labels {}, :sourceInstance string, :downloadBytes string, :name string, :createTime string, :state string, :satisfiesPzs boolean, :sourceInstanceTier string, :sourceFileShare string, :storageBytes string, :capacityGb string}

Creates a backup.

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/backups/create

Required parameters: parent

Optional parameters: backupId

Body: 

{:description string,
 :labels {},
 :sourceInstance string,
 :downloadBytes string,
 :name string,
 :createTime string,
 :state string,
 :satisfiesPzs boolean,
 :sourceInstanceTier string,
 :sourceFileShare string,
 :storageBytes string,
 :capacityGb string}

Creates a backup.
sourceraw docstring

locations-backups-delete$clj

(locations-backups-delete$ auth parameters)

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/backups/delete

Required parameters: name

Optional parameters: none

Deletes a backup.

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/backups/delete

Required parameters: name

Optional parameters: none

Deletes a backup.
sourceraw docstring

locations-backups-get$clj

(locations-backups-get$ auth parameters)

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/backups/get

Required parameters: name

Optional parameters: none

Gets the details of a specific backup.

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/backups/get

Required parameters: name

Optional parameters: none

Gets the details of a specific backup.
sourceraw docstring

locations-backups-list$clj

(locations-backups-list$ auth parameters)

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/backups/list

Required parameters: parent

Optional parameters: pageSize, orderBy, filter, pageToken

Lists all backups in a project for either a specified location or for all locations.

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/backups/list

Required parameters: parent

Optional parameters: pageSize, orderBy, filter, pageToken

Lists all backups in a project for either a specified location or for all locations.
sourceraw docstring

locations-backups-patch$clj

(locations-backups-patch$ auth parameters body)

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/backups/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:description string, :labels {}, :sourceInstance string, :downloadBytes string, :name string, :createTime string, :state string, :satisfiesPzs boolean, :sourceInstanceTier string, :sourceFileShare string, :storageBytes string, :capacityGb string}

Updates the settings of a specific backup.

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/backups/patch

Required parameters: name

Optional parameters: updateMask

Body: 

{:description string,
 :labels {},
 :sourceInstance string,
 :downloadBytes string,
 :name string,
 :createTime string,
 :state string,
 :satisfiesPzs boolean,
 :sourceInstanceTier string,
 :sourceFileShare string,
 :storageBytes string,
 :capacityGb string}

Updates the settings of a specific backup.
sourceraw docstring

locations-get$clj

(locations-get$ auth parameters)

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/get

Required parameters: name

Optional parameters: none

Gets information about a location.

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/get

Required parameters: name

Optional parameters: none

Gets information about a location.
sourceraw docstring

locations-instances-create$clj

(locations-instances-create$ auth parameters body)

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/instances/create

Required parameters: parent

Optional parameters: instanceId

Body:

{:description string, :labels {}, :tier string, :fileShares [{:name string, :sourceBackup string, :capacityGb string, :nfsExportOptions [NfsExportOptions]}], :name string, :statusMessage string, :createTime string, :etag string, :state string, :networks [{:network string, :modes [string], :reservedIpRange string, :ipAddresses [string]}], :satisfiesPzs boolean}

Creates an instance. When creating from a backup, the capacity of the new instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/instances/create

Required parameters: parent

Optional parameters: instanceId

Body: 

{:description string,
 :labels {},
 :tier string,
 :fileShares [{:name string,
               :sourceBackup string,
               :capacityGb string,
               :nfsExportOptions [NfsExportOptions]}],
 :name string,
 :statusMessage string,
 :createTime string,
 :etag string,
 :state string,
 :networks [{:network string,
             :modes [string],
             :reservedIpRange string,
             :ipAddresses [string]}],
 :satisfiesPzs boolean}

Creates an instance. When creating from a backup, the capacity of the new instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).
sourceraw docstring

locations-instances-delete$clj

(locations-instances-delete$ auth parameters)

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/instances/delete

Required parameters: name

Optional parameters: none

Deletes an instance.

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/instances/delete

Required parameters: name

Optional parameters: none

Deletes an instance.
sourceraw docstring

locations-instances-get$clj

(locations-instances-get$ auth parameters)

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/instances/get

Required parameters: name

Optional parameters: none

Gets the details of a specific instance.

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/instances/get

Required parameters: name

Optional parameters: none

Gets the details of a specific instance.
sourceraw docstring

locations-instances-list$clj

(locations-instances-list$ auth parameters)

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/instances/list

Required parameters: parent

Optional parameters: pageSize, pageToken, orderBy, filter

Lists all instances in a project for either a specified location or for all locations.

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/instances/list

Required parameters: parent

Optional parameters: pageSize, pageToken, orderBy, filter

Lists all instances in a project for either a specified location or for all locations.
sourceraw docstring

locations-instances-patch$clj

(locations-instances-patch$ auth parameters body)

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/instances/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:description string, :labels {}, :tier string, :fileShares [{:name string, :sourceBackup string, :capacityGb string, :nfsExportOptions [NfsExportOptions]}], :name string, :statusMessage string, :createTime string, :etag string, :state string, :networks [{:network string, :modes [string], :reservedIpRange string, :ipAddresses [string]}], :satisfiesPzs boolean}

Updates the settings of a specific instance.

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/instances/patch

Required parameters: name

Optional parameters: updateMask

Body: 

{:description string,
 :labels {},
 :tier string,
 :fileShares [{:name string,
               :sourceBackup string,
               :capacityGb string,
               :nfsExportOptions [NfsExportOptions]}],
 :name string,
 :statusMessage string,
 :createTime string,
 :etag string,
 :state string,
 :networks [{:network string,
             :modes [string],
             :reservedIpRange string,
             :ipAddresses [string]}],
 :satisfiesPzs boolean}

Updates the settings of a specific instance.
sourceraw docstring

locations-instances-restore$clj

(locations-instances-restore$ auth parameters body)

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/instances/restore

Required parameters: name

Optional parameters: none

Body:

{:sourceBackup string, :fileShare string}

Restores an existing instance's file share from a backup. The capacity of the instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/instances/restore

Required parameters: name

Optional parameters: none

Body: 

{:sourceBackup string, :fileShare string}

Restores an existing instance's file share from a backup. The capacity of the instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).
sourceraw docstring

locations-list$clj

(locations-list$ auth parameters)

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/list

Required parameters: name

Optional parameters: includeUnrevealedLocations, filter, pageSize, pageToken

Lists information about the supported locations for this service.

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/list

Required parameters: name

Optional parameters: includeUnrevealedLocations, filter, pageSize, pageToken

Lists information about the supported locations for this service.
sourceraw docstring

locations-operations-cancel$clj

(locations-operations-cancel$ auth parameters body)

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/operations/cancel

Required parameters: name

Optional parameters: none

Body:

{}

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.

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/operations/cancel

Required parameters: name

Optional parameters: none

Body: 

{}

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`.
sourceraw docstring

locations-operations-delete$clj

(locations-operations-delete$ auth parameters)

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/operations/delete

Required parameters: name

Optional parameters: none

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.

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/operations/delete

Required parameters: name

Optional parameters: none

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`.
sourceraw docstring

locations-operations-get$clj

(locations-operations-get$ auth parameters)

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/operations/get

Required parameters: name

Optional parameters: none

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.

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/operations/get

Required parameters: name

Optional parameters: none

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.
sourceraw docstring

locations-operations-list$clj

(locations-operations-list$ auth parameters)

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/operations/list

Required parameters: name

Optional parameters: pageToken, filter, pageSize

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

https://cloud.google.com/filestore/api/reference/rest/v1/projects/locations/operations/list

Required parameters: name

Optional parameters: pageToken, filter, pageSize

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close