Class StorageControlClient (2.71.0)

2.71.0 (latest) 2.70.0 2.69.0 2.67.0 2.64.0 2.63.0 2.62.1 2.60.0 2.59.0 2.58.1 2.57.0 2.56.0 2.55.0 2.54.0 2.53.3 2.52.3 2.50.0 2.49.0 2.48.2 2.47.0 2.46.0 2.45.0 2.44.1 2.43.2 2.42.0 2.41.0 2.40.1 2.39.0 2.38.0 2.37.0 2.36.1 2.34.0 2.33.0 2.32.1 2.30.1 2.29.1 2.28.0 2.27.1 2.24.0 2.23.0 2.22.6 2.21.0 2.20.2 2.19.0 2.18.0 2.17.2 2.16.0 2.15.1 2.14.0 2.13.1 2.12.0 2.11.3 2.10.0 2.9.3 2.8.1 2.7.1 2.6.1 2.5.1 2.4.5 2.3.0 2.2.3 2.1.10

GitHub Repository

Product Reference

Service Description: StorageControl service includes selected control plane operations.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   BucketName parent = BucketName.of("[PROJECT]", "[BUCKET]");
   Folder folder = Folder.newBuilder().build();
   String folderId = "folderId294109737";
   Folder response = storageControlClient.createFolder(parent, folder, folderId);
 }
 

Note: close() needs to be called on the StorageControlClient 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
CreateFolder	Creates a new folder. This operation is only applicable to a hierarchical namespace enabled bucket.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createFolder(CreateFolderRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createFolder(BucketName parent, Folder folder, String folderId) createFolder(String parent, Folder folder, String folderId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createFolderCallable()
DeleteFolder	Permanently deletes an empty folder. This operation is only applicable to a hierarchical namespace enabled bucket.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteFolder(DeleteFolderRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteFolder(FolderName name) deleteFolder(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. deleteFolderCallable()
GetFolder	Returns metadata for the specified folder. This operation is only applicable to a hierarchical namespace enabled bucket.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getFolder(GetFolderRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getFolder(FolderName name) getFolder(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. getFolderCallable()
ListFolders	Retrieves a list of folders. This operation is only applicable to a hierarchical namespace enabled bucket.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listFolders(ListFoldersRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listFolders(BucketName parent) listFolders(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. listFoldersPagedCallable() listFoldersCallable()
RenameFolder	Renames a source folder to a destination folder. This operation is only applicable to a hierarchical namespace enabled bucket. During a rename, the source and destination folders are locked until the long running operation completes.	Request object method variants only take one parameter, a request object, which must be constructed before the call. renameFolderAsync(RenameFolderRequest request) Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service. renameFolderAsync(FolderName name, String destinationFolderId) renameFolderAsync(String name, String destinationFolderId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. renameFolderOperationCallable() renameFolderCallable()
DeleteFolderRecursive	Deletes a folder recursively. This operation is only applicable to a hierarchical namespace enabled bucket.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteFolderRecursiveAsync(DeleteFolderRecursiveRequest request) Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service. deleteFolderRecursiveAsync(FolderName name) deleteFolderRecursiveAsync(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. deleteFolderRecursiveOperationCallable() deleteFolderRecursiveCallable()
GetStorageLayout	Returns the storage layout configuration for a given bucket.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getStorageLayout(GetStorageLayoutRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getStorageLayout(StorageLayoutName name) getStorageLayout(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. getStorageLayoutCallable()
CreateManagedFolder	Creates a new managed folder.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createManagedFolder(CreateManagedFolderRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createManagedFolder(BucketName parent, ManagedFolder managedFolder, String managedFolderId) createManagedFolder(String parent, ManagedFolder managedFolder, String managedFolderId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createManagedFolderCallable()
DeleteManagedFolder	Permanently deletes an empty managed folder.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteManagedFolder(DeleteManagedFolderRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteManagedFolder(ManagedFolderName name) deleteManagedFolder(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. deleteManagedFolderCallable()
GetManagedFolder	Returns metadata for the specified managed folder.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getManagedFolder(GetManagedFolderRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getManagedFolder(ManagedFolderName name) getManagedFolder(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. getManagedFolderCallable()
ListManagedFolders	Retrieves a list of managed folders for a given bucket.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listManagedFolders(ListManagedFoldersRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listManagedFolders(BucketName parent) listManagedFolders(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. listManagedFoldersPagedCallable() listManagedFoldersCallable()
UpdateManagedFolder	Updates a managed folder. Currently, this RPC only supports updating the rapid_cache_config field.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateManagedFolder(UpdateManagedFolderRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateManagedFolder(ManagedFolder managedFolder, 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. updateManagedFolderCallable()
CreateAnywhereCache	Creates an Anywhere Cache instance.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createAnywhereCacheAsync(CreateAnywhereCacheRequest request) Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service. createAnywhereCacheAsync(BucketName parent, AnywhereCache anywhereCache) createAnywhereCacheAsync(String parent, AnywhereCache anywhereCache) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createAnywhereCacheOperationCallable() createAnywhereCacheCallable()
UpdateAnywhereCache	Updates an Anywhere Cache instance. Mutable fields include ttl and admission_policy.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateAnywhereCacheAsync(UpdateAnywhereCacheRequest request) Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service. updateAnywhereCacheAsync(AnywhereCache anywhereCache, 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. updateAnywhereCacheOperationCallable() updateAnywhereCacheCallable()
DisableAnywhereCache	Disables an Anywhere Cache instance. A disabled instance is read-only. The disablement could be revoked by calling ResumeAnywhereCache. The cache instance will be deleted automatically if it remains in the disabled state for at least one hour.	Request object method variants only take one parameter, a request object, which must be constructed before the call. disableAnywhereCache(DisableAnywhereCacheRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. disableAnywhereCache(AnywhereCacheName name) disableAnywhereCache(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. disableAnywhereCacheCallable()
PauseAnywhereCache	Pauses an Anywhere Cache instance.	Request object method variants only take one parameter, a request object, which must be constructed before the call. pauseAnywhereCache(PauseAnywhereCacheRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. pauseAnywhereCache(AnywhereCacheName name) pauseAnywhereCache(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. pauseAnywhereCacheCallable()
ResumeAnywhereCache	Resumes a disabled or paused Anywhere Cache instance.	Request object method variants only take one parameter, a request object, which must be constructed before the call. resumeAnywhereCache(ResumeAnywhereCacheRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. resumeAnywhereCache(AnywhereCacheName name) resumeAnywhereCache(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. resumeAnywhereCacheCallable()
GetAnywhereCache	Gets an Anywhere Cache instance.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getAnywhereCache(GetAnywhereCacheRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getAnywhereCache(AnywhereCacheName name) getAnywhereCache(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. getAnywhereCacheCallable()
ListAnywhereCaches	Lists Anywhere Cache instances for a given bucket.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listAnywhereCaches(ListAnywhereCachesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listAnywhereCaches(BucketName parent) listAnywhereCaches(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. listAnywhereCachesPagedCallable() listAnywhereCachesCallable()
CreateRapidCache	Creates a Rapid Cache instance.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createRapidCacheAsync(CreateRapidCacheRequest request) Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service. createRapidCacheAsync(BucketName parent, RapidCache rapidCache) createRapidCacheAsync(String parent, RapidCache rapidCache) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createRapidCacheOperationCallable() createRapidCacheCallable()
UpdateRapidCache	Updates a Rapid Cache instance.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateRapidCacheAsync(UpdateRapidCacheRequest request) Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service. updateRapidCacheAsync(RapidCache rapidCache, 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. updateRapidCacheOperationCallable() updateRapidCacheCallable()
GetRapidCache	Gets a Rapid Cache instance.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getRapidCache(GetRapidCacheRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getRapidCache(RapidCacheName name) getRapidCache(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. getRapidCacheCallable()
ListRapidCaches	Lists Rapid Cache instances for a given bucket.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listRapidCaches(ListRapidCachesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listRapidCaches(BucketName parent) listRapidCaches(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. listRapidCachesPagedCallable() listRapidCachesCallable()
GetProjectIntelligenceConfig	Returns the Project scoped singleton IntelligenceConfig resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getProjectIntelligenceConfig(GetProjectIntelligenceConfigRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getProjectIntelligenceConfig(IntelligenceConfigName name) getProjectIntelligenceConfig(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. getProjectIntelligenceConfigCallable()
UpdateProjectIntelligenceConfig	Updates the Project scoped singleton IntelligenceConfig resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateProjectIntelligenceConfig(UpdateProjectIntelligenceConfigRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateProjectIntelligenceConfig(IntelligenceConfig intelligenceConfig, 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. updateProjectIntelligenceConfigCallable()
GetFolderIntelligenceConfig	Returns the Folder scoped singleton IntelligenceConfig resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getFolderIntelligenceConfig(GetFolderIntelligenceConfigRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getFolderIntelligenceConfig(IntelligenceConfigName name) getFolderIntelligenceConfig(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. getFolderIntelligenceConfigCallable()
UpdateFolderIntelligenceConfig	Updates the Folder scoped singleton IntelligenceConfig resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateFolderIntelligenceConfig(UpdateFolderIntelligenceConfigRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateFolderIntelligenceConfig(IntelligenceConfig intelligenceConfig, 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. updateFolderIntelligenceConfigCallable()
GetOrganizationIntelligenceConfig	Returns the Organization scoped singleton IntelligenceConfig resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getOrganizationIntelligenceConfig(GetOrganizationIntelligenceConfigRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getOrganizationIntelligenceConfig(IntelligenceConfigName name) getOrganizationIntelligenceConfig(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. getOrganizationIntelligenceConfigCallable()
UpdateOrganizationIntelligenceConfig	Updates the Organization scoped singleton IntelligenceConfig resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateOrganizationIntelligenceConfig(UpdateOrganizationIntelligenceConfigRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateOrganizationIntelligenceConfig(IntelligenceConfig intelligenceConfig, 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. updateOrganizationIntelligenceConfigCallable()
GetIamPolicy	Gets the IAM policy for a specified bucket. The resource field in the request should be projects//buckets/{bucket} for a bucket, or projects//buckets/{bucket}/managedFolders/{managedFolder} for a managed folder.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getIamPolicy(GetIamPolicyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getIamPolicy(ResourceName resource) getIamPolicy(String resource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getIamPolicyCallable()
SetIamPolicy	Updates an IAM policy for the specified bucket. The resource field in the request should be projects//buckets/{bucket} for a bucket, or projects//buckets/{bucket}/managedFolders/{managedFolder} for a managed folder.	Request object method variants only take one parameter, a request object, which must be constructed before the call. setIamPolicy(SetIamPolicyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. setIamPolicy(ResourceName resource, Policy policy) setIamPolicy(String resource, Policy policy) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setIamPolicyCallable()
TestIamPermissions	Tests a set of permissions on the given bucket, object, or managed folder to see which, if any, are held by the caller. The resource field in the request should be projects//buckets/{bucket} for a bucket, projects//buckets/{bucket}/objects/{object} for an object, or projects/_/buckets/{bucket}/managedFolders/{managedFolder} for a managed folder.	Request object method variants only take one parameter, a request object, which must be constructed before the call. testIamPermissions(TestIamPermissionsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. testIamPermissions(ResourceName resource, List<String> permissions) testIamPermissions(String resource, List<String> permissions) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. testIamPermissionsCallable()
GetIntelligenceFinding	Gets the IntelligenceFinding for a project.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getIntelligenceFinding(GetIntelligenceFindingRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getIntelligenceFinding(IntelligenceFindingName name) getIntelligenceFinding(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. getIntelligenceFindingCallable()
ListIntelligenceFindings	Lists the IntelligenceFinding resources for the specified the project.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listIntelligenceFindings(ListIntelligenceFindingsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listIntelligenceFindings(LocationName parent) listIntelligenceFindings(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. listIntelligenceFindingsPagedCallable() listIntelligenceFindingsCallable()
SummarizeIntelligenceFindings	Summarizes the intelligence findings for the specified scope (organization, folder or project).	Request object method variants only take one parameter, a request object, which must be constructed before the call. summarizeIntelligenceFindings(SummarizeIntelligenceFindingsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. summarizeIntelligenceFindings(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. summarizeIntelligenceFindingsPagedCallable() summarizeIntelligenceFindingsCallable()
GetIntelligenceFindingRevision	Gets the IntelligenceFindingRevision resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getIntelligenceFindingRevision(GetIntelligenceFindingRevisionRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getIntelligenceFindingRevision(IntelligenceFindingRevisionName name) getIntelligenceFindingRevision(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. getIntelligenceFindingRevisionCallable()
ListIntelligenceFindingRevisions	Lists all the revisions of an IntelligenceFinding resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listIntelligenceFindingRevisions(ListIntelligenceFindingRevisionsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listIntelligenceFindingRevisions(IntelligenceFindingName parent) listIntelligenceFindingRevisions(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. listIntelligenceFindingRevisionsPagedCallable() listIntelligenceFindingRevisionsCallable()

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 StorageControlSettings 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
 StorageControlSettings storageControlSettings =
     StorageControlSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 StorageControlClient storageControlClient = StorageControlClient.create(storageControlSettings);
 

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
 StorageControlSettings storageControlSettings =
     StorageControlSettings.newBuilder().setEndpoint(myEndpoint).build();
 StorageControlClient storageControlClient = StorageControlClient.create(storageControlSettings);
 

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
 StorageControlSettings storageControlSettings =
     StorageControlSettings.newHttpJsonBuilder().build();
 StorageControlClient storageControlClient = StorageControlClient.create(storageControlSettings);
 

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

Inheritance

java.lang.Object > StorageControlClient

Static Methods

create()

public static final StorageControlClient create()

Constructs an instance of StorageControlClient with default settings.

Returns
Type	Description
StorageControlClient

Exceptions
Type	Description
IOException

create(StorageControlSettings settings)

public static final StorageControlClient create(StorageControlSettings settings)

Constructs an instance of StorageControlClient, 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	StorageControlSettings

Returns
Type	Description
StorageControlClient

Exceptions
Type	Description
IOException

create(StorageControlStub stub)

public static final StorageControlClient create(StorageControlStub stub)

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

Parameter
Name	Description
stub	StorageControlStub

Returns
Type	Description
StorageControlClient

Constructors

StorageControlClient(StorageControlSettings settings)

protected StorageControlClient(StorageControlSettings settings)

Constructs an instance of StorageControlClient, 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	StorageControlSettings

StorageControlClient(StorageControlStub stub)

protected StorageControlClient(StorageControlStub stub)

Parameter
Name	Description
stub	StorageControlStub

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()

createAnywhereCacheAsync(@Nullable BucketName parent, AnywhereCache anywhereCache)

public final OperationFuture<AnywhereCache,CreateAnywhereCacheMetadata> createAnywhereCacheAsync(@Nullable BucketName parent, AnywhereCache anywhereCache)

Creates an Anywhere Cache 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   BucketName parent = BucketName.of("[PROJECT]", "[BUCKET]");
   AnywhereCache anywhereCache = AnywhereCache.newBuilder().build();
   AnywhereCache response =
       storageControlClient.createAnywhereCacheAsync(parent, anywhereCache).get();
 }
 

Parameters
Name	Description
parent	@org.jspecify.annotations.Nullable com.google.storage.control.v2.BucketName Required. The bucket to which this cache belongs. Format: projects/{project}/buckets/{bucket}
anywhereCache	AnywhereCache Required. Properties of the Anywhere Cache instance being created. The parent bucket name is specified in the parent field. Server uses the default value of ttl or admission_policy if not specified in request.

Returns
Type	Description
OperationFuture<AnywhereCache,CreateAnywhereCacheMetadata>

createAnywhereCacheAsync(CreateAnywhereCacheRequest request)

public final OperationFuture<AnywhereCache,CreateAnywhereCacheMetadata> createAnywhereCacheAsync(CreateAnywhereCacheRequest request)

Creates an Anywhere Cache 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   CreateAnywhereCacheRequest request =
       CreateAnywhereCacheRequest.newBuilder()
           .setParent(BucketName.of("[PROJECT]", "[BUCKET]").toString())
           .setAnywhereCache(AnywhereCache.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   AnywhereCache response = storageControlClient.createAnywhereCacheAsync(request).get();
 }
 

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

Returns
Type	Description
OperationFuture<AnywhereCache,CreateAnywhereCacheMetadata>

createAnywhereCacheAsync(String parent, AnywhereCache anywhereCache)

public final OperationFuture<AnywhereCache,CreateAnywhereCacheMetadata> createAnywhereCacheAsync(String parent, AnywhereCache anywhereCache)

Creates an Anywhere Cache 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String parent = BucketName.of("[PROJECT]", "[BUCKET]").toString();
   AnywhereCache anywhereCache = AnywhereCache.newBuilder().build();
   AnywhereCache response =
       storageControlClient.createAnywhereCacheAsync(parent, anywhereCache).get();
 }
 

Parameters
Name	Description
parent	String Required. The bucket to which this cache belongs. Format: projects/{project}/buckets/{bucket}
anywhereCache	AnywhereCache Required. Properties of the Anywhere Cache instance being created. The parent bucket name is specified in the parent field. Server uses the default value of ttl or admission_policy if not specified in request.

Returns
Type	Description
OperationFuture<AnywhereCache,CreateAnywhereCacheMetadata>

createAnywhereCacheCallable()

public final UnaryCallable<CreateAnywhereCacheRequest,Operation> createAnywhereCacheCallable()

Creates an Anywhere Cache 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   CreateAnywhereCacheRequest request =
       CreateAnywhereCacheRequest.newBuilder()
           .setParent(BucketName.of("[PROJECT]", "[BUCKET]").toString())
           .setAnywhereCache(AnywhereCache.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       storageControlClient.createAnywhereCacheCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<CreateAnywhereCacheRequest,Operation>

createAnywhereCacheOperationCallable()

public final OperationCallable<CreateAnywhereCacheRequest,AnywhereCache,CreateAnywhereCacheMetadata> createAnywhereCacheOperationCallable()

Creates an Anywhere Cache 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   CreateAnywhereCacheRequest request =
       CreateAnywhereCacheRequest.newBuilder()
           .setParent(BucketName.of("[PROJECT]", "[BUCKET]").toString())
           .setAnywhereCache(AnywhereCache.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<AnywhereCache, CreateAnywhereCacheMetadata> future =
       storageControlClient.createAnywhereCacheOperationCallable().futureCall(request);
   // Do something.
   AnywhereCache response = future.get();
 }
 

Returns
Type	Description
OperationCallable<CreateAnywhereCacheRequest,AnywhereCache,CreateAnywhereCacheMetadata>

createFolder(@Nullable BucketName parent, Folder folder, String folderId)

public final Folder createFolder(@Nullable BucketName parent, Folder folder, String folderId)

Creates a new folder. This operation is only applicable to a hierarchical namespace enabled bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   BucketName parent = BucketName.of("[PROJECT]", "[BUCKET]");
   Folder folder = Folder.newBuilder().build();
   String folderId = "folderId294109737";
   Folder response = storageControlClient.createFolder(parent, folder, folderId);
 }
 

Parameters
Name	Description
parent	@org.jspecify.annotations.Nullable com.google.storage.control.v2.BucketName Required. Name of the bucket in which the folder will reside. The bucket must be a hierarchical namespace enabled bucket.
folder	Folder Required. Properties of the new folder being created. The bucket and name of the folder are specified in the parent and folder_id fields, respectively. Populating those fields in folder will result in an error.
folderId	String Required. The full name of a folder, including all its parent folders. Folders use single '/' characters as a delimiter. The folder_id must end with a slash. For example, the folder_id of "books/biographies/" would create a new "biographies/" folder under the "books/" folder.

Returns
Type	Description
Folder

createFolder(CreateFolderRequest request)

public final Folder createFolder(CreateFolderRequest request)

Creates a new folder. This operation is only applicable to a hierarchical namespace enabled bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   CreateFolderRequest request =
       CreateFolderRequest.newBuilder()
           .setParent(BucketName.of("[PROJECT]", "[BUCKET]").toString())
           .setFolder(Folder.newBuilder().build())
           .setFolderId("folderId294109737")
           .setRecursive(true)
           .setRequestId("requestId693933066")
           .build();
   Folder response = storageControlClient.createFolder(request);
 }
 

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

Returns
Type	Description
Folder

createFolder(String parent, Folder folder, String folderId)

public final Folder createFolder(String parent, Folder folder, String folderId)

Creates a new folder. This operation is only applicable to a hierarchical namespace enabled bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String parent = BucketName.of("[PROJECT]", "[BUCKET]").toString();
   Folder folder = Folder.newBuilder().build();
   String folderId = "folderId294109737";
   Folder response = storageControlClient.createFolder(parent, folder, folderId);
 }
 

Parameters
Name	Description
parent	String Required. Name of the bucket in which the folder will reside. The bucket must be a hierarchical namespace enabled bucket.
folder	Folder Required. Properties of the new folder being created. The bucket and name of the folder are specified in the parent and folder_id fields, respectively. Populating those fields in folder will result in an error.
folderId	String Required. The full name of a folder, including all its parent folders. Folders use single '/' characters as a delimiter. The folder_id must end with a slash. For example, the folder_id of "books/biographies/" would create a new "biographies/" folder under the "books/" folder.

Returns
Type	Description
Folder

createFolderCallable()

public final UnaryCallable<CreateFolderRequest,Folder> createFolderCallable()

Creates a new folder. This operation is only applicable to a hierarchical namespace enabled bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   CreateFolderRequest request =
       CreateFolderRequest.newBuilder()
           .setParent(BucketName.of("[PROJECT]", "[BUCKET]").toString())
           .setFolder(Folder.newBuilder().build())
           .setFolderId("folderId294109737")
           .setRecursive(true)
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Folder> future = storageControlClient.createFolderCallable().futureCall(request);
   // Do something.
   Folder response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<CreateFolderRequest,Folder>

createManagedFolder(@Nullable BucketName parent, ManagedFolder managedFolder, String managedFolderId)

public final ManagedFolder createManagedFolder(@Nullable BucketName parent, ManagedFolder managedFolder, String managedFolderId)

Creates a new managed folder.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   BucketName parent = BucketName.of("[PROJECT]", "[BUCKET]");
   ManagedFolder managedFolder = ManagedFolder.newBuilder().build();
   String managedFolderId = "managedFolderId-2027084056";
   ManagedFolder response =
       storageControlClient.createManagedFolder(parent, managedFolder, managedFolderId);
 }
 

Parameters
Name	Description
parent	@org.jspecify.annotations.Nullable com.google.storage.control.v2.BucketName Required. Name of the bucket this managed folder belongs to.
managedFolder	ManagedFolder Required. Properties of the managed folder being created. The bucket and managed folder names are specified in the parent and managed_folder_id fields. Populating these fields in managed_folder will result in an error.
managedFolderId	String Required. The name of the managed folder. It uses a single / as delimiter and leading and trailing / are allowed.

Returns
Type	Description
ManagedFolder

createManagedFolder(CreateManagedFolderRequest request)

public final ManagedFolder createManagedFolder(CreateManagedFolderRequest request)

Creates a new managed folder.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   CreateManagedFolderRequest request =
       CreateManagedFolderRequest.newBuilder()
           .setParent(BucketName.of("[PROJECT]", "[BUCKET]").toString())
           .setManagedFolder(ManagedFolder.newBuilder().build())
           .setManagedFolderId("managedFolderId-2027084056")
           .setRequestId("requestId693933066")
           .build();
   ManagedFolder response = storageControlClient.createManagedFolder(request);
 }
 

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

Returns
Type	Description
ManagedFolder

createManagedFolder(String parent, ManagedFolder managedFolder, String managedFolderId)

public final ManagedFolder createManagedFolder(String parent, ManagedFolder managedFolder, String managedFolderId)

Creates a new managed folder.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String parent = BucketName.of("[PROJECT]", "[BUCKET]").toString();
   ManagedFolder managedFolder = ManagedFolder.newBuilder().build();
   String managedFolderId = "managedFolderId-2027084056";
   ManagedFolder response =
       storageControlClient.createManagedFolder(parent, managedFolder, managedFolderId);
 }
 

Parameters
Name	Description
parent	String Required. Name of the bucket this managed folder belongs to.
managedFolder	ManagedFolder Required. Properties of the managed folder being created. The bucket and managed folder names are specified in the parent and managed_folder_id fields. Populating these fields in managed_folder will result in an error.
managedFolderId	String Required. The name of the managed folder. It uses a single / as delimiter and leading and trailing / are allowed.

Returns
Type	Description
ManagedFolder

createManagedFolderCallable()

public final UnaryCallable<CreateManagedFolderRequest,ManagedFolder> createManagedFolderCallable()

Creates a new managed folder.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   CreateManagedFolderRequest request =
       CreateManagedFolderRequest.newBuilder()
           .setParent(BucketName.of("[PROJECT]", "[BUCKET]").toString())
           .setManagedFolder(ManagedFolder.newBuilder().build())
           .setManagedFolderId("managedFolderId-2027084056")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<ManagedFolder> future =
       storageControlClient.createManagedFolderCallable().futureCall(request);
   // Do something.
   ManagedFolder response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<CreateManagedFolderRequest,ManagedFolder>

createRapidCacheAsync(@Nullable BucketName parent, RapidCache rapidCache)

public final OperationFuture<RapidCache,CreateRapidCacheMetadata> createRapidCacheAsync(@Nullable BucketName parent, RapidCache rapidCache)

Creates a Rapid Cache 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   BucketName parent = BucketName.of("[PROJECT]", "[BUCKET]");
   RapidCache rapidCache = RapidCache.newBuilder().build();
   RapidCache response = storageControlClient.createRapidCacheAsync(parent, rapidCache).get();
 }
 

Parameters
Name	Description
parent	@org.jspecify.annotations.Nullable com.google.storage.control.v2.BucketName Required. The bucket to which this cache belongs. Format: projects/{project}/buckets/{bucket}
rapidCache	RapidCache Required. The RapidCache to create. Default values for ingest_on_write, ttl and admission_policy will be applied if not specified in the request.

Returns
Type	Description
OperationFuture<RapidCache,CreateRapidCacheMetadata>

createRapidCacheAsync(CreateRapidCacheRequest request)

public final OperationFuture<RapidCache,CreateRapidCacheMetadata> createRapidCacheAsync(CreateRapidCacheRequest request)

Creates a Rapid Cache 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   CreateRapidCacheRequest request =
       CreateRapidCacheRequest.newBuilder()
           .setParent(BucketName.of("[PROJECT]", "[BUCKET]").toString())
           .setRapidCache(RapidCache.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   RapidCache response = storageControlClient.createRapidCacheAsync(request).get();
 }
 

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

Returns
Type	Description
OperationFuture<RapidCache,CreateRapidCacheMetadata>

createRapidCacheAsync(String parent, RapidCache rapidCache)

public final OperationFuture<RapidCache,CreateRapidCacheMetadata> createRapidCacheAsync(String parent, RapidCache rapidCache)

Creates a Rapid Cache 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String parent = BucketName.of("[PROJECT]", "[BUCKET]").toString();
   RapidCache rapidCache = RapidCache.newBuilder().build();
   RapidCache response = storageControlClient.createRapidCacheAsync(parent, rapidCache).get();
 }
 

Parameters
Name	Description
parent	String Required. The bucket to which this cache belongs. Format: projects/{project}/buckets/{bucket}
rapidCache	RapidCache Required. The RapidCache to create. Default values for ingest_on_write, ttl and admission_policy will be applied if not specified in the request.

Returns
Type	Description
OperationFuture<RapidCache,CreateRapidCacheMetadata>

createRapidCacheCallable()

public final UnaryCallable<CreateRapidCacheRequest,Operation> createRapidCacheCallable()

Creates a Rapid Cache 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   CreateRapidCacheRequest request =
       CreateRapidCacheRequest.newBuilder()
           .setParent(BucketName.of("[PROJECT]", "[BUCKET]").toString())
           .setRapidCache(RapidCache.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       storageControlClient.createRapidCacheCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<CreateRapidCacheRequest,Operation>

createRapidCacheOperationCallable()

public final OperationCallable<CreateRapidCacheRequest,RapidCache,CreateRapidCacheMetadata> createRapidCacheOperationCallable()

Creates a Rapid Cache 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   CreateRapidCacheRequest request =
       CreateRapidCacheRequest.newBuilder()
           .setParent(BucketName.of("[PROJECT]", "[BUCKET]").toString())
           .setRapidCache(RapidCache.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<RapidCache, CreateRapidCacheMetadata> future =
       storageControlClient.createRapidCacheOperationCallable().futureCall(request);
   // Do something.
   RapidCache response = future.get();
 }
 

Returns
Type	Description
OperationCallable<CreateRapidCacheRequest,RapidCache,CreateRapidCacheMetadata>

deleteFolder(@Nullable FolderName name)

public final void deleteFolder(@Nullable FolderName name)

Permanently deletes an empty folder. This operation is only applicable to a hierarchical namespace enabled bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   FolderName name = FolderName.of("[PROJECT]", "[BUCKET]", "[FOLDER]");
   storageControlClient.deleteFolder(name);
 }
 

Parameter
Name	Description
name	@org.jspecify.annotations.Nullable com.google.storage.control.v2.FolderName Required. Name of the folder. Format: projects/{project}/buckets/{bucket}/folders/{folder}

deleteFolder(DeleteFolderRequest request)

public final void deleteFolder(DeleteFolderRequest request)

Permanently deletes an empty folder. This operation is only applicable to a hierarchical namespace enabled bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   DeleteFolderRequest request =
       DeleteFolderRequest.newBuilder()
           .setName(FolderName.of("[PROJECT]", "[BUCKET]", "[FOLDER]").toString())
           .setIfMetagenerationMatch(1043427781)
           .setIfMetagenerationNotMatch(1025430873)
           .setRequestId("requestId693933066")
           .build();
   storageControlClient.deleteFolder(request);
 }
 

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

deleteFolder(String name)

public final void deleteFolder(String name)

Permanently deletes an empty folder. This operation is only applicable to a hierarchical namespace enabled bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String name = FolderName.of("[PROJECT]", "[BUCKET]", "[FOLDER]").toString();
   storageControlClient.deleteFolder(name);
 }
 

Parameter
Name	Description
name	String Required. Name of the folder. Format: projects/{project}/buckets/{bucket}/folders/{folder}

deleteFolderCallable()

public final UnaryCallable<DeleteFolderRequest,Empty> deleteFolderCallable()

Permanently deletes an empty folder. This operation is only applicable to a hierarchical namespace enabled bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   DeleteFolderRequest request =
       DeleteFolderRequest.newBuilder()
           .setName(FolderName.of("[PROJECT]", "[BUCKET]", "[FOLDER]").toString())
           .setIfMetagenerationMatch(1043427781)
           .setIfMetagenerationNotMatch(1025430873)
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Empty> future = storageControlClient.deleteFolderCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns
Type	Description
UnaryCallable<DeleteFolderRequest,Empty>

deleteFolderRecursiveAsync(@Nullable FolderName name)

public final OperationFuture<Empty,DeleteFolderRecursiveMetadata> deleteFolderRecursiveAsync(@Nullable FolderName name)

Deletes a folder recursively. This operation is only applicable to a hierarchical namespace enabled bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   FolderName name = FolderName.of("[PROJECT]", "[BUCKET]", "[FOLDER]");
   storageControlClient.deleteFolderRecursiveAsync(name).get();
 }
 

Parameter
Name	Description
name	@org.jspecify.annotations.Nullable com.google.storage.control.v2.FolderName Required. Name of the folder being deleted, however all of its contents will be deleted too. Format: projects/{project}/buckets/{bucket}/folders/{folder}

Returns
Type	Description
OperationFuture<Empty,DeleteFolderRecursiveMetadata>

deleteFolderRecursiveAsync(DeleteFolderRecursiveRequest request)

public final OperationFuture<Empty,DeleteFolderRecursiveMetadata> deleteFolderRecursiveAsync(DeleteFolderRecursiveRequest request)

Deletes a folder recursively. This operation is only applicable to a hierarchical namespace enabled bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   DeleteFolderRecursiveRequest request =
       DeleteFolderRecursiveRequest.newBuilder()
           .setName(FolderName.of("[PROJECT]", "[BUCKET]", "[FOLDER]").toString())
           .setIfMetagenerationMatch(1043427781)
           .setIfMetagenerationNotMatch(1025430873)
           .setRequestId("requestId693933066")
           .build();
   storageControlClient.deleteFolderRecursiveAsync(request).get();
 }
 

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

Returns
Type	Description
OperationFuture<Empty,DeleteFolderRecursiveMetadata>

deleteFolderRecursiveAsync(String name)

public final OperationFuture<Empty,DeleteFolderRecursiveMetadata> deleteFolderRecursiveAsync(String name)

Deletes a folder recursively. This operation is only applicable to a hierarchical namespace enabled bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String name = FolderName.of("[PROJECT]", "[BUCKET]", "[FOLDER]").toString();
   storageControlClient.deleteFolderRecursiveAsync(name).get();
 }
 

Parameter
Name	Description
name	String Required. Name of the folder being deleted, however all of its contents will be deleted too. Format: projects/{project}/buckets/{bucket}/folders/{folder}

Returns
Type	Description
OperationFuture<Empty,DeleteFolderRecursiveMetadata>

deleteFolderRecursiveCallable()

public final UnaryCallable<DeleteFolderRecursiveRequest,Operation> deleteFolderRecursiveCallable()

Deletes a folder recursively. This operation is only applicable to a hierarchical namespace enabled bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   DeleteFolderRecursiveRequest request =
       DeleteFolderRecursiveRequest.newBuilder()
           .setName(FolderName.of("[PROJECT]", "[BUCKET]", "[FOLDER]").toString())
           .setIfMetagenerationMatch(1043427781)
           .setIfMetagenerationNotMatch(1025430873)
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       storageControlClient.deleteFolderRecursiveCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns
Type	Description
UnaryCallable<DeleteFolderRecursiveRequest,Operation>

deleteFolderRecursiveOperationCallable()

public final OperationCallable<DeleteFolderRecursiveRequest,Empty,DeleteFolderRecursiveMetadata> deleteFolderRecursiveOperationCallable()

Deletes a folder recursively. This operation is only applicable to a hierarchical namespace enabled bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   DeleteFolderRecursiveRequest request =
       DeleteFolderRecursiveRequest.newBuilder()
           .setName(FolderName.of("[PROJECT]", "[BUCKET]", "[FOLDER]").toString())
           .setIfMetagenerationMatch(1043427781)
           .setIfMetagenerationNotMatch(1025430873)
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, DeleteFolderRecursiveMetadata> future =
       storageControlClient.deleteFolderRecursiveOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns
Type	Description
OperationCallable<DeleteFolderRecursiveRequest,Empty,DeleteFolderRecursiveMetadata>

deleteManagedFolder(@Nullable ManagedFolderName name)

public final void deleteManagedFolder(@Nullable ManagedFolderName name)

Permanently deletes an empty managed folder.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   ManagedFolderName name = ManagedFolderName.of("[PROJECT]", "[BUCKET]", "[MANAGED_FOLDER]");
   storageControlClient.deleteManagedFolder(name);
 }
 

Parameter
Name	Description
name	@org.jspecify.annotations.Nullable com.google.storage.control.v2.ManagedFolderName Required. Name of the managed folder. Format: projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}

deleteManagedFolder(DeleteManagedFolderRequest request)

public final void deleteManagedFolder(DeleteManagedFolderRequest request)

Permanently deletes an empty managed folder.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   DeleteManagedFolderRequest request =
       DeleteManagedFolderRequest.newBuilder()
           .setName(ManagedFolderName.of("[PROJECT]", "[BUCKET]", "[MANAGED_FOLDER]").toString())
           .setIfMetagenerationMatch(1043427781)
           .setIfMetagenerationNotMatch(1025430873)
           .setAllowNonEmpty(true)
           .setRequestId("requestId693933066")
           .build();
   storageControlClient.deleteManagedFolder(request);
 }
 

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

deleteManagedFolder(String name)

public final void deleteManagedFolder(String name)

Permanently deletes an empty managed folder.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String name = ManagedFolderName.of("[PROJECT]", "[BUCKET]", "[MANAGED_FOLDER]").toString();
   storageControlClient.deleteManagedFolder(name);
 }
 

Parameter
Name	Description
name	String Required. Name of the managed folder. Format: projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}

deleteManagedFolderCallable()

public final UnaryCallable<DeleteManagedFolderRequest,Empty> deleteManagedFolderCallable()

Permanently deletes an empty managed folder.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   DeleteManagedFolderRequest request =
       DeleteManagedFolderRequest.newBuilder()
           .setName(ManagedFolderName.of("[PROJECT]", "[BUCKET]", "[MANAGED_FOLDER]").toString())
           .setIfMetagenerationMatch(1043427781)
           .setIfMetagenerationNotMatch(1025430873)
           .setAllowNonEmpty(true)
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Empty> future =
       storageControlClient.deleteManagedFolderCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns
Type	Description
UnaryCallable<DeleteManagedFolderRequest,Empty>

disableAnywhereCache(@Nullable AnywhereCacheName name)

public final AnywhereCache disableAnywhereCache(@Nullable AnywhereCacheName name)

Disables an Anywhere Cache instance. A disabled instance is read-only. The disablement could be revoked by calling ResumeAnywhereCache. The cache instance will be deleted automatically if it remains in the disabled state for at least one hour.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   AnywhereCacheName name = AnywhereCacheName.of("[PROJECT]", "[BUCKET]", "[ANYWHERE_CACHE]");
   AnywhereCache response = storageControlClient.disableAnywhereCache(name);
 }
 

Parameter
Name	Description
name	@org.jspecify.annotations.Nullable com.google.storage.control.v2.AnywhereCacheName Required. The name field in the request should be: projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}

Returns
Type	Description
AnywhereCache

disableAnywhereCache(DisableAnywhereCacheRequest request)

public final AnywhereCache disableAnywhereCache(DisableAnywhereCacheRequest request)

Disables an Anywhere Cache instance. A disabled instance is read-only. The disablement could be revoked by calling ResumeAnywhereCache. The cache instance will be deleted automatically if it remains in the disabled state for at least one hour.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   DisableAnywhereCacheRequest request =
       DisableAnywhereCacheRequest.newBuilder()
           .setName(AnywhereCacheName.of("[PROJECT]", "[BUCKET]", "[ANYWHERE_CACHE]").toString())
           .setRequestId("requestId693933066")
           .build();
   AnywhereCache response = storageControlClient.disableAnywhereCache(request);
 }
 

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

Returns
Type	Description
AnywhereCache

disableAnywhereCache(String name)

public final AnywhereCache disableAnywhereCache(String name)

Disables an Anywhere Cache instance. A disabled instance is read-only. The disablement could be revoked by calling ResumeAnywhereCache. The cache instance will be deleted automatically if it remains in the disabled state for at least one hour.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String name = AnywhereCacheName.of("[PROJECT]", "[BUCKET]", "[ANYWHERE_CACHE]").toString();
   AnywhereCache response = storageControlClient.disableAnywhereCache(name);
 }
 

Parameter
Name	Description
name	String Required. The name field in the request should be: projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}

Returns
Type	Description
AnywhereCache

disableAnywhereCacheCallable()

public final UnaryCallable<DisableAnywhereCacheRequest,AnywhereCache> disableAnywhereCacheCallable()

Disables an Anywhere Cache instance. A disabled instance is read-only. The disablement could be revoked by calling ResumeAnywhereCache. The cache instance will be deleted automatically if it remains in the disabled state for at least one hour.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   DisableAnywhereCacheRequest request =
       DisableAnywhereCacheRequest.newBuilder()
           .setName(AnywhereCacheName.of("[PROJECT]", "[BUCKET]", "[ANYWHERE_CACHE]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<AnywhereCache> future =
       storageControlClient.disableAnywhereCacheCallable().futureCall(request);
   // Do something.
   AnywhereCache response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<DisableAnywhereCacheRequest,AnywhereCache>

getAnywhereCache(@Nullable AnywhereCacheName name)

public final AnywhereCache getAnywhereCache(@Nullable AnywhereCacheName name)

Gets an Anywhere Cache 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   AnywhereCacheName name = AnywhereCacheName.of("[PROJECT]", "[BUCKET]", "[ANYWHERE_CACHE]");
   AnywhereCache response = storageControlClient.getAnywhereCache(name);
 }
 

Parameter
Name	Description
name	@org.jspecify.annotations.Nullable com.google.storage.control.v2.AnywhereCacheName Required. The name field in the request should be: projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}

Returns
Type	Description
AnywhereCache

getAnywhereCache(GetAnywhereCacheRequest request)

public final AnywhereCache getAnywhereCache(GetAnywhereCacheRequest request)

Gets an Anywhere Cache 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   GetAnywhereCacheRequest request =
       GetAnywhereCacheRequest.newBuilder()
           .setName(AnywhereCacheName.of("[PROJECT]", "[BUCKET]", "[ANYWHERE_CACHE]").toString())
           .setRequestId("requestId693933066")
           .build();
   AnywhereCache response = storageControlClient.getAnywhereCache(request);
 }
 

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

Returns
Type	Description
AnywhereCache

getAnywhereCache(String name)

public final AnywhereCache getAnywhereCache(String name)

Gets an Anywhere Cache 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String name = AnywhereCacheName.of("[PROJECT]", "[BUCKET]", "[ANYWHERE_CACHE]").toString();
   AnywhereCache response = storageControlClient.getAnywhereCache(name);
 }
 

Parameter
Name	Description
name	String Required. The name field in the request should be: projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}

Returns
Type	Description
AnywhereCache

getAnywhereCacheCallable()

public final UnaryCallable<GetAnywhereCacheRequest,AnywhereCache> getAnywhereCacheCallable()

Gets an Anywhere Cache 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   GetAnywhereCacheRequest request =
       GetAnywhereCacheRequest.newBuilder()
           .setName(AnywhereCacheName.of("[PROJECT]", "[BUCKET]", "[ANYWHERE_CACHE]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<AnywhereCache> future =
       storageControlClient.getAnywhereCacheCallable().futureCall(request);
   // Do something.
   AnywhereCache response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetAnywhereCacheRequest,AnywhereCache>

getFolder(@Nullable FolderName name)

public final Folder getFolder(@Nullable FolderName name)

Returns metadata for the specified folder. This operation is only applicable to a hierarchical namespace enabled bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   FolderName name = FolderName.of("[PROJECT]", "[BUCKET]", "[FOLDER]");
   Folder response = storageControlClient.getFolder(name);
 }
 

Parameter
Name	Description
name	@org.jspecify.annotations.Nullable com.google.storage.control.v2.FolderName Required. Name of the folder. Format: projects/{project}/buckets/{bucket}/folders/{folder}

Returns
Type	Description
Folder

getFolder(GetFolderRequest request)

public final Folder getFolder(GetFolderRequest request)

Returns metadata for the specified folder. This operation is only applicable to a hierarchical namespace enabled bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   GetFolderRequest request =
       GetFolderRequest.newBuilder()
           .setName(FolderName.of("[PROJECT]", "[BUCKET]", "[FOLDER]").toString())
           .setIfMetagenerationMatch(1043427781)
           .setIfMetagenerationNotMatch(1025430873)
           .setRequestId("requestId693933066")
           .build();
   Folder response = storageControlClient.getFolder(request);
 }
 

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

Returns
Type	Description
Folder

getFolder(String name)

public final Folder getFolder(String name)

Returns metadata for the specified folder. This operation is only applicable to a hierarchical namespace enabled bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String name = FolderName.of("[PROJECT]", "[BUCKET]", "[FOLDER]").toString();
   Folder response = storageControlClient.getFolder(name);
 }
 

Parameter
Name	Description
name	String Required. Name of the folder. Format: projects/{project}/buckets/{bucket}/folders/{folder}

Returns
Type	Description
Folder

getFolderCallable()

public final UnaryCallable<GetFolderRequest,Folder> getFolderCallable()

Returns metadata for the specified folder. This operation is only applicable to a hierarchical namespace enabled bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   GetFolderRequest request =
       GetFolderRequest.newBuilder()
           .setName(FolderName.of("[PROJECT]", "[BUCKET]", "[FOLDER]").toString())
           .setIfMetagenerationMatch(1043427781)
           .setIfMetagenerationNotMatch(1025430873)
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Folder> future = storageControlClient.getFolderCallable().futureCall(request);
   // Do something.
   Folder response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetFolderRequest,Folder>

getFolderIntelligenceConfig(@Nullable IntelligenceConfigName name)

public final IntelligenceConfig getFolderIntelligenceConfig(@Nullable IntelligenceConfigName name)

Returns the Folder scoped singleton IntelligenceConfig 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   IntelligenceConfigName name =
       IntelligenceConfigName.ofFolderLocationName("[FOLDER]", "[LOCATION]");
   IntelligenceConfig response = storageControlClient.getFolderIntelligenceConfig(name);
 }
 

Parameter
Name	Description
name	@org.jspecify.annotations.Nullable com.google.storage.control.v2.IntelligenceConfigName Required. The name of the IntelligenceConfig resource associated with your folder. Format: folders/{id}/locations/global/intelligenceConfig

Returns
Type	Description
IntelligenceConfig

getFolderIntelligenceConfig(GetFolderIntelligenceConfigRequest request)

public final IntelligenceConfig getFolderIntelligenceConfig(GetFolderIntelligenceConfigRequest request)

Returns the Folder scoped singleton IntelligenceConfig 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   GetFolderIntelligenceConfigRequest request =
       GetFolderIntelligenceConfigRequest.newBuilder()
           .setName(
               IntelligenceConfigName.ofFolderLocationName("[FOLDER]", "[LOCATION]").toString())
           .build();
   IntelligenceConfig response = storageControlClient.getFolderIntelligenceConfig(request);
 }
 

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

Returns
Type	Description
IntelligenceConfig

getFolderIntelligenceConfig(String name)

public final IntelligenceConfig getFolderIntelligenceConfig(String name)

Returns the Folder scoped singleton IntelligenceConfig 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String name =
       IntelligenceConfigName.ofFolderLocationName("[FOLDER]", "[LOCATION]").toString();
   IntelligenceConfig response = storageControlClient.getFolderIntelligenceConfig(name);
 }
 

Parameter
Name	Description
name	String Required. The name of the IntelligenceConfig resource associated with your folder. Format: folders/{id}/locations/global/intelligenceConfig

Returns
Type	Description
IntelligenceConfig

getFolderIntelligenceConfigCallable()

public final UnaryCallable<GetFolderIntelligenceConfigRequest,IntelligenceConfig> getFolderIntelligenceConfigCallable()

Returns the Folder scoped singleton IntelligenceConfig 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   GetFolderIntelligenceConfigRequest request =
       GetFolderIntelligenceConfigRequest.newBuilder()
           .setName(
               IntelligenceConfigName.ofFolderLocationName("[FOLDER]", "[LOCATION]").toString())
           .build();
   ApiFuture<IntelligenceConfig> future =
       storageControlClient.getFolderIntelligenceConfigCallable().futureCall(request);
   // Do something.
   IntelligenceConfig response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetFolderIntelligenceConfigRequest,IntelligenceConfig>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

getIamPolicy(@Nullable ResourceName resource)

public final Policy getIamPolicy(@Nullable ResourceName resource)

Gets the IAM policy for a specified bucket. The resource field in the request should be projects//buckets/{bucket} for a bucket, or projects//buckets/{bucket}/managedFolders/{managedFolder} for a managed folder.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   ResourceName resource = LocationName.of("[PROJECT]", "[LOCATION]");
   Policy response = storageControlClient.getIamPolicy(resource);
 }
 

Parameter
Name	Description
resource	@org.jspecify.annotations.Nullable com.google.api.resourcenames.ResourceName REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

Returns
Type	Description
com.google.iam.v1.Policy

getIamPolicy(GetIamPolicyRequest request)

public final Policy getIamPolicy(GetIamPolicyRequest request)

Gets the IAM policy for a specified bucket. The resource field in the request should be projects//buckets/{bucket} for a bucket, or projects//buckets/{bucket}/managedFolders/{managedFolder} for a managed folder.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = storageControlClient.getIamPolicy(request);
 }
 

Parameter
Name	Description
request	com.google.iam.v1.GetIamPolicyRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
com.google.iam.v1.Policy

getIamPolicy(String resource)

public final Policy getIamPolicy(String resource)

Gets the IAM policy for a specified bucket. The resource field in the request should be projects//buckets/{bucket} for a bucket, or projects//buckets/{bucket}/managedFolders/{managedFolder} for a managed folder.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String resource = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Policy response = storageControlClient.getIamPolicy(resource);
 }
 

Parameter
Name	Description
resource	String REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

Returns
Type	Description
com.google.iam.v1.Policy

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()

Gets the IAM policy for a specified bucket. The resource field in the request should be projects//buckets/{bucket} for a bucket, or projects//buckets/{bucket}/managedFolders/{managedFolder} for a managed folder.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future = storageControlClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getIntelligenceFinding(@Nullable IntelligenceFindingName name)

public final IntelligenceFinding getIntelligenceFinding(@Nullable IntelligenceFindingName name)

Gets the IntelligenceFinding for a project.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   IntelligenceFindingName name =
       IntelligenceFindingName.of("[PROJECT]", "[LOCATION]", "[INTELLIGENCE_FINDING]");
   IntelligenceFinding response = storageControlClient.getIntelligenceFinding(name);
 }
 

Parameter
Name	Description
name	@org.jspecify.annotations.Nullable com.google.storage.control.v2.IntelligenceFindingName Required. The name of the IntelligenceFinding resource. Format: projects/{project}/locations/{location}/intelligenceFindings/{intelligence_finding}

Returns
Type	Description
IntelligenceFinding

getIntelligenceFinding(GetIntelligenceFindingRequest request)

public final IntelligenceFinding getIntelligenceFinding(GetIntelligenceFindingRequest request)

Gets the IntelligenceFinding for a project.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   GetIntelligenceFindingRequest request =
       GetIntelligenceFindingRequest.newBuilder()
           .setName(
               IntelligenceFindingName.of("[PROJECT]", "[LOCATION]", "[INTELLIGENCE_FINDING]")
                   .toString())
           .build();
   IntelligenceFinding response = storageControlClient.getIntelligenceFinding(request);
 }
 

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

Returns
Type	Description
IntelligenceFinding

getIntelligenceFinding(String name)

public final IntelligenceFinding getIntelligenceFinding(String name)

Gets the IntelligenceFinding for a project.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String name =
       IntelligenceFindingName.of("[PROJECT]", "[LOCATION]", "[INTELLIGENCE_FINDING]")
           .toString();
   IntelligenceFinding response = storageControlClient.getIntelligenceFinding(name);
 }
 

Parameter
Name	Description
name	String Required. The name of the IntelligenceFinding resource. Format: projects/{project}/locations/{location}/intelligenceFindings/{intelligence_finding}

Returns
Type	Description
IntelligenceFinding

getIntelligenceFindingCallable()

public final UnaryCallable<GetIntelligenceFindingRequest,IntelligenceFinding> getIntelligenceFindingCallable()

Gets the IntelligenceFinding for a project.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   GetIntelligenceFindingRequest request =
       GetIntelligenceFindingRequest.newBuilder()
           .setName(
               IntelligenceFindingName.of("[PROJECT]", "[LOCATION]", "[INTELLIGENCE_FINDING]")
                   .toString())
           .build();
   ApiFuture<IntelligenceFinding> future =
       storageControlClient.getIntelligenceFindingCallable().futureCall(request);
   // Do something.
   IntelligenceFinding response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetIntelligenceFindingRequest,IntelligenceFinding>

getIntelligenceFindingRevision(@Nullable IntelligenceFindingRevisionName name)

public final IntelligenceFindingRevision getIntelligenceFindingRevision(@Nullable IntelligenceFindingRevisionName name)

Gets the IntelligenceFindingRevision 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   IntelligenceFindingRevisionName name =
       IntelligenceFindingRevisionName.of(
           "[PROJECT]", "[LOCATION]", "[INTELLIGENCE_FINDING]", "[REVISION]");
   IntelligenceFindingRevision response =
       storageControlClient.getIntelligenceFindingRevision(name);
 }
 

Parameter
Name	Description
name	@org.jspecify.annotations.Nullable com.google.storage.control.v2.IntelligenceFindingRevisionName Required. The name of the IntelligenceFindingRevision resource. ## Format: projects/{project}/locations/{location}/intelligenceFindings/{intelligence_finding}/revisions/{revision}

Returns
Type	Description
IntelligenceFindingRevision

getIntelligenceFindingRevision(GetIntelligenceFindingRevisionRequest request)

public final IntelligenceFindingRevision getIntelligenceFindingRevision(GetIntelligenceFindingRevisionRequest request)

Gets the IntelligenceFindingRevision 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   GetIntelligenceFindingRevisionRequest request =
       GetIntelligenceFindingRevisionRequest.newBuilder()
           .setName(
               IntelligenceFindingRevisionName.of(
                       "[PROJECT]", "[LOCATION]", "[INTELLIGENCE_FINDING]", "[REVISION]")
                   .toString())
           .build();
   IntelligenceFindingRevision response =
       storageControlClient.getIntelligenceFindingRevision(request);
 }
 

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

Returns
Type	Description
IntelligenceFindingRevision

getIntelligenceFindingRevision(String name)

public final IntelligenceFindingRevision getIntelligenceFindingRevision(String name)

Gets the IntelligenceFindingRevision 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String name =
       IntelligenceFindingRevisionName.of(
               "[PROJECT]", "[LOCATION]", "[INTELLIGENCE_FINDING]", "[REVISION]")
           .toString();
   IntelligenceFindingRevision response =
       storageControlClient.getIntelligenceFindingRevision(name);
 }
 

Parameter
Name	Description
name	String Required. The name of the IntelligenceFindingRevision resource. ## Format: projects/{project}/locations/{location}/intelligenceFindings/{intelligence_finding}/revisions/{revision}

Returns
Type	Description
IntelligenceFindingRevision

getIntelligenceFindingRevisionCallable()

public final UnaryCallable<GetIntelligenceFindingRevisionRequest,IntelligenceFindingRevision> getIntelligenceFindingRevisionCallable()

Gets the IntelligenceFindingRevision 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   GetIntelligenceFindingRevisionRequest request =
       GetIntelligenceFindingRevisionRequest.newBuilder()
           .setName(
               IntelligenceFindingRevisionName.of(
                       "[PROJECT]", "[LOCATION]", "[INTELLIGENCE_FINDING]", "[REVISION]")
                   .toString())
           .build();
   ApiFuture<IntelligenceFindingRevision> future =
       storageControlClient.getIntelligenceFindingRevisionCallable().futureCall(request);
   // Do something.
   IntelligenceFindingRevision response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetIntelligenceFindingRevisionRequest,IntelligenceFindingRevision>

getManagedFolder(@Nullable ManagedFolderName name)

public final ManagedFolder getManagedFolder(@Nullable ManagedFolderName name)

Returns metadata for the specified managed folder.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   ManagedFolderName name = ManagedFolderName.of("[PROJECT]", "[BUCKET]", "[MANAGED_FOLDER]");
   ManagedFolder response = storageControlClient.getManagedFolder(name);
 }
 

Parameter
Name	Description
name	@org.jspecify.annotations.Nullable com.google.storage.control.v2.ManagedFolderName Required. Name of the managed folder. Format: projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}

Returns
Type	Description
ManagedFolder

getManagedFolder(GetManagedFolderRequest request)

public final ManagedFolder getManagedFolder(GetManagedFolderRequest request)

Returns metadata for the specified managed folder.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   GetManagedFolderRequest request =
       GetManagedFolderRequest.newBuilder()
           .setName(ManagedFolderName.of("[PROJECT]", "[BUCKET]", "[MANAGED_FOLDER]").toString())
           .setIfMetagenerationMatch(1043427781)
           .setIfMetagenerationNotMatch(1025430873)
           .setRequestId("requestId693933066")
           .build();
   ManagedFolder response = storageControlClient.getManagedFolder(request);
 }
 

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

Returns
Type	Description
ManagedFolder

getManagedFolder(String name)

public final ManagedFolder getManagedFolder(String name)

Returns metadata for the specified managed folder.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String name = ManagedFolderName.of("[PROJECT]", "[BUCKET]", "[MANAGED_FOLDER]").toString();
   ManagedFolder response = storageControlClient.getManagedFolder(name);
 }
 

Parameter
Name	Description
name	String Required. Name of the managed folder. Format: projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}

Returns
Type	Description
ManagedFolder

getManagedFolderCallable()

public final UnaryCallable<GetManagedFolderRequest,ManagedFolder> getManagedFolderCallable()

Returns metadata for the specified managed folder.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   GetManagedFolderRequest request =
       GetManagedFolderRequest.newBuilder()
           .setName(ManagedFolderName.of("[PROJECT]", "[BUCKET]", "[MANAGED_FOLDER]").toString())
           .setIfMetagenerationMatch(1043427781)
           .setIfMetagenerationNotMatch(1025430873)
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<ManagedFolder> future =
       storageControlClient.getManagedFolderCallable().futureCall(request);
   // Do something.
   ManagedFolder response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetManagedFolderRequest,ManagedFolder>

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

getOrganizationIntelligenceConfig(@Nullable IntelligenceConfigName name)

public final IntelligenceConfig getOrganizationIntelligenceConfig(@Nullable IntelligenceConfigName name)

Returns the Organization scoped singleton IntelligenceConfig 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   IntelligenceConfigName name = IntelligenceConfigName.ofOrgLocationName("[ORG]", "[LOCATION]");
   IntelligenceConfig response = storageControlClient.getOrganizationIntelligenceConfig(name);
 }
 

Parameter
Name	Description
name	@org.jspecify.annotations.Nullable com.google.storage.control.v2.IntelligenceConfigName Required. The name of the IntelligenceConfig resource associated with your organization. Format: organizations/{org_id}/locations/global/intelligenceConfig

Returns
Type	Description
IntelligenceConfig

getOrganizationIntelligenceConfig(GetOrganizationIntelligenceConfigRequest request)

public final IntelligenceConfig getOrganizationIntelligenceConfig(GetOrganizationIntelligenceConfigRequest request)

Returns the Organization scoped singleton IntelligenceConfig 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   GetOrganizationIntelligenceConfigRequest request =
       GetOrganizationIntelligenceConfigRequest.newBuilder()
           .setName(IntelligenceConfigName.ofOrgLocationName("[ORG]", "[LOCATION]").toString())
           .build();
   IntelligenceConfig response = storageControlClient.getOrganizationIntelligenceConfig(request);
 }
 

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

Returns
Type	Description
IntelligenceConfig

getOrganizationIntelligenceConfig(String name)

public final IntelligenceConfig getOrganizationIntelligenceConfig(String name)

Returns the Organization scoped singleton IntelligenceConfig 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String name =
       IntelligenceConfigName.ofFolderLocationName("[FOLDER]", "[LOCATION]").toString();
   IntelligenceConfig response = storageControlClient.getOrganizationIntelligenceConfig(name);
 }
 

Parameter
Name	Description
name	String Required. The name of the IntelligenceConfig resource associated with your organization. Format: organizations/{org_id}/locations/global/intelligenceConfig

Returns
Type	Description
IntelligenceConfig

getOrganizationIntelligenceConfigCallable()

public final UnaryCallable<GetOrganizationIntelligenceConfigRequest,IntelligenceConfig> getOrganizationIntelligenceConfigCallable()

Returns the Organization scoped singleton IntelligenceConfig 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   GetOrganizationIntelligenceConfigRequest request =
       GetOrganizationIntelligenceConfigRequest.newBuilder()
           .setName(IntelligenceConfigName.ofOrgLocationName("[ORG]", "[LOCATION]").toString())
           .build();
   ApiFuture<IntelligenceConfig> future =
       storageControlClient.getOrganizationIntelligenceConfigCallable().futureCall(request);
   // Do something.
   IntelligenceConfig response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetOrganizationIntelligenceConfigRequest,IntelligenceConfig>

getProjectIntelligenceConfig(@Nullable IntelligenceConfigName name)

public final IntelligenceConfig getProjectIntelligenceConfig(@Nullable IntelligenceConfigName name)

Returns the Project scoped singleton IntelligenceConfig 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   IntelligenceConfigName name =
       IntelligenceConfigName.ofProjectLocationName("[PROJECT]", "[LOCATION]");
   IntelligenceConfig response = storageControlClient.getProjectIntelligenceConfig(name);
 }
 

Parameter
Name	Description
name	@org.jspecify.annotations.Nullable com.google.storage.control.v2.IntelligenceConfigName Required. The name of the IntelligenceConfig resource associated with your project. Format: projects/{id}/locations/global/intelligenceConfig

Returns
Type	Description
IntelligenceConfig

getProjectIntelligenceConfig(GetProjectIntelligenceConfigRequest request)

public final IntelligenceConfig getProjectIntelligenceConfig(GetProjectIntelligenceConfigRequest request)

Returns the Project scoped singleton IntelligenceConfig 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   GetProjectIntelligenceConfigRequest request =
       GetProjectIntelligenceConfigRequest.newBuilder()
           .setName(
               IntelligenceConfigName.ofProjectLocationName("[PROJECT]", "[LOCATION]")
                   .toString())
           .build();
   IntelligenceConfig response = storageControlClient.getProjectIntelligenceConfig(request);
 }
 

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

Returns
Type	Description
IntelligenceConfig

getProjectIntelligenceConfig(String name)

public final IntelligenceConfig getProjectIntelligenceConfig(String name)

Returns the Project scoped singleton IntelligenceConfig 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String name =
       IntelligenceConfigName.ofFolderLocationName("[FOLDER]", "[LOCATION]").toString();
   IntelligenceConfig response = storageControlClient.getProjectIntelligenceConfig(name);
 }
 

Parameter
Name	Description
name	String Required. The name of the IntelligenceConfig resource associated with your project. Format: projects/{id}/locations/global/intelligenceConfig

Returns
Type	Description
IntelligenceConfig

getProjectIntelligenceConfigCallable()

public final UnaryCallable<GetProjectIntelligenceConfigRequest,IntelligenceConfig> getProjectIntelligenceConfigCallable()

Returns the Project scoped singleton IntelligenceConfig 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   GetProjectIntelligenceConfigRequest request =
       GetProjectIntelligenceConfigRequest.newBuilder()
           .setName(
               IntelligenceConfigName.ofProjectLocationName("[PROJECT]", "[LOCATION]")
                   .toString())
           .build();
   ApiFuture<IntelligenceConfig> future =
       storageControlClient.getProjectIntelligenceConfigCallable().futureCall(request);
   // Do something.
   IntelligenceConfig response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetProjectIntelligenceConfigRequest,IntelligenceConfig>

getRapidCache(@Nullable RapidCacheName name)

public final RapidCache getRapidCache(@Nullable RapidCacheName name)

Gets a Rapid Cache 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   RapidCacheName name = RapidCacheName.of("[PROJECT]", "[BUCKET]", "[RAPID_CACHE]");
   RapidCache response = storageControlClient.getRapidCache(name);
 }
 

Parameter
Name	Description
name	@org.jspecify.annotations.Nullable com.google.storage.control.v2.RapidCacheName Required. The name field in the request should be: projects/{project}/buckets/{bucket}/rapidCaches/{rapid_cache}

Returns
Type	Description
RapidCache

getRapidCache(GetRapidCacheRequest request)

public final RapidCache getRapidCache(GetRapidCacheRequest request)

Gets a Rapid Cache 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   GetRapidCacheRequest request =
       GetRapidCacheRequest.newBuilder()
           .setName(RapidCacheName.of("[PROJECT]", "[BUCKET]", "[RAPID_CACHE]").toString())
           .setRequestId("requestId693933066")
           .build();
   RapidCache response = storageControlClient.getRapidCache(request);
 }
 

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

Returns
Type	Description
RapidCache

getRapidCache(String name)

public final RapidCache getRapidCache(String name)

Gets a Rapid Cache 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String name = RapidCacheName.of("[PROJECT]", "[BUCKET]", "[RAPID_CACHE]").toString();
   RapidCache response = storageControlClient.getRapidCache(name);
 }
 

Parameter
Name	Description
name	String Required. The name field in the request should be: projects/{project}/buckets/{bucket}/rapidCaches/{rapid_cache}

Returns
Type	Description
RapidCache

getRapidCacheCallable()

public final UnaryCallable<GetRapidCacheRequest,RapidCache> getRapidCacheCallable()

Gets a Rapid Cache 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   GetRapidCacheRequest request =
       GetRapidCacheRequest.newBuilder()
           .setName(RapidCacheName.of("[PROJECT]", "[BUCKET]", "[RAPID_CACHE]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<RapidCache> future =
       storageControlClient.getRapidCacheCallable().futureCall(request);
   // Do something.
   RapidCache response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetRapidCacheRequest,RapidCache>

getSettings()

public final @Nullable StorageControlSettings getSettings()

Returns
Type	Description
@org.jspecify.annotations.Nullable com.google.storage.control.v2.StorageControlSettings

getStorageLayout(@Nullable StorageLayoutName name)

public final StorageLayout getStorageLayout(@Nullable StorageLayoutName name)

Returns the storage layout configuration for a given bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   StorageLayoutName name = StorageLayoutName.of("[PROJECT]", "[BUCKET]");
   StorageLayout response = storageControlClient.getStorageLayout(name);
 }
 

Parameter
Name	Description
name	@org.jspecify.annotations.Nullable com.google.storage.control.v2.StorageLayoutName Required. The name of the StorageLayout resource. Format: projects/{project}/buckets/{bucket}/storageLayout

Returns
Type	Description
StorageLayout

getStorageLayout(GetStorageLayoutRequest request)

public final StorageLayout getStorageLayout(GetStorageLayoutRequest request)

Returns the storage layout configuration for a given bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   GetStorageLayoutRequest request =
       GetStorageLayoutRequest.newBuilder()
           .setName(StorageLayoutName.of("[PROJECT]", "[BUCKET]").toString())
           .setPrefix("prefix-980110702")
           .setRequestId("requestId693933066")
           .build();
   StorageLayout response = storageControlClient.getStorageLayout(request);
 }
 

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

Returns
Type	Description
StorageLayout

getStorageLayout(String name)

public final StorageLayout getStorageLayout(String name)

Returns the storage layout configuration for a given bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String name = StorageLayoutName.of("[PROJECT]", "[BUCKET]").toString();
   StorageLayout response = storageControlClient.getStorageLayout(name);
 }
 

Parameter
Name	Description
name	String Required. The name of the StorageLayout resource. Format: projects/{project}/buckets/{bucket}/storageLayout

Returns
Type	Description
StorageLayout

getStorageLayoutCallable()

public final UnaryCallable<GetStorageLayoutRequest,StorageLayout> getStorageLayoutCallable()

Returns the storage layout configuration for a given bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   GetStorageLayoutRequest request =
       GetStorageLayoutRequest.newBuilder()
           .setName(StorageLayoutName.of("[PROJECT]", "[BUCKET]").toString())
           .setPrefix("prefix-980110702")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<StorageLayout> future =
       storageControlClient.getStorageLayoutCallable().futureCall(request);
   // Do something.
   StorageLayout response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetStorageLayoutRequest,StorageLayout>

getStub()

public StorageControlStub getStub()

Returns
Type	Description
StorageControlStub

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

listAnywhereCaches(@Nullable BucketName parent)

public final StorageControlClient.ListAnywhereCachesPagedResponse listAnywhereCaches(@Nullable BucketName parent)

Lists Anywhere Cache instances for a given bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   BucketName parent = BucketName.of("[PROJECT]", "[BUCKET]");
   for (AnywhereCache element : storageControlClient.listAnywhereCaches(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	@org.jspecify.annotations.Nullable com.google.storage.control.v2.BucketName Required. The bucket to which this cache belongs.

Returns
Type	Description
StorageControlClient.ListAnywhereCachesPagedResponse

listAnywhereCaches(ListAnywhereCachesRequest request)

public final StorageControlClient.ListAnywhereCachesPagedResponse listAnywhereCaches(ListAnywhereCachesRequest request)

Lists Anywhere Cache instances for a given bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   ListAnywhereCachesRequest request =
       ListAnywhereCachesRequest.newBuilder()
           .setParent(BucketName.of("[PROJECT]", "[BUCKET]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setRequestId("requestId693933066")
           .build();
   for (AnywhereCache element : storageControlClient.listAnywhereCaches(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

Returns
Type	Description
StorageControlClient.ListAnywhereCachesPagedResponse

listAnywhereCaches(String parent)

public final StorageControlClient.ListAnywhereCachesPagedResponse listAnywhereCaches(String parent)

Lists Anywhere Cache instances for a given bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String parent = BucketName.of("[PROJECT]", "[BUCKET]").toString();
   for (AnywhereCache element : storageControlClient.listAnywhereCaches(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	String Required. The bucket to which this cache belongs.

Returns
Type	Description
StorageControlClient.ListAnywhereCachesPagedResponse

listAnywhereCachesCallable()

public final UnaryCallable<ListAnywhereCachesRequest,ListAnywhereCachesResponse> listAnywhereCachesCallable()

Lists Anywhere Cache instances for a given bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   ListAnywhereCachesRequest request =
       ListAnywhereCachesRequest.newBuilder()
           .setParent(BucketName.of("[PROJECT]", "[BUCKET]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setRequestId("requestId693933066")
           .build();
   while (true) {
     ListAnywhereCachesResponse response =
         storageControlClient.listAnywhereCachesCallable().call(request);
     for (AnywhereCache element : response.getAnywhereCachesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<ListAnywhereCachesRequest,ListAnywhereCachesResponse>

listAnywhereCachesPagedCallable()

public final UnaryCallable<ListAnywhereCachesRequest,StorageControlClient.ListAnywhereCachesPagedResponse> listAnywhereCachesPagedCallable()

Lists Anywhere Cache instances for a given bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   ListAnywhereCachesRequest request =
       ListAnywhereCachesRequest.newBuilder()
           .setParent(BucketName.of("[PROJECT]", "[BUCKET]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<AnywhereCache> future =
       storageControlClient.listAnywhereCachesPagedCallable().futureCall(request);
   // Do something.
   for (AnywhereCache element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<ListAnywhereCachesRequest,ListAnywhereCachesPagedResponse>

listFolders(@Nullable BucketName parent)

public final StorageControlClient.ListFoldersPagedResponse listFolders(@Nullable BucketName parent)

Retrieves a list of folders. This operation is only applicable to a hierarchical namespace enabled bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   BucketName parent = BucketName.of("[PROJECT]", "[BUCKET]");
   for (Folder element : storageControlClient.listFolders(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	@org.jspecify.annotations.Nullable com.google.storage.control.v2.BucketName Required. Name of the bucket in which to look for folders. The bucket must be a hierarchical namespace enabled bucket.

Returns
Type	Description
StorageControlClient.ListFoldersPagedResponse

listFolders(ListFoldersRequest request)

public final StorageControlClient.ListFoldersPagedResponse listFolders(ListFoldersRequest request)

Retrieves a list of folders. This operation is only applicable to a hierarchical namespace enabled bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   ListFoldersRequest request =
       ListFoldersRequest.newBuilder()
           .setParent(BucketName.of("[PROJECT]", "[BUCKET]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setPrefix("prefix-980110702")
           .setDelimiter("delimiter-250518009")
           .setLexicographicStart("lexicographicStart-2093413008")
           .setLexicographicEnd("lexicographicEnd1646968169")
           .setRequestId("requestId693933066")
           .build();
   for (Folder element : storageControlClient.listFolders(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

Returns
Type	Description
StorageControlClient.ListFoldersPagedResponse

listFolders(String parent)

public final StorageControlClient.ListFoldersPagedResponse listFolders(String parent)

Retrieves a list of folders. This operation is only applicable to a hierarchical namespace enabled bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String parent = BucketName.of("[PROJECT]", "[BUCKET]").toString();
   for (Folder element : storageControlClient.listFolders(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	String Required. Name of the bucket in which to look for folders. The bucket must be a hierarchical namespace enabled bucket.

Returns
Type	Description
StorageControlClient.ListFoldersPagedResponse

listFoldersCallable()

public final UnaryCallable<ListFoldersRequest,ListFoldersResponse> listFoldersCallable()

Retrieves a list of folders. This operation is only applicable to a hierarchical namespace enabled bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   ListFoldersRequest request =
       ListFoldersRequest.newBuilder()
           .setParent(BucketName.of("[PROJECT]", "[BUCKET]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setPrefix("prefix-980110702")
           .setDelimiter("delimiter-250518009")
           .setLexicographicStart("lexicographicStart-2093413008")
           .setLexicographicEnd("lexicographicEnd1646968169")
           .setRequestId("requestId693933066")
           .build();
   while (true) {
     ListFoldersResponse response = storageControlClient.listFoldersCallable().call(request);
     for (Folder element : response.getFoldersList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<ListFoldersRequest,ListFoldersResponse>

listFoldersPagedCallable()

public final UnaryCallable<ListFoldersRequest,StorageControlClient.ListFoldersPagedResponse> listFoldersPagedCallable()

Retrieves a list of folders. This operation is only applicable to a hierarchical namespace enabled bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   ListFoldersRequest request =
       ListFoldersRequest.newBuilder()
           .setParent(BucketName.of("[PROJECT]", "[BUCKET]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setPrefix("prefix-980110702")
           .setDelimiter("delimiter-250518009")
           .setLexicographicStart("lexicographicStart-2093413008")
           .setLexicographicEnd("lexicographicEnd1646968169")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Folder> future =
       storageControlClient.listFoldersPagedCallable().futureCall(request);
   // Do something.
   for (Folder element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<ListFoldersRequest,ListFoldersPagedResponse>

listIntelligenceFindingRevisions(@Nullable IntelligenceFindingName parent)

public final StorageControlClient.ListIntelligenceFindingRevisionsPagedResponse listIntelligenceFindingRevisions(@Nullable IntelligenceFindingName parent)

Lists all the revisions of an IntelligenceFinding 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   IntelligenceFindingName parent =
       IntelligenceFindingName.of("[PROJECT]", "[LOCATION]", "[INTELLIGENCE_FINDING]");
   for (IntelligenceFindingRevision element :
       storageControlClient.listIntelligenceFindingRevisions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	@org.jspecify.annotations.Nullable com.google.storage.control.v2.IntelligenceFindingName Required. The parent of the IntelligenceFindingRevision resource. ## Format: projects/{project}/locations/{location}/intelligenceFindings/{intelligence_finding}

Returns
Type	Description
StorageControlClient.ListIntelligenceFindingRevisionsPagedResponse

listIntelligenceFindingRevisions(ListIntelligenceFindingRevisionsRequest request)

public final StorageControlClient.ListIntelligenceFindingRevisionsPagedResponse listIntelligenceFindingRevisions(ListIntelligenceFindingRevisionsRequest request)

Lists all the revisions of an IntelligenceFinding 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   ListIntelligenceFindingRevisionsRequest request =
       ListIntelligenceFindingRevisionsRequest.newBuilder()
           .setParent(
               IntelligenceFindingName.of("[PROJECT]", "[LOCATION]", "[INTELLIGENCE_FINDING]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (IntelligenceFindingRevision element :
       storageControlClient.listIntelligenceFindingRevisions(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

Returns
Type	Description
StorageControlClient.ListIntelligenceFindingRevisionsPagedResponse

listIntelligenceFindingRevisions(String parent)

public final StorageControlClient.ListIntelligenceFindingRevisionsPagedResponse listIntelligenceFindingRevisions(String parent)

Lists all the revisions of an IntelligenceFinding 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String parent =
       IntelligenceFindingName.of("[PROJECT]", "[LOCATION]", "[INTELLIGENCE_FINDING]")
           .toString();
   for (IntelligenceFindingRevision element :
       storageControlClient.listIntelligenceFindingRevisions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	String Required. The parent of the IntelligenceFindingRevision resource. ## Format: projects/{project}/locations/{location}/intelligenceFindings/{intelligence_finding}

Returns
Type	Description
StorageControlClient.ListIntelligenceFindingRevisionsPagedResponse

listIntelligenceFindingRevisionsCallable()

public final UnaryCallable<ListIntelligenceFindingRevisionsRequest,ListIntelligenceFindingRevisionsResponse> listIntelligenceFindingRevisionsCallable()

Lists all the revisions of an IntelligenceFinding 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   ListIntelligenceFindingRevisionsRequest request =
       ListIntelligenceFindingRevisionsRequest.newBuilder()
           .setParent(
               IntelligenceFindingName.of("[PROJECT]", "[LOCATION]", "[INTELLIGENCE_FINDING]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListIntelligenceFindingRevisionsResponse response =
         storageControlClient.listIntelligenceFindingRevisionsCallable().call(request);
     for (IntelligenceFindingRevision element : response.getIntelligenceFindingRevisionsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<ListIntelligenceFindingRevisionsRequest,ListIntelligenceFindingRevisionsResponse>

listIntelligenceFindingRevisionsPagedCallable()

public final UnaryCallable<ListIntelligenceFindingRevisionsRequest,StorageControlClient.ListIntelligenceFindingRevisionsPagedResponse> listIntelligenceFindingRevisionsPagedCallable()

Lists all the revisions of an IntelligenceFinding 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   ListIntelligenceFindingRevisionsRequest request =
       ListIntelligenceFindingRevisionsRequest.newBuilder()
           .setParent(
               IntelligenceFindingName.of("[PROJECT]", "[LOCATION]", "[INTELLIGENCE_FINDING]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<IntelligenceFindingRevision> future =
       storageControlClient.listIntelligenceFindingRevisionsPagedCallable().futureCall(request);
   // Do something.
   for (IntelligenceFindingRevision element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<ListIntelligenceFindingRevisionsRequest,ListIntelligenceFindingRevisionsPagedResponse>

listIntelligenceFindings(@Nullable LocationName parent)

public final StorageControlClient.ListIntelligenceFindingsPagedResponse listIntelligenceFindings(@Nullable LocationName parent)

Lists the IntelligenceFinding resources for the specified the project.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (IntelligenceFinding element :
       storageControlClient.listIntelligenceFindings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	@org.jspecify.annotations.Nullable com.google.storage.control.v2.LocationName Required. The parent of the IntelligenceFinding resource. Format: projects/{project}/locations/{location}

Returns
Type	Description
StorageControlClient.ListIntelligenceFindingsPagedResponse

listIntelligenceFindings(ListIntelligenceFindingsRequest request)

public final StorageControlClient.ListIntelligenceFindingsPagedResponse listIntelligenceFindings(ListIntelligenceFindingsRequest request)

Lists the IntelligenceFinding resources for the specified the project.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   ListIntelligenceFindingsRequest request =
       ListIntelligenceFindingsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (IntelligenceFinding element :
       storageControlClient.listIntelligenceFindings(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

Returns
Type	Description
StorageControlClient.ListIntelligenceFindingsPagedResponse

listIntelligenceFindings(String parent)

public final StorageControlClient.ListIntelligenceFindingsPagedResponse listIntelligenceFindings(String parent)

Lists the IntelligenceFinding resources for the specified the project.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (IntelligenceFinding element :
       storageControlClient.listIntelligenceFindings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	String Required. The parent of the IntelligenceFinding resource. Format: projects/{project}/locations/{location}

Returns
Type	Description
StorageControlClient.ListIntelligenceFindingsPagedResponse

listIntelligenceFindingsCallable()

public final UnaryCallable<ListIntelligenceFindingsRequest,ListIntelligenceFindingsResponse> listIntelligenceFindingsCallable()

Lists the IntelligenceFinding resources for the specified the project.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   ListIntelligenceFindingsRequest request =
       ListIntelligenceFindingsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListIntelligenceFindingsResponse response =
         storageControlClient.listIntelligenceFindingsCallable().call(request);
     for (IntelligenceFinding element : response.getIntelligenceFindingsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<ListIntelligenceFindingsRequest,ListIntelligenceFindingsResponse>

listIntelligenceFindingsPagedCallable()

public final UnaryCallable<ListIntelligenceFindingsRequest,StorageControlClient.ListIntelligenceFindingsPagedResponse> listIntelligenceFindingsPagedCallable()

Lists the IntelligenceFinding resources for the specified the project.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   ListIntelligenceFindingsRequest request =
       ListIntelligenceFindingsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<IntelligenceFinding> future =
       storageControlClient.listIntelligenceFindingsPagedCallable().futureCall(request);
   // Do something.
   for (IntelligenceFinding element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<ListIntelligenceFindingsRequest,ListIntelligenceFindingsPagedResponse>

listManagedFolders(@Nullable BucketName parent)

public final StorageControlClient.ListManagedFoldersPagedResponse listManagedFolders(@Nullable BucketName parent)

Retrieves a list of managed folders for a given bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   BucketName parent = BucketName.of("[PROJECT]", "[BUCKET]");
   for (ManagedFolder element : storageControlClient.listManagedFolders(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	@org.jspecify.annotations.Nullable com.google.storage.control.v2.BucketName Required. Name of the bucket this managed folder belongs to.

Returns
Type	Description
StorageControlClient.ListManagedFoldersPagedResponse

listManagedFolders(ListManagedFoldersRequest request)

public final StorageControlClient.ListManagedFoldersPagedResponse listManagedFolders(ListManagedFoldersRequest request)

Retrieves a list of managed folders for a given bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   ListManagedFoldersRequest request =
       ListManagedFoldersRequest.newBuilder()
           .setParent(BucketName.of("[PROJECT]", "[BUCKET]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setPrefix("prefix-980110702")
           .setRequestId("requestId693933066")
           .build();
   for (ManagedFolder element : storageControlClient.listManagedFolders(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

Returns
Type	Description
StorageControlClient.ListManagedFoldersPagedResponse

listManagedFolders(String parent)

public final StorageControlClient.ListManagedFoldersPagedResponse listManagedFolders(String parent)

Retrieves a list of managed folders for a given bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String parent = BucketName.of("[PROJECT]", "[BUCKET]").toString();
   for (ManagedFolder element : storageControlClient.listManagedFolders(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	String Required. Name of the bucket this managed folder belongs to.

Returns
Type	Description
StorageControlClient.ListManagedFoldersPagedResponse

listManagedFoldersCallable()

public final UnaryCallable<ListManagedFoldersRequest,ListManagedFoldersResponse> listManagedFoldersCallable()

Retrieves a list of managed folders for a given bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   ListManagedFoldersRequest request =
       ListManagedFoldersRequest.newBuilder()
           .setParent(BucketName.of("[PROJECT]", "[BUCKET]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setPrefix("prefix-980110702")
           .setRequestId("requestId693933066")
           .build();
   while (true) {
     ListManagedFoldersResponse response =
         storageControlClient.listManagedFoldersCallable().call(request);
     for (ManagedFolder element : response.getManagedFoldersList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<ListManagedFoldersRequest,ListManagedFoldersResponse>

listManagedFoldersPagedCallable()

public final UnaryCallable<ListManagedFoldersRequest,StorageControlClient.ListManagedFoldersPagedResponse> listManagedFoldersPagedCallable()

Retrieves a list of managed folders for a given bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   ListManagedFoldersRequest request =
       ListManagedFoldersRequest.newBuilder()
           .setParent(BucketName.of("[PROJECT]", "[BUCKET]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setPrefix("prefix-980110702")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<ManagedFolder> future =
       storageControlClient.listManagedFoldersPagedCallable().futureCall(request);
   // Do something.
   for (ManagedFolder element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<ListManagedFoldersRequest,ListManagedFoldersPagedResponse>

listRapidCaches(@Nullable BucketName parent)

public final StorageControlClient.ListRapidCachesPagedResponse listRapidCaches(@Nullable BucketName parent)

Lists Rapid Cache instances for a given bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   BucketName parent = BucketName.of("[PROJECT]", "[BUCKET]");
   for (RapidCache element : storageControlClient.listRapidCaches(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	@org.jspecify.annotations.Nullable com.google.storage.control.v2.BucketName Required. The bucket to which this cache belongs.

Returns
Type	Description
StorageControlClient.ListRapidCachesPagedResponse

listRapidCaches(ListRapidCachesRequest request)

public final StorageControlClient.ListRapidCachesPagedResponse listRapidCaches(ListRapidCachesRequest request)

Lists Rapid Cache instances for a given bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   ListRapidCachesRequest request =
       ListRapidCachesRequest.newBuilder()
           .setParent(BucketName.of("[PROJECT]", "[BUCKET]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setRequestId("requestId693933066")
           .build();
   for (RapidCache element : storageControlClient.listRapidCaches(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

Returns
Type	Description
StorageControlClient.ListRapidCachesPagedResponse

listRapidCaches(String parent)

public final StorageControlClient.ListRapidCachesPagedResponse listRapidCaches(String parent)

Lists Rapid Cache instances for a given bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String parent = BucketName.of("[PROJECT]", "[BUCKET]").toString();
   for (RapidCache element : storageControlClient.listRapidCaches(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	String Required. The bucket to which this cache belongs.

Returns
Type	Description
StorageControlClient.ListRapidCachesPagedResponse

listRapidCachesCallable()

public final UnaryCallable<ListRapidCachesRequest,ListRapidCachesResponse> listRapidCachesCallable()

Lists Rapid Cache instances for a given bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   ListRapidCachesRequest request =
       ListRapidCachesRequest.newBuilder()
           .setParent(BucketName.of("[PROJECT]", "[BUCKET]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setRequestId("requestId693933066")
           .build();
   while (true) {
     ListRapidCachesResponse response =
         storageControlClient.listRapidCachesCallable().call(request);
     for (RapidCache element : response.getRapidCachesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<ListRapidCachesRequest,ListRapidCachesResponse>

listRapidCachesPagedCallable()

public final UnaryCallable<ListRapidCachesRequest,StorageControlClient.ListRapidCachesPagedResponse> listRapidCachesPagedCallable()

Lists Rapid Cache instances for a given bucket.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   ListRapidCachesRequest request =
       ListRapidCachesRequest.newBuilder()
           .setParent(BucketName.of("[PROJECT]", "[BUCKET]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<RapidCache> future =
       storageControlClient.listRapidCachesPagedCallable().futureCall(request);
   // Do something.
   for (RapidCache element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<ListRapidCachesRequest,ListRapidCachesPagedResponse>

pauseAnywhereCache(@Nullable AnywhereCacheName name)

public final AnywhereCache pauseAnywhereCache(@Nullable AnywhereCacheName name)

Pauses an Anywhere Cache 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   AnywhereCacheName name = AnywhereCacheName.of("[PROJECT]", "[BUCKET]", "[ANYWHERE_CACHE]");
   AnywhereCache response = storageControlClient.pauseAnywhereCache(name);
 }
 

Parameter
Name	Description
name	@org.jspecify.annotations.Nullable com.google.storage.control.v2.AnywhereCacheName Required. The name field in the request should be: projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}

Returns
Type	Description
AnywhereCache

pauseAnywhereCache(PauseAnywhereCacheRequest request)

public final AnywhereCache pauseAnywhereCache(PauseAnywhereCacheRequest request)

Pauses an Anywhere Cache 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   PauseAnywhereCacheRequest request =
       PauseAnywhereCacheRequest.newBuilder()
           .setName(AnywhereCacheName.of("[PROJECT]", "[BUCKET]", "[ANYWHERE_CACHE]").toString())
           .setRequestId("requestId693933066")
           .build();
   AnywhereCache response = storageControlClient.pauseAnywhereCache(request);
 }
 

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

Returns
Type	Description
AnywhereCache

pauseAnywhereCache(String name)

public final AnywhereCache pauseAnywhereCache(String name)

Pauses an Anywhere Cache 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String name = AnywhereCacheName.of("[PROJECT]", "[BUCKET]", "[ANYWHERE_CACHE]").toString();
   AnywhereCache response = storageControlClient.pauseAnywhereCache(name);
 }
 

Parameter
Name	Description
name	String Required. The name field in the request should be: projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}

Returns
Type	Description
AnywhereCache

pauseAnywhereCacheCallable()

public final UnaryCallable<PauseAnywhereCacheRequest,AnywhereCache> pauseAnywhereCacheCallable()

Pauses an Anywhere Cache 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   PauseAnywhereCacheRequest request =
       PauseAnywhereCacheRequest.newBuilder()
           .setName(AnywhereCacheName.of("[PROJECT]", "[BUCKET]", "[ANYWHERE_CACHE]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<AnywhereCache> future =
       storageControlClient.pauseAnywhereCacheCallable().futureCall(request);
   // Do something.
   AnywhereCache response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<PauseAnywhereCacheRequest,AnywhereCache>

renameFolderAsync(@Nullable FolderName name, String destinationFolderId)

public final OperationFuture<Folder,RenameFolderMetadata> renameFolderAsync(@Nullable FolderName name, String destinationFolderId)

Renames a source folder to a destination folder. This operation is only applicable to a hierarchical namespace enabled bucket. During a rename, the source and destination folders are locked until the long running operation completes.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   FolderName name = FolderName.of("[PROJECT]", "[BUCKET]", "[FOLDER]");
   String destinationFolderId = "destinationFolderId-480084905";
   Folder response = storageControlClient.renameFolderAsync(name, destinationFolderId).get();
 }
 

Parameters
Name	Description
name	@org.jspecify.annotations.Nullable com.google.storage.control.v2.FolderName Required. Name of the source folder being renamed. Format: projects/{project}/buckets/{bucket}/folders/{folder}
destinationFolderId	String Required. The destination folder ID, e.g. foo/bar/.

Returns
Type	Description
OperationFuture<Folder,RenameFolderMetadata>

renameFolderAsync(RenameFolderRequest request)

public final OperationFuture<Folder,RenameFolderMetadata> renameFolderAsync(RenameFolderRequest request)

Renames a source folder to a destination folder. This operation is only applicable to a hierarchical namespace enabled bucket. During a rename, the source and destination folders are locked until the long running operation completes.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   RenameFolderRequest request =
       RenameFolderRequest.newBuilder()
           .setName(FolderName.of("[PROJECT]", "[BUCKET]", "[FOLDER]").toString())
           .setDestinationFolderId("destinationFolderId-480084905")
           .setIfMetagenerationMatch(1043427781)
           .setIfMetagenerationNotMatch(1025430873)
           .setRequestId("requestId693933066")
           .build();
   Folder response = storageControlClient.renameFolderAsync(request).get();
 }
 

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

Returns
Type	Description
OperationFuture<Folder,RenameFolderMetadata>

renameFolderAsync(String name, String destinationFolderId)

public final OperationFuture<Folder,RenameFolderMetadata> renameFolderAsync(String name, String destinationFolderId)

Renames a source folder to a destination folder. This operation is only applicable to a hierarchical namespace enabled bucket. During a rename, the source and destination folders are locked until the long running operation completes.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String name = FolderName.of("[PROJECT]", "[BUCKET]", "[FOLDER]").toString();
   String destinationFolderId = "destinationFolderId-480084905";
   Folder response = storageControlClient.renameFolderAsync(name, destinationFolderId).get();
 }
 

Parameters
Name	Description
name	String Required. Name of the source folder being renamed. Format: projects/{project}/buckets/{bucket}/folders/{folder}
destinationFolderId	String Required. The destination folder ID, e.g. foo/bar/.

Returns
Type	Description
OperationFuture<Folder,RenameFolderMetadata>

renameFolderCallable()

public final UnaryCallable<RenameFolderRequest,Operation> renameFolderCallable()

Renames a source folder to a destination folder. This operation is only applicable to a hierarchical namespace enabled bucket. During a rename, the source and destination folders are locked until the long running operation completes.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   RenameFolderRequest request =
       RenameFolderRequest.newBuilder()
           .setName(FolderName.of("[PROJECT]", "[BUCKET]", "[FOLDER]").toString())
           .setDestinationFolderId("destinationFolderId-480084905")
           .setIfMetagenerationMatch(1043427781)
           .setIfMetagenerationNotMatch(1025430873)
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = storageControlClient.renameFolderCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<RenameFolderRequest,Operation>

renameFolderOperationCallable()

public final OperationCallable<RenameFolderRequest,Folder,RenameFolderMetadata> renameFolderOperationCallable()

Renames a source folder to a destination folder. This operation is only applicable to a hierarchical namespace enabled bucket. During a rename, the source and destination folders are locked until the long running operation completes.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   RenameFolderRequest request =
       RenameFolderRequest.newBuilder()
           .setName(FolderName.of("[PROJECT]", "[BUCKET]", "[FOLDER]").toString())
           .setDestinationFolderId("destinationFolderId-480084905")
           .setIfMetagenerationMatch(1043427781)
           .setIfMetagenerationNotMatch(1025430873)
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Folder, RenameFolderMetadata> future =
       storageControlClient.renameFolderOperationCallable().futureCall(request);
   // Do something.
   Folder response = future.get();
 }
 

Returns
Type	Description
OperationCallable<RenameFolderRequest,Folder,RenameFolderMetadata>

resumeAnywhereCache(@Nullable AnywhereCacheName name)

public final AnywhereCache resumeAnywhereCache(@Nullable AnywhereCacheName name)

Resumes a disabled or paused Anywhere Cache 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   AnywhereCacheName name = AnywhereCacheName.of("[PROJECT]", "[BUCKET]", "[ANYWHERE_CACHE]");
   AnywhereCache response = storageControlClient.resumeAnywhereCache(name);
 }
 

Parameter
Name	Description
name	@org.jspecify.annotations.Nullable com.google.storage.control.v2.AnywhereCacheName Required. The name field in the request should be: projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}

Returns
Type	Description
AnywhereCache

resumeAnywhereCache(ResumeAnywhereCacheRequest request)

public final AnywhereCache resumeAnywhereCache(ResumeAnywhereCacheRequest request)

Resumes a disabled or paused Anywhere Cache 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   ResumeAnywhereCacheRequest request =
       ResumeAnywhereCacheRequest.newBuilder()
           .setName(AnywhereCacheName.of("[PROJECT]", "[BUCKET]", "[ANYWHERE_CACHE]").toString())
           .setRequestId("requestId693933066")
           .build();
   AnywhereCache response = storageControlClient.resumeAnywhereCache(request);
 }
 

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

Returns
Type	Description
AnywhereCache

resumeAnywhereCache(String name)

public final AnywhereCache resumeAnywhereCache(String name)

Resumes a disabled or paused Anywhere Cache 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String name = AnywhereCacheName.of("[PROJECT]", "[BUCKET]", "[ANYWHERE_CACHE]").toString();
   AnywhereCache response = storageControlClient.resumeAnywhereCache(name);
 }
 

Parameter
Name	Description
name	String Required. The name field in the request should be: projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}

Returns
Type	Description
AnywhereCache

resumeAnywhereCacheCallable()

public final UnaryCallable<ResumeAnywhereCacheRequest,AnywhereCache> resumeAnywhereCacheCallable()

Resumes a disabled or paused Anywhere Cache 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   ResumeAnywhereCacheRequest request =
       ResumeAnywhereCacheRequest.newBuilder()
           .setName(AnywhereCacheName.of("[PROJECT]", "[BUCKET]", "[ANYWHERE_CACHE]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<AnywhereCache> future =
       storageControlClient.resumeAnywhereCacheCallable().futureCall(request);
   // Do something.
   AnywhereCache response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<ResumeAnywhereCacheRequest,AnywhereCache>

setIamPolicy(@Nullable ResourceName resource, Policy policy)

public final Policy setIamPolicy(@Nullable ResourceName resource, Policy policy)

Updates an IAM policy for the specified bucket. The resource field in the request should be projects//buckets/{bucket} for a bucket, or projects//buckets/{bucket}/managedFolders/{managedFolder} for a managed folder.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   ResourceName resource = LocationName.of("[PROJECT]", "[LOCATION]");
   Policy policy = Policy.newBuilder().build();
   Policy response = storageControlClient.setIamPolicy(resource, policy);
 }
 

Parameters
Name	Description
resource	@org.jspecify.annotations.Nullable com.google.api.resourcenames.ResourceName REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
policy	com.google.iam.v1.Policy REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

Returns
Type	Description
com.google.iam.v1.Policy

setIamPolicy(SetIamPolicyRequest request)

public final Policy setIamPolicy(SetIamPolicyRequest request)

Updates an IAM policy for the specified bucket. The resource field in the request should be projects//buckets/{bucket} for a bucket, or projects//buckets/{bucket}/managedFolders/{managedFolder} for a managed folder.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = storageControlClient.setIamPolicy(request);
 }
 

Parameter
Name	Description
request	com.google.iam.v1.SetIamPolicyRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
com.google.iam.v1.Policy

setIamPolicy(String resource, Policy policy)

public final Policy setIamPolicy(String resource, Policy policy)

Updates an IAM policy for the specified bucket. The resource field in the request should be projects//buckets/{bucket} for a bucket, or projects//buckets/{bucket}/managedFolders/{managedFolder} for a managed folder.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String resource = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Policy policy = Policy.newBuilder().build();
   Policy response = storageControlClient.setIamPolicy(resource, policy);
 }
 

Parameters
Name	Description
resource	String REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
policy	com.google.iam.v1.Policy REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

Returns
Type	Description
com.google.iam.v1.Policy

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()

Updates an IAM policy for the specified bucket. The resource field in the request should be projects//buckets/{bucket} for a bucket, or projects//buckets/{bucket}/managedFolders/{managedFolder} for a managed folder.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future = storageControlClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

summarizeIntelligenceFindings(SummarizeIntelligenceFindingsRequest request)

public final StorageControlClient.SummarizeIntelligenceFindingsPagedResponse summarizeIntelligenceFindings(SummarizeIntelligenceFindingsRequest request)

Summarizes the intelligence findings for the specified scope (organization, folder or project).

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   SummarizeIntelligenceFindingsRequest request =
       SummarizeIntelligenceFindingsRequest.newBuilder()
           .setParent("parent-995424086")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (FindingSummary element :
       storageControlClient.summarizeIntelligenceFindings(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

Returns
Type	Description
StorageControlClient.SummarizeIntelligenceFindingsPagedResponse

summarizeIntelligenceFindings(String parent)

public final StorageControlClient.SummarizeIntelligenceFindingsPagedResponse summarizeIntelligenceFindings(String parent)

Summarizes the intelligence findings for the specified scope (organization, folder or project).

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String parent = "parent-995424086";
   for (FindingSummary element :
       storageControlClient.summarizeIntelligenceFindings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	String Required. The scope to summarize the findings for. Format: - organizations/{organization}/locations/{location} - folders/{folder}/locations/{location} - projects/{project}/locations/{location}

Returns
Type	Description
StorageControlClient.SummarizeIntelligenceFindingsPagedResponse

summarizeIntelligenceFindingsCallable()

public final UnaryCallable<SummarizeIntelligenceFindingsRequest,SummarizeIntelligenceFindingsResponse> summarizeIntelligenceFindingsCallable()

Summarizes the intelligence findings for the specified scope (organization, folder or project).

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   SummarizeIntelligenceFindingsRequest request =
       SummarizeIntelligenceFindingsRequest.newBuilder()
           .setParent("parent-995424086")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     SummarizeIntelligenceFindingsResponse response =
         storageControlClient.summarizeIntelligenceFindingsCallable().call(request);
     for (FindingSummary element : response.getFindingSummariesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<SummarizeIntelligenceFindingsRequest,SummarizeIntelligenceFindingsResponse>

summarizeIntelligenceFindingsPagedCallable()

public final UnaryCallable<SummarizeIntelligenceFindingsRequest,StorageControlClient.SummarizeIntelligenceFindingsPagedResponse> summarizeIntelligenceFindingsPagedCallable()

Summarizes the intelligence findings for the specified scope (organization, folder or project).

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   SummarizeIntelligenceFindingsRequest request =
       SummarizeIntelligenceFindingsRequest.newBuilder()
           .setParent("parent-995424086")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<FindingSummary> future =
       storageControlClient.summarizeIntelligenceFindingsPagedCallable().futureCall(request);
   // Do something.
   for (FindingSummary element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<SummarizeIntelligenceFindingsRequest,SummarizeIntelligenceFindingsPagedResponse>

testIamPermissions(@Nullable ResourceName resource, List<String> permissions)

public final TestIamPermissionsResponse testIamPermissions(@Nullable ResourceName resource, List<String> permissions)

Tests a set of permissions on the given bucket, object, or managed folder to see which, if any, are held by the caller. The resource field in the request should be projects//buckets/{bucket} for a bucket, projects//buckets/{bucket}/objects/{object} for an object, or projects/_/buckets/{bucket}/managedFolders/{managedFolder} for a managed folder.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   ResourceName resource = LocationName.of("[PROJECT]", "[LOCATION]");
   List<String> permissions = new ArrayList<>();
   TestIamPermissionsResponse response =
       storageControlClient.testIamPermissions(resource, permissions);
 }
 

Parameters
Name	Description
resource	@org.jspecify.annotations.Nullable com.google.api.resourcenames.ResourceName REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
permissions	List<String> The set of permissions to check for the resource. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview.

Returns
Type	Description
com.google.iam.v1.TestIamPermissionsResponse

testIamPermissions(TestIamPermissionsRequest request)

public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)

Tests a set of permissions on the given bucket, object, or managed folder to see which, if any, are held by the caller. The resource field in the request should be projects//buckets/{bucket} for a bucket, projects//buckets/{bucket}/objects/{object} for an object, or projects/_/buckets/{bucket}/managedFolders/{managedFolder} for a managed folder.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = storageControlClient.testIamPermissions(request);
 }
 

Parameter
Name	Description
request	com.google.iam.v1.TestIamPermissionsRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
com.google.iam.v1.TestIamPermissionsResponse

testIamPermissions(String resource, List<String> permissions)

public final TestIamPermissionsResponse testIamPermissions(String resource, List<String> permissions)

Tests a set of permissions on the given bucket, object, or managed folder to see which, if any, are held by the caller. The resource field in the request should be projects//buckets/{bucket} for a bucket, projects//buckets/{bucket}/objects/{object} for an object, or projects/_/buckets/{bucket}/managedFolders/{managedFolder} for a managed folder.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   String resource = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   List<String> permissions = new ArrayList<>();
   TestIamPermissionsResponse response =
       storageControlClient.testIamPermissions(resource, permissions);
 }
 

Parameters
Name	Description
resource	String REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
permissions	List<String> The set of permissions to check for the resource. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview.

Returns
Type	Description
com.google.iam.v1.TestIamPermissionsResponse

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()

Tests a set of permissions on the given bucket, object, or managed folder to see which, if any, are held by the caller. The resource field in the request should be projects//buckets/{bucket} for a bucket, projects//buckets/{bucket}/objects/{object} for an object, or projects/_/buckets/{bucket}/managedFolders/{managedFolder} for a managed folder.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       storageControlClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

updateAnywhereCacheAsync(AnywhereCache anywhereCache, FieldMask updateMask)

public final OperationFuture<AnywhereCache,UpdateAnywhereCacheMetadata> updateAnywhereCacheAsync(AnywhereCache anywhereCache, FieldMask updateMask)

Updates an Anywhere Cache instance. Mutable fields include ttl and admission_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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   AnywhereCache anywhereCache = AnywhereCache.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   AnywhereCache response =
       storageControlClient.updateAnywhereCacheAsync(anywhereCache, updateMask).get();
 }
 

Parameters
Name	Description
anywhereCache	AnywhereCache Required. The Anywhere Cache instance to be updated.
updateMask	FieldMask Required. List of fields to be updated. Mutable fields of AnywhereCache include ttl and admission_policy. To specify ALL fields, specify a single field with the value *. Note: We recommend against doing this. If a new field is introduced at a later time, an older client updating with the * may accidentally reset the new field's value. Not specifying any fields is an error.

Returns
Type	Description
OperationFuture<AnywhereCache,UpdateAnywhereCacheMetadata>

updateAnywhereCacheAsync(UpdateAnywhereCacheRequest request)

public final OperationFuture<AnywhereCache,UpdateAnywhereCacheMetadata> updateAnywhereCacheAsync(UpdateAnywhereCacheRequest request)

Updates an Anywhere Cache instance. Mutable fields include ttl and admission_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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   UpdateAnywhereCacheRequest request =
       UpdateAnywhereCacheRequest.newBuilder()
           .setAnywhereCache(AnywhereCache.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   AnywhereCache response = storageControlClient.updateAnywhereCacheAsync(request).get();
 }
 

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

Returns
Type	Description
OperationFuture<AnywhereCache,UpdateAnywhereCacheMetadata>

updateAnywhereCacheCallable()

public final UnaryCallable<UpdateAnywhereCacheRequest,Operation> updateAnywhereCacheCallable()

Updates an Anywhere Cache instance. Mutable fields include ttl and admission_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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   UpdateAnywhereCacheRequest request =
       UpdateAnywhereCacheRequest.newBuilder()
           .setAnywhereCache(AnywhereCache.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       storageControlClient.updateAnywhereCacheCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<UpdateAnywhereCacheRequest,Operation>

updateAnywhereCacheOperationCallable()

public final OperationCallable<UpdateAnywhereCacheRequest,AnywhereCache,UpdateAnywhereCacheMetadata> updateAnywhereCacheOperationCallable()

Updates an Anywhere Cache instance. Mutable fields include ttl and admission_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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   UpdateAnywhereCacheRequest request =
       UpdateAnywhereCacheRequest.newBuilder()
           .setAnywhereCache(AnywhereCache.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<AnywhereCache, UpdateAnywhereCacheMetadata> future =
       storageControlClient.updateAnywhereCacheOperationCallable().futureCall(request);
   // Do something.
   AnywhereCache response = future.get();
 }
 

Returns
Type	Description
OperationCallable<UpdateAnywhereCacheRequest,AnywhereCache,UpdateAnywhereCacheMetadata>

updateFolderIntelligenceConfig(IntelligenceConfig intelligenceConfig, FieldMask updateMask)

public final IntelligenceConfig updateFolderIntelligenceConfig(IntelligenceConfig intelligenceConfig, FieldMask updateMask)

Updates the Folder scoped singleton IntelligenceConfig 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   IntelligenceConfig intelligenceConfig = IntelligenceConfig.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   IntelligenceConfig response =
       storageControlClient.updateFolderIntelligenceConfig(intelligenceConfig, updateMask);
 }
 

Parameters
Name	Description
intelligenceConfig	IntelligenceConfig Required. The IntelligenceConfig resource to be updated.
updateMask	FieldMask Required. The update_mask that specifies the fields within the IntelligenceConfig resource that should be modified by this update. Only the listed fields are updated.

Returns
Type	Description
IntelligenceConfig

updateFolderIntelligenceConfig(UpdateFolderIntelligenceConfigRequest request)

public final IntelligenceConfig updateFolderIntelligenceConfig(UpdateFolderIntelligenceConfigRequest request)

Updates the Folder scoped singleton IntelligenceConfig 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   UpdateFolderIntelligenceConfigRequest request =
       UpdateFolderIntelligenceConfigRequest.newBuilder()
           .setIntelligenceConfig(IntelligenceConfig.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   IntelligenceConfig response = storageControlClient.updateFolderIntelligenceConfig(request);
 }
 

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

Returns
Type	Description
IntelligenceConfig

updateFolderIntelligenceConfigCallable()

public final UnaryCallable<UpdateFolderIntelligenceConfigRequest,IntelligenceConfig> updateFolderIntelligenceConfigCallable()

Updates the Folder scoped singleton IntelligenceConfig 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   UpdateFolderIntelligenceConfigRequest request =
       UpdateFolderIntelligenceConfigRequest.newBuilder()
           .setIntelligenceConfig(IntelligenceConfig.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<IntelligenceConfig> future =
       storageControlClient.updateFolderIntelligenceConfigCallable().futureCall(request);
   // Do something.
   IntelligenceConfig response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<UpdateFolderIntelligenceConfigRequest,IntelligenceConfig>

updateManagedFolder(ManagedFolder managedFolder, FieldMask updateMask)

public final ManagedFolder updateManagedFolder(ManagedFolder managedFolder, FieldMask updateMask)

Updates a managed folder. Currently, this RPC only supports updating the rapid_cache_config field.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   ManagedFolder managedFolder = ManagedFolder.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   ManagedFolder response = storageControlClient.updateManagedFolder(managedFolder, updateMask);
 }
 

Parameters
Name	Description
managedFolder	ManagedFolder Required. Properties of the managed folder being updated. Currently, this RPC only supports updating the rapid_cache_config field in managed_folder.
updateMask	FieldMask Optional. Update mask for managed_folder. Currently, this RPC only supports updating the rapid_cache_config field in managed_folder. This field also supports update mask for the subfields in the map of rapid_cache_config. The user can specify the update mask for rapid_cache_config.policies and rapid_cache_config.policies.<key>, but patching is not supported for a field within RapidCachePolicy.policies.<key>, like rapid_cache_config.policies.[key].ingest_on_write.

Returns
Type	Description
ManagedFolder

updateManagedFolder(UpdateManagedFolderRequest request)

public final ManagedFolder updateManagedFolder(UpdateManagedFolderRequest request)

Updates a managed folder. Currently, this RPC only supports updating the rapid_cache_config field.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   UpdateManagedFolderRequest request =
       UpdateManagedFolderRequest.newBuilder()
           .setManagedFolder(ManagedFolder.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setIfMetagenerationMatch(1043427781)
           .setIfMetagenerationNotMatch(1025430873)
           .setRequestId("requestId693933066")
           .build();
   ManagedFolder response = storageControlClient.updateManagedFolder(request);
 }
 

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

Returns
Type	Description
ManagedFolder

updateManagedFolderCallable()

public final UnaryCallable<UpdateManagedFolderRequest,ManagedFolder> updateManagedFolderCallable()

Updates a managed folder. Currently, this RPC only supports updating the rapid_cache_config field.

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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   UpdateManagedFolderRequest request =
       UpdateManagedFolderRequest.newBuilder()
           .setManagedFolder(ManagedFolder.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setIfMetagenerationMatch(1043427781)
           .setIfMetagenerationNotMatch(1025430873)
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<ManagedFolder> future =
       storageControlClient.updateManagedFolderCallable().futureCall(request);
   // Do something.
   ManagedFolder response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<UpdateManagedFolderRequest,ManagedFolder>

updateOrganizationIntelligenceConfig(IntelligenceConfig intelligenceConfig, FieldMask updateMask)

public final IntelligenceConfig updateOrganizationIntelligenceConfig(IntelligenceConfig intelligenceConfig, FieldMask updateMask)

Updates the Organization scoped singleton IntelligenceConfig 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   IntelligenceConfig intelligenceConfig = IntelligenceConfig.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   IntelligenceConfig response =
       storageControlClient.updateOrganizationIntelligenceConfig(intelligenceConfig, updateMask);
 }
 

Parameters
Name	Description
intelligenceConfig	IntelligenceConfig Required. The IntelligenceConfig resource to be updated.
updateMask	FieldMask Required. The update_mask that specifies the fields within the IntelligenceConfig resource that should be modified by this update. Only the listed fields are updated.

Returns
Type	Description
IntelligenceConfig

updateOrganizationIntelligenceConfig(UpdateOrganizationIntelligenceConfigRequest request)

public final IntelligenceConfig updateOrganizationIntelligenceConfig(UpdateOrganizationIntelligenceConfigRequest request)

Updates the Organization scoped singleton IntelligenceConfig 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   UpdateOrganizationIntelligenceConfigRequest request =
       UpdateOrganizationIntelligenceConfigRequest.newBuilder()
           .setIntelligenceConfig(IntelligenceConfig.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   IntelligenceConfig response =
       storageControlClient.updateOrganizationIntelligenceConfig(request);
 }
 

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

Returns
Type	Description
IntelligenceConfig

updateOrganizationIntelligenceConfigCallable()

public final UnaryCallable<UpdateOrganizationIntelligenceConfigRequest,IntelligenceConfig> updateOrganizationIntelligenceConfigCallable()

Updates the Organization scoped singleton IntelligenceConfig 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   UpdateOrganizationIntelligenceConfigRequest request =
       UpdateOrganizationIntelligenceConfigRequest.newBuilder()
           .setIntelligenceConfig(IntelligenceConfig.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<IntelligenceConfig> future =
       storageControlClient.updateOrganizationIntelligenceConfigCallable().futureCall(request);
   // Do something.
   IntelligenceConfig response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<UpdateOrganizationIntelligenceConfigRequest,IntelligenceConfig>

updateProjectIntelligenceConfig(IntelligenceConfig intelligenceConfig, FieldMask updateMask)

public final IntelligenceConfig updateProjectIntelligenceConfig(IntelligenceConfig intelligenceConfig, FieldMask updateMask)

Updates the Project scoped singleton IntelligenceConfig 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   IntelligenceConfig intelligenceConfig = IntelligenceConfig.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   IntelligenceConfig response =
       storageControlClient.updateProjectIntelligenceConfig(intelligenceConfig, updateMask);
 }
 

Parameters
Name	Description
intelligenceConfig	IntelligenceConfig Required. The IntelligenceConfig resource to be updated.
updateMask	FieldMask Required. The update_mask that specifies the fields within the IntelligenceConfig resource that should be modified by this update. Only the listed fields are updated.

Returns
Type	Description
IntelligenceConfig

updateProjectIntelligenceConfig(UpdateProjectIntelligenceConfigRequest request)

public final IntelligenceConfig updateProjectIntelligenceConfig(UpdateProjectIntelligenceConfigRequest request)

Updates the Project scoped singleton IntelligenceConfig 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   UpdateProjectIntelligenceConfigRequest request =
       UpdateProjectIntelligenceConfigRequest.newBuilder()
           .setIntelligenceConfig(IntelligenceConfig.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   IntelligenceConfig response = storageControlClient.updateProjectIntelligenceConfig(request);
 }
 

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

Returns
Type	Description
IntelligenceConfig

updateProjectIntelligenceConfigCallable()

public final UnaryCallable<UpdateProjectIntelligenceConfigRequest,IntelligenceConfig> updateProjectIntelligenceConfigCallable()

Updates the Project scoped singleton IntelligenceConfig 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   UpdateProjectIntelligenceConfigRequest request =
       UpdateProjectIntelligenceConfigRequest.newBuilder()
           .setIntelligenceConfig(IntelligenceConfig.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<IntelligenceConfig> future =
       storageControlClient.updateProjectIntelligenceConfigCallable().futureCall(request);
   // Do something.
   IntelligenceConfig response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<UpdateProjectIntelligenceConfigRequest,IntelligenceConfig>

updateRapidCacheAsync(RapidCache rapidCache, FieldMask updateMask)

public final OperationFuture<RapidCache,UpdateRapidCacheMetadata> updateRapidCacheAsync(RapidCache rapidCache, FieldMask updateMask)

Updates a Rapid Cache 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   RapidCache rapidCache = RapidCache.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   RapidCache response =
       storageControlClient.updateRapidCacheAsync(rapidCache, updateMask).get();
 }
 

Parameters
Name	Description
rapidCache	RapidCache Required. The RapidCache to update.
updateMask	FieldMask Required. List of fields to be updated. Mutable fields of RapidCache include ttl, admission_policy and ingest_on_write. To specify ALL fields, specify a single field with the value *. Note: We recommend against doing this. If a new field is introduced at a later time, an older client updating with the * may accidentally reset the new field's value. Not specifying any fields is an error.

Returns
Type	Description
OperationFuture<RapidCache,UpdateRapidCacheMetadata>

updateRapidCacheAsync(UpdateRapidCacheRequest request)

public final OperationFuture<RapidCache,UpdateRapidCacheMetadata> updateRapidCacheAsync(UpdateRapidCacheRequest request)

Updates a Rapid Cache 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   UpdateRapidCacheRequest request =
       UpdateRapidCacheRequest.newBuilder()
           .setRapidCache(RapidCache.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   RapidCache response = storageControlClient.updateRapidCacheAsync(request).get();
 }
 

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

Returns
Type	Description
OperationFuture<RapidCache,UpdateRapidCacheMetadata>

updateRapidCacheCallable()

public final UnaryCallable<UpdateRapidCacheRequest,Operation> updateRapidCacheCallable()

Updates a Rapid Cache 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   UpdateRapidCacheRequest request =
       UpdateRapidCacheRequest.newBuilder()
           .setRapidCache(RapidCache.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       storageControlClient.updateRapidCacheCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<UpdateRapidCacheRequest,Operation>

updateRapidCacheOperationCallable()

public final OperationCallable<UpdateRapidCacheRequest,RapidCache,UpdateRapidCacheMetadata> updateRapidCacheOperationCallable()

Updates a Rapid Cache 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 (StorageControlClient storageControlClient = StorageControlClient.create()) {
   UpdateRapidCacheRequest request =
       UpdateRapidCacheRequest.newBuilder()
           .setRapidCache(RapidCache.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<RapidCache, UpdateRapidCacheMetadata> future =
       storageControlClient.updateRapidCacheOperationCallable().futureCall(request);
   // Do something.
   RapidCache response = future.get();
 }
 

Returns
Type	Description
OperationCallable<UpdateRapidCacheRequest,RapidCache,UpdateRapidCacheMetadata>