com.google.cloud.compute.v1

Class BackendBucketClient

java.lang.Object

com.google.cloud.compute.v1.BackendBucketClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class BackendBucketClient
extends Object
implements BackgroundResource

Service Description: Creates and runs virtual machines on Google Cloud Platform.

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:

 
 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   ProjectGlobalBackendBucketName backendBucket = ProjectGlobalBackendBucketName.of("[PROJECT]", "[BACKEND_BUCKET]");
   SignedUrlKey signedUrlKeyResource = SignedUrlKey.newBuilder().build();
   Operation response = backendBucketClient.addSignedUrlKeyBackendBucket(backendBucket, signedUrlKeyResource);
 }
 
 

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

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of BackendBucketSettings to create(). For example:

To customize credentials:

 
 BackendBucketSettings backendBucketSettings =
     BackendBucketSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 BackendBucketClient backendBucketClient =
     BackendBucketClient.create(backendBucketSettings);
 
 

To customize the endpoint:

 
 BackendBucketSettings backendBucketSettings =
     BackendBucketSettings.newBuilder().setEndpoint(myEndpoint).build();
 BackendBucketClient backendBucketClient =
     BackendBucketClient.create(backendBucketSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BackendBucketClient.ListBackendBucketsFixedSizeCollection
static class	BackendBucketClient.ListBackendBucketsPage
static class	BackendBucketClient.ListBackendBucketsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BackendBucketClient(BackendBucketSettings settings) Constructs an instance of BackendBucketClient, using the given settings.
protected	BackendBucketClient(BackendBucketStub stub)

Method Summary

Modifier and Type	Method and Description
Operation	addSignedUrlKeyBackendBucket(AddSignedUrlKeyBackendBucketHttpRequest request) Adds a key for validating requests with signed URLs for this backend bucket.
Operation	addSignedUrlKeyBackendBucket(ProjectGlobalBackendBucketName backendBucket, SignedUrlKey signedUrlKeyResource) Adds a key for validating requests with signed URLs for this backend bucket.
Operation	addSignedUrlKeyBackendBucket(String backendBucket, SignedUrlKey signedUrlKeyResource) Adds a key for validating requests with signed URLs for this backend bucket.
UnaryCallable<AddSignedUrlKeyBackendBucketHttpRequest,Operation>	addSignedUrlKeyBackendBucketCallable() Adds a key for validating requests with signed URLs for this backend bucket.
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static BackendBucketClient	create() Constructs an instance of BackendBucketClient with default settings.
static BackendBucketClient	create(BackendBucketSettings settings) Constructs an instance of BackendBucketClient, using the given settings.
static BackendBucketClient	create(BackendBucketStub stub) Constructs an instance of BackendBucketClient, using the given stub for making calls.
Operation	deleteBackendBucket(DeleteBackendBucketHttpRequest request) Deletes the specified BackendBucket resource.
Operation	deleteBackendBucket(ProjectGlobalBackendBucketName backendBucket) Deletes the specified BackendBucket resource.
Operation	deleteBackendBucket(String backendBucket) Deletes the specified BackendBucket resource.
UnaryCallable<DeleteBackendBucketHttpRequest,Operation>	deleteBackendBucketCallable() Deletes the specified BackendBucket resource.
Operation	deleteSignedUrlKeyBackendBucket(DeleteSignedUrlKeyBackendBucketHttpRequest request) Deletes a key for validating requests with signed URLs for this backend bucket.
Operation	deleteSignedUrlKeyBackendBucket(ProjectGlobalBackendBucketName backendBucket, String keyName) Deletes a key for validating requests with signed URLs for this backend bucket.
Operation	deleteSignedUrlKeyBackendBucket(String backendBucket, String keyName) Deletes a key for validating requests with signed URLs for this backend bucket.
UnaryCallable<DeleteSignedUrlKeyBackendBucketHttpRequest,Operation>	deleteSignedUrlKeyBackendBucketCallable() Deletes a key for validating requests with signed URLs for this backend bucket.
BackendBucket	getBackendBucket(GetBackendBucketHttpRequest request) Returns the specified BackendBucket resource.
BackendBucket	getBackendBucket(ProjectGlobalBackendBucketName backendBucket) Returns the specified BackendBucket resource.
BackendBucket	getBackendBucket(String backendBucket) Returns the specified BackendBucket resource.
UnaryCallable<GetBackendBucketHttpRequest,BackendBucket>	getBackendBucketCallable() Returns the specified BackendBucket resource.
BackendBucketSettings	getSettings()
BackendBucketStub	getStub()
Operation	insertBackendBucket(InsertBackendBucketHttpRequest request) Creates a BackendBucket resource in the specified project using the data included in the request.
Operation	insertBackendBucket(ProjectName project, BackendBucket backendBucketResource) Creates a BackendBucket resource in the specified project using the data included in the request.
Operation	insertBackendBucket(String project, BackendBucket backendBucketResource) Creates a BackendBucket resource in the specified project using the data included in the request.
UnaryCallable<InsertBackendBucketHttpRequest,Operation>	insertBackendBucketCallable() Creates a BackendBucket resource in the specified project using the data included in the request.
boolean	isShutdown()
boolean	isTerminated()
BackendBucketClient.ListBackendBucketsPagedResponse	listBackendBuckets(ListBackendBucketsHttpRequest request) Retrieves the list of BackendBucket resources available to the specified project.
BackendBucketClient.ListBackendBucketsPagedResponse	listBackendBuckets(ProjectName project) Retrieves the list of BackendBucket resources available to the specified project.
BackendBucketClient.ListBackendBucketsPagedResponse	listBackendBuckets(String project) Retrieves the list of BackendBucket resources available to the specified project.
UnaryCallable<ListBackendBucketsHttpRequest,BackendBucketList>	listBackendBucketsCallable() Retrieves the list of BackendBucket resources available to the specified project.
UnaryCallable<ListBackendBucketsHttpRequest,BackendBucketClient.ListBackendBucketsPagedResponse>	listBackendBucketsPagedCallable() Retrieves the list of BackendBucket resources available to the specified project.
Operation	patchBackendBucket(PatchBackendBucketHttpRequest request) Updates the specified BackendBucket resource with the data included in the request.
Operation	patchBackendBucket(ProjectGlobalBackendBucketName backendBucket, BackendBucket backendBucketResource, List<String> fieldMask) Updates the specified BackendBucket resource with the data included in the request.
Operation	patchBackendBucket(String backendBucket, BackendBucket backendBucketResource, List<String> fieldMask) Updates the specified BackendBucket resource with the data included in the request.
UnaryCallable<PatchBackendBucketHttpRequest,Operation>	patchBackendBucketCallable() Updates the specified BackendBucket resource with the data included in the request.
void	shutdown()
void	shutdownNow()
Operation	updateBackendBucket(ProjectGlobalBackendBucketName backendBucket, BackendBucket backendBucketResource, List<String> fieldMask) Updates the specified BackendBucket resource with the data included in the request.
Operation	updateBackendBucket(String backendBucket, BackendBucket backendBucketResource, List<String> fieldMask) Updates the specified BackendBucket resource with the data included in the request.
Operation	updateBackendBucket(UpdateBackendBucketHttpRequest request) Updates the specified BackendBucket resource with the data included in the request.
UnaryCallable<UpdateBackendBucketHttpRequest,Operation>	updateBackendBucketCallable() Updates the specified BackendBucket resource with the data included in the request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BackendBucketClient

protected BackendBucketClient(BackendBucketSettings settings)
                       throws IOException

Constructs an instance of BackendBucketClient, 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.

Throws:

IOException

BackendBucketClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected BackendBucketClient(BackendBucketStub stub)

Method Detail

create

public static final BackendBucketClient create()
                                        throws IOException

Constructs an instance of BackendBucketClient with default settings.

Throws:

IOException

create

public static final BackendBucketClient create(BackendBucketSettings settings)
                                        throws IOException

Constructs an instance of BackendBucketClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final BackendBucketClient create(BackendBucketStub stub)

Constructs an instance of BackendBucketClient, using the given stub for making calls. This is for advanced usage - prefer to use BackendBucketSettings}.

getSettings

public final BackendBucketSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public BackendBucketStub getStub()

addSignedUrlKeyBackendBucket

@BetaApi
public final Operation addSignedUrlKeyBackendBucket(ProjectGlobalBackendBucketName backendBucket,
                                                             SignedUrlKey signedUrlKeyResource)

Adds a key for validating requests with signed URLs for this backend bucket.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   ProjectGlobalBackendBucketName backendBucket = ProjectGlobalBackendBucketName.of("[PROJECT]", "[BACKEND_BUCKET]");
   SignedUrlKey signedUrlKeyResource = SignedUrlKey.newBuilder().build();
   Operation response = backendBucketClient.addSignedUrlKeyBackendBucket(backendBucket, signedUrlKeyResource);
 }
 

Parameters:

backendBucket - Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035.

signedUrlKeyResource - Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs

Throws:

ApiException - if the remote call fails

addSignedUrlKeyBackendBucket

@BetaApi
public final Operation addSignedUrlKeyBackendBucket(String backendBucket,
                                                             SignedUrlKey signedUrlKeyResource)

Adds a key for validating requests with signed URLs for this backend bucket.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   ProjectGlobalBackendBucketName backendBucket = ProjectGlobalBackendBucketName.of("[PROJECT]", "[BACKEND_BUCKET]");
   SignedUrlKey signedUrlKeyResource = SignedUrlKey.newBuilder().build();
   Operation response = backendBucketClient.addSignedUrlKeyBackendBucket(backendBucket.toString(), signedUrlKeyResource);
 }
 

Parameters:

backendBucket - Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035.

signedUrlKeyResource - Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs

Throws:

ApiException - if the remote call fails

addSignedUrlKeyBackendBucket

@BetaApi
public final Operation addSignedUrlKeyBackendBucket(AddSignedUrlKeyBackendBucketHttpRequest request)

Adds a key for validating requests with signed URLs for this backend bucket.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   String formattedBackendBucket = ProjectGlobalBackendBucketName.format("[PROJECT]", "[BACKEND_BUCKET]");
   SignedUrlKey signedUrlKeyResource = SignedUrlKey.newBuilder().build();
   AddSignedUrlKeyBackendBucketHttpRequest request = AddSignedUrlKeyBackendBucketHttpRequest.newBuilder()
     .setBackendBucket(formattedBackendBucket)
     .setSignedUrlKeyResource(signedUrlKeyResource)
     .build();
   Operation response = backendBucketClient.addSignedUrlKeyBackendBucket(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

addSignedUrlKeyBackendBucketCallable

@BetaApi
public final UnaryCallable<AddSignedUrlKeyBackendBucketHttpRequest,Operation> addSignedUrlKeyBackendBucketCallable()

Adds a key for validating requests with signed URLs for this backend bucket.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   String formattedBackendBucket = ProjectGlobalBackendBucketName.format("[PROJECT]", "[BACKEND_BUCKET]");
   SignedUrlKey signedUrlKeyResource = SignedUrlKey.newBuilder().build();
   AddSignedUrlKeyBackendBucketHttpRequest request = AddSignedUrlKeyBackendBucketHttpRequest.newBuilder()
     .setBackendBucket(formattedBackendBucket)
     .setSignedUrlKeyResource(signedUrlKeyResource)
     .build();
   ApiFuture<Operation> future = backendBucketClient.addSignedUrlKeyBackendBucketCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

deleteBackendBucket

@BetaApi
public final Operation deleteBackendBucket(ProjectGlobalBackendBucketName backendBucket)

Deletes the specified BackendBucket resource.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   ProjectGlobalBackendBucketName backendBucket = ProjectGlobalBackendBucketName.of("[PROJECT]", "[BACKEND_BUCKET]");
   Operation response = backendBucketClient.deleteBackendBucket(backendBucket);
 }
 

Parameters:

backendBucket - Name of the BackendBucket resource to delete.

Throws:

ApiException - if the remote call fails

deleteBackendBucket

@BetaApi
public final Operation deleteBackendBucket(String backendBucket)

Deletes the specified BackendBucket resource.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   ProjectGlobalBackendBucketName backendBucket = ProjectGlobalBackendBucketName.of("[PROJECT]", "[BACKEND_BUCKET]");
   Operation response = backendBucketClient.deleteBackendBucket(backendBucket.toString());
 }
 

Parameters:

backendBucket - Name of the BackendBucket resource to delete.

Throws:

ApiException - if the remote call fails

deleteBackendBucket

@BetaApi
public final Operation deleteBackendBucket(DeleteBackendBucketHttpRequest request)

