com.google.cloud.compute.v1

Class BackendServiceClient

java.lang.Object

com.google.cloud.compute.v1.BackendServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class BackendServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

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

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 
 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   ProjectGlobalBackendServiceName backendService = ProjectGlobalBackendServiceName.of("[PROJECT]", "[BACKEND_SERVICE]");
   SignedUrlKey signedUrlKeyResource = SignedUrlKey.newBuilder().build();
   Operation response = backendServiceClient.addSignedUrlKeyBackendService(backendService, signedUrlKeyResource);
 }
 
 

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

To customize credentials:

 
 BackendServiceSettings backendServiceSettings =
     BackendServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 BackendServiceClient backendServiceClient =
     BackendServiceClient.create(backendServiceSettings);
 
 

To customize the endpoint:

 
 BackendServiceSettings backendServiceSettings =
     BackendServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 BackendServiceClient backendServiceClient =
     BackendServiceClient.create(backendServiceSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BackendServiceClient.AggregatedListBackendServicesFixedSizeCollection
static class	BackendServiceClient.AggregatedListBackendServicesPage
static class	BackendServiceClient.AggregatedListBackendServicesPagedResponse
static class	BackendServiceClient.ListBackendServicesFixedSizeCollection
static class	BackendServiceClient.ListBackendServicesPage
static class	BackendServiceClient.ListBackendServicesPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BackendServiceClient(BackendServiceSettings settings) Constructs an instance of BackendServiceClient, using the given settings.
protected	BackendServiceClient(BackendServiceStub stub)

Method Summary

Modifier and Type	Method and Description
Operation	addSignedUrlKeyBackendService(AddSignedUrlKeyBackendServiceHttpRequest request) Adds a key for validating requests with signed URLs for this backend service.
Operation	addSignedUrlKeyBackendService(ProjectGlobalBackendServiceName backendService, SignedUrlKey signedUrlKeyResource) Adds a key for validating requests with signed URLs for this backend service.
Operation	addSignedUrlKeyBackendService(String backendService, SignedUrlKey signedUrlKeyResource) Adds a key for validating requests with signed URLs for this backend service.
com.google.api.gax.rpc.UnaryCallable<AddSignedUrlKeyBackendServiceHttpRequest,Operation>	addSignedUrlKeyBackendServiceCallable() Adds a key for validating requests with signed URLs for this backend service.
BackendServiceClient.AggregatedListBackendServicesPagedResponse	aggregatedListBackendServices(AggregatedListBackendServicesHttpRequest request) Retrieves the list of all BackendService resources, regional and global, available to the specified project.
BackendServiceClient.AggregatedListBackendServicesPagedResponse	aggregatedListBackendServices(ProjectName project) Retrieves the list of all BackendService resources, regional and global, available to the specified project.
BackendServiceClient.AggregatedListBackendServicesPagedResponse	aggregatedListBackendServices(String project) Retrieves the list of all BackendService resources, regional and global, available to the specified project.
com.google.api.gax.rpc.UnaryCallable<AggregatedListBackendServicesHttpRequest,BackendServiceAggregatedList>	aggregatedListBackendServicesCallable() Retrieves the list of all BackendService resources, regional and global, available to the specified project.
com.google.api.gax.rpc.UnaryCallable<AggregatedListBackendServicesHttpRequest,BackendServiceClient.AggregatedListBackendServicesPagedResponse>	aggregatedListBackendServicesPagedCallable() Retrieves the list of all BackendService resources, regional and global, available to the specified project.
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static BackendServiceClient	create() Constructs an instance of BackendServiceClient with default settings.
static BackendServiceClient	create(BackendServiceSettings settings) Constructs an instance of BackendServiceClient, using the given settings.
static BackendServiceClient	create(BackendServiceStub stub) Constructs an instance of BackendServiceClient, using the given stub for making calls.
Operation	deleteBackendService(DeleteBackendServiceHttpRequest request) Deletes the specified BackendService resource.
Operation	deleteBackendService(ProjectGlobalBackendServiceName backendService) Deletes the specified BackendService resource.
Operation	deleteBackendService(String backendService) Deletes the specified BackendService resource.
com.google.api.gax.rpc.UnaryCallable<DeleteBackendServiceHttpRequest,Operation>	deleteBackendServiceCallable() Deletes the specified BackendService resource.
Operation	deleteSignedUrlKeyBackendService(DeleteSignedUrlKeyBackendServiceHttpRequest request) Deletes a key for validating requests with signed URLs for this backend service.
Operation	deleteSignedUrlKeyBackendService(ProjectGlobalBackendServiceName backendService, String keyName) Deletes a key for validating requests with signed URLs for this backend service.
Operation	deleteSignedUrlKeyBackendService(String backendService, String keyName) Deletes a key for validating requests with signed URLs for this backend service.
com.google.api.gax.rpc.UnaryCallable<DeleteSignedUrlKeyBackendServiceHttpRequest,Operation>	deleteSignedUrlKeyBackendServiceCallable() Deletes a key for validating requests with signed URLs for this backend service.
BackendService	getBackendService(GetBackendServiceHttpRequest request) Returns the specified BackendService resource.
BackendService	getBackendService(ProjectGlobalBackendServiceName backendService) Returns the specified BackendService resource.
BackendService	getBackendService(String backendService) Returns the specified BackendService resource.
com.google.api.gax.rpc.UnaryCallable<GetBackendServiceHttpRequest,BackendService>	getBackendServiceCallable() Returns the specified BackendService resource.
BackendServiceGroupHealth	getHealthBackendService(GetHealthBackendServiceHttpRequest request) Gets the most recent health check results for this BackendService.
BackendServiceGroupHealth	getHealthBackendService(ProjectGlobalBackendServiceName backendService, ResourceGroupReference resourceGroupReferenceResource) Gets the most recent health check results for this BackendService.
BackendServiceGroupHealth	getHealthBackendService(String backendService, ResourceGroupReference resourceGroupReferenceResource) Gets the most recent health check results for this BackendService.
com.google.api.gax.rpc.UnaryCallable<GetHealthBackendServiceHttpRequest,BackendServiceGroupHealth>	getHealthBackendServiceCallable() Gets the most recent health check results for this BackendService.
BackendServiceSettings	getSettings()
BackendServiceStub	getStub()
Operation	insertBackendService(InsertBackendServiceHttpRequest request) Creates a BackendService resource in the specified project using the data included in the request.
Operation	insertBackendService(ProjectName project, BackendService backendServiceResource) Creates a BackendService resource in the specified project using the data included in the request.
Operation	insertBackendService(String project, BackendService backendServiceResource) Creates a BackendService resource in the specified project using the data included in the request.
com.google.api.gax.rpc.UnaryCallable<InsertBackendServiceHttpRequest,Operation>	insertBackendServiceCallable() Creates a BackendService resource in the specified project using the data included in the request.
boolean	isShutdown()
boolean	isTerminated()
BackendServiceClient.ListBackendServicesPagedResponse	listBackendServices(ListBackendServicesHttpRequest request) Retrieves the list of BackendService resources available to the specified project.
BackendServiceClient.ListBackendServicesPagedResponse	listBackendServices(ProjectName project) Retrieves the list of BackendService resources available to the specified project.
BackendServiceClient.ListBackendServicesPagedResponse	listBackendServices(String project) Retrieves the list of BackendService resources available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListBackendServicesHttpRequest,BackendServiceList>	listBackendServicesCallable() Retrieves the list of BackendService resources available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListBackendServicesHttpRequest,BackendServiceClient.ListBackendServicesPagedResponse>	listBackendServicesPagedCallable() Retrieves the list of BackendService resources available to the specified project.
Operation	patchBackendService(PatchBackendServiceHttpRequest request) Patches the specified BackendService resource with the data included in the request.
Operation	patchBackendService(ProjectGlobalBackendServiceName backendService, BackendService backendServiceResource, List<String> fieldMask) Patches the specified BackendService resource with the data included in the request.
Operation	patchBackendService(String backendService, BackendService backendServiceResource, List<String> fieldMask) Patches the specified BackendService resource with the data included in the request.
com.google.api.gax.rpc.UnaryCallable<PatchBackendServiceHttpRequest,Operation>	patchBackendServiceCallable() Patches the specified BackendService resource with the data included in the request.
Operation	setSecurityPolicyBackendService(ProjectGlobalBackendServiceName backendService, SecurityPolicyReference securityPolicyReferenceResource) Sets the security policy for the specified backend service.
Operation	setSecurityPolicyBackendService(SetSecurityPolicyBackendServiceHttpRequest request) Sets the security policy for the specified backend service.
Operation	setSecurityPolicyBackendService(String backendService, SecurityPolicyReference securityPolicyReferenceResource) Sets the security policy for the specified backend service.
com.google.api.gax.rpc.UnaryCallable<SetSecurityPolicyBackendServiceHttpRequest,Operation>	setSecurityPolicyBackendServiceCallable() Sets the security policy for the specified backend service.
void	shutdown()
void	shutdownNow()
Operation	updateBackendService(ProjectGlobalBackendServiceName backendService, BackendService backendServiceResource, List<String> fieldMask) Updates the specified BackendService resource with the data included in the request.
Operation	updateBackendService(String backendService, BackendService backendServiceResource, List<String> fieldMask) Updates the specified BackendService resource with the data included in the request.
Operation	updateBackendService(UpdateBackendServiceHttpRequest request) Updates the specified BackendService resource with the data included in the request.
com.google.api.gax.rpc.UnaryCallable<UpdateBackendServiceHttpRequest,Operation>	updateBackendServiceCallable() Updates the specified BackendService resource with the data included in the request.

Methods inherited from class java.lang.Object

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

Constructor Detail

BackendServiceClient

protected BackendServiceClient(BackendServiceSettings settings)
                        throws IOException

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

BackendServiceClient

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

Method Detail

create

public static final BackendServiceClient create()
                                         throws IOException

Constructs an instance of BackendServiceClient with default settings.

Throws:

IOException

create

public static final BackendServiceClient create(BackendServiceSettings settings)
                                         throws IOException

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

Throws:

IOException

create

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

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

getSettings

public final BackendServiceSettings getSettings()

getStub

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

addSignedUrlKeyBackendService

@BetaApi
public final Operation addSignedUrlKeyBackendService(ProjectGlobalBackendServiceName backendService,
                                                              SignedUrlKey signedUrlKeyResource)

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

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   ProjectGlobalBackendServiceName backendService = ProjectGlobalBackendServiceName.of("[PROJECT]", "[BACKEND_SERVICE]");
   SignedUrlKey signedUrlKeyResource = SignedUrlKey.newBuilder().build();
   Operation response = backendServiceClient.addSignedUrlKeyBackendService(backendService, signedUrlKeyResource);
 }
 

