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

ProjectsLocationsObservationJobs

class ProjectsLocationsObservationJobs extends Resource (View source)

The "observationJobs" collection of methods.

Typical usage is:

 $apimService = new Google\Service\APIManagement(...);
 $observationJobs = $apimService->projects_locations_observationJobs;

Methods

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

CreateObservationJob creates a new ObservationJob but does not have any effecton its own. It is a configuration that can be used in an Observation Job to collect data about existing APIs. (observationJobs.create)

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

DeleteObservationJob deletes an ObservationJob. This method will fail if the observation job is currently being used by any ObservationSource, even if not enabled. (observationJobs.delete)

Operation
disable(string $name, DisableObservationJobRequest $postBody, array $optParams = [])

Disables the given ObservationJob. (observationJobs.disable)

Operation
enable(string $name, EnableObservationJobRequest $postBody, array $optParams = [])

Enables the given ObservationJob. (observationJobs.enable)

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

GetObservationJob retrieves a single ObservationJob by name.

ListObservationJobsResponse
listProjectsLocationsObservationJobs(string $parent, array $optParams = [])

ListObservationJobs gets all ObservationJobs for a given project and location. (observationJobs.listProjectsLocationsObservationJobs)

Details

at line 63
Operation create(string $parent, ObservationJob $postBody, array $optParams = [])

CreateObservationJob creates a new ObservationJob but does not have any effecton its own. It is a configuration that can be used in an Observation Job to collect data about existing APIs. (observationJobs.create)

Parameters

string $parent

Required. The parent resource where this ObservationJob will be created. Format: projects/{project}/locations/{location}
ObservationJob $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

DeleteObservationJob deletes an ObservationJob. This method will fail if the observation job is currently being used by any ObservationSource, even if not enabled. (observationJobs.delete)

Parameters

string $name

Required. Name of the resource Format: projects/{project}/locations/{location}/observationJobs/{observation_job}
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 96
Operation disable(string $name, DisableObservationJobRequest $postBody, array $optParams = [])

Disables the given ObservationJob. (observationJobs.disable)

Parameters

string $name

Required. The name of the ObservationJob to disable. Format: projects/{project}/locations/{location}/observationJobs/{job}
DisableObservationJobRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 112
Operation enable(string $name, EnableObservationJobRequest $postBody, array $optParams = [])

Enables the given ObservationJob. (observationJobs.enable)

Parameters

string $name

Required. The name of the ObservationJob to enable. Format: projects/{project}/locations/{location}/observationJobs/{job}
EnableObservationJobRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 128
ObservationJob get(string $name, array $optParams = [])

GetObservationJob retrieves a single ObservationJob by name.

(observationJobs.get)

Parameters

string $name

Required. The name of the ObservationJob to retrieve. Format: projects/{project}/locations/{location}/observationJobs/{job}
array $optParams

Optional parameters.

Return Value

ObservationJob

Exceptions

Exception

at line 153
ListObservationJobsResponse listProjectsLocationsObservationJobs(string $parent, array $optParams = [])

ListObservationJobs gets all ObservationJobs for a given project and location. (observationJobs.listProjectsLocationsObservationJobs)

Parameters

string $parent

Required. The parent, which owns this collection of ObservationJobs. Format: projects/{project}/locations/{location}
array $optParams

Optional parameters.

Return Value

ListObservationJobsResponse

Exceptions

Exception