Deletes the specified BackendBucket resource.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   String formattedBackendBucket = ProjectGlobalBackendBucketName.format("[PROJECT]", "[BACKEND_BUCKET]");
   DeleteBackendBucketHttpRequest request = DeleteBackendBucketHttpRequest.newBuilder()
     .setBackendBucket(formattedBackendBucket)
     .build();
   Operation response = backendBucketClient.deleteBackendBucket(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

deleteBackendBucketCallable

@BetaApi
public final UnaryCallable<DeleteBackendBucketHttpRequest,Operation> deleteBackendBucketCallable()

Deletes the specified BackendBucket resource.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   String formattedBackendBucket = ProjectGlobalBackendBucketName.format("[PROJECT]", "[BACKEND_BUCKET]");
   DeleteBackendBucketHttpRequest request = DeleteBackendBucketHttpRequest.newBuilder()
     .setBackendBucket(formattedBackendBucket)
     .build();
   ApiFuture<Operation> future = backendBucketClient.deleteBackendBucketCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

deleteSignedUrlKeyBackendBucket

@BetaApi
public final Operation deleteSignedUrlKeyBackendBucket(ProjectGlobalBackendBucketName backendBucket,
                                                                String keyName)

Deletes a key for validating requests with signed URLs for this backend bucket.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   ProjectGlobalBackendBucketName backendBucket = ProjectGlobalBackendBucketName.of("[PROJECT]", "[BACKEND_BUCKET]");
   String keyName = "";
   Operation response = backendBucketClient.deleteSignedUrlKeyBackendBucket(backendBucket, keyName);
 }
 

Parameters:

backendBucket - Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035.

keyName - The name of the Signed URL Key to delete.

Throws:

ApiException - if the remote call fails

deleteSignedUrlKeyBackendBucket

@BetaApi
public final Operation deleteSignedUrlKeyBackendBucket(String backendBucket,
                                                                String keyName)

Deletes a key for validating requests with signed URLs for this backend bucket.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   ProjectGlobalBackendBucketName backendBucket = ProjectGlobalBackendBucketName.of("[PROJECT]", "[BACKEND_BUCKET]");
   String keyName = "";
   Operation response = backendBucketClient.deleteSignedUrlKeyBackendBucket(backendBucket.toString(), keyName);
 }
 

Parameters:

backendBucket - Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035.

keyName - The name of the Signed URL Key to delete.

Throws:

ApiException - if the remote call fails

deleteSignedUrlKeyBackendBucket

@BetaApi
public final Operation deleteSignedUrlKeyBackendBucket(DeleteSignedUrlKeyBackendBucketHttpRequest request)

Deletes a key for validating requests with signed URLs for this backend bucket.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   String formattedBackendBucket = ProjectGlobalBackendBucketName.format("[PROJECT]", "[BACKEND_BUCKET]");
   String keyName = "";
   DeleteSignedUrlKeyBackendBucketHttpRequest request = DeleteSignedUrlKeyBackendBucketHttpRequest.newBuilder()
     .setBackendBucket(formattedBackendBucket)
     .setKeyName(keyName)
     .build();
   Operation response = backendBucketClient.deleteSignedUrlKeyBackendBucket(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

deleteSignedUrlKeyBackendBucketCallable

@BetaApi
public final UnaryCallable<DeleteSignedUrlKeyBackendBucketHttpRequest,Operation> deleteSignedUrlKeyBackendBucketCallable()

Deletes a key for validating requests with signed URLs for this backend bucket.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   String formattedBackendBucket = ProjectGlobalBackendBucketName.format("[PROJECT]", "[BACKEND_BUCKET]");
   String keyName = "";
   DeleteSignedUrlKeyBackendBucketHttpRequest request = DeleteSignedUrlKeyBackendBucketHttpRequest.newBuilder()
     .setBackendBucket(formattedBackendBucket)
     .setKeyName(keyName)
     .build();
   ApiFuture<Operation> future = backendBucketClient.deleteSignedUrlKeyBackendBucketCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

getBackendBucket

@BetaApi
public final BackendBucket getBackendBucket(ProjectGlobalBackendBucketName backendBucket)

Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   ProjectGlobalBackendBucketName backendBucket = ProjectGlobalBackendBucketName.of("[PROJECT]", "[BACKEND_BUCKET]");
   BackendBucket response = backendBucketClient.getBackendBucket(backendBucket);
 }
 

