- 2.48.0 (latest)
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.6
- 2.2.1
- 2.1.11
A client to Cloud Memorystore for Memcached API
The interfaces provided are listed below, along with usage samples.
CloudMemcacheClient
Service Description: Configures and manages Cloud Memorystore for Memcached instances.
The memcache.googleapis.com
service implements the Google Cloud Memorystore for Memcached
API and defines the following resource model for managing Memorystore Memcached (also called
Memcached below) instances:
- The service works with a collection of cloud projects, named:
/projects/*
- Each project has a collection of available locations, named:
/locations/*
- Each location has a collection of Memcached instances, named:
/instances/*
- As such, Memcached instances are resources of the form:
/projects/{project_id}/locations/{location_id}/instances/{instance_id}
Note that location_id must be a GCP region
; for example:
projects/my-memcached-project/locations/us-central1/instances/my-memcached
Sample for CloudMemcacheClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (CloudMemcacheClient cloudMemcacheClient = CloudMemcacheClient.create()) {
InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
Instance response = cloudMemcacheClient.getInstance(name);
}
Classes
ApplyParametersRequest
Request for ApplyParameters.
Protobuf type google.cloud.memcache.v1.ApplyParametersRequest
ApplyParametersRequest.Builder
Request for ApplyParameters.
Protobuf type google.cloud.memcache.v1.ApplyParametersRequest
CloudMemcacheClient
Service Description: Configures and manages Cloud Memorystore for Memcached instances.
The memcache.googleapis.com
service implements the Google Cloud Memorystore for Memcached
API and defines the following resource model for managing Memorystore Memcached (also called
Memcached below) instances:
- The service works with a collection of cloud projects, named:
/projects/*
- Each project has a collection of available locations, named:
/locations/*
- Each location has a collection of Memcached instances, named:
/instances/*
- As such, Memcached instances are resources of the form:
/projects/{project_id}/locations/{location_id}/instances/{instance_id}
Note that location_id must be a GCP region
; for example:
projects/my-memcached-project/locations/us-central1/instances/my-memcached
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (CloudMemcacheClient cloudMemcacheClient = CloudMemcacheClient.create()) {
InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
Instance response = cloudMemcacheClient.getInstance(name);
}
Note: close() needs to be called on the CloudMemcacheClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of CloudMemcacheSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
CloudMemcacheSettings cloudMemcacheSettings =
CloudMemcacheSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
CloudMemcacheClient cloudMemcacheClient = CloudMemcacheClient.create(cloudMemcacheSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
CloudMemcacheSettings cloudMemcacheSettings =
CloudMemcacheSettings.newBuilder().setEndpoint(myEndpoint).build();
CloudMemcacheClient cloudMemcacheClient = CloudMemcacheClient.create(cloudMemcacheSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
CloudMemcacheSettings cloudMemcacheSettings =
CloudMemcacheSettings.newHttpJsonBuilder().build();
CloudMemcacheClient cloudMemcacheClient = CloudMemcacheClient.create(cloudMemcacheSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
CloudMemcacheClient.ListInstancesFixedSizeCollection
CloudMemcacheClient.ListInstancesPage
CloudMemcacheClient.ListInstancesPagedResponse
CloudMemcacheClient.ListLocationsFixedSizeCollection
CloudMemcacheClient.ListLocationsPage
CloudMemcacheClient.ListLocationsPagedResponse
CloudMemcacheGrpc
Configures and manages Cloud Memorystore for Memcached instances.
The memcache.googleapis.com
service implements the Google Cloud Memorystore
for Memcached API and defines the following resource model for managing
Memorystore Memcached (also called Memcached below) instances:
- The service works with a collection of cloud projects, named:
/projects/*
- Each project has a collection of available locations, named:
/locations/*
- Each location has a collection of Memcached instances, named:
/instances/*
- As such, Memcached instances are resources of the form:
/projects/{project_id}/locations/{location_id}/instances/{instance_id}
Note that location_id must be a GCPregion
; for example: projects/my-memcached-project/locations/us-central1/instances/my-memcached
CloudMemcacheGrpc.CloudMemcacheBlockingStub
Configures and manages Cloud Memorystore for Memcached instances.
The memcache.googleapis.com
service implements the Google Cloud Memorystore
for Memcached API and defines the following resource model for managing
Memorystore Memcached (also called Memcached below) instances:
- The service works with a collection of cloud projects, named:
/projects/*
- Each project has a collection of available locations, named:
/locations/*
- Each location has a collection of Memcached instances, named:
/instances/*
- As such, Memcached instances are resources of the form:
/projects/{project_id}/locations/{location_id}/instances/{instance_id}
Note that location_id must be a GCPregion
; for example: projects/my-memcached-project/locations/us-central1/instances/my-memcached
CloudMemcacheGrpc.CloudMemcacheFutureStub
Configures and manages Cloud Memorystore for Memcached instances.
The memcache.googleapis.com
service implements the Google Cloud Memorystore
for Memcached API and defines the following resource model for managing
Memorystore Memcached (also called Memcached below) instances:
- The service works with a collection of cloud projects, named:
/projects/*
- Each project has a collection of available locations, named:
/locations/*
- Each location has a collection of Memcached instances, named:
/instances/*
- As such, Memcached instances are resources of the form:
/projects/{project_id}/locations/{location_id}/instances/{instance_id}
Note that location_id must be a GCPregion
; for example: projects/my-memcached-project/locations/us-central1/instances/my-memcached
CloudMemcacheGrpc.CloudMemcacheImplBase
Configures and manages Cloud Memorystore for Memcached instances.
The memcache.googleapis.com
service implements the Google Cloud Memorystore
for Memcached API and defines the following resource model for managing
Memorystore Memcached (also called Memcached below) instances:
- The service works with a collection of cloud projects, named:
/projects/*
- Each project has a collection of available locations, named:
/locations/*
- Each location has a collection of Memcached instances, named:
/instances/*
- As such, Memcached instances are resources of the form:
/projects/{project_id}/locations/{location_id}/instances/{instance_id}
Note that location_id must be a GCPregion
; for example: projects/my-memcached-project/locations/us-central1/instances/my-memcached
CloudMemcacheGrpc.CloudMemcacheStub
Configures and manages Cloud Memorystore for Memcached instances.
The memcache.googleapis.com
service implements the Google Cloud Memorystore
for Memcached API and defines the following resource model for managing
Memorystore Memcached (also called Memcached below) instances:
- The service works with a collection of cloud projects, named:
/projects/*
- Each project has a collection of available locations, named:
/locations/*
- Each location has a collection of Memcached instances, named:
/instances/*
- As such, Memcached instances are resources of the form:
/projects/{project_id}/locations/{location_id}/instances/{instance_id}
Note that location_id must be a GCPregion
; for example: projects/my-memcached-project/locations/us-central1/instances/my-memcached
CloudMemcacheProto
CloudMemcacheSettings
Settings class to configure an instance of CloudMemcacheClient.
The default instance has everything set to sensible defaults:
- The default service address (memcache.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of getInstance to 30 seconds:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
CloudMemcacheSettings.Builder cloudMemcacheSettingsBuilder = CloudMemcacheSettings.newBuilder();
cloudMemcacheSettingsBuilder
.getInstanceSettings()
.setRetrySettings(
cloudMemcacheSettingsBuilder.getInstanceSettings().getRetrySettings().toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
CloudMemcacheSettings cloudMemcacheSettings = cloudMemcacheSettingsBuilder.build();
CloudMemcacheSettings.Builder
Builder for CloudMemcacheSettings.
CreateInstanceRequest
Request for CreateInstance.
Protobuf type google.cloud.memcache.v1.CreateInstanceRequest
CreateInstanceRequest.Builder
Request for CreateInstance.
Protobuf type google.cloud.memcache.v1.CreateInstanceRequest
DeleteInstanceRequest
Request for DeleteInstance.
Protobuf type google.cloud.memcache.v1.DeleteInstanceRequest
DeleteInstanceRequest.Builder
Request for DeleteInstance.
Protobuf type google.cloud.memcache.v1.DeleteInstanceRequest
GetInstanceRequest
Request for GetInstance.
Protobuf type google.cloud.memcache.v1.GetInstanceRequest
GetInstanceRequest.Builder
Request for GetInstance.
Protobuf type google.cloud.memcache.v1.GetInstanceRequest
Instance
A Memorystore for Memcached instance
Protobuf type google.cloud.memcache.v1.Instance
Instance.Builder
A Memorystore for Memcached instance
Protobuf type google.cloud.memcache.v1.Instance
Instance.InstanceMessage
Protobuf type google.cloud.memcache.v1.Instance.InstanceMessage
Instance.InstanceMessage.Builder
Protobuf type google.cloud.memcache.v1.Instance.InstanceMessage
Instance.Node
Protobuf type google.cloud.memcache.v1.Instance.Node
Instance.Node.Builder
Protobuf type google.cloud.memcache.v1.Instance.Node
Instance.NodeConfig
Configuration for a Memcached Node.
Protobuf type google.cloud.memcache.v1.Instance.NodeConfig
Instance.NodeConfig.Builder
Configuration for a Memcached Node.
Protobuf type google.cloud.memcache.v1.Instance.NodeConfig
InstanceName
InstanceName.Builder
Builder for projects/{project}/locations/{location}/instances/{instance}.
ListInstancesRequest
Request for ListInstances.
Protobuf type google.cloud.memcache.v1.ListInstancesRequest
ListInstancesRequest.Builder
Request for ListInstances.
Protobuf type google.cloud.memcache.v1.ListInstancesRequest
ListInstancesResponse
Response for ListInstances.
Protobuf type google.cloud.memcache.v1.ListInstancesResponse
ListInstancesResponse.Builder
Response for ListInstances.
Protobuf type google.cloud.memcache.v1.ListInstancesResponse
LocationMetadata
Metadata for the given google.cloud.location.Location.
Protobuf type google.cloud.memcache.v1.LocationMetadata
LocationMetadata.Builder
Metadata for the given google.cloud.location.Location.
Protobuf type google.cloud.memcache.v1.LocationMetadata
LocationName
LocationName.Builder
Builder for projects/{project}/locations/{location}.
MaintenancePolicy
Maintenance policy per instance.
Protobuf type google.cloud.memcache.v1.MaintenancePolicy
MaintenancePolicy.Builder
Maintenance policy per instance.
Protobuf type google.cloud.memcache.v1.MaintenancePolicy
MaintenanceSchedule
Upcoming maintenance schedule.
Protobuf type google.cloud.memcache.v1.MaintenanceSchedule
MaintenanceSchedule.Builder
Upcoming maintenance schedule.
Protobuf type google.cloud.memcache.v1.MaintenanceSchedule
MemcacheParameters
Protobuf type google.cloud.memcache.v1.MemcacheParameters
MemcacheParameters.Builder
Protobuf type google.cloud.memcache.v1.MemcacheParameters
OperationMetadata
Represents the metadata of a long-running operation.
Protobuf type google.cloud.memcache.v1.OperationMetadata
OperationMetadata.Builder
Represents the metadata of a long-running operation.
Protobuf type google.cloud.memcache.v1.OperationMetadata
RescheduleMaintenanceRequest
Request for RescheduleMaintenance.
Protobuf type google.cloud.memcache.v1.RescheduleMaintenanceRequest
RescheduleMaintenanceRequest.Builder
Request for RescheduleMaintenance.
Protobuf type google.cloud.memcache.v1.RescheduleMaintenanceRequest
UpdateInstanceRequest
Request for UpdateInstance.
Protobuf type google.cloud.memcache.v1.UpdateInstanceRequest
UpdateInstanceRequest.Builder
Request for UpdateInstance.
Protobuf type google.cloud.memcache.v1.UpdateInstanceRequest
UpdateParametersRequest
Request for UpdateParameters.
Protobuf type google.cloud.memcache.v1.UpdateParametersRequest
UpdateParametersRequest.Builder
Request for UpdateParameters.
Protobuf type google.cloud.memcache.v1.UpdateParametersRequest
WeeklyMaintenanceWindow
Time window specified for weekly operations.
Protobuf type google.cloud.memcache.v1.WeeklyMaintenanceWindow
WeeklyMaintenanceWindow.Builder
Time window specified for weekly operations.
Protobuf type google.cloud.memcache.v1.WeeklyMaintenanceWindow
ZoneMetadata
Protobuf type google.cloud.memcache.v1.ZoneMetadata
ZoneMetadata.Builder
Protobuf type google.cloud.memcache.v1.ZoneMetadata
Interfaces
ApplyParametersRequestOrBuilder
CreateInstanceRequestOrBuilder
DeleteInstanceRequestOrBuilder
GetInstanceRequestOrBuilder
Instance.InstanceMessageOrBuilder
Instance.NodeConfigOrBuilder
Instance.NodeOrBuilder
InstanceOrBuilder
ListInstancesRequestOrBuilder
ListInstancesResponseOrBuilder
LocationMetadataOrBuilder
MaintenancePolicyOrBuilder
MaintenanceScheduleOrBuilder
MemcacheParametersOrBuilder
OperationMetadataOrBuilder
RescheduleMaintenanceRequestOrBuilder
UpdateInstanceRequestOrBuilder
UpdateParametersRequestOrBuilder
WeeklyMaintenanceWindowOrBuilder
ZoneMetadataOrBuilder
Enums
Instance.InstanceMessage.Code
Protobuf enum google.cloud.memcache.v1.Instance.InstanceMessage.Code
Instance.Node.State
Different states of a Memcached node.
Protobuf enum google.cloud.memcache.v1.Instance.Node.State
Instance.State
Different states of a Memcached instance.
Protobuf enum google.cloud.memcache.v1.Instance.State
MemcacheVersion
Memcached versions supported by our service.
Protobuf enum google.cloud.memcache.v1.MemcacheVersion
RescheduleMaintenanceRequest.RescheduleType
Reschedule options.
Protobuf enum google.cloud.memcache.v1.RescheduleMaintenanceRequest.RescheduleType