• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright 2022 Google LLC
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      https://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 /**
18  * A client to Google Cloud Memorystore for Redis API
19  *
20  * <p>The interfaces provided are listed below, along with usage samples.
21  *
22  * <p>======================= CloudRedisClient =======================
23  *
24  * <p>Service Description: Configures and manages Cloud Memorystore for Redis instances
25  *
26  * <p>Google Cloud Memorystore for Redis v1beta1
27  *
28  * <p>The `redis.googleapis.com` service implements the Google Cloud Memorystore for Redis API and
29  * defines the following resource model for managing Redis instances:
30  *
31  * <ul>
32  *   <li>The service works with a collection of cloud projects, named: `/projects/&#42;`
33  *   <li>Each project has a collection of available locations, named: `/locations/&#42;`
34  *   <li>Each location has a collection of Redis instances, named: `/instances/&#42;`
35  *   <li>As such, Redis instances are resources of the form:
36  *       `/projects/{project_id}/locations/{location_id}/instances/{instance_id}`
37  * </ul>
38  *
39  * <p>Note that location_id must be referring to a GCP `region`; for example:
40  *
41  * <ul>
42  *   <li>`projects/redpepper-1290/locations/us-central1/instances/my-redis`
43  * </ul>
44  *
45  * <p>Sample for CloudRedisClient:
46  *
47  * <pre>{@code
48  * // This snippet has been automatically generated and should be regarded as a code template only.
49  * // It will require modifications to work:
50  * // - It may require correct/in-range values for request initialization.
51  * // - It may require specifying regional endpoints when creating the service client as shown in
52  * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
53  * try (CloudRedisClient cloudRedisClient = CloudRedisClient.create()) {
54  *   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
55  *   Instance response = cloudRedisClient.getInstance(name);
56  * }
57  * }</pre>
58  */
59 @Generated("by gapic-generator-java")
60 package com.google.cloud.redis.v1beta1;
61 
62 import javax.annotation.Generated;
63