Parameters:

backendBucket - Name of the BackendBucket resource to return.

Throws:

ApiException - if the remote call fails

getBackendBucket

@BetaApi
public final BackendBucket getBackendBucket(String backendBucket)

Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   ProjectGlobalBackendBucketName backendBucket = ProjectGlobalBackendBucketName.of("[PROJECT]", "[BACKEND_BUCKET]");
   BackendBucket response = backendBucketClient.getBackendBucket(backendBucket.toString());
 }
 

Parameters:

backendBucket - Name of the BackendBucket resource to return.

Throws:

ApiException - if the remote call fails

getBackendBucket

@BetaApi
public final BackendBucket getBackendBucket(GetBackendBucketHttpRequest request)

Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   String formattedBackendBucket = ProjectGlobalBackendBucketName.format("[PROJECT]", "[BACKEND_BUCKET]");
   GetBackendBucketHttpRequest request = GetBackendBucketHttpRequest.newBuilder()
     .setBackendBucket(formattedBackendBucket)
     .build();
   BackendBucket response = backendBucketClient.getBackendBucket(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

getBackendBucketCallable

@BetaApi
public final UnaryCallable<GetBackendBucketHttpRequest,BackendBucket> getBackendBucketCallable()

Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   String formattedBackendBucket = ProjectGlobalBackendBucketName.format("[PROJECT]", "[BACKEND_BUCKET]");
   GetBackendBucketHttpRequest request = GetBackendBucketHttpRequest.newBuilder()
     .setBackendBucket(formattedBackendBucket)
     .build();
   ApiFuture<BackendBucket> future = backendBucketClient.getBackendBucketCallable().futureCall(request);
   // Do something
   BackendBucket response = future.get();
 }
 

insertBackendBucket

@BetaApi
public final Operation insertBackendBucket(ProjectName project,
                                                    BackendBucket backendBucketResource)

Creates a BackendBucket resource in the specified project using the data included in the request.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   BackendBucket backendBucketResource = BackendBucket.newBuilder().build();
   Operation response = backendBucketClient.insertBackendBucket(project, backendBucketResource);
 }
 

Parameters:

project - Project ID for this request.

backendBucketResource - A BackendBucket resource. This resource defines a Cloud Storage bucket.

Throws:

ApiException - if the remote call fails

insertBackendBucket

@BetaApi
public final Operation insertBackendBucket(String project,
                                                    BackendBucket backendBucketResource)

Creates a BackendBucket resource in the specified project using the data included in the request.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   BackendBucket backendBucketResource = BackendBucket.newBuilder().build();
   Operation response = backendBucketClient.insertBackendBucket(project.toString(), backendBucketResource);
 }
 

Parameters:

project - Project ID for this request.

backendBucketResource - A BackendBucket resource. This resource defines a Cloud Storage bucket.

Throws:

ApiException - if the remote call fails

insertBackendBucket

@BetaApi
public final Operation insertBackendBucket(InsertBackendBucketHttpRequest request)

