Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class LustreClient (0.39.0)

GitHub Repository

Product Reference

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 (LustreClient lustreClient = LustreClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   Instance response = lustreClient.getInstance(name);
 }

Note: close() needs to be called on the LustreClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
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. listInstances(ListInstancesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listInstances(LocationName parent) listInstances(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listInstancesPagedCallable() listInstancesCallable()
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. getInstance(GetInstanceRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getInstance(InstanceName name) getInstance(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getInstanceCallable()
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. createInstanceAsync(CreateInstanceRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createInstanceAsync(LocationName parent, Instance instance, String instanceId) createInstanceAsync(String parent, Instance instance, String instanceId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createInstanceOperationCallable() createInstanceCallable()
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. updateInstanceAsync(UpdateInstanceRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. updateInstanceAsync(Instance instance, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateInstanceOperationCallable() updateInstanceCallable()
DeleteInstance	Deletes a single instance.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteInstanceAsync(DeleteInstanceRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteInstanceAsync(InstanceName name) deleteInstanceAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteInstanceOperationCallable() deleteInstanceCallable()
RescheduleMaintenance	Reschedules a planned maintenance event for a specific instance.	Request object method variants only take one parameter, a request object, which must be constructed before the call. rescheduleMaintenanceAsync(RescheduleMaintenanceRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. rescheduleMaintenanceAsync(InstanceName name, RescheduleMaintenanceRequest.Reschedule reschedule) rescheduleMaintenanceAsync(String name, RescheduleMaintenanceRequest.Reschedule reschedule) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. rescheduleMaintenanceOperationCallable() rescheduleMaintenanceCallable()
ImportData	Imports data from Cloud Storage to a Managed Lustre instance.	Request object method variants only take one parameter, a request object, which must be constructed before the call. importDataAsync(ImportDataRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. importDataAsync(InstanceName name) importDataAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. importDataOperationCallable() importDataCallable()
ExportData	Exports data from a Managed Lustre instance to Cloud Storage.	Request object method variants only take one parameter, a request object, which must be constructed before the call. exportDataAsync(ExportDataRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. exportDataOperationCallable() exportDataCallable()
CreateMirror	Creates a new mirror in a given instance.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createMirrorAsync(CreateMirrorRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createMirrorAsync(InstanceName parent, Mirror mirror, String mirrorId) createMirrorAsync(String parent, Mirror mirror, String mirrorId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createMirrorOperationCallable() createMirrorCallable()
UpdateMirror	Updates the parameters of a single mirror.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateMirrorAsync(UpdateMirrorRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. updateMirrorAsync(Mirror mirror, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateMirrorOperationCallable() updateMirrorCallable()
DeleteMirror	Deletes a single mirror.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteMirrorAsync(DeleteMirrorRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteMirrorAsync(MirrorName name) deleteMirrorAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteMirrorOperationCallable() deleteMirrorCallable()
GetMirror	Gets details of a single mirror.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getMirror(GetMirrorRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getMirror(MirrorName name) getMirror(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getMirrorCallable()
ListMirrors	Gets details of multiple mirrors under a given instance.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listMirrors(ListMirrorsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listMirrors(InstanceName parent) listMirrors(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listMirrorsPagedCallable() listMirrorsCallable()
CreateDirectoryPolicy	Creates a directory policy resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createDirectoryPolicyAsync(CreateDirectoryPolicyRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createDirectoryPolicyAsync(InstanceName parent, DirectoryPolicy directoryPolicy, String directoryPolicyId) createDirectoryPolicyAsync(String parent, DirectoryPolicy directoryPolicy, String directoryPolicyId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createDirectoryPolicyOperationCallable() createDirectoryPolicyCallable()
DeleteDirectoryPolicy	Deletes a directory policy resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteDirectoryPolicyAsync(DeleteDirectoryPolicyRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteDirectoryPolicyAsync(DirectoryPolicyName name) deleteDirectoryPolicyAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteDirectoryPolicyOperationCallable() deleteDirectoryPolicyCallable()
GetDirectoryPolicy	Gets details of a single directory policy.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getDirectoryPolicy(GetDirectoryPolicyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getDirectoryPolicy(DirectoryPolicyName name) getDirectoryPolicy(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getDirectoryPolicyCallable()
ListDirectoryPolicies	Gets details of multiple directory policies under a given instance.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listDirectoryPolicies(ListDirectoryPoliciesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listDirectoryPolicies(InstanceName parent) listDirectoryPolicies(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listDirectoryPoliciesPagedCallable() listDirectoryPoliciesCallable()
ListLocations	Lists information about the supported locations for this service. This method lists locations based on the resource scope provided inthe ListLocationsRequest.name field: *Global locations: If `name` is empty, the method lists thepublic locations available to all projects. * Project-specificlocations: If `name` follows the format`projects/{project}`, the method lists locations visible to thatspecific project. This includes public, private, or otherproject-specific locations enabled for the project. For gRPC and client library implementations, the resource name ispassed as the `name` field. For direct service calls, the resourcename isincorporated into the request path based on the specific serviceimplementation and version.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listLocations(ListLocationsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listLocationsPagedCallable() listLocationsCallable()
GetLocation	Gets information about a location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getLocation(GetLocationRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getLocationCallable()

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 LustreSettings 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
 LustreSettings lustreSettings =
     LustreSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 LustreClient lustreClient = LustreClient.create(lustreSettings);

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
 LustreSettings lustreSettings = LustreSettings.newBuilder().setEndpoint(myEndpoint).build();
 LustreClient lustreClient = LustreClient.create(lustreSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 LustreSettings lustreSettings = LustreSettings.newHttpJsonBuilder().build();
 LustreClient lustreClient = LustreClient.create(lustreSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > LustreClient

Static Methods

create()

public static final LustreClient create()

Constructs an instance of LustreClient with default settings.

Returns
Type	Description
`LustreClient`

Exceptions
Type	Description
`IOException`

create(LustreSettings settings)

public static final LustreClient create(LustreSettings settings)

Constructs an instance of LustreClient, 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`	`LustreSettings`

Returns
Type	Description
`LustreClient`

Exceptions
Type	Description
`IOException`

create(LustreStub stub)

public static final LustreClient create(LustreStub stub)

Constructs an instance of LustreClient, using the given stub for making calls. This is for advanced usage - prefer using create(LustreSettings).

Parameter
Name	Description
`stub`	`LustreStub`

Returns
Type	Description
`LustreClient`

Constructors

LustreClient(LustreSettings settings)

protected LustreClient(LustreSettings settings)

Constructs an instance of LustreClient, 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`	`LustreSettings`

LustreClient(LustreStub stub)

protected LustreClient(LustreStub stub)

Parameter
Name	Description
`stub`	`LustreStub`

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`

close()

public final void close()

createDirectoryPolicyAsync(@Nullable InstanceName parent, DirectoryPolicy directoryPolicy, String directoryPolicyId)

public final OperationFuture<DirectoryPolicy,OperationMetadata> createDirectoryPolicyAsync(@Nullable InstanceName parent, DirectoryPolicy directoryPolicy, String directoryPolicyId)

Creates a directory policy resource.

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 (LustreClient lustreClient = LustreClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   DirectoryPolicy directoryPolicy = DirectoryPolicy.newBuilder().build();
   String directoryPolicyId = "directoryPolicyId1899556730";
   DirectoryPolicy response =
       lustreClient.createDirectoryPolicyAsync(parent, directoryPolicy, directoryPolicyId).get();
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.lustre.v1.InstanceName` Required. The parent instance. It must be in the format of `projects/{project}/locations/{location}/instances/{instance}`.
`directoryPolicy`	`DirectoryPolicy` Required. The directory policy to create.
`directoryPolicyId`	`String` Required. The ID for the DirectoryPolicy to create.

Returns
Type	Description
`OperationFuture<DirectoryPolicy,OperationMetadata>`

createDirectoryPolicyAsync(CreateDirectoryPolicyRequest request)

public final OperationFuture<DirectoryPolicy,OperationMetadata> createDirectoryPolicyAsync(CreateDirectoryPolicyRequest request)

Creates a directory policy resource.

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 (LustreClient lustreClient = LustreClient.create()) {
   CreateDirectoryPolicyRequest request =
       CreateDirectoryPolicyRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setDirectoryPolicyId("directoryPolicyId1899556730")
           .setDirectoryPolicy(DirectoryPolicy.newBuilder().build())
           .build();
   DirectoryPolicy response = lustreClient.createDirectoryPolicyAsync(request).get();
 }

Parameter
Name	Description
`request`	`CreateDirectoryPolicyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<DirectoryPolicy,OperationMetadata>`

createDirectoryPolicyAsync(String parent, DirectoryPolicy directoryPolicy, String directoryPolicyId)

public final OperationFuture<DirectoryPolicy,OperationMetadata> createDirectoryPolicyAsync(String parent, DirectoryPolicy directoryPolicy, String directoryPolicyId)

Creates a directory policy resource.

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 (LustreClient lustreClient = LustreClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   DirectoryPolicy directoryPolicy = DirectoryPolicy.newBuilder().build();
   String directoryPolicyId = "directoryPolicyId1899556730";
   DirectoryPolicy response =
       lustreClient.createDirectoryPolicyAsync(parent, directoryPolicy, directoryPolicyId).get();
 }

Parameters
Name	Description
`parent`	`String` Required. The parent instance. It must be in the format of `projects/{project}/locations/{location}/instances/{instance}`.
`directoryPolicy`	`DirectoryPolicy` Required. The directory policy to create.
`directoryPolicyId`	`String` Required. The ID for the DirectoryPolicy to create.

Returns
Type	Description
`OperationFuture<DirectoryPolicy,OperationMetadata>`

createDirectoryPolicyCallable()

public final UnaryCallable<CreateDirectoryPolicyRequest,Operation> createDirectoryPolicyCallable()

Creates a directory policy resource.

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 (LustreClient lustreClient = LustreClient.create()) {
   CreateDirectoryPolicyRequest request =
       CreateDirectoryPolicyRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setDirectoryPolicyId("directoryPolicyId1899556730")
           .setDirectoryPolicy(DirectoryPolicy.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       lustreClient.createDirectoryPolicyCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateDirectoryPolicyRequest,Operation>`

createDirectoryPolicyOperationCallable()

public final OperationCallable<CreateDirectoryPolicyRequest,DirectoryPolicy,OperationMetadata> createDirectoryPolicyOperationCallable()

Creates a directory policy resource.

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 (LustreClient lustreClient = LustreClient.create()) {
   CreateDirectoryPolicyRequest request =
       CreateDirectoryPolicyRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setDirectoryPolicyId("directoryPolicyId1899556730")
           .setDirectoryPolicy(DirectoryPolicy.newBuilder().build())
           .build();
   OperationFuture<DirectoryPolicy, OperationMetadata> future =
       lustreClient.createDirectoryPolicyOperationCallable().futureCall(request);
   // Do something.
   DirectoryPolicy response = future.get();
 }

Returns
Type	Description
`OperationCallable<CreateDirectoryPolicyRequest,DirectoryPolicy,OperationMetadata>`

createInstanceAsync(@Nullable LocationName parent, Instance instance, String instanceId)

public final OperationFuture<Instance,OperationMetadata> createInstanceAsync(@Nullable 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 (LustreClient lustreClient = LustreClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Instance instance = Instance.newBuilder().build();
   String instanceId = "instanceId902024336";
   Instance response = lustreClient.createInstanceAsync(parent, instance, instanceId).get();
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.lustre.v1.LocationName` Required. The instance's project and location, in the format `projects/{project}/locations/{location}`. Locations map to Google Cloud zones; for example, `us-west1-b`.
`instance`	`Instance` Required. The resource being created
`instanceId`	`String` Required. The name of the Managed Lustre instance. Must contain only lowercase letters, numbers, and hyphens. Must start with a letter. Must be between 1-63 characters. Must end with a number or a letter.

Returns
Type	Description
`OperationFuture<Instance,OperationMetadata>`

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 (LustreClient lustreClient = LustreClient.create()) {
   CreateInstanceRequest request =
       CreateInstanceRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setInstanceId("instanceId902024336")
           .setInstance(Instance.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Instance response = lustreClient.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(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 (LustreClient lustreClient = LustreClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Instance instance = Instance.newBuilder().build();
   String instanceId = "instanceId902024336";
   Instance response = lustreClient.createInstanceAsync(parent, instance, instanceId).get();
 }

Parameters
Name	Description
`parent`	`String` Required. The instance's project and location, in the format `projects/{project}/locations/{location}`. Locations map to Google Cloud zones; for example, `us-west1-b`.
`instance`	`Instance` Required. The resource being created
`instanceId`	`String` Required. The name of the Managed Lustre instance. Must contain only lowercase letters, numbers, and hyphens. Must start with a letter. Must be between 1-63 characters. Must end with a number or a letter.

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 (LustreClient lustreClient = LustreClient.create()) {
   CreateInstanceRequest request =
       CreateInstanceRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setInstanceId("instanceId902024336")
           .setInstance(Instance.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = lustreClient.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 (LustreClient lustreClient = LustreClient.create()) {
   CreateInstanceRequest request =
       CreateInstanceRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setInstanceId("instanceId902024336")
           .setInstance(Instance.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Instance, OperationMetadata> future =
       lustreClient.createInstanceOperationCallable().futureCall(request);
   // Do something.
   Instance response = future.get();
 }

Returns
Type	Description
`OperationCallable<CreateInstanceRequest,Instance,OperationMetadata>`

createMirrorAsync(@Nullable InstanceName parent, Mirror mirror, String mirrorId)

public final OperationFuture<Mirror,CreateMirrorMetadata> createMirrorAsync(@Nullable InstanceName parent, Mirror mirror, String mirrorId)

Creates a new mirror in a given 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 (LustreClient lustreClient = LustreClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   Mirror mirror = Mirror.newBuilder().build();
   String mirrorId = "mirrorId-1236172486";
   Mirror response = lustreClient.createMirrorAsync(parent, mirror, mirrorId).get();
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.lustre.v1.InstanceName` Required. Parent instance resource where the mirror will be created, in the format: `projects/{project}/locations/{location}/instances/{instance}`
`mirror`	`Mirror` Required. The mirror to create.
`mirrorId`	`String` Required. The ID to use for the mirror. Must contain only lowercase letters, numbers, and hyphens. Must start with a letter. Must be between 1-63 characters. Must end with a number or a letter. The ID cannot be changed after the mirror is created.

Returns
Type	Description
`OperationFuture<Mirror,CreateMirrorMetadata>`

createMirrorAsync(CreateMirrorRequest request)

public final OperationFuture<Mirror,CreateMirrorMetadata> createMirrorAsync(CreateMirrorRequest request)

Creates a new mirror in a given 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 (LustreClient lustreClient = LustreClient.create()) {
   CreateMirrorRequest request =
       CreateMirrorRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setMirrorId("mirrorId-1236172486")
           .setMirror(Mirror.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Mirror response = lustreClient.createMirrorAsync(request).get();
 }

Parameter
Name	Description
`request`	`CreateMirrorRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Mirror,CreateMirrorMetadata>`

createMirrorAsync(String parent, Mirror mirror, String mirrorId)

public final OperationFuture<Mirror,CreateMirrorMetadata> createMirrorAsync(String parent, Mirror mirror, String mirrorId)

Creates a new mirror in a given 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 (LustreClient lustreClient = LustreClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   Mirror mirror = Mirror.newBuilder().build();
   String mirrorId = "mirrorId-1236172486";
   Mirror response = lustreClient.createMirrorAsync(parent, mirror, mirrorId).get();
 }

Parameters
Name	Description
`parent`	`String` Required. Parent instance resource where the mirror will be created, in the format: `projects/{project}/locations/{location}/instances/{instance}`
`mirror`	`Mirror` Required. The mirror to create.
`mirrorId`	`String` Required. The ID to use for the mirror. Must contain only lowercase letters, numbers, and hyphens. Must start with a letter. Must be between 1-63 characters. Must end with a number or a letter. The ID cannot be changed after the mirror is created.

Returns
Type	Description
`OperationFuture<Mirror,CreateMirrorMetadata>`

createMirrorCallable()

public final UnaryCallable<CreateMirrorRequest,Operation> createMirrorCallable()

Creates a new mirror in a given 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 (LustreClient lustreClient = LustreClient.create()) {
   CreateMirrorRequest request =
       CreateMirrorRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setMirrorId("mirrorId-1236172486")
           .setMirror(Mirror.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = lustreClient.createMirrorCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateMirrorRequest,Operation>`

createMirrorOperationCallable()

public final OperationCallable<CreateMirrorRequest,Mirror,CreateMirrorMetadata> createMirrorOperationCallable()

Creates a new mirror in a given 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 (LustreClient lustreClient = LustreClient.create()) {
   CreateMirrorRequest request =
       CreateMirrorRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setMirrorId("mirrorId-1236172486")
           .setMirror(Mirror.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Mirror, CreateMirrorMetadata> future =
       lustreClient.createMirrorOperationCallable().futureCall(request);
   // Do something.
   Mirror response = future.get();
 }

Returns
Type	Description
`OperationCallable<CreateMirrorRequest,Mirror,CreateMirrorMetadata>`

deleteDirectoryPolicyAsync(@Nullable DirectoryPolicyName name)

public final OperationFuture<Empty,OperationMetadata> deleteDirectoryPolicyAsync(@Nullable DirectoryPolicyName name)

Deletes a directory policy resource.

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 (LustreClient lustreClient = LustreClient.create()) {
   DirectoryPolicyName name =
       DirectoryPolicyName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DIRECTORY_POLICY]");
   lustreClient.deleteDirectoryPolicyAsync(name).get();
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.lustre.v1.DirectoryPolicyName` Required. The resource name of the directory policy. DirectoryPolicy names have the form `projects/{project}/locations/{location}/instances/{instance}/directoryPolicies/{id}`.

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteDirectoryPolicyAsync(DeleteDirectoryPolicyRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteDirectoryPolicyAsync(DeleteDirectoryPolicyRequest request)

Deletes a directory policy resource.

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 (LustreClient lustreClient = LustreClient.create()) {
   DeleteDirectoryPolicyRequest request =
       DeleteDirectoryPolicyRequest.newBuilder()
           .setName(
               DirectoryPolicyName.of(
                       "[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DIRECTORY_POLICY]")
                   .toString())
           .build();
   lustreClient.deleteDirectoryPolicyAsync(request).get();
 }

Parameter
Name	Description
`request`	`DeleteDirectoryPolicyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteDirectoryPolicyAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteDirectoryPolicyAsync(String name)

Deletes a directory policy resource.

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 (LustreClient lustreClient = LustreClient.create()) {
   String name =
       DirectoryPolicyName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DIRECTORY_POLICY]")
           .toString();
   lustreClient.deleteDirectoryPolicyAsync(name).get();
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the directory policy. DirectoryPolicy names have the form `projects/{project}/locations/{location}/instances/{instance}/directoryPolicies/{id}`.

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteDirectoryPolicyCallable()

public final UnaryCallable<DeleteDirectoryPolicyRequest,Operation> deleteDirectoryPolicyCallable()

Deletes a directory policy resource.

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 (LustreClient lustreClient = LustreClient.create()) {
   DeleteDirectoryPolicyRequest request =
       DeleteDirectoryPolicyRequest.newBuilder()
           .setName(
               DirectoryPolicyName.of(
                       "[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DIRECTORY_POLICY]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       lustreClient.deleteDirectoryPolicyCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteDirectoryPolicyRequest,Operation>`

deleteDirectoryPolicyOperationCallable()

public final OperationCallable<DeleteDirectoryPolicyRequest,Empty,OperationMetadata> deleteDirectoryPolicyOperationCallable()

Deletes a directory policy resource.

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 (LustreClient lustreClient = LustreClient.create()) {
   DeleteDirectoryPolicyRequest request =
       DeleteDirectoryPolicyRequest.newBuilder()
           .setName(
               DirectoryPolicyName.of(
                       "[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DIRECTORY_POLICY]")
                   .toString())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       lustreClient.deleteDirectoryPolicyOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`OperationCallable<DeleteDirectoryPolicyRequest,Empty,OperationMetadata>`

deleteInstanceAsync(@Nullable InstanceName name)

public final OperationFuture<Empty,OperationMetadata> deleteInstanceAsync(@Nullable 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 (LustreClient lustreClient = LustreClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   lustreClient.deleteInstanceAsync(name).get();
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.lustre.v1.InstanceName` Required. The resource name of the instance to delete, in the format `projects/{projectId}/locations/{location}/instances/{instanceId}`.

Returns
Type	Description
`OperationFuture<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 (LustreClient lustreClient = LustreClient.create()) {
   DeleteInstanceRequest request =
       DeleteInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setRequestId("requestId693933066")
           .setForce(true)
           .build();
   lustreClient.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(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 (LustreClient lustreClient = LustreClient.create()) {
   String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   lustreClient.deleteInstanceAsync(name).get();
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the instance to delete, in the format `projects/{projectId}/locations/{location}/instances/{instanceId}`.

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 (LustreClient lustreClient = LustreClient.create()) {
   DeleteInstanceRequest request =
       DeleteInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setRequestId("requestId693933066")
           .setForce(true)
           .build();
   ApiFuture<Operation> future = lustreClient.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 (LustreClient lustreClient = LustreClient.create()) {
   DeleteInstanceRequest request =
       DeleteInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setRequestId("requestId693933066")
           .setForce(true)
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       lustreClient.deleteInstanceOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`OperationCallable<DeleteInstanceRequest,Empty,OperationMetadata>`

deleteMirrorAsync(@Nullable MirrorName name)

public final OperationFuture<Empty,OperationMetadata> deleteMirrorAsync(@Nullable MirrorName name)

Deletes a single mirror.

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 (LustreClient lustreClient = LustreClient.create()) {
   MirrorName name = MirrorName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[MIRROR]");
   lustreClient.deleteMirrorAsync(name).get();
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.lustre.v1.MirrorName` Required. Name of the mirror to delete, in the format: `projects/{project}/locations/{location}/instances/{instance}/mirrors/{mirror}`

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteMirrorAsync(DeleteMirrorRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteMirrorAsync(DeleteMirrorRequest request)

Deletes a single mirror.

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 (LustreClient lustreClient = LustreClient.create()) {
   DeleteMirrorRequest request =
       DeleteMirrorRequest.newBuilder()
           .setName(
               MirrorName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[MIRROR]").toString())
           .setRequestId("requestId693933066")
           .build();
   lustreClient.deleteMirrorAsync(request).get();
 }

Parameter
Name	Description
`request`	`DeleteMirrorRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteMirrorAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteMirrorAsync(String name)

Deletes a single mirror.

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 (LustreClient lustreClient = LustreClient.create()) {
   String name = MirrorName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[MIRROR]").toString();
   lustreClient.deleteMirrorAsync(name).get();
 }

Parameter
Name	Description
`name`	`String` Required. Name of the mirror to delete, in the format: `projects/{project}/locations/{location}/instances/{instance}/mirrors/{mirror}`

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteMirrorCallable()

public final UnaryCallable<DeleteMirrorRequest,Operation> deleteMirrorCallable()

Deletes a single mirror.

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 (LustreClient lustreClient = LustreClient.create()) {
   DeleteMirrorRequest request =
       DeleteMirrorRequest.newBuilder()
           .setName(
               MirrorName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[MIRROR]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = lustreClient.deleteMirrorCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteMirrorRequest,Operation>`

deleteMirrorOperationCallable()

public final OperationCallable<DeleteMirrorRequest,Empty,OperationMetadata> deleteMirrorOperationCallable()

Deletes a single mirror.

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 (LustreClient lustreClient = LustreClient.create()) {
   DeleteMirrorRequest request =
       DeleteMirrorRequest.newBuilder()
           .setName(
               MirrorName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[MIRROR]").toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       lustreClient.deleteMirrorOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`OperationCallable<DeleteMirrorRequest,Empty,OperationMetadata>`

exportDataAsync(ExportDataRequest request)

public final OperationFuture<ExportDataResponse,ExportDataMetadata> exportDataAsync(ExportDataRequest request)

Exports data from a Managed Lustre instance to Cloud Storage.

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 (LustreClient lustreClient = LustreClient.create()) {
   ExportDataRequest request =
       ExportDataRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setRequestId("requestId693933066")
           .setServiceAccount(ServiceAccountName.of("[PROJECT]", "[SERVICE_ACCOUNT]").toString())
           .build();
   ExportDataResponse response = lustreClient.exportDataAsync(request).get();
 }

Parameter
Name	Description
`request`	`ExportDataRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<ExportDataResponse,ExportDataMetadata>`

exportDataCallable()

public final UnaryCallable<ExportDataRequest,Operation> exportDataCallable()

Exports data from a Managed Lustre instance to Cloud Storage.

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 (LustreClient lustreClient = LustreClient.create()) {
   ExportDataRequest request =
       ExportDataRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setRequestId("requestId693933066")
           .setServiceAccount(ServiceAccountName.of("[PROJECT]", "[SERVICE_ACCOUNT]").toString())
           .build();
   ApiFuture<Operation> future = lustreClient.exportDataCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<ExportDataRequest,Operation>`

exportDataOperationCallable()

public final OperationCallable<ExportDataRequest,ExportDataResponse,ExportDataMetadata> exportDataOperationCallable()

Exports data from a Managed Lustre instance to Cloud Storage.

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 (LustreClient lustreClient = LustreClient.create()) {
   ExportDataRequest request =
       ExportDataRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setRequestId("requestId693933066")
           .setServiceAccount(ServiceAccountName.of("[PROJECT]", "[SERVICE_ACCOUNT]").toString())
           .build();
   OperationFuture<ExportDataResponse, ExportDataMetadata> future =
       lustreClient.exportDataOperationCallable().futureCall(request);
   // Do something.
   ExportDataResponse response = future.get();
 }

Returns
Type	Description
`OperationCallable<ExportDataRequest,ExportDataResponse,ExportDataMetadata>`

getDirectoryPolicy(@Nullable DirectoryPolicyName name)

public final DirectoryPolicy getDirectoryPolicy(@Nullable DirectoryPolicyName name)

Gets details of a single directory policy.

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 (LustreClient lustreClient = LustreClient.create()) {
   DirectoryPolicyName name =
       DirectoryPolicyName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DIRECTORY_POLICY]");
   DirectoryPolicy response = lustreClient.getDirectoryPolicy(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.lustre.v1.DirectoryPolicyName` Required. The resource name of the directory policy. DirectoryPolicy names have the form `projects/{project}/locations/{location}/instances/{instance}/directoryPolicies/{id}`.

Returns
Type	Description
`DirectoryPolicy`

getDirectoryPolicy(GetDirectoryPolicyRequest request)

public final DirectoryPolicy getDirectoryPolicy(GetDirectoryPolicyRequest request)

Gets details of a single directory policy.

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 (LustreClient lustreClient = LustreClient.create()) {
   GetDirectoryPolicyRequest request =
       GetDirectoryPolicyRequest.newBuilder()
           .setName(
               DirectoryPolicyName.of(
                       "[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DIRECTORY_POLICY]")
                   .toString())
           .build();
   DirectoryPolicy response = lustreClient.getDirectoryPolicy(request);
 }

Parameter
Name	Description
`request`	`GetDirectoryPolicyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`DirectoryPolicy`

getDirectoryPolicy(String name)

public final DirectoryPolicy getDirectoryPolicy(String name)

Gets details of a single directory policy.

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 (LustreClient lustreClient = LustreClient.create()) {
   String name =
       DirectoryPolicyName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DIRECTORY_POLICY]")
           .toString();
   DirectoryPolicy response = lustreClient.getDirectoryPolicy(name);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the directory policy. DirectoryPolicy names have the form `projects/{project}/locations/{location}/instances/{instance}/directoryPolicies/{id}`.

Returns
Type	Description
`DirectoryPolicy`

getDirectoryPolicyCallable()

public final UnaryCallable<GetDirectoryPolicyRequest,DirectoryPolicy> getDirectoryPolicyCallable()

Gets details of a single directory policy.

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 (LustreClient lustreClient = LustreClient.create()) {
   GetDirectoryPolicyRequest request =
       GetDirectoryPolicyRequest.newBuilder()
           .setName(
               DirectoryPolicyName.of(
                       "[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DIRECTORY_POLICY]")
                   .toString())
           .build();
   ApiFuture<DirectoryPolicy> future =
       lustreClient.getDirectoryPolicyCallable().futureCall(request);
   // Do something.
   DirectoryPolicy response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetDirectoryPolicyRequest,DirectoryPolicy>`

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(@Nullable InstanceName name)

public final Instance getInstance(@Nullable 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 (LustreClient lustreClient = LustreClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   Instance response = lustreClient.getInstance(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.lustre.v1.InstanceName` Required. The instance resource name, in the format `projects/{projectId}/locations/{location}/instances/{instanceId}`.

Returns
Type	Description
`Instance`

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 (LustreClient lustreClient = LustreClient.create()) {
   GetInstanceRequest request =
       GetInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   Instance response = lustreClient.getInstance(request);
 }

Parameter
Name	Description
`request`	`GetInstanceRequest` The request object containing all of the parameters for the API call.

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 (LustreClient lustreClient = LustreClient.create()) {
   String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   Instance response = lustreClient.getInstance(name);
 }

Parameter
Name	Description
`name`	`String` Required. The instance resource name, in the format `projects/{projectId}/locations/{location}/instances/{instanceId}`.

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 (LustreClient lustreClient = LustreClient.create()) {
   GetInstanceRequest request =
       GetInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   ApiFuture<Instance> future = lustreClient.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 (LustreClient lustreClient = LustreClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = lustreClient.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 (LustreClient lustreClient = LustreClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = lustreClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`

getMirror(@Nullable MirrorName name)

public final Mirror getMirror(@Nullable MirrorName name)

Gets details of a single mirror.

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 (LustreClient lustreClient = LustreClient.create()) {
   MirrorName name = MirrorName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[MIRROR]");
   Mirror response = lustreClient.getMirror(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.lustre.v1.MirrorName` Required. Name of the mirror to retrieve, in the format: `projects/{project}/locations/{location}/instances/{instance}/mirrors/{mirror}`

Returns
Type	Description
`Mirror`

getMirror(GetMirrorRequest request)

public final Mirror getMirror(GetMirrorRequest request)

Gets details of a single mirror.

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 (LustreClient lustreClient = LustreClient.create()) {
   GetMirrorRequest request =
       GetMirrorRequest.newBuilder()
           .setName(
               MirrorName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[MIRROR]").toString())
           .build();
   Mirror response = lustreClient.getMirror(request);
 }

Parameter
Name	Description
`request`	`GetMirrorRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Mirror`

getMirror(String name)

public final Mirror getMirror(String name)

Gets details of a single mirror.

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 (LustreClient lustreClient = LustreClient.create()) {
   String name = MirrorName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[MIRROR]").toString();
   Mirror response = lustreClient.getMirror(name);
 }

Parameter
Name	Description
`name`	`String` Required. Name of the mirror to retrieve, in the format: `projects/{project}/locations/{location}/instances/{instance}/mirrors/{mirror}`

Returns
Type	Description
`Mirror`

getMirrorCallable()

public final UnaryCallable<GetMirrorRequest,Mirror> getMirrorCallable()

Gets details of a single mirror.

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 (LustreClient lustreClient = LustreClient.create()) {
   GetMirrorRequest request =
       GetMirrorRequest.newBuilder()
           .setName(
               MirrorName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[MIRROR]").toString())
           .build();
   ApiFuture<Mirror> future = lustreClient.getMirrorCallable().futureCall(request);
   // Do something.
   Mirror response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetMirrorRequest,Mirror>`

getOperationsClient()

public final OperationsClient getOperationsClient()

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`

getSettings()

public final @Nullable LustreSettings getSettings()

Returns
Type	Description
`@org.jspecify.annotations.Nullable com.google.cloud.lustre.v1.LustreSettings`

getStub()

public LustreStub getStub()

Returns
Type	Description
`LustreStub`

importDataAsync(@Nullable InstanceName name)

public final OperationFuture<ImportDataResponse,ImportDataMetadata> importDataAsync(@Nullable InstanceName name)

Imports data from Cloud Storage to a Managed Lustre 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 (LustreClient lustreClient = LustreClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   ImportDataResponse response = lustreClient.importDataAsync(name).get();
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.lustre.v1.InstanceName` Required. The name of the Managed Lustre instance in the format `projects/{project}/locations/{location}/instances/{instance}`.

Returns
Type	Description
`OperationFuture<ImportDataResponse,ImportDataMetadata>`

importDataAsync(ImportDataRequest request)

public final OperationFuture<ImportDataResponse,ImportDataMetadata> importDataAsync(ImportDataRequest request)

Imports data from Cloud Storage to a Managed Lustre 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 (LustreClient lustreClient = LustreClient.create()) {
   ImportDataRequest request =
       ImportDataRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setRequestId("requestId693933066")
           .setServiceAccount(ServiceAccountName.of("[PROJECT]", "[SERVICE_ACCOUNT]").toString())
           .build();
   ImportDataResponse response = lustreClient.importDataAsync(request).get();
 }

Parameter
Name	Description
`request`	`ImportDataRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<ImportDataResponse,ImportDataMetadata>`

importDataAsync(String name)

public final OperationFuture<ImportDataResponse,ImportDataMetadata> importDataAsync(String name)

Imports data from Cloud Storage to a Managed Lustre 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 (LustreClient lustreClient = LustreClient.create()) {
   String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   ImportDataResponse response = lustreClient.importDataAsync(name).get();
 }

Parameter
Name	Description
`name`	`String` Required. The name of the Managed Lustre instance in the format `projects/{project}/locations/{location}/instances/{instance}`.

Returns
Type	Description
`OperationFuture<ImportDataResponse,ImportDataMetadata>`

importDataCallable()

public final UnaryCallable<ImportDataRequest,Operation> importDataCallable()

Imports data from Cloud Storage to a Managed Lustre 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 (LustreClient lustreClient = LustreClient.create()) {
   ImportDataRequest request =
       ImportDataRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setRequestId("requestId693933066")
           .setServiceAccount(ServiceAccountName.of("[PROJECT]", "[SERVICE_ACCOUNT]").toString())
           .build();
   ApiFuture<Operation> future = lustreClient.importDataCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<ImportDataRequest,Operation>`

importDataOperationCallable()

public final OperationCallable<ImportDataRequest,ImportDataResponse,ImportDataMetadata> importDataOperationCallable()

Imports data from Cloud Storage to a Managed Lustre 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 (LustreClient lustreClient = LustreClient.create()) {
   ImportDataRequest request =
       ImportDataRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setRequestId("requestId693933066")
           .setServiceAccount(ServiceAccountName.of("[PROJECT]", "[SERVICE_ACCOUNT]").toString())
           .build();
   OperationFuture<ImportDataResponse, ImportDataMetadata> future =
       lustreClient.importDataOperationCallable().futureCall(request);
   // Do something.
   ImportDataResponse response = future.get();
 }

Returns
Type	Description
`OperationCallable<ImportDataRequest,ImportDataResponse,ImportDataMetadata>`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listDirectoryPolicies(@Nullable InstanceName parent)

public final LustreClient.ListDirectoryPoliciesPagedResponse listDirectoryPolicies(@Nullable InstanceName parent)

Gets details of multiple directory policies under a given 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 (LustreClient lustreClient = LustreClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   for (DirectoryPolicy element : lustreClient.listDirectoryPolicies(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.lustre.v1.InstanceName` Required. The parent instance. It must be in the format of `projects/{project}/locations/{location}/instances/{instance}`.

Returns
Type	Description
`LustreClient.ListDirectoryPoliciesPagedResponse`

listDirectoryPolicies(ListDirectoryPoliciesRequest request)

public final LustreClient.ListDirectoryPoliciesPagedResponse listDirectoryPolicies(ListDirectoryPoliciesRequest request)

Gets details of multiple directory policies under a given 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 (LustreClient lustreClient = LustreClient.create()) {
   ListDirectoryPoliciesRequest request =
       ListDirectoryPoliciesRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (DirectoryPolicy element : lustreClient.listDirectoryPolicies(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListDirectoryPoliciesRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`LustreClient.ListDirectoryPoliciesPagedResponse`

listDirectoryPolicies(String parent)

public final LustreClient.ListDirectoryPoliciesPagedResponse listDirectoryPolicies(String parent)

Gets details of multiple directory policies under a given 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 (LustreClient lustreClient = LustreClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   for (DirectoryPolicy element : lustreClient.listDirectoryPolicies(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent instance. It must be in the format of `projects/{project}/locations/{location}/instances/{instance}`.

Returns
Type	Description
`LustreClient.ListDirectoryPoliciesPagedResponse`

listDirectoryPoliciesCallable()

public final UnaryCallable<ListDirectoryPoliciesRequest,ListDirectoryPoliciesResponse> listDirectoryPoliciesCallable()

Gets details of multiple directory policies under a given 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 (LustreClient lustreClient = LustreClient.create()) {
   ListDirectoryPoliciesRequest request =
       ListDirectoryPoliciesRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListDirectoryPoliciesResponse response =
         lustreClient.listDirectoryPoliciesCallable().call(request);
     for (DirectoryPolicy element : response.getDirectoryPoliciesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListDirectoryPoliciesRequest,ListDirectoryPoliciesResponse>`

listDirectoryPoliciesPagedCallable()

public final UnaryCallable<ListDirectoryPoliciesRequest,LustreClient.ListDirectoryPoliciesPagedResponse> listDirectoryPoliciesPagedCallable()

Gets details of multiple directory policies under a given 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 (LustreClient lustreClient = LustreClient.create()) {
   ListDirectoryPoliciesRequest request =
       ListDirectoryPoliciesRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<DirectoryPolicy> future =
       lustreClient.listDirectoryPoliciesPagedCallable().futureCall(request);
   // Do something.
   for (DirectoryPolicy element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListDirectoryPoliciesRequest,ListDirectoryPoliciesPagedResponse>`

listInstances(@Nullable LocationName parent)

public final LustreClient.ListInstancesPagedResponse listInstances(@Nullable 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 (LustreClient lustreClient = LustreClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Instance element : lustreClient.listInstances(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name Description

parent

@org.jspecify.annotations.Nullable com.google.cloud.lustre.v1.LocationName

Required. The project and location for which to retrieve a list of instances, in the format projects/{projectId}/locations/{location}.

To retrieve instance information for all locations, use "-" as the value of {location}.

Returns
Type	Description
`LustreClient.ListInstancesPagedResponse`

listInstances(ListInstancesRequest request)

public final LustreClient.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 (LustreClient lustreClient = LustreClient.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 : lustreClient.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
`LustreClient.ListInstancesPagedResponse`

listInstances(String parent)

public final LustreClient.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 (LustreClient lustreClient = LustreClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Instance element : lustreClient.listInstances(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name Description

parent

String

Required. The project and location for which to retrieve a list of instances, in the format projects/{projectId}/locations/{location}.

To retrieve instance information for all locations, use "-" as the value of {location}.

Returns
Type	Description
`LustreClient.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 (LustreClient lustreClient = LustreClient.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 = lustreClient.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,LustreClient.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 (LustreClient lustreClient = LustreClient.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 = lustreClient.listInstancesPagedCallable().futureCall(request);
   // Do something.
   for (Instance element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListInstancesRequest,ListInstancesPagedResponse>`

listLocations(ListLocationsRequest request)

public final LustreClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

This method lists locations based on the resource scope provided inthe ListLocationsRequest.name field: ***Global locations**: If name is empty, the method lists thepublic locations available to all projects. * **Project-specificlocations**: If name follows the formatprojects/{project}, the method lists locations visible to thatspecific project. This includes public, private, or otherproject-specific locations enabled for the project.

For gRPC and client library implementations, the resource name ispassed as the name field. For direct service calls, the resourcename isincorporated into the request path based on the specific serviceimplementation and version.

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 (LustreClient lustreClient = LustreClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : lustreClient.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
`LustreClient.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 (LustreClient lustreClient = LustreClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response = lustreClient.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,LustreClient.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 (LustreClient lustreClient = LustreClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future = lustreClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>`

listMirrors(@Nullable InstanceName parent)

public final LustreClient.ListMirrorsPagedResponse listMirrors(@Nullable InstanceName parent)

Gets details of multiple mirrors under a given 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 (LustreClient lustreClient = LustreClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   for (Mirror element : lustreClient.listMirrors(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.lustre.v1.InstanceName` Required. Parent instance resource where the mirrors will be listed, in the format: `projects/{project}/locations/{location}/instances/{instance}`

Returns
Type	Description
`LustreClient.ListMirrorsPagedResponse`

listMirrors(ListMirrorsRequest request)

public final LustreClient.ListMirrorsPagedResponse listMirrors(ListMirrorsRequest request)

Gets details of multiple mirrors under a given 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 (LustreClient lustreClient = LustreClient.create()) {
   ListMirrorsRequest request =
       ListMirrorsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   for (Mirror element : lustreClient.listMirrors(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListMirrorsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`LustreClient.ListMirrorsPagedResponse`

listMirrors(String parent)

public final LustreClient.ListMirrorsPagedResponse listMirrors(String parent)

Gets details of multiple mirrors under a given 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 (LustreClient lustreClient = LustreClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   for (Mirror element : lustreClient.listMirrors(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. Parent instance resource where the mirrors will be listed, in the format: `projects/{project}/locations/{location}/instances/{instance}`

Returns
Type	Description
`LustreClient.ListMirrorsPagedResponse`

listMirrorsCallable()

public final UnaryCallable<ListMirrorsRequest,ListMirrorsResponse> listMirrorsCallable()

Gets details of multiple mirrors under a given 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 (LustreClient lustreClient = LustreClient.create()) {
   ListMirrorsRequest request =
       ListMirrorsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListMirrorsResponse response = lustreClient.listMirrorsCallable().call(request);
     for (Mirror element : response.getMirrorsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListMirrorsRequest,ListMirrorsResponse>`

listMirrorsPagedCallable()

public final UnaryCallable<ListMirrorsRequest,LustreClient.ListMirrorsPagedResponse> listMirrorsPagedCallable()

Gets details of multiple mirrors under a given 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 (LustreClient lustreClient = LustreClient.create()) {
   ListMirrorsRequest request =
       ListMirrorsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<Mirror> future = lustreClient.listMirrorsPagedCallable().futureCall(request);
   // Do something.
   for (Mirror element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListMirrorsRequest,ListMirrorsPagedResponse>`

rescheduleMaintenanceAsync(@Nullable InstanceName name, RescheduleMaintenanceRequest.Reschedule reschedule)

public final OperationFuture<Instance,OperationMetadata> rescheduleMaintenanceAsync(@Nullable InstanceName name, RescheduleMaintenanceRequest.Reschedule reschedule)

Reschedules a planned maintenance event for a specific 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 (LustreClient lustreClient = LustreClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   RescheduleMaintenanceRequest.Reschedule reschedule =
       RescheduleMaintenanceRequest.Reschedule.newBuilder().build();
   Instance response = lustreClient.rescheduleMaintenanceAsync(name, reschedule).get();
 }

Parameters
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.lustre.v1.InstanceName` Required. Format: projects/{project}/locations/{location}/instances/{instance}
`reschedule`	`RescheduleMaintenanceRequest.Reschedule` Required. The desired reschedule settings.

Returns
Type	Description
`OperationFuture<Instance,OperationMetadata>`

rescheduleMaintenanceAsync(RescheduleMaintenanceRequest request)

public final OperationFuture<Instance,OperationMetadata> rescheduleMaintenanceAsync(RescheduleMaintenanceRequest request)

Reschedules a planned maintenance event for a specific 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 (LustreClient lustreClient = LustreClient.create()) {
   RescheduleMaintenanceRequest request =
       RescheduleMaintenanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setReschedule(RescheduleMaintenanceRequest.Reschedule.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Instance response = lustreClient.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.Reschedule reschedule)

public final OperationFuture<Instance,OperationMetadata> rescheduleMaintenanceAsync(String name, RescheduleMaintenanceRequest.Reschedule reschedule)

Reschedules a planned maintenance event for a specific 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 (LustreClient lustreClient = LustreClient.create()) {
   String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   RescheduleMaintenanceRequest.Reschedule reschedule =
       RescheduleMaintenanceRequest.Reschedule.newBuilder().build();
   Instance response = lustreClient.rescheduleMaintenanceAsync(name, reschedule).get();
 }

Parameters
Name	Description
`name`	`String` Required. Format: projects/{project}/locations/{location}/instances/{instance}
`reschedule`	`RescheduleMaintenanceRequest.Reschedule` Required. The desired reschedule settings.

Returns
Type	Description
`OperationFuture<Instance,OperationMetadata>`

rescheduleMaintenanceCallable()

public final UnaryCallable<RescheduleMaintenanceRequest,Operation> rescheduleMaintenanceCallable()

Reschedules a planned maintenance event for a specific 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 (LustreClient lustreClient = LustreClient.create()) {
   RescheduleMaintenanceRequest request =
       RescheduleMaintenanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setReschedule(RescheduleMaintenanceRequest.Reschedule.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       lustreClient.rescheduleMaintenanceCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<RescheduleMaintenanceRequest,Operation>`

rescheduleMaintenanceOperationCallable()

public final OperationCallable<RescheduleMaintenanceRequest,Instance,OperationMetadata> rescheduleMaintenanceOperationCallable()

Reschedules a planned maintenance event for a specific 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 (LustreClient lustreClient = LustreClient.create()) {
   RescheduleMaintenanceRequest request =
       RescheduleMaintenanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setReschedule(RescheduleMaintenanceRequest.Reschedule.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Instance, OperationMetadata> future =
       lustreClient.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 (LustreClient lustreClient = LustreClient.create()) {
   Instance instance = Instance.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Instance response = lustreClient.updateInstanceAsync(instance, updateMask).get();
 }

Parameters

Name Description

instance

Instance

Required. The resource name of the instance to update, in the format projects/{projectId}/locations/{location}/instances/{instanceId}.

updateMask

FieldMask

Optional. Specifies the fields to be overwritten in the instance resource by the update.

The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If no mask is provided then all fields present in the request are overwritten.

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 (LustreClient lustreClient = LustreClient.create()) {
   UpdateInstanceRequest request =
       UpdateInstanceRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setInstance(Instance.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Instance response = lustreClient.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 (LustreClient lustreClient = LustreClient.create()) {
   UpdateInstanceRequest request =
       UpdateInstanceRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setInstance(Instance.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = lustreClient.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 (LustreClient lustreClient = LustreClient.create()) {
   UpdateInstanceRequest request =
       UpdateInstanceRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setInstance(Instance.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Instance, OperationMetadata> future =
       lustreClient.updateInstanceOperationCallable().futureCall(request);
   // Do something.
   Instance response = future.get();
 }

Returns
Type	Description
`OperationCallable<UpdateInstanceRequest,Instance,OperationMetadata>`

updateMirrorAsync(Mirror mirror, FieldMask updateMask)

public final OperationFuture<Mirror,OperationMetadata> updateMirrorAsync(Mirror mirror, FieldMask updateMask)

Updates the parameters of a single mirror.

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 (LustreClient lustreClient = LustreClient.create()) {
   Mirror mirror = Mirror.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Mirror response = lustreClient.updateMirrorAsync(mirror, updateMask).get();
 }

Parameters
Name	Description
`mirror`	`Mirror` Required. Mirror to update. The mirror's `name` field is used to identify the mirror to update, in the format: `projects/{project}/locations/{location}/instances/{instance}/mirrors/{mirror}`
`updateMask`	`FieldMask` Optional. Fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If no mask is provided then all fields present in the request are overwritten.

Returns
Type	Description
`OperationFuture<Mirror,OperationMetadata>`

updateMirrorAsync(UpdateMirrorRequest request)

public final OperationFuture<Mirror,OperationMetadata> updateMirrorAsync(UpdateMirrorRequest request)

Updates the parameters of a single mirror.

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 (LustreClient lustreClient = LustreClient.create()) {
   UpdateMirrorRequest request =
       UpdateMirrorRequest.newBuilder()
           .setMirror(Mirror.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Mirror response = lustreClient.updateMirrorAsync(request).get();
 }

Parameter
Name	Description
`request`	`UpdateMirrorRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Mirror,OperationMetadata>`

updateMirrorCallable()

public final UnaryCallable<UpdateMirrorRequest,Operation> updateMirrorCallable()

Updates the parameters of a single mirror.

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 (LustreClient lustreClient = LustreClient.create()) {
   UpdateMirrorRequest request =
       UpdateMirrorRequest.newBuilder()
           .setMirror(Mirror.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = lustreClient.updateMirrorCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateMirrorRequest,Operation>`

updateMirrorOperationCallable()

public final OperationCallable<UpdateMirrorRequest,Mirror,OperationMetadata> updateMirrorOperationCallable()

Updates the parameters of a single mirror.

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 (LustreClient lustreClient = LustreClient.create()) {
   UpdateMirrorRequest request =
       UpdateMirrorRequest.newBuilder()
           .setMirror(Mirror.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Mirror, OperationMetadata> future =
       lustreClient.updateMirrorOperationCallable().futureCall(request);
   // Do something.
   Mirror response = future.get();
 }

Returns
Type	Description
`OperationCallable<UpdateMirrorRequest,Mirror,OperationMetadata>`