Summary of entries of Methods for google-cloud-redis-cluster.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient
CloudRedisClusterAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.redis_cluster_v1.services.cloud_redis_cluster.transports.base.CloudRedisClusterTransport, typing.Callable[[...], google.cloud.redis_cluster_v1.services.cloud_redis_cluster.transports.base.CloudRedisClusterTransport]]] = '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 cluster async client.
See more: google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.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.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.certificate_authority_path
certificate_authority_path(project: str, location: str, cluster: str) -> str
Returns a fully-qualified certificate_authority string.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.cluster_path
cluster_path(project: str, location: str, cluster: str) -> str
Returns a fully-qualified cluster string.
See more: google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.cluster_path
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.create_cluster
create_cluster(
request: typing.Optional[
typing.Union[
google.cloud.redis_cluster_v1.types.cloud_redis_cluster.CreateClusterRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
cluster: typing.Optional[
google.cloud.redis_cluster_v1.types.cloud_redis_cluster.Cluster
] = None,
cluster_id: 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
Creates a Redis cluster based on the specified properties.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.delete_cluster
delete_cluster(
request: typing.Optional[
typing.Union[
google.cloud.redis_cluster_v1.types.cloud_redis_cluster.DeleteClusterRequest,
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
Deletes a specific Redis cluster.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.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
Deletes a long-running operation.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.get_cluster
get_cluster(
request: typing.Optional[
typing.Union[
google.cloud.redis_cluster_v1.types.cloud_redis_cluster.GetClusterRequest,
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_cluster_v1.types.cloud_redis_cluster.Cluster
Gets the details of a specific Redis cluster.
See more: google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.get_cluster
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.get_cluster_certificate_authority
get_cluster_certificate_authority(
request: typing.Optional[
typing.Union[
google.cloud.redis_cluster_v1.types.cloud_redis_cluster.GetClusterCertificateAuthorityRequest,
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_cluster_v1.types.cloud_redis_cluster.CertificateAuthority
Gets the details of certificate authority information for Redis cluster.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.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
Gets information about a location.
See more: google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.get_location
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.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.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.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.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.transports.base.CloudRedisClusterTransport
]
Returns an appropriate transport class.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.list_clusters
list_clusters(
request: typing.Optional[
typing.Union[
google.cloud.redis_cluster_v1.types.cloud_redis_cluster.ListClustersRequest,
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_cluster_v1.services.cloud_redis_cluster.pagers.ListClustersAsyncPager
)
Lists all Redis clusters owned by a project in either the specified location (region) or all locations.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.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.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.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.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.parse_certificate_authority_path
parse_certificate_authority_path(path: str) -> typing.Dict[str, str]
Parses a certificate_authority path into its component segments.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.parse_cluster_path
parse_cluster_path(path: str) -> typing.Dict[str, str]
Parses a cluster path into its component segments.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.update_cluster
update_cluster(
request: typing.Optional[
typing.Union[
google.cloud.redis_cluster_v1.types.cloud_redis_cluster.UpdateClusterRequest,
dict,
]
] = None,
*,
cluster: typing.Optional[
google.cloud.redis_cluster_v1.types.cloud_redis_cluster.Cluster
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = 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 cluster.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient
CloudRedisClusterClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.redis_cluster_v1.services.cloud_redis_cluster.transports.base.CloudRedisClusterTransport, typing.Callable[[...], google.cloud.redis_cluster_v1.services.cloud_redis_cluster.transports.base.CloudRedisClusterTransport]]] = 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 cluster client.
See more: google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.exit
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.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_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.cancel_operation
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.certificate_authority_path
certificate_authority_path(project: str, location: str, cluster: str) -> str
Returns a fully-qualified certificate_authority string.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.cluster_path
cluster_path(project: str, location: str, cluster: str) -> str
Returns a fully-qualified cluster string.
See more: google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.cluster_path
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.create_cluster
create_cluster(
request: typing.Optional[
typing.Union[
google.cloud.redis_cluster_v1.types.cloud_redis_cluster.CreateClusterRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
cluster: typing.Optional[
google.cloud.redis_cluster_v1.types.cloud_redis_cluster.Cluster
] = None,
cluster_id: 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
Creates a Redis cluster based on the specified properties.
See more: google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.create_cluster
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.delete_cluster
delete_cluster(
request: typing.Optional[
typing.Union[
google.cloud.redis_cluster_v1.types.cloud_redis_cluster.DeleteClusterRequest,
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
Deletes a specific Redis cluster.
See more: google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.delete_cluster
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.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
Deletes a long-running operation.
See more: google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.delete_operation
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.get_cluster
get_cluster(
request: typing.Optional[
typing.Union[
google.cloud.redis_cluster_v1.types.cloud_redis_cluster.GetClusterRequest,
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_cluster_v1.types.cloud_redis_cluster.Cluster
Gets the details of a specific Redis cluster.
See more: google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.get_cluster
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.get_cluster_certificate_authority
get_cluster_certificate_authority(
request: typing.Optional[
typing.Union[
google.cloud.redis_cluster_v1.types.cloud_redis_cluster.GetClusterCertificateAuthorityRequest,
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_cluster_v1.types.cloud_redis_cluster.CertificateAuthority
Gets the details of certificate authority information for Redis cluster.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.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
Gets information about a location.
See more: google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.get_location
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.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_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.get_operation
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.list_clusters
list_clusters(
request: typing.Optional[
typing.Union[
google.cloud.redis_cluster_v1.types.cloud_redis_cluster.ListClustersRequest,
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_cluster_v1.services.cloud_redis_cluster.pagers.ListClustersPager
)
Lists all Redis clusters owned by a project in either the specified location (region) or all locations.
See more: google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.list_clusters
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.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_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.list_locations
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.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_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.list_operations
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.parse_certificate_authority_path
parse_certificate_authority_path(path: str) -> typing.Dict[str, str]
Parses a certificate_authority path into its component segments.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.parse_cluster_path
parse_cluster_path(path: str) -> typing.Dict[str, str]
Parses a cluster path into its component segments.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.update_cluster
update_cluster(
request: typing.Optional[
typing.Union[
google.cloud.redis_cluster_v1.types.cloud_redis_cluster.UpdateClusterRequest,
dict,
]
] = None,
*,
cluster: typing.Optional[
google.cloud.redis_cluster_v1.types.cloud_redis_cluster.Cluster
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = 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 cluster.
See more: google.cloud.redis_cluster_v1.services.cloud_redis_cluster.CloudRedisClusterClient.update_cluster
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.pagers.ListClustersAsyncPager
ListClustersAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.redis_cluster_v1.types.cloud_redis_cluster.ListClustersResponse
],
],
request: google.cloud.redis_cluster_v1.types.cloud_redis_cluster.ListClustersRequest,
response: google.cloud.redis_cluster_v1.types.cloud_redis_cluster.ListClustersResponse,
*,
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]]] = ()
)
Instantiates the pager.
See more: google.cloud.redis_cluster_v1.services.cloud_redis_cluster.pagers.ListClustersAsyncPager
google.cloud.redis_cluster_v1.services.cloud_redis_cluster.pagers.ListClustersPager
ListClustersPager(
method: typing.Callable[
[...],
google.cloud.redis_cluster_v1.types.cloud_redis_cluster.ListClustersResponse,
],
request: google.cloud.redis_cluster_v1.types.cloud_redis_cluster.ListClustersRequest,
response: google.cloud.redis_cluster_v1.types.cloud_redis_cluster.ListClustersResponse,
*,
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]]] = ()
)
Instantiate the pager.
See more: google.cloud.redis_cluster_v1.services.cloud_redis_cluster.pagers.ListClustersPager
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient
CloudRedisClusterAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.transports.base.CloudRedisClusterTransport, typing.Callable[[...], google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.transports.base.CloudRedisClusterTransport]]] = '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 cluster async client.
See more: google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.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.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.certificate_authority_path
certificate_authority_path(project: str, location: str, cluster: str) -> str
Returns a fully-qualified certificate_authority string.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.cluster_path
cluster_path(project: str, location: str, cluster: str) -> str
Returns a fully-qualified cluster string.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.create_cluster
create_cluster(
request: typing.Optional[
typing.Union[
google.cloud.redis_cluster_v1beta1.types.cloud_redis_cluster.CreateClusterRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
cluster: typing.Optional[
google.cloud.redis_cluster_v1beta1.types.cloud_redis_cluster.Cluster
] = None,
cluster_id: 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
Creates a Redis cluster based on the specified properties.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.delete_cluster
delete_cluster(
request: typing.Optional[
typing.Union[
google.cloud.redis_cluster_v1beta1.types.cloud_redis_cluster.DeleteClusterRequest,
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
Deletes a specific Redis cluster.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.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
Deletes a long-running operation.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.get_cluster
get_cluster(
request: typing.Optional[
typing.Union[
google.cloud.redis_cluster_v1beta1.types.cloud_redis_cluster.GetClusterRequest,
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_cluster_v1beta1.types.cloud_redis_cluster.Cluster
Gets the details of a specific Redis cluster.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.get_cluster_certificate_authority
get_cluster_certificate_authority(
request: typing.Optional[
typing.Union[
google.cloud.redis_cluster_v1beta1.types.cloud_redis_cluster.GetClusterCertificateAuthorityRequest,
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_cluster_v1beta1.types.cloud_redis_cluster.CertificateAuthority
Gets the details of certificate authority information for Redis cluster.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.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
Gets information about a location.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.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.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.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.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.transports.base.CloudRedisClusterTransport
]
Returns an appropriate transport class.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.list_clusters
list_clusters(
request: typing.Optional[
typing.Union[
google.cloud.redis_cluster_v1beta1.types.cloud_redis_cluster.ListClustersRequest,
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_cluster_v1beta1.services.cloud_redis_cluster.pagers.ListClustersAsyncPager
)
Lists all Redis clusters owned by a project in either the specified location (region) or all locations.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.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.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.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.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.parse_certificate_authority_path
parse_certificate_authority_path(path: str) -> typing.Dict[str, str]
Parses a certificate_authority path into its component segments.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.parse_cluster_path
parse_cluster_path(path: str) -> typing.Dict[str, str]
Parses a cluster path into its component segments.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterAsyncClient.update_cluster
update_cluster(
request: typing.Optional[
typing.Union[
google.cloud.redis_cluster_v1beta1.types.cloud_redis_cluster.UpdateClusterRequest,
dict,
]
] = None,
*,
cluster: typing.Optional[
google.cloud.redis_cluster_v1beta1.types.cloud_redis_cluster.Cluster
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = 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 cluster.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient
CloudRedisClusterClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.transports.base.CloudRedisClusterTransport, typing.Callable[[...], google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.transports.base.CloudRedisClusterTransport]]] = 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 cluster client.
See more: google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.exit
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.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.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.certificate_authority_path
certificate_authority_path(project: str, location: str, cluster: str) -> str
Returns a fully-qualified certificate_authority string.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.cluster_path
cluster_path(project: str, location: str, cluster: str) -> str
Returns a fully-qualified cluster string.
See more: google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.cluster_path
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.create_cluster
create_cluster(
request: typing.Optional[
typing.Union[
google.cloud.redis_cluster_v1beta1.types.cloud_redis_cluster.CreateClusterRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
cluster: typing.Optional[
google.cloud.redis_cluster_v1beta1.types.cloud_redis_cluster.Cluster
] = None,
cluster_id: 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
Creates a Redis cluster based on the specified properties.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.delete_cluster
delete_cluster(
request: typing.Optional[
typing.Union[
google.cloud.redis_cluster_v1beta1.types.cloud_redis_cluster.DeleteClusterRequest,
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
Deletes a specific Redis cluster.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.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
Deletes a long-running operation.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.get_cluster
get_cluster(
request: typing.Optional[
typing.Union[
google.cloud.redis_cluster_v1beta1.types.cloud_redis_cluster.GetClusterRequest,
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_cluster_v1beta1.types.cloud_redis_cluster.Cluster
Gets the details of a specific Redis cluster.
See more: google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.get_cluster
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.get_cluster_certificate_authority
get_cluster_certificate_authority(
request: typing.Optional[
typing.Union[
google.cloud.redis_cluster_v1beta1.types.cloud_redis_cluster.GetClusterCertificateAuthorityRequest,
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_cluster_v1beta1.types.cloud_redis_cluster.CertificateAuthority
Gets the details of certificate authority information for Redis cluster.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.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
Gets information about a location.
See more: google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.get_location
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.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.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.list_clusters
list_clusters(
request: typing.Optional[
typing.Union[
google.cloud.redis_cluster_v1beta1.types.cloud_redis_cluster.ListClustersRequest,
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_cluster_v1beta1.services.cloud_redis_cluster.pagers.ListClustersPager
)
Lists all Redis clusters owned by a project in either the specified location (region) or all locations.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.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.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.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.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.parse_certificate_authority_path
parse_certificate_authority_path(path: str) -> typing.Dict[str, str]
Parses a certificate_authority path into its component segments.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.parse_cluster_path
parse_cluster_path(path: str) -> typing.Dict[str, str]
Parses a cluster path into its component segments.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.CloudRedisClusterClient.update_cluster
update_cluster(
request: typing.Optional[
typing.Union[
google.cloud.redis_cluster_v1beta1.types.cloud_redis_cluster.UpdateClusterRequest,
dict,
]
] = None,
*,
cluster: typing.Optional[
google.cloud.redis_cluster_v1beta1.types.cloud_redis_cluster.Cluster
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = 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 cluster.
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.pagers.ListClustersAsyncPager
ListClustersAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.redis_cluster_v1beta1.types.cloud_redis_cluster.ListClustersResponse
],
],
request: google.cloud.redis_cluster_v1beta1.types.cloud_redis_cluster.ListClustersRequest,
response: google.cloud.redis_cluster_v1beta1.types.cloud_redis_cluster.ListClustersResponse,
*,
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]]] = ()
)
Instantiates the pager.
See more: google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.pagers.ListClustersAsyncPager
google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.pagers.ListClustersPager
ListClustersPager(
method: typing.Callable[
[...],
google.cloud.redis_cluster_v1beta1.types.cloud_redis_cluster.ListClustersResponse,
],
request: google.cloud.redis_cluster_v1beta1.types.cloud_redis_cluster.ListClustersRequest,
response: google.cloud.redis_cluster_v1beta1.types.cloud_redis_cluster.ListClustersResponse,
*,
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]]] = ()
)
Instantiate the pager.
See more: google.cloud.redis_cluster_v1beta1.services.cloud_redis_cluster.pagers.ListClustersPager