class ProjectsLocationsClusters extends Resource (View source)

The "clusters" collection of methods.

Typical usage is:

 $redisService = new Google\Service\CloudRedis(...);
 $clusters = $redisService->projects_locations_clusters;

Methods

create(string $parent, Cluster $postBody, array $optParams = [])

Creates a Redis cluster based on the specified properties. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis cluster will be fully functional. The completed longrunning.Operation will contain the new cluster object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

delete(string $name, array $optParams = [])

Deletes a specific Redis cluster. Cluster stops serving and data is deleted.

get(string $name, array $optParams = [])

Gets the details of a specific Redis cluster. (clusters.get)

getCertificateAuthority(string $name, array $optParams = [])

Gets the details of certificate authority information for Redis cluster.

listProjectsLocationsClusters(string $parent, array $optParams = [])

Lists all Redis clusters 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. (clusters.listProjectsLocationsClusters)

patch(string $name, Cluster $postBody, array $optParams = [])

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

Details

Operation create(string $parent, Cluster $postBody, array $optParams = [])

Creates a Redis cluster based on the specified properties. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis cluster will be fully functional. The completed longrunning.Operation will contain the new cluster object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

(clusters.create)

Parameters

string $parent

Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

Cluster $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation delete(string $name, array $optParams = [])

Deletes a specific Redis cluster. Cluster stops serving and data is deleted.

(clusters.delete)

Parameters

string $name

Required. Redis cluster resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Cluster get(string $name, array $optParams = [])

Gets the details of a specific Redis cluster. (clusters.get)

Parameters

string $name

Required. Redis cluster resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

array $optParams

Optional parameters.

Return Value

Cluster

Exceptions

Exception

CertificateAuthority getCertificateAuthority(string $name, array $optParams = [])

Gets the details of certificate authority information for Redis cluster.

(clusters.getCertificateAuthority)

Parameters

string $name

Required. Redis cluster certificate authority resource name using the form: projects/{project_id}/locations/{location_id}/clusters/ {cluster_id}/certificateAuthority where location_id refers to a GCP region.

array $optParams

Optional parameters.

Return Value

CertificateAuthority

Exceptions

Exception

ListClustersResponse listProjectsLocationsClusters(string $parent, array $optParams = [])

Lists all Redis clusters 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. (clusters.listProjectsLocationsClusters)

Parameters

string $parent

Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

array $optParams

Optional parameters.

Return Value

ListClustersResponse

Exceptions

Exception

Operation patch(string $name, Cluster $postBody, array $optParams = [])

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

Parameters

string $name

Required. Identifier. Unique name of the resource in this scope including project and location using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id}

Cluster $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception