Class BackendBucketsClient (1.65.0)

GitHub RepositoryProduct Reference

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

Methods
Method Description Method Variants

AddSignedUrlKey

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • addSignedUrlKeyAsync(AddSignedUrlKeyBackendBucketRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • addSignedUrlKeyAsync(String project, String backendBucket, SignedUrlKey signedUrlKeyResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • addSignedUrlKeyOperationCallable()

  • addSignedUrlKeyCallable()

Delete

Deletes the specified BackendBucket resource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteAsync(DeleteBackendBucketRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteAsync(String project, String backendBucket)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteOperationCallable()

  • deleteCallable()

DeleteSignedUrlKey

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteSignedUrlKeyAsync(DeleteSignedUrlKeyBackendBucketRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteSignedUrlKeyAsync(String project, String backendBucket, String keyName)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteSignedUrlKeyOperationCallable()

  • deleteSignedUrlKeyCallable()

Get

Returns the specified BackendBucket resource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • get(GetBackendBucketRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • get(String project, String backendBucket)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getCallable()

GetIamPolicy

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getIamPolicy(GetIamPolicyBackendBucketRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getIamPolicy(String project, String resource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getIamPolicyCallable()

Insert

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • insertAsync(InsertBackendBucketRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • insertAsync(String project, BackendBucket backendBucketResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • insertOperationCallable()

  • insertCallable()

List

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • list(ListBackendBucketsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • list(String project)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listPagedCallable()

  • listCallable()

Patch

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • patchAsync(PatchBackendBucketRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • patchAsync(String project, String backendBucket, BackendBucket backendBucketResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • patchOperationCallable()

  • patchCallable()

SetEdgeSecurityPolicy

Sets the edge security policy for the specified backend bucket.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • setEdgeSecurityPolicyAsync(SetEdgeSecurityPolicyBackendBucketRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • setEdgeSecurityPolicyAsync(String project, String backendBucket, SecurityPolicyReference securityPolicyReferenceResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • setEdgeSecurityPolicyOperationCallable()

  • setEdgeSecurityPolicyCallable()

SetIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • setIamPolicy(SetIamPolicyBackendBucketRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • setIamPolicy(String project, String resource, GlobalSetPolicyRequest globalSetPolicyRequestResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • setIamPolicyCallable()

TestIamPermissions

Returns permissions that a caller has on the specified resource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • testIamPermissions(TestIamPermissionsBackendBucketRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • testIamPermissions(String project, String resource, TestPermissionsRequest testPermissionsRequestResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • testIamPermissionsCallable()

Update

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateAsync(UpdateBackendBucketRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateAsync(String project, String backendBucket, BackendBucket backendBucketResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateOperationCallable()

  • updateCallable()

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 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
 BackendBucketsSettings backendBucketsSettings =
     BackendBucketsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 BackendBucketsClient backendBucketsClient = BackendBucketsClient.create(backendBucketsSettings);
 

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

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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>

getIamPolicy(GetIamPolicyBackendBucketRequest request)

public final Policy getIamPolicy(GetIamPolicyBackendBucketRequest request)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   GetIamPolicyBackendBucketRequest request =
       GetIamPolicyBackendBucketRequest.newBuilder()
           .setOptionsRequestedPolicyVersion(-574521795)
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .build();
   Policy response = backendBucketsClient.getIamPolicy(request);
 }
 
Parameter
Name Description
request GetIamPolicyBackendBucketRequest

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

Returns
Type Description
Policy

getIamPolicy(String project, String resource)

public final Policy getIamPolicy(String project, String resource)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   String project = "project-309310695";
   String resource = "resource-341064690";
   Policy response = backendBucketsClient.getIamPolicy(project, resource);
 }
 
Parameters
Name Description
project String

Project ID for this request.

resource String

Name or id of the resource for this request.

Returns
Type Description
Policy

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyBackendBucketRequest,Policy> getIamPolicyCallable()

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   GetIamPolicyBackendBucketRequest request =
       GetIamPolicyBackendBucketRequest.newBuilder()
           .setOptionsRequestedPolicyVersion(-574521795)
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .build();
   ApiFuture<Policy> future = backendBucketsClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetIamPolicyBackendBucketRequest,Policy>

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

setIamPolicy(SetIamPolicyBackendBucketRequest request)

public final Policy setIamPolicy(SetIamPolicyBackendBucketRequest request)

Sets the access control policy on the specified resource. Replaces any existing policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   SetIamPolicyBackendBucketRequest request =
       SetIamPolicyBackendBucketRequest.newBuilder()
           .setGlobalSetPolicyRequestResource(GlobalSetPolicyRequest.newBuilder().build())
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .build();
   Policy response = backendBucketsClient.setIamPolicy(request);
 }
 
Parameter
Name Description
request SetIamPolicyBackendBucketRequest

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

Returns
Type Description
Policy

setIamPolicy(String project, String resource, GlobalSetPolicyRequest globalSetPolicyRequestResource)

public final Policy setIamPolicy(String project, String resource, GlobalSetPolicyRequest globalSetPolicyRequestResource)

Sets the access control policy on the specified resource. Replaces any existing policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   String project = "project-309310695";
   String resource = "resource-341064690";
   GlobalSetPolicyRequest globalSetPolicyRequestResource =
       GlobalSetPolicyRequest.newBuilder().build();
   Policy response =
       backendBucketsClient.setIamPolicy(project, resource, globalSetPolicyRequestResource);
 }
 
Parameters
Name Description
project String

Project ID for this request.

resource String

Name or id of the resource for this request.

globalSetPolicyRequestResource GlobalSetPolicyRequest

The body resource for this request

Returns
Type Description
Policy

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyBackendBucketRequest,Policy> setIamPolicyCallable()

Sets the access control policy on the specified resource. Replaces any existing policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   SetIamPolicyBackendBucketRequest request =
       SetIamPolicyBackendBucketRequest.newBuilder()
           .setGlobalSetPolicyRequestResource(GlobalSetPolicyRequest.newBuilder().build())
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .build();
   ApiFuture<Policy> future = backendBucketsClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 
Returns
Type Description
UnaryCallable<SetIamPolicyBackendBucketRequest,Policy>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testIamPermissions(TestIamPermissionsBackendBucketRequest request)

public final TestPermissionsResponse testIamPermissions(TestIamPermissionsBackendBucketRequest request)

Returns permissions that a caller has on the specified resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   TestIamPermissionsBackendBucketRequest request =
       TestIamPermissionsBackendBucketRequest.newBuilder()
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build())
           .build();
   TestPermissionsResponse response = backendBucketsClient.testIamPermissions(request);
 }
 
Parameter
Name Description
request TestIamPermissionsBackendBucketRequest

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

Returns
Type Description
TestPermissionsResponse

testIamPermissions(String project, String resource, TestPermissionsRequest testPermissionsRequestResource)

public final TestPermissionsResponse testIamPermissions(String project, String resource, TestPermissionsRequest testPermissionsRequestResource)

Returns permissions that a caller has on the specified resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   String project = "project-309310695";
   String resource = "resource-341064690";
   TestPermissionsRequest testPermissionsRequestResource =
       TestPermissionsRequest.newBuilder().build();
   TestPermissionsResponse response =
       backendBucketsClient.testIamPermissions(
           project, resource, testPermissionsRequestResource);
 }
 
Parameters
Name Description
project String

Project ID for this request.

resource String

Name or id of the resource for this request.

testPermissionsRequestResource TestPermissionsRequest

The body resource for this request

Returns
Type Description
TestPermissionsResponse

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsBackendBucketRequest,TestPermissionsResponse> testIamPermissionsCallable()

Returns permissions that a caller has on the specified resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BackendBucketsClient backendBucketsClient = BackendBucketsClient.create()) {
   TestIamPermissionsBackendBucketRequest request =
       TestIamPermissionsBackendBucketRequest.newBuilder()
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build())
           .build();
   ApiFuture<TestPermissionsResponse> future =
       backendBucketsClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestPermissionsResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<TestIamPermissionsBackendBucketRequest,TestPermissionsResponse>

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