GitHub Repository | Product Reference | REST Documentation |
Service Description: Service describing handlers for resources
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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
Instance response = memorystoreClient.getInstance(name);
}
Note: close() needs to be called on the MemorystoreClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
Method | Description | Method Variants |
---|---|---|
ListInstances |
Lists Instances in a given project and location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetInstance |
Gets details of a single Instance. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateInstance |
Creates a new Instance in a given project and location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateInstance |
Updates the parameters of a single Instance. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteInstance |
Deletes a single Instance. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetCertificateAuthority |
Gets details about the certificate authority for an Instance. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
RescheduleMaintenance |
Reschedules upcoming maintenance event. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListBackupCollections |
Lists all backup collections owned by a consumer project in either the specified location (region) or all locations. If |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetBackupCollection |
Get a backup collection. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListBackups |
Lists all backups owned by a backup collection. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetBackup |
Gets the details of a specific backup. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteBackup |
Deletes a specific backup. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ExportBackup |
Exports a specific backup to a customer target Cloud Storage URI. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
BackupInstance |
Backup Instance. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the instance's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListLocations |
Lists information about the supported locations for this service. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetLocation |
Gets information about a location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return 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 MemorystoreSettings 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
MemorystoreSettings memorystoreSettings =
MemorystoreSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
MemorystoreClient memorystoreClient = MemorystoreClient.create(memorystoreSettings);
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
MemorystoreSettings memorystoreSettings =
MemorystoreSettings.newBuilder().setEndpoint(myEndpoint).build();
MemorystoreClient memorystoreClient = MemorystoreClient.create(memorystoreSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final MemorystoreClient create()
Constructs an instance of MemorystoreClient with default settings.
Returns | |
---|---|
Type | Description |
MemorystoreClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(MemorystoreSettings settings)
public static final MemorystoreClient create(MemorystoreSettings settings)
Constructs an instance of MemorystoreClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
Parameter | |
---|---|
Name | Description |
settings |
MemorystoreSettings |
Returns | |
---|---|
Type | Description |
MemorystoreClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(MemorystoreStub stub)
public static final MemorystoreClient create(MemorystoreStub stub)
Constructs an instance of MemorystoreClient, using the given stub for making calls. This is for advanced usage - prefer using create(MemorystoreSettings).
Parameter | |
---|---|
Name | Description |
stub |
MemorystoreStub |
Returns | |
---|---|
Type | Description |
MemorystoreClient |
Constructors
MemorystoreClient(MemorystoreSettings settings)
protected MemorystoreClient(MemorystoreSettings settings)
Constructs an instance of MemorystoreClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
Parameter | |
---|---|
Name | Description |
settings |
MemorystoreSettings |
MemorystoreClient(MemorystoreStub stub)
protected MemorystoreClient(MemorystoreStub stub)
Parameter | |
---|---|
Name | Description |
stub |
MemorystoreStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Parameters | |
---|---|
Name | Description |
duration |
long |
unit |
TimeUnit |
Returns | |
---|---|
Type | Description |
boolean |
Exceptions | |
---|---|
Type | Description |
InterruptedException |
backupInstanceAsync(BackupInstanceRequest request)
public final OperationFuture<Instance,OperationMetadata> backupInstanceAsync(BackupInstanceRequest request)
Backup Instance. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the instance's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
BackupInstanceRequest request =
BackupInstanceRequest.newBuilder()
.setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
.setTtl(Duration.newBuilder().build())
.setBackupId("backupId2121930365")
.build();
Instance response = memorystoreClient.backupInstanceAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
BackupInstanceRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Instance,OperationMetadata> |
backupInstanceAsync(InstanceName name)
public final OperationFuture<Instance,OperationMetadata> backupInstanceAsync(InstanceName name)
Backup Instance. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the instance's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
Instance response = memorystoreClient.backupInstanceAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name |
InstanceName Required. Instance resource name using the form:
|
Returns | |
---|---|
Type | Description |
OperationFuture<Instance,OperationMetadata> |
backupInstanceAsync(String name)
public final OperationFuture<Instance,OperationMetadata> backupInstanceAsync(String name)
Backup Instance. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the instance's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
Instance response = memorystoreClient.backupInstanceAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name |
String Required. Instance resource name using the form:
|
Returns | |
---|---|
Type | Description |
OperationFuture<Instance,OperationMetadata> |
backupInstanceCallable()
public final UnaryCallable<BackupInstanceRequest,Operation> backupInstanceCallable()
Backup Instance. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the instance's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
BackupInstanceRequest request =
BackupInstanceRequest.newBuilder()
.setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
.setTtl(Duration.newBuilder().build())
.setBackupId("backupId2121930365")
.build();
ApiFuture<Operation> future = memorystoreClient.backupInstanceCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<BackupInstanceRequest,Operation> |
backupInstanceOperationCallable()
public final OperationCallable<BackupInstanceRequest,Instance,OperationMetadata> backupInstanceOperationCallable()
Backup Instance. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the instance's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
BackupInstanceRequest request =
BackupInstanceRequest.newBuilder()
.setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
.setTtl(Duration.newBuilder().build())
.setBackupId("backupId2121930365")
.build();
OperationFuture<Instance, OperationMetadata> future =
memorystoreClient.backupInstanceOperationCallable().futureCall(request);
// Do something.
Instance response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<BackupInstanceRequest,Instance,OperationMetadata> |
close()
public final void close()
createInstanceAsync(CreateInstanceRequest request)
public final OperationFuture<Instance,OperationMetadata> createInstanceAsync(CreateInstanceRequest request)
Creates a new Instance in a given project and location.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
CreateInstanceRequest request =
CreateInstanceRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setInstanceId("instanceId902024336")
.setInstance(Instance.newBuilder().build())
.setRequestId("requestId693933066")
.build();
Instance response = memorystoreClient.createInstanceAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
CreateInstanceRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Instance,OperationMetadata> |
createInstanceAsync(LocationName parent, Instance instance, String instanceId)
public final OperationFuture<Instance,OperationMetadata> createInstanceAsync(LocationName parent, Instance instance, String instanceId)
Creates a new Instance in a given project and location.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Instance instance = Instance.newBuilder().build();
String instanceId = "instanceId902024336";
Instance response = memorystoreClient.createInstanceAsync(parent, instance, instanceId).get();
}
Parameters | |
---|---|
Name | Description |
parent |
LocationName Required. The parent resource where this instance will be created. Format: projects/{project}/locations/{location} |
instance |
Instance Required. The instance to create. |
instanceId |
String Required. The ID to use for the instance, which will become the final component of the instance's resource name. This value is subject to the following restrictions:
|
Returns | |
---|---|
Type | Description |
OperationFuture<Instance,OperationMetadata> |
createInstanceAsync(String parent, Instance instance, String instanceId)
public final OperationFuture<Instance,OperationMetadata> createInstanceAsync(String parent, Instance instance, String instanceId)
Creates a new Instance in a given project and location.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
Instance instance = Instance.newBuilder().build();
String instanceId = "instanceId902024336";
Instance response = memorystoreClient.createInstanceAsync(parent, instance, instanceId).get();
}
Parameters | |
---|---|
Name | Description |
parent |
String Required. The parent resource where this instance will be created. Format: projects/{project}/locations/{location} |
instance |
Instance Required. The instance to create. |
instanceId |
String Required. The ID to use for the instance, which will become the final component of the instance's resource name. This value is subject to the following restrictions:
|
Returns | |
---|---|
Type | Description |
OperationFuture<Instance,OperationMetadata> |
createInstanceCallable()
public final UnaryCallable<CreateInstanceRequest,Operation> createInstanceCallable()
Creates a new Instance in a given project and location.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
CreateInstanceRequest request =
CreateInstanceRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setInstanceId("instanceId902024336")
.setInstance(Instance.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = memorystoreClient.createInstanceCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateInstanceRequest,Operation> |
createInstanceOperationCallable()
public final OperationCallable<CreateInstanceRequest,Instance,OperationMetadata> createInstanceOperationCallable()
Creates a new Instance in a given project and location.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
CreateInstanceRequest request =
CreateInstanceRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setInstanceId("instanceId902024336")
.setInstance(Instance.newBuilder().build())
.setRequestId("requestId693933066")
.build();
OperationFuture<Instance, OperationMetadata> future =
memorystoreClient.createInstanceOperationCallable().futureCall(request);
// Do something.
Instance response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<CreateInstanceRequest,Instance,OperationMetadata> |
deleteBackupAsync(BackupName name)
public final OperationFuture<Empty,OperationMetadata> deleteBackupAsync(BackupName name)
Deletes a specific backup.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
BackupName name = BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]");
memorystoreClient.deleteBackupAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name |
BackupName Required. Instance backup resource name using the form:
|
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteBackupAsync(DeleteBackupRequest request)
public final OperationFuture<Empty,OperationMetadata> deleteBackupAsync(DeleteBackupRequest request)
Deletes a specific backup.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
DeleteBackupRequest request =
DeleteBackupRequest.newBuilder()
.setName(
BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]")
.toString())
.setRequestId("requestId693933066")
.build();
memorystoreClient.deleteBackupAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
DeleteBackupRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteBackupAsync(String name)
public final OperationFuture<Empty,OperationMetadata> deleteBackupAsync(String name)
Deletes a specific backup.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
String name =
BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]").toString();
memorystoreClient.deleteBackupAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name |
String Required. Instance backup resource name using the form:
|
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteBackupCallable()
public final UnaryCallable<DeleteBackupRequest,Operation> deleteBackupCallable()
Deletes a specific backup.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
DeleteBackupRequest request =
DeleteBackupRequest.newBuilder()
.setName(
BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]")
.toString())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = memorystoreClient.deleteBackupCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteBackupRequest,Operation> |
deleteBackupOperationCallable()
public final OperationCallable<DeleteBackupRequest,Empty,OperationMetadata> deleteBackupOperationCallable()
Deletes a specific backup.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
DeleteBackupRequest request =
DeleteBackupRequest.newBuilder()
.setName(
BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]")
.toString())
.setRequestId("requestId693933066")
.build();
OperationFuture<Empty, OperationMetadata> future =
memorystoreClient.deleteBackupOperationCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeleteBackupRequest,Empty,OperationMetadata> |
deleteInstanceAsync(DeleteInstanceRequest request)
public final OperationFuture<Empty,OperationMetadata> deleteInstanceAsync(DeleteInstanceRequest request)
Deletes a single Instance.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
DeleteInstanceRequest request =
DeleteInstanceRequest.newBuilder()
.setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
.setRequestId("requestId693933066")
.build();
memorystoreClient.deleteInstanceAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
DeleteInstanceRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteInstanceAsync(InstanceName name)
public final OperationFuture<Empty,OperationMetadata> deleteInstanceAsync(InstanceName name)
Deletes a single Instance.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
memorystoreClient.deleteInstanceAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name |
InstanceName Required. The name of the instance to delete. Format: projects/{project}/locations/{location}/instances/{instance} |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteInstanceAsync(String name)
public final OperationFuture<Empty,OperationMetadata> deleteInstanceAsync(String name)
Deletes a single Instance.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
memorystoreClient.deleteInstanceAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The name of the instance to delete. Format: projects/{project}/locations/{location}/instances/{instance} |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteInstanceCallable()
public final UnaryCallable<DeleteInstanceRequest,Operation> deleteInstanceCallable()
Deletes a single Instance.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
DeleteInstanceRequest request =
DeleteInstanceRequest.newBuilder()
.setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = memorystoreClient.deleteInstanceCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteInstanceRequest,Operation> |
deleteInstanceOperationCallable()
public final OperationCallable<DeleteInstanceRequest,Empty,OperationMetadata> deleteInstanceOperationCallable()
Deletes a single Instance.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
DeleteInstanceRequest request =
DeleteInstanceRequest.newBuilder()
.setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
.setRequestId("requestId693933066")
.build();
OperationFuture<Empty, OperationMetadata> future =
memorystoreClient.deleteInstanceOperationCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeleteInstanceRequest,Empty,OperationMetadata> |
exportBackupAsync(ExportBackupRequest request)
public final OperationFuture<Backup,OperationMetadata> exportBackupAsync(ExportBackupRequest request)
Exports a specific backup to a customer target Cloud Storage URI.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
ExportBackupRequest request =
ExportBackupRequest.newBuilder()
.setName(
BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]")
.toString())
.build();
Backup response = memorystoreClient.exportBackupAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
ExportBackupRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Backup,OperationMetadata> |
exportBackupCallable()
public final UnaryCallable<ExportBackupRequest,Operation> exportBackupCallable()
Exports a specific backup to a customer target Cloud Storage URI.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
ExportBackupRequest request =
ExportBackupRequest.newBuilder()
.setName(
BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]")
.toString())
.build();
ApiFuture<Operation> future = memorystoreClient.exportBackupCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ExportBackupRequest,Operation> |
exportBackupOperationCallable()
public final OperationCallable<ExportBackupRequest,Backup,OperationMetadata> exportBackupOperationCallable()
Exports a specific backup to a customer target Cloud Storage URI.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
ExportBackupRequest request =
ExportBackupRequest.newBuilder()
.setName(
BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]")
.toString())
.build();
OperationFuture<Backup, OperationMetadata> future =
memorystoreClient.exportBackupOperationCallable().futureCall(request);
// Do something.
Backup response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<ExportBackupRequest,Backup,OperationMetadata> |
getBackup(BackupName name)
public final Backup getBackup(BackupName name)
Gets the details of a specific backup.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
BackupName name = BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]");
Backup response = memorystoreClient.getBackup(name);
}
Parameter | |
---|---|
Name | Description |
name |
BackupName Required. Instance backup resource name using the form:
|
Returns | |
---|---|
Type | Description |
Backup |
getBackup(GetBackupRequest request)
public final Backup getBackup(GetBackupRequest request)
Gets the details of a specific backup.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
GetBackupRequest request =
GetBackupRequest.newBuilder()
.setName(
BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]")
.toString())
.build();
Backup response = memorystoreClient.getBackup(request);
}
Parameter | |
---|---|
Name | Description |
request |
GetBackupRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Backup |
getBackup(String name)
public final Backup getBackup(String name)
Gets the details of a specific backup.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
String name =
BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]").toString();
Backup response = memorystoreClient.getBackup(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. Instance backup resource name using the form:
|
Returns | |
---|---|
Type | Description |
Backup |
getBackupCallable()
public final UnaryCallable<GetBackupRequest,Backup> getBackupCallable()
Gets the details of a specific backup.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
GetBackupRequest request =
GetBackupRequest.newBuilder()
.setName(
BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]", "[BACKUP]")
.toString())
.build();
ApiFuture<Backup> future = memorystoreClient.getBackupCallable().futureCall(request);
// Do something.
Backup response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetBackupRequest,Backup> |
getBackupCollection(BackupCollectionName name)
public final BackupCollection getBackupCollection(BackupCollectionName name)
Get a backup collection.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
BackupCollectionName name =
BackupCollectionName.of("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]");
BackupCollection response = memorystoreClient.getBackupCollection(name);
}
Parameter | |
---|---|
Name | Description |
name |
BackupCollectionName Required. Instance backupCollection resource name using the form:
|
Returns | |
---|---|
Type | Description |
BackupCollection |
getBackupCollection(GetBackupCollectionRequest request)
public final BackupCollection getBackupCollection(GetBackupCollectionRequest request)
Get a backup collection.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
GetBackupCollectionRequest request =
GetBackupCollectionRequest.newBuilder()
.setName(
BackupCollectionName.of("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]")
.toString())
.build();
BackupCollection response = memorystoreClient.getBackupCollection(request);
}
Parameter | |
---|---|
Name | Description |
request |
GetBackupCollectionRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
BackupCollection |
getBackupCollection(String name)
public final BackupCollection getBackupCollection(String name)
Get a backup collection.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
String name =
BackupCollectionName.of("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]").toString();
BackupCollection response = memorystoreClient.getBackupCollection(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. Instance backupCollection resource name using the form:
|
Returns | |
---|---|
Type | Description |
BackupCollection |
getBackupCollectionCallable()
public final UnaryCallable<GetBackupCollectionRequest,BackupCollection> getBackupCollectionCallable()
Get a backup collection.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
GetBackupCollectionRequest request =
GetBackupCollectionRequest.newBuilder()
.setName(
BackupCollectionName.of("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]")
.toString())
.build();
ApiFuture<BackupCollection> future =
memorystoreClient.getBackupCollectionCallable().futureCall(request);
// Do something.
BackupCollection response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetBackupCollectionRequest,BackupCollection> |
getCertificateAuthority(GetCertificateAuthorityRequest request)
public final CertificateAuthority getCertificateAuthority(GetCertificateAuthorityRequest request)
Gets details about the certificate authority for an Instance.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
GetCertificateAuthorityRequest request =
GetCertificateAuthorityRequest.newBuilder()
.setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
.build();
CertificateAuthority response = memorystoreClient.getCertificateAuthority(request);
}
Parameter | |
---|---|
Name | Description |
request |
GetCertificateAuthorityRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
CertificateAuthority |
getCertificateAuthority(InstanceName name)
public final CertificateAuthority getCertificateAuthority(InstanceName name)
Gets details about the certificate authority for an Instance.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
CertificateAuthority response = memorystoreClient.getCertificateAuthority(name);
}
Parameter | |
---|---|
Name | Description |
name |
InstanceName Required. The name of the certificate authority. Format: projects/{project}/locations/{location}/instances/{instance}/certificateAuthority |
Returns | |
---|---|
Type | Description |
CertificateAuthority |
getCertificateAuthority(String name)
public final CertificateAuthority getCertificateAuthority(String name)
Gets details about the certificate authority for an Instance.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
CertificateAuthority response = memorystoreClient.getCertificateAuthority(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The name of the certificate authority. Format: projects/{project}/locations/{location}/instances/{instance}/certificateAuthority |
Returns | |
---|---|
Type | Description |
CertificateAuthority |
getCertificateAuthorityCallable()
public final UnaryCallable<GetCertificateAuthorityRequest,CertificateAuthority> getCertificateAuthorityCallable()
Gets details about the certificate authority for an Instance.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
GetCertificateAuthorityRequest request =
GetCertificateAuthorityRequest.newBuilder()
.setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
.build();
ApiFuture<CertificateAuthority> future =
memorystoreClient.getCertificateAuthorityCallable().futureCall(request);
// Do something.
CertificateAuthority response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetCertificateAuthorityRequest,CertificateAuthority> |
getHttpJsonOperationsClient()
public final OperationsClient getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
Returns | |
---|---|
Type | Description |
OperationsClient |
getInstance(GetInstanceRequest request)
public final Instance getInstance(GetInstanceRequest request)
Gets details of a single Instance.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
GetInstanceRequest request =
GetInstanceRequest.newBuilder()
.setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
.build();
Instance response = memorystoreClient.getInstance(request);
}
Parameter | |
---|---|
Name | Description |
request |
GetInstanceRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Instance |
getInstance(InstanceName name)
public final Instance getInstance(InstanceName name)
Gets details of a single Instance.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
Instance response = memorystoreClient.getInstance(name);
}
Parameter | |
---|---|
Name | Description |
name |
InstanceName Required. The name of the instance to retrieve. Format: projects/{project}/locations/{location}/instances/{instance} |
Returns | |
---|---|
Type | Description |
Instance |
getInstance(String name)
public final Instance getInstance(String name)
Gets details of a single Instance.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
Instance response = memorystoreClient.getInstance(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The name of the instance to retrieve. Format: projects/{project}/locations/{location}/instances/{instance} |
Returns | |
---|---|
Type | Description |
Instance |
getInstanceCallable()
public final UnaryCallable<GetInstanceRequest,Instance> getInstanceCallable()
Gets details of a single Instance.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
GetInstanceRequest request =
GetInstanceRequest.newBuilder()
.setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
.build();
ApiFuture<Instance> future = memorystoreClient.getInstanceCallable().futureCall(request);
// Do something.
Instance response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetInstanceRequest,Instance> |
getLocation(GetLocationRequest request)
public final Location getLocation(GetLocationRequest request)
Gets information about a location.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = memorystoreClient.getLocation(request);
}
Parameter | |
---|---|
Name | Description |
request |
com.google.cloud.location.GetLocationRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.cloud.location.Location |
getLocationCallable()
public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()
Gets information about a location.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location> future = memorystoreClient.getLocationCallable().futureCall(request);
// Do something.
Location response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
getSettings()
public final MemorystoreSettings getSettings()
Returns | |
---|---|
Type | Description |
MemorystoreSettings |
getStub()
public MemorystoreStub getStub()
Returns | |
---|---|
Type | Description |
MemorystoreStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
listBackupCollections(ListBackupCollectionsRequest request)
public final MemorystoreClient.ListBackupCollectionsPagedResponse listBackupCollections(ListBackupCollectionsRequest request)
Lists all backup collections owned by a consumer project in either the specified location (region) or all locations.
If location_id
is specified as -
(wildcard), then all regions available to the project
are queried, and the results are aggregated.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
ListBackupCollectionsRequest request =
ListBackupCollectionsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (BackupCollection element :
memorystoreClient.listBackupCollections(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListBackupCollectionsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
MemorystoreClient.ListBackupCollectionsPagedResponse |
listBackupCollections(LocationName parent)
public final MemorystoreClient.ListBackupCollectionsPagedResponse listBackupCollections(LocationName parent)
Lists all backup collections owned by a consumer project in either the specified location (region) or all locations.
If location_id
is specified as -
(wildcard), then all regions available to the project
are queried, and the results are aggregated.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (BackupCollection element :
memorystoreClient.listBackupCollections(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
LocationName Required. The resource name of the backupCollection location using the form:
|
Returns | |
---|---|
Type | Description |
MemorystoreClient.ListBackupCollectionsPagedResponse |
listBackupCollections(String parent)
public final MemorystoreClient.ListBackupCollectionsPagedResponse listBackupCollections(String parent)
Lists all backup collections owned by a consumer project in either the specified location (region) or all locations.
If location_id
is specified as -
(wildcard), then all regions available to the project
are queried, and the results are aggregated.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (BackupCollection element :
memorystoreClient.listBackupCollections(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
String Required. The resource name of the backupCollection location using the form:
|
Returns | |
---|---|
Type | Description |
MemorystoreClient.ListBackupCollectionsPagedResponse |
listBackupCollectionsCallable()
public final UnaryCallable<ListBackupCollectionsRequest,ListBackupCollectionsResponse> listBackupCollectionsCallable()
Lists all backup collections owned by a consumer project in either the specified location (region) or all locations.
If location_id
is specified as -
(wildcard), then all regions available to the project
are queried, and the results are aggregated.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
ListBackupCollectionsRequest request =
ListBackupCollectionsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListBackupCollectionsResponse response =
memorystoreClient.listBackupCollectionsCallable().call(request);
for (BackupCollection element : response.getBackupCollectionsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListBackupCollectionsRequest,ListBackupCollectionsResponse> |
listBackupCollectionsPagedCallable()
public final UnaryCallable<ListBackupCollectionsRequest,MemorystoreClient.ListBackupCollectionsPagedResponse> listBackupCollectionsPagedCallable()
Lists all backup collections owned by a consumer project in either the specified location (region) or all locations.
If location_id
is specified as -
(wildcard), then all regions available to the project
are queried, and the results are aggregated.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
ListBackupCollectionsRequest request =
ListBackupCollectionsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<BackupCollection> future =
memorystoreClient.listBackupCollectionsPagedCallable().futureCall(request);
// Do something.
for (BackupCollection element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListBackupCollectionsRequest,ListBackupCollectionsPagedResponse> |
listBackups(BackupCollectionName parent)
public final MemorystoreClient.ListBackupsPagedResponse listBackups(BackupCollectionName parent)
Lists all backups owned by a backup collection.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
BackupCollectionName parent =
BackupCollectionName.of("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]");
for (Backup element : memorystoreClient.listBackups(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
BackupCollectionName Required. The resource name of the backupCollection using the form:
|
Returns | |
---|---|
Type | Description |
MemorystoreClient.ListBackupsPagedResponse |
listBackups(ListBackupsRequest request)
public final MemorystoreClient.ListBackupsPagedResponse listBackups(ListBackupsRequest request)
Lists all backups owned by a backup collection.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
ListBackupsRequest request =
ListBackupsRequest.newBuilder()
.setParent(
BackupCollectionName.of("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Backup element : memorystoreClient.listBackups(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListBackupsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
MemorystoreClient.ListBackupsPagedResponse |
listBackups(String parent)
public final MemorystoreClient.ListBackupsPagedResponse listBackups(String parent)
Lists all backups owned by a backup collection.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
String parent =
BackupCollectionName.of("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]").toString();
for (Backup element : memorystoreClient.listBackups(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
String Required. The resource name of the backupCollection using the form:
|
Returns | |
---|---|
Type | Description |
MemorystoreClient.ListBackupsPagedResponse |
listBackupsCallable()
public final UnaryCallable<ListBackupsRequest,ListBackupsResponse> listBackupsCallable()
Lists all backups owned by a backup collection.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
ListBackupsRequest request =
ListBackupsRequest.newBuilder()
.setParent(
BackupCollectionName.of("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListBackupsResponse response = memorystoreClient.listBackupsCallable().call(request);
for (Backup element : response.getBackupsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListBackupsRequest,ListBackupsResponse> |
listBackupsPagedCallable()
public final UnaryCallable<ListBackupsRequest,MemorystoreClient.ListBackupsPagedResponse> listBackupsPagedCallable()
Lists all backups owned by a backup collection.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
ListBackupsRequest request =
ListBackupsRequest.newBuilder()
.setParent(
BackupCollectionName.of("[PROJECT]", "[LOCATION]", "[BACKUP_COLLECTION]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Backup> future = memorystoreClient.listBackupsPagedCallable().futureCall(request);
// Do something.
for (Backup element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListBackupsRequest,ListBackupsPagedResponse> |
listInstances(ListInstancesRequest request)
public final MemorystoreClient.ListInstancesPagedResponse listInstances(ListInstancesRequest request)
Lists Instances in a given project and location.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
ListInstancesRequest request =
ListInstancesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (Instance element : memorystoreClient.listInstances(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListInstancesRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
MemorystoreClient.ListInstancesPagedResponse |
listInstances(LocationName parent)
public final MemorystoreClient.ListInstancesPagedResponse listInstances(LocationName parent)
Lists Instances in a given project and location.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (Instance element : memorystoreClient.listInstances(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
LocationName Required. The parent to list instances from. Format: projects/{project}/locations/{location} |
Returns | |
---|---|
Type | Description |
MemorystoreClient.ListInstancesPagedResponse |
listInstances(String parent)
public final MemorystoreClient.ListInstancesPagedResponse listInstances(String parent)
Lists Instances in a given project and location.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (Instance element : memorystoreClient.listInstances(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
String Required. The parent to list instances from. Format: projects/{project}/locations/{location} |
Returns | |
---|---|
Type | Description |
MemorystoreClient.ListInstancesPagedResponse |
listInstancesCallable()
public final UnaryCallable<ListInstancesRequest,ListInstancesResponse> listInstancesCallable()
Lists Instances in a given project and location.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
ListInstancesRequest request =
ListInstancesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListInstancesResponse response = memorystoreClient.listInstancesCallable().call(request);
for (Instance element : response.getInstancesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListInstancesRequest,ListInstancesResponse> |
listInstancesPagedCallable()
public final UnaryCallable<ListInstancesRequest,MemorystoreClient.ListInstancesPagedResponse> listInstancesPagedCallable()
Lists Instances in a given project and location.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
ListInstancesRequest request =
ListInstancesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<Instance> future =
memorystoreClient.listInstancesPagedCallable().futureCall(request);
// Do something.
for (Instance element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListInstancesRequest,ListInstancesPagedResponse> |
listLocations(ListLocationsRequest request)
public final MemorystoreClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)
Lists information about the supported locations for this service.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Location element : memorystoreClient.listLocations(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
com.google.cloud.location.ListLocationsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
MemorystoreClient.ListLocationsPagedResponse |
listLocationsCallable()
public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()
Lists information about the supported locations for this service.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListLocationsResponse response = memorystoreClient.listLocationsCallable().call(request);
for (Location element : response.getLocationsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> |
listLocationsPagedCallable()
public final UnaryCallable<ListLocationsRequest,MemorystoreClient.ListLocationsPagedResponse> listLocationsPagedCallable()
Lists information about the supported locations for this service.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Location> future =
memorystoreClient.listLocationsPagedCallable().futureCall(request);
// Do something.
for (Location element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse> |
rescheduleMaintenanceAsync(InstanceName name, RescheduleMaintenanceRequest.RescheduleType rescheduleType, Timestamp scheduleTime)
public final OperationFuture<Instance,OperationMetadata> rescheduleMaintenanceAsync(InstanceName name, RescheduleMaintenanceRequest.RescheduleType rescheduleType, Timestamp scheduleTime)
Reschedules upcoming maintenance event.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
RescheduleMaintenanceRequest.RescheduleType rescheduleType =
RescheduleMaintenanceRequest.RescheduleType.forNumber(0);
Timestamp scheduleTime = Timestamp.newBuilder().build();
Instance response =
memorystoreClient.rescheduleMaintenanceAsync(name, rescheduleType, scheduleTime).get();
}
Parameters | |
---|---|
Name | Description |
name |
InstanceName Required. Name of the instance to reschedule maintenance for:
|
rescheduleType |
RescheduleMaintenanceRequest.RescheduleType Required. If reschedule type is SPECIFIC_TIME, schedule_time must be set. |
scheduleTime |
Timestamp Optional. Timestamp when the maintenance shall be rescheduled to if
reschedule_type=SPECIFIC_TIME, in RFC 3339 format. Example: |
Returns | |
---|---|
Type | Description |
OperationFuture<Instance,OperationMetadata> |
rescheduleMaintenanceAsync(RescheduleMaintenanceRequest request)
public final OperationFuture<Instance,OperationMetadata> rescheduleMaintenanceAsync(RescheduleMaintenanceRequest request)
Reschedules upcoming maintenance event.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
RescheduleMaintenanceRequest request =
RescheduleMaintenanceRequest.newBuilder()
.setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
.setScheduleTime(Timestamp.newBuilder().build())
.build();
Instance response = memorystoreClient.rescheduleMaintenanceAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
RescheduleMaintenanceRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Instance,OperationMetadata> |
rescheduleMaintenanceAsync(String name, RescheduleMaintenanceRequest.RescheduleType rescheduleType, Timestamp scheduleTime)
public final OperationFuture<Instance,OperationMetadata> rescheduleMaintenanceAsync(String name, RescheduleMaintenanceRequest.RescheduleType rescheduleType, Timestamp scheduleTime)
Reschedules upcoming maintenance event.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
RescheduleMaintenanceRequest.RescheduleType rescheduleType =
RescheduleMaintenanceRequest.RescheduleType.forNumber(0);
Timestamp scheduleTime = Timestamp.newBuilder().build();
Instance response =
memorystoreClient.rescheduleMaintenanceAsync(name, rescheduleType, scheduleTime).get();
}
Parameters | |
---|---|
Name | Description |
name |
String Required. Name of the instance to reschedule maintenance for:
|
rescheduleType |
RescheduleMaintenanceRequest.RescheduleType Required. If reschedule type is SPECIFIC_TIME, schedule_time must be set. |
scheduleTime |
Timestamp Optional. Timestamp when the maintenance shall be rescheduled to if
reschedule_type=SPECIFIC_TIME, in RFC 3339 format. Example: |
Returns | |
---|---|
Type | Description |
OperationFuture<Instance,OperationMetadata> |
rescheduleMaintenanceCallable()
public final UnaryCallable<RescheduleMaintenanceRequest,Operation> rescheduleMaintenanceCallable()
Reschedules upcoming maintenance event.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
RescheduleMaintenanceRequest request =
RescheduleMaintenanceRequest.newBuilder()
.setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
.setScheduleTime(Timestamp.newBuilder().build())
.build();
ApiFuture<Operation> future =
memorystoreClient.rescheduleMaintenanceCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<RescheduleMaintenanceRequest,Operation> |
rescheduleMaintenanceOperationCallable()
public final OperationCallable<RescheduleMaintenanceRequest,Instance,OperationMetadata> rescheduleMaintenanceOperationCallable()
Reschedules upcoming maintenance event.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
RescheduleMaintenanceRequest request =
RescheduleMaintenanceRequest.newBuilder()
.setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
.setScheduleTime(Timestamp.newBuilder().build())
.build();
OperationFuture<Instance, OperationMetadata> future =
memorystoreClient.rescheduleMaintenanceOperationCallable().futureCall(request);
// Do something.
Instance response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<RescheduleMaintenanceRequest,Instance,OperationMetadata> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
updateInstanceAsync(Instance instance, FieldMask updateMask)
public final OperationFuture<Instance,OperationMetadata> updateInstanceAsync(Instance instance, FieldMask updateMask)
Updates the parameters of a single Instance.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
Instance instance = Instance.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Instance response = memorystoreClient.updateInstanceAsync(instance, updateMask).get();
}
Parameters | |
---|---|
Name | Description |
instance |
Instance Required. The instance to update. |
updateMask |
FieldMask Optional. The list of fields to be updated on the instance. At least one field must be specified. |
Returns | |
---|---|
Type | Description |
OperationFuture<Instance,OperationMetadata> |
updateInstanceAsync(UpdateInstanceRequest request)
public final OperationFuture<Instance,OperationMetadata> updateInstanceAsync(UpdateInstanceRequest request)
Updates the parameters of a single Instance.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
UpdateInstanceRequest request =
UpdateInstanceRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setInstance(Instance.newBuilder().build())
.setRequestId("requestId693933066")
.build();
Instance response = memorystoreClient.updateInstanceAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
UpdateInstanceRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Instance,OperationMetadata> |
updateInstanceCallable()
public final UnaryCallable<UpdateInstanceRequest,Operation> updateInstanceCallable()
Updates the parameters of a single Instance.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
UpdateInstanceRequest request =
UpdateInstanceRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setInstance(Instance.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = memorystoreClient.updateInstanceCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpdateInstanceRequest,Operation> |
updateInstanceOperationCallable()
public final OperationCallable<UpdateInstanceRequest,Instance,OperationMetadata> updateInstanceOperationCallable()
Updates the parameters of a single Instance.
Sample code:
// 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 (MemorystoreClient memorystoreClient = MemorystoreClient.create()) {
UpdateInstanceRequest request =
UpdateInstanceRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setInstance(Instance.newBuilder().build())
.setRequestId("requestId693933066")
.build();
OperationFuture<Instance, OperationMetadata> future =
memorystoreClient.updateInstanceOperationCallable().futureCall(request);
// Do something.
Instance response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<UpdateInstanceRequest,Instance,OperationMetadata> |