class ProjectsLocationsObservationSources extends Resource (View source)

The "observationSources" collection of methods.

Typical usage is:

 $apimService = new Google\Service\APIManagement(...);
 $observationSources = $apimService->projects_locations_observationSources;

Methods

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

CreateObservationSource creates a new ObservationSource but does not affect any deployed infrastructure. It is a configuration that can be used in an Observation Job to collect data about APIs running in user's dataplane.

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

DeleteObservationSource deletes an observation source. This method will fail if the observation source is currently being used by any ObservationJob, even if not enabled. (observationSources.delete)

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

GetObservationSource retrieves a single ObservationSource by name.

listProjectsLocationsObservationSources(string $parent, array $optParams = [])

ListObservationSources gets all ObservationSources for a given project and location. (observationSources.listProjectsLocationsObservationSources)

Details

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

CreateObservationSource creates a new ObservationSource but does not affect any deployed infrastructure. It is a configuration that can be used in an Observation Job to collect data about APIs running in user's dataplane.

(observationSources.create)

Parameters

string $parent

Required. Value for parent.

ObservationSource $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

DeleteObservationSource deletes an observation source. This method will fail if the observation source is currently being used by any ObservationJob, even if not enabled. (observationSources.delete)

Parameters

string $name

Required. Name of the resource Format: projects/{project}/locations/{location}/observationSources/{source}

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

GetObservationSource retrieves a single ObservationSource by name.

(observationSources.get)

Parameters

string $name

Required. The name of the ObservationSource to retrieve. Format: projects/{project}/locations/{location}/observationSources/{source}

array $optParams

Optional parameters.

Return Value

ObservationSource

Exceptions

Exception

ListObservationSourcesResponse listProjectsLocationsObservationSources(string $parent, array $optParams = [])

ListObservationSources gets all ObservationSources for a given project and location. (observationSources.listProjectsLocationsObservationSources)

Parameters

string $parent

Required. The parent, which owns this collection of ObservationSources. Format: projects/{project}/locations/{location}

array $optParams

Optional parameters.

Return Value

ListObservationSourcesResponse

Exceptions

Exception