Parameters:

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

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

addSignedUrlKeyBackendService

@BetaApi
public final Operation addSignedUrlKeyBackendService(String backendService,
                                                              SignedUrlKey signedUrlKeyResource)

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

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   ProjectGlobalBackendServiceName backendService = ProjectGlobalBackendServiceName.of("[PROJECT]", "[BACKEND_SERVICE]");
   SignedUrlKey signedUrlKeyResource = SignedUrlKey.newBuilder().build();
   Operation response = backendServiceClient.addSignedUrlKeyBackendService(backendService.toString(), signedUrlKeyResource);
 }
 

Parameters:

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

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

addSignedUrlKeyBackendService

@BetaApi
public final Operation addSignedUrlKeyBackendService(AddSignedUrlKeyBackendServiceHttpRequest request)

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

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   String formattedBackendService = ProjectGlobalBackendServiceName.format("[PROJECT]", "[BACKEND_SERVICE]");
   SignedUrlKey signedUrlKeyResource = SignedUrlKey.newBuilder().build();
   AddSignedUrlKeyBackendServiceHttpRequest request = AddSignedUrlKeyBackendServiceHttpRequest.newBuilder()
     .setBackendService(formattedBackendService)
     .setSignedUrlKeyResource(signedUrlKeyResource)
     .build();
   Operation response = backendServiceClient.addSignedUrlKeyBackendService(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

addSignedUrlKeyBackendServiceCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<AddSignedUrlKeyBackendServiceHttpRequest,Operation> addSignedUrlKeyBackendServiceCallable()

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

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   String formattedBackendService = ProjectGlobalBackendServiceName.format("[PROJECT]", "[BACKEND_SERVICE]");
   SignedUrlKey signedUrlKeyResource = SignedUrlKey.newBuilder().build();
   AddSignedUrlKeyBackendServiceHttpRequest request = AddSignedUrlKeyBackendServiceHttpRequest.newBuilder()
     .setBackendService(formattedBackendService)
     .setSignedUrlKeyResource(signedUrlKeyResource)
     .build();
   ApiFuture<Operation> future = backendServiceClient.addSignedUrlKeyBackendServiceCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

aggregatedListBackendServices

@BetaApi
public final BackendServiceClient.AggregatedListBackendServicesPagedResponse aggregatedListBackendServices(ProjectName project)

Retrieves the list of all BackendService resources, regional and global, available to the specified project.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (BackendServicesScopedList element : backendServiceClient.aggregatedListBackendServices(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Name of the project scoping this request.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

aggregatedListBackendServices

@BetaApi
public final BackendServiceClient.AggregatedListBackendServicesPagedResponse aggregatedListBackendServices(String project)

Retrieves the list of all BackendService resources, regional and global, available to the specified project.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (BackendServicesScopedList element : backendServiceClient.aggregatedListBackendServices(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Name of the project scoping this request.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

aggregatedListBackendServices

@BetaApi
public final BackendServiceClient.AggregatedListBackendServicesPagedResponse aggregatedListBackendServices(AggregatedListBackendServicesHttpRequest request)

Retrieves the list of all BackendService resources, regional and global, available to the specified project.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListBackendServicesHttpRequest request = AggregatedListBackendServicesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (BackendServicesScopedList element : backendServiceClient.aggregatedListBackendServices(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

aggregatedListBackendServicesPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListBackendServicesHttpRequest,BackendServiceClient.AggregatedListBackendServicesPagedResponse> aggregatedListBackendServicesPagedCallable()

Retrieves the list of all BackendService resources, regional and global, available to the specified project.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListBackendServicesHttpRequest request = AggregatedListBackendServicesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<AggregatedListBackendServicesPagedResponse> future = backendServiceClient.aggregatedListBackendServicesPagedCallable().futureCall(request);
   // Do something
   for (BackendServicesScopedList element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

aggregatedListBackendServicesCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListBackendServicesHttpRequest,BackendServiceAggregatedList> aggregatedListBackendServicesCallable()

Retrieves the list of all BackendService resources, regional and global, available to the specified project.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListBackendServicesHttpRequest request = AggregatedListBackendServicesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     BackendServiceAggregatedList response = backendServiceClient.aggregatedListBackendServicesCallable().call(request);
     for (BackendServicesScopedList element : response.getItemsMap()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

deleteBackendService

@BetaApi
public final Operation deleteBackendService(ProjectGlobalBackendServiceName backendService)

Deletes the specified BackendService resource.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   ProjectGlobalBackendServiceName backendService = ProjectGlobalBackendServiceName.of("[PROJECT]", "[BACKEND_SERVICE]");
   Operation response = backendServiceClient.deleteBackendService(backendService);
 }
 

Parameters:

backendService - Name of the BackendService resource to delete.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteBackendService

@BetaApi
public final Operation deleteBackendService(String backendService)

Deletes the specified BackendService resource.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   ProjectGlobalBackendServiceName backendService = ProjectGlobalBackendServiceName.of("[PROJECT]", "[BACKEND_SERVICE]");
   Operation response = backendServiceClient.deleteBackendService(backendService.toString());
 }
 

Parameters:

backendService - Name of the BackendService resource to delete.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteBackendService

@BetaApi
public final Operation deleteBackendService(DeleteBackendServiceHttpRequest request)

Deletes the specified BackendService resource.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   String formattedBackendService = ProjectGlobalBackendServiceName.format("[PROJECT]", "[BACKEND_SERVICE]");
   DeleteBackendServiceHttpRequest request = DeleteBackendServiceHttpRequest.newBuilder()
     .setBackendService(formattedBackendService)
     .build();
   Operation response = backendServiceClient.deleteBackendService(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

deleteBackendServiceCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<DeleteBackendServiceHttpRequest,Operation> deleteBackendServiceCallable()

Deletes the specified BackendService resource.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   String formattedBackendService = ProjectGlobalBackendServiceName.format("[PROJECT]", "[BACKEND_SERVICE]");
   DeleteBackendServiceHttpRequest request = DeleteBackendServiceHttpRequest.newBuilder()
     .setBackendService(formattedBackendService)
     .build();
   ApiFuture<Operation> future = backendServiceClient.deleteBackendServiceCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

deleteSignedUrlKeyBackendService

@BetaApi
public final Operation deleteSignedUrlKeyBackendService(ProjectGlobalBackendServiceName backendService,
                                                                 String keyName)

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

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   ProjectGlobalBackendServiceName backendService = ProjectGlobalBackendServiceName.of("[PROJECT]", "[BACKEND_SERVICE]");
   String keyName = "";
   Operation response = backendServiceClient.deleteSignedUrlKeyBackendService(backendService, keyName);
 }
 

Parameters:

backendService - Name of the BackendService 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

deleteSignedUrlKeyBackendService

@BetaApi
public final Operation deleteSignedUrlKeyBackendService(String backendService,
                                                                 String keyName)

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

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   ProjectGlobalBackendServiceName backendService = ProjectGlobalBackendServiceName.of("[PROJECT]", "[BACKEND_SERVICE]");
   String keyName = "";
   Operation response = backendServiceClient.deleteSignedUrlKeyBackendService(backendService.toString(), keyName);
 }
 

Parameters:

backendService - Name of the BackendService 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

deleteSignedUrlKeyBackendService

@BetaApi
public final Operation deleteSignedUrlKeyBackendService(DeleteSignedUrlKeyBackendServiceHttpRequest request)

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

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   String formattedBackendService = ProjectGlobalBackendServiceName.format("[PROJECT]", "[BACKEND_SERVICE]");
   String keyName = "";
   DeleteSignedUrlKeyBackendServiceHttpRequest request = DeleteSignedUrlKeyBackendServiceHttpRequest.newBuilder()
     .setBackendService(formattedBackendService)
     .setKeyName(keyName)
     .build();
   Operation response = backendServiceClient.deleteSignedUrlKeyBackendService(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

deleteSignedUrlKeyBackendServiceCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<DeleteSignedUrlKeyBackendServiceHttpRequest,Operation> deleteSignedUrlKeyBackendServiceCallable()

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

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   String formattedBackendService = ProjectGlobalBackendServiceName.format("[PROJECT]", "[BACKEND_SERVICE]");
   String keyName = "";
   DeleteSignedUrlKeyBackendServiceHttpRequest request = DeleteSignedUrlKeyBackendServiceHttpRequest.newBuilder()
     .setBackendService(formattedBackendService)
     .setKeyName(keyName)
     .build();
   ApiFuture<Operation> future = backendServiceClient.deleteSignedUrlKeyBackendServiceCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

getBackendService

@BetaApi
public final BackendService getBackendService(ProjectGlobalBackendServiceName backendService)

Returns the specified BackendService resource. Gets a list of available backend services.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   ProjectGlobalBackendServiceName backendService = ProjectGlobalBackendServiceName.of("[PROJECT]", "[BACKEND_SERVICE]");
   BackendService response = backendServiceClient.getBackendService(backendService);
 }
 

Parameters:

backendService - Name of the BackendService resource to return.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getBackendService

@BetaApi
public final BackendService getBackendService(String backendService)

Returns the specified BackendService resource. Gets a list of available backend services.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   ProjectGlobalBackendServiceName backendService = ProjectGlobalBackendServiceName.of("[PROJECT]", "[BACKEND_SERVICE]");
   BackendService response = backendServiceClient.getBackendService(backendService.toString());
 }
 

Parameters:

backendService - Name of the BackendService resource to return.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getBackendService

@BetaApi
public final BackendService getBackendService(GetBackendServiceHttpRequest request)

Returns the specified BackendService resource. Gets a list of available backend services.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   String formattedBackendService = ProjectGlobalBackendServiceName.format("[PROJECT]", "[BACKEND_SERVICE]");
   GetBackendServiceHttpRequest request = GetBackendServiceHttpRequest.newBuilder()
     .setBackendService(formattedBackendService)
     .build();
   BackendService response = backendServiceClient.getBackendService(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

getBackendServiceCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetBackendServiceHttpRequest,BackendService> getBackendServiceCallable()

Returns the specified BackendService resource. Gets a list of available backend services.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   String formattedBackendService = ProjectGlobalBackendServiceName.format("[PROJECT]", "[BACKEND_SERVICE]");
   GetBackendServiceHttpRequest request = GetBackendServiceHttpRequest.newBuilder()
     .setBackendService(formattedBackendService)
     .build();
   ApiFuture<BackendService> future = backendServiceClient.getBackendServiceCallable().futureCall(request);
   // Do something
   BackendService response = future.get();
 }
 

getHealthBackendService

@BetaApi
public final BackendServiceGroupHealth getHealthBackendService(ProjectGlobalBackendServiceName backendService,
                                                                        ResourceGroupReference resourceGroupReferenceResource)

Gets the most recent health check results for this BackendService.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   ProjectGlobalBackendServiceName backendService = ProjectGlobalBackendServiceName.of("[PROJECT]", "[BACKEND_SERVICE]");
   ResourceGroupReference resourceGroupReferenceResource = ResourceGroupReference.newBuilder().build();
   BackendServiceGroupHealth response = backendServiceClient.getHealthBackendService(backendService, resourceGroupReferenceResource);
 }
 

Parameters:

backendService - Name of the BackendService resource to which the queried instance belongs.

resourceGroupReferenceResource -

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getHealthBackendService

@BetaApi
public final BackendServiceGroupHealth getHealthBackendService(String backendService,
                                                                        ResourceGroupReference resourceGroupReferenceResource)

Gets the most recent health check results for this BackendService.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   ProjectGlobalBackendServiceName backendService = ProjectGlobalBackendServiceName.of("[PROJECT]", "[BACKEND_SERVICE]");
   ResourceGroupReference resourceGroupReferenceResource = ResourceGroupReference.newBuilder().build();
   BackendServiceGroupHealth response = backendServiceClient.getHealthBackendService(backendService.toString(), resourceGroupReferenceResource);
 }
 

Parameters:

backendService - Name of the BackendService resource to which the queried instance belongs.

resourceGroupReferenceResource -

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getHealthBackendService

@BetaApi
public final BackendServiceGroupHealth getHealthBackendService(GetHealthBackendServiceHttpRequest request)

Gets the most recent health check results for this BackendService.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   String formattedBackendService = ProjectGlobalBackendServiceName.format("[PROJECT]", "[BACKEND_SERVICE]");
   ResourceGroupReference resourceGroupReferenceResource = ResourceGroupReference.newBuilder().build();
   GetHealthBackendServiceHttpRequest request = GetHealthBackendServiceHttpRequest.newBuilder()
     .setBackendService(formattedBackendService)
     .setResourceGroupReferenceResource(resourceGroupReferenceResource)
     .build();
   BackendServiceGroupHealth response = backendServiceClient.getHealthBackendService(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

getHealthBackendServiceCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetHealthBackendServiceHttpRequest,BackendServiceGroupHealth> getHealthBackendServiceCallable()

Gets the most recent health check results for this BackendService.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   String formattedBackendService = ProjectGlobalBackendServiceName.format("[PROJECT]", "[BACKEND_SERVICE]");
   ResourceGroupReference resourceGroupReferenceResource = ResourceGroupReference.newBuilder().build();
   GetHealthBackendServiceHttpRequest request = GetHealthBackendServiceHttpRequest.newBuilder()
     .setBackendService(formattedBackendService)
     .setResourceGroupReferenceResource(resourceGroupReferenceResource)
     .build();
   ApiFuture<BackendServiceGroupHealth> future = backendServiceClient.getHealthBackendServiceCallable().futureCall(request);
   // Do something
   BackendServiceGroupHealth response = future.get();
 }
 

insertBackendService

@BetaApi
public final Operation insertBackendService(ProjectName project,
                                                     BackendService backendServiceResource)

Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   BackendService backendServiceResource = BackendService.newBuilder().build();
   Operation response = backendServiceClient.insertBackendService(project, backendServiceResource);
 }
 

Parameters:

project - Project ID for this request.

backendServiceResource - Represents a Backend Service resource.

Backend services must have an associated health check. Backend services also store information about session affinity. For more information, read Backend Services.

A backendServices resource represents a global backend service. Global backend services are used for HTTP(S), SSL Proxy, TCP Proxy load balancing and Traffic Director.

A regionBackendServices resource represents a regional backend service. Regional backend services are used for internal TCP/UDP load balancing. For more information, read Internal TCP/UDP Load balancing. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==)

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

insertBackendService

@BetaApi
public final Operation insertBackendService(String project,
                                                     BackendService backendServiceResource)

Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   BackendService backendServiceResource = BackendService.newBuilder().build();
   Operation response = backendServiceClient.insertBackendService(project.toString(), backendServiceResource);
 }
 

Parameters:

project - Project ID for this request.

backendServiceResource - Represents a Backend Service resource.

Backend services must have an associated health check. Backend services also store information about session affinity. For more information, read Backend Services.

A backendServices resource represents a global backend service. Global backend services are used for HTTP(S), SSL Proxy, TCP Proxy load balancing and Traffic Director.

A regionBackendServices resource represents a regional backend service. Regional backend services are used for internal TCP/UDP load balancing. For more information, read Internal TCP/UDP Load balancing. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==)

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

insertBackendService

@BetaApi
public final Operation insertBackendService(InsertBackendServiceHttpRequest request)

Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   BackendService backendServiceResource = BackendService.newBuilder().build();
   InsertBackendServiceHttpRequest request = InsertBackendServiceHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setBackendServiceResource(backendServiceResource)
     .build();
   Operation response = backendServiceClient.insertBackendService(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

insertBackendServiceCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<InsertBackendServiceHttpRequest,Operation> insertBackendServiceCallable()

Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   BackendService backendServiceResource = BackendService.newBuilder().build();
   InsertBackendServiceHttpRequest request = InsertBackendServiceHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setBackendServiceResource(backendServiceResource)
     .build();
   ApiFuture<Operation> future = backendServiceClient.insertBackendServiceCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

listBackendServices

@BetaApi
public final BackendServiceClient.ListBackendServicesPagedResponse listBackendServices(ProjectName project)

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

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (BackendService element : backendServiceClient.listBackendServices(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listBackendServices

@BetaApi
public final BackendServiceClient.ListBackendServicesPagedResponse listBackendServices(String project)

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

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (BackendService element : backendServiceClient.listBackendServices(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listBackendServices

@BetaApi
public final BackendServiceClient.ListBackendServicesPagedResponse listBackendServices(ListBackendServicesHttpRequest request)

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

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListBackendServicesHttpRequest request = ListBackendServicesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (BackendService element : backendServiceClient.listBackendServices(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

listBackendServicesPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListBackendServicesHttpRequest,BackendServiceClient.ListBackendServicesPagedResponse> listBackendServicesPagedCallable()

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

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListBackendServicesHttpRequest request = ListBackendServicesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<ListBackendServicesPagedResponse> future = backendServiceClient.listBackendServicesPagedCallable().futureCall(request);
   // Do something
   for (BackendService element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listBackendServicesCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListBackendServicesHttpRequest,BackendServiceList> listBackendServicesCallable()

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

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListBackendServicesHttpRequest request = ListBackendServicesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     BackendServiceList response = backendServiceClient.listBackendServicesCallable().call(request);
     for (BackendService element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

patchBackendService

@BetaApi
public final Operation patchBackendService(ProjectGlobalBackendServiceName backendService,
                                                    BackendService backendServiceResource,
                                                    List<String> fieldMask)

Patches the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   ProjectGlobalBackendServiceName backendService = ProjectGlobalBackendServiceName.of("[PROJECT]", "[BACKEND_SERVICE]");
   BackendService backendServiceResource = BackendService.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = backendServiceClient.patchBackendService(backendService, backendServiceResource, fieldMask);
 }
 

Parameters:

backendService - Name of the BackendService resource to patch.

backendServiceResource - Represents a Backend Service resource.

Backend services must have an associated health check. Backend services also store information about session affinity. For more information, read Backend Services.

A backendServices resource represents a global backend service. Global backend services are used for HTTP(S), SSL Proxy, TCP Proxy load balancing and Traffic Director.

A regionBackendServices resource represents a regional backend service. Regional backend services are used for internal TCP/UDP load balancing. For more information, read Internal TCP/UDP Load balancing. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==)

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

patchBackendService

@BetaApi
public final Operation patchBackendService(String backendService,
                                                    BackendService backendServiceResource,
                                                    List<String> fieldMask)

Patches the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   ProjectGlobalBackendServiceName backendService = ProjectGlobalBackendServiceName.of("[PROJECT]", "[BACKEND_SERVICE]");
   BackendService backendServiceResource = BackendService.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = backendServiceClient.patchBackendService(backendService.toString(), backendServiceResource, fieldMask);
 }
 

Parameters:

backendService - Name of the BackendService resource to patch.

backendServiceResource - Represents a Backend Service resource.

Backend services must have an associated health check. Backend services also store information about session affinity. For more information, read Backend Services.

A backendServices resource represents a global backend service. Global backend services are used for HTTP(S), SSL Proxy, TCP Proxy load balancing and Traffic Director.

A regionBackendServices resource represents a regional backend service. Regional backend services are used for internal TCP/UDP load balancing. For more information, read Internal TCP/UDP Load balancing. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==)

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

patchBackendService

@BetaApi
public final Operation patchBackendService(PatchBackendServiceHttpRequest request)

Patches the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   String formattedBackendService = ProjectGlobalBackendServiceName.format("[PROJECT]", "[BACKEND_SERVICE]");
   BackendService backendServiceResource = BackendService.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   PatchBackendServiceHttpRequest request = PatchBackendServiceHttpRequest.newBuilder()
     .setBackendService(formattedBackendService)
     .setBackendServiceResource(backendServiceResource)
     .addAllFieldMask(fieldMask)
     .build();
   Operation response = backendServiceClient.patchBackendService(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

patchBackendServiceCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<PatchBackendServiceHttpRequest,Operation> patchBackendServiceCallable()

Patches the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   String formattedBackendService = ProjectGlobalBackendServiceName.format("[PROJECT]", "[BACKEND_SERVICE]");
   BackendService backendServiceResource = BackendService.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   PatchBackendServiceHttpRequest request = PatchBackendServiceHttpRequest.newBuilder()
     .setBackendService(formattedBackendService)
     .setBackendServiceResource(backendServiceResource)
     .addAllFieldMask(fieldMask)
     .build();
   ApiFuture<Operation> future = backendServiceClient.patchBackendServiceCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

setSecurityPolicyBackendService

@BetaApi
public final Operation setSecurityPolicyBackendService(ProjectGlobalBackendServiceName backendService,
                                                                SecurityPolicyReference securityPolicyReferenceResource)

Sets the security policy for the specified backend service.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   ProjectGlobalBackendServiceName backendService = ProjectGlobalBackendServiceName.of("[PROJECT]", "[BACKEND_SERVICE]");
   SecurityPolicyReference securityPolicyReferenceResource = SecurityPolicyReference.newBuilder().build();
   Operation response = backendServiceClient.setSecurityPolicyBackendService(backendService, securityPolicyReferenceResource);
 }
 

Parameters:

backendService - Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035.

securityPolicyReferenceResource -

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

setSecurityPolicyBackendService

@BetaApi
public final Operation setSecurityPolicyBackendService(String backendService,
                                                                SecurityPolicyReference securityPolicyReferenceResource)

Sets the security policy for the specified backend service.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   ProjectGlobalBackendServiceName backendService = ProjectGlobalBackendServiceName.of("[PROJECT]", "[BACKEND_SERVICE]");
   SecurityPolicyReference securityPolicyReferenceResource = SecurityPolicyReference.newBuilder().build();
   Operation response = backendServiceClient.setSecurityPolicyBackendService(backendService.toString(), securityPolicyReferenceResource);
 }
 

Parameters:

backendService - Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035.

securityPolicyReferenceResource -

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

setSecurityPolicyBackendService

@BetaApi
public final Operation setSecurityPolicyBackendService(SetSecurityPolicyBackendServiceHttpRequest request)

Sets the security policy for the specified backend service.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   String formattedBackendService = ProjectGlobalBackendServiceName.format("[PROJECT]", "[BACKEND_SERVICE]");
   SecurityPolicyReference securityPolicyReferenceResource = SecurityPolicyReference.newBuilder().build();
   SetSecurityPolicyBackendServiceHttpRequest request = SetSecurityPolicyBackendServiceHttpRequest.newBuilder()
     .setBackendService(formattedBackendService)
     .setSecurityPolicyReferenceResource(securityPolicyReferenceResource)
     .build();
   Operation response = backendServiceClient.setSecurityPolicyBackendService(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

setSecurityPolicyBackendServiceCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<SetSecurityPolicyBackendServiceHttpRequest,Operation> setSecurityPolicyBackendServiceCallable()

Sets the security policy for the specified backend service.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   String formattedBackendService = ProjectGlobalBackendServiceName.format("[PROJECT]", "[BACKEND_SERVICE]");
   SecurityPolicyReference securityPolicyReferenceResource = SecurityPolicyReference.newBuilder().build();
   SetSecurityPolicyBackendServiceHttpRequest request = SetSecurityPolicyBackendServiceHttpRequest.newBuilder()
     .setBackendService(formattedBackendService)
     .setSecurityPolicyReferenceResource(securityPolicyReferenceResource)
     .build();
   ApiFuture<Operation> future = backendServiceClient.setSecurityPolicyBackendServiceCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

updateBackendService

@BetaApi
public final Operation updateBackendService(ProjectGlobalBackendServiceName backendService,
                                                     BackendService backendServiceResource,
                                                     List<String> fieldMask)

Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   ProjectGlobalBackendServiceName backendService = ProjectGlobalBackendServiceName.of("[PROJECT]", "[BACKEND_SERVICE]");
   BackendService backendServiceResource = BackendService.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = backendServiceClient.updateBackendService(backendService, backendServiceResource, fieldMask);
 }
 

Parameters:

backendService - Name of the BackendService resource to update.

backendServiceResource - Represents a Backend Service resource.

Backend services must have an associated health check. Backend services also store information about session affinity. For more information, read Backend Services.

A backendServices resource represents a global backend service. Global backend services are used for HTTP(S), SSL Proxy, TCP Proxy load balancing and Traffic Director.

A regionBackendServices resource represents a regional backend service. Regional backend services are used for internal TCP/UDP load balancing. For more information, read Internal TCP/UDP Load balancing. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==)

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateBackendService

@BetaApi
public final Operation updateBackendService(String backendService,
                                                     BackendService backendServiceResource,
                                                     List<String> fieldMask)

Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   ProjectGlobalBackendServiceName backendService = ProjectGlobalBackendServiceName.of("[PROJECT]", "[BACKEND_SERVICE]");
   BackendService backendServiceResource = BackendService.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = backendServiceClient.updateBackendService(backendService.toString(), backendServiceResource, fieldMask);
 }
 

Parameters:

backendService - Name of the BackendService resource to update.

backendServiceResource - Represents a Backend Service resource.

Backend services must have an associated health check. Backend services also store information about session affinity. For more information, read Backend Services.

A backendServices resource represents a global backend service. Global backend services are used for HTTP(S), SSL Proxy, TCP Proxy load balancing and Traffic Director.

A regionBackendServices resource represents a regional backend service. Regional backend services are used for internal TCP/UDP load balancing. For more information, read Internal TCP/UDP Load balancing. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==)

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateBackendService

@BetaApi
public final Operation updateBackendService(UpdateBackendServiceHttpRequest request)

Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   String formattedBackendService = ProjectGlobalBackendServiceName.format("[PROJECT]", "[BACKEND_SERVICE]");
   BackendService backendServiceResource = BackendService.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   UpdateBackendServiceHttpRequest request = UpdateBackendServiceHttpRequest.newBuilder()
     .setBackendService(formattedBackendService)
     .setBackendServiceResource(backendServiceResource)
     .addAllFieldMask(fieldMask)
     .build();
   Operation response = backendServiceClient.updateBackendService(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

updateBackendServiceCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<UpdateBackendServiceHttpRequest,Operation> updateBackendServiceCallable()

Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.

Sample code:

 try (BackendServiceClient backendServiceClient = BackendServiceClient.create()) {
   String formattedBackendService = ProjectGlobalBackendServiceName.format("[PROJECT]", "[BACKEND_SERVICE]");
   BackendService backendServiceResource = BackendService.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   UpdateBackendServiceHttpRequest request = UpdateBackendServiceHttpRequest.newBuilder()
     .setBackendService(formattedBackendService)
     .setBackendServiceResource(backendServiceResource)
     .addAllFieldMask(fieldMask)
     .build();
   ApiFuture<Operation> future = backendServiceClient.updateBackendServiceCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface 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

awaitTermination

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

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException