1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Monitoring
  7. \
  8. Resource
  9. \
  10. ProjectsUptimeCheckConfigs

ProjectsUptimeCheckConfigs

class ProjectsUptimeCheckConfigs extends Resource (View source)

The "uptimeCheckConfigs" collection of methods.

Typical usage is:

 $monitoringService = new Google\Service\Monitoring(...);
 $uptimeCheckConfigs = $monitoringService->projects_uptimeCheckConfigs;

Methods

UptimeCheckConfig
create(string $parent, UptimeCheckConfig $postBody, array $optParams = [])

Creates a new Uptime check configuration. (uptimeCheckConfigs.create)

MonitoringEmpty
delete(string $name, array $optParams = [])

Deletes an Uptime check configuration. Note that this method will fail if the Uptime check configuration is referenced by an alert policy or other dependent configs that would be rendered invalid by the deletion.

UptimeCheckConfig
get(string $name, array $optParams = [])

Gets a single Uptime check configuration. (uptimeCheckConfigs.get)

ListUptimeCheckConfigsResponse
listProjectsUptimeCheckConfigs(string $parent, array $optParams = [])

Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).

UptimeCheckConfig
patch(string $name, UptimeCheckConfig $postBody, array $optParams = [])

Updates an Uptime check configuration. You can either replace the entire configuration with a new one or replace only certain fields in the current configuration by specifying the fields to be updated via updateMask. Returns the updated configuration. (uptimeCheckConfigs.patch)

Details

at line 45
UptimeCheckConfig create(string $parent, UptimeCheckConfig $postBody, array $optParams = [])

Creates a new Uptime check configuration. (uptimeCheckConfigs.create)

Parameters

string $parent

Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) in which to create the Uptime check. The format is: projects/[PROJECT_ID_OR_NUMBER]
UptimeCheckConfig $postBody
array $optParams

Optional parameters.

Return Value

UptimeCheckConfig

Exceptions

Exception

at line 64
MonitoringEmpty delete(string $name, array $optParams = [])

Deletes an Uptime check configuration. Note that this method will fail if the Uptime check configuration is referenced by an alert policy or other dependent configs that would be rendered invalid by the deletion.

(uptimeCheckConfigs.delete)

Parameters

string $name

Required. The Uptime check configuration to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
array $optParams

Optional parameters.

Return Value

MonitoringEmpty

Exceptions

Exception

at line 80
UptimeCheckConfig get(string $name, array $optParams = [])

Gets a single Uptime check configuration. (uptimeCheckConfigs.get)

Parameters

string $name

Required. The Uptime check configuration to retrieve. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
array $optParams

Optional parameters.

Return Value

UptimeCheckConfig

Exceptions

Exception

at line 111
ListUptimeCheckConfigsResponse listProjectsUptimeCheckConfigs(string $parent, array $optParams = [])

Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).

(uptimeCheckConfigs.listProjectsUptimeCheckConfigs)

Parameters

string $parent

Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) whose Uptime check configurations are listed. The format is: projects/[PROJECT_ID_OR_NUMBER]
array $optParams

Optional parameters.

Return Value

ListUptimeCheckConfigsResponse

Exceptions

Exception

at line 140
UptimeCheckConfig patch(string $name, UptimeCheckConfig $postBody, array $optParams = [])

Updates an Uptime check configuration. You can either replace the entire configuration with a new one or replace only certain fields in the current configuration by specifying the fields to be updated via updateMask. Returns the updated configuration. (uptimeCheckConfigs.patch)

Parameters

string $name

Identifier. A unique resource name for this Uptime check configuration. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] [PROJECT_ID_OR_NUMBER] is the Workspace host project associated with the Uptime check.This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response.
UptimeCheckConfig $postBody
array $optParams

Optional parameters.

Return Value

UptimeCheckConfig

Exceptions

Exception