class HealthChecks extends Resource (View source)

The "healthChecks" collection of methods.

Typical usage is:

 $computeService = new Google\Service\Compute(...);
 $healthChecks = $computeService->healthChecks;

Methods

aggregatedList(string $project, array $optParams = [])

Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

delete(string $project, string $healthCheck, array $optParams = [])

Deletes the specified HealthCheck resource. (healthChecks.delete)

get(string $project, string $healthCheck, array $optParams = [])

Returns the specified HealthCheck resource. (healthChecks.get)

insert(string $project, HealthCheck $postBody, array $optParams = [])

Creates a HealthCheck resource in the specified project using the data included in the request. (healthChecks.insert)

listHealthChecks(string $project, array $optParams = [])

Retrieves the list of HealthCheck resources available to the specified project. (healthChecks.listHealthChecks)

patch(string $project, string $healthCheck, HealthCheck $postBody, array $optParams = [])

Updates a HealthCheck 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. (healthChecks.patch)

update(string $project, string $healthCheck, HealthCheck $postBody, array $optParams = [])

Updates a HealthCheck resource in the specified project using the data included in the request. (healthChecks.update)

Details

HealthChecksAggregatedList aggregatedList(string $project, array $optParams = [])

Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

(healthChecks.aggregatedList)

Parameters

string $project

Name of the project scoping this request.

array $optParams

Optional parameters.

Return Value

HealthChecksAggregatedList

Exceptions

Exception

Operation delete(string $project, string $healthCheck, array $optParams = [])

Deletes the specified HealthCheck resource. (healthChecks.delete)

Parameters

string $project

Project ID for this request.

string $healthCheck

Name of the HealthCheck resource to delete.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

HealthCheck get(string $project, string $healthCheck, array $optParams = [])

Returns the specified HealthCheck resource. (healthChecks.get)

Parameters

string $project

Project ID for this request.

string $healthCheck

Name of the HealthCheck resource to return.

array $optParams

Optional parameters.

Return Value

HealthCheck

Exceptions

Exception

Operation insert(string $project, HealthCheck $postBody, array $optParams = [])

Creates a HealthCheck resource in the specified project using the data included in the request. (healthChecks.insert)

Parameters

string $project

Project ID for this request.

HealthCheck $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

HealthCheckList listHealthChecks(string $project, array $optParams = [])

Retrieves the list of HealthCheck resources available to the specified project. (healthChecks.listHealthChecks)

Parameters

string $project

Project ID for this request.

array $optParams

Optional parameters.

Return Value

HealthCheckList

Exceptions

Exception

Operation patch(string $project, string $healthCheck, HealthCheck $postBody, array $optParams = [])

Updates a HealthCheck 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. (healthChecks.patch)

Parameters

string $project

Project ID for this request.

string $healthCheck

Name of the HealthCheck resource to patch.

HealthCheck $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation update(string $project, string $healthCheck, HealthCheck $postBody, array $optParams = [])

Updates a HealthCheck resource in the specified project using the data included in the request. (healthChecks.update)

Parameters

string $project

Project ID for this request.

string $healthCheck

Name of the HealthCheck resource to update.

HealthCheck $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception