Package Methods (2.18.0)

Summary of entries of Methods for redis.

google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient

  CloudRedisAsyncClient 
 ( 
 * 
 , 
 credentials 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 auth 
 . 
 credentials 
 . 
 Credentials 
 ] 
 = 
 None 
 , 
 transport 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 services 
 . 
 cloud_redis 
 . 
 transports 
 . 
 base 
 . 
 CloudRedisTransport 
 , 
 typing 
 . 
 Callable 
 [[ 
 ... 
 ], 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 services 
 . 
 cloud_redis 
 . 
 transports 
 . 
 base 
 . 
 CloudRedisTransport 
 ]]] 
 = 
 'grpc_asyncio' 
 , 
 client_options 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 api_core 
 . 
 client_options 
 . 
 ClientOptions 
 ] 
 = 
 None 
 , 
 client_info 
 : 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 client_info 
 . 
 ClientInfo 
 = 
 

Instantiates the cloud redis async client.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient

google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.cancel_operation

  cancel_operation 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 CancelOperationRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary_async 
 . 
 AsyncRetry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> None 
 

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.cancel_operation

  common_billing_account_path 
 ( 
 billing_account 
 : 
 str 
 ) 
 - 
> str 
 

Returns a fully-qualified billing_account string.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.common_billing_account_path

google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.common_folder_path

  common_folder_path 
 ( 
 folder 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.common_location_path

  common_location_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.common_organization_path

  common_organization_path 
 ( 
 organization 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.common_project_path

  common_project_path 
 ( 
 project 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.create_instance

  create_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 CreateInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 instance_id 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 instance 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 Instance 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary_async 
 . 
 AsyncRetry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation_async 
 . 
 AsyncOperation 
 

Creates a Redis instance based on the specified tier and memory size.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.create_instance

google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.delete_instance

  delete_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 DeleteInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary_async 
 . 
 AsyncRetry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation_async 
 . 
 AsyncOperation 
 

google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.delete_operation

  delete_operation 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 DeleteOperationRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary_async 
 . 
 AsyncRetry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> None 
 

google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.export_instance

  export_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 ExportInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 output_config 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 OutputConfig 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary_async 
 . 
 AsyncRetry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation_async 
 . 
 AsyncOperation 
 

Export Redis instance data into a Redis RDB format file in Cloud Storage.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.export_instance

google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.failover_instance

  failover_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 FailoverInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 data_protection_mode 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 FailoverInstanceRequest 
 . 
 DataProtectionMode 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary_async 
 . 
 AsyncRetry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation_async 
 . 
 AsyncOperation 
 

Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.failover_instance

  from_service_account_file 
 ( 
 filename 
 : 
 str 
 , 
 * 
 args 
 , 
 ** 
 kwargs 
 ) 
 

Creates an instance of this client using the provided credentials file.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.from_service_account_file

  from_service_account_info 
 ( 
 info 
 : 
 dict 
 , 
 * 
 args 
 , 
 ** 
 kwargs 
 ) 
 

Creates an instance of this client using the provided credentials info.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.from_service_account_info

  from_service_account_json 
 ( 
 filename 
 : 
 str 
 , 
 * 
 args 
 , 
 ** 
 kwargs 
 ) 
 

Creates an instance of this client using the provided credentials file.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.from_service_account_json

google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.get_instance

  get_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 GetInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary_async 
 . 
 AsyncRetry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 Instance 
 

Gets the details of a specific Redis instance.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.get_instance

google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.get_instance_auth_string

  get_instance_auth_string 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 GetInstanceAuthStringRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary_async 
 . 
 AsyncRetry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 InstanceAuthString 
 

google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.get_location

  get_location 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 location 
 . 
 locations_pb2 
 . 
 GetLocationRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary_async 
 . 
 AsyncRetry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 location 
 . 
 locations_pb2 
 . 
 Location 
 

google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.get_mtls_endpoint_and_cert_source

  get_mtls_endpoint_and_cert_source 
 ( 
 client_options 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 api_core 
 . 
 client_options 
 . 
 ClientOptions 
 ] 
 = 
 None 
 , 
 ) 
 

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.get_operation

  get_operation 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 GetOperationRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary_async 
 . 
 AsyncRetry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 Operation 
 

Gets the latest state of a long-running operation.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.get_operation

google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.get_transport_class

  get_transport_class 
 ( 
 label 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 ) 
 - 
> typing 
 . 
 Type 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 services 
 . 
 cloud_redis 
 . 
 transports 
 . 
 base 
 . 
 CloudRedisTransport 
 ] 
 

google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.import_instance

  import_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 ImportInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 input_config 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 InputConfig 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary_async 
 . 
 AsyncRetry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation_async 
 . 
 AsyncOperation 
 

Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.import_instance

google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.instance_path

  instance_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 instance 
 : 
 str 
 ) 
 - 
> str 
 

Returns a fully-qualified instance string.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.instance_path

google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.list_instances

  list_instances 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 ListInstancesRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary_async 
 . 
 AsyncRetry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 services 
 . 
 cloud_redis 
 . 
 pagers 
 . 
 ListInstancesAsyncPager 
 

Lists all Redis instances owned by a project in either the specified location (region) or all locations.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.list_instances

google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.list_locations

  list_locations 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 location 
 . 
 locations_pb2 
 . 
 ListLocationsRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary_async 
 . 
 AsyncRetry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 location 
 . 
 locations_pb2 
 . 
 ListLocationsResponse 
 

Lists information about the supported locations for this service.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.list_locations

google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.list_operations

  list_operations 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 ListOperationsRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary_async 
 . 
 AsyncRetry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 ListOperationsResponse 
 

Lists operations that match the specified filter in the request.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.list_operations

  parse_common_billing_account_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parse a billing_account path into its component segments.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.parse_common_billing_account_path

google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.parse_common_folder_path

  parse_common_folder_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parse a folder path into its component segments.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.parse_common_folder_path

google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.parse_common_location_path

  parse_common_location_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parse a location path into its component segments.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.parse_common_location_path

google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.parse_common_organization_path

  parse_common_organization_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parse a organization path into its component segments.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.parse_common_organization_path

google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.parse_common_project_path

  parse_common_project_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parse a project path into its component segments.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.parse_common_project_path

google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.parse_instance_path

  parse_instance_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parses a instance path into its component segments.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.parse_instance_path

google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.reschedule_maintenance

  reschedule_maintenance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 RescheduleMaintenanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 reschedule_type 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 RescheduleMaintenanceRequest 
 . 
 RescheduleType 
 ] 
 = 
 None 
 , 
 schedule_time 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 protobuf 
 . 
 timestamp_pb2 
 . 
 Timestamp 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary_async 
 . 
 AsyncRetry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation_async 
 . 
 AsyncOperation 
 

Reschedule maintenance for a given instance in a given project and location.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.reschedule_maintenance

google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.update_instance

  update_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 UpdateInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 update_mask 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 protobuf 
 . 
 field_mask_pb2 
 . 
 FieldMask 
 ] 
 = 
 None 
 , 
 instance 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 Instance 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary_async 
 . 
 AsyncRetry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation_async 
 . 
 AsyncOperation 
 

Updates the metadata and configuration of a specific Redis instance.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.update_instance

google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.upgrade_instance

  upgrade_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 UpgradeInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 redis_version 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary_async 
 . 
 AsyncRetry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation_async 
 . 
 AsyncOperation 
 

Upgrades Redis instance to the newer Redis version specified in the request.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient.upgrade_instance

google.cloud.redis_v1.services.cloud_redis.CloudRedisClient

  CloudRedisClient 
 ( 
 * 
 , 
 credentials 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 auth 
 . 
 credentials 
 . 
 Credentials 
 ] 
 = 
 None 
 , 
 transport 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 services 
 . 
 cloud_redis 
 . 
 transports 
 . 
 base 
 . 
 CloudRedisTransport 
 , 
 typing 
 . 
 Callable 
 [[ 
 ... 
 ], 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 services 
 . 
 cloud_redis 
 . 
 transports 
 . 
 base 
 . 
 CloudRedisTransport 
 ]]] 
 = 
 None 
 , 
 client_options 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 client_options 
 . 
 ClientOptions 
 , 
 dict 
 ]] 
 = 
 None 
 , 
 client_info 
 : 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 client_info 
 . 
 ClientInfo 
 = 
 

Instantiates the cloud redis client.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisClient

google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.__exit__

  __exit__ 
 ( 
 type 
 , 
 value 
 , 
 traceback 
 ) 
 

Releases underlying transport's resources.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisClient. exit

google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.cancel_operation

  cancel_operation 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 CancelOperationRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> None 
 

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.cancel_operation

  common_billing_account_path 
 ( 
 billing_account 
 : 
 str 
 ) 
 - 
> str 
 

Returns a fully-qualified billing_account string.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.common_billing_account_path

google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.common_folder_path

  common_folder_path 
 ( 
 folder 
 : 
 str 
 ) 
 - 
> str 
 

Returns a fully-qualified folder string.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.common_folder_path

google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.common_location_path

  common_location_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 ) 
 - 
> str 
 

Returns a fully-qualified location string.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.common_location_path

google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.common_organization_path

  common_organization_path 
 ( 
 organization 
 : 
 str 
 ) 
 - 
> str 
 

Returns a fully-qualified organization string.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.common_organization_path

google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.common_project_path

  common_project_path 
 ( 
 project 
 : 
 str 
 ) 
 - 
> str 
 

Returns a fully-qualified project string.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.common_project_path

google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.create_instance

  create_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 CreateInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 instance_id 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 instance 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 Instance 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation 
 . 
 Operation 
 

Creates a Redis instance based on the specified tier and memory size.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.create_instance

google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.delete_instance

  delete_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 DeleteInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation 
 . 
 Operation 
 

google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.delete_operation

  delete_operation 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 DeleteOperationRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> None 
 

google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.export_instance

  export_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 ExportInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 output_config 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 OutputConfig 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation 
 . 
 Operation 
 

Export Redis instance data into a Redis RDB format file in Cloud Storage.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.export_instance

google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.failover_instance

  failover_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 FailoverInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 data_protection_mode 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 FailoverInstanceRequest 
 . 
 DataProtectionMode 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation 
 . 
 Operation 
 

Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.failover_instance

  from_service_account_file 
 ( 
 filename 
 : 
 str 
 , 
 * 
 args 
 , 
 ** 
 kwargs 
 ) 
 

Creates an instance of this client using the provided credentials file.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.from_service_account_file

  from_service_account_info 
 ( 
 info 
 : 
 dict 
 , 
 * 
 args 
 , 
 ** 
 kwargs 
 ) 
 

Creates an instance of this client using the provided credentials info.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.from_service_account_info

  from_service_account_json 
 ( 
 filename 
 : 
 str 
 , 
 * 
 args 
 , 
 ** 
 kwargs 
 ) 
 

Creates an instance of this client using the provided credentials file.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.from_service_account_json

google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.get_instance

  get_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 GetInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 Instance 
 

Gets the details of a specific Redis instance.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.get_instance

google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.get_instance_auth_string

  get_instance_auth_string 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 GetInstanceAuthStringRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 InstanceAuthString 
 

google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.get_location

  get_location 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 location 
 . 
 locations_pb2 
 . 
 GetLocationRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 location 
 . 
 locations_pb2 
 . 
 Location 
 

google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.get_mtls_endpoint_and_cert_source

  get_mtls_endpoint_and_cert_source 
 ( 
 client_options 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 api_core 
 . 
 client_options 
 . 
 ClientOptions 
 ] 
 = 
 None 
 , 
 ) 
 

google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.get_operation

  get_operation 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 GetOperationRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 Operation 
 

Gets the latest state of a long-running operation.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.get_operation

google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.import_instance

  import_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 ImportInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 input_config 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 InputConfig 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation 
 . 
 Operation 
 

Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.import_instance

google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.instance_path

  instance_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 instance 
 : 
 str 
 ) 
 - 
> str 
 

Returns a fully-qualified instance string.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.instance_path

google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.list_instances

  list_instances 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 ListInstancesRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 services 
 . 
 cloud_redis 
 . 
 pagers 
 . 
 ListInstancesPager 
 

Lists all Redis instances owned by a project in either the specified location (region) or all locations.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.list_instances

google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.list_locations

  list_locations 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 location 
 . 
 locations_pb2 
 . 
 ListLocationsRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 location 
 . 
 locations_pb2 
 . 
 ListLocationsResponse 
 

Lists information about the supported locations for this service.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.list_locations

google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.list_operations

  list_operations 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 ListOperationsRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 ListOperationsResponse 
 

Lists operations that match the specified filter in the request.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.list_operations

  parse_common_billing_account_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parse a billing_account path into its component segments.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.parse_common_billing_account_path

google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.parse_common_folder_path

  parse_common_folder_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parse a folder path into its component segments.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.parse_common_folder_path

google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.parse_common_location_path

  parse_common_location_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parse a location path into its component segments.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.parse_common_location_path

google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.parse_common_organization_path

  parse_common_organization_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parse a organization path into its component segments.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.parse_common_organization_path

google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.parse_common_project_path

  parse_common_project_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parse a project path into its component segments.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.parse_common_project_path

google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.parse_instance_path

  parse_instance_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parses a instance path into its component segments.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.parse_instance_path

google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.reschedule_maintenance

  reschedule_maintenance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 RescheduleMaintenanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 reschedule_type 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 RescheduleMaintenanceRequest 
 . 
 RescheduleType 
 ] 
 = 
 None 
 , 
 schedule_time 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 protobuf 
 . 
 timestamp_pb2 
 . 
 Timestamp 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation 
 . 
 Operation 
 

Reschedule maintenance for a given instance in a given project and location.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.reschedule_maintenance

google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.update_instance

  update_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 UpdateInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 update_mask 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 protobuf 
 . 
 field_mask_pb2 
 . 
 FieldMask 
 ] 
 = 
 None 
 , 
 instance 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 Instance 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation 
 . 
 Operation 
 

Updates the metadata and configuration of a specific Redis instance.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.update_instance

google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.upgrade_instance

  upgrade_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 UpgradeInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 redis_version 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation 
 . 
 Operation 
 

Upgrades Redis instance to the newer Redis version specified in the request.

See more: google.cloud.redis_v1.services.cloud_redis.CloudRedisClient.upgrade_instance

google.cloud.redis_v1.services.cloud_redis.pagers.ListInstancesAsyncPager

  ListInstancesAsyncPager 
 ( 
 method 
 : 
 typing 
 . 
 Callable 
 [ 
 [ 
 ... 
 ], 
 typing 
 . 
 Awaitable 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 ListInstancesResponse 
 ], 
 ], 
 request 
 : 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 ListInstancesRequest 
 , 
 response 
 : 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 ListInstancesResponse 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary_async 
 . 
 AsyncRetry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 

google.cloud.redis_v1.services.cloud_redis.pagers.ListInstancesPager

  ListInstancesPager 
 ( 
 method 
 : 
 typing 
 . 
 Callable 
 [ 
 [ 
 ... 
 ], 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 ListInstancesResponse 
 ], 
 request 
 : 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 ListInstancesRequest 
 , 
 response 
 : 
 google 
 . 
 cloud 
 . 
 redis_v1 
 . 
 types 
 . 
 cloud_redis 
 . 
 ListInstancesResponse 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient

  CloudRedisAsyncClient 
 ( 
 * 
 , 
 credentials 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 auth 
 . 
 credentials 
 . 
 Credentials 
 ] 
 = 
 None 
 , 
 transport 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 services 
 . 
 cloud_redis 
 . 
 transports 
 . 
 base 
 . 
 CloudRedisTransport 
 , 
 typing 
 . 
 Callable 
 [[ 
 ... 
 ], 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 services 
 . 
 cloud_redis 
 . 
 transports 
 . 
 base 
 . 
 CloudRedisTransport 
 ]]] 
 = 
 'grpc_asyncio' 
 , 
 client_options 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 api_core 
 . 
 client_options 
 . 
 ClientOptions 
 ] 
 = 
 None 
 , 
 client_info 
 : 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 client_info 
 . 
 ClientInfo 
 = 
 

Instantiates the cloud redis async client.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient

  common_billing_account_path 
 ( 
 billing_account 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.common_folder_path

  common_folder_path 
 ( 
 folder 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.common_location_path

  common_location_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.common_organization_path

  common_organization_path 
 ( 
 organization 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.common_project_path

  common_project_path 
 ( 
 project 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.create_instance

  create_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 CreateInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 instance_id 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 instance 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 Instance 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary_async 
 . 
 AsyncRetry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation_async 
 . 
 AsyncOperation 
 

Creates a Redis instance based on the specified tier and memory size.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.create_instance

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.delete_instance

  delete_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 DeleteInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary_async 
 . 
 AsyncRetry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation_async 
 . 
 AsyncOperation 
 

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.export_instance

  export_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 ExportInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 output_config 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 OutputConfig 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary_async 
 . 
 AsyncRetry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation_async 
 . 
 AsyncOperation 
 

Export Redis instance data into a Redis RDB format file in Cloud Storage.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.export_instance

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.failover_instance

  failover_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 FailoverInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 data_protection_mode 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 FailoverInstanceRequest 
 . 
 DataProtectionMode 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary_async 
 . 
 AsyncRetry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation_async 
 . 
 AsyncOperation 
 

Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.failover_instance

  from_service_account_file 
 ( 
 filename 
 : 
 str 
 , 
 * 
 args 
 , 
 ** 
 kwargs 
 ) 
 

Creates an instance of this client using the provided credentials file.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.from_service_account_file

  from_service_account_info 
 ( 
 info 
 : 
 dict 
 , 
 * 
 args 
 , 
 ** 
 kwargs 
 ) 
 

Creates an instance of this client using the provided credentials info.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.from_service_account_info

  from_service_account_json 
 ( 
 filename 
 : 
 str 
 , 
 * 
 args 
 , 
 ** 
 kwargs 
 ) 
 

Creates an instance of this client using the provided credentials file.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.from_service_account_json

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.get_instance

  get_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 GetInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary_async 
 . 
 AsyncRetry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 Instance 
 

Gets the details of a specific Redis instance.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.get_instance

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.get_instance_auth_string

  get_instance_auth_string 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 GetInstanceAuthStringRequest 
 , 
 dict 
 , 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary_async 
 . 
 AsyncRetry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 InstanceAuthString 
 

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.get_mtls_endpoint_and_cert_source

  get_mtls_endpoint_and_cert_source 
 ( 
 client_options 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 api_core 
 . 
 client_options 
 . 
 ClientOptions 
 ] 
 = 
 None 
 , 
 ) 
 

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.get_transport_class

  get_transport_class 
 ( 
 label 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 ) 
 - 
> typing 
 . 
 Type 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 services 
 . 
 cloud_redis 
 . 
 transports 
 . 
 base 
 . 
 CloudRedisTransport 
 ] 
 

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.import_instance

  import_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 ImportInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 input_config 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 InputConfig 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary_async 
 . 
 AsyncRetry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation_async 
 . 
 AsyncOperation 
 

Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.import_instance

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.instance_path

  instance_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 instance 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.list_instances

  list_instances 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 ListInstancesRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary_async 
 . 
 AsyncRetry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 services 
 . 
 cloud_redis 
 . 
 pagers 
 . 
 ListInstancesAsyncPager 
 

Lists all Redis instances owned by a project in either the specified location (region) or all locations.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.list_instances

  parse_common_billing_account_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parse a billing_account path into its component segments.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.parse_common_billing_account_path

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.parse_common_folder_path

  parse_common_folder_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.parse_common_location_path

  parse_common_location_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.parse_common_organization_path

  parse_common_organization_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parse a organization path into its component segments.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.parse_common_organization_path

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.parse_common_project_path

  parse_common_project_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.parse_instance_path

  parse_instance_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parses a instance path into its component segments.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.parse_instance_path

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.reschedule_maintenance

  reschedule_maintenance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 RescheduleMaintenanceRequest 
 , 
 dict 
 , 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 reschedule_type 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 RescheduleMaintenanceRequest 
 . 
 RescheduleType 
 ] 
 = 
 None 
 , 
 schedule_time 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 protobuf 
 . 
 timestamp_pb2 
 . 
 Timestamp 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary_async 
 . 
 AsyncRetry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation_async 
 . 
 AsyncOperation 
 

Reschedule maintenance for a given instance in a given project and location.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.reschedule_maintenance

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.update_instance

  update_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 UpdateInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 update_mask 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 protobuf 
 . 
 field_mask_pb2 
 . 
 FieldMask 
 ] 
 = 
 None 
 , 
 instance 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 Instance 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary_async 
 . 
 AsyncRetry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation_async 
 . 
 AsyncOperation 
 

Updates the metadata and configuration of a specific Redis instance.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.update_instance

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.upgrade_instance

  upgrade_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 UpgradeInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 redis_version 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary_async 
 . 
 AsyncRetry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation_async 
 . 
 AsyncOperation 
 

Upgrades Redis instance to the newer Redis version specified in the request.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient.upgrade_instance

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient

  CloudRedisClient 
 ( 
 * 
 , 
 credentials 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 auth 
 . 
 credentials 
 . 
 Credentials 
 ] 
 = 
 None 
 , 
 transport 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 services 
 . 
 cloud_redis 
 . 
 transports 
 . 
 base 
 . 
 CloudRedisTransport 
 , 
 typing 
 . 
 Callable 
 [[ 
 ... 
 ], 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 services 
 . 
 cloud_redis 
 . 
 transports 
 . 
 base 
 . 
 CloudRedisTransport 
 ]]] 
 = 
 None 
 , 
 client_options 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 client_options 
 . 
 ClientOptions 
 , 
 dict 
 ]] 
 = 
 None 
 , 
 client_info 
 : 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 client_info 
 . 
 ClientInfo 
 = 
 

Instantiates the cloud redis client.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.__exit__

  __exit__ 
 ( 
 type 
 , 
 value 
 , 
 traceback 
 ) 
 

Releases underlying transport's resources.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient. exit

  common_billing_account_path 
 ( 
 billing_account 
 : 
 str 
 ) 
 - 
> str 
 

Returns a fully-qualified billing_account string.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.common_billing_account_path

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.common_folder_path

  common_folder_path 
 ( 
 folder 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.common_location_path

  common_location_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.common_organization_path

  common_organization_path 
 ( 
 organization 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.common_project_path

  common_project_path 
 ( 
 project 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.create_instance

  create_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 CreateInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 instance_id 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 instance 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 Instance 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation 
 . 
 Operation 
 

Creates a Redis instance based on the specified tier and memory size.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.create_instance

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.delete_instance

  delete_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 DeleteInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation 
 . 
 Operation 
 

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.export_instance

  export_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 ExportInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 output_config 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 OutputConfig 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation 
 . 
 Operation 
 

Export Redis instance data into a Redis RDB format file in Cloud Storage.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.export_instance

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.failover_instance

  failover_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 FailoverInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 data_protection_mode 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 FailoverInstanceRequest 
 . 
 DataProtectionMode 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation 
 . 
 Operation 
 

Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.failover_instance

  from_service_account_file 
 ( 
 filename 
 : 
 str 
 , 
 * 
 args 
 , 
 ** 
 kwargs 
 ) 
 

Creates an instance of this client using the provided credentials file.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.from_service_account_file

  from_service_account_info 
 ( 
 info 
 : 
 dict 
 , 
 * 
 args 
 , 
 ** 
 kwargs 
 ) 
 

Creates an instance of this client using the provided credentials info.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.from_service_account_info

  from_service_account_json 
 ( 
 filename 
 : 
 str 
 , 
 * 
 args 
 , 
 ** 
 kwargs 
 ) 
 

Creates an instance of this client using the provided credentials file.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.from_service_account_json

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.get_instance

  get_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 GetInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 Instance 
 

Gets the details of a specific Redis instance.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.get_instance

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.get_instance_auth_string

  get_instance_auth_string 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 GetInstanceAuthStringRequest 
 , 
 dict 
 , 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 InstanceAuthString 
 

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.get_mtls_endpoint_and_cert_source

  get_mtls_endpoint_and_cert_source 
 ( 
 client_options 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 api_core 
 . 
 client_options 
 . 
 ClientOptions 
 ] 
 = 
 None 
 , 
 ) 
 

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.import_instance

  import_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 ImportInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 input_config 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 InputConfig 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation 
 . 
 Operation 
 

Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.import_instance

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.instance_path

  instance_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 instance 
 : 
 str 
 ) 
 - 
> str 
 

Returns a fully-qualified instance string.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.instance_path

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.list_instances

  list_instances 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 ListInstancesRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 services 
 . 
 cloud_redis 
 . 
 pagers 
 . 
 ListInstancesPager 
 

Lists all Redis instances owned by a project in either the specified location (region) or all locations.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.list_instances

  parse_common_billing_account_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parse a billing_account path into its component segments.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.parse_common_billing_account_path

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.parse_common_folder_path

  parse_common_folder_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parse a folder path into its component segments.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.parse_common_folder_path

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.parse_common_location_path

  parse_common_location_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parse a location path into its component segments.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.parse_common_location_path

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.parse_common_organization_path

  parse_common_organization_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parse a organization path into its component segments.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.parse_common_organization_path

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.parse_common_project_path

  parse_common_project_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parse a project path into its component segments.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.parse_common_project_path

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.parse_instance_path

  parse_instance_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parses a instance path into its component segments.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.parse_instance_path

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.reschedule_maintenance

  reschedule_maintenance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 RescheduleMaintenanceRequest 
 , 
 dict 
 , 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 reschedule_type 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 RescheduleMaintenanceRequest 
 . 
 RescheduleType 
 ] 
 = 
 None 
 , 
 schedule_time 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 protobuf 
 . 
 timestamp_pb2 
 . 
 Timestamp 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation 
 . 
 Operation 
 

Reschedule maintenance for a given instance in a given project and location.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.reschedule_maintenance

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.update_instance

  update_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 UpdateInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 update_mask 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 protobuf 
 . 
 field_mask_pb2 
 . 
 FieldMask 
 ] 
 = 
 None 
 , 
 instance 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 Instance 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation 
 . 
 Operation 
 

Updates the metadata and configuration of a specific Redis instance.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.update_instance

google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.upgrade_instance

  upgrade_instance 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 UpgradeInstanceRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 redis_version 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation 
 . 
 Operation 
 

Upgrades Redis instance to the newer Redis version specified in the request.

See more: google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient.upgrade_instance

google.cloud.redis_v1beta1.services.cloud_redis.pagers.ListInstancesAsyncPager

  ListInstancesAsyncPager 
 ( 
 method 
 : 
 typing 
 . 
 Callable 
 [ 
 [ 
 ... 
 ], 
 typing 
 . 
 Awaitable 
 [ 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 ListInstancesResponse 
 ], 
 ], 
 request 
 : 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 ListInstancesRequest 
 , 
 response 
 : 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 ListInstancesResponse 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary_async 
 . 
 AsyncRetry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 

google.cloud.redis_v1beta1.services.cloud_redis.pagers.ListInstancesPager

  ListInstancesPager 
 ( 
 method 
 : 
 typing 
 . 
 Callable 
 [ 
 [ 
 ... 
 ], 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 ListInstancesResponse 
 ], 
 request 
 : 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 ListInstancesRequest 
 , 
 response 
 : 
 google 
 . 
 cloud 
 . 
 redis_v1beta1 
 . 
 types 
 . 
 cloud_redis 
 . 
 ListInstancesResponse 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 
Design a Mobile Site
View Site in Mobile | Classic
Share by: