ProjectsLocationsInstances
class ProjectsLocationsInstances extends Resource (View source)
The "instances" collection of methods.
Typical usage is:
$redisService = new Google\Service\CloudRedis(...);
$instances = $redisService->projects_locations_instances;Methods
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.
Deletes a specific Redis instance. Instance stops serving and data is deleted. (instances.delete)
Export Redis instance data into a Redis RDB format file in Cloud Storage.
Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.
Gets the details of a specific Redis instance. (instances.get)
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. (instances.getAuthString)
Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.
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. (instances.listProjectsLocationsInstances)
Reschedule maintenance for a given instance in a given project and location.
Upgrades Redis instance to the newer Redis version specified in the request.
Details
Operation
create(string $parent, Instance $postBody, array $optParams = [])
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.
(instances.create)
Operation
delete(string $name, array $optParams = [])
Deletes a specific Redis instance. Instance stops serving and data is deleted. (instances.delete)
Operation
export(string $name, ExportInstanceRequest $postBody, array $optParams = [])
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. (instances.export)
Operation
failover(string $name, FailoverInstanceRequest $postBody, array $optParams = [])
Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.
(instances.failover)
Instance
get(string $name, array $optParams = [])
Gets the details of a specific Redis instance. (instances.get)
InstanceAuthString
getAuthString(string $name, array $optParams = [])
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. (instances.getAuthString)
Operation
import(string $name, ImportInstanceRequest $postBody, array $optParams = [])
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. (instances.import)
ListInstancesResponse
listProjectsLocationsInstances(string $parent, array $optParams = [])
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. (instances.listProjectsLocationsInstances)
Operation
patch(string $name, Instance $postBody, array $optParams = [])
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. (instances.patch)
Operation
rescheduleMaintenance(string $name, RescheduleMaintenanceRequest $postBody, array $optParams = [])
Reschedule maintenance for a given instance in a given project and location.
(instances.rescheduleMaintenance)
Operation
upgrade(string $name, UpgradeInstanceRequest $postBody, array $optParams = [])
Upgrades Redis instance to the newer Redis version specified in the request.
(instances.upgrade)