Documentation

Google_Service_Monitoring_Resource_ProjectsUptimeCheckConfigs extends Google_Service_Resource
in package

The "uptimeCheckConfigs" collection of methods.

Typical usage is: $monitoringService = new Google_Service_Monitoring(...); $uptimeCheckConfigs = $monitoringService->uptimeCheckConfigs;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_Monitoring_UptimeCheckConfig
Creates a new Uptime check configuration. (uptimeCheckConfigs.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_Monitoring_MonitoringEmpty
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.
get()  : Google_Service_Monitoring_UptimeCheckConfig
Gets a single Uptime check configuration. (uptimeCheckConfigs.get)
listProjectsUptimeCheckConfigs()  : Google_Service_Monitoring_ListUptimeCheckConfigsResponse
Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).
patch()  : Google_Service_Monitoring_UptimeCheckConfig
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)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

create()

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

public create(string $parent, Google_Service_Monitoring_UptimeCheckConfig $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Monitoring_UptimeCheckConfig
Parameters
$parent : string

Required. The project in which to create the Uptime check. The format is: projects/[PROJECT_ID_OR_NUMBER]

$postBody : Google_Service_Monitoring_UptimeCheckConfig
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Monitoring_UptimeCheckConfig

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string

$requestUrl

delete()

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.

public delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Monitoring_MonitoringEmpty

(uptimeCheckConfigs.delete)

Parameters
$name : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Monitoring_MonitoringEmpty

get()

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

public get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Monitoring_UptimeCheckConfig
Parameters
$name : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Monitoring_UptimeCheckConfig

listProjectsUptimeCheckConfigs()

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

public listProjectsUptimeCheckConfigs(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Monitoring_ListUptimeCheckConfigsResponse

(uptimeCheckConfigs.listProjectsUptimeCheckConfigs)

Parameters
$parent : string

Required. The project whose Uptime check configurations are listed. The format is: projects/[PROJECT_ID_OR_NUMBER]

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

int pageSize The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0, the server will decide the number of results to be returned.

opt_param

string pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call.

Return values
Google_Service_Monitoring_ListUptimeCheckConfigsResponse

patch()

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)

public patch(string $name, Google_Service_Monitoring_UptimeCheckConfig $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Monitoring_UptimeCheckConfig
Parameters
$name : string

A unique resource name for this Uptime check configuration. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] 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.

$postBody : Google_Service_Monitoring_UptimeCheckConfig
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string updateMask Optional. If present, only the listed fields in the current Uptime check configuration are updated with values from the new configuration. If this field is empty, then the current configuration is completely replaced with the new configuration.

Return values
Google_Service_Monitoring_UptimeCheckConfig

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results