Liking cljdoc? Tell your friends :D

happygapi.redis.projects

Google Cloud Memorystore for Redis API: projects. Creates and manages Redis instances on the Google Cloud Platform. See: https://cloud.google.com/memorystore/docs/redis/api/reference/rest/v1/projects

Google Cloud Memorystore for Redis API: projects.
Creates and manages Redis instances on the Google Cloud Platform.
See: https://cloud.google.com/memorystore/docs/redis/api/reference/rest/v1/projects
raw docstring

locations-get$clj

(locations-get$ auth parameters)

https://cloud.google.com/memorystore/docs/redis/api/reference/rest/v1/projects/locations/get

Required parameters: name

Optional parameters: none

Gets information about a location.

https://cloud.google.com/memorystore/docs/redis/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/memorystore/docs/redis/api/reference/rest/v1/projects/locations/instances/create

Required parameters: parent

Optional parameters: instanceId

Body:

{:labels {}, :tier string, :connectMode string, :memorySizeGb integer, :authEnabled boolean, :redisVersion string, :displayName string, :locationId string, :name string, :reservedIpRange string, :statusMessage string, :createTime string, :maintenanceSchedule {:canReschedule boolean, :scheduleDeadlineTime string, :endTime string, :startTime string}, :state string, :port integer, :redisConfigs {}, :maintenancePolicy {:createTime string, :updateTime string, :weeklyMaintenanceWindow [WeeklyMaintenanceWindow], :description string}, :persistenceIamIdentity string, :host string, :serverCaCerts [{:createTime string, :sha1Fingerprint string, :cert string, :serialNumber string, :expireTime string}], :currentLocationId string, :alternativeLocationId string, :transitEncryptionMode string, :authorizedNetwork string}

Creates a Redis instance based on the specified tier and memory size. By default, the instance is accessible from the project's default network. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

https://cloud.google.com/memorystore/docs/redis/api/reference/rest/v1/projects/locations/instances/create

Required parameters: parent

Optional parameters: instanceId

Body: 

{:labels {},
 :tier string,
 :connectMode string,
 :memorySizeGb integer,
 :authEnabled boolean,
 :redisVersion string,
 :displayName string,
 :locationId string,
 :name string,
 :reservedIpRange string,
 :statusMessage string,
 :createTime string,
 :maintenanceSchedule {:canReschedule boolean,
                       :scheduleDeadlineTime string,
                       :endTime string,
                       :startTime string},
 :state string,
 :port integer,
 :redisConfigs {},
 :maintenancePolicy {:createTime string,
                     :updateTime string,
                     :weeklyMaintenanceWindow [WeeklyMaintenanceWindow],
                     :description string},
 :persistenceIamIdentity string,
 :host string,
 :serverCaCerts [{:createTime string,
                  :sha1Fingerprint string,
                  :cert string,
                  :serialNumber string,
                  :expireTime string}],
 :currentLocationId string,
 :alternativeLocationId string,
 :transitEncryptionMode string,
 :authorizedNetwork string}

Creates a Redis instance based on the specified tier and memory size. By default, the instance is accessible from the project's [default network](https://cloud.google.com/vpc/docs/vpc). The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
sourceraw docstring

locations-instances-delete$clj

(locations-instances-delete$ auth parameters)

https://cloud.google.com/memorystore/docs/redis/api/reference/rest/v1/projects/locations/instances/delete

Required parameters: name

Optional parameters: none

Deletes a specific Redis instance. Instance stops serving and data is deleted.

https://cloud.google.com/memorystore/docs/redis/api/reference/rest/v1/projects/locations/instances/delete

Required parameters: name

Optional parameters: none

Deletes a specific Redis instance. Instance stops serving and data is deleted.
sourceraw docstring

locations-instances-export$clj

(locations-instances-export$ auth parameters body)

https://cloud.google.com/memorystore/docs/redis/api/reference/rest/v1/projects/locations/instances/export

Required parameters: name

Optional parameters: none

Body:

{:outputConfig {:gcsDestination GcsDestination}}

Export Redis instance data into a Redis RDB format file in Cloud Storage. Redis will continue serving during this operation. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

https://cloud.google.com/memorystore/docs/redis/api/reference/rest/v1/projects/locations/instances/export

Required parameters: name

Optional parameters: none

Body: 

