Class StorageControlClient (2.40.1)

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

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

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

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

createFolder(BucketName parent, Folder folder, String folderId)

public final Folder createFolder(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 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(BucketName parent, ManagedFolder managedFolder, String managedFolderId)

public final ManagedFolder createManagedFolder(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 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>

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

public final void deleteFolder(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 FolderName

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

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>

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

public final void deleteManagedFolder(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 ManagedFolderName

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

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>

getFolder(FolderName name)

public final Folder getFolder(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 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>

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

public final ManagedFolder getManagedFolder(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 ManagedFolderName

Required. Name of the managed folder. Format: projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}
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

getSettings()

public final StorageControlSettings getSettings()
Returns
Type Description
StorageControlSettings

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

public final StorageLayout getStorageLayout(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 StorageLayoutName

Required. The name of the StorageLayout resource. Format: projects/{project}/buckets/{bucket}/storageLayout
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

listFolders(BucketName parent)

public final StorageControlClient.ListFoldersPagedResponse listFolders(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 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>

listManagedFolders(BucketName parent)

public final StorageControlClient.ListManagedFoldersPagedResponse listManagedFolders(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 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>

renameFolderAsync(FolderName name, String destinationFolderId)

public final OperationFuture<Folder,RenameFolderMetadata> renameFolderAsync(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 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>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()