Class BackendBucketsClient (1.11.0)

Version 1.11.0

• 1.63.0 (latest)
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public class BackendBucketsClient implements BackgroundResource

Service Description: The BackendBuckets API.

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   String project = "project-309310695";
   String backendBucket = "backendBucket713751966";
   BackendBucket response = backendBucketsClient.get(project, backendBucket);
 }
 

Note: close() needs to be called on the BackendBucketsClient 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 BackendBucketsSettings to create(). For example:

To customize credentials:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 BackendBucketsSettings backendBucketsSettings =
     BackendBucketsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 BackendBucketsClient backendBucketsClient = BackendBucketsClient.create(backendBucketsSettings);
 

To customize the endpoint:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 BackendBucketsSettings backendBucketsSettings =
     BackendBucketsSettings.newBuilder().setEndpoint(myEndpoint).build();
 BackendBucketsClient backendBucketsClient = BackendBucketsClient.create(backendBucketsSettings);
 

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

Inheritance

java.lang.Object > BackendBucketsClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final BackendBucketsClient create()

Constructs an instance of BackendBucketsClient with default settings.

Returns

Type	Description
BackendBucketsClient

Exceptions

Type	Description
IOException

create(BackendBucketsSettings settings)

public static final BackendBucketsClient create(BackendBucketsSettings settings)

Constructs an instance of BackendBucketsClient, 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	BackendBucketsSettings

Returns

Type	Description
BackendBucketsClient

Exceptions

Type	Description
IOException

create(BackendBucketsStub stub)

public static final BackendBucketsClient create(BackendBucketsStub stub)

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

Parameter

Name	Description
stub	BackendBucketsStub

Returns

Type	Description
BackendBucketsClient

Constructors

BackendBucketsClient(BackendBucketsSettings settings)

protected BackendBucketsClient(BackendBucketsSettings settings)

Constructs an instance of BackendBucketsClient, 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	BackendBucketsSettings

BackendBucketsClient(BackendBucketsStub stub)

protected BackendBucketsClient(BackendBucketsStub stub)

Parameter

Name	Description
stub	BackendBucketsStub

Methods

addSignedUrlKeyAsync(AddSignedUrlKeyBackendBucketRequest request)

public final OperationFuture<Operation,Operation> addSignedUrlKeyAsync(AddSignedUrlKeyBackendBucketRequest request)

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   AddSignedUrlKeyBackendBucketRequest request =
       AddSignedUrlKeyBackendBucketRequest.newBuilder()
           .setBackendBucket("backendBucket713751966")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSignedUrlKeyResource(SignedUrlKey.newBuilder().build())
           .build();
   Operation response = backendBucketsClient.addSignedUrlKeyAsync(request).get();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

addSignedUrlKeyAsync(String project, String backendBucket, SignedUrlKey signedUrlKeyResource)

public final OperationFuture<Operation,Operation> addSignedUrlKeyAsync(String project, String backendBucket, SignedUrlKey signedUrlKeyResource)

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   String project = "project-309310695";
   String backendBucket = "backendBucket713751966";
   SignedUrlKey signedUrlKeyResource = SignedUrlKey.newBuilder().build();
   Operation response =
       backendBucketsClient
           .addSignedUrlKeyAsync(project, backendBucket, signedUrlKeyResource)
           .get();
 }
 

Parameters

Name	Description
project	String Project ID for this request.
backendBucket	String Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035.
signedUrlKeyResource	SignedUrlKey The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

addSignedUrlKeyCallable()

