Class BackendBucketsClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, AutoCloseable

    @Generated("by gapic-generator-java")
    public class BackendBucketsClient
    extends Object
    implements com.google.api.gax.core.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 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().

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

    • Constructor Detail

      • BackendBucketsClient

        protected BackendBucketsClient​(BackendBucketsSettings settings)
                                throws IOException
        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.
        Throws:
        IOException
    • Method Detail

      • create

        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).
      • addSignedUrlKeyAsync

        public final com.google.api.gax.longrunning.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:
        project - Project ID for this request.
        backendBucket - Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035.
        signedUrlKeyResource - The body resource for this request
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • addSignedUrlKeyAsync

        @BetaApi("The surface for long-running operations is not stable yet and may change in the future.")
        public final com.google.api.gax.longrunning.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();
         }
         
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • addSignedUrlKeyOperationCallable

        public final com.google.api.gax.rpc.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();
         }
         
      • addSignedUrlKeyCallable

        public final com.google.api.gax.rpc.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();
         }
         
      • deleteAsync

        public final com.google.api.gax.longrunning.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:
        project - Project ID for this request.
        backendBucket - Name of the BackendBucket resource to delete.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • deleteAsync

        @BetaApi("The surface for long-running operations is not stable yet and may change in the future.")
        public final com.google.api.gax.longrunning.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();
         }
         
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • deleteOperationCallable

        public final com.google.api.gax.rpc.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();
         }
         
      • deleteCallable

        public final com.google.api.gax.rpc.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();
         }
         
      • deleteSignedUrlKeyAsync

        public final com.google.api.gax.longrunning.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:
        project - Project ID for this request.
        backendBucket - Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035.
        keyName - The name of the Signed URL Key to delete.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • deleteSignedUrlKeyAsync

        @BetaApi("The surface for long-running operations is not stable yet and may change in the future.")
        public final com.google.api.gax.longrunning.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();
         }
         
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • deleteSignedUrlKeyOperationCallable

        public final com.google.api.gax.rpc.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();
         }
         
      • deleteSignedUrlKeyCallable

        public final com.google.api.gax.rpc.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();
         }
         
      • get

        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:
        project - Project ID for this request.
        backendBucket - Name of the BackendBucket resource to return.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • get

        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);
         }
         
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • getCallable

        public final com.google.api.gax.rpc.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();
         }
         
      • insertAsync

        public final com.google.api.gax.longrunning.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:
        project - Project ID for this request.
        backendBucketResource - The body resource for this request
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • insertAsync

        @BetaApi("The surface for long-running operations is not stable yet and may change in the future.")
        public final com.google.api.gax.longrunning.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();
         }
         
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • insertOperationCallable

        public final com.google.api.gax.rpc.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();
         }
         
      • insertCallable

        public final com.google.api.gax.rpc.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();
         }
         
      • list

        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);
           }
         }
         
        Parameters:
        project - Project ID for this request.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • list

        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);
           }
         }
         
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • listPagedCallable

        public final com.google.api.gax.rpc.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);
           }
         }
         
      • listCallable

        public final com.google.api.gax.rpc.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;
             }
           }
         }
         
      • patchAsync

        public final com.google.api.gax.longrunning.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:
        project - Project ID for this request.
        backendBucket - Name of the BackendBucket resource to patch.
        backendBucketResource - The body resource for this request
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • patchAsync

        @BetaApi("The surface for long-running operations is not stable yet and may change in the future.")
        public final com.google.api.gax.longrunning.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();
         }
         
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • patchOperationCallable

        public final com.google.api.gax.rpc.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();
         }
         
      • patchCallable

        public final com.google.api.gax.rpc.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();
         }
         
      • setEdgeSecurityPolicyAsync

        public final com.google.api.gax.longrunning.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:
        project - Project ID for this request.
        backendBucket - Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035.
        securityPolicyReferenceResource - The body resource for this request
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • setEdgeSecurityPolicyAsync

        @BetaApi("The surface for long-running operations is not stable yet and may change in the future.")
        public final com.google.api.gax.longrunning.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();
         }
         
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • setEdgeSecurityPolicyOperationCallable

        public final com.google.api.gax.rpc.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();
         }
         
      • setEdgeSecurityPolicyCallable

        public final com.google.api.gax.rpc.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();
         }
         
      • updateAsync

        public final com.google.api.gax.longrunning.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:
        project - Project ID for this request.
        backendBucket - Name of the BackendBucket resource to update.
        backendBucketResource - The body resource for this request
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • updateAsync

        @BetaApi("The surface for long-running operations is not stable yet and may change in the future.")
        public final com.google.api.gax.longrunning.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();
         }
         
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • updateOperationCallable

        public final com.google.api.gax.rpc.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();
         }
         
      • updateCallable

        public final com.google.api.gax.rpc.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();
         }
         
      • shutdown

        public void shutdown()
        Specified by:
        shutdown in interface com.google.api.gax.core.BackgroundResource
      • isShutdown

        public boolean isShutdown()
        Specified by:
        isShutdown in interface com.google.api.gax.core.BackgroundResource
      • isTerminated

        public boolean isTerminated()
        Specified by:
        isTerminated in interface com.google.api.gax.core.BackgroundResource
      • shutdownNow

        public void shutdownNow()
        Specified by:
        shutdownNow in interface com.google.api.gax.core.BackgroundResource