Package com.google.storage.control.v2 (2.33.0)

A client to Cloud Storage API

The interfaces provided are listed below, along with usage samples.

StorageControlClient

Service Description: StorageControl service includes selected control plane operations.

Sample for StorageControlClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying 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);
 }

Classes

BucketName.Builder

Builder for projects/{project}/buckets/{bucket}.

CommonLongRunningOperationMetadata

The message contains metadata that is common to all Storage Control long-running operations, present in its google.longrunning.Operation messages, and accessible via metadata.common_metadata.

Protobuf type google.storage.control.v2.CommonLongRunningOperationMetadata

CommonLongRunningOperationMetadata.Builder

The message contains metadata that is common to all Storage Control long-running operations, present in its google.longrunning.Operation messages, and accessible via metadata.common_metadata.

Protobuf type google.storage.control.v2.CommonLongRunningOperationMetadata

CreateFolderRequest

Request message for CreateFolder.

Protobuf type google.storage.control.v2.CreateFolderRequest

CreateFolderRequest.Builder

Request message for CreateFolder.

Protobuf type google.storage.control.v2.CreateFolderRequest

DeleteFolderRequest

Request message for DeleteFolder.

Protobuf type google.storage.control.v2.DeleteFolderRequest

DeleteFolderRequest.Builder

Request message for DeleteFolder.

Protobuf type google.storage.control.v2.DeleteFolderRequest

Folder

A folder.

Protobuf type google.storage.control.v2.Folder

Folder.Builder

A folder.

Protobuf type google.storage.control.v2.Folder

FolderName.Builder

Builder for projects/{project}/buckets/{bucket}/folders/{folder=**}.

GetFolderRequest

Request message for GetFolder.

Protobuf type google.storage.control.v2.GetFolderRequest

GetFolderRequest.Builder

Request message for GetFolder.

Protobuf type google.storage.control.v2.GetFolderRequest

GetStorageLayoutRequest

Request message for GetStorageLayout.

Protobuf type google.storage.control.v2.GetStorageLayoutRequest

GetStorageLayoutRequest.Builder

Request message for GetStorageLayout.

Protobuf type google.storage.control.v2.GetStorageLayoutRequest

ListFoldersRequest

Request message for ListFolders.

Protobuf type google.storage.control.v2.ListFoldersRequest

ListFoldersRequest.Builder

Request message for ListFolders.

Protobuf type google.storage.control.v2.ListFoldersRequest

ListFoldersResponse

Response message for ListFolders.

Protobuf type google.storage.control.v2.ListFoldersResponse

ListFoldersResponse.Builder

Response message for ListFolders.

Protobuf type google.storage.control.v2.ListFoldersResponse

PendingRenameInfo

Contains information about a pending rename operation.

Protobuf type google.storage.control.v2.PendingRenameInfo

PendingRenameInfo.Builder

Contains information about a pending rename operation.

Protobuf type google.storage.control.v2.PendingRenameInfo

RenameFolderMetadata

Message returned in the metadata field of the Operation resource for RenameFolder operations.

Protobuf type google.storage.control.v2.RenameFolderMetadata

RenameFolderMetadata.Builder

Message returned in the metadata field of the Operation resource for RenameFolder operations.

Protobuf type google.storage.control.v2.RenameFolderMetadata

RenameFolderRequest

Request message for RenameFolder.

Protobuf type google.storage.control.v2.RenameFolderRequest

RenameFolderRequest.Builder

Request message for RenameFolder.

Protobuf type google.storage.control.v2.RenameFolderRequest

StorageControlClient

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.	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.	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.	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 for a given 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. 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()

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.

The default service address (storage.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of createFolder to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require 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.Builder storageControlSettingsBuilder =
     StorageControlSettings.newBuilder();
 storageControlSettingsBuilder
     .createFolderSettings()
     .setRetrySettings(
         storageControlSettingsBuilder
             .createFolderSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 StorageControlSettings storageControlSettings = storageControlSettingsBuilder.build();

Package com.google.storage.control.v2 (2.33.0)

StorageControlClient

Classes

Interfaces