2023-09-29
▼ ▲ redis.projects.locations.clusters.create
Description: 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.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/clusters
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/clusters
Parameter Order: parent
Parameters:
requestId
Type: string
Description: Idempotent request UUID.
Location: query
clusterId
Type: string
Location: query
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
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.
Type: string
Required: Yes
▼ ▲ redis.projects.locations.clusters.patch
Parameter Order: name
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.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: PATCH
Path: v1/{+name}
Parameters:
requestId
Description: Idempotent request UUID.
Type: string
Location: query
updateMask
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`
Location: query
Format: google-fieldmask
Type: string
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
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}`
Type: string
Required: Yes
▼ ▲ redis.projects.locations.clusters.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}
Path: v1/{+name}
HTTP Method: GET
Parameter Order: name
Description: Gets the details of a specific Redis cluster.
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
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.
▼ ▲ redis.projects.locations.clusters.list
HTTP Method: GET
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/clusters
Parameters:
pageToken
Location: query
Description: The `next_page_token` value returned from a previous ListClusters request, if any.
Type: string
parent
Required: Yes
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.
pageSize
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
Type: integer
Format: int32
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/clusters
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.
▼ ▲ redis.projects.locations.clusters.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
HTTP Method: DELETE
Description: Deletes a specific Redis cluster. Cluster stops serving and data is deleted.
Parameters:
requestId
Type: string
Description: Idempotent request UUID.
Location: query
name
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
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
Location: path
Required: Yes
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}
Path: v1/{+name}
▼ ▲ redis.projects.locations.clusters.getCertificateAuthority
Description: Gets the details of certificate authority information for Redis cluster.
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Type: string
Location: path
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.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Path: v1/{+name}/certificateAuthority
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/certificateAuthority
▼ ▲ redis.projects.locations.clusters.getCertificateAuthority
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/certificateAuthority
Parameter Order: name
Path: v1/{+name}/certificateAuthority
Description: Gets the details of certificate authority information for Redis cluster.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
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
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
requestId
Type: string
Description: Idempotent request UUID.
Location: query
parent
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Type: string
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.
clusterId
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
Location: query
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/clusters
Description: 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.
Parameter Order: parent
Path: v1/{+parent}/clusters
HTTP Method: POST
▼ ▲ redis.projects.locations.clusters.patch
HTTP Method: PATCH
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
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.
Path: v1/{+name}
Parameters:
requestId
Description: Idempotent request UUID.
Type: string
Location: query
updateMask
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`
Format: google-fieldmask
Type: string
name
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Location: path
Type: string
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}`
Required: Yes
▼ ▲ redis.projects.locations.clusters.delete
Description: Deletes a specific Redis cluster. Cluster stops serving and data is deleted.
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
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.
Required: Yes
Location: path
requestId
Location: query
Description: Idempotent request UUID.
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Parameter Order: name
▼ ▲ redis.projects.locations.clusters.get
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Description: Gets the details of a specific Redis cluster.
Parameters:
name
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
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Required: Yes
Path: v1/{+name}
▼ ▲ redis.projects.locations.clusters.list
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/clusters
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: v1/{+parent}/clusters
Parameters:
pageSize
Location: query
Type: integer
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.
Format: int32
pageToken
Type: string
Description: The `next_page_token` value returned from a previous ListClusters request, if any.
Location: query
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.
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Type: string