public final UnaryCallable<AddSignedUrlKeyBackendBucketRequest,Operation> addSignedUrlKeyCallable()

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   AddSignedUrlKeyBackendBucketRequest request =
       AddSignedUrlKeyBackendBucketRequest.newBuilder()
           .setBackendBucket("backendBucket713751966")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSignedUrlKeyResource(SignedUrlKey.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       backendBucketsClient.addSignedUrlKeyCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<AddSignedUrlKeyBackendBucketRequest,Operation>

addSignedUrlKeyOperationCallable()

public final OperationCallable<AddSignedUrlKeyBackendBucketRequest,Operation,Operation> addSignedUrlKeyOperationCallable()

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   AddSignedUrlKeyBackendBucketRequest request =
       AddSignedUrlKeyBackendBucketRequest.newBuilder()
           .setBackendBucket("backendBucket713751966")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSignedUrlKeyResource(SignedUrlKey.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       backendBucketsClient.addSignedUrlKeyOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
OperationCallable<AddSignedUrlKeyBackendBucketRequest,Operation,Operation>

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

deleteAsync(DeleteBackendBucketRequest request)

public final OperationFuture<Operation,Operation> deleteAsync(DeleteBackendBucketRequest request)

Deletes the specified BackendBucket resource.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   DeleteBackendBucketRequest request =
       DeleteBackendBucketRequest.newBuilder()
           .setBackendBucket("backendBucket713751966")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   Operation response = backendBucketsClient.deleteAsync(request).get();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String backendBucket)

public final OperationFuture<Operation,Operation> deleteAsync(String project, String backendBucket)

Deletes the specified BackendBucket resource.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   String project = "project-309310695";
   String backendBucket = "backendBucket713751966";
   Operation response = backendBucketsClient.deleteAsync(project, backendBucket).get();
 }
 

Parameters

Name	Description
project	String Project ID for this request.
backendBucket	String Name of the BackendBucket resource to delete.

Returns

Type	Description
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteBackendBucketRequest,Operation> deleteCallable()

Deletes the specified BackendBucket resource.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   DeleteBackendBucketRequest request =
       DeleteBackendBucketRequest.newBuilder()
           .setBackendBucket("backendBucket713751966")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = backendBucketsClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<DeleteBackendBucketRequest,Operation>

deleteOperationCallable()

public final OperationCallable<DeleteBackendBucketRequest,Operation,Operation> deleteOperationCallable()

Deletes the specified BackendBucket resource.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   DeleteBackendBucketRequest request =
       DeleteBackendBucketRequest.newBuilder()
           .setBackendBucket("backendBucket713751966")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       backendBucketsClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
OperationCallable<DeleteBackendBucketRequest,Operation,Operation>

deleteSignedUrlKeyAsync(DeleteSignedUrlKeyBackendBucketRequest request)

public final OperationFuture<Operation,Operation> deleteSignedUrlKeyAsync(DeleteSignedUrlKeyBackendBucketRequest request)

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   DeleteSignedUrlKeyBackendBucketRequest request =
       DeleteSignedUrlKeyBackendBucketRequest.newBuilder()
           .setBackendBucket("backendBucket713751966")
           .setKeyName("keyName-815643254")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   Operation response = backendBucketsClient.deleteSignedUrlKeyAsync(request).get();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

deleteSignedUrlKeyAsync(String project, String backendBucket, String keyName)

public final OperationFuture<Operation,Operation> deleteSignedUrlKeyAsync(String project, String backendBucket, String keyName)

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   String project = "project-309310695";
   String backendBucket = "backendBucket713751966";
   String keyName = "keyName-815643254";
   Operation response =
       backendBucketsClient.deleteSignedUrlKeyAsync(project, backendBucket, keyName).get();
 }
 

Parameters

Name	Description
project	String Project ID for this request.
backendBucket	String Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035.
keyName	String The name of the Signed URL Key to delete.

Returns

Type	Description
OperationFuture<Operation,Operation>

deleteSignedUrlKeyCallable()

public final UnaryCallable<DeleteSignedUrlKeyBackendBucketRequest,Operation> deleteSignedUrlKeyCallable()

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   DeleteSignedUrlKeyBackendBucketRequest request =
       DeleteSignedUrlKeyBackendBucketRequest.newBuilder()
           .setBackendBucket("backendBucket713751966")
           .setKeyName("keyName-815643254")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       backendBucketsClient.deleteSignedUrlKeyCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<DeleteSignedUrlKeyBackendBucketRequest,Operation>

deleteSignedUrlKeyOperationCallable()

public final OperationCallable<DeleteSignedUrlKeyBackendBucketRequest,Operation,Operation> deleteSignedUrlKeyOperationCallable()

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   DeleteSignedUrlKeyBackendBucketRequest request =
       DeleteSignedUrlKeyBackendBucketRequest.newBuilder()
           .setBackendBucket("backendBucket713751966")
           .setKeyName("keyName-815643254")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       backendBucketsClient.deleteSignedUrlKeyOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
OperationCallable<DeleteSignedUrlKeyBackendBucketRequest,Operation,Operation>

get(GetBackendBucketRequest request)

public final BackendBucket get(GetBackendBucketRequest request)

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   GetBackendBucketRequest request =
       GetBackendBucketRequest.newBuilder()
           .setBackendBucket("backendBucket713751966")
           .setProject("project-309310695")
           .build();
   BackendBucket response = backendBucketsClient.get(request);
 }
 

Parameter

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

Returns

Type	Description
BackendBucket

get(String project, String backendBucket)

public final BackendBucket get(String project, String backendBucket)

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   String project = "project-309310695";
   String backendBucket = "backendBucket713751966";
   BackendBucket response = backendBucketsClient.get(project, backendBucket);
 }
 

Parameters

Name	Description
project	String Project ID for this request.
backendBucket	String Name of the BackendBucket resource to return.

Returns

Type	Description
BackendBucket

getCallable()

public final UnaryCallable<GetBackendBucketRequest,BackendBucket> getCallable()

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   GetBackendBucketRequest request =
       GetBackendBucketRequest.newBuilder()
           .setBackendBucket("backendBucket713751966")
           .setProject("project-309310695")
           .build();
   ApiFuture<BackendBucket> future = backendBucketsClient.getCallable().futureCall(request);
   // Do something.
   BackendBucket response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<GetBackendBucketRequest,BackendBucket>

getSettings()

public final BackendBucketsSettings getSettings()

Returns

Type	Description
BackendBucketsSettings

getStub()

public BackendBucketsStub getStub()

Returns

Type	Description
BackendBucketsStub

insertAsync(InsertBackendBucketRequest request)

public final OperationFuture<Operation,Operation> insertAsync(InsertBackendBucketRequest request)

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   InsertBackendBucketRequest request =
       InsertBackendBucketRequest.newBuilder()
           .setBackendBucketResource(BackendBucket.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   Operation response = backendBucketsClient.insertAsync(request).get();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

insertAsync(String project, BackendBucket backendBucketResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, BackendBucket backendBucketResource)

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   String project = "project-309310695";
   BackendBucket backendBucketResource = BackendBucket.newBuilder().build();
   Operation response = backendBucketsClient.insertAsync(project, backendBucketResource).get();
 }
 

Parameters

Name	Description
project	String Project ID for this request.
backendBucketResource	BackendBucket The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertBackendBucketRequest,Operation> insertCallable()

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   InsertBackendBucketRequest request =
       InsertBackendBucketRequest.newBuilder()
           .setBackendBucketResource(BackendBucket.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = backendBucketsClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<InsertBackendBucketRequest,Operation>

insertOperationCallable()

public final OperationCallable<InsertBackendBucketRequest,Operation,Operation> insertOperationCallable()

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   InsertBackendBucketRequest request =
       InsertBackendBucketRequest.newBuilder()
           .setBackendBucketResource(BackendBucket.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       backendBucketsClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
OperationCallable<InsertBackendBucketRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

list(ListBackendBucketsRequest request)

public final BackendBucketsClient.ListPagedResponse list(ListBackendBucketsRequest request)

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   ListBackendBucketsRequest request =
       ListBackendBucketsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (BackendBucket element : backendBucketsClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

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

Returns

Type	Description
BackendBucketsClient.ListPagedResponse

list(String project)

public final BackendBucketsClient.ListPagedResponse list(String project)

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   String project = "project-309310695";
   for (BackendBucket element : backendBucketsClient.list(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
project	String Project ID for this request.

Returns

Type	Description
BackendBucketsClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListBackendBucketsRequest,BackendBucketList> listCallable()

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   ListBackendBucketsRequest request =
       ListBackendBucketsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     BackendBucketList response = backendBucketsClient.listCallable().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;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListBackendBucketsRequest,BackendBucketList>

listPagedCallable()

public final UnaryCallable<ListBackendBucketsRequest,BackendBucketsClient.ListPagedResponse> listPagedCallable()

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   ListBackendBucketsRequest request =
       ListBackendBucketsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<BackendBucket> future =
       backendBucketsClient.listPagedCallable().futureCall(request);
   // Do something.
   for (BackendBucket element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListBackendBucketsRequest,ListPagedResponse>

patchAsync(PatchBackendBucketRequest request)

public final OperationFuture<Operation,Operation> patchAsync(PatchBackendBucketRequest 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:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   PatchBackendBucketRequest request =
       PatchBackendBucketRequest.newBuilder()
           .setBackendBucket("backendBucket713751966")
           .setBackendBucketResource(BackendBucket.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   Operation response = backendBucketsClient.patchAsync(request).get();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

patchAsync(String project, String backendBucket, BackendBucket backendBucketResource)

public final OperationFuture<Operation,Operation> patchAsync(String project, String backendBucket, BackendBucket backendBucketResource)

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:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   String project = "project-309310695";
   String backendBucket = "backendBucket713751966";
   BackendBucket backendBucketResource = BackendBucket.newBuilder().build();
   Operation response =
       backendBucketsClient.patchAsync(project, backendBucket, backendBucketResource).get();
 }
 

Parameters

Name	Description
project	String Project ID for this request.
backendBucket	String Name of the BackendBucket resource to patch.
backendBucketResource	BackendBucket The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

patchCallable()

public final UnaryCallable<PatchBackendBucketRequest,Operation> patchCallable()

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:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   PatchBackendBucketRequest request =
       PatchBackendBucketRequest.newBuilder()
           .setBackendBucket("backendBucket713751966")
           .setBackendBucketResource(BackendBucket.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = backendBucketsClient.patchCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<PatchBackendBucketRequest,Operation>

patchOperationCallable()

public final OperationCallable<PatchBackendBucketRequest,Operation,Operation> patchOperationCallable()

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:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   PatchBackendBucketRequest request =
       PatchBackendBucketRequest.newBuilder()
           .setBackendBucket("backendBucket713751966")
           .setBackendBucketResource(BackendBucket.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       backendBucketsClient.patchOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
OperationCallable<PatchBackendBucketRequest,Operation,Operation>

setEdgeSecurityPolicyAsync(SetEdgeSecurityPolicyBackendBucketRequest request)

public final OperationFuture<Operation,Operation> setEdgeSecurityPolicyAsync(SetEdgeSecurityPolicyBackendBucketRequest request)

Sets the edge security policy for the specified backend bucket.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   SetEdgeSecurityPolicyBackendBucketRequest request =
       SetEdgeSecurityPolicyBackendBucketRequest.newBuilder()
           .setBackendBucket("backendBucket713751966")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSecurityPolicyReferenceResource(SecurityPolicyReference.newBuilder().build())
           .build();
   Operation response = backendBucketsClient.setEdgeSecurityPolicyAsync(request).get();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

setEdgeSecurityPolicyAsync(String project, String backendBucket, SecurityPolicyReference securityPolicyReferenceResource)

public final OperationFuture<Operation,Operation> setEdgeSecurityPolicyAsync(String project, String backendBucket, SecurityPolicyReference securityPolicyReferenceResource)

Sets the edge security policy for the specified backend bucket.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   String project = "project-309310695";
   String backendBucket = "backendBucket713751966";
   SecurityPolicyReference securityPolicyReferenceResource =
       SecurityPolicyReference.newBuilder().build();
   Operation response =
       backendBucketsClient
           .setEdgeSecurityPolicyAsync(project, backendBucket, securityPolicyReferenceResource)
           .get();
 }
 

Parameters

Name	Description
project	String Project ID for this request.
backendBucket	String Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035.
securityPolicyReferenceResource	SecurityPolicyReference The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

setEdgeSecurityPolicyCallable()

public final UnaryCallable<SetEdgeSecurityPolicyBackendBucketRequest,Operation> setEdgeSecurityPolicyCallable()

Sets the edge security policy for the specified backend bucket.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   SetEdgeSecurityPolicyBackendBucketRequest request =
       SetEdgeSecurityPolicyBackendBucketRequest.newBuilder()
           .setBackendBucket("backendBucket713751966")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSecurityPolicyReferenceResource(SecurityPolicyReference.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       backendBucketsClient.setEdgeSecurityPolicyCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<SetEdgeSecurityPolicyBackendBucketRequest,Operation>

setEdgeSecurityPolicyOperationCallable()

public final OperationCallable<SetEdgeSecurityPolicyBackendBucketRequest,Operation,Operation> setEdgeSecurityPolicyOperationCallable()

Sets the edge security policy for the specified backend bucket.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   SetEdgeSecurityPolicyBackendBucketRequest request =
       SetEdgeSecurityPolicyBackendBucketRequest.newBuilder()
           .setBackendBucket("backendBucket713751966")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSecurityPolicyReferenceResource(SecurityPolicyReference.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       backendBucketsClient.setEdgeSecurityPolicyOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
OperationCallable<SetEdgeSecurityPolicyBackendBucketRequest,Operation,Operation>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateAsync(UpdateBackendBucketRequest request)

public final OperationFuture<Operation,Operation> updateAsync(UpdateBackendBucketRequest request)

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   UpdateBackendBucketRequest request =
       UpdateBackendBucketRequest.newBuilder()
           .setBackendBucket("backendBucket713751966")
           .setBackendBucketResource(BackendBucket.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   Operation response = backendBucketsClient.updateAsync(request).get();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

updateAsync(String project, String backendBucket, BackendBucket backendBucketResource)

public final OperationFuture<Operation,Operation> updateAsync(String project, String backendBucket, BackendBucket backendBucketResource)

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   String project = "project-309310695";
   String backendBucket = "backendBucket713751966";
   BackendBucket backendBucketResource = BackendBucket.newBuilder().build();
   Operation response =
       backendBucketsClient.updateAsync(project, backendBucket, backendBucketResource).get();
 }
 

Parameters

Name	Description
project	String Project ID for this request.
backendBucket	String Name of the BackendBucket resource to update.
backendBucketResource	BackendBucket The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

updateCallable()

public final UnaryCallable<UpdateBackendBucketRequest,Operation> updateCallable()

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   UpdateBackendBucketRequest request =
       UpdateBackendBucketRequest.newBuilder()
           .setBackendBucket("backendBucket713751966")
           .setBackendBucketResource(BackendBucket.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = backendBucketsClient.updateCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<UpdateBackendBucketRequest,Operation>

updateOperationCallable()

public final OperationCallable<UpdateBackendBucketRequest,Operation,Operation> updateOperationCallable()

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   UpdateBackendBucketRequest request =
       UpdateBackendBucketRequest.newBuilder()
           .setBackendBucket("backendBucket713751966")
           .setBackendBucketResource(BackendBucket.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       backendBucketsClient.updateOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
OperationCallable<UpdateBackendBucketRequest,Operation,Operation>