{:outputConfig {:gcsDestination GcsDestination}}

Export Redis instance data into a Redis RDB format file in Cloud Storage. Redis will continue serving during this operation. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
sourceraw docstring

locations-instances-failover$clj

(locations-instances-failover$ auth parameters body)

https://cloud.google.com/memorystore/docs/redis/api/reference/rest/v1/projects/locations/instances/failover

Required parameters: name

Optional parameters: none

Body:

{:dataProtectionMode string}

Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.

https://cloud.google.com/memorystore/docs/redis/api/reference/rest/v1/projects/locations/instances/failover

Required parameters: name

Optional parameters: none

Body: 

{:dataProtectionMode string}

Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.
sourceraw docstring

locations-instances-get$clj

(locations-instances-get$ auth parameters)

https://cloud.google.com/memorystore/docs/redis/api/reference/rest/v1/projects/locations/instances/get

Required parameters: name

Optional parameters: none

Gets the details of a specific Redis instance.

https://cloud.google.com/memorystore/docs/redis/api/reference/rest/v1/projects/locations/instances/get

Required parameters: name

Optional parameters: none

Gets the details of a specific Redis instance.
sourceraw docstring

locations-instances-getAuthString$clj

(locations-instances-getAuthString$ auth parameters)

https://cloud.google.com/memorystore/docs/redis/api/reference/rest/v1/projects/locations/instances/getAuthString

Required parameters: name

Optional parameters: none

Gets the AUTH string for a Redis instance. If AUTH is not enabled for the instance the response will be empty. This information is not included in the details returned to GetInstance.

https://cloud.google.com/memorystore/docs/redis/api/reference/rest/v1/projects/locations/instances/getAuthString

Required parameters: name

Optional parameters: none

Gets the AUTH string for a Redis instance. If AUTH is not enabled for the instance the response will be empty. This information is not included in the details returned to GetInstance.
sourceraw docstring

locations-instances-import$clj

(locations-instances-import$ auth parameters body)

https://cloud.google.com/memorystore/docs/redis/api/reference/rest/v1/projects/locations/instances/import

Required parameters: name

Optional parameters: none

Body:

{:inputConfig {:gcsSource GcsSource}}

Import a Redis RDB snapshot file from Cloud Storage into a Redis instance. Redis may stop serving during this operation. Instance state will be IMPORTING for entire operation. When complete, the instance will contain only data from the imported file. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

https://cloud.google.com/memorystore/docs/redis/api/reference/rest/v1/projects/locations/instances/import

Required parameters: name

Optional parameters: none

Body: 

{:inputConfig {:gcsSource GcsSource}}

Import a Redis RDB snapshot file from Cloud Storage into a Redis instance. Redis may stop serving during this operation. Instance state will be IMPORTING for entire operation. When complete, the instance will contain only data from the imported file. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
sourceraw docstring

locations-instances-list$clj

(locations-instances-list$ auth parameters)

https://cloud.google.com/memorystore/docs/redis/api/reference/rest/v1/projects/locations/instances/list

Required parameters: parent

Optional parameters: pageSize, pageToken

Lists all Redis instances owned by a project in either the specified location (region) or all locations. The location should have the following format: * projects/{project_id}/locations/{location_id} If location_id is specified as - (wildcard), then all regions available to the project are queried, and the results are aggregated.

https://cloud.google.com/memorystore/docs/redis/api/reference/rest/v1/projects/locations/instances/list

Required parameters: parent

Optional parameters: pageSize, pageToken

Lists all Redis instances owned by a project in either the specified location (region) or all locations. The location should have the following format: * `projects/{project_id}/locations/{location_id}` If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated.
sourceraw docstring

locations-instances-patch$clj

(locations-instances-patch$ auth parameters body)

https://cloud.google.com/memorystore/docs/redis/api/reference/rest/v1/projects/locations/instances/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:labels {}, :tier string, :connectMode string, :memorySizeGb integer, :authEnabled boolean, :redisVersion string, :displayName string, :locationId string, :name string, :reservedIpRange string, :statusMessage string, :createTime string, :maintenanceSchedule {:canReschedule boolean, :scheduleDeadlineTime string, :endTime string, :startTime string}, :state string, :port integer, :redisConfigs {}, :maintenancePolicy {:createTime string, :updateTime string, :weeklyMaintenanceWindow [WeeklyMaintenanceWindow], :description string}, :persistenceIamIdentity string, :host string, :serverCaCerts [{:createTime string, :sha1Fingerprint string, :cert string, :serialNumber string, :expireTime string}], :currentLocationId string, :alternativeLocationId string, :transitEncryptionMode string, :authorizedNetwork string}

Updates the metadata and configuration of a specific Redis instance. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

https://cloud.google.com/memorystore/docs/redis/api/reference/rest/v1/projects/locations/instances/patch

Required parameters: name

Optional parameters: updateMask

Body: 

{:labels {},
 :tier string,
 :connectMode string,
 :memorySizeGb integer,
 :authEnabled boolean,
 :redisVersion string,
 :displayName string,
 :locationId string,
 :name string,
 :reservedIpRange string,
 :statusMessage string,
 :createTime string,
 :maintenanceSchedule {:canReschedule boolean,
                       :scheduleDeadlineTime string,
                       :endTime string,
                       :startTime string},
 :state string,
 :port integer,
 :redisConfigs {},
 :maintenancePolicy {:createTime string,
                     :updateTime string,
                     :weeklyMaintenanceWindow [WeeklyMaintenanceWindow],
                     :description string},
 :persistenceIamIdentity string,
 :host string,
 :serverCaCerts [{:createTime string,
                  :sha1Fingerprint string,
                  :cert string,
                  :serialNumber string,
                  :expireTime string}],
 :currentLocationId string,
 :alternativeLocationId string,
 :transitEncryptionMode string,
 :authorizedNetwork string}

Updates the metadata and configuration of a specific Redis instance. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
sourceraw docstring

locations-instances-rescheduleMaintenance$clj

(locations-instances-rescheduleMaintenance$ auth parameters body)

https://cloud.google.com/memorystore/docs/redis/api/reference/rest/v1/projects/locations/instances/rescheduleMaintenance

Required parameters: name

Optional parameters: none

Body:

{:scheduleTime string, :rescheduleType string}

Reschedule maintenance for a given instance in a given project and location.

https://cloud.google.com/memorystore/docs/redis/api/reference/rest/v1/projects/locations/instances/rescheduleMaintenance

Required parameters: name

Optional parameters: none

Body: 

{:scheduleTime string, :rescheduleType string}

Reschedule maintenance for a given instance in a given project and location.
sourceraw docstring

locations-instances-upgrade$clj

(locations-instances-upgrade$ auth parameters body)

https://cloud.google.com/memorystore/docs/redis/api/reference/rest/v1/projects/locations/instances/upgrade

Required parameters: name

Optional parameters: none

Body:

{:redisVersion string}

Upgrades Redis instance to the newer Redis version specified in the request.

https://cloud.google.com/memorystore/docs/redis/api/reference/rest/v1/projects/locations/instances/upgrade

Required parameters: name

Optional parameters: none

Body: 

{:redisVersion string}

Upgrades Redis instance to the newer Redis version specified in the request.
sourceraw docstring

locations-list$clj

(locations-list$ auth parameters)

https://cloud.google.com/memorystore/docs/redis/api/reference/rest/v1/projects/locations/list

Required parameters: name

Optional parameters: filter, pageSize, pageToken

Lists information about the supported locations for this service.

https://cloud.google.com/memorystore/docs/redis/api/reference/rest/v1/projects/locations/list

Required parameters: name

Optional parameters: filter, pageSize, pageToken

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

locations-operations-cancel$clj

(locations-operations-cancel$ auth parameters)

https://cloud.google.com/memorystore/docs/redis/api/reference/rest/v1/projects/locations/operations/cancel

Required parameters: name

Optional parameters: none

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/memorystore/docs/redis/api/reference/rest/v1/projects/locations/operations/cancel

Required parameters: name

Optional parameters: none

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/memorystore/docs/redis/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/memorystore/docs/redis/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/memorystore/docs/redis/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/memorystore/docs/redis/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/memorystore/docs/redis/api/reference/rest/v1/projects/locations/operations/list

Required parameters: name

Optional parameters: pageSize, pageToken, filter

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/memorystore/docs/redis/api/reference/rest/v1/projects/locations/operations/list

Required parameters: name

Optional parameters: pageSize, pageToken, filter

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