Class API

constructor

• new API(client): Redis.v1.API

• Parameters

  • client: Client

  Returns Redis.v1.API

Static ReadonlyLOCALITIES

addAclRules

• addAclRules(request): Promise<AddAclRulesResponse>

• Add ACL rules for a cluster. Add an additional ACL rule to a Redis™ Database Instance (Redis™ cluster).

  Parameters

  • request: Readonly<AddAclRulesRequest>

    The request AddAclRulesRequest

  Returns Promise<AddAclRulesResponse>

  A Promise of AddAclRulesResponse

addClusterSettings

• addClusterSettings(request): Promise<ClusterSettingsResponse>

• Add advanced settings. Add an advanced setting to a Redis™ Database Instance (Redis™ cluster). You must set the name and the value of each setting.

  Parameters

  • request: Readonly<AddClusterSettingsRequest>

    The request AddClusterSettingsRequest

  Returns Promise<ClusterSettingsResponse>

  A Promise of ClusterSettingsResponse

addEndpoints

• addEndpoints(request): Promise<AddEndpointsResponse>

• Add endpoints for a cluster. Add a new endpoint for a Redis™ Database Instance (Redis™ cluster). You can add private_network or public_network specifications to the body of the request.

  Parameters

  • request: Readonly<AddEndpointsRequest>

    The request AddEndpointsRequest

  Returns Promise<AddEndpointsResponse>

  A Promise of AddEndpointsResponse

createCluster

• createCluster(request): Promise<Redis.v1.Cluster>

• Create a Redis™ Database Instance. Create a new Redis™ Database Instance (Redis™ cluster). You must set the zone, project_id, version, node_type, user_name and password parameters. Optionally you can define acl_rules, endpoints, tls_enabled and cluster_settings.

  Parameters

  • request: Readonly<Redis.v1.CreateClusterRequest>

    The request CreateClusterRequest

  Returns Promise<Redis.v1.Cluster>

  A Promise of Cluster

deleteAclRule

• deleteAclRule(request): Promise<Redis.v1.Cluster>

• Delete an ACL rule for a cluster. Delete an ACL rule of a Redis™ Database Instance (Redis™ cluster). You must specify the acl_id of the rule you want to delete in your request.

  Parameters

  • request: Readonly<DeleteAclRuleRequest>

    The request DeleteAclRuleRequest

  Returns Promise<Redis.v1.Cluster>

  A Promise of Cluster

deleteCluster

• deleteCluster(request): Promise<Redis.v1.Cluster>

• Delete a Redis™ Database Instance. Delete a Redis™ Database Instance (Redis™ cluster), specified by the region and cluster_id parameters. Deleting a Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost.

  Parameters

  • request: Readonly<Redis.v1.DeleteClusterRequest>

    The request DeleteClusterRequest

  Returns Promise<Redis.v1.Cluster>

  A Promise of Cluster

deleteClusterSetting

• deleteClusterSetting(request): Promise<Redis.v1.Cluster>

• Delete advanced setting. Delete an advanced setting in a Redis™ Database Instance (Redis™ cluster). You must specify the names of the settings you want to delete in the request body.

  Parameters

  • request: Readonly<DeleteClusterSettingRequest>

    The request DeleteClusterSettingRequest

  Returns Promise<Redis.v1.Cluster>

  A Promise of Cluster

deleteEndpoint

• deleteEndpoint(request): Promise<Redis.v1.Cluster>

• Delete an endpoint for a cluster. Delete the endpoint of a Redis™ Database Instance (Redis™ cluster). You must specify the region and endpoint_id parameters of the endpoint you want to delete. Note that might need to update any environment configurations that point to the deleted endpoint.

  Parameters

  • request: Readonly<Redis.v1.DeleteEndpointRequest>

    The request DeleteEndpointRequest

  Returns Promise<Redis.v1.Cluster>

  A Promise of Cluster

getAclRule

• getAclRule(request): Promise<Redis.v1.ACLRule>

• Get an ACL rule. Retrieve information about an ACL rule of a Redis™ Database Instance (Redis™ cluster). You must specify the acl_id of the rule in your request.

  Parameters

  • request: Readonly<GetAclRuleRequest>

    The request GetAclRuleRequest

  Returns Promise<Redis.v1.ACLRule>

  A Promise of ACLRule

getCluster

• getCluster(request): Promise<Redis.v1.Cluster>

• Get a Redis™ Database Instance. Retrieve information about a Redis™ Database Instance (Redis™ cluster). Specify the cluster_id and region in your request to get information such as id, status, version, tls_enabled, cluster_settings, upgradable_versions and endpoints about your cluster in the response.

  Parameters

  • request: Readonly<Redis.v1.GetClusterRequest>

    The request GetClusterRequest

  Returns Promise<Redis.v1.Cluster>

  A Promise of Cluster

getClusterCertificate

• getClusterCertificate(request): Promise<Blob>

• Get the TLS certificate of a cluster. Retrieve information about the TLS certificate of a Redis™ Database Instance (Redis™ cluster). Details like name and content are returned in the response.

  Parameters

  • request: Readonly<GetClusterCertificateRequest>

    The request GetClusterCertificateRequest

  Returns Promise<Blob>

  A Promise of Blob

getClusterMetrics

• getClusterMetrics(request): Promise<ClusterMetricsResponse>

• Get metrics of a Redis™ Database Instance. Retrieve the metrics of a Redis™ Database Instance (Redis™ cluster). You can define the period from which to retrieve metrics by specifying the start_date and end_date.

  Parameters

  • request: Readonly<GetClusterMetricsRequest>

    The request GetClusterMetricsRequest

  Returns Promise<ClusterMetricsResponse>

  A Promise of ClusterMetricsResponse

getEndpoint

• getEndpoint(request): Promise<Redis.v1.Endpoint>

• Get an endpoint. Retrieve information about a Redis™ Database Instance (Redis™ cluster) endpoint. Full details about the endpoint, like ips, port, private_network and public_network specifications are returned in the response.

  Parameters

  • request: Readonly<Redis.v1.GetEndpointRequest>

    The request GetEndpointRequest

  Returns Promise<Redis.v1.Endpoint>

  A Promise of Endpoint

listClusterVersions

• listClusterVersions(request): Promise<ListClusterVersionsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<ClusterVersion[], void, void>);
      all: (() => Promise<ClusterVersion[]>);
  }

• List available Redis™ versions. List the Redis™ database engine versions available. You can define additional parameters for your query, such as include_disabled, include_beta, include_deprecated and version.

  Parameters

  • request: Readonly<ListClusterVersionsRequest>

    The request ListClusterVersionsRequest

  Returns Promise<ListClusterVersionsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<ClusterVersion[], void, void>);
      all: (() => Promise<ClusterVersion[]>);
  }

  A Promise of ListClusterVersionsResponse

listClusters

• listClusters(request?): Promise<Redis.v1.ListClustersResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Redis.v1.Cluster[], void, void>);
      all: (() => Promise<Redis.v1.Cluster[]>);
  }

• List Redis™ Database Instances. List all Redis™ Database Instances (Redis™ cluster) in the specified zone. By default, the Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as tags, name, organization_id and version.

  Parameters

  • request: Readonly<Redis.v1.ListClustersRequest> = {}

    The request ListClustersRequest

  Returns Promise<Redis.v1.ListClustersResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Redis.v1.Cluster[], void, void>);
      all: (() => Promise<Redis.v1.Cluster[]>);
  }

  A Promise of ListClustersResponse

listNodeTypes

• listNodeTypes(request): Promise<Redis.v1.ListNodeTypesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Redis.v1.NodeType[], void, void>);
      all: (() => Promise<Redis.v1.NodeType[]>);
  }

• List available node types. List all available node types. By default, the node types returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.

  Parameters

  • request: Readonly<Redis.v1.ListNodeTypesRequest>

    The request ListNodeTypesRequest

  Returns Promise<Redis.v1.ListNodeTypesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Redis.v1.NodeType[], void, void>);
      all: (() => Promise<Redis.v1.NodeType[]>);
  }

  A Promise of ListNodeTypesResponse

migrateCluster

• migrateCluster(request): Promise<Redis.v1.Cluster>

• Scale up a Redis™ Database Instance. Upgrade your Redis™ Database Instance, either by upgrading to a bigger node type (vertical scaling) or by adding more nodes to your Database Instance to increase your number of endpoints and distribute cache (horizontal scaling, available for clusters only). Note that scaling horizontally your Redis™ Database Instance will not renew its TLS certificate. In order to refresh the TLS certificate, you must use the Renew TLS certificate endpoint.

  Parameters

  • request: Readonly<MigrateClusterRequest>

    The request MigrateClusterRequest

  Returns Promise<Redis.v1.Cluster>

  A Promise of Cluster

renewClusterCertificate

• renewClusterCertificate(request): Promise<Redis.v1.Cluster>

• Renew the TLS certificate of a cluster. Renew a TLS certificate for a Redis™ Database Instance (Redis™ cluster). Renewing a certificate means that you will not be able to connect to your Database Instance using the previous certificate. You will also need to download and update the new certificate for all database clients.

  Parameters

  • request: Readonly<RenewClusterCertificateRequest>

    The request RenewClusterCertificateRequest

  Returns Promise<Redis.v1.Cluster>

  A Promise of Cluster

setAclRules

• setAclRules(request): Promise<SetAclRulesResponse>

• Set ACL rules for a cluster. Replace all the ACL rules of a Redis™ Database Instance (Redis™ cluster).

  Parameters

  • request: Readonly<SetAclRulesRequest>

    The request SetAclRulesRequest

  Returns Promise<SetAclRulesResponse>

  A Promise of SetAclRulesResponse

setClusterSettings

• setClusterSettings(request): Promise<ClusterSettingsResponse>

• Set advanced settings. Update an advanced setting for a Redis™ Database Instance (Redis™ cluster). Settings added upon database engine initalization can only be defined once, and cannot, therefore, be updated.

  Parameters

  • request: Readonly<SetClusterSettingsRequest>

    The request SetClusterSettingsRequest

  Returns Promise<ClusterSettingsResponse>

  A Promise of ClusterSettingsResponse

setEndpoints

• setEndpoints(request): Promise<SetEndpointsResponse>

• Set endpoints for a cluster. Update an endpoint for a Redis™ Database Instance (Redis™ cluster). You must specify the cluster_id and the endpoints parameters in your request.

  Parameters

  • request: Readonly<SetEndpointsRequest>

    The request SetEndpointsRequest

  Returns Promise<SetEndpointsResponse>

  A Promise of SetEndpointsResponse

updateCluster

• updateCluster(request): Promise<Redis.v1.Cluster>

• Update a Redis™ Database Instance. Update the parameters of a Redis™ Database Instance (Redis™ cluster), including name, tags, user_name and password.

  Parameters

  • request: Readonly<Redis.v1.UpdateClusterRequest>

    The request UpdateClusterRequest

  Returns Promise<Redis.v1.Cluster>

  A Promise of Cluster

updateEndpoint

• updateEndpoint(request): Promise<Redis.v1.Endpoint>

• Update an endpoint. Update information about a Redis™ Database Instance (Redis™ cluster) endpoint. Full details about the endpoint, like ips, port, private_network and public_network specifications are returned in the response.

  Parameters

  • request: Readonly<Redis.v1.UpdateEndpointRequest>

    The request UpdateEndpointRequest

  Returns Promise<Redis.v1.Endpoint>

  A Promise of Endpoint

waitForCluster

• waitForCluster(request, options?): Promise<Redis.v1.Cluster>

• Waits for Cluster to be in a final state.

  Parameters

  • request: Readonly<Redis.v1.GetClusterRequest>

    The request GetClusterRequest
  • Optionaloptions: Readonly<WaitForOptions<Redis.v1.Cluster>>

    The waiting options

  Returns Promise<Redis.v1.Cluster>

  A Promise of Cluster