com.google.cloud.compute.v1

Class HttpsHealthCheckClient

java.lang.Object

com.google.cloud.compute.v1.HttpsHealthCheckClient

All Implemented Interfaces:

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

@Generated(value="by gapic-generator")
 @BetaApi
public class HttpsHealthCheckClient
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 (HttpsHealthCheckClient httpsHealthCheckClient = HttpsHealthCheckClient.create()) {
   ProjectGlobalHttpsHealthCheckName httpsHealthCheck = ProjectGlobalHttpsHealthCheckName.of("[PROJECT]", "[HTTPS_HEALTH_CHECK]");
   Operation response = httpsHealthCheckClient.deleteHttpsHealthCheck(httpsHealthCheck);
 }
 
 

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

To customize credentials:

 
 HttpsHealthCheckSettings httpsHealthCheckSettings =
     HttpsHealthCheckSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 HttpsHealthCheckClient httpsHealthCheckClient =
     HttpsHealthCheckClient.create(httpsHealthCheckSettings);
 
 

To customize the endpoint:

 
 HttpsHealthCheckSettings httpsHealthCheckSettings =
     HttpsHealthCheckSettings.newBuilder().setEndpoint(myEndpoint).build();
 HttpsHealthCheckClient httpsHealthCheckClient =
     HttpsHealthCheckClient.create(httpsHealthCheckSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpsHealthCheckClient.ListHttpsHealthChecksFixedSizeCollection
static class	HttpsHealthCheckClient.ListHttpsHealthChecksPage
static class	HttpsHealthCheckClient.ListHttpsHealthChecksPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpsHealthCheckClient(HttpsHealthCheckSettings settings) Constructs an instance of HttpsHealthCheckClient, using the given settings.
protected	HttpsHealthCheckClient(HttpsHealthCheckStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static HttpsHealthCheckClient	create() Constructs an instance of HttpsHealthCheckClient with default settings.
static HttpsHealthCheckClient	create(HttpsHealthCheckSettings settings) Constructs an instance of HttpsHealthCheckClient, using the given settings.
static HttpsHealthCheckClient	create(HttpsHealthCheckStub stub) Constructs an instance of HttpsHealthCheckClient, using the given stub for making calls.
Operation	deleteHttpsHealthCheck(DeleteHttpsHealthCheckHttpRequest request) Deletes the specified HttpsHealthCheck resource.
Operation	deleteHttpsHealthCheck(ProjectGlobalHttpsHealthCheckName httpsHealthCheck) Deletes the specified HttpsHealthCheck resource.
Operation	deleteHttpsHealthCheck(String httpsHealthCheck) Deletes the specified HttpsHealthCheck resource.
com.google.api.gax.rpc.UnaryCallable<DeleteHttpsHealthCheckHttpRequest,Operation>	deleteHttpsHealthCheckCallable() Deletes the specified HttpsHealthCheck resource.
HttpsHealthCheck2	getHttpsHealthCheck(GetHttpsHealthCheckHttpRequest request) Returns the specified HttpsHealthCheck resource.
HttpsHealthCheck2	getHttpsHealthCheck(ProjectGlobalHttpsHealthCheckName httpsHealthCheck) Returns the specified HttpsHealthCheck resource.
HttpsHealthCheck2	getHttpsHealthCheck(String httpsHealthCheck) Returns the specified HttpsHealthCheck resource.
com.google.api.gax.rpc.UnaryCallable<GetHttpsHealthCheckHttpRequest,HttpsHealthCheck2>	getHttpsHealthCheckCallable() Returns the specified HttpsHealthCheck resource.
HttpsHealthCheckSettings	getSettings()
HttpsHealthCheckStub	getStub()
Operation	insertHttpsHealthCheck(InsertHttpsHealthCheckHttpRequest request) Creates a HttpsHealthCheck resource in the specified project using the data included in the request.
Operation	insertHttpsHealthCheck(ProjectName project, HttpsHealthCheck2 httpsHealthCheckResource) Creates a HttpsHealthCheck resource in the specified project using the data included in the request.
Operation	insertHttpsHealthCheck(String project, HttpsHealthCheck2 httpsHealthCheckResource) Creates a HttpsHealthCheck resource in the specified project using the data included in the request.
com.google.api.gax.rpc.UnaryCallable<InsertHttpsHealthCheckHttpRequest,Operation>	insertHttpsHealthCheckCallable() Creates a HttpsHealthCheck resource in the specified project using the data included in the request.
boolean	isShutdown()
boolean	isTerminated()
HttpsHealthCheckClient.ListHttpsHealthChecksPagedResponse	listHttpsHealthChecks(ListHttpsHealthChecksHttpRequest request) Retrieves the list of HttpsHealthCheck resources available to the specified project.
HttpsHealthCheckClient.ListHttpsHealthChecksPagedResponse	listHttpsHealthChecks(ProjectName project) Retrieves the list of HttpsHealthCheck resources available to the specified project.
HttpsHealthCheckClient.ListHttpsHealthChecksPagedResponse	listHttpsHealthChecks(String project) Retrieves the list of HttpsHealthCheck resources available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListHttpsHealthChecksHttpRequest,HttpsHealthCheckList>	listHttpsHealthChecksCallable() Retrieves the list of HttpsHealthCheck resources available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListHttpsHealthChecksHttpRequest,HttpsHealthCheckClient.ListHttpsHealthChecksPagedResponse>	listHttpsHealthChecksPagedCallable() Retrieves the list of HttpsHealthCheck resources available to the specified project.
Operation	patchHttpsHealthCheck(PatchHttpsHealthCheckHttpRequest request) Updates a HttpsHealthCheck resource in the specified project using the data included in the request.
Operation	patchHttpsHealthCheck(ProjectGlobalHttpsHealthCheckName httpsHealthCheck, HttpsHealthCheck2 httpsHealthCheckResource, List<String> fieldMask) Updates a HttpsHealthCheck resource in the specified project using the data included in the request.
Operation	patchHttpsHealthCheck(String httpsHealthCheck, HttpsHealthCheck2 httpsHealthCheckResource, List<String> fieldMask) Updates a HttpsHealthCheck resource in the specified project using the data included in the request.
com.google.api.gax.rpc.UnaryCallable<PatchHttpsHealthCheckHttpRequest,Operation>	patchHttpsHealthCheckCallable() Updates a HttpsHealthCheck resource in the specified project using the data included in the request.
void	shutdown()
void	shutdownNow()
Operation	updateHttpsHealthCheck(ProjectGlobalHttpsHealthCheckName httpsHealthCheck, HttpsHealthCheck2 httpsHealthCheckResource, List<String> fieldMask) Updates a HttpsHealthCheck resource in the specified project using the data included in the request.
Operation	updateHttpsHealthCheck(String httpsHealthCheck, HttpsHealthCheck2 httpsHealthCheckResource, List<String> fieldMask) Updates a HttpsHealthCheck resource in the specified project using the data included in the request.
Operation	updateHttpsHealthCheck(UpdateHttpsHealthCheckHttpRequest request) Updates a HttpsHealthCheck resource in the specified project using the data included in the request.
com.google.api.gax.rpc.UnaryCallable<UpdateHttpsHealthCheckHttpRequest,Operation>	updateHttpsHealthCheckCallable() Updates a HttpsHealthCheck resource in the specified project using 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

HttpsHealthCheckClient

protected HttpsHealthCheckClient(HttpsHealthCheckSettings settings)
                          throws IOException

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

HttpsHealthCheckClient

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

Method Detail

create

public static final HttpsHealthCheckClient create()
                                           throws IOException

Constructs an instance of HttpsHealthCheckClient with default settings.

Throws:

IOException

create

public static final HttpsHealthCheckClient create(HttpsHealthCheckSettings settings)
                                           throws IOException

Constructs an instance of HttpsHealthCheckClient, 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 HttpsHealthCheckClient create(HttpsHealthCheckStub stub)

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

getSettings

public final HttpsHealthCheckSettings getSettings()

getStub

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

deleteHttpsHealthCheck

@BetaApi
public final Operation deleteHttpsHealthCheck(ProjectGlobalHttpsHealthCheckName httpsHealthCheck)

Deletes the specified HttpsHealthCheck resource.

Sample code:

 try (HttpsHealthCheckClient httpsHealthCheckClient = HttpsHealthCheckClient.create()) {
   ProjectGlobalHttpsHealthCheckName httpsHealthCheck = ProjectGlobalHttpsHealthCheckName.of("[PROJECT]", "[HTTPS_HEALTH_CHECK]");
   Operation response = httpsHealthCheckClient.deleteHttpsHealthCheck(httpsHealthCheck);
 }
 

Parameters:

httpsHealthCheck - Name of the HttpsHealthCheck resource to delete.

Throws:

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

deleteHttpsHealthCheck

@BetaApi
public final Operation deleteHttpsHealthCheck(String httpsHealthCheck)

Deletes the specified HttpsHealthCheck resource.

Sample code:

 try (HttpsHealthCheckClient httpsHealthCheckClient = HttpsHealthCheckClient.create()) {
   ProjectGlobalHttpsHealthCheckName httpsHealthCheck = ProjectGlobalHttpsHealthCheckName.of("[PROJECT]", "[HTTPS_HEALTH_CHECK]");
   Operation response = httpsHealthCheckClient.deleteHttpsHealthCheck(httpsHealthCheck.toString());
 }
 

Parameters:

httpsHealthCheck - Name of the HttpsHealthCheck resource to delete.

Throws:

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

deleteHttpsHealthCheck

@BetaApi
public final Operation deleteHttpsHealthCheck(DeleteHttpsHealthCheckHttpRequest request)

Deletes the specified HttpsHealthCheck resource.

Sample code:

 try (HttpsHealthCheckClient httpsHealthCheckClient = HttpsHealthCheckClient.create()) {
   String formattedHttpsHealthCheck = ProjectGlobalHttpsHealthCheckName.format("[PROJECT]", "[HTTPS_HEALTH_CHECK]");
   DeleteHttpsHealthCheckHttpRequest request = DeleteHttpsHealthCheckHttpRequest.newBuilder()
     .setHttpsHealthCheck(formattedHttpsHealthCheck)
     .build();
   Operation response = httpsHealthCheckClient.deleteHttpsHealthCheck(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

deleteHttpsHealthCheckCallable

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

Deletes the specified HttpsHealthCheck resource.

Sample code:

 try (HttpsHealthCheckClient httpsHealthCheckClient = HttpsHealthCheckClient.create()) {
   String formattedHttpsHealthCheck = ProjectGlobalHttpsHealthCheckName.format("[PROJECT]", "[HTTPS_HEALTH_CHECK]");
   DeleteHttpsHealthCheckHttpRequest request = DeleteHttpsHealthCheckHttpRequest.newBuilder()
     .setHttpsHealthCheck(formattedHttpsHealthCheck)
     .build();
   ApiFuture<Operation> future = httpsHealthCheckClient.deleteHttpsHealthCheckCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

getHttpsHealthCheck

@BetaApi
public final HttpsHealthCheck2 getHttpsHealthCheck(ProjectGlobalHttpsHealthCheckName httpsHealthCheck)

Returns the specified HttpsHealthCheck resource. Gets a list of available HTTPS health checks by making a list() request.

Sample code:

 try (HttpsHealthCheckClient httpsHealthCheckClient = HttpsHealthCheckClient.create()) {
   ProjectGlobalHttpsHealthCheckName httpsHealthCheck = ProjectGlobalHttpsHealthCheckName.of("[PROJECT]", "[HTTPS_HEALTH_CHECK]");
   HttpsHealthCheck2 response = httpsHealthCheckClient.getHttpsHealthCheck(httpsHealthCheck);
 }
 

Parameters:

httpsHealthCheck - Name of the HttpsHealthCheck resource to return.

Throws:

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

getHttpsHealthCheck

@BetaApi
public final HttpsHealthCheck2 getHttpsHealthCheck(String httpsHealthCheck)

Returns the specified HttpsHealthCheck resource. Gets a list of available HTTPS health checks by making a list() request.

Sample code:

 try (HttpsHealthCheckClient httpsHealthCheckClient = HttpsHealthCheckClient.create()) {
   ProjectGlobalHttpsHealthCheckName httpsHealthCheck = ProjectGlobalHttpsHealthCheckName.of("[PROJECT]", "[HTTPS_HEALTH_CHECK]");
   HttpsHealthCheck2 response = httpsHealthCheckClient.getHttpsHealthCheck(httpsHealthCheck.toString());
 }
 

Parameters:

httpsHealthCheck - Name of the HttpsHealthCheck resource to return.

Throws:

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

getHttpsHealthCheck

@BetaApi
public final HttpsHealthCheck2 getHttpsHealthCheck(GetHttpsHealthCheckHttpRequest request)

Returns the specified HttpsHealthCheck resource. Gets a list of available HTTPS health checks by making a list() request.

Sample code:

 try (HttpsHealthCheckClient httpsHealthCheckClient = HttpsHealthCheckClient.create()) {
   String formattedHttpsHealthCheck = ProjectGlobalHttpsHealthCheckName.format("[PROJECT]", "[HTTPS_HEALTH_CHECK]");
   GetHttpsHealthCheckHttpRequest request = GetHttpsHealthCheckHttpRequest.newBuilder()
     .setHttpsHealthCheck(formattedHttpsHealthCheck)
     .build();
   HttpsHealthCheck2 response = httpsHealthCheckClient.getHttpsHealthCheck(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

getHttpsHealthCheckCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetHttpsHealthCheckHttpRequest,HttpsHealthCheck2> getHttpsHealthCheckCallable()

Returns the specified HttpsHealthCheck resource. Gets a list of available HTTPS health checks by making a list() request.

Sample code:

 try (HttpsHealthCheckClient httpsHealthCheckClient = HttpsHealthCheckClient.create()) {
   String formattedHttpsHealthCheck = ProjectGlobalHttpsHealthCheckName.format("[PROJECT]", "[HTTPS_HEALTH_CHECK]");
   GetHttpsHealthCheckHttpRequest request = GetHttpsHealthCheckHttpRequest.newBuilder()
     .setHttpsHealthCheck(formattedHttpsHealthCheck)
     .build();
   ApiFuture<HttpsHealthCheck2> future = httpsHealthCheckClient.getHttpsHealthCheckCallable().futureCall(request);
   // Do something
   HttpsHealthCheck2 response = future.get();
 }
 

insertHttpsHealthCheck

@BetaApi
public final Operation insertHttpsHealthCheck(ProjectName project,
                                                       HttpsHealthCheck2 httpsHealthCheckResource)

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

Sample code:

 try (HttpsHealthCheckClient httpsHealthCheckClient = HttpsHealthCheckClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   HttpsHealthCheck2 httpsHealthCheckResource = HttpsHealthCheck2.newBuilder().build();
   Operation response = httpsHealthCheckClient.insertHttpsHealthCheck(project, httpsHealthCheckResource);
 }
 

Parameters:

project - Project ID for this request.

httpsHealthCheckResource - Represents a legacy HTTPS Health Check resource.

Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.

Throws:

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

insertHttpsHealthCheck

@BetaApi
public final Operation insertHttpsHealthCheck(String project,
                                                       HttpsHealthCheck2 httpsHealthCheckResource)

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

Sample code:

 try (HttpsHealthCheckClient httpsHealthCheckClient = HttpsHealthCheckClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   HttpsHealthCheck2 httpsHealthCheckResource = HttpsHealthCheck2.newBuilder().build();
   Operation response = httpsHealthCheckClient.insertHttpsHealthCheck(project.toString(), httpsHealthCheckResource);
 }
 

Parameters:

project - Project ID for this request.

httpsHealthCheckResource - Represents a legacy HTTPS Health Check resource.

Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.

Throws:

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

insertHttpsHealthCheck

@BetaApi
public final Operation insertHttpsHealthCheck(InsertHttpsHealthCheckHttpRequest request)

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

Sample code:

 try (HttpsHealthCheckClient httpsHealthCheckClient = HttpsHealthCheckClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   HttpsHealthCheck2 httpsHealthCheckResource = HttpsHealthCheck2.newBuilder().build();
   InsertHttpsHealthCheckHttpRequest request = InsertHttpsHealthCheckHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setHttpsHealthCheckResource(httpsHealthCheckResource)
     .build();
   Operation response = httpsHealthCheckClient.insertHttpsHealthCheck(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

insertHttpsHealthCheckCallable

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

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

Sample code:

 try (HttpsHealthCheckClient httpsHealthCheckClient = HttpsHealthCheckClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   HttpsHealthCheck2 httpsHealthCheckResource = HttpsHealthCheck2.newBuilder().build();
   InsertHttpsHealthCheckHttpRequest request = InsertHttpsHealthCheckHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setHttpsHealthCheckResource(httpsHealthCheckResource)
     .build();
   ApiFuture<Operation> future = httpsHealthCheckClient.insertHttpsHealthCheckCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

listHttpsHealthChecks

@BetaApi
public final HttpsHealthCheckClient.ListHttpsHealthChecksPagedResponse listHttpsHealthChecks(ProjectName project)

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

Sample code:

 try (HttpsHealthCheckClient httpsHealthCheckClient = HttpsHealthCheckClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (HttpsHealthCheck2 element : httpsHealthCheckClient.listHttpsHealthChecks(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

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

listHttpsHealthChecks

@BetaApi
public final HttpsHealthCheckClient.ListHttpsHealthChecksPagedResponse listHttpsHealthChecks(String project)

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

Sample code:

 try (HttpsHealthCheckClient httpsHealthCheckClient = HttpsHealthCheckClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (HttpsHealthCheck2 element : httpsHealthCheckClient.listHttpsHealthChecks(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

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

listHttpsHealthChecks

@BetaApi
public final HttpsHealthCheckClient.ListHttpsHealthChecksPagedResponse listHttpsHealthChecks(ListHttpsHealthChecksHttpRequest request)

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

Sample code:

 try (HttpsHealthCheckClient httpsHealthCheckClient = HttpsHealthCheckClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListHttpsHealthChecksHttpRequest request = ListHttpsHealthChecksHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (HttpsHealthCheck2 element : httpsHealthCheckClient.listHttpsHealthChecks(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

listHttpsHealthChecksPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListHttpsHealthChecksHttpRequest,HttpsHealthCheckClient.ListHttpsHealthChecksPagedResponse> listHttpsHealthChecksPagedCallable()

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

Sample code:

 try (HttpsHealthCheckClient httpsHealthCheckClient = HttpsHealthCheckClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListHttpsHealthChecksHttpRequest request = ListHttpsHealthChecksHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<ListHttpsHealthChecksPagedResponse> future = httpsHealthCheckClient.listHttpsHealthChecksPagedCallable().futureCall(request);
   // Do something
   for (HttpsHealthCheck2 element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listHttpsHealthChecksCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListHttpsHealthChecksHttpRequest,HttpsHealthCheckList> listHttpsHealthChecksCallable()

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

Sample code:

 try (HttpsHealthCheckClient httpsHealthCheckClient = HttpsHealthCheckClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListHttpsHealthChecksHttpRequest request = ListHttpsHealthChecksHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     HttpsHealthCheckList response = httpsHealthCheckClient.listHttpsHealthChecksCallable().call(request);
     for (HttpsHealthCheck2 element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

patchHttpsHealthCheck

@BetaApi
public final Operation patchHttpsHealthCheck(ProjectGlobalHttpsHealthCheckName httpsHealthCheck,
                                                      HttpsHealthCheck2 httpsHealthCheckResource,
                                                      List<String> fieldMask)

Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sample code:

 try (HttpsHealthCheckClient httpsHealthCheckClient = HttpsHealthCheckClient.create()) {
   ProjectGlobalHttpsHealthCheckName httpsHealthCheck = ProjectGlobalHttpsHealthCheckName.of("[PROJECT]", "[HTTPS_HEALTH_CHECK]");
   HttpsHealthCheck2 httpsHealthCheckResource = HttpsHealthCheck2.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = httpsHealthCheckClient.patchHttpsHealthCheck(httpsHealthCheck, httpsHealthCheckResource, fieldMask);
 }
 

Parameters:

httpsHealthCheck - Name of the HttpsHealthCheck resource to patch.

httpsHealthCheckResource - Represents a legacy HTTPS Health Check resource.

Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.

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

patchHttpsHealthCheck

@BetaApi
public final Operation patchHttpsHealthCheck(String httpsHealthCheck,
                                                      HttpsHealthCheck2 httpsHealthCheckResource,
                                                      List<String> fieldMask)

Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sample code:

 try (HttpsHealthCheckClient httpsHealthCheckClient = HttpsHealthCheckClient.create()) {
   ProjectGlobalHttpsHealthCheckName httpsHealthCheck = ProjectGlobalHttpsHealthCheckName.of("[PROJECT]", "[HTTPS_HEALTH_CHECK]");
   HttpsHealthCheck2 httpsHealthCheckResource = HttpsHealthCheck2.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = httpsHealthCheckClient.patchHttpsHealthCheck(httpsHealthCheck.toString(), httpsHealthCheckResource, fieldMask);
 }
 

Parameters:

httpsHealthCheck - Name of the HttpsHealthCheck resource to patch.

httpsHealthCheckResource - Represents a legacy HTTPS Health Check resource.

Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.

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

patchHttpsHealthCheck

@BetaApi
public final Operation patchHttpsHealthCheck(PatchHttpsHealthCheckHttpRequest request)

Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sample code:

 try (HttpsHealthCheckClient httpsHealthCheckClient = HttpsHealthCheckClient.create()) {
   String formattedHttpsHealthCheck = ProjectGlobalHttpsHealthCheckName.format("[PROJECT]", "[HTTPS_HEALTH_CHECK]");
   HttpsHealthCheck2 httpsHealthCheckResource = HttpsHealthCheck2.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   PatchHttpsHealthCheckHttpRequest request = PatchHttpsHealthCheckHttpRequest.newBuilder()
     .setHttpsHealthCheck(formattedHttpsHealthCheck)
     .setHttpsHealthCheckResource(httpsHealthCheckResource)
     .addAllFieldMask(fieldMask)
     .build();
   Operation response = httpsHealthCheckClient.patchHttpsHealthCheck(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

patchHttpsHealthCheckCallable

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

Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sample code:

 try (HttpsHealthCheckClient httpsHealthCheckClient = HttpsHealthCheckClient.create()) {
   String formattedHttpsHealthCheck = ProjectGlobalHttpsHealthCheckName.format("[PROJECT]", "[HTTPS_HEALTH_CHECK]");
   HttpsHealthCheck2 httpsHealthCheckResource = HttpsHealthCheck2.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   PatchHttpsHealthCheckHttpRequest request = PatchHttpsHealthCheckHttpRequest.newBuilder()
     .setHttpsHealthCheck(formattedHttpsHealthCheck)
     .setHttpsHealthCheckResource(httpsHealthCheckResource)
     .addAllFieldMask(fieldMask)
     .build();
   ApiFuture<Operation> future = httpsHealthCheckClient.patchHttpsHealthCheckCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

updateHttpsHealthCheck

@BetaApi
public final Operation updateHttpsHealthCheck(ProjectGlobalHttpsHealthCheckName httpsHealthCheck,
                                                       HttpsHealthCheck2 httpsHealthCheckResource,
                                                       List<String> fieldMask)

Updates a HttpsHealthCheck resource in the specified project using the data included in the request.

Sample code:

 try (HttpsHealthCheckClient httpsHealthCheckClient = HttpsHealthCheckClient.create()) {
   ProjectGlobalHttpsHealthCheckName httpsHealthCheck = ProjectGlobalHttpsHealthCheckName.of("[PROJECT]", "[HTTPS_HEALTH_CHECK]");
   HttpsHealthCheck2 httpsHealthCheckResource = HttpsHealthCheck2.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = httpsHealthCheckClient.updateHttpsHealthCheck(httpsHealthCheck, httpsHealthCheckResource, fieldMask);
 }
 

Parameters:

httpsHealthCheck - Name of the HttpsHealthCheck resource to update.

httpsHealthCheckResource - Represents a legacy HTTPS Health Check resource.

Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.

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

updateHttpsHealthCheck

@BetaApi
public final Operation updateHttpsHealthCheck(String httpsHealthCheck,
                                                       HttpsHealthCheck2 httpsHealthCheckResource,
                                                       List<String> fieldMask)

Updates a HttpsHealthCheck resource in the specified project using the data included in the request.

Sample code:

 try (HttpsHealthCheckClient httpsHealthCheckClient = HttpsHealthCheckClient.create()) {
   ProjectGlobalHttpsHealthCheckName httpsHealthCheck = ProjectGlobalHttpsHealthCheckName.of("[PROJECT]", "[HTTPS_HEALTH_CHECK]");
   HttpsHealthCheck2 httpsHealthCheckResource = HttpsHealthCheck2.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = httpsHealthCheckClient.updateHttpsHealthCheck(httpsHealthCheck.toString(), httpsHealthCheckResource, fieldMask);
 }
 

Parameters:

httpsHealthCheck - Name of the HttpsHealthCheck resource to update.

httpsHealthCheckResource - Represents a legacy HTTPS Health Check resource.

Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.

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

updateHttpsHealthCheck

@BetaApi
public final Operation updateHttpsHealthCheck(UpdateHttpsHealthCheckHttpRequest request)

Updates a HttpsHealthCheck resource in the specified project using the data included in the request.

Sample code:

 try (HttpsHealthCheckClient httpsHealthCheckClient = HttpsHealthCheckClient.create()) {
   String formattedHttpsHealthCheck = ProjectGlobalHttpsHealthCheckName.format("[PROJECT]", "[HTTPS_HEALTH_CHECK]");
   HttpsHealthCheck2 httpsHealthCheckResource = HttpsHealthCheck2.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   UpdateHttpsHealthCheckHttpRequest request = UpdateHttpsHealthCheckHttpRequest.newBuilder()
     .setHttpsHealthCheck(formattedHttpsHealthCheck)
     .setHttpsHealthCheckResource(httpsHealthCheckResource)
     .addAllFieldMask(fieldMask)
     .build();
   Operation response = httpsHealthCheckClient.updateHttpsHealthCheck(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

updateHttpsHealthCheckCallable

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

Updates a HttpsHealthCheck resource in the specified project using the data included in the request.

Sample code:

 try (HttpsHealthCheckClient httpsHealthCheckClient = HttpsHealthCheckClient.create()) {
   String formattedHttpsHealthCheck = ProjectGlobalHttpsHealthCheckName.format("[PROJECT]", "[HTTPS_HEALTH_CHECK]");
   HttpsHealthCheck2 httpsHealthCheckResource = HttpsHealthCheck2.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   UpdateHttpsHealthCheckHttpRequest request = UpdateHttpsHealthCheckHttpRequest.newBuilder()
     .setHttpsHealthCheck(formattedHttpsHealthCheck)
     .setHttpsHealthCheckResource(httpsHealthCheckResource)
     .addAllFieldMask(fieldMask)
     .build();
   ApiFuture<Operation> future = httpsHealthCheckClient.updateHttpsHealthCheckCallable().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