Package Methods (0.1.3)

Summary of entries of Methods for google-cloud-memorystore.

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient

MemorystoreClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.memorystore_v1.services.memorystore.transports.base.MemorystoreTransport, typing.Callable[[...], google.cloud.memorystore_v1.services.memorystore.transports.base.MemorystoreTransport]]] = 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 memorystore client.

See more: google.cloud.memorystore_v1.services.memorystore.MemorystoreClient

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.exit

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.backup_collection_path

backup_collection_path(project: str, location: str, backup_collection: str) -> str

Returns a fully-qualified backup_collection string.

See more: google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.backup_collection_path

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.backup_instance

backup_instance(
 request: typing.Optional[
 typing.Union[
 google.cloud.memorystore_v1.types.memorystore.BackupInstanceRequest, 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.memorystore_v1.services.memorystore.MemorystoreClient.backup_path

backup_path(
 project: str, location: str, backup_collection: str, backup: str
) -> str

Returns a fully-qualified backup string.

See more: google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.backup_path

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.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.memorystore_v1.services.memorystore.MemorystoreClient.cancel_operation

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.certificate_authority_path

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

Returns a fully-qualified certificate_authority string.

See more: google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.certificate_authority_path

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.common_folder_path

common_folder_path(folder: str) -> str

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.common_location_path

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

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.common_organization_path

common_organization_path(organization: str) -> str

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.common_project_path

common_project_path(project: str) -> str

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.create_instance

create_instance(
 request: typing.Optional[
 typing.Union[
 google.cloud.memorystore_v1.types.memorystore.CreateInstanceRequest, dict
 ]
 ] = None,
 *,
 parent: typing.Optional[str] = None,
 instance: typing.Optional[
 google.cloud.memorystore_v1.types.memorystore.Instance
 ] = None,
 instance_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 new Instance in a given project and location.

See more: google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.create_instance

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.crypto_key_path

crypto_key_path(project: str, location: str, key_ring: str, crypto_key: str) -> str

Returns a fully-qualified crypto_key string.

See more: google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.crypto_key_path

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.delete_backup

delete_backup(
 request: typing.Optional[
 typing.Union[
 google.cloud.memorystore_v1.types.memorystore.DeleteBackupRequest, 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.memorystore_v1.services.memorystore.MemorystoreClient.delete_instance

delete_instance(
 request: typing.Optional[
 typing.Union[
 google.cloud.memorystore_v1.types.memorystore.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.memorystore_v1.services.memorystore.MemorystoreClient.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.memorystore_v1.services.memorystore.MemorystoreClient.export_backup

export_backup(
 request: typing.Optional[
 typing.Union[
 google.cloud.memorystore_v1.types.memorystore.ExportBackupRequest, dict
 ]
 ] = 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

Exports a specific backup to a customer target Cloud Storage URI.

See more: google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.export_backup

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.forwarding_rule_path

forwarding_rule_path(project: str, region: str, forwarding_rule: str) -> str

Returns a fully-qualified forwarding_rule string.

See more: google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.forwarding_rule_path

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.from_service_account_file

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

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

See more: google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.from_service_account_file

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.from_service_account_info

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

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

See more: google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.from_service_account_info

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.from_service_account_json

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

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

See more: google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.from_service_account_json

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.get_backup

get_backup(
 request: typing.Optional[
 typing.Union[
 google.cloud.memorystore_v1.types.memorystore.GetBackupRequest, 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.memorystore_v1.types.memorystore.Backup

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.get_backup_collection

get_backup_collection(
 request: typing.Optional[
 typing.Union[
 google.cloud.memorystore_v1.types.memorystore.GetBackupCollectionRequest,
 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.memorystore_v1.types.memorystore.BackupCollection

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.get_certificate_authority

get_certificate_authority(
 request: typing.Optional[
 typing.Union[
 google.cloud.memorystore_v1.types.memorystore.GetCertificateAuthorityRequest,
 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.memorystore_v1.types.memorystore.CertificateAuthority

Gets details about the certificate authority for an Instance.

See more: google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.get_certificate_authority

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.get_instance

get_instance(
 request: typing.Optional[
 typing.Union[
 google.cloud.memorystore_v1.types.memorystore.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.memorystore_v1.types.memorystore.Instance

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.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.memorystore_v1.services.memorystore.MemorystoreClient.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.memorystore_v1.services.memorystore.MemorystoreClient.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.memorystore_v1.services.memorystore.MemorystoreClient.get_operation

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.instance_path

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

Returns a fully-qualified instance string.

See more: google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.instance_path

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.list_backup_collections

list_backup_collections(
 request: typing.Optional[
 typing.Union[
 google.cloud.memorystore_v1.types.memorystore.ListBackupCollectionsRequest,
 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.memorystore_v1.services.memorystore.pagers.ListBackupCollectionsPager

Lists all backup collections owned by a consumer project in either the specified location (region) or all locations.

See more: google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.list_backup_collections

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.list_backups

list_backups(
 request: typing.Optional[
 typing.Union[
 google.cloud.memorystore_v1.types.memorystore.ListBackupsRequest, 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.memorystore_v1.services.memorystore.pagers.ListBackupsPager

Lists all backups owned by a backup collection.

See more: google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.list_backups

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.list_instances

list_instances(
 request: typing.Optional[
 typing.Union[
 google.cloud.memorystore_v1.types.memorystore.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.memorystore_v1.services.memorystore.pagers.ListInstancesPager

Lists Instances in a given project and location.

See more: google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.list_instances

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.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.memorystore_v1.services.memorystore.MemorystoreClient.list_locations

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.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.memorystore_v1.services.memorystore.MemorystoreClient.list_operations

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.network_path

network_path(project: str, network: str) -> str

Returns a fully-qualified network string.

See more: google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.network_path

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.parse_backup_collection_path

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

Parses a backup_collection path into its component segments.

See more: google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.parse_backup_collection_path

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.parse_backup_path

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

Parses a backup path into its component segments.

See more: google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.parse_backup_path

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.parse_certificate_authority_path

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

Parses a certificate_authority path into its component segments.

See more: google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.parse_certificate_authority_path

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.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.

See more: google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.parse_common_billing_account_path

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.parse_common_folder_path

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

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.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.memorystore_v1.services.memorystore.MemorystoreClient.parse_common_location_path

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.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.memorystore_v1.services.memorystore.MemorystoreClient.parse_common_organization_path

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.parse_common_project_path

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

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.parse_crypto_key_path

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

Parses a crypto_key path into its component segments.

See more: google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.parse_crypto_key_path

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.parse_forwarding_rule_path

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

Parses a forwarding_rule path into its component segments.

See more: google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.parse_forwarding_rule_path

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.parse_instance_path

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

Parses a instance path into its component segments.

See more: google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.parse_instance_path

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.parse_network_path

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

Parses a network path into its component segments.

See more: google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.parse_network_path

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.parse_service_attachment_path

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

Parses a service_attachment path into its component segments.

See more: google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.parse_service_attachment_path

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.reschedule_maintenance

reschedule_maintenance(
 request: typing.Optional[
 typing.Union[
 google.cloud.memorystore_v1.types.memorystore.RescheduleMaintenanceRequest,
 dict,
 ]
 ] = None,
 *,
 name: typing.Optional[str] = None,
 reschedule_type: typing.Optional[
 google.cloud.memorystore_v1.types.memorystore.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

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.service_attachment_path

service_attachment_path(project: str, region: str, service_attachment: str) -> str

Returns a fully-qualified service_attachment string.

See more: google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.service_attachment_path

google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.update_instance

update_instance(
 request: typing.Optional[
 typing.Union[
 google.cloud.memorystore_v1.types.memorystore.UpdateInstanceRequest, dict
 ]
 ] = None,
 *,
 instance: typing.Optional[
 google.cloud.memorystore_v1.types.memorystore.Instance
 ] = 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 parameters of a single Instance.

See more: google.cloud.memorystore_v1.services.memorystore.MemorystoreClient.update_instance

google.cloud.memorystore_v1.services.memorystore.pagers.ListBackupCollectionsPager

ListBackupCollectionsPager(
 method: typing.Callable[
 [...],
 google.cloud.memorystore_v1.types.memorystore.ListBackupCollectionsResponse,
 ],
 request: google.cloud.memorystore_v1.types.memorystore.ListBackupCollectionsRequest,
 response: google.cloud.memorystore_v1.types.memorystore.ListBackupCollectionsResponse,
 *,
 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.memorystore_v1.services.memorystore.pagers.ListBackupsPager

ListBackupsPager(
 method: typing.Callable[
 [...], google.cloud.memorystore_v1.types.memorystore.ListBackupsResponse
 ],
 request: google.cloud.memorystore_v1.types.memorystore.ListBackupsRequest,
 response: google.cloud.memorystore_v1.types.memorystore.ListBackupsResponse,
 *,
 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.memorystore_v1.services.memorystore.pagers.ListInstancesPager

ListInstancesPager(
 method: typing.Callable[
 [...], google.cloud.memorystore_v1.types.memorystore.ListInstancesResponse
 ],
 request: google.cloud.memorystore_v1.types.memorystore.ListInstancesRequest,
 response: google.cloud.memorystore_v1.types.memorystore.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.memorystore_v1beta.services.memorystore.MemorystoreClient

MemorystoreClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.memorystore_v1beta.services.memorystore.transports.base.MemorystoreTransport, typing.Callable[[...], google.cloud.memorystore_v1beta.services.memorystore.transports.base.MemorystoreTransport]]] = 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 memorystore client.

See more: google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.exit

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.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.memorystore_v1beta.services.memorystore.MemorystoreClient.cancel_operation

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.certificate_authority_path

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

Returns a fully-qualified certificate_authority string.

See more: google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.certificate_authority_path

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.common_folder_path

common_folder_path(folder: str) -> str

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.common_location_path

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

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.common_organization_path

common_organization_path(organization: str) -> str

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.common_project_path

common_project_path(project: str) -> str

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.create_instance

create_instance(
 request: typing.Optional[
 typing.Union[
 google.cloud.memorystore_v1beta.types.memorystore.CreateInstanceRequest,
 dict,
 ]
 ] = None,
 *,
 parent: typing.Optional[str] = None,
 instance: typing.Optional[
 google.cloud.memorystore_v1beta.types.memorystore.Instance
 ] = None,
 instance_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 new Instance in a given project and location.

See more: google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.create_instance

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.delete_instance

delete_instance(
 request: typing.Optional[
 typing.Union[
 google.cloud.memorystore_v1beta.types.memorystore.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.memorystore_v1beta.services.memorystore.MemorystoreClient.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.memorystore_v1beta.services.memorystore.MemorystoreClient.forwarding_rule_path

forwarding_rule_path(project: str, region: str, forwarding_rule: str) -> str

Returns a fully-qualified forwarding_rule string.

See more: google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.forwarding_rule_path

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.from_service_account_file

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

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

See more: google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.from_service_account_file

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.from_service_account_info

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

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

See more: google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.from_service_account_info

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.from_service_account_json

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

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

See more: google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.from_service_account_json

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.get_certificate_authority

get_certificate_authority(
 request: typing.Optional[
 typing.Union[
 google.cloud.memorystore_v1beta.types.memorystore.GetCertificateAuthorityRequest,
 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.memorystore_v1beta.types.memorystore.CertificateAuthority

Gets details about the certificate authority for an Instance.

See more: google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.get_certificate_authority

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.get_instance

get_instance(
 request: typing.Optional[
 typing.Union[
 google.cloud.memorystore_v1beta.types.memorystore.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.memorystore_v1beta.types.memorystore.Instance

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.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.memorystore_v1beta.services.memorystore.MemorystoreClient.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.memorystore_v1beta.services.memorystore.MemorystoreClient.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.memorystore_v1beta.services.memorystore.MemorystoreClient.get_operation

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.instance_path

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

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.list_instances

list_instances(
 request: typing.Optional[
 typing.Union[
 google.cloud.memorystore_v1beta.types.memorystore.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.memorystore_v1beta.services.memorystore.pagers.ListInstancesPager

Lists Instances in a given project and location.

See more: google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.list_instances

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.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.memorystore_v1beta.services.memorystore.MemorystoreClient.list_locations

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.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.memorystore_v1beta.services.memorystore.MemorystoreClient.list_operations

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.network_path

network_path(project: str, network: str) -> str

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.parse_certificate_authority_path

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

Parses a certificate_authority path into its component segments.

See more: google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.parse_certificate_authority_path

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.parse_common_billing_account_path

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

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.parse_common_folder_path

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

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.parse_common_location_path

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

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.parse_common_organization_path

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

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.parse_common_project_path

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

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.parse_forwarding_rule_path

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

Parses a forwarding_rule path into its component segments.

See more: google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.parse_forwarding_rule_path

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.parse_instance_path

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

Parses a instance path into its component segments.

See more: google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.parse_instance_path

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.parse_network_path

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

Parses a network path into its component segments.

See more: google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.parse_network_path

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.parse_service_attachment_path

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

Parses a service_attachment path into its component segments.

See more: google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.parse_service_attachment_path

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.service_attachment_path

service_attachment_path(project: str, region: str, service_attachment: str) -> str

Returns a fully-qualified service_attachment string.

See more: google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.service_attachment_path

google.cloud.memorystore_v1beta.services.memorystore.MemorystoreClient.update_instance

update_instance(
 request: typing.Optional[
 typing.Union[
 google.cloud.memorystore_v1beta.types.memorystore.UpdateInstanceRequest,
 dict,
 ]
 ] = None,
 *,
 instance: typing.Optional[
 google.cloud.memorystore_v1beta.types.memorystore.Instance
 ] = 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

google.cloud.memorystore_v1beta.services.memorystore.pagers.ListInstancesPager

ListInstancesPager(
 method: typing.Callable[
 [...], google.cloud.memorystore_v1beta.types.memorystore.ListInstancesResponse
 ],
 request: google.cloud.memorystore_v1beta.types.memorystore.ListInstancesRequest,
 response: google.cloud.memorystore_v1beta.types.memorystore.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]]] = ()
)

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.