Creates a BackendBucket resource in the specified project using the data included in the request.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   BackendBucket backendBucketResource = BackendBucket.newBuilder().build();
   InsertBackendBucketHttpRequest request = InsertBackendBucketHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setBackendBucketResource(backendBucketResource)
     .build();
   Operation response = backendBucketClient.insertBackendBucket(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

insertBackendBucketCallable

@BetaApi
public final UnaryCallable<InsertBackendBucketHttpRequest,Operation> insertBackendBucketCallable()

Creates a BackendBucket resource in the specified project using the data included in the request.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   BackendBucket backendBucketResource = BackendBucket.newBuilder().build();
   InsertBackendBucketHttpRequest request = InsertBackendBucketHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setBackendBucketResource(backendBucketResource)
     .build();
   ApiFuture<Operation> future = backendBucketClient.insertBackendBucketCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

listBackendBuckets

@BetaApi
public final BackendBucketClient.ListBackendBucketsPagedResponse listBackendBuckets(ProjectName project)

Retrieves the list of BackendBucket resources available to the specified project.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (BackendBucket element : backendBucketClient.listBackendBuckets(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

ApiException - if the remote call fails

listBackendBuckets

@BetaApi
public final BackendBucketClient.ListBackendBucketsPagedResponse listBackendBuckets(String project)

Retrieves the list of BackendBucket resources available to the specified project.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (BackendBucket element : backendBucketClient.listBackendBuckets(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

ApiException - if the remote call fails

listBackendBuckets

@BetaApi
public final BackendBucketClient.ListBackendBucketsPagedResponse listBackendBuckets(ListBackendBucketsHttpRequest request)

Retrieves the list of BackendBucket resources available to the specified project.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListBackendBucketsHttpRequest request = ListBackendBucketsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (BackendBucket element : backendBucketClient.listBackendBuckets(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

listBackendBucketsPagedCallable

@BetaApi
public final UnaryCallable<ListBackendBucketsHttpRequest,BackendBucketClient.ListBackendBucketsPagedResponse> listBackendBucketsPagedCallable()

Retrieves the list of BackendBucket resources available to the specified project.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListBackendBucketsHttpRequest request = ListBackendBucketsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<ListBackendBucketsPagedResponse> future = backendBucketClient.listBackendBucketsPagedCallable().futureCall(request);
   // Do something
   for (BackendBucket element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listBackendBucketsCallable

@BetaApi
public final UnaryCallable<ListBackendBucketsHttpRequest,BackendBucketList> listBackendBucketsCallable()

Retrieves the list of BackendBucket resources available to the specified project.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListBackendBucketsHttpRequest request = ListBackendBucketsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     BackendBucketList response = backendBucketClient.listBackendBucketsCallable().call(request);
     for (BackendBucket element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

patchBackendBucket

@BetaApi
public final Operation patchBackendBucket(ProjectGlobalBackendBucketName backendBucket,
                                                   BackendBucket backendBucketResource,
                                                   List<String> fieldMask)

Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   ProjectGlobalBackendBucketName backendBucket = ProjectGlobalBackendBucketName.of("[PROJECT]", "[BACKEND_BUCKET]");
   BackendBucket backendBucketResource = BackendBucket.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = backendBucketClient.patchBackendBucket(backendBucket, backendBucketResource, fieldMask);
 }
 

Parameters:

backendBucket - Name of the BackendBucket resource to patch.

backendBucketResource - A BackendBucket resource. This resource defines a Cloud Storage bucket.

fieldMask - The fields that should be serialized (even if they have empty values). If the containing message object has a non-null fieldmask, then all the fields in the field mask (and only those fields in the field mask) will be serialized. If the containing object does not have a fieldmask, then only non-empty fields will be serialized.

Throws:

ApiException - if the remote call fails

patchBackendBucket

@BetaApi
public final Operation patchBackendBucket(String backendBucket,
                                                   BackendBucket backendBucketResource,
                                                   List<String> fieldMask)

Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   ProjectGlobalBackendBucketName backendBucket = ProjectGlobalBackendBucketName.of("[PROJECT]", "[BACKEND_BUCKET]");
   BackendBucket backendBucketResource = BackendBucket.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = backendBucketClient.patchBackendBucket(backendBucket.toString(), backendBucketResource, fieldMask);
 }
 

Parameters:

backendBucket - Name of the BackendBucket resource to patch.

backendBucketResource - A BackendBucket resource. This resource defines a Cloud Storage bucket.

fieldMask - The fields that should be serialized (even if they have empty values). If the containing message object has a non-null fieldmask, then all the fields in the field mask (and only those fields in the field mask) will be serialized. If the containing object does not have a fieldmask, then only non-empty fields will be serialized.

Throws:

ApiException - if the remote call fails

patchBackendBucket

@BetaApi
public final Operation patchBackendBucket(PatchBackendBucketHttpRequest request)

Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   String formattedBackendBucket = ProjectGlobalBackendBucketName.format("[PROJECT]", "[BACKEND_BUCKET]");
   BackendBucket backendBucketResource = BackendBucket.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   PatchBackendBucketHttpRequest request = PatchBackendBucketHttpRequest.newBuilder()
     .setBackendBucket(formattedBackendBucket)
     .setBackendBucketResource(backendBucketResource)
     .addAllFieldMask(fieldMask)
     .build();
   Operation response = backendBucketClient.patchBackendBucket(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

patchBackendBucketCallable

@BetaApi
public final UnaryCallable<PatchBackendBucketHttpRequest,Operation> patchBackendBucketCallable()

Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   String formattedBackendBucket = ProjectGlobalBackendBucketName.format("[PROJECT]", "[BACKEND_BUCKET]");
   BackendBucket backendBucketResource = BackendBucket.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   PatchBackendBucketHttpRequest request = PatchBackendBucketHttpRequest.newBuilder()
     .setBackendBucket(formattedBackendBucket)
     .setBackendBucketResource(backendBucketResource)
     .addAllFieldMask(fieldMask)
     .build();
   ApiFuture<Operation> future = backendBucketClient.patchBackendBucketCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

updateBackendBucket

@BetaApi
public final Operation updateBackendBucket(ProjectGlobalBackendBucketName backendBucket,
                                                    BackendBucket backendBucketResource,
                                                    List<String> fieldMask)

Updates the specified BackendBucket resource with the data included in the request.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   ProjectGlobalBackendBucketName backendBucket = ProjectGlobalBackendBucketName.of("[PROJECT]", "[BACKEND_BUCKET]");
   BackendBucket backendBucketResource = BackendBucket.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = backendBucketClient.updateBackendBucket(backendBucket, backendBucketResource, fieldMask);
 }
 

Parameters:

backendBucket - Name of the BackendBucket resource to update.

backendBucketResource - A BackendBucket resource. This resource defines a Cloud Storage bucket.

fieldMask - The fields that should be serialized (even if they have empty values). If the containing message object has a non-null fieldmask, then all the fields in the field mask (and only those fields in the field mask) will be serialized. If the containing object does not have a fieldmask, then only non-empty fields will be serialized.

Throws:

ApiException - if the remote call fails

updateBackendBucket

@BetaApi
public final Operation updateBackendBucket(String backendBucket,
                                                    BackendBucket backendBucketResource,
                                                    List<String> fieldMask)

Updates the specified BackendBucket resource with the data included in the request.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   ProjectGlobalBackendBucketName backendBucket = ProjectGlobalBackendBucketName.of("[PROJECT]", "[BACKEND_BUCKET]");
   BackendBucket backendBucketResource = BackendBucket.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = backendBucketClient.updateBackendBucket(backendBucket.toString(), backendBucketResource, fieldMask);
 }
 

Parameters:

backendBucket - Name of the BackendBucket resource to update.

backendBucketResource - A BackendBucket resource. This resource defines a Cloud Storage bucket.

fieldMask - The fields that should be serialized (even if they have empty values). If the containing message object has a non-null fieldmask, then all the fields in the field mask (and only those fields in the field mask) will be serialized. If the containing object does not have a fieldmask, then only non-empty fields will be serialized.

Throws:

ApiException - if the remote call fails

updateBackendBucket

@BetaApi
public final Operation updateBackendBucket(UpdateBackendBucketHttpRequest request)

Updates the specified BackendBucket resource with the data included in the request.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   String formattedBackendBucket = ProjectGlobalBackendBucketName.format("[PROJECT]", "[BACKEND_BUCKET]");
   BackendBucket backendBucketResource = BackendBucket.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   UpdateBackendBucketHttpRequest request = UpdateBackendBucketHttpRequest.newBuilder()
     .setBackendBucket(formattedBackendBucket)
     .setBackendBucketResource(backendBucketResource)
     .addAllFieldMask(fieldMask)
     .build();
   Operation response = backendBucketClient.updateBackendBucket(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

updateBackendBucketCallable

@BetaApi
public final UnaryCallable<UpdateBackendBucketHttpRequest,Operation> updateBackendBucketCallable()

Updates the specified BackendBucket resource with the data included in the request.

Sample code:

 try (BackendBucketClient backendBucketClient = BackendBucketClient.create()) {
   String formattedBackendBucket = ProjectGlobalBackendBucketName.format("[PROJECT]", "[BACKEND_BUCKET]");
   BackendBucket backendBucketResource = BackendBucket.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   UpdateBackendBucketHttpRequest request = UpdateBackendBucketHttpRequest.newBuilder()
     .setBackendBucket(formattedBackendBucket)
     .setBackendBucketResource(backendBucketResource)
     .addAllFieldMask(fieldMask)
     .build();
   ApiFuture<Operation> future = backendBucketClient.updateBackendBucketCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface BackgroundResource

Throws:

InterruptedException