2023-08-12
▼ ▲ redis.projects.locations.clusters.get
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}
Description: Gets the details of a specific Redis cluster.
Path: v1beta1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
HTTP Method: GET
Parameters:
name
Location: path
Required: Yes
Description: 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.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
▼ ▲ redis.projects.locations.clusters.getCertificateAuthority
HTTP Method: GET
Path: v1beta1/{+name}/certificateAuthority
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets the details of certificate authority information for Redis cluster.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/certificateAuthority
Parameter Order: name
Parameters:
name
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Required: Yes
Description: 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.
▼ ▲ redis.projects.locations.clusters.create
HTTP Method: POST
Description: Creates a Redis cluster based on the specified tier and memory size. 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.
Parameter Order: parent
Parameters:
requestId
Type: string
Description: Idempotent request UUID.
Location: query
clusterId
Location: query
Type: string
Description: Required. The logical name of the Redis cluster in the customer project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the customer project / location
parent
Location: path
Description: 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.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/clusters
Path: v1beta1/{+parent}/clusters
▼ ▲ redis.projects.locations.clusters.patch
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}
Parameter Order: name
Parameters:
name
Description: Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Type: string
Required: Yes
Location: path
updateMask
Type: string
Format: google-fieldmask
Location: query
Description: Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from Cluster: * `size_gb` * `replica_count`
requestId
Description: Idempotent request UUID.
Location: query
Type: string
Path: v1beta1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: PATCH
Description: 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.
▼ ▲ redis.projects.locations.clusters.list
Description: 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.
Path: v1beta1/{+parent}/clusters
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
pageToken
Type: string
Description: The `next_page_token` value returned from a previous ListClusters request, if any.
Location: query
parent
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: 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.
Required: Yes
pageSize
Type: integer
Format: int32
Description: The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's `next_page_token` to determine if there are more clusters left to be queried.
Location: query
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/clusters
Parameter Order: parent
▼ ▲ redis.projects.locations.clusters.delete
Parameters:
requestId
Type: string
Location: query
Description: Idempotent request UUID.
name
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Location: path
Type: string
Required: Yes
Description: 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.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}
HTTP Method: DELETE
Parameter Order: name
Path: v1beta1/{+name}
Description: Deletes a specific Redis cluster. Cluster stops serving and